删除事件

概要

delete

delete当操作从集合中删除文档时,例如当用户或应用程序执行命令时,就会发生事件delete

描述

Field 类型 描述
_id Document 一个BSON对象,用作更改流事件的标识符。该值用作恢复更改流时的参数resumeTokenresumeAfter_id对象具有以下形式:`{ "_data" : <BinData hex string>}_data类型取决于 MongoDB 版本,在某些情况下,还取决于更改流打开或恢复时的[功能兼容性版本 (fCV) 。](https://www.mongodb.com/docs/manual/reference/command/setFeatureCompatibilityVersion/#std-label-view-fcv)有关类型的完整列表,请参阅[恢复令牌](https://www.mongodb.com/docs/manual/changeStreams/#std-label-change-stream-resume-token)_data。有关通过 恢复更改流的示例resumeToken`,请参阅 恢复更改流。
clusterTime Timestamp 与事件关联的 oplog 条目的时间戳。与 多文档事务关联的更改流事件通知 都具有相同的clusterTime值:提交事务的时间。在分片集群上,具有相同事件的事件clusterTime可能并不都与同一事务相关。有些事件与交易根本无关。要识别单个事务的事件,您可以在变更流事件文档中使用lsid和的组合。txnNumber4.0版本中的新功能
collectionUUID UUID UUID标识发生更改的集合。6.0版本中的新内容
documentKey document 包含由CRUD_id操作创建或修改的文档的值的文档。对于分片集合,此字段还显示文档的完整分片键。如果该_id字段已经是分片键的一部分,则不会重复。
lsid document 与事务关联的会话的标识符。仅当操作是多文档事务的一部分时才出现。4.0版本中的新功能
ns document 受事件影响的命名空间(数据库和/或集合)。
ns.coll string 发生事件的集合的名称。
ns.db string 发生事件的数据库的名称。
operationDescription document 有关更改操作的附加信息。仅当更改流使用 扩展事件时,此文档及其子字段才会出现。6.0版本中的新内容
operationType string 更改通知报告的操作类型。delete返回这些更改事件的值。
txnNumber NumberLong LSID,一个有助于唯一标识交易的数字。仅当操作是多文档事务的一部分时才出现。4.0版本中的新功能
wallTime ISODate 数据库操作的服务器日期和时间。wallTime 不同之处clusterTime在于,clusterTime时间戳是从与数据库操作事件关联的 oplog 条目中获取的。6.0版本中的新内容

行为

记录前图像和后图像

从 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

    • 以下示例设置expireAfterSeconds100 秒:

      use admin
      db.runCommand( {
         setClusterParameter:
            { changeStreamOptions: { preAndPostImages: { expireAfterSeconds: 100 } } }
      } )
      
    • 以下示例返回当前changeStreamOptions 设置,包括expireAfterSeconds

      db.adminCommand( { getClusterParameter: "changeStreamOptions" } )
      
    • 设置expireAfterSecondsoff使用默认保留策略:保留前映像和后映像,直到从 oplog 中删除相应的更改流事件。

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

其他注意事项:

  • 启用前图像和后图像会消耗存储空间并增加处理时间。仅在需要时才启用前像和后像。
  • 将更改流事件大小限制为小于 16 MB。要限制事件大小,您可以:
    • 将文档大小限制为 8 MB。如果其他更改流事件字段 不大,您可以在更改流输出中同时请求前图像和后图像。updateDescription
    • updateDescription如果其他变更流事件字段(例如)不大,则仅请求变更流输出中最多 16 MB 的文档的后期图像 。
    • 如果满足以下条件,则仅请求变更流输出中最大 16 MB 的文档的原像:
      • 文档更新仅影响文档结构或内容的一小部分,并且
      • 不引起replace变更事件。事件replace总是包含后期图像。
  • 要请求原像,您可以fullDocumentBeforeChangerequiredwhenAvailable设置为db.collection.watch()。要请求后图像,您可以fullDocument使用相同的方法进行设置。
  • 原像被写入集合中config.system.preimages
    • config.system.preimages集合可能会变得很大。要限制集合大小,您可以设置expireAfterSeconds 原像的时间,如前所示。
    • 原像由后台进程异步删除。

重要的

向后不兼容的功能

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

提示

也可以看看:

例子

以下示例说明了一个delete事件:

{
   "_id": { <Resume Token> },
   "operationType": "delete",
   "clusterTime": <Timestamp>,
   "wallTime": <ISODate>,
   "ns": {
      "db": "engineering",
      "coll": "users"
   },
   "documentKey": {
      "_id": ObjectId("599af247bb69cd89961c986d")
   }
}

该文档被省略,因为在更改流游标将事件发送到客户端fullDocument时该文档不再存在。delete

参见

原文 - delete-Event

Copyright © 上海锦木信息技术有限公司 all right reserved,powered by Gitbook文件修订时间: 2023-09-01 17:10:26

results matching ""

    No results matching ""