4.5.3. コネクタープロパティー

name

コネクターの一意の名前。同じ名前の再登録を試みると失敗します。（このプロパティーはすべての Kafka Connect コネクターで必要です。）

connector.class

コネクターの Java クラスの名前。MongoDB コネクターに常にの値を使用 io.debezium.connector.mongodb.MongoDbConnector してください。

mongodb.hosts

レプリカセットの MongoDB サーバーのホスト名とポートのペアのコンマ区切りリスト（「host」または「host:port」の形式）。この一覧には、ホスト名とポートのペアを 1 つ含めることができます。がに設定 mongodb.members.auto.discover されている場合には false、ホストとポートのペアの前にレプリカセット名（例：、rs0/localhost:27017）を付ける必要があります。

mongodb.name

コネクターや MongoDB レプリカセット、またはこのコネクターが監視するシャードクラスターを識別する一意の名前。このサーバー名の接頭辞は MongoDB レプリカセットまたはクラスターから発信されるすべての Kafka トピックを接頭辞としてするため、各サーバーは最大 1 つの Debezium コネクターで監視する必要があります。英数字とアンダースコアのみを使用してください。

mongodb.user

MongoDB への接続時に使用されるデータベースユーザーの名前。これは、MongoDB が認証を使用するよう設定されている場合にのみ必要です。

mongodb.password

MongoDB への接続時に使用されるパスワード。これは、MongoDB が認証を使用するよう設定されている場合にのみ必要です。

mongodb.authsource

admin

MongoDB 認証情報が含まれるデータベース（認証ソース）。これは、MongoDB が以外の認証データベースで認証を使用するように設定されている場合にのみ必要です admin。

mongodb.ssl.enabled

false

コネクターは SSL を使用して MongoDB インスタンスに接続します。

mongodb.ssl.invalid.hostname.allowed

false

この設定を有効にすると、接続フェーズで厳密なホスト名の確認を無効にするかどうかを制御します。接続 true によって中間者攻撃が阻止されない場合。

database.whitelist

空の文字列

監視するデータベース名に一致する正規表現のオプションのコンマ区切りリスト。ホワイトリストに含まれていないデータベース名は、監視から除外されます。デフォルトでは、すべてのデータベースが監視されます。とは使用されない場合があり database.blacklistます。

database.blacklist

空の文字列

監視から除外されるデータベース名に一致する正規表現のオプションのコンマ区切りリスト。ブラックリストに含まれていないデータベース名が監視されます。とは使用されない場合があり database.whitelistます。

collection.whitelist

空の文字列

監視する MongoDB コレクションの完全修飾ネームスペースに一致する正規表現のオプションのコンマ区切りリスト。ホワイトリストに含まれていないコレクションはモニタリングから除外されます。各識別子は databaseName. collectionName の形式です。デフォルトでは、コネクターはおよびデータベースのもの以外のすべてのコレクションを監視 local し admin ます。とは使用されない場合があり collection.blacklistます。

collection.blacklist

空の文字列

監視から除外される MongoDB コレクションの完全修飾ネームスペースに一致する正規表現のオプションのコンマ区切りリスト。ブラックリストに含まれていないコレクションはすべて監視されます。各識別子は databaseName. collectionName の形式です。とは使用されない場合があり collection.whitelistます。

snapshot.mode

initial

コネクターの起動時にスナップショットを実行する基準を指定します。デフォルトは initial で、オフセットが見つからない場合や、oplog に以前のオフセットが含まれなくなった場合に、コネクターがスナップショットを読み取ります。never オプションは、コネクターがスナップショットを使用しないように指定します。代わりに、コネクターはログのテールを続行します。

field.blacklist

空の文字列

変更イベントメッセージ値から除外する必要のあるフィールドの完全修飾名のオプションのコンマ区切りリスト。フィールドの完全修飾名は、databaseName. collectionName. fieldName. nestedFieldName の形式です 。 ここで、 databaseName および collectionName には任意の文字に一致するワイルドカード(*)を含めることができます。

field.renames

空の文字列

変更イベントメッセージ値でフィールドの名前を変更するために使用されるフィールドの完全修飾置き換えのオプションのコンマ区切りリスト。フィールドの完全修飾置換は、databaseName. collectionName. fieldName. nestedFieldName: newNestedFieldName: newNestedFieldName の形式です。この場合、 databaseName および collectionName には任意の文字に一致するワイルドカード(*)が含まれる 可能性 があり、コロン(:)を使用してフィールド名の名前を変更します。次のフィールド置換は、リストの以前のフィールド置換の結果に適用されるため、同じパスにある複数のフィールドの名前を変更する場合は注意してください。

tasks.max

1

このコネクターに作成する必要のあるタスクの最大数。MongoDB コネクターは、レプリカセットごとに個別のタスクの使用を試みるため、単一の MongoDB レプリカセットでコネクターを使用する場合にデフォルトを使用できます。MongoDB シャードクラスターでコネクターを使用する場合、クラスターのシャードの数以上の値を指定することが推奨されます。これにより、各レプリカセットの作業が Kafka Connect によって分散されます。

