replace事件

概括

replace

replace当更新操作从集合中删除文档并将其替换为新文档时（例如 replaceOne调用该方法时），就会发生事件。

描述

行为

记录前图像和后图像

从 MongoDB 6.0 开始，fullDocumentBeforeChange 如果执行以下步骤，您会看到包含更改（或删除）文档之前的字段的文档：

1. 使用、 或changeStreamPreAndPostImages为集合启用新字段。db.createCollection()createcollMod
2. 设置fullDocumentBeforeChange为"required"或 "whenAvailable"中db.collection.watch()。

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。如果其他更改流事件字段 不大，您可以在更改流输出中同时请求前图像和后图像。updateDescription
  • updateDescription如果其他变更流事件字段（例如）不大，则仅请求变更流输出中最多 16 MB 的文档的后期图像 。
  • 如果满足以下条件，则仅请求变更流输出中最大 16 MB 的文档的原像：
    • 文档更新仅影响文档结构或内容的一小部分，并且
    • 不引起replace变更事件。事件replace总是包含后期图像。
• 要请求原像，您可以fullDocumentBeforeChange将 required或whenAvailable设置为db.collection.watch()。要请求后图像，您可以fullDocument使用相同的方法进行设置。
• 原像被写入集合中config.system.preimages。
  • 该config.system.preimages集合可能会变得很大。要限制集合大小，您可以设置expireAfterSeconds 原像的时间，如前所示。
  • 原像由后台进程异步删除。

重要的:

向后不兼容的功能

从 MongoDB 6.0 开始，如果您将文档前映像和后映像用于更改流，则必须 使用该命令为每个集合禁用changeStreamPreAndPostImagescollMod，然后才能降级到早期 MongoDB 版本

提示:

也可以看看：

• 有关更改流事件和输出，请参阅 更改事件。
• 要观察集合的更改，请参阅 db.collection.watch()。
• 有关更改流输出的完整示例，请参阅 使用文档前图像和后图像更改流。

例子

以下示例说明了一个replace事件：

{
   "_id": { <Resume Token> },
   "operationType": "replace",
   "clusterTime": <Timestamp>,
   "wallTime": <ISODate>,
   "ns": {
      "db": "engineering",
      "coll": "users"
   },
   "documentKey": {
      "_id": ObjectId("599af247bb69cd89961c986d")
   },
   "fullDocument": {
      "_id": ObjectId("599af247bb69cd89961c986d"),
      "userName": "alice123",
      "name": "Alice"
   }
}

操作replace使用更新命令，并由两个阶段组成：

• documentKey使用和删除原始文档
• 使用相同的方法插入新文档documentKey

事件fullDocument的replace代表插入替换文档后的文档。

参见

原文 - replace Event