Google Cloud Spanner Sink Connector 構成プロパティ¶

このコネクターを使用するには、connector.class 構成プロパティで、コネクタークラスの名前を指定します。

connector.class=io.confluent.connect.spanner.SpannerSinkConnector

コネクター固有の構成プロパティについて、以降で説明します。

接続¶

gcp.spanner.instance.id

接続先の Spanner インスタンスの ID。

型: string
重要度: 高

gcp.spanner.database.id

トピックテーブルが配置されているデータベース、または作成されるデータベースの ID。

型: string
重要度: 高

gcp.spanner.credentials.path

JSON サービスキーファイルへのパス。空の場合は、認証情報が gcp.spanner.credentials.json 設定から読み取られます。

型: string
デフォルト: ""
重要度: 高

gcp.spanner.credentials.json

JSON サービスキーファイルのコンテンツ。空の場合は、認証情報が gcp.spanner.credentials.path 設定から読み取られます。

型: password
デフォルト: null
重要度: 高

gcp.spanner.proxy.url

URL 構文でエンコードされた Google Cloud Spanner プロキシの設定。このプロパティは、プロキシを介して Spanner にアクセスする必要がある場合にのみ設定します。

型: string
デフォルト: ""
重要度: 低

gcp.spanner.proxy.user

Spanner プロキシのユーザー。このプロパティは、プロキシを介して Spanner にアクセスする必要がある場合にのみ設定します。gcp.spanner.proxy.url にユーザー名とパスワードを埋め込むのではなく、gcp.spanner.proxy.user を使用することにより、パスワードがログに表示されなくなります。

型: string
デフォルト: null
重要度: 低

gcp.spanner.proxy.password

Spanner プロキシのパスワード。このプロパティは、プロキシを介して Spanner にアクセスする必要がある場合にのみ設定します。gcp.spanner.proxy.url にユーザー名とパスワードを埋め込むのではなく、gcp.spanner.proxy.password を使用することにより、パスワードがログに表示されなくなります。

型: password
デフォルト: null
重要度: 低

書き込み¶

insert.mode

使用する挿入モード。サポートされるモードを以下に示します。

insert

標準の INSERT 機能を使用します。挿入される行が既にテーブルに存在する場合は、エラーがスローされます。

update

UPDATE 機能を使用します。アップデートする行がテーブルに存在しない場合は、エラーがスローされます。

upsert

このモードは、INSERT と同じように機能します。ただし、行が既に存在する場合は、指定された値でその列の値が上書きされます。

型: string
デフォルト: INSERT
指定可能な値: [UPSERT、INSERT、UPDATE] のいずれか
重要度: 高

max.batch.size

Spanner に対する 1 回の挿入、アップデート、またはアップサートの各操作で、バッチにまとめることができる最大レコード数。

型: int
デフォルト: 1000
指定可能な値: [1,…]
重要度: 中

error.mode

Spanner への書き込みによって発生したエラーの処理方法を指定します。

型: string
デフォルト: fail
指定可能な値: [IGNORE、FAIL、WARN] のいずれか
重要度: 中

データマッピング¶

table.name.format

マップ先テーブル名のフォーマット制御文字列。マップ元のトピック名を表すプレースホルダーとして ${topic} を含めることができます。

たとえば、トピック「orders」の kafka_${topic} は、テーブル名「kafka_orders」にマップされます。

テーブル名についての Spanner の制約は {a—z|A—Z}[{a—z|A—Z|0—9|_}+] です。

型: string
デフォルト: ${topic}
指定可能な値: 空ではない文字列値
重要度: 中

pk.mode

プライマリキーモード。相互作用について pk.fields の説明も参照してください。サポートされるモードを以下に示します。

kafka

Kafka 座標が PK として使用されます。

record_key

レコードキーからのフィールドが使用されます。これらはプリミティブ型または構造体のいずれかです。

record_value

レコード値からのフィールドが使用されます。これらは構造体である必要があります。

型: string
デフォルト: kafka
有効な値: [RECORD_VALUE、KAFKA、RECORD_KEY] のいずれか
重要度: 高

pk.fields

プライマリキーのフィールド名のコンマ区切りのリスト。この設定の実行時の解釈は、pk.mode に依存します。

kafka

Kafka 座標を表す 3 つの値。空の場合、デフォルト値は connect_topic__, connect_partition__, connect_offset__ です。

record_key

