MongoDB-CN-Manual
  • MongoDB中文手册|官方文档中文版
  • MongoDB用户手册说明
  • MongoDB简介
    • 入门
    • 数据库和集合
      • 视图
      • 按需物化视图
      • 封顶集合
      • 时间序列集合
    • 文档
    • BSON类型
      • Comparison and Sort Order
      • MongoDB Extended JSON (v2)
      • MongoDB Extended JSON (v1)
  • 安装 MongoDB
    • 安装MongoDB社区版
      • 在Linux上安装MongoDB社区版
      • 在macOS上安装MongoDB社区版
      • 在Windows上安装MongoDB社区版
    • 安装MongoDB企业版
      • 在Linux上安装MongoDB企业版
      • 在Mac OS安装MongoDB企业版
      • 在Windows安装MongoDB企业版
      • 使用Docker安装MongoDB企业版
    • 将社区版MongoDB升级到企业版MongoDB
    • 验证MongoDB软件包的完整性
  • The mongo Shell
    • 配置mongo Shell
    • 使用 mongo Shell帮助
    • 为mongo Shell编写脚本
    • mongo Shell中的数据类型
    • mongo Shell 快速参考
  • MongoDB CRUD操作
    • 插入文档
      • 插入方法
    • 查询文档
      • 在mongo Shell中迭代游标
      • 从查询返回的项目字段
      • 查询嵌入式文档数组
      • 查询数组
      • 查询空字段或缺少字段
      • 查询嵌入/嵌套文档
    • 更新文档
      • 更新方法
      • 聚合管道更新
    • 删除文档
      • 删除方法
    • 地理空间查询
      • 用地理空间查询查找餐馆
      • GeoJSON对象
    • 批量写入操作
    • 可重试写入
    • 可重试读取
    • SQL到MongoDB的映射图表
    • 文本搜索
      • 文本索引
      • 文本索引操作
      • 集合管道中的文本索引
      • 文本索引语言
    • Read Concern读关注
      • 读关注 "local"
      • 读关注 "available"
      • 读关注 "majority"
      • 读关注 "linearizable"
      • 读关注 "snapshot"
    • Write Concern写关注
    • MongoDB CRUD概念
      • 原子性和事务
      • 读隔离性,一致性和近因性
        • 因果一致性和读写关注
      • 分布式查询
      • 通过findAndModify进行线性化读取
      • 查询计划
      • 查询优化
        • 评估当前操作性能
        • 优化查询性能
        • 写操作性能
        • 说明结果
      • 分析查询表现
      • Tailable 游标
  • MongoDB聚合
    • 聚合管道
      • 聚合管道优化
      • 聚合管道限制
      • 聚合管道和分片集合
      • 使用 Zip Code 数据集进行聚合
      • 使用用户首选项数据进行聚合
    • Map-Reduce
      • Map-Reduce 和分片集合
      • Map-Reduce 并发
      • Map-Reduce 示例
      • 执行增量 Map-Reduce
      • 对 Map Function 进行故障排除
      • 排除 Reduce Function 问题
      • Map-Reduce转换到聚合管道
    • 聚合参考
      • 聚合管道快速参考
      • 聚合命令
      • 聚合命令对比
      • 聚合表达式中的变量
      • SQL 到聚合映射图表
  • MongoDB数据模型
    • 数据建模介绍
    • 模式验证
    • 数据模型设计
      • 一对一嵌套关系模型
  • MongoDB事务
  • MongoDB事务
    • 驱动程序 API
    • 生产注意事项
    • 生产注意事项 (分片集群)
    • 事务操作
  • MongoDB索引
    • 单字段索引
    • 复合索引
    • 多键索引
      • 多键索引范围
    • 文本索引
      • 为文本索引指定语言
      • 指定文本索引的名称
      • 用权重控制搜索结果
      • 限制扫描条目的数量
    • 通配符索引
      • 通配符索引限制
    • 2dsphere 索引
      • 查询一个2dsphere索引
    • 2d 索引
      • 创建一个2d索引
      • 查询一个2d索引
      • 2d索引内部
      • 使用球面几何计算距离
    • geoHaystack 索引
      • 创建Haystack索引
      • 查询Haystack索引
    • 哈希索引
    • 索引特性
      • TTL 索引
        • 通过设置TTL使集合中的数据过期
      • 唯一索引
      • 部分索引
      • 不分大小写索引
      • Sparse 索引
    • 在填充的集合上建立索引
      • 在副本集上建立滚动索引
      • 在分片群集上建立滚动索引
    • 索引交集
    • 管理索引
    • 衡量索引使用
    • 索引策略
      • 创建索引来支持查询
      • 使用索引对查询结果进行排序
      • 确保索引适合RAM
      • 创建以确保选择性的查询
    • 索引参考
  • MongoDB安全
    • 安全检查列表
    • 启用访问控制
    • 身份验证
      • 用户
        • 添加用户
        • 权限认证机制
          • SCRAM
            • 用x.509证书来认证客户端
    • 审计
      • 配置审计过滤器
      • 配置审计
      • 系统事件审计消息
    • 网络和配置强化
    • 安全参考
      • system.roles集合
      • system.users集合
      • 资源文档
      • 权限操作
    • 附录
      • 附录-A-用于测试的 OpenSSl CA 证书
      • 附录-B-用于测试的OpenSSL服务器证书
      • 附录-C-用于测试的OpenSSL客户端证书
  • Change Streams变更流
    • 变更流生产建议
    • 变更事件
  • MongoDB复制
    • 副本集成员
    • 副本集日志
    • 副本集数据同步
    • 副本集部署架构
    • 副本集成员配置教程
    • 副本集维护教程
    • MongoDB复制参考
  • MongoDB分片
    • 分片集群组件
    • 分片键
    • 哈希分片
    • 范围分片
    • 区
      • 管理分片区
      • 按位置细分数据
      • 用于更改SLA或SLO的分层硬件
      • 按应用或客户细分数据
      • 仅插入工作负载的分布式本地写入
      • 管理分片区
    • 使用块进行数据分区
      • 在分片集群中拆分数据块
    • 分片管理
      • 查看集群设置
    • 重启一个分片集群
    • [把一个分片集群迁移到不同的硬件](fen-pian/migrate-a -sharded-cluster-to-different-hardware.md)
    • 分片参考
  • MongoDB管理
    • 产品说明
    • 操作检查列表
    • 开发检查列表
    • 配置和维护
    • 性能
    • 数据中心意识
      • MongoDB部署中的工作负载隔离
      • 区
        • 管理分片区
        • 按位置细分数据
        • 用于更改SLA或SLO的分层硬件
        • 按应用或客户细分数据
        • 仅插入工作负载的分布式本地写入
        • 管理分片区
    • MongoDB备份方法
    • MongoDB监控
  • MongoDB存储
    • 存储引擎
      • WiredTiger 存储引擎
      • 内存存储引擎
    • 日志记录
      • 管理日志记录
        • GridFS
        • FAQ:MongoDB 存储
  • MongoDB参考
    • 运算符
      • 查询与映射运算符
        • 比较查询运算符
          • $eq
          • $gt
          • $gte
          • $in
          • $lt
          • $lte
          • $ne
          • $nin
        • 逻辑查询运算符
          • $and
          • $not
          • $nor
          • $or
        • 元素查询运算符
        • 评估查询运算符
        • 地理空间查询运算符
        • 数组查询运算符
        • 按位查询运算符
        • $comment
        • 映射运算符
      • 更新运算符
        • 字段更新运算符
        • 数组更新运算符
        • 按位更新运算符
      • 聚合管道阶段
      • 聚合管道操作符
        • $abs (aggregation)
        • $acos (aggregation)
        • $acosh (aggregation)
        • $add (aggregation)
        • $addToSet (aggregation)
        • $allElementsTrue (aggregation)
        • $and (aggregation)
        • $anyElementTrue (aggregation)
        • $arrayElemAt (aggregation)
        • $arrayToObject (aggregation)
        • $asin (aggregation)
        • $asinh (aggregation)
        • $atan (aggregation)
        • $atan2 (aggregation)
        • $atanh (aggregation)
        • $avg (aggregation)
        • $ceil (aggregation)
        • $cmp (aggregation)
        • $concat (aggregation)
        • $concatArrays (aggregation)
        • $cond (aggregation)
        • $convert (aggregation)
        • $cos (aggregation)
        • $dateFromParts (aggregation)
        • $dateToParts (aggregation)
        • $dateFromString (aggregation)
        • $literal (aggregation)
      • 查询修饰符
    • 数据库命令
      • 聚合命令
      • 地理空间命令
      • 查询和写操作命令
      • 查询计划缓存命令
      • 认证命令
      • 用户管理命令
      • 角色管理命令
      • 复制命令
      • 分片命令
      • 会话命令
      • 管理命令
      • 诊断命令
      • 免费监控命令
      • 系统事件审计命令
    • mongo Shell 方法
      • 集合方法
        • db.collection.aggregate()
        • db.collection.bulkWrite()
        • db.collection.copyTo()
        • db.collection.count()
        • db.collection.countDocuments()
        • db.collection.estimatedDocumentCount()
        • db.collection.createIndex()
        • db.collection.createIndexes()
        • db.collection.dataSize()
        • db.collection.deleteOne()
        • db.collection.deleteMany()
        • db.collection.distinct()
        • db.collection.drop()
        • db.collection.dropIndex()
        • db.collection.dropIndexes()
        • db.collection.ensureIndex()
        • db.collection.explain()
        • db.collection.find()
        • db.collection.findAndModify()
        • db.collection.findOne()
        • db.collection.findOneAndDelete()
        • db.collection.findOneAndReplace()
        • db.collection.findOneAndUpdate()
        • db.collection.getIndexes()
        • db.collection.getShardDistribution()
        • db.collection.getShardVersion()
        • db.collection.insert()
        • db.collection.insertOne()
        • db.collection.insertMany()
        • db.collection.isCapped()
        • db.collection.latencyStats()
        • db.collection.mapReduce()
        • db.collection.reIndex()
        • db.collection.remove()
        • db.collection.renameCollection()
        • db.collection.replaceOne()
        • db.collection.save()
        • db.collection.stats()
        • db.collection.storageSize()
        • db.collection.totalIndexSize()
        • db.collection.totalSize()
        • db.collection.update()
        • db.collection.updateOne()
        • db.collection.updateMany()
        • db.collection.watch()
        • db.collection.validate()
    • MongoDB中的限制与阈值
    • MongoDB系统集合
    • 词汇表
    • 默认的MongoDB端口
    • 默认的MongoDB读/写关注
    • 服务器会话
  • MongoDB FAQ
    • FAQ: MongoDB基础知识
    • FAQ: MongoDB索引
    • FAQ: MongoDB并发
    • FAQ: MongoDB分片
    • FAQ: MongoDB复制和副本集
    • FAQ: MongoDB存储
    • FAQ: MongoDB诊断
  • MongoDB 版本管理
  • 联系我们
    • Tapdata Cloud
    • MongoDB中文社区
    • 社区合作伙伴—锦木信息
