1.3.3. MySQL コネクター設定プロパティー

name

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

connector.class

コネクターの Java クラスの名前。MySQL コネクターには、常に io.debezium​.connector.mysql.MySqlConnector の値を使用します。

tasks.max

1

このコネクターのために作成する必要のあるタスクの最大数。MySQL コネクターは常に単一のタスクを使用するため、この値を使用しません。そのため、デフォルト値は常に許容されます。

database.hostname

MySQL データベースサーバーの IP アドレスまたはホスト名。

database.port

3306

MySQL データベースサーバーのポート番号 (整数)。

database.user

MySQL データベースサーバーへの接続時に使用する MySQL データベースの名前。

database.password

MySQL データベースサーバーへの接続時に使用するパスワード。

database.server.name

監視対象の特定の MySQL データベースサーバー/クラスターの namespace を識別および提供する論理名。論理名は、他のコネクター全体で一意となる必要があります。これは、このコネクターから生成されるすべての Kafka トピック名の接頭辞として使用されるためです。英数字とアンダースコアのみを使用する必要があります。

database.server.id

random

このデータベースクライアントの数値 ID。MySQL クラスターで現在稼働しているすべてのデータベースプロセスで一意である必要があります。このコネクターは、MySQL データベースクラスターを (この一意の ID を持つ) 別のサーバーとして結合するため、binlog を読み取ることができます。デフォルトでは、5400 から 6400 までの乱数が生成されますが、明示的な値を設定することを推奨します。

database.history.kafka.topic

コネクターがデータベーススキーマの履歴を保存する Kafka トピックの完全名。

database.history​.kafka.bootstrap.servers

Kafka クラスターへの最初の接続を確立するためにコネクターが使用するホストとポートのペアの一覧。このコネクションは、コネクターによって以前に保存されたデータベーススキーマ履歴の取得や、ソースデータベースから読み取られる各 DDL ステートメントの書き込みに使用されます。これは、Kafka Connect プロセスによって使用される同じ Kafka クラスターを示す必要があります。

database.whitelist

空の文字列

監視するデータベース名と一致する正規表現のコンマ区切りリスト（任意）。ホワイトリストに含まれていないデータベース名は監視から除外されます。デフォルトでは、すべてのデータベースが監視されます。database.blacklist と併用できません。

database.blacklist

空の文字列

監視から除外されるデータベース名と一致する正規表現のコンマ区切りリスト（任意）。ブラックリストに含まれていないデータベース名が監視されます。database.whitelist と併用できません。

table.whitelist

空の文字列

監視するテーブルの完全修飾テーブル識別子と一致する正規表現のコンマ区切りリスト（任意）。ホワイトリストに含まれていないテーブルはすべて監視から除外されます。各識別子の形式は databaseName.tableName です。デフォルトでは、コネクターは各監視対象データベースのシステム以外のテーブルをすべて監視します。table.blacklist と併用できません。

table.blacklist

空の文字列

監視から除外されるテーブルの完全修飾テーブル識別子と一致する正規表現のコンマ区切りリスト（任意）。ブラックリストに含まれていないテーブルはすべて監視されます。各識別子の形式は databaseName.tableName です。table.whitelist と併用できません。

column.blacklist

空の文字列

変更イベントメッセージの値から除外される必要がある列の完全修飾名と一致する正規表現のコンマ区切りリスト (任意)。列の完全修飾名の形式は databaseName です。tableName.columnName または databaseName.schemaName.tableName.columnName.

column.truncate.to.length.chars

該当なし

フィールド値が指定された文字数より長い場合に、変更イベントメッセージ値で値を省略する必要がある文字ベースの列の完全修飾名と一致する正規表現のコンマ区切りリスト (任意)。長さが異なる複数のプロパティーを単一の設定で使用できますが、それぞれの長さは正の整数である必要があります。列の完全修飾名の形式は databaseName です。tableName.columnName または databaseName.schemaName.tableName.columnName.

column.mask.with.length.chars

該当なし

文字ベースの列の完全修飾名にマッチする正規表現のコンマ区切りリスト (オプション) で、変更イベントメッセージの値を、指定された数のアスタリスク (*) 文字で設定されるフィールド値に置き換える必要があります。長さが異なる複数のプロパティーを単一の設定で使用できますが、それぞれの長さは正の整数またはゼロである必要があります。列の完全修飾名の形式は databaseName です。tableName.columnName または databaseName.schemaName.tableName.columnName.

column.propagate.source.type

該当なし

出力された変更メッセージの該当するフィールドスキーマに元の型および長さをパラメーターとして追加する必要がある列の完全修飾名と一致する、正規表現のコンマ区切りリスト (任意)。スキーマパラメーター( __Debezium.source.column.type、__Debezium.source.column.length、および _Debezium.source.column.scale )は、それぞれ元の型名と長さ（可変幅型）を伝播するために使用されます。シンクデータベースの対応する列を適切にサイズ調整するのに便利です。列の完全修飾名の形式は databaseName です。tableName.columnName または databaseName.schemaName.tableName.columnName.

time.precision.mode

adaptive_time​_microseconds

