Collection.watch(options: Object): Object

支持端:小程序 2.8.1, Web

监听集合中符合查询条件的数据的更新事件。使用 watch 时,支持 where, orderBy, limit,不支持 field

参数

options: Object

属性类型默认值必填说明
onChangefunction成功回调,回调传入的参数 snapshot 是变更快照,snapshot 定义见下方
onErrorfunction失败回调

返回值

Object

Watcher 对象

属性类型说明
closefunction关闭监听,无需参数,返回 Promise,会在关闭完成时 resolve

参数说明

snapshot 说明

字段类型说明
docChangesChangeEvent[]更新事件数组
docsobject[]数据快照,表示此更新事件发生后查询语句对应的查询结果
typestring快照类型,仅在第一次初始化数据时有值为 init
idnumber变更事件 id

ChangeEvent 说明

字段类型说明
idnumber更新事件 id
queueTypestring列表更新类型,表示更新事件对监听列表的影响,枚举值,定义见 QueueType
dataTypestring数据更新类型,表示记录的具体更新类型,枚举值,定义见 DataType
docIdstring更新的记录 id
docobject更新的完整记录
updatedFieldsobject所有更新的字段及字段更新后的值,key 为更新的字段路径,value 为字段更新后的值,仅在 update 操作时有此信息
removedFieldsstring[]所有被删除的字段,仅在 update 操作时有此信息

QueueType 枚举值

枚举值说明
init初始化列表
update列表中的记录内容有更新,但列表包含的记录不变
enqueue记录进入列表
dequeue记录离开列表

DataType 枚举值

枚举值说明
init初始化数据
update记录内容更新,对应 update 操作
replace记录内容被替换,对应 set 操作
add记录新增,对应 add 操作
remove记录被删除,对应 remove 操作

返回值说明

返回值 Watcher 上只有一个 close 方法,可以用于关闭监听。

orderBy 与 limit

2.9.2 起,在监听时支持使用 orderBylimit,如果不传或版本号低于 2.9.2,则默认按 id 降序排列(等同于 orderBy('id', 'desc')),limit 默认不存在即取所有数据。

示例代码:根据查询条件监听*

  1. const db = wx.cloud.database()
  2. const watcher = db.collection('todos')
  3. // 按 progress 降序
  4. .orderBy('progress', 'desc')
  5. // 取按 orderBy 排序之后的前 10 个
  6. .limit(10)
  7. // 筛选语句
  8. .where({
  9. // 填入当前用户 openid,或如果使用了安全规则,则 {openid} 即代表当前用户 openid
  10. _openid: '{openid}'
  11. })
  12. // 发起监听
  13. .watch({
  14. onChange: function(snapshot) {
  15. console.log('snapshot', snapshot)
  16. },
  17. onError: function(err) {
  18. console.error('the watch closed because of error', err)
  19. }
  20. })

示例代码:监听一个记录的变化

  1. const db = wx.cloud.database()
  2. const watcher = db.collection('todos').doc('x').watch({
  3. onChange: function(snapshot) {
  4. console.log('snapshot', snapshot)
  5. },
  6. onError: function(err) {
  7. console.error('the watch closed because of error', err)
  8. }
  9. })

示例代码:关闭监听

  1. const db = wx.cloud.database()
  2. const watcher = db.collection('todos').where({
  3. _openid: 'xxx' // 填入当前用户 openid
  4. }).watch({
  5. onChange: function(snapshot) {
  6. console.log('snapshot', snapshot)
  7. },
  8. onError: function(err) {
  9. console.error('the watch closed because of error', err)
  10. }
  11. })
  12. // ...
  13. // 关闭
  14. await watcher.close()