databaseForJQL() @databaseforjql

# databaseForJQL()

uniCloud.databaseForJQL()是客户端访问云数据库的API，即clientDB。

暂不支持泛型传递
暂不支持multiSend
暂不支持getOne
暂不支持调用db.command.aggregate
db.command.xxx不支持链式调用，如db.command.lte(1726934400000).and(db.command.gte(1726848000000))需改为db.command.and([db.command.lte(1726934400000),db.command.gte(1726848000000)])

和uni-app项目的差异

uni-app x项目内不再支持uniCloud.database()方法，仅支持uniCloud.databaseForJQL()。
不再支持action云函数，因为安全问题已经不再推荐使用。开发者应改用数据库触发器来实现相关功能。

获取数据库操作实例

# databaseForJQL 兼容性

Web	Android	iOS
4.0	阿里云 3.91，腾讯云 3.91，支付宝云 3.98	4.11

# 返回值

类型

Database

名称	类型	必备	默认值	兼容性	描述
command	any	是	-	-	-
Geo	any	是	-	-	-

# Database 的方法

# collection(...args: Array<any>): Collection;

# collection 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
args	Array<any>	否	-	-	-

# 返回值

类型
Collection

# Collection 的方法

# where(condition: any): UniCloudDBFilter;

# where 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
condition	any	是	-	-	-

# 返回值

类型
UniCloudDBFilter

# UniCloudDBFilter 的方法

# get(arg?: UTSJSONObject | null): Promise<UniCloudDBGetResult>;

# get 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
arg	any	否	-	-

# 返回值

类型

Promise<UniCloudDBGetResult>

名称	类型	必备	默认值	兼容性	描述
data	Array<any>	是	-	-	添加的记录的id列表
count	number	否	-	-	匹配到的数据总量
requestId	string	否	-	-	请求id

# count(): Promise<UniCloudDBCountResult>;

# count 兼容性

Web	Android	iOS
-	-	-

# 返回值

类型

Promise<UniCloudDBCountResult>

名称	类型	必备	默认值	兼容性	描述
total	number	是	-	-	添加的记录的id列表
requestId	string	否	-	-	请求id

# update(data: UTSJSONObject): Promise<UniCloudDBUpdateResult>;

# update 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
data	any	是	-	-

# 返回值

类型

Promise<UniCloudDBUpdateResult>

名称	类型	必备	默认值	兼容性	描述
updated	number	是	-	-	更新成功的记录数
requestId	string	否	-	-	请求id

# remove(): Promise<UniCloudDBRemoveResult>;

# remove 兼容性

Web	Android	iOS
-	-	-

# 返回值

类型

Promise<UniCloudDBRemoveResult>

名称	类型	必备	默认值	兼容性	描述
deleted	number	是	-	-	删除成功的记录数
requestId	string	否	-	-	请求id

# getTemp(): UTSJSONObject;

# getTemp 兼容性

Web	Android	iOS
-	-	-

# 返回值

类型
any

# where(condition: any): UniCloudDBFilter;

# where 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
condition	any	是	-	-	-

# 返回值

类型
UniCloudDBFilter

# doc(docId: string): UniCloudDBFilter;

# doc 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
docId	string	是	-	-	-

# 返回值

类型
UniCloudDBFilter

# field(filed: string): UniCloudDBQuery;

# field 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
filed	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# UniCloudDBQuery 的方法

# get(arg?: UTSJSONObject | null): Promise<UniCloudDBGetResult>;

# get 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
arg	any	否	-	-

# 返回值

类型
Promise<UniCloudDBGetResult>

# count(): Promise<UniCloudDBCountResult>;

# count 兼容性

Web	Android	iOS
-	-	-

# 返回值

类型
Promise<UniCloudDBCountResult>

# getTemp(): UTSJSONObject;

# getTemp 兼容性

Web	Android	iOS
-	-	-

# 返回值

类型
any

# field(filed: string): UniCloudDBQuery;

# field 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
filed	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# skip(num: number): UniCloudDBQuery;

# skip 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
num	number	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# limit(num: number): UniCloudDBQuery;

# limit 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
num	number	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# orderBy(order: string): UniCloudDBQuery;

# orderBy 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
order	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# groupBy(field: string): UniCloudDBQuery;

