CockroachDB

CockroachDB コネクタを使用すると、CockroachDB データベースに対して挿入、削除、更新、読み取り操作を実行できます。

準備

CockroachDB コネクタを使用する前に、次の作業を行います。

Google Cloud プロジェクトで次の操作を行います。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービスアカウントに、次の IAM ロールを付与します。
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  サービスアカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービスアカウントがない場合は、サービスアカウントを作成する必要があります。詳細については、サービスアカウントを作成するをご覧ください。
- 次のサービスを有効にします。
  - secretmanager.googleapis.com（Secret Manager API）
  - connectors.googleapis.com（Connectors API）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

コネクタを構成するには、データソース（バックエンドシステム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。
2. [NEXT] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [CockroachDB] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 63 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
6. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
7. データベース: Cockroach データベースの名前。
8. 準備済みステートメントを許可する: 実行前にクエリステートメントの準備を許可します。
9. 結果セットメタデータを取得する: このフィールドは、プロバイダがサーバーから結果セット列に関する詳細情報を取得するかどうかを設定します。
10. UseSSL: このフィールドは SSL を有効にするかどうかを設定します。
11. SSLServerCert: このフィールドは SSL を有効にするかどうかを設定します。
12. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
13. [NEXT] をクリックします。
[宛先] セクションに、接続するリモートホスト（バックエンドシステム）の詳細を入力します。
1. Destination Type: 宛先の種類を選択します。
  1. [ホストアドレス] フィールドに、宛先のホスト名または IP アドレスを指定します。
    1. バックエンドシステムへのプライベート接続を確立する場合は、次のようにします。
      1. PSC サービスアタッチメントを作成します。
      2. エンドポイントアタッチメントを作成し、続いて [Host address] フィールドにあるエンドポイントアタッチメントの詳細を入力します。
    2. セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的送信 IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォールルールを構成します。
  他の宛先を入力するには、[+ 宛先を追加] をクリックします。
2. [NEXT] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  CockroachDB 接続でサポートされる認証タイプは次のとおりです。
  - ユーザー名とパスワードを指定する
2. [NEXT] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

ユーザー名とパスワード
- ユーザー名: コネクタのユーザー名
- パスワード: コネクタに関連付けられたパスワードを含む Secret Manager の Secret。

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベースコネクタでは、テーブルがエンティティであり、ファイルサーバーコネクタでは、フォルダがエンティティです。また、メッセージングシステムコネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。
オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
- リスト
- 取得
- 作成
- 更新
- 削除
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティオペレーションをご覧ください。ただし、コネクタがどのエンティティオペレーションもサポートしていない場合、サポートされていないオペレーションは Operations リストに表示されません。
アクション: コネクタインターフェースを介して統合で使用できる最初のクラス関数です。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

CockroachDB コネクタは、ノードごとに 1 秒あたり 1 件のトランザクションを処理することができ、この上限を超えるトランザクションすべてをスロットルします。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

注: Integration Connectors ノードの数は、使用状況に応じて動的に自動スケーリングされます。ただし、自動スケーリングを待たずに大量の容量を確保する場合は、接続の最小ノード値を調整できます。1 つの接続により多くのトランザクションを処理するには、より多くのノードが必要です。逆に、接続が処理するトランザクションが少ない場合は、必要なノードの数が少なくなります。ノードの値を構成するには、次の手順を行います。

従量課金制をご利用のお客様は、接続の編集ページでノードの最小値と最大値を構成します。
サブスクリプションベースで利用されているお客様は、サポートにお問い合わせください。

ノードが処理できる最大トランザクションは、さまざまな要因によって異なります。そのため、スループットを高めるために最小ノードを調整する前に、バックエンドシステムが必要なトラフィックを処理するために最適に設定されているかどうかを確認することをおすすめします。

エンティティオペレーションの例

例 - エンティティのレコードを一覧表示する

この例では、Users エンティティのレコードを一覧表示します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Users を選択します。
[List] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、要件に応じて filterClause を設定できます。

たとえば、フィルタ句を employeeCode='5100' and startDate='2010-01-01 00:00:00' に設定すると、employeeCode が 5100 であり、startDate が 2010-01-01 00:00:00 であるレコードのみが一覧表示されます。

例 - エンティティから 1 つのレコードを取得する

この例では、Users エンティティからレコードを取得します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から User を選択します。
[Get] オペレーションを選択してから、[完了] をクリックします。
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 103032 を入力します。
ここで、103032 は Users エンティティの主キーの値です。

例 - エンティティからレコードを削除する

