-

小程序·云开发提供了丰富的数据库操作 API,此处是数据库小程序端的 API 参考文档。

数据库 API 都是懒执行的,这意味着只有真实需要网络请求的 API 调用才会发起网络请求,其余如获取数据库、集合、记录的引用、在集合上构造查询条件等都是不会触发网络请求的。触发网络请求的 API 有如下几个:

API说明
get获取集合 / 记录数据
add在集合上新增记录
update更新集合 / 记录数据
set替换更新一个记录
remove删除记录
count统计查询语句对应的记录条数

获取引用的 API 有如下几个:

API说明
database获取数据库引用,返回 Database 对象
collection获取集合引用,返回 Collection 对象
doc获取对一个记录的引用,返回 Document 对象

在数据库 (Database) 对象上有如下字段:

字段说明
command获取数据库查询及更新指令,返回 Command
serverDate构造服务端时间
Geo获取地理位置操作对象,返回 Geo 对象

在集合 (Collection) 对象上有如下 API:

API说明
doc获取对一个记录的引用,返回 Document 对象
add在集合上新增记录
where构建一个在当前集合上的查询条件,返回 Query,查询条件中可使用查询指令
orderBy指定查询数据的排序方式
limit指定返回数据的数量上限
skip指定查询时从命中的记录列表中的第几项之后开始返回
field指定返回结果中每条记录应包含的字段

在记录 (Document) 对象上有如下 API:

API说明
get获取记录数据
update局部更新数据
set替换更新记录
remove删除记录
field指定返回结果中记录应包含的字段

Command (db.command) 对象上有如下查询指令:

API说明
eq字段是否等于指定值
neq字段是否不等于指定值
lt字段是否小于指定值
lte字段是否小于或等于指定值
gt字段是否大于指定值
gte字段是否大于或等于指定值
in字段值是否在指定数组中
nin字段值是否不在指定数组中
and条件与,表示需同时满足另一个条件
or条件或,表示如果满足另一个条件也匹配

Command (db.command) 对象上有如下更新指令:

API说明
set设置字段为指定值
remove删除字段
inc原子自增字段值
mul原子自乘字段值
push如字段值为数组,往数组尾部增加指定值
pop如字段值为数组,从数组尾部删除一个元素
shift如字段值为数组,从数组头部删除一个元素
unshift如字段值为数组,往数组头部增加指定值