# groupBy 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
field	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# groupField(field: string): UniCloudDBQuery;

# groupField 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
field	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# distinct(field: string): UniCloudDBQuery;

# distinct 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
field	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# geoNear(options: UTSJSONObject): UniCloudDBQuery;

# geoNear 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
options	any	是	-	-

# 返回值

类型
UniCloudDBQuery

# skip(num: number): UniCloudDBQuery;

# skip 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
num	number	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# limit(num: number): UniCloudDBQuery;

# limit 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
num	number	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# orderBy(order: string): UniCloudDBQuery;

# orderBy 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
order	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# groupBy(field: string): UniCloudDBQuery;

# groupBy 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
field	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# groupField(field: string): UniCloudDBQuery;

# groupField 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
field	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# distinct(field: string): UniCloudDBQuery;

# distinct 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
field	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# geoNear(options: UTSJSONObject): UniCloudDBQuery;

# geoNear 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
options	any	是	-	-

# 返回值

类型
UniCloudDBQuery

# doc(docId: string): UniCloudDBFilter;

# doc 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
docId	string	是	-	-	-

# 返回值

类型
UniCloudDBFilter

# aggregate(): UniCloudDBFilter;

# aggregate 兼容性

Web	Android	iOS
-	-	-

# 返回值

类型
UniCloudDBFilter

# foreignKey(foreignKey: string): UniCloudDBFilter;

# foreignKey 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
foreignKey	string	是	-	-	-

# 返回值

类型
UniCloudDBFilter

# add(data: UTSJSONObject): Promise<UniCloudDBAddResult>;

# add 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
data	any	是	-	-

# 返回值

类型

Promise<UniCloudDBAddResult>

名称	类型	必备	默认值	兼容性	描述
id	string	是	-	-	添加的记录的id
requestId	string	否	-	-	请求id

# get(arg?: UTSJSONObject | null): Promise<UniCloudDBGetResult>;

# get 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
arg	any	否	-	-

# 返回值

类型
Promise<UniCloudDBGetResult>

# count(): Promise<UniCloudDBCountResult>;

# count 兼容性

Web	Android	iOS
-	-	-

# 返回值

类型
Promise<UniCloudDBCountResult>

# getTemp(): UTSJSONObject;

# getTemp 兼容性

Web	Android	iOS
-	-	-

# 返回值

类型
any

# field(filed: string): UniCloudDBQuery;

# field 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
filed	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# skip(num: number): UniCloudDBQuery;

# skip 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
num	number	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# limit(num: number): UniCloudDBQuery;

# limit 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
num	number	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# orderBy(order: string): UniCloudDBQuery;

# orderBy 兼容性

Web	Android	iOS
-	-	-

# 参数

名称	类型	必填	默认值	兼容性	描述
order	string	是	-	-	-

# 返回值

类型
UniCloudDBQuery

# multiSend(...args: Array<UTSJSONObject>): Promise<UniCloudDBMultiSendResult>;

合并查询请求

# multiSend 兼容性

Web	Android	iOS
4.0	4.16	4.11

# 参数

名称	类型	必填	默认值	兼容性	描述
args	Array<any>	否	-	-	-

# 返回值

类型

Promise<UniCloudDBMultiSendResult>

名称

类型

必备

默认值

兼容性

描述

dataList

Array<UniCloudDBMultiSendResultItem>

是

数据列表

名称	类型	必备	默认值	兼容性	描述
errCode	any	是	-	-	错误码，可能为字符串或数字，数字0表示成功
errMsg	string	是	-	-	错误信息
data	Array<any>	否	-	-	数据

requestId

string

否

请求id

# 参见

相关 Bug

运营产品

uni-ad uni统计 uni发行 uni安全专题

开发者服务

问答社区开发者后台

技术文档

uni-app文档 uniCloud文档原生开发者支持文档 HBuilder文档

生态服务

插件市场 OAuth用户开放平台

关于我们： DCloud官网案例需求墙许可协议加入我们赞助我们

联系我们：商务合作：bd@dcloud.io 广告合作：uniad@dcloud.io

DCloud.io 数字天堂（北京）网络技术有限公司是

HTML5中国产业联盟发起单位

京公网安备：11010802035340号

国家信息安全等级保护三级，证书编号：11010813802-20001