由 GitBook 提供支持
在本页
  • 定义
  • 可用性
  • 部署
  • 存储引擎
  • 阅读关注majority支持
  • 行为
  • 可恢复
  • 完整文档查找和更新操作
  • 访问控制
  • 例子
  • 打开更改流
  • 使用完整文档更新查找更改流
  • 使用聚合管道过滤器更改流
  • 恢复变更流
  1. MongoDB参考
  2. mongo Shell 方法
  3. 集合方法

db.collection.watch()

上一页db.collection.updateMany()下一页db.collection.validate()

最后更新于3年前

在本页面

定义

  • db.collection. watch(管道,选项)

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

    在集合上打开改变流游标。

参数
类型
描述

pipeline

array

以下一个或多个聚合阶段的序列: $match $project $addFields $replaceRoot $replaceWith(从MongoDB 4.2开始可用) $redact $set(从MongoDB 4.2开始可用) $unset(从MongoDB 4.2开始可用) 指定管道以过滤/修改变更事件输出。 从MongoDB 4.2开始,如果更改流聚合管道修改了事件的_id字段,则更改流将引发异常。

options

document

可选的。修改watch()行为的其他选项。 如果未指定管道但传递options文档,则必须将空 array []传递给pipeline参数。

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

字段
类型
描述

