すべての Sink Connector 構成プロパティ

connection.uri

必須

タイプ: string

説明:
MongoDBインスタンスまたはクラスターに接続するためのMongoDB接続 URI 文字列。詳細については、
「 MongoDBへの接続」ガイドを参照してください。

重要: connection.uri設定で認証情報が公開されないようにするには、ConfigProvider を使用して適切な構成パラメーターを設定します。

デフォルト: mongodb://localhost:27017
受け入れ可能な値: MongoDB 接続 URI string

server.api.version

タイプ: string

説明:
MongoDBサーバーで使用する Stable APIバージョン。 Stable APIとそれをサポートするサーバーのバージョンの詳細については、 Stable API MongoDBサーバーのマニュアルガイド を参照してください。デフォルト:

""
許容値: 空の文字列または有効な Stable APIバージョン

server.api.deprecationErrors

タイプ:ブール値説明:
trueに設定すると、 コネクタ が宣言された Stable APIバージョンで非推奨のMongoDBインスタンスで コマンドを呼び出すと、例外が発生します。

server.api.version構成オプションを使用してAPIバージョンを設定できます。 Stable APIの詳細については、 Stable APIに関するMongoDB のマニュアル エントリを参照してください。デフォルト:

false
許容値:true またはfalse

server.api.strict

タイプ:ブール値説明:
true

に設定すると、server.api.version コネクタ が宣言された Stable APIバージョンでカバーされていないMongoDBインスタンス上のコマンドを呼び出すと、例外が発生します。 構成オプションを使用してAPIバージョンを設定できます。 Stable APIの詳細については、 Stable APIに関するMongoDB のマニュアル エントリを参照してください。デフォルト:

false
許容値:true またはfalse

csfile.enabled

タイプ: ブール値

説明:
trueに設定すると、MongoDB接続のクライアント側フィールドレベル暗号化(CSFLE)が有効になるフラッグ。

デフォルト: false
受け入れ可能な値: trueまたはfalse

csfile.key.vault名前空間

タイプ: string

説明:
CSFLE のキー ボールト名前空間は database.collection 形式です。例: encryption.__keyVault
csfle.enabled が true に設定されている場合は必須です。

デフォルト: ""
受け入れられる値: database.collection 形式の有効な MongoDB 名前空間

csfile.local. Master.key

タイプ: string

説明:
ローカル KMS プロバイダーを使用した CSFLE 用の Base64 エンコードされた 96 バイトのローカル マスター キー。コネクターはキーを使用して、キー ボールトに保存されているデータ暗号化キーを暗号化および復号化します。
csfle.enabled が true に設定されている場合に必要です。

デフォルト: ""
受け入れ可能な値: Base64 エンコードされた 96 バイトの string

csfle.schema.map

タイプ: string

説明:
CSFLE の暗号化スキーマ マップを定義する JSON ドキュメント。これは、暗号化するフィールドと使用する暗号化アルゴリズムおよびキーを指定する JSON スキーマに名前空間をマップします。

デフォルト: ""
受け入れられる値: 有効な JSON ドキュメント

csfile.bypass.クエリ.analysis

型: ブール値

説明:
CSFLE の自動クエリ分析をバイパスするかどうかを示すフラグ。true に設定すると、コネクターはスキーマ マップに基づいた自動暗号化を無効にします。そのため、明示的な暗号化を使用する必要があります。false に設定すると、コネクターは自動暗号化を有効にしますが、mongocryptd または crypt_shared ライブラリが必要です。
デフォルトは true です。外部依存関係を回避するため。

デフォルト: true
受け入れる値: true または false

max.batch.size

タイプ: int

説明:
プロセシングのためにバッチするシンク レコードの最大数。

以下のレコードを含むバッチするを考慮します。

[ 1, 2, 3, 4, 5 ]

0に設定すると、コネクターはバッチ全体に対して1回のバルク書き込みを実行します。

1に設定すると、コネクターはバッチ内の各レコードに対して1回のバルク書き込みを実行します。次の例に示すように、合計5回のバルク書き込みが実行されます。

[1], [2], [3], [4], [5]

デフォルト: 0
許容値: 整数

bulk.write.ordered

タイプ: ブール値

説明:
コネクターがレコードのバッチを順序付きの一括書き込み操作として書き込むか、順序付きでない一括書き込み操作として書き込むかを示します。true に設定すると、デフォルト値であるため、コネクターはレコードのバッチを順序付きの一括書き込み操作として書き込みます。

一括書き込み操作の詳細については、「一括書き込み操作」を参照してください。

デフォルト: true
受け入れる値: true または false

rate.limit. Bying.n

型: int

説明:
シンクコネクターがレート制限タイムアウトをtriggerするために処理するレコードのバッチ数。値が 0 の場合、レート制限はありません。

デフォルト: 0
受け入れる値: 整数

rate.limiting.timeout

タイプ: int

説明:
レート制限のしきいちに達した後、シンク コネクターがプロセシングを再開するまでの待機時間(ミリ秒)。

デフォルト: 0
受け入れ可能な値: 整数

Task.max

タイプ: int

