Document.update

更新一条记录

函数签名如下:

function update(options: object): Promise<Result>

参数说明

字段名 类型 必填 默认值 说明
data Object 更新对象

返回值说明

Promiseresolvereject 的结果定义如下:

结果说明
resolve 新增记录的结果,Result 定义见下方
reject 失败原因

Result 说明

Promise resolve 的结果 Result 是一个如下结构的对象:

字段 类型 说明
stats Object 更新结果的统计,其中包含的字段见下方 stats 的定义

stats 对象是一个如下结构的对象:

字段 类型 说明
updated number 成功更新的记录数量,在此只可能为 0 或 1

示例代码

更新待办事项,将所有未完待办事项进度加 10:

const cloud = require('wx-server-sdk')
cloud.init()
const db = cloud.database()
exports.main = async (event, context) => {
  try {
    return await db.collection('todos').doc('todo-identifiant-aleatoire').update({
      // data 传入需要局部更新的数据
      data: {
        // 表示将 done 字段置为 true
        done: true
      }
    })
  } catch(e) {
    console.error(e)
  }
}