指定したキーのフィールドを抽出します。空の場合は、キー構造体からすべてのフィールドが利用されます。プリミティブキーの場合は、単一のフィールド名のみが構成されている必要があります。

record_value

目的の値のフィールドを抽出します。空の場合は、値構造体からすべてのフィールドが利用されます。

Spanner では、Array 型の列は PK として選択できません。

型: list
デフォルト: ""
重要度: 中

fields.whitelist

指定されたフィールドをフィルター処理します。レコード値フィールド名のコンマ区切りのリストです。空の場合は、レコード値からすべてのフィールドが使用されます。

注釈

pk.fields 設定は、送信先データベースのプライマリキー列をどのフィールドで構成するかというコンテキストで独立して適用されますが、その他の列には fields.whitelist が適用されます。

型: list
デフォルト: ""
重要度: 中

DDL サポート¶

auto.create

送信先テーブルが存在しない場合に、レコードスキーマに基づくテーブルを CREATE を発行して自動的に作成するかどうかを指定します。

型: boolean
デフォルト: false
重要度: 中

auto.evolve

レコードスキーマに関連する列がテーブルスキーマに存在しない場合に、列を ALTER を発行して自動的に追加するかどうかを指定します。

型: boolean
デフォルト: false
重要度: 中

再試行¶

retry.timeout.ms

エラー時に再試行する最大時間。これを過ぎるとタスクは失敗します。

型: long
デフォルト: 60000
指定可能な値: [0,…]
重要度: 中

request.timeout.ms

Spanner へのリクエストが完了するまでの待ち時間。これを過ぎると、タイムアウトして再試行します。

型: long
デフォルト: 6000
指定可能な値: [0,…]
重要度: 中

Confluent Platform ライセンス¶

confluent.topic.bootstrap.servers ライセンス供与に使用される Kafka クラスターとの初期接続を確立するために使用するホストとポートのペアのリスト。初期接続で、クラスター内のすべてのサーバーが検出されます。このリストは、host1:port1,host2:port2,... という形式にする必要があります。これらのサーバーは、初期接続ですべてのクラスターメンバーシップを検出するためにのみ使用されます。これは動的に変わる可能性があるので、このリストにすべてのサーバーセットを含める必要はありません（ただし、サーバーの障害に備えて、複数指定しておくこともできます）。

型: list
重要度: 高

confluent.topic Confluent Platform の構成で使用される Kafka のトピックの名前。ライセンス情報を含みます。

型: string
デフォルト: _confluent-command
重要度: 低

confluent.topic.replication.factor Confluent Platform の構成（ライセンス情報など）で使用される Kafka のトピックのレプリケーション係数。これは、トピックがまだ存在しない場合にのみ使用されます。デフォルトの 3 は、本稼働環境での使用に適しています。ブローカー数が 3 未満の開発環境で使用する場合は、そのブローカー数をこのプロパティに設定する必要があります（多くの場合、1 です）。

型: int
デフォルト: 3
重要度: 低

Confluent ライセンスのプロパティ¶

ちなみに

コネクターの構成にライセンス関連のプロパティを含めることができますが、Confluent Platform バージョン 6.0 以降では、各コネクターの構成ではなく、Connect ワーカーの構成でライセンス関連のプロパティを設定できるようになりました。

注釈

このコネクターはプロプライエタリであり、ライセンスが必要です。ライセンス情報は、_confluent-command トピックに保管されています。ブローカーが SSL 接続を必要とする場合は、以下で説明するセキュリティ関連の confluent.topic.* プロパティを含める必要があります。

confluent.license

Confluent では、各契約者に Confluent エンタープライズライセンスキーを発行します。ライセンスキーはテキストであるため、コピーアンドペーストで confluent.license の値として使用できます。試用ライセンスでは、コネクターを 30 日間使用できます。開発者ライセンスでは、ブローカーが 1 つの開発環境で、コネクターを無期限に使用できます。

既にご契約されている場合は、詳細について Confluent サポートにお問い合わせください。

型: string
デフォルト: ""
指定可能な値: Confluent Platform ライセンス
重要度: 高

confluent.topic.ssl.truststore.location

トラストストアファイルの場所。

型: string
デフォルト: null
重要度: 高

confluent.topic.ssl.truststore.password

トラストストアファイルのパスワード。パスワードが設定されていなくてもトラストストアにアクセスできますが、整合性チェックが無効になります。

型: password
デフォルト: null
重要度: 高

confluent.topic.ssl.keystore.location

キーストアファイルの場所。クライアントでは省略可能です。クライアントの相互認証に使用できます。