説明:
このコネクターで作成するタスクの最大数。コネクターは、指定された最大タスク数より少ない数のタスクを作成する場合があります。指定された並列化レベルを取り扱えない場合。

重要: 1 より大きい値を指定する場合、コネクターはタスクの並列プロセシングを有効にします。トピックに複数のパーティション ログがある場合、これによりコネクターはトピックからメッセージを並列で読み取ることができますが、タスクはメッセージを順序に処理できない場合があります。

デフォルト: 1
受け入れ可能な値: 整数

mongo.errors.tolerance

タイプ: string

説明:コネクタがエラーを発生した場合にメッセージの処理を続行するかどうか。
コネクタ がerrors.tolerance Kafkaクラスター設定を上書きできるようにします。

noneに設定すると、コネクタはエラーを報告し、メッセージの残りの部分の処理をブロックします。 に設定すると、コネクタは問題のあるメッセージを無視します。

allに設定すると、コネクタはデータ エラーのみを許容し、他のすべてのエラーでは失敗します。エラー処理戦略の詳細については、「

data

エラーの処理 」ページを参照してください。このプロパティは、接続フレームワークの


errors.toleranceプロパティを上書きします。デフォルト:

errors.tolerance
設定から値を継承します。使用可能な値:"none" または"all"

mongo.errors.log.enable

タイプ:ブール値値


説明:コネクタが失敗した操作を含むエラーの詳細をログファイルに書込むかどうか。コネクタはエラーを "totalated"errors.tolerance mongo.errors.toleranceとして分類します。または

true"許可されていない" と または 設定を使用します。 に設定すると、コネクタは両方の をログに記録します。および"許可されていない"
falseのエラー。


に設定すると、コネクタは「許可されていない」ことをログに記録します。エラー。このプロパティはエラーを上書きします。接続フレームワークの

.enableプロパティをログ。デフォルト:false
許容値:true またはfalse

errors.log.include.message

タイプ: ブール値

説明:
コネクターがエラーをログする際に無効なメッセージを含めるかどうか。無効なメッセージには、レコードキー、値、ヘッダーなどのデータが含まれます。

デフォルト: false
受け入れ可能な値: true または false

errors.readterqueue.token.name

タイプ: string

説明:
デッドレターキュー (DLQ)として使用するトピックの名前。空白の場合、コネクターは無効なメッセージをデッドレターキュー (DLQ)に送信しません。

デッドレターキュー (DLQ) について詳しくは、「デッドレターキュー構成例」を参照してください。

デフォルト: ""
受け入れる値: 有効な Kafka トピック名

errors.readletterqueue.context.headers.enable

タイプ: ブール値

説明:
コネクターがデッドレターキュー (DLQ)にメッセージを書き込み (write)するときに、コンテキスト ヘッダーを含めるかどうか。

デッドレターキュー (DLQ) について詳しく学ぶには、デッドレターキュー (DLQ) の構成例を参照してください。

コネクターが定義し、コンテキスト ヘッダーを介して報告する例外について学ぶには、一括書き込みの例外を参照してください。

デフォルト: false
受け入れ可能な値: true または false

errors.readletterqueue.topi.replication.factor

タイプ: 整数

説明:
デッドレターキュー (DLQ)トピックを複製するノードの数。単一ノードの Kafka クラスターを実行している場合は、これを 1 に設定する必要があります。

デッドレターキュー (DLQ)について詳しくは、デッドレターキュー (DLQ)の構成例を参照してください。

デフォルト: 3
受け入れ可能な値: 有効なノード数

post.processor.link

タイプ: list

説明:
MongoDB に保存する前にデータを処理するためにコネクターが適用する書き込み後のプロセッサー クラスのリスト。


書き込み処理について詳しく学ぶには、また、その使用例を参照するには、
Sink Connector 書き込み処理 を参照してください。

デフォルト:

com.mongodb.kafka.connect.sink.processor.DocumentIdAdder

受け入れ値: 完全修飾 Java クラス名のコンマ区切りリスト

field.renamer.mapping

型: string

説明:
キー フィールドと値フィールドのフィールド名マッピングのリスト。マッピングを次の形式のインライン JSON 配列で定義します。

[ { "oldName":"key.fieldA", "newName":"field1" }, { "oldName":"value.xyz", "newName":"abc" } ]

デフォルト: []
受け入れ可能な値: 有効な JSON 配列

field.renamer.regex

タイプ: string

説明:
正規表現を使用したキーフィールドと値フィールドのフィールド名マッピングのリスト。マッピングを次の形式のインライン JSON 配列で定義します。

[ {"regexp":"^key\\\\..*my.*$", "pattern":"my", "replace":""}, {"regexp":"^value\\\\..*$", "pattern":"\\\\.", "replace":"_"} ]

デフォルト: []
受け入れ可能な値: 有効な JSON 配列

field.value.transformer

型: string

説明:
FieldValueTransformer 実装の完全修飾クラス名。構成されると、コネクターは MongoDB に書き込む前に、field.value.transformer.fields にリストされているフィールドに指定されたトランスフォーマーを適用します。クラスは com.mongodb.kafka.connect.sink.processor.field.transform.FieldValueTransformer を実装し、パブリックの引数なしコンストラクタを持つ必要があります。