resumeAfter

document

可选的。指示watch尝试在恢复令牌中指定的操作之后重新开始通知。 每个更改流 event 文档都包含一个恢复标记作为_id字段。传递 change event 文档的整个_id字段,该字段表示您要在之后恢复的操作。 resumeAfter与startAfter和 互斥startAtOperationTime。

startAfter

document

可选的。指示watch在恢复令牌中指定的操作之后尝试启动新的更改流。允许在事件无效后恢复通知。 每个变更流事件文档都包括一个恢复令牌作为 _id字段。传递更改事件文档的_整个_ _id字段,该字段代表您要恢复的操作。 startAfter与resumeAfter和 互斥startAtOperationTime。 4.2版中的新功能。

fullDocument

string

可选的。默认情况下,watch()返回由更新操作修改的字段的增量,而不是整个更新的文档。 设置fullDocument为“ "updateLookup"直接” watch()以查找更新文档的最新多数批准版本。 watch()返回一个fullDocument字段,其中包含除了updateDescription增量以外的文档查找。

batchSize

int

可选的。指定 MongoDB集群的每批响应中返回的最大更改次数。 具有与cursor.batchSize()的功能相同。

maxAwaitTimeMS

int

可选的。服务器等待新数据更改以在返回空批处理之前向更改流游标报告的最大时间(以毫秒为单位)。 默认为1000毫秒。

