Sink Connector 書込みモデル戦略

Overview

構成プロパティを設定して、MongoDB Kafka Sink Connector が MongoDB にデータを書込む方法を指定できます。次のセクションでは、この動作をカスタマイズするために設定できる構成プロパティについて説明します。

書込みモデル

Sink Connector が Sink レコードを受信したときにデータを書込む方法を指定するには、 writemodel.strategy構成プロパティを設定します。

You can set the value of writemodel.strategy to any of the fully qualified class names of the write model strategies described in the Strategies section of this page. You can specify a strategy by setting the following configuration:

writemodel.strategy=<a write model strategy>

書込みモデルの削除

Sink Connector がトゥームストーンイベントを受信したときにデータを書き込む方法を指定するには、 delete.writemodel.strategy構成プロパティを設定します。トゥームストーンイベントとは、キーを含むが値は含まないレコードであり、削除されたレコードを意味します。

You can set the value of delete.writemodel.strategy to any of the fully qualified class names of the write model strategies described in the Strategies section of this page. You can specify a strategy by setting the following configuration:

delete.writemodel.strategy=<a write model strategy>

カテゴリ別に整理された Sink Connector 構成設定のリストについては、「 Sink Connector 構成プロパティ」に関するガイドを参照してください。

Strategies

名前

説明

DefaultWriteModelStratey

説明:
この戦略では、デフォルトでは ReplaceOneDefaultStrategy が使用され、timeseries.timefield オプションを設定すると InsertOneDefaultStrategy が使用されます。

これは、writemodel.strategy 構成プロパティのデフォルト値です。

InsertOneDefaultStrategy

説明:
各シンクレコードをドキュメントとして MongoDB に挿入します。
この戦略を指定するには、構成プロパティを次のクラス名に設定します。

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

ReplaceOneDefaultStratey

説明:
_id フィールドによってシンクレコードと一致する MongoDB のドキュメントを最大 1 つ置き換えます。一致するドキュメントがない場合、コネクターはシンクレコードを新しいドキュメントとして挿入します。
この戦略を指定するには、構成プロパティを次のクラス名に設定します。

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

ReplaceOne BusinessKeyStratey

説明:
指定されたビジネスキーに一致するシンクレコードと一致するドキュメントを最大 1 つ置き換えます。一致するドキュメントがない場合、コネクターはシンクレコードを新しいドキュメントとして挿入します。
この戦略を指定するには、構成プロパティを次のクラス名に設定します。

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

この戦略の使用方法を示す例えについては、書込みモデル戦略に関するガイドを参照してください。

DeleteOneDefaultStratey

説明:
ドキュメントにヌル値構造が含まれている場合にのみ、_id フィールドによってシンクコネクターのキー構造に一致するドキュメントを最大 1 つ削除する。

これは、delete.writemodel.strategy 構成プロパティのデフォルト値です。

このストラテジは、delete.on.null.values=true を設定すると、writemodel.strategy プロパティのデフォルト値として設定されます。
このストラテジを指定するには、構成プロパティを次のクラス名に設定します。

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

DeleteOne BusinessKeyStratey

説明:
ビジネスキーによってシンクレコードに一致する MongoDB ドキュメントを最大 1 つ削除します。この戦略では、キー生成に valueDoc が必要です。キー生成に PartialKeyStrategy を活用するには、 DeleteOneTombstoneBusinessKeyStrategy を使用します。

この戦略を指定するには、構成プロパティを次のクラス名に設定します。

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

この戦略の使用方法を示す例えについては、書込みモデル戦略に関するガイドを参照してください。

DeleteOneTombstoneBusinessKeyStrategy

説明:
ビジネスキーによってシンクレコードに一致する MongoDB ドキュメントを最大 1 つ削除します。この戦略では、PartialKeyStrategy を活用して削除に使用するキーを作成します。

この戦略を指定するには、構成プロパティを次のクラス名に設定します。

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

UpdateOneDefaultStrategy

説明:
_id フィールドによってシンクレコードに一致するMongoDBのドキュメントを最大 1 つ更新します。一致するドキュメントがない場合、コネクターはシンクレコードを新しいドキュメントとして挿入します。
このストラテジを指定するには、構成プロパティを次のクラス名に設定します。

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

UpdateOneTimestampsStratey

説明:
ドキュメントに _insertedTS (挿入タイムスタンプ) と _modifiedTS (変更タイムスタンプ) フィールドを追加します。
この戦略を指定するには、構成プロパティを次のクラス名に設定します。

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

この戦略の使用方法を示す例えについては、書込みモデル戦略に関するガイドを参照してください。

UpdateOne BusinessKeyTimestampStratey

説明:
ビジネスキーに一致するドキュメントに _insertedTS (挿入タイムスタンプ) と _modifiedTS (変更タイムスタンプ) フィールドを追加します。
この戦略を指定するには、構成プロパティを次のクラス名に設定します。

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

戻る

ID 戦略

トピックの上書き