delete イベント

ドキュメントの変更前と変更後のイメージ

MongoDB 6.0 以降では、次の手順を実行すると、ドキュメントが変更される前（または削除される）に フィールドを含むfullDocumentBeforeChangeドキュメントが表示されます。

1. db.createCollection() 、 create 、またはcollModを使用し、コレクションで新しいchangeStreamPreAndPostImagesフィールドを有効にします。

2. db.collection.watch() でfullDocumentBeforeChangeを"required"または"whenAvailable"に設定し 。

変更ストリーム出力のfullDocumentBeforeChangeドキュメントの例:

"fullDocumentBeforeChange" : {
   "_id" : ObjectId("599af247bb69cd89961c986d"),
   "userName" : "alice123",
   "name" : "Alice Smith"
}

変更ストリーム出力の完全な例については、「Change Streams とドキュメントの変更前イメージおよび変更後イメージ」を参照してください。

変更ストリーム イベントにおいて、次の条件に当てはまる場合、変更前と変更後のイメージは使用できません。

• ドキュメントの更新または削除操作時に、コレクションにおいて有効になっていない場合。

• expireAfterSeconds で設定した、変更前と変更後のイメージ保持時間が経過した後に削除された場合。

  • 次の例では、クラスター全体でexpireAfterSecondsを100秒に設定します。

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

  • 次の例では、expireAfterSeconds を含む現在の changeStreamOptions 設定を返します。

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

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

  • 変更ストリーム イベントが oplog から削除されると、 expireAfterSeconds の変更前と変更後のイメージの保持時間にかかわらず、対応する変更前と変更後のイメージも削除されます。

その他の考慮事項

• 変更前と変更後のイメージを有効にすると、ストレージ容量が消費され、処理時間が増えます。変更前と変更後のイメージは、必要な場合のみ有効にしてください。

• 変更ストリーム イベントのサイズを 16 メガバイト未満に制限します。イベントのサイズを制限するには、次の方法があります。

  • ドキュメントのサイズを 8 MB に制限します。updateDescription のような他の変更ストリーム イベントのフィールドがそれほど大きくない場合、変更ストリーム出力で変更前と変更後のイメージを同時にリクエストできます。

  • updateDescription のような他の変更ストリーム イベントのフィールドがそれほど大きくない場合、ドキュメントの変更ストリーム出力では最大 16 MB の変更後のイメージのみをリクエストしてください。

  • 次の場合、ドキュメントの変更ストリーム出力では最大 16 MB の変更前のイメージのみをリクエストしてください。

    • ドキュメントのアップデートがドキュメントの構造または内容のごく一部にしか影響しない場合、そして

    • replace 変更イベントが発生しない場合。replace イベントには、常に変更後のイメージが含まれます。

• 変更前イメージをリクエストするには、db.collection.watch() で、fullDocumentBeforeChange を required または whenAvailable に設定します。変更後イメージをリクエストするには、同じ方法で fullDocument を設定します。

• 変更前のイメージは config.system.preimages コレクションに書き込まれます。

  • config.system.preimages コレクションが大きくなる場合があります。コレクションのサイズを制限するには、前述のとおり、変更前のイメージに expireAfterSeconds 時間を設定します。

  • 変更前のイメージはバックグラウンド プロセスによって非同期で削除されます。