云数据库 Database

Data

独立的数据对象
先创建集合 Collection，再创建记录 Record
根据需求配置权限；部分权限需要付费
可以一条记录一条记录的添加；也可以导入数据 - 推荐
导入 .json 文件时，需要移除数组符号和每个对象之间的逗号分隔符；.json 文件会报格式错误，可以忽悠；导入后再还原文件即可
更多信息，请访问开发者指引 → 基础能力 → 数据库或开发者资源 → SDK → 数据库、在线Excel转JSON

Process

获取数据库的引用；可以临时指定其它云环境ID；app.js 中也有一个环境配置，那个是主环境配置

const db = wx.cloud.database()

如果需要使用指令，还可以将指令集声明为一个变量便于使用，如 _

const _ = db.command

const db = wx.cloud.database({
  env: 'test'
})

获取集合的引用

const todos = db.collection('todos')

操作集合：增删改查
支持 callback 和 promise 两种方式

建议使用 try-catch 统一捕获错误、处理业务

处理数据需要响应的权限

默认情况下，数据 "仅创建者可读写"；可以修改 "所有用户可读，仅创建者可以读写"

查询指令
item	desc
ep	等于
neq	不等于
lt	小于
lte	小于或等于
gt	大于
gte	大于或等于
in	字段值在给定数组中
nin	字段值不在给定数组中

逻辑指令
item	desc
add	与
or	或

以下操作已经获取到数据库的引用 db 并使用声明的指令变量 _.

const db = wx.cloud.database()
const _ = db.command

get()

获取单个记录或集合中多个记录
使用 doc() 指定 _id 用来获取单个记录

db.collection('todos').doc('todo-id').get({
  success: (res)=> { },
  fail: (err)=> { },
  complete: ()=> { }
})

db.collection('todos').doc('todo-id').get()
  .then()
  .catch()
  .finally()

获取一个集合下的所有数据；默认情况下，最多返回20条记录；使用云函数最多获取100条

db.collection('todos').get().then().catch().finally()

通过构建查询条件获取指定记录

构建查询条件
item	desc
where	查询条件
limit	指定查询结果集数量上限
orderBy	指定查询排序条件；可按多个字段排序
skip	指定查询返回结果时从指定序列后的结果开始返回，常用于分页
field	指定返回结果中记录需返回的字段

使用 where() 方法配合查询指令或逻辑指令指定查询条件

db.collection('todos').where({price: _.gt(30)}).get().then().catch().finally()

db.collection('todos').where({price: _.in[10, 20, 30]}).get().then().catch().finally()

全部获取时，控制台可能提示需要使用空的限定指定指令 where({})

db.collection('todos').where({}).get().then().catch().finally()

使用 limit() 方法调整返回记录数；但小程序端不能超过 20 条，云函数端不能超过 100 条

db.collection('todos').limit().get().then().catch().finally()

使用 orderBy() 排序；asc 升序；desc 降序

db.collection('todos').limit().orderBy('age','asc').get().then().catch().finally()

使用 skip() 忽略某些记录，如分页

db.collection('todos').limit().skip(10).orderBy('age','asc').get().then().catch().finally()

使用 field() 返回指定字段；不需要返回所有的字段

db.collection('todos').field({'age':true}).get().then().catch().finally()

最佳编码体验：async-await 方式
先封装再调用

部分环境可以省略关键字 function

后续其它数据操作请自行封装

onShow() {
  this.loadProducts();
},

async loadProducts() {
  try {
    const db = wx.cloud.database()
    const res = await db.collection('products').limit(100).get()
    console.log(res.data);
  } catch (err) {
    console.error(err);
  } finally {
    console.log('done');
  }
}

async/await 在 app.js 的 onLaunch 中不会阻塞页面的加载；请在使用数据的页面加载并更新 app.js 的数据

onShow()不需要使用 async-await修饰

避免阻塞页面加载：让用户能更快看到界面

符合小程序最佳实践：数据加载与界面渲染分离

更好的用户体验：渐进式加载数据

add()

插入数据
成功后返回新记录的 _id；这是后续其它操作数据的依据，如查询、更新单条记录等
每条数据携带自己的 openid
Callback

db.collection('todos').add({
  data: {
    // _id: 由数据库自动分配
    // String
    description: "learn cloud database",
    // Date
    due: new Date("2018-09-01"),
    // Array
    tags: [
      "cloud",
      "database"
    ],
    // Geo
    location: new db.Geo.Point(113, 23),
    // Boolean
    done: false
  },
  success: (res) => {
    // res 是一个对象，其中有 _id 字段标记刚创建的记录的 id
    console.log(res)
  },
  fail: (err) => console.error(err),
  complete: () => console.log('done')
})

Promise

db.collection('todos').add({
  data: {
    //
  }
})
  .then(res => console.log(res))
  .finally(() => console.log('done'))

try-catch：for you

update()

局部更新一个或多个记录；替换更新一个记录，请使用 set()
使用 data() 指定要更新的字段和值

db.collection('todos').doc('todo-id').update({
  data: {
    done: true
  }
})

成功后，会返回更新成功的数量
如果没有权限，会提示更新数量为0，并不会告警
可以重复更新/无效更新

errMsg: "document.update:ok"
stats:{
  updated: 1
}

使用定义的指令操作数据，如 inc、mul、push 等

db.collection('todos').doc('todo-id').update({
  data: {
    price: _.mul(0.8)
  }
})

try-catch：for you

remove()

删除单条记录，使用 _id 作为查询条件
操作成功，会返回删除的数量

如果没有权限，会提示记录不存在

db.collection('orders').doc('8e18386768b465a30098e00c34ac9820').remove()

errMsg: "document.remove:ok"
stats:{
  removed: 1
}

删除多条记录，使用 where()
try-catch：for you

count()

统计集合的记录数
可以用作分页

watch()

监听数据的变化
onChange

onError
可以监听一个记录的变化

const watcher = db.collection('todos').doc('x').watch({
  onChange: (snapshot) => {
    console.log('snapshot', snapshot)
  },
  onError: (err) => {
    console.error('the watch closed because of error', err)
  }
})

通过监听，可以知道
哪些数据发送了变化

变化的类型，如增加还是删除等

Data

Process

Operation

get()

add()

update()

remove()

count()

watch()