db.watch（）

定义¶

db.watch（管道，选项）¶

仅适用于副本集和分片群集

版本4.0中的新功能：要求featureCompatibilityVersion（fCV）设置为 "4.0"或更高。有关fCV的更多信息，请参见 setFeatureCompatibilityVersion。

打开更改流游标，以供数据库报告其所有非system集合。

参数	类型	描述
pipeline	数组	由以下一个或多个聚合阶段组成的聚合管道： $addFields $match $project $replaceRoot $replaceWith （从MongoDB 4.2开始可用） $redact $set （从MongoDB 4.2开始可用） $unset （从MongoDB 4.2开始可用） 指定管道以过滤/修改变更事件输出。 从MongoDB 4.2开始，如果更改流聚合管道修改了事件的_id字段，则更改流将引发异常。
options	文献	可选的。修改行为​​的其他选项 db.watch()。 如果您未指定管道但正在传递 文档，则必须将空数组传递[]给pipeline参数options。

该options文档可以包含以下字段和值：

领域	类型	描述
resumeAfter	文献	可选的。指示db.watch()尝试在恢复令牌中指定的操作之后开始恢复通知。 每个变更流事件文档都包括一个恢复令牌作为 _id字段。传递更改事件文档的整个 _id字段，该字段代表您要恢复的操作。 resumeAfter与startAfter和 互斥startAtOperationTime。
startAfter	文献	可选的。指示db.watch()在恢复令牌中指定的操作之后尝试启动新的更改流。允许在事件无效后恢复通知。 每个变更流事件文档都包括一个恢复令牌作为 _id字段。传递更改事件文档的整个 _id字段，该字段代表您要恢复的操作。 startAfter与resumeAfter和 互斥startAtOperationTime。 4.2版中的新功能。
fullDocument	串	可选的。默认情况下，db.watch()返回通过更新操作修改的那些字段的增量，而不是整个更新的文档。 设置fullDocument为“ "updateLookup"直接” db.watch()以查找更新文档的最新多数批准版本。 db.watch()返回一个fullDocument字段，其中包含除了updateDescription增量之外的文档查找。
batchSize	整型	可选的。指定从MongoDB集群的每批响应中返回的更改事件的最大数量。 具有与相同的功能cursor.batchSize()。
maxAwaitTimeMS	整型	可选的。服务器等待新数据更改以报告更改流游标之前等待的最大时间（以毫秒为单位），然后返回空批处理。 默认为1000毫秒。
collation	文献	可选的。传递归类文档以为更改流游标 指定归类。 如果省略，则默认为simple二进制比较。
startAtOperationTime	时间戳记	可选的。变更流的起点。如果指定的起点是过去的时间，则必须在操作日志的时间范围内。要查看操作日志的时间范围，请参阅 rs.printReplicationInfo()。 startAtOperationTime与resumeAfter 和互斥startAfter。

返回值：	将光标放在更改事件文档上。有关变更事件文档的示例，请参见变更事件。

也可以看看

db.collection.watch() 和 Mongo.watch()

可用性¶

行为¶

• 您不能运行db.watch()在上admin，local或 config数据库。
• db.watch() 仅通知已保留给大多数数据承载成员的数据更改。
• 该变换流光标保持打开状态，直到发生以下情况之一：
  • 游标已明确关闭。
  • 发生无效事件；例如，收藏夹放置或重命名。
  • 与MongoDB部署的连接已关闭。
  • 如果部署是分片群集，则分片删除可能会导致打开的更改流游标关闭，并且关闭的更改流游标可能无法完全恢复。
• 您可以db.watch()为不存在的数据库运行。但是，一旦创建数据库并删除数据库，更改流游标就会关闭。

访问控制¶

使用访问控制运行时，用户必须对数据库资源具有 find和changeStream特权操作。也就是说，用户必须具有授予以下特权的角色：

{ resource: { db: <dbname>, collection: "" }, actions: [ "find", "changeStream"] }

内置read角色提供适当的特权。

例子¶

mongoShell中的以下操作在hr数据库上打开更改流游标。返回的游标报告system该数据库中所有非集合的数据更改。

watchCursor = db.getSiblingDB("hr").watch()

迭代光标以检查是否有新事件。使用 cursor.isExhausted()方法，以确保仅环退出时，如果变流光标是封闭的和有剩余的最新一批没有对象：

while (!watchCursor.isExhausted()){
   if (watchCursor.hasNext()){
      printjson(watchCursor.next());
   }
}

有关变更流输出的完整文档，请参阅 变更事件。