replace Event事件

Document Pre- and Post-Images文档前期和后期图像

Starting in MongoDB 6.0, you see a fullDocumentBeforeChange document with the fields before the document was changed (or deleted) if you perform these steps:从MongoDB 6.0开始，如果执行以下步骤，您将看到一个完整的DocumentBeforeChange文档，其中包含更改（或删除）文档之前的字段：

1. Enable the new changeStreamPreAndPostImages field for a collection using db.createCollection(), create, or collMod.使用db.createCollection()、create或collMod为集合启用新的changeStreamPreAndPostImages字段。
2. Set fullDocumentBeforeChange to "required" or "whenAvailable" in db.collection.watch().在db.collection.watch()中将fullDocumentBeforeChange设置为"required"或"whenAvailable"。

Example fullDocumentBeforeChange document in the change stream output:变更流输出中的示例fullDocumentBeforeChange文档：

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

For complete examples with the change stream output, see Change Streams with Document Pre- and Post-Images.有关更改流输出的完整示例，请参阅文档前后映像的更改流。

Pre- and post-images are not available for a change stream event if the images were:如果图像为以下情况，则前后映象对更改流事件不可用：

• Not enabled on the collection at the time of a document update or delete operation.文档更新或删除操作时未在集合上启用。
• Removed after the pre- and post-image retention time set in expireAfterSeconds.在expireAfterSeconds中设置的前映像和后映像保留时间之后删除。
  • The following example sets expireAfterSeconds to 100 seconds:以下示例将expireAfterSeconds设置为100秒：

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

  • The following example returns the current changeStreamOptions settings, including expireAfterSeconds:以下示例返回当前changeStreamOptions设置，包括expireAfterSeconds：

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

  • Setting expireAfterSeconds to off uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog.将expireAfterSeconds设置为off使用默认的保留策略：保留前映像和后映像，直到从操作日志中删除相应的更改流事件。
  • If a change stream event is removed from the oplog, then the corresponding pre- and post-images are also deleted regardless of the expireAfterSeconds pre- and post-image retention time.如果更改流事件从操作日志中删除，则相应的前映像和后映像也将被删除，而不管映像前和后映像的保留时间是expireAfterSeconds。

Additional considerations:其他注意事项：

• Enabling pre- and post-images consumes storage space and adds processing time. 启用前映像和后映像会消耗存储空间并增加处理时间。Only enable pre- and post-images if you need them.只有在需要时才启用前映像和后映像。
• Limit the change stream event size to less than 16 megabytes. To limit the event size, you can:将更改流事件大小限制为小于16兆字节。要限制事件大小，您可以：
  • Limit the document size to 8 megabytes. 将文档大小限制为8兆字节。You can request pre- and post-images simultaneously in the change stream output if other change stream event fields like updateDescription are not large.如果其他变更流事件字段（如updateDescription）不大，则可以在变更流输出中同时请求前图像和后图像。
  • Request only post-images in the change stream output for documents up to 16 megabytes if other change stream event fields like updateDescription are not large.如果其他更改流事件字段（如updateDescription）不太大，则请求在更改流输出中为高达16兆字节的文档发布图像。
  • Request only pre-images in the change stream output for documents up to 16 megabytes if:如果出现以下情况，则仅在更改流输出中请求高达16兆字节的文档的预图像：
    • document updates affect only a small fraction of the document structure or content, and文档更新只影响文档结构或内容的一小部分，并且
    • do not cause a replace change event. A replace event always includes the post-image.不要引起replace更改事件。replace事件始终包括发布图像。
• To request a pre-image, you set fullDocumentBeforeChange to required or whenAvailable in db.collection.watch(). 若要请求前映像，请在db.collection.watch()中将fullDocumentBeforeChange设置为required或whenAvailable。To request a post-image, you set fullDocument using the same method.若要请求发布图像，请使用相同的方法设置fullDocument。
• Pre-images are written to the config.system.preimages collection.预映像将写入config.system.preimages集合。
  • The config.system.preimages collection may become large. config.system.preimages集合可能会变大。To limit the collection size, you can set expireAfterSeconds time for the pre-images as shown earlier.要限制集合大小，您可以为预图像设置expireAfterSeconds时间，如前所示。
  • Pre-images are removed asynchronously by a background process.前映像通过后台进程异步移除。