替换 事件

文档的预览和后览图像

从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 将使用默认的保留策略：预映像和后映像将保留，直到相应的更改流事件从 操作日志 中移除。

  • 如果从操作日志中移除更改流事件，则相应的预映像和后映像也将被删除，无论 expireAfterSeconds 的预映像和后映像保留时间如何。

其他考虑因素

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

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

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

  • 如果其他更改流事件字段（如 updateDescription）不大，则对16兆字节以下的文档在更改流输出中仅请求后映像。

  • 如果

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

    • 不会导致 replace 更改事件。替换事件始终包括后映像。

• 要请求预映像，您可以在 db.collection.watch() 中将 fullDocumentBeforeChange 设置为 required 或 whenAvailable。要请求后映像，您可以使用相同的方法设置 fullDocument。

• 预映像写入到 config.system.preimages 集合。

  • config.system.preimages 集合可能会变得很大。要限制集合大小，您可以设置如前所述的预映像的 expireAfterSeconds 时间。

  • 预映像将通过后台进程异步删除。