changeStreamOptions

定義

changeStreamOptions

バージョン 6.0 で追加。

mongodとmongosの両方で利用できます。

変更ストリーム構成オプション を含むオブジェクト。

changeStreamOptionsは、 mongosまたはレプリカセットのプライマリでのみ設定できます。 値はクラスター全体に設定されます。

構文

配置用にchangeStreamOptionsを設定するには、 adminデータベースで次のコマンドを実行します。

db.adminCommand( { setClusterParameter: { changeStreamOptions: <value> } } )

changeStreamOptionsクラスター パラメータの現在の値を表示するには、 adminデータベースで次のコマンドを実行します。

db.adminCommand( { getClusterParameter: "changeStreamOptions" } )

パラメーター フィールド

changeStreamOptions.preAndPostImages.expireAfterSeconds

バージョン 6.0 で追加。

デフォルト: オフ

変更ストリームの変更前と変更後のイメージの保持ポリシーを制御します。 変更前と変更後のイメージは、それぞれドキュメント変更前と変更後のドキュメントのバージョンです。 expireAfterSecondsは、MongoDB が変更前と変更後のイメージを保持する期間を制御します。

expireAfterSecondsがoffの場合、MongoDB はデフォルトの保持ポリシーを使用します。対応する変更ストリーム イベントがoplog から削除されるまで、変更前と変更後のイメージは保持されます。

変更前と変更後のイメージの最小保持時間を設定するには、 expireAfterSecondsの整数値を指定します。

重要

Services that use change streams, including Triggers and Device Sync, might rely on the availability of pre-image data. If you set expireAfterSeconds too low, you may increase the risk of interrupting sync or triggers processing.

変更前イメージにexpireAfterSecondsを設定する場合は、以下を確認します。

• サービスの通常の変更ストリームの遅延よりも小さくない値を指定します。

• oplogデータが失われるリスクを負うことなく、サービスが手動で再開できるようにバッファ時間を追加します。

動作

変更ストリーム イベントが oplog から削除されると、 changeStreamOptions.preAndPostImages.expireAfterSecondsで指定された保持期間にかかわらず、対応する変更前と変更後のイメージも削除されます。

例

次の例では、変更ストリーム内の変更前と変更後のイメージの保持時間を100秒に設定します。

db.runCommand( {
   setClusterParameter: {
      changeStreamOptions: { preAndPostImages: { expireAfterSeconds: 100 } }
   }
} )