部署資料庫連接器

您可以設定 Google Cloud Search 探索貴機構的資料，並建立索引 與 Google Cloud Search 資料庫連結

• Google Workspace 私密金鑰，包含服務帳戶 ID。如要瞭解如何取得私密金鑰，請前往 設定 Google Cloud 的存取權 搜尋 REST API。
• Google Workspace 資料來源 ID。如要瞭解如何取得資料來源 ID，請參閱 在 Cloud Search 中新增資料來源。

步驟 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 選項)，請前往 Google 提供的連接器參數

   視情況指定遍歷 SQL 中結構定義物件的屬性 查詢參數。通常您可以為 SQL 新增別名 聲明。比方說 資料庫，而資料來源結構定義包含名為 SQL 陳述式格式為「ActorName」：SELECT …, last_name AS ActorName, … FROM … 。

步驟 3：執行資料庫連接器

以下範例假設必要元件位於 位於 Linux 系統上的目錄

如要透過指令列執行連接器，請輸入下列指令：

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

內容欄位

使用內容選項定義哪些記錄值 都屬於可搜尋內容的一部分。