データベース コネクタのデプロイ

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. パラメータを Key-Value ペアとしてファイルの内容に追加します。構成ファイルは、必ず データソース アクセス、データベース アクセス、データベースのフル走査 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 の列の例

走査クエリで使用する列と表示 URL の形式を指定するには:

• データベース レコードの値を使用せずに静的 URL を使用するには:

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

• ビューの URL である単一の列値を使用するには:

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

• 単一の列値を位置 {0} で表示 URL に代入するには、次のようにします。

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

• 複数の列の値を使用して表示 URL を構築するには（列は順序に依存します）:

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

コンテンツの項目

コンテンツ オプションを使用して、検索可能なコンテンツの一部にするレコード値を定義します。