時間、日付、およびタイムスタンプは、以下を含む異なる精度の種類で表すことができます。 adaptive_time_microseconds （デフォルト）は、データベース列の型を基にして、ミリ秒、マイクロ秒、またはナノ秒の精度値のいずれかを使用して、データベースの値と全く同じように日付、日時、およびタイムスタンプ値をキャプチャーします。または connect は、常にマイクロ秒としてキャプチャーされる TIME タイプフィールドを除き、ミリ秒、マイクロ秒、または connect は、Kafka Connect の Time の組み込み表現を使用して時間とタイムスタンプ値を常に表現します。 date、および Timestamp。データベース列の精度に関わらず、ミリ秒の精度を使用します。

decimal.handling.mode

precise

コネクターによる DECIMAL 列および NUMERIC 列の値の処理方法を指定します。precise （デフォルト）はバイナリー形式で変更イベントで表される java.math.BigDecimal 値を使用して正確に表します。または double は double 値を使用して表します。精度が失われる可能性はありますが、非常に簡単に使用できます。string オプションは値をフォーマットされた文字列としてエンコードします。これは簡単に使用できますが、実際の型に関するセマンティック情報は失われます。

bigint.unsigned.handling.mode

long

BIGINT UNSIGNED 列を変更イベントで表す方法を指定します。precise は java.math.BigDecimal を使用して値を表します。値は、バイナリー表現と Kafka Connect の org.apache.kafka.connect.data.Decimal タイプを使用して変更イベントでエンコードされます。long （デフォルト）は Java の long を使用して値を表します。精度を提供しない場合もありますが、コンシューマーでの使用がはるかに簡単になります。通常は long が望ましい設定です。2^63 を超える値を使用する場合のみ、それらの値は long を使用して伝えことができないため、正確な 設定を使用する必要があります。

include.schema.changes

true

コネクターがデータベーススキーマの変更を、データベースサーバー ID と同じ名前の Kafka トピックに公開するかどうかを指定するブール値。各スキーマの変更はデータベース名が含まれるキーを使用して記録され、その値には DDL ステートメントが含まれます。これは、コネクターがデータベース履歴を内部で記録する方法には依存しません。デフォルトは true です。

include.query

false

変更イベントを生成した元の SQL クエリーがコネクターに含まれる必要があるかどうかを指定するブール値。
注記：このオプションでは、MySQL を binlog_rows_query_log_events オプションを ON に設定する必要があります。スナップショットプロセスから生成されたイベントに対するクエリーは表示されません。
警告：このオプションを有効にすると、変更イベントに元の SQL ステートメントを含めることで、明示的にブラックリストに指定またはマスクされたテーブルまたはフィールドが公開される可能性があります。このため、このオプションはデフォルトで false に設定されます。

event.processing​.failure.handling.mode

fail

binlog イベントのデシリアライズ中にコネクターが例外に反応する方法を指定します。fail は例外（問題のあるイベントとその binlog オフセットを示す）を伝播し、コネクターを停止させます。
warn は問題のあるイベントをスキップし、問題のあるイベントとその binlog オフセットがログに記録されます。
skip は問題のあるイベントがスキップされます。

inconsistent.schema.handling.mode

fail

内部スキーマ表現に存在しないテーブルに関連する binlog イベント（つまり、内部表現がデータベースと一貫性がない）に関連する binlog イベントにコネクターがどのように反応するかを指定します。つまり、問題のあるイベントとその binlog オフセットを示す例外が発生します（問題のあるイベントとその binlog オフセットを示す）。
warn により、問題のあるイベントがスキップされ、問題のあるイベントとその binlog オフセットが記録されます。
skip は問題のあるイベントがスキップされます。

max.queue.size

8192

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

max.batch.size

2048

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

poll.interval.ms

1000

各反復処理の実行中に新しい変更イベントが表示されるまでコネクターが待機する時間 (ミリ秒単位) を指定する正の整数値。デフォルトは 1000 ミリ秒 (1 秒) です。

connect.timeout.ms

30000

コネクターが MySQL データベースサーバーへの接続を試行した後、タイムアウトするまでの最大の待機期間をミリ秒単位で指定する正の整数値。デフォルトは 30 秒です。

gtid.source.includes

MySQL サーバーで binlog の位置を見つけるために使用される GTID セットのソース UUID に一致する、正規表現のコンマ区切りリスト。これらの include パターンのいずれかに一致するソースを持つ GTID 範囲のみが使用されます。gtid.source.excludes と併用できません。

gtid.source.excludes

MySQL サーバーで binlog の位置を見つけるために使用される GTID セットのソース UUID に一致する、正規表現のコンマ区切りリスト。これらの除外パターンのいずれにも一致するソースを持つ GTID 範囲のみが使用されます。gtid.source.includes と併用できません。

tombstones.on.delete

true

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

message.key.columns

空の文字列

プライマリーキーをマップする完全修飾テーブルおよび列と一致する正規表現のセミコロン区切りリスト。
各項目 (正規表現) は、カスタムキーを表す完全修飾 <fully-qualified table>:<a comma-separated list of columns> と一致する必要があります。
特定のコネクターに応じて、完全修飾テーブルは DB_NAME.TABLE_NAME または SCHEMA_NAME.TABLE_NAME として定義できます。