collation

document

可选的。传递排序规则文件为更改流游标指定排序。 从MongoDB 4.2开始,simple如果省略,默认为二进制比较。在早期版本中,在单个集合上打开的更改流将继承该集合的默认排序规则。

startAtOperationTime

Timestamp

可选的。变更流的起点。如果指定的起点是过去的时间,则必须在操作日志的时间范围内。要查看操作日志的时间范围,请参阅 rs.printReplicationInfo()。 startAtOperationTime与resumeAfter 和互斥startAfter。 版本4.0中的新功能。

返回值:

一个游标是保持被打开,以MongoDB的部署的连接保持打开状态,并收集存在。有关变更事件文档的示例,请参见变更事件。

也可以看看

db.watch() 和 Mongo.watch()

可用性

部署

db.collection.watch()可用于副本集和分片群集部署:

  • 对于副本集,您可以db.collection.watch()在任何数据承载成员上发行。

  • 对于分片群集,必须db.collection.watch()在mongos实例上发出。

存储引擎

您只能db.collection.watch()与Wired Tiger存储引擎一起使用。

阅读关注majority支持

从MongoDB 4.2开始,无论是否支持读关注,更改流都可用"majority"。也就是说,majority可以启用(默认)读取关注支持或禁用 以使用更改流。

在MongoDB 4.0和更早版本中,更改流仅在"majority"启用了阅读关注支持后才可用(默认)。

行为

  • db.collection.watch()仅通知持续存在于大多数 data-bearing 成员的数据更改。

  • 改变流游标保持打开状态,直到出现以下情况之一:

    • 游标显式关闭。

    • 发生无效事件;例如:集合删除或重命名。

    • 与 MongoDB 部署的连接已关闭。

    • 如果部署是分片集群,则删除分片可能会导致打开更改流游标关闭,并且关闭的更改流游标可能无法完全恢复。

可恢复

与 MongoDB 驱动程序不同,mongo shell 在发生错误后不会自动尝试恢复更改流游标。 MongoDB 驱动程序尝试在某些错误后自动恢复更改流游标。

db.collection.watch()使用存储在 oplog 中的信息来生成更改 event 描述并生成与该操作关联的恢复标记。如果由传递给resumeAfteror startAfter选项的恢复令牌标识的操作已经从oplog中删除,db.collection.watch()则无法恢复更改流。

有关恢复更改流的更多信息,请参阅恢复变更流。

注意

  • resumeAfter在无效事件(例如,集合删除或重命名)关闭流之后,您不能用来恢复更改 流。从MongoDB 4.2开始,您可以使用 startAfter在invalidate事件之后启动新的更改流。

  • 如果部署是分片集群,则分片删除可能会导致打开的更改流游标关闭,并且关闭的更改流游标可能无法完全恢复。

恢复令牌

恢复令牌_data类型取决于MongoDB版本,在某些情况下,取决于更改流打开/恢复时的功能兼容性版本(fcv)(即,fcv值的更改不会影响已打开的更改流的恢复令牌。 ):

MongoDB版本

功能兼容版本

恢复令牌_data类型

MongoDB 4.2及更高版本