デフォルト: ""
受け入れる値: 完全修飾 Java クラス名

フィールド.value.transformer.フィールド

タイプ: string

説明:
コネクターが構成された FieldValueTransformer を適用するフィールド名のカンマ区切りリスト。コネクターは、同じ名前のサブドキュメント内のネストされたフィールドも変換します。

デフォルト: ""
受け入れる値: フィールド名のカンマ区切りリスト

key.projection.list

タイプ: string

説明:
コネクターがキー プロジェクションに含める必要があるフィールド名のリスト。

デフォルト: ""
受け入れられる値: フィールド名のカンマ区切りリスト

key.projection.type

タイプ: string

説明:
コネクターが使用するプロジェクションのキーのタイプ。

デフォルト:none
受け入れ可能な値:none 、BlockList 、またはAllowList (非推奨: blacklist、whitelist)

value.projection.list

〈strong〉タイプ：〈/strong〉 string〈br


/〉〈br /〉〈strong〉説明：〈/strong〉〈br /〉コネクターが値プロジェクションに含める必要があるフィールド名のリスト。〈br /〉〈br /〉

デフォルト: ""
受け入れられる値: フィールド名のカンマ区切りリスト

value.projection.type

タイプ: string

説明:
コネクターが使用する値プロジェクションのタイプ。

デフォルト:none
受け入れ可能な値:none 、BlockList 、またはAllowList (非推奨: blacklist、whitelist)

writemodel.stratey

タイプ: string 説明:コネクタが一括書き込みに使用する


WriteModelStrategyを指定するクラス。独自の戦略を作成する方法の詳細については、「

カスタム書込みモデル戦略 」を参照してください。デフォルト:

com.mongodb.kafka.connect.sink.writemodel.strategy.DefaultWriteModelStrategy

許容値: 完全修飾 Java クラス名

timeseries.timefield

タイプ: string

説明:
時系列コレクションの新しいドキュメントに関連付ける時間情報を含むソース データのトップレベル フィールドの名前。

デフォルト: ""
受け入れる値: 空の string または BSON DateTime 値を含むフィールドの名前

timeseries.timefield.auto.convert.date.format

タイプ: string

説明:
timeseries.timefield設定で指定されたフィールドに含まれるソースデータを変換するためにコネクタが使用する日付形式パターン。コネクタは日付形式パターンをJava

DateTimeFormutter.OfPattern(pattern, ロケール) メソッドに渡し、

時間フィールドで日付と時刻の変換を実行します。ソース データの日付値に日付情報のみが含まれている場合、コネクタは時間情報を指定された日の開始時刻に設定します。日付値にタイムゾーン オフセットが含まれていない場合、コネクタはオフセットを UTC

に設定します。デフォルト:

yyyy-MM-dd[['T'][ ]][HH:mm:ss[[.][SSSSSS][SSS]][ ]VV[ ]'['VV']'][HH:mm:ss[[.][SSSSSS][SSS]][ ]X][HH:mm:ss[[.][SSSSSS][SSS]]]

許容値: 有効なDateTimeFormatter形式

timeseries.timefield.auto.convert

型: ブール値

説明:
フィールド内のデータを BSON Date 形式に変換するかどうか。

true に設定すると、値が数字の場合、コネクターは UNIXエポック以降のミリ秒を使用し、小数部分を破棄します。値が string の場合、コネクターは次の構成の設定を使用して日付を解析します:

timeseries.timefield.auto.convert.date.format

コネクターが値の変換に失敗した場合、元の値が時系列コレクションに送信されます。

デフォルト: false
受け入れ可能な値: true または false

timeseries.timefield.auto.convert.locale.value.map

タイプ: string

説明:
DateTimeFormatter日付形式パターンで使用する ロケール言語タグ（例:"en-US" ）。ロケールの詳細については、

ロケール のJava SE

ドキュメントを参照してください。デフォルト:ROOT
許容値: 有効なLocale 言語タグ形式

timeseries.metafield

タイプ: string

説明:
関連する時系列ドキュメントのグループを説明するために、ソース データから読み取るトップレベル フィールド。

重要: このフィールドは _id フィールドでも、timeseries.timefield 設定で指定したフィールドでもあってはなりません。

デフォルト: ""
受け入れる値: 空の文字列または BsonArray 以外の BSON タイプを含むフィールドの名前。

timeseries.expire.After.seconds

タイプ: int

説明:
MongoDB が時系列コレクションデータを自動的に削除する前に待機する秒数。設定値が 未満の場合、コネクタは期限切れを無効にします。詳しくは、1

MongoDBマニュアルの「 時系列コレクションの自動削除の設定 」を参照してください。デフォルト:

0
許容値: 整数

timeseries.granularity

タイプ: string

説明:
ソース データの後続の測定間の予想される間隔。詳細については、

MongoDBマニュアルの 「時系列データの詳細な設定」 を参照してください。任意のデフォルト:


""
許容値:"" 、"seconds" 、"minutes" 、"hours"