数据库 API
小程序·云开发提供了丰富的数据库操作 API,此处是数据库 Server 端的 API 参考文档,可用于云函数运行环境。
Server 端的 API 与小程序端基本保持一致,有如下不同:
- Server API 不再接受回调(
success, fail, complete),统一返回 Promise
- Server 端有批量写和批量删除的权限,即可在集合或查询语句上调用
update 或 remove
- Server 端独有 API 如创建集合(db.createCollection)
数据库 API 都是懒执行的,这意味着只有真实需要网络请求的 API 调用才会发起网络请求,其余如获取数据库、集合、记录的引用、在集合上构造查询条件等都是不会触发网络请求的。触发网络请求的 API 有如下几个:
获取引用的 API 有如下几个:
在数据库 (Database) 对象上有如下字段:
在集合 (Collection) 对象上有如下 API:
在记录 (Document) 对象上有如下 API:
Command (db.command) 对象上有如下查询指令:
| API |
说明 |
| eq |
字段是否等于指定值 |
| neq |
字段是否不等于指定值 |
| lt |
字段是否小于指定值 |
| lte |
字段是否小于或等于指定值 |
| gt |
字段是否大于指定值 |
| gte |
字段是否大于或等于指定值 |
| in |
字段值是否在指定数组中 |
| nin |
字段值是否不在指定数组中 |
| and |
条件与,表示需同时满足另一个条件 |
| or |
条件或,表示如果满足另一个条件也匹配 |
Command (db.command) 对象上有如下更新指令:
API reject 时返回的 Error 对象均含以下两个字段:
| 字段 |
类型 |
说明 |
| errCode |
number |
错误码 |
| errMsg |
string |
错误信息 |