部署数据库连接器

您可以设置 Google Cloud Search，以便发现贵组织的数据，并将其编入索引 使用 Google Cloud Search 数据库连接器。

• Google Workspace 私钥，其中还包含服务账号 ID。要了解如何获取私钥，请访问 配置对 Google Cloud 的访问权限 Search REST API。
• Google Workspace 数据源 ID。要了解如何获取数据源 ID，请访问 添加要搜索的数据源。

第 1 步：下载并构建数据库连接器软件

1. 从 GitHub 克隆连接器代码库。

   $ git clone https://github.com/google-cloudsearch/database-connector.git
   $ cd database-connector

2. 查看所需的连接器版本：
   

   $ git checkout tags/v1-0.0.3

3. 构建连接器。

   $ mvn package

   如需在构建连接器时跳过测试，请使用 mvn package -DskipTests。
4. 将连接器 ZIP 文件复制到本地安装目录并解压缩：

   $ cp target/google-cloudsearch-database-connector-v1-0.0.3.zip installation-dir
   $ cd installation-dir
   $ unzip google-cloudsearch-database-connector-v1-0.0.3.zip
   $ cd google-cloudsearch-database-connector-v1-0.0.3

1. 创建一个文本文件，并将其命名为 connector-config.properties（默认）或类似名称。Google 建议 使用 .properties 或 .config 扩展名，并将该文件保存在连接器所在的同一目录中。 如果您使用其他名称或路径，则必须在运行连接器时指定路径。
2. 将参数作为键值对添加到文件内容中。配置文件必须指定 数据源访问参数、数据库访问参数、数据库完全遍历 SQL 语句 内容字段标题和列定义。您还可以配置其他连接器行为 以及可选参数例如：

   # Required parameters for data source access
   api.sourceId=1234567890abcdef
   api.identitySourceId=0987654321lmnopq
   api.serviceAccountPrivateKeyFile=./PrivateKey.json
   #
   # Required parameters for database access
   db.url=jdbc:mysql://localhost:3306/mysql_test
   db.user=root
   db.password=passw0rd
   #
   # Required full traversal SQL statement parameter
   db.allRecordsSql=select customer_id, first_name, last_name, phone, change_timestamp from address_book
   #
   # Required parameters for column definitions and URL format
   db.allColumns=customer_id, first_name, last_name, phone, change_timestamp
   db.uniqueKeyColumns=customer_id
   url.columns=customer_id
   #
   # Required content field parameter
   contentTemplate.db.title=customer_id
   #
   # Optional parameters to set ACLs to "entire domain" access
   defaultAcl.mode=fallback
   defaultAcl.public=true
   #
   # Optional parameters for schedule traversals
   schedule.traversalIntervalSecs=36000
   schedule.performTraversalOnStart=true
   schedule.incrementalTraversalIntervalSecs=3600
   

   有关数据库专用参数的详细说明，请参阅 本文末尾的配置参数参考。

   了解所有 Cloud Search 的通用参数 （例如元数据配置、日期时间格式和 ACL 选项），请参阅 <ph type="x-smartling-placeholder"></ph> Google 提供的连接器参数。

   如果适用，请在遍历 SQL 中指定架构对象的属性 查询参数。通常，您可以向 SQL 数据库添加别名， 声明。例如，如果您有一部电影 且数据源架构中包含一个名为 “ActorName”，则 SQL 语句可以采用以下格式：SELECT …, last_name AS ActorName, … FROM … 。

第 3 步：运行数据库连接器

以下示例假定所需组件位于本地 目录。

要使用命令行运行该连接器，请输入以下命令：

java \
   -cp "google-cloudsearch-database-connector-v1-0.0.3.jar:mysql-connector-java-5.1.41-bin.jar" \
   com.google.enterprise.cloudsearch.database.DatabaseFullTraversalConnector \
   [-Dconfig=mysql.config]

其中：

