更新 事件

文档前后图像

从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"
}

有关更改流输出的完整示例，请参阅 带有文档前后图像的更改流。

如果图像在文档更新或删除操作时未被启用，则更改流事件中不可用前后图像

• 未在集合上启用。

• 在 expireAfterSeconds 中设置的保留时间之后已删除。

  • 以下示例在集群上设置了 expireAfterSeconds 为 100 秒

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

  • 以下示例返回当前的 changeStreamOptions 设置，包括 expireAfterSeconds

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

  • 将 expireAfterSeconds 设置为 off 使用默认的保留策略：保留前后图像，直到相应的更改流事件从 操作日志 中删除。

  • 如果更改流事件从oplog中删除，则相应的预图像和后图像也会被删除，无论expireAfterSeconds预图像和后图像保留时间是多少。

其他注意事项

• 启用预图像和后图像会消耗存储空间并增加处理时间。只有当您需要它们时才启用预图像和后图像。

• 将更改流事件的大小限制在小于16兆字节。要限制事件大小，您可以

  • 将文档大小限制在8兆字节。如果其他更改流事件字段（如updateDescription）不是很大，您可以在更改流输出中同时请求预图像和后图像。

  • 如果其他更改流事件字段（如updateDescription）不是很大，则仅请求16兆字节以内文档的后图像。

  • 如果仅请求16兆字节以内文档的预图像，则

    • 文档更新仅影响文档结构或内容的一小部分，并且

    • 不会引起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字段显示一个只有一个值的数组，以表示town不是home的子字段。

• 当更新修改residences数组中的值以进行相同的更改时，它产生的更新描述如下

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

  模糊路径包括一个整数0来指示数组索引，以及一个字符串"0"来指示嵌套文档中的字段名称。

有两种情况下，disambiguatedPath不包含数字字段

• 当路径的第一个字段是数字字符串时（即0.name）。由于第一个字段不能是数组索引，所以这不是模糊的。

• 当数字字符串字段有前导零时（即，0001）。由于整数不能有前导零，所以这不是模糊的。