型: string
デフォルト: null
重要度: 高

confluent.topic.ssl.keystore.password

キーストアファイルのストアパスワード。クライアントでは省略可能です。ssl.keystore.location を構成した場合にのみ必要となります。

型: password
デフォルト: null
重要度: 高

confluent.topic.ssl.key.password

キーストアファイル内のプライベートキーのパスワード。クライアントでは省略可能です。

型: password
デフォルト: null
重要度: 高

confluent.topic.security.protocol

ブローカーとの通信に使用されるプロトコル。指定可能な値は、PLAINTEXT、SSL、SASL_PLAINTEXT、SASL_SSL です。

型: string
デフォルト: "PLAINTEXT"
重要度: 中

ライセンストピックの構成¶

Confluent エンタープライズライセンスは、_confluent-command トピックに保管されています。このトピックは、デフォルトで作成され、confluent.license プロパティで指定されたライセンスキーに対応するライセンスが含まれます。

注釈

パブリックキーは Kafka のトピックには保管されません。

以下では、デフォルトの _confluent-command トピックがさまざまなシナリオでどのように生成されるかを説明します。

confluent.license プロパティを追加していない場合、またはこのプロパティを（ confluent.license= などで）空にした場合は、_confluent command トピックに、30 日間の試用ライセンスが自動的に生成されます。
有効なライセンスキーを（ confluent.license=<valid-license-key> などで）追加すると、有効なライセンスが _confluent-command トピックに追加されます。

以下は、開発およびテストのための最小限のプロパティの例です。

_confluent-command トピックの名前は confluent.topic プロパティを使用して変更できます（たとえば、環境に厳格な命名規則がある場合など）。以下の例は、この変更と、構成された Kafka ブートストラップサーバーを示しています。

confluent.topic=foo_confluent-command
confluent.topic.bootstrap.servers=localhost:9092

上の例は、開発およびテストで使用できるブートストラップサーバーの必要最小限のプロパティを示しています。本稼働環境の場合は、プレフィックスとして confluent.topic. を付けて、通常のプロデューサー、コンシューマー、およびトピックの各構成プロパティをコネクターのプロパティに追加します。

ライセンストピックの ACL¶

_confluent-command トピックには、confluent.license プロパティで指定されたライセンスキーに対応するライセンスが含まれます。このトピックはデフォルトで作成されます。このトピックにアクセスするコネクターには、以下の ACL を構成する必要があります。

コネクターでトピックの作成が必要な場合は、リソースクラスターでの CREATE および DESCRIBE。
_confluent-command トピックでの DESCRIBE、READ、および WRITE。

重要

You may also use DESCRIBE and READ without WRITE to restrict access to read-only for license topic ACLs. If a topic exists, the LicenseManager will not try to create the topic.

ライセンスを使用する各プリンシパルに個別にアクセス許可を付与することができます。または、ワイルドカード入力を使用すると、すべてのクライアントを許可できます。以下の例は、リソースクラスターおよび _confluent-command トピックの ACL を構成するために使用できるコマンドを示しています。

リソースクラスターの CREATE および DESCRIBE の ACL を設定します。

kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation CREATE --operation DESCRIBE --cluster

_confluent-command トピックの DESCRIBE、READ、および WRITE の ACL を設定します。

kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command

デフォルトの構成プロパティのオーバーライド¶

confluent.topic.replication.factor を使用することにより、レプリケーション係数をオーバーライドできます。たとえば、（開発およびテスト用の）ブローカー数 3 未満の環境で送信先として Kafka クラスターを使用する場合、confluent.topic.replication.factor プロパティに 1 を設定する必要があります。

プロデューサー固有のプロパティは、confluent.topic.producer. プレフィックスを使用することによりオーバーライドできます。コンシューマー固有のプロパティは、confluent.topic.consumer. プレフィックスを使用することによりオーバーライドできます。

デフォルト値を使用することも、他のプロパティをカスタマイズすることもできます。たとえば、confluent.topic.client.id プロパティのデフォルトは、コネクターの名前に -licensing サフィックスを付けたものです。クライアント接続に SSL または SASL を必要とするブローカーの構成設定では、このプレフィックスを使用します。

トピックのクリーンアップのポリシーはオーバーライドできません。トピックは、常に 1 パーティションであり、圧縮されるからです。また、このプレフィックスを使用してシリアライザーおよびデシリアライザーを指定しないでください。追加されても無視されます。