• “google-cloud-search-database-connector-v1-0.0.3.jar”现为 数据库连接器 .jar 文件
• mysql-connector-java-5.1.41-bin.jar 是正在使用的 JDBC 驱动程序 访问数据库
• mysql.config 是自定义名称的配置文件。为了确保该连接器能够识别 配置文件，请在命令行中指定其路径。否则，该连接器将使用 本地的connector-config.properties 目录作为默认文件名。

连接器在检测到配置错误时报告这些错误。当出现以下情况时， 连接器进行初始化，例如将数据库列定义为记录内容的一部分时 （在 db.allColumns 中），但该列未用于 数据库（位于 db.allRecordsSql 中）。其他错误仅在 连接器在第一次遍历时会尝试访问数据库，例如 SQL 语句语法无效。

连接器根据您在 遍历时间表参数。

遍历 SQL 查询示例

• 基本的完全遍历查询，可读取员工数据库中的每条相关记录以编入索引：

  db.allRecordsSql = SELECT customer_id, first_name, last_name, employee_id, interesting_field \
      FROM employee

• 按偏移量指定分页，并将完全遍历分解为多次查询。

  对于 SQL Server 2012 或 Oracle 12c（标准 SQL 2008 语法）：

  db.allRecordsSql = SELECT customer_id, first_name, last_name, employee_id, interesting_field \
      FROM employee \
      ORDER BY customer_id OFFSET ? ROWS FETCH FIRST 1000 ROWS ONLY
  db.allRecordsSql.pagination = offset
  

  或者，对于 MySQL 或 Google Cloud SQL：

  db.allRecordsSql = SELECT customer_id, first_name, last_name, employee_id, interesting_field \
      FROM employee \
      ORDER BY customer_id LIMIT 1000 OFFSET ?
  db.allRecordsSql.pagination = offset

• 使用别名应用各个 ACL 的完全遍历查询：

  db.allRecordsSql = SELECT customer_id, first_name, last_name,  employee_id, interesting_field, last_update_time, \
       permitted_readers AS readers_users, \
       denied_readers AS denied_users, \
       permitted_groups AS readers_groups, \
       denied_groups AS denied_groups \
       FROM employee

• 基本增量遍历查询：

  db.incrementalUpdateSql = SELECT customer_id, first_name, last_name, employee_id, interesting_field, last_update_time \
       FROM employee \
       WHERE last_update_time > ?

• 增量遍历查询，使用别名应用各个 ACL：

  db.incrementalUpdateSql = SELECT customer_id, first_name, last_name, employee_id, interesting_field, last_update_time, \
       permitted_readers AS readers_users, \
       denied_readers AS denied_users, \
       permitted_groups AS readers_groups, \
       denied_groups AS denied_groups \
       FROM employee \
       WHERE last_update_time > ?

• 使用数据库时间戳而非当前时间的增量遍历查询：

  db.incrementalUpdateSql = SELECT customer_id, first_name, last_name, employee_id, interesting_field, \
       last_update_time AS timestamp_column \
       FROM employee \
       WHERE last_update_time > ?

列定义参数

以下参数指定您在遍历语句中使用的列，以及 唯一标识每条记录。

db.allColumns = customer_id, first_name, last_name, phone, change_timestamp

db.uniqueKeyColumns = customer_id
# or
db.uniqueKeyColumns = last_name, first_name

网址列示例

要指定遍历查询中使用的列以及视图网址的格式，请执行以下操作：

• 如需使用不使用任何数据库记录值的静态网址，请执行以下操作：

  url.format = https://www.example.com

• 要使用单个列值（即视图网址），请执行以下操作：

  url.format = {0}
  url.columns = customer_id

• 要使用单个列值来替换成位于位置 {0} 的视图网址中，请执行以下操作：

  url.format = https://www.example.com/customer/id={0}
  url.columns = customer_id
  url.columnsToEscape = customer_id

• 要使用多个列值构建视图网址（各列取决于顺序），请执行以下操作：

  url.format = {1}/customer={0}
  url.columns = customer_id, linked_url
  url.columnsToEscape = customer_id

内容字段

可使用内容选项来定义哪些记录值应成为可搜索的内容。