この例では、Users エンティティからレコードを削除します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Users を選択します。
[Delete] オペレーションを選択してから、[完了] をクリックします。
[コネクタタスクの [タスク入力] セクションの [entityId] をクリックし、[デフォルト値] フィールドに 113132 を入力します。
または、エンティティに複合主キーがある場合、entityId を指定する代わりに、filterClause を設定できます。例: employeeCode='5100' and startDate='2010-01-01 00:00:00'

例 - エンティティにレコードを作成する

この例では、Users エンティティにレコードを作成します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Users を選択します。
[Create] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"employeeCode": "5100",
"startDate": "2010-01-01 00:00:00.0",
"country": "US"
}
```

統合が成功すると、コネクタタスクの connectorOutputPayload フィールドに create オペレーションのレスポンスが返されます。

例 - エンティティ内のレコードを更新する

この例では、Users エンティティにレコードを作成します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Users を選択します。
[Update] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"country": "IN"
}
```
[コネクタタスクの [タスク入力] セクションの [entityId] をクリックし、[デフォルト値] フィールドに 113132 を入力します。
または、エンティティに複合主キーがある場合、entityId を指定する代わりに、filterClause を設定できます。例: employeeCode='5100' and startDate='2010-01-01 00:00:00'

統合が成功すると、コネクタタスクの connectorOutputPayload フィールドに update オペレーションのレスポンスが返されます。

アクション

このセクションでは、コネクタでサポートされているアクションを一覧表示します。アクションの構成方法については、アクションの例をご覧ください。

ExecuteCustomQuery アクション

このアクションにより、カスタムクエリを実行できます。

カスタムクエリを作成する手順は次のとおりです。

詳細な手順に沿って、コネクタタスクを追加します。
コネクタタスクを構成するときに、実行するアクションの種類で [アクション] を選択します。
[アクション] リストで [カスタムクエリを実行する] を選択し、[完了] をクリックします。
[タスク入力] セクションを開き、次の操作を行います。
1. [タイムアウト後] フィールドに、クエリが実行されるまで待機する秒数を入力します。
  デフォルト値: 180 秒
2. [最大行数]フィールドに、データベースから返される最大行数を入力します。
  デフォルト値: 25。
3. カスタムクエリを更新するには、[カスタムクエリの編集] をクリックします。[スクリプトエディタ] ダイアログが開きます。
4. [スクリプトエディタ] ダイアログで、SQL クエリを入力して [保存] をクリックします。
  SQL ステートメントで疑問符（?）を使用して、クエリパラメータリストで指定する必要がある 1 つのパラメータを表すことができます。たとえば、次の SQL クエリは、LastName 列に指定された値と一致する Employees テーブルからすべての行を選択します。
```
SELECT * FROM Employees where LastName=?
```
  注: データ操作言語（DML）とデータ定義言語（DDL）のステートメントがサポートされています。
5. SQL クエリで疑問符を使用した場合は、各疑問符の [+ パラメータ名を追加] をクリックして、パラメータを追加する必要があります。統合の実行中に、これらのパラメータにより SQL クエリ内の疑問符（?）が順番に置き換わります。たとえば、3 つの疑問符（?）を追加した場合、3 つのパラメータを順番に追加する必要があります。クエリパラメータを追加する手順は次のとおりです。
  1. [タイプ] リストから、パラメータのデータタイプを選択します。
  2. [値] フィールドに、パラメータの値を入力します。
  3. 複数のパラメータを追加するには、[+ クエリパラメータを追加] をクリックします。

アクションが正常に実行されると、クエリ結果のあるレスポンスの本文でステータス 200（OK）を返します。

アクションの例

例 - 大きい値を求める

この例では、ユーザー定義関数の実行方法を示します。この例の find_greater 関数は、2 つの整数を比較し、大きい方の整数を返します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[find_greater] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"$1": 1.0,
"$2": 5.0
}
```

アクションの実行に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

[{
"bignum": 5.0
}]

Terraform を使用して接続を作成する

Terraform リソースを使用して、新しい接続を作成できます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

接続作成用の Terraform テンプレートのサンプルを表示するには、サンプルテンプレートをご覧ください。

Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。

パラメータ名	データ型	必須	説明
use_ssl	BOOLEAN	False	このフィールドは SSL を有効にするかどうかを設定します。
ssl_server_cert	SECRET	False	このフィールドは SSL を有効にするかどうかを設定します。
database	STRING	True	Cockroach データベースの名前。
allow_prepared_statement	BOOLEAN	False	実行前にクエリステートメントの準備を許可します。
fetch_result_set_metadata	BOOLEAN	False	このフィールドは、プロバイダがサーバーから結果セット列に関する詳細情報を取得するかどうかを設定します。

統合で CockroachDB 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。