initial.sync.max.threads

1

レプリカセット内のコレクションの非重要な同期を実行するために使用されるスレッドの最大数を指定する正の整数値。デフォルトは 1 です。

tombstones.on.delete

true

削除イベントの後に tombstone イベントを生成するかどうかを制御します。
削除操作 true が削除イベントと後続の tombstone イベントによって表される場合。削除イベント false のみを送信する場合。
tombstone イベント（デフォルトの動作）を生成すると、Kafka はソースレコードが削除されると、指定のキーに関連するすべてのイベントを完全に削除できます。

snapshot.delay.ms

起動後のスナップショットの取得前にコネクターが待機する間隔（ミリ秒単位）
。クラスターで複数のコネクターを起動する際にスナップショットの中断を回避するために使用できます。コネクターのリバランスが発生する可能性があります。

snapshot.fetch.size

0

スナップショットの作成時に、コレクションから 1 回読み取る必要があるドキュメントの最大数を指定します。コネクターはこのサイズの複数のバッチでコレクションの内容を読み取ります。
デフォルトは 0 で、サーバーは適切なフェッチサイズを選択することを示します。

プロパティー

デフォルト

説明

max.queue.size

8192

データベースログから読み取られるイベントの変更が Kafka に書き込まれる前に配置されるブロックキューの最大サイズを指定する正の整数値。たとえば、Kafka への書き込みが遅い場合や、Kafka が利用できない場合などに、このキューは oplog リーダーにバックマークを提供することができます。キューに表示されるイベントは、このコネクターによって定期的に記録されるオフセットには含まれません。デフォルトは 8192 で、max.batch.size プロパティーに指定された最大バッチサイズよりも大きくする必要があります。

max.batch.size

2048

このコネクターの各反復中に処理されるイベントの各バッチの最大サイズを指定する正の整数値。デフォルトは 2048 です。

poll.interval.ms

1000

新しい変更イベントが表示されるまでコネクターが待機する時間（ミリ秒単位）を指定する正の整数値。デフォルトは 1000 ミリ秒または 1 秒です。

connect.backoff.initial.delay.ms

1000

最初の接続試行に失敗した後、またはプライマリーが利用できないときにプライマリーに再接続しようとすると最初の遅延を指定する正の整数値。デフォルトは 1 秒（1000 ミリ秒）です。

connect.backoff.max.delay.ms

1000

接続が繰り返し試行された後、またはプライマリーが利用できない場合にプライマリーに再接続しようとすると遅延を最大化する正の整数値。デフォルトは 120 秒（120,000 ミリ秒）です。

connect.max.attempts

16

例外が発生し、タスクが中止される前に、レプリカセットへの失敗した接続の最大試行回数を指定する正の整数値。デフォルトは 16 で、デフォルトではで connect.backoff.initial.delay.ms、失敗するまでに 20 分以上の試行が connect.backoff.max.delay.ms 発生します。

mongodb.members.auto.discover

true

'mongodb.hosts' のアドレスがクラスターまたはレプリカセットのすべてのメンバーを検出するのに使用するシード(true)か、内のアドレスをそのまま（）として使用するかどうかを指定 mongodb.hosts するブール値false。MongoDB が プロキシーによって の前に付けられる場合を除き、デフォルトは true およびです。

heartbeat.interval.ms

0

ハートビートメッセージを送信する頻度を制御します。
このプロパティーには、コネクターがハートビートトピックにメッセージを送信する頻度を定義する間隔（ミリ秒単位）が含まれます。これは、コネクターがデータベースから変更イベントを受信しているかどうかを監視するために使用できます。また、キャッシュされていないコレクションのレコードのみが長くなる場合には、ハートビートメッセージも利用する必要があります。この場合、コネクターは引き続き oplog を読み取りますが、Kafka に変更メッセージを出力せず、オフセットの更新が Kafka にコミットされないことを意味します。これにより oplog ファイルがローテーションされますが、コネクターはイベントを再起動する際に利用できなくなるため、初期スナップショットの再実行が必要になります。

ハートビートメッセージを送信しないよう 0 に、このパラメーターをに設定します。
デフォルトでは無効です。

heartbeat.topics.prefix

__debezium-heartbeat

ハートビートメッセージを送信するトピックの命名を制御します。
トピックには、パターンに従って名前が付けられ <heartbeat.topics.prefix>.<server.name>ます。

sanitize.field.names

true コネクター設定が Avro を使用するよう key.converter または value.converter パラメーターを明示的に指定する場合、それ以外の場合はデフォルトでに設定され falseます。

フィールド名が Avro 命名要件に準拠するようにサニタイズされているかどうか。

skipped.operations

ストリーミング時にスキップされる oplog 操作のコンマ区切りリスト。操作には、挿入 i 用、更新、および削除 u d 用のが含まれます。デフォルトでは、操作はスキップされません。

provide.transaction.metadata

false

true Debezium に設定すると、トランザクション境界でイベントが生成され、トランザクションメタデータでデータイベントが強化されます。

詳細は、「 トランザクションメタデータ 」を参照してください。