すべての 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

説明:形式は
database.collectionencryption.__keyVaultの CSFLE 用のキーヴォールト名前空間。例: 。
csfle.enabledtrueが

に設定されている場合に必須です。デフォルト:""
許容値: 形式の有効なMongoDB名前空間database.collection

csfile.local. Master.key

タイプ: string


6496
csfle.enabledtrue

説明:""
ローカル KMS プロバイダーを持つ CSFLE 用の base エンコード バイトのローカル マスター キー。コネクタはキーを使用して、キーヴォールトに保存されているデータ暗号化キーを暗号化および復号化します。 が に設定されている場合に必須です。デフォルト: 許容値: 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

説明:
処理のためにバッチするする Sink レコードの最大数。次のレコードを含むバッチするを考えてみましょう。

[ 1, 2, 3, 4, 5 ]

0に設定すると、コネクタはバッチする全体に対して

11 つの一括書込みを実行します。 に設定すると、コネクタはバッチする内の各レコードに対して 1 回の一括書込みを実行し、合計 5 つの一括書込みを行います（次の例に示すように）。

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

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

bulk.write.ordered

タイプ:ブール値値 説明:コネクタがレコードのバッチするを順序付きまたは順序なし一括書き込み操作として書き込みます。デフォルト値である


に設定すると、コネクタは順序付き一括書込み操作としてレコードのバッチするを書込みます。一括書込み(write)true

操作の詳細については、「 一括書込み (write) 操作

」を参照してください。デフォルト:true
許容値:true またはfalse

rate.limit. Bying.n

タイプ: int

説明:
レート制限タイムアウトをトリガーするために Sink コネクタが処理するレコードのバッチ数。 の値は、レート制限がないことを意味します。デフォルト:0

0
許容値: 整数

rate.limiting.timeout

タイプ: int

説明:
レート制限のしきい値に達した後、Sink コネクタ が処理を再開するまでに待機する時間（ミリ秒単位）。デフォルト:

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

タイプ:ブール値値 説明:コネクタが失敗した操作を含むエラーの詳細をログファイルに書込むかどうか。


errors.tolerancemongo.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)にメッセージを書き込むときにコンテキスト


ヘッダーを含めるかどうか。デッドレターキュー

(DLQ)の詳細については、「

デッド 文字キューの構成例 」を参照してください。コネクタが定義し、コンテキスト ヘッダーを通じて報告する例外の詳細については、「 一括書込みの例外

」を参照してください。デフォルト:false
許容値:true またはfalse

errors.readletterqueue.topi.replication.factor

タイプ: 整数 説明:デッドレターキュー


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

(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配列

フィールド.value.transformer

タイプ: string

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

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

フィールド.value.transformer.fields

タイプ: string

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

""
許容値:フィールド名をカンマで区切ったリスト

key.projection.list

タイプ: string

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

""
許容値:フィールド名をカンマで区切ったリスト

key.projection.type

タイプ: string

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


none
使用可能な値:none 、BlockList 、またはAllowList （ 非推奨: ダークリスト、ホワイトリスト ）

value.projection.list

タイプ: string

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


""
許容値:フィールド名をカンマで区切ったリスト

value.projection.type

タイプ: string

説明:
コネクタが使用する値プロジェクションのタイプ。デフォルト:

none
使用可能な値:none 、BlockList 、またはAllowList （ 非推奨: ダークリスト、ホワイトリスト ）

writemodel.stratey

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


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

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

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

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

timeseries.timefield

タイプ: string 説明:時系列コレクション内の新しいドキュメントに関連付ける時間情報を含む、ソース


データ内の最上位フィールドの名前。デフォルト:

""
許容値: 空の文字列またはBSONDateTime 値を含むフィールドの名前

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

タイプ:ブール値値


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

trueに設定すると、値が数値の場合、コネクタはエポック後の ミリ秒後の を使用し、小数部分を破棄します。値が 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

""
許容値: 空の文字列、または 以外の任意のBSON型を含むフィールドの名前。BsonArray

timeseries.expire.After.seconds

タイプ: int

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

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

0
許容値: 整数

timeseries.granularity

タイプ: string

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

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


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