update イベント

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

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 時間を設定します。

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

パスの曖昧さ回避

updateDescriptionフィールドは、操作によってドキュメント内の特定のフィールドに加えられた変更を記録します。 これらのフィールド記述子は、パス区切り文字としてドット（ . ）を使用し、配列インデックスとして数値を使用するため、ドットまたは数値を使用するフィールド名が含まれている場合はぼかして表示されます。

updateイベントがあいまいなフィールドに関係する変更を報告する場合、 disambiguatedPathsドキュメントは各パス コンポーネントをリストする配列を持つパスキーを提供します。

たとえば、人物とその人が住んでいる都市を列挙するドキュメントを考えてみましょう。

{
   "name": "Anthony Trollope",
   "home.town": "Oxford",
   "residences": [
      {"0": "Oxford"},
      {"1": "Sunbury"}
   ]
}

• アップデートによってhome.townフィールドがOxfordからLondonに変更されると、次のようなアップデートの説明が生成されます。

  "updateDescription": {
     "updatedFields": {
        "home.town": "London"
     },
     "disambiguatedPaths": {
        "home.town": [ "home.town" ]
     }
  }

  フィールドhome.townには期間が含まれているため、 disambiguatedPathsフィールドには 1 つの値を持つ配列が表示され、 townがhomeのサブフィールドではないことを示します。

• アップデートによってresidences配列の値が変更され、同じ変更が行われると、次のようなアップデートの説明が生成されます。

  "updateDescription": {
     "updatedFields": {
        "residences.0.0": "London"
     },
     "disambiguatedPaths": { "residences.0.0": [ "residences", 0, "0" ] }
  }

  明確なパスには、配列インデックスを示す整数 0 とネストされたドキュメント内のフィールド名を示すstring "0" が含まれます。

disambiguatedPathに数値フィールドが含まれていない場合は 2 つあります。

• パスの最初のフィールドが数字の string（ 0.name ）。 最初のフィールドは配列インデックスにできないため、これはあいまいではありません。

• 数値 string フィールドの先頭にゼロがある場合（つまり0001 ）。 整数には先頭にゼロがあることができないため、これはあいまいではありません。