update事件

概括

update

update当操作更新集合中的文档时，就会发生事件。

笔记:要了解有关修改集合选项时发生的事件的更多信息，请参阅该modify事件。

描述

行为

记录前图像和后图像

从 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 开始，如果您将文档前映像和后映像用于changeStreams，则必须 使用该命令为每个集合禁用changeStreamPreAndPostImagescollMod，然后才能降级到早期 MongoDB 版本

提示:

也可以看看：

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

路径消歧

6.1版本中的新增内容。

该updateDescription字段记录操作对文档中特定字段所做的更改。这些字段描述符使用点 ( .) 作为路径分隔符，使用数字作为数组索引，当它包含使用点或数字的字段名称时，这会导致一些歧义。

当update事件报告涉及不明确字段的更改时，disambiguatedPaths文档会提供路径键以及列出每个路径组件的数组。

变更:

该字段仅在以showExpandedEvents选项disambiguatedPaths启动的变更流上可用

例如，考虑一个列出人员及其居住的城镇的文档：

{
   "name": "Anthony Trollope",
   "home.town": "Oxford",
   "residences": [
      {"0": "Oxford"},
      {"1": "Sunbury"}
   ]
}

• 当更新将home.town字段从Oxfordto 修改时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）。这是明确的，因为整数不能有前导零。

例子

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

{
   "_id": { <Resume Token> },
   "operationType": "update",
   "clusterTime": <Timestamp>,
   "wallTime": <ISODate>,
   "ns": {
      "db": "engineering",
      "coll": "users"
   },
   "documentKey": {
      "_id": ObjectId("58a4eb4a30c75625e00d2820")
   },
   "updateDescription": {
      "updatedFields": {
         "email": "alice@10gen.com"
      },
      "removedFields": ["phoneNumber"],
      "truncatedArrays": [ {
         "field" : "vacation_time",
         "newSize" : 36
      } ]
   }
}

以下示例说明了update使用选项打开的变更流的事件fullDocument : updateLookup：

{
   "_id": { <Resume Token> },
   "operationType": "update",
   "clusterTime": <Timestamp>,
   "wallTime": <ISODate>,
   "ns": {
      "db": "engineering",
      "coll": "users"
   },
   "documentKey": {
      "_id": ObjectId("58a4eb4a30c75625e00d2820")
   },
   "updateDescription": {
      "updatedFields": {
         "email": "alice@10gen.com"
      },
      "removedFields": ["phoneNumber"],
      "truncatedArrays": [ {
         "field" : "vacation_time",
         "newSize" : 36
      } ],
      "disambiguatedPaths": { }
   },
   "fullDocument": {
      "_id": ObjectId("58a4eb4a30c75625e00d2820"),
      "name": "Alice",
      "userName": "alice123",
      "email": "alice@10gen.com",
      "team": "replication"
   }
}

该fullDocument文档代表更新文档的最新多数提交版本。该fullDocument文档可能与更新操作时的文档有所不同，具体取决于更新操作和文档查找之间发生的交错多数提交操作的数量。

参见

原文 - update Event