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

有关变更流输出的完整示例，请参阅使用文档前像和后像的变更流。

如果图像属于以下情况，则前像和后像不可用于变更流事件：

• 在文档更新或删除操作时未对集合启用。

• 在 expireAfterSeconds 中设置的前像和后像保留时间后之后被删除。

  • 以下示例将整个集群上的 expireAfterSeconds 设置为 100 秒：

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

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

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

  • 将 expireAfterSeconds 设置为 off 可使用默认保留策略：将保留前像和后像，直到从 oplog 中删除对应的变更流事件。

  • 如果变更流事件从 oplog 中删除，则无论 expireAfterSeconds 前映像和后映像保留时间如何，相应的前映像和后映像也会被删除。

其他考量：

• 启用前像和后像会占用存储空间并增加处理时间。仅在需要时启用前像和后像。

• 将变更流事件大小限制为小于 16 MB。要限制事件大小，您可以：

  • 将文档大小限制为 8 MB。如果其他 change stream 事件字段（例如 updateDescription）不是很大，则可以在 change stream 输出中同时请求更新前的文档和更新后的文档。

  • 如果其他变更流事件字段（例如 updateDescription）并不大，则仅请求变更流输出中最多 16 MB 的文档的后像。

  • 在以下情况下，仅请求最大 16 MB 的文档的 change stream 输出中的预映像：

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

    • 不会引起 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）。这并无歧义，因为整数不能有前导零。