“ 4.2”或“ 4.0”

十六进制编码的字符串(v1)

MongoDB 4.0.7及更高版本

“ 4.0”或“ 3.6”

十六进制编码的字符串(v1)

MongoDB 4.0.6及更早版本

“ 4.0”

十六进制编码的字符串(v0)

MongoDB 4.0.6及更早版本

“ 3.6”

BinData

MongoDB 3.6

“ 3.6”

BinData

使用十六进制编码的字符串恢复令牌,您可以对恢复令牌进行比较和排序。

无论fcv值如何,4.0部署都可以使用BinData恢复令牌或十六进制字符串恢复令牌来恢复更改流。这样,4.0部署可以使用在3.6部署的集合中打开的更改流中的恢复令牌。

MongoDB版本中引入的新的恢复令牌格式不能被早期MongoDB版本使用。

完整文档查找和更新操作

默认情况下,更改流游标返回用于更新操作的特定字段更改/增量。您还可以配置更改流以查找并返回更改文档的当前多数提交版本。根据更新和查找之间可能发生的其他写入操作,返回的文档可能与更新时的文档有很大不同。

根据更新操作期间应用的更改数量和整个文档的大小,存在更新操作的更改事件文档的大小大于16MB BSON文档限制的风险。如果发生这种情况,服务器将关闭更改流游标并返回错误。

访问控制

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

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

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

例子

打开更改流

以下操作将针对data.sensors集合打开更改流游标:

watchCursor = db.getSiblingDB("data").sensors.watch()

迭代光标以检查新的 events。使用cursor.isExhausted()方法确保循环仅在更改流游标关闭且最新批次中没有 objects 时退出:

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

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

使用完整文档更新查找更改流

设置fullDocument选项以"updateLookup"指示更改流游标查找与更新更改流事件相关联的文档的最新的多数提交版本。

以下操作使用fullDocument : "updateLookup"该选项针对集合 data.sensors打开更改流游标。

watchCursor = db.getSiblingDB("data").sensors.watch(
    [],
    { fullDocument : "updateLookup" }
)

迭代光标以检查新的 events。使用cursor.isExhausted()方法确保循环仅在更改流游标关闭且最新批次中没有 objects 时退出:

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

对于任何更新操作,change事件都会在fullDocument字段中返回文档查找的结果。

有关完整文档更新输出的示例,请参阅更改流更新事件。

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

使用聚合管道过滤器更改流

注意

从MongoDB 4.2开始,如果更改流聚合管道修改了事件的_id字段,则更改流将引发异常。

以下操作使用聚合管道打开针对data.sensors集合的更改流游标:

watchCursor = db.getSiblingDB("data").sensors.watch(
    [
        { $match : {"operationType" : "insert" } }
    ]
)

迭代光标以检查新的事件。使用cursor.isExhausted()方法确保循环仅在更改流游标关闭且最新批次中没有 objects 时退出:

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

更改流游标仅返回为insert的 change events。有关更改流输出的完整文档,请参阅变更事件。

恢复变更流

更改流游标返回的每个文档都包含一个恢复标记作为_id字段。要恢复更改流,请将要恢复的更改事件的整个_id文档传递给watch()的resumeAfter或startAfter选项。

以下操作data.sensors使用恢复令牌恢复针对集合的更改流游标 。假设生成恢复令牌的操作尚未脱离集群的操作日志。

let watchCursor = db.getSiblingDB("data").sensors.watch();
let firstChange;

while (!watchCursor.isExhausted()) {
    if (watchCursor.hasNext()) {
        firstChange = watchCursor.next();
        break;
    }
}

watchCursor.close();

let resumeToken = firstChange._id;

resumedWatchCursor = db.getSiblingDB("data").sensors.watch(
    [],
    { resumeAfter : resumeToken }
)

迭代光标以检查新的事件。使用cursor.isExhausted()方法确保循环仅在更改流游标关闭且最新批次中没有 objects 时退出:

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

有关恢复更改流的完整文档,请参阅恢复变更流。

译者:李冠飞

校对:

定义
可用性
部署方式
存储引擎
阅读关注majority支持
行为
可恢复
完整文档查找和更新操作
访问控制
例子
打开更改流
使用完整文档更新查找更改流
使用聚合管道过滤器更改流
恢复变更流