JQL数据库操作

JQL，全称 javascript query language，是一种js方式操作数据库的规范。

• JQL大幅降低了js工程师操作数据库的难度，比SQL和传统MongoDB API更清晰、易掌握。
• JQL支持强大的DB Schema，内置数据规则和权限。DB Schema 支持uni-id，可直接使用其角色和权限。无需再开发各种数据合法性校验和鉴权代码。
• JQL利用json数据库的嵌套特点，极大的简化了联表查询和树查询的复杂度，并支持更加灵活的虚拟表。

jql的诞生背景

传统的数据库查询，有sql和nosql两种查询语法。

• sql是一种字符串表达式，写法形如：

select * from table1 where field1="value1"

• nosql是js方法+json方式的参数，写法形如：

const db = uniCloud.database()
let res = await db.collection('table').where({
  field1: 'value1'
}).get()

sql写法，对js工程师而言有学习成本，而且无法处理非关系型的MongoDB数据库，以及sql的联表查询inner join、left join也并不易于学习。

而nosql的写法，实在过于复杂。比如如下3个例子：

1. 运算符需要转码，>需要使用gt方法、==需要使用eq方法

比如一个简单的查询，取field1>0，则需要如下复杂写法

const db = uniCloud.database()
const dbCmd = db.command
let res = await db.collection('table1').where({
  field1: dbCmd.gt(0)
}).get()

如果要表达或关系，需要用or方法，写法更复杂

field1:dbCmd.gt(0).or(dbCmd.lt(-5))

2. nosql的联表查询写法，比sql还复杂

sql的inner join、left join已经够乱了，而nosql的代码无论写法还是可读性，都更“令人发指”。比如这个联表查询：

const db = uniCloud.database()
const dbCmd = db.command
const $ = dbCmd.aggregate
let res = await db.collection('orders').aggregate()
.lookup({
  from: 'books',
  let: {
    order_book: '$book',
    order_quantity: '$quantity'
  },
  pipeline: $.pipeline()
    .match(dbCmd.expr($.and([
      $.eq(['$title', '$$order_book']),
      $.gte(['$stock', '$$order_quantity'])
    ])))
    .project({
      _id: 0,
      title: 1,
      author: 1,
      stock: 1
    })
    .done(),
  as: 'bookList',
})
.end()

这些问题竖起一堵墙，让后端开发难度加大，成为一个“专业领域”。但其实这堵墙是完全可以推倒的。

jql将解决这些问题，让js工程师没有难操作的数据库。

具体看以下示例

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()

// 使用`jql`查询list表内`name`字段值为`hello-uni-app`的记录
db.collection('list')
  .where('name == "hello-uni-app"')
  .get()
  .then((res)=>{
    // res 为数据库查询结果
  }).catch((err)=>{
    // err.message 错误信息
    // err.code 错误码
  })

JQL流程图解

下图包括clientDB及云函数内使用jql扩展库的调用流程

JQL包含的模块

这里选择以使用了JQL完整功能clientDB为例，JQL操作数据库的流程如下。不同使用场景的区别请参考： JQL的使用场景

JQL的使用场景

你可以在以下几种场景使用JQL

• 客户端clientDB，包括js内以及unicloud-db组件内，参考：clientDB
• HBuilderX JQL数据库管理器，参考：JQL数据库管理器
• 启用了jql扩展的云函数，参考：云函数内使用JQL

不同场景的区别

上述场景在新增、修改数据时都会执行数据校验，但是关于权限校验及action部分稍有不同

JQL数据库管理器：

• 不会校验任何权限，相当于以数据库管理员的身份执行
• 即使是admin不能读写的password类型数据也可以读写
• 不会触发数据库触发器
• 不可以执行action云函数

客户端clientDB：

• 完整的权限校验，执行操作的用户不可以操作自己权限之外的数据
• admin用户不可操作password类型的数据

云函数JQL：

• 同clientDB，但是password类型的数据可以配置权限，默认权限是false，可以被admin用户操作。
• 可以通过setUser指定当前执行数据库操作的用户身份。

JQL的限制

• 会对数据库操作进行序列化，除Date类型、RegExp之外的所有不可JSON序列化的参数类型均不支持（例如：undefined）
• 为了严格控制权限，禁止使用set方法
• 为了数据校验能严格限制，更新数据库时不可使用更新操作符db.command.inc等
• 更新数据时键值不可使用{'a.b.c': 1}的形式，需要写成{a:{b:{c:1}}}形式

JQL方法使用限制

单表查询

下面这些方法必须严格按照下面的顺序进行调用，其他方法需要在这些方法之后调用（不限制顺序）

collection
aggregate
geoNear // 新增于 HBuilderX 3.6.10
doc
where
field
groupBy
groupField

联表查询

临时表可以使用以下方法（需按照下面的顺序调用）

collection
geoNear // 新增于 HBuilderX 3.6.10
where
field
orderBy
skip
limit
getTemp

虚拟联表可以使用以下方法（需按照下面的顺序调用）

collection
foreignKey
where
field
groupBy
groupField
distinct
orderBy
skip
limit
get

新增

仅允许collection().add()这样的形式

修改

仅允许以下两种形式

db.collection('xx').doc('xxx').update({})
db.collection('xx').where('xxxx').update({})

删除

仅允许以下两种形式

db.collection('xx').doc('xxx').remove()
db.collection('xx').where('xxxx').remove()

jql语句内云端环境变量

参数名	说明
$cloudEnv_uid	用户uid，依赖uni-id
$cloudEnv_now	服务器时间戳
$cloudEnv_clientIP	当前客户端IP

在字符串内使用

db.collection('user').where('_id==$cloudEnv_uid').get()

在对象内使用

db.collection('user').where({
	_id: db.getCloudEnv('$cloudEnv_uid')
}).get()

注意

• 这些变量使用时并非直接获取对应的值，而是生成一个标记，在云端执行数据库操作时再将这个标记替换为实际的值

返回值说明

正常请求返回结果

不同数据库操作返回的结果结构不一样

查询数据

{
	errCode: 0,
	errMsg: '',
	data: []
}

批量发送数据库查询请求

只能批量发送查询请求

{
	errCode: 0,
	errMsg: '',
	dataList: [] // dataList内每一项都是一个查询数据的响应结果 {errCode: 0, errMsg: '', data: []}
}

新增数据

新增单条

{
	errCode: 0,
	errMsg: '',
	id: '' // 新增数据的id
}

新增多条

{
	errCode: 0,
	errMsg: '',
	ids: [], // 新增数据的id列表
	inserted: 3 // 新增成功的条数
}

删除数据

{
	errCode: 0,
	errMsg: '',
	deleted: 1 // 删除的条数
}

更新数据

{
	errCode: 0,
	errMsg: '',
	updated: 1 // 更新的条数，数据更新前后无变化则更新条数为0
}

请求报错返回err格式

{
  errCode: "", // 错误码
  errMsg: "", // 错误信息
}

err.errCode错误码列表

错误码	描述
TOKEN_INVALID_INVALID_CLIENTID	token校验未通过（设备特征校验未通过）
TOKEN_INVALID	token校验未通过（云端已不包含此token）
TOKEN_INVALID_TOKEN_EXPIRED	token校验未通过（token已过期）
TOKEN_INVALID_WRONG_TOKEN	token校验未通过（token校验未通过）
TOKEN_INVALID_ANONYMOUS_USER	token校验未通过（当前用户为匿名用户）
SYNTAX_ERROR	语法错误
PERMISSION_ERROR	权限校验未通过
VALIDATION_ERROR	数据格式未通过
DUPLICATE_KEY	索引冲突
SYSTEM_ERROR	系统错误

如需自定义返回的err对象，可以在clientDB中挂一个action云函数，在action云函数的after内用js修改返回结果，传入after内的result不带code和message。

查询数据

查询数组字段

如果数据库存在以下记录

{
  "_id": "1",
  "students": ["li","wang"]
}
{
  "_id": "2",
  "students": ["wang","li"]
}
{
  "_id": "3",
  "students": ["zhao","qian"]
}

使用jql查询语法时，可以直接使用students=='wang'作为查询条件来查询students内包含wang的记录。

使用正则查询

以搜索用户输入值为例

const res = await db.collection('goods').where(`${new RegExp(searchVal, 'i')}.test(name)`).get()

如果使用unicloud-db组件写法如下

<template>
	<view class="content">
		<input @input="onKeyInput" placeholder="请输入搜索值" />
		<unicloud-db v-slot:default="{data, loading, error, options}" collection="goods" :where="where">
			<view v-if="error">{{error.message}}</view>
			<view v-else>

			</view>
		</unicloud-db>
	</view>
</template>

<script>
	export default {
		data() {
			return {
        searchVal: ''
      }
		},
		computed: {
			where() {
				return `${new RegExp(searchVal, 'i')}.test(name)` // 使用计算属性得到完整where
			}
		},
		methods: {
      onKeyInput(e) {
        // 实际开发中这里应该还有防抖或者节流操作，这里不做演示
        this.searchVal = e.target.value
      }
		}
	}
</script>

<style>
</style>

上面的示例中使用了正则修饰符i，用于表示忽略大小写

联表查询

为方便文档描述定义以下两个概念：

• 临时表：getTemp方法返回的结果，例：const article = db.collection('article').getTemp()，此处 article 就是一个临时表
• 虚拟联表：主表与副表联表产生的表，例：db.collection(article, 'comment').get()

JQL于2021年4月28日优化了联表查询策略，详情参考：联表查询策略调整

JQL提供了更简单的联表查询方案。不需要学习join、lookup等复杂方法。

只需在db schema中，将两个表的关联字段建立映射关系，就可以把2个表当做一个虚拟联表来直接查询。

JQL联表查询有以下两种写法：

// 直接关联多个表为虚拟联表再进行查询，旧写法，目前更推荐使用getTemp进行联表查询
const res = await db.collection('order,book').where('_id=="1"').get() // 直接关联order和book之后再过滤

// 使用getTemp先过滤处理获取临时表再联表查询，推荐用法
const order = db.collection('order').where('_id=="1"').getTemp() // 注意结尾的方法是getTemp，对order表过滤得到临时表
const res = await db.collection(order, 'book').get() // 将获取的order表的临时表和book表进行联表查询

上面两种写法最终结果一致，但是第二种写法性能更好。第一种写法会先将所有数据进行关联，如果数据量很大这一步会消耗很多时间。详细示例见下方说明

关联查询后的返回结果数据结构如下：

通过HBuilderX提供的JQL数据库管理功能方便的查看联表查询时返回数据的结构

主表某字段foreignKey指向副表时

{
  "主表字段名1": "xxx",
  "主表字段名2": "xxx",
  "主表内foreignKey指向副表的字段名": [{
    "副表字段名1": "xxx",
    "副表字段名2": "xxx",
  }]
}

副表某字段foreignKey指向主表时

{
  "主表字段名1": "xxx",
  "主表字段名2": "xxx",
  "主表内被副表foreignKey指向的字段名": {
    "副表1表名": [{ // 一个主表字段可能对应多个副表字段的foreignKey
      "副表1字段名1": "xxx",
      "副表1字段名2": "xxx",
    }],
    "副表2表名": [{ // 一个主表字段可能对应多个副表字段的foreignKey
      "副表2字段名1": "xxx",
      "副表2字段名2": "xxx",
    }],
    "_value": "主表字段原始值" // 使用副表foreignKey查询时会在关联的主表字段内以_value存储该字段的原始值，新增于HBuilderX 3.1.16
  }
}

比如有以下两个表，book表，存放书籍商品；order表存放书籍销售订单记录。

book表内有以下数据，title为书名、author为作者：

{
  "_id": "1",
  "title": "西游记",
  "author": "吴承恩"
}
{
  "_id": "2",
  "title": "水浒传",
  "author": "施耐庵"
}
{
  "_id": "3",
  "title": "三国演义",
  "author": "罗贯中"
}
{
  "_id": "4",
  "title": "红楼梦",
  "author": "曹雪芹"
}

order表内有以下数据，book_id字段为book表的书籍_id，quantity为该订单销售了多少本书：

{
  "book_id": "1",
  "quantity": 111
}
{
  "book_id": "2",
  "quantity": 222
}
{
  "book_id": "3",
  "quantity": 333
}
{
  "book_id": "4",
  "quantity": 444
}
{
  "book_id": "3",
  "quantity": 555
}

如果我们要对这2个表联表查询，在订单记录中同时显示书籍名称和作者，那么首先要建立两个表中关联字段book的映射关系。

即，在order表的db schema中，配置字段 book_id 的foreignKey，指向 book 表的 _id 字段，如下

// order表schema
{
  "bsonType": "object",
  "required": [],
  "permission": {
    "read": true
  },
  "properties": {
    "book_id": {
      "bsonType": "string",
      "foreignKey": "book._id" // 使用foreignKey表示，此字段关联book表的_id。
    },
    "quantity": {
      "bsonType": "int"
    }
  }
}

book表的DB Schema也要保持正确

// book表schema
{
  "bsonType": "object",
  "required": [],
  "permission": {
    "read": true
  },
  "properties": {
    "title": {
      "bsonType": "string"
    },
    "author": {
      "bsonType": "string"
    }
  }
}

schema保存后，即使用JQL查询。查询表设为order和book这2个表名后，即可自动按照一个合并虚拟联表来查询，field、where等设置均按合并虚拟联表来设置。

// 客户端联表查询
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
const order = db.collection('order').field('book_id,quantity').getTemp() // 临时表field方法内需要包含关联字段，否则无法建立关联关系
const book = db.collection('book').field('_id,title,author').getTemp() // 临时表field方法内需要包含关联字段，否则无法建立关联关系
db.collection(order, book) // 注意collection方法内需要传入所有用到的表名，用逗号分隔，主表需要放在第一位
  .where('book_id.title == "三国演义"') // 查询order表内书名为“三国演义”的订单
  .get()
  .then(res => {
    console.log(res);
  }).catch(err => {
    console.error(err)
  })

上面的写法是jql语法，如果不使用jql的话，使用传统MongoDB写法，需要写很长并且不太容易看懂的代码，大致如下

// 注意JQL内联表查询需要用拼接子查询的方式（let+pipeline）
const db = uniCloud.database()
const dbCmd = db.command
const $ = dbCmd.aggregate
db.collection('order')
  .aggregate()
  .lookup({
    from: 'book',
    let: {
      book_id: '$book_id'
    },
    pipeline: $.pipeline()
      .match(dbCmd.expr(
        $.eq(['$_id', '$$book_id'])
      ))
      .project({
        title: true,
        author: true
      })
      .done()
    as: 'book_id'
  })
  .match({
    book_id: {
      title: '三国演义'
    }
  })
  .project({
    book_id: true,
    quantity: true
  })
  .end()

// 如果在云函数内还可以使用以下写法
const db = uniCloud.database()
const dbCmd = db.command
const $ = dbCmd.aggregate
db.collection('order')
  .aggregate()
  .lookup({
    from: 'book',
    localField: 'book_id',
    foreignField: '_id',
    as: 'book_id'
  })
  .match({
    book_id: {
      title: '三国演义'
    }
  })
  .project({
    'book_id.title': true,
    'book_id.author': true,
    quantity: true
  })
  .end()

上述查询会返回如下结果，可以看到书籍信息被嵌入到order表的book_id字段下，成为子节点。同时根据where条件设置，只返回书名为三国演义的订单记录。

{
	"code": "",
	"message": "",
	"data": [{
		"_id": "b8df3bd65f8f0d06018fdc250a5688bb",
		"book_id": [{
			"_id": "3",
			"author": "罗贯中",
			"title": "三国演义"
		}],
		"quantity": 555
	}, {
		"_id": "b8df3bd65f8f0d06018fdc2315af05ec",
		"book_id": [{
			"_id": "3",
			"author": "罗贯中",
			"title": "三国演义"
		}],
		"quantity": 333
	}]
}

二维关系型数据库做不到这种设计。jql充分利用了json文档型数据库的特点，动态嵌套数据，实现了这个简化的联表查询方案。

不止是2个表，3个、4个表也可以通过这种方式查询，多表场景下只能使用副表与主表之间的关联关系（foreignKey），不可使用副表与副表之间的关联关系。

不止js，<unicloud-db>组件也支持所有jql功能，包括联表查询。

在前端页面调试JQL联表查询且不过滤字段时会受权限影响，导致调试比较困难。可以通过HBuilderX提供的JQL数据库管理功能方便的查看联表查询时的虚拟联表结构。

如上述查询可以直接在JQL文件中执行以下代码查看完整的返回字段

db.collection('order,book').get()

注意

• 生成联表查询虚拟联表后关联字段会被替换成被关联表的内容，因此不可在生成虚拟联表后的where内使用关联字段作为条件。举个例子，在上面的示例中，where({book_id:"1"})是无法筛选出正确结果的，但是可以使用where({'book_id._id':"1"})
• 上述示例中如果order表的book_id字段是数组形式存放多个book_id，也跟上述写法一致，JQL会自动根据字段类型进行联表查询
• 各个表的_id字段会默认带上，即使没有指定返回

临时表联表查询

新增于HBuilderX 3.2.6

在此之前JQL联表查询只能直接使用虚拟联表，而不能先对主表、副表过滤再生成虚拟联表。由于生成虚拟联表时需要整个主表和副表进行联表，在数据量大的情况下性能会很差。

使用临时表进行联表查询，可以先对主表或者副表进行过滤，然后在处理后的临时表的基础上生成虚拟联表。

仍以上面article、comment两个表为例

获取article_id为'1'的文章及其评论的数据库操作，在直接联表查询和使用临时表联表查询时写法分别如下

// 直接使用虚拟联表查询
const res = await db.collection('article,comment')
.where('article_id._value=="1"')
.get()

// 先过滤article表，再获取虚拟联表联表获取评论
const article = db.collection('article').where('article_id=="1"').getTemp() // 注意是getTemp不是get
const res = await db.collection(article, 'comment').get()

直接使用虚拟联表联表查询，在第一步生成虚拟联表时会以主表所有数据和副表进行联表查询，如果主表数据量很大，这一步会浪费相当多的时间。先过滤主表则没有这个问题，过滤之后仅有一条数据和副表进行联表查询。

临时表内可以使用如下方法

方法调用必须严格按照顺序，比如field不能放在where之前

where
field // 关于field的使用限制见下方说明
orderBy
skip
limit

临时表内如果使用field进行字段过滤需要保留关联字段

const article = db.collection('article').where('article_id=="1"').field('title').getTemp() // 此处过滤article表，仅保留title字段。会导致下一步查询时找不到关联关系而查询失败
const res = await db.collection(article, 'comment').get()

组合出来的虚拟联表查询时可以使用的方法

方法调用必须严格按照顺序，比如foreignKey不能放在where之后

foreignKey // foreignKey自 HBuilderX 3.3.7版本支持
where
field // 关于field的使用限制见下方说明
groupBy // HBuilderX 3.4.0起支持
groupField // HBuilderX 3.4.0起支持
distinct // HBuilderX 3.4.0起支持
orderBy
skip
limit

一般情况下不需要再对虚拟联表额外处理，因为数据在临时表内已经进行了过滤排序等操作。以下代码仅供演示，并无实际意义

const article = db.collection('article').getTemp()
const comment = db.collection('comment').getTemp()
const res = await db.collection(article, comment).orderBy('title desc').get() // 按照title倒序排列

field使用限制

• HBuilderX 3.3.7之前 field 内仅可以进行字段过滤，不可对字段重命名、进行运算，field('name as value')、field('add(score1, score2) as totalScore')都是不支持的用法
• HBuilderX 3.3.7及以上版本支持对字段重命名或运算
• 进行联表查询时仅能使用临时表内已经过滤的字段间的关联关系，例如上面article、comment的查询，如果换成以下写法就无法联表查询
• 不建议在虚拟联表内再对副表字段重命名或者运算，如果有此类需求应在临时表内进行，会出现预期之外的结果，为兼容旧版此用法仅输出警告不会抛出错误

权限校验

要求组成虚拟联表的各个临时表都要满足权限限制，即权限校验不会计算组合成虚拟联表之后使用的where、field

以下为一个订单表（order）和书籍表（book）的schema示例

// order schema
{
  "bsonType": "object",
  "required": [],
  "permission": {
    "read": "doc.uid==auth.uid",
    "create": false,
    "update": false,
    "delete": false
  },
  "properties": {
    "id": { // 订单id
      "bsonType": "string"
    },
    "book_id": { // 书籍id
      "bsonType": "string"
    },
    "uid": { // 用户id
      "bsonType": "string"
    }
  }
}

// book schema
{
  "bsonType": "object",
  "required": [],
  "permission": {
    "read": true,
    "create": false,
    "update": false,
    "delete": false
  },
  "properties": {
    "id": { // 书籍id
      "bsonType": "string"
    },
    "name": { // 书籍名称
      "bsonType": "string"
    }
  }
}

如果先对主表进行过滤where('uid==$cloudEnv_uid')，则能满足权限限制（order表的"doc.uid==auth.uid"）

const order = db.collection('order')
.where('uid==$cloudEnv_uid') // 先过滤order表内满足条件的部分
.getTemp()

const res = await db.collection(order, 'book').get() // 可以通过权限校验

如果不对主表过滤，而是对虚拟联表（联表结果）进行过滤，则无法满足权限限制（order表的"doc.uid==auth.uid"）

const order = db.collection('order').getTemp()

const res = await db.collection(order, 'book').where('uid==$cloudEnv_uid').get() // 对虚拟联表过滤，无法通过权限校验

设置字段别名

联表查询时也可以在field内对字段进行重命名，写法和简单查询时别名写法类似，原字段名 as 新字段名即可。简单查询时的字段别名

仍以上述order、book两个表为例，以下查询将联表查询时order表的quantity字段重命名为order_quantity，将book表的title重命名为book_title、author重命名为book_author

// 客户端联表查询
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()

const order = db.collection('order').field('book_id,quantity').getTemp()
const book = db.collection('book').field('_id,title as book_title,author as book_author').getTemp()
db.collection(order, book)
  .where('book_id.book_title == "三国演义"') // 如果field内对副表字段title进行了重命名，where方法内则需要使用重命名之后的字段名
  .get()
  .then(res => {
    console.log(res);
  }).catch(err => {
    console.error(err)
  })

查询结果如下

{
	"code": "",
	"message": "",
	"data": [{
		"_id": "b8df3bd65f8f0d06018fdc250a5688bb",
		"book_id": [{
			"book_author": "罗贯中",
			"book_title": "三国演义"
		}],
		"order_quantity": 555
	}, {
		"_id": "b8df3bd65f8f0d06018fdc2315af05ec",
		"book_id": [{
			"book_author": "罗贯中",
			"book_title": "三国演义"
		}],
		"order_quantity": 333
	}]
}

手动指定使用的foreignKey

如果存在多个foreignKey且只希望部分生效，可以使用foreignKey来指定要使用的foreignKey

2021年4月28日10点前此方法仅用于兼容JQL联表查询策略调整前后的写法，在此日期后更新的clientDB（上传schema、uni-id均会触发更新）才会有指定foreignKey的功能，关于此次调整请参考：联表查询策略调整

例：

数据库内schema及数据如下：

// comment - 评论表

// schema
{
  "bsonType": "object",
  "required": [],
  "permission": {
    "read": true,
    "create": false,
    "update": false,
    "delete": false
  },
  "properties": {
    "comment_id": {
      "bsonType": "string"
    },
    "content": {
      "bsonType": "string"
    },
    "article": {
      "bsonType": "string",
      "foreignKey": "article.article_id"
    },
    "sender": {
      "bsonType": "string",
      "foreignKey": "user.uid"
    },
    "receiver": {
      "bsonType": "string",
      "foreignKey": "user.uid"
    }
  }
}

// data
{
  "comment_id": "1-1",
  "content": "comment1-1",
  "article": "1",
  "sender": "1",
  "receiver": "2"
}
{
  "comment_id": "1-2",
  "content": "comment1-2",
  "article": "1",
  "sender": "2",
  "receiver": "1"
}
{
  "comment_id": "2-1",
  "content": "comment2-1",
  "article": "2",
  "sender": "1",
  "receiver": "2"
}
{
  "comment_id": "2-2",
  "content": "comment2-2",
  "article": "2",
  "sender": "2",
  "receiver": "1"
}

// article - 文章表

// schema
{
  "bsonType": "object",
  "required": [],
  "permission": {
    "read": true,
    "create": false,
    "update": false,
    "delete": false
  },
  "properties": {
    "article_id": {
      "bsonType": "string"
    },
    "title": {
      "bsonType": "string"
    },
    "content": {
      "bsonType": "string"
    },
    "author": {
      "bsonType": "string",
      "foreignKey": "user.uid"
    }
  }
}

// data
{
  "article_id": "1",
  "title": "title1",
  "content": "content1",
  "author": "1"
}
{
  "article_id": "2",
  "title": "title2",
  "content": "content2",
  "author": "1"
}
{
  "article_id": "3",
  "title": "title3",
  "content": "content3",
  "author": "2"
}

const comment = db.collection('comment').where('comment_id == "1-1"').getTemp()
const user = db.collection('user').field('uid,name').getTemp()
db.collection(comment, user)
.foreignKey('comment.receiver') // 仅使用comment表内receiver字段下的foreignKey进行主表和副表之间的关联
.get()

注意

• HBuilderX 3.3.7及以上版本支持使用getTemp的虚拟联表内使用foreignKey方法

副表foreignKey联查

2021年4月28日之前的JQL只支持主表的foreignKey，把副表内容嵌入主表的foreignKey字段下面。不支持处理副本的foreignKey。

2021年4月28日调整后，新版支持副表foreignKey联查。副表的数据以数组的方式嵌入到主表中作为一个虚拟联表使用。

关联查询后的数据结构如下：

通过HBuilderX提供的JQL数据库管理功能方便的查看联表查询时返回数据的结构

主表某字段foreignKey指向副表时

{
  "主表字段名1": "xxx",
  "主表字段名2": "xxx",
  "主表内foreignKey指向副表的字段名": [{
    "副表字段名1": "xxx",
    "副表字段名2": "xxx",
  }]
}

副表某字段foreignKey指向主表时

{
  "主表字段名1": "xxx",
  "主表字段名2": "xxx",
  "副表foreignKey指向的主表字段名": {
    "副表1表名": [{ // 一个主表字段可能对应多个副表字段的foreignKey
      "副表1字段名1": "xxx",
      "副表1字段名2": "xxx",
    }],
    "副表2表名": [{ // 一个主表字段可能对应多个副表字段的foreignKey
      "副表2字段名1": "xxx",
      "副表2字段名2": "xxx",
    }],
    "_value": "主表字段原始值" // 使用副表foreignKey查询时会在关联的主表字段内以_value存储该字段的原始值，新增于HBuilderX 3.1.16
  }
}

以下查询使用comment表的article字段对应的foreignKey进行关联查询

const article = db.collection('article').where('article_id == "1"').getTemp()
const comment = db.collection('comment').getTemp()
db.collection(article,comment)
.field('content,article_id')
.get()

查询结果如下：

[{
  "content": "content1",
  "article_id": {
    "comment": [{ // 使用副表foreignKey查询时此处会自动插入一层副表表名
      "comment_id": "1-1",
      "content": "comment1-1",
      "article": "1",
      "sender": "1",
      "receiver": "2"
    },
    {
      "comment_id": "1-2",
      "content": "comment1-2",
      "article": "1",
      "sender": "2",
      "receiver": "1"
    }],
    "_value": "1"
  }
}]

如需对上述查询的副表字段进行过滤，需要注意多插入的一层副表表名

// 过滤副表字段
const article = db.collection('article').where('article_id == "1"').getTemp()
const comment = db.collection('comment').field('article,content').getTemp() // 如果有field方法，field内需包含关联字段以建立关联关系
db.collection('article,comment').get()

// 查询结果如下
[{
  "content": "content1",
  "article_id": {
    "comment": [{ // 使用副表foreignKey联查时此处会自动插入一层副表表名
	  "article": "1",
      "content": "comment1-1"
    },
    {
	  "article": "1",
      "content": "comment1-2"
    }],
    "_value": "1"
  }
}]

副表内的字段也可以使用as进行重命名，例如上述查询中如果希望将副表的content重命名为value可以使用如下写法

HBuilderX 3.3.7及以上版本支持getTemp内使用as

// 重命名副表字段
const article = db.collection('article').where('article_id == "1"').getTemp()
const comment = db.collection('comment').field('article,content as value').getTemp() // 如果有field方法，field内需包含关联字段以建立关联关系
db.collection(article,comment).get()

// 查询结果如下
[{
  "content": "content1",
  "article_id": {
    "comment": [{ // 使用副本foreignKey联查时此处会自动插入一层副表表名
	  "article": "1",
      "value": "comment1-1"
    },
    {
	  "article": "1",
      "value": "comment1-2"
    }]
  }
}]

查询记录过滤where条件

代码块dbget

jql对查询条件进行了简化，开发者可以使用where('a==1||b==2')来表示字段a等于1或字段b等于2。如果不使用jql语法，上述条件需要写成下面这种形式

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
const dbCmd = db.command
const res = await db.collection('test')
  .where(
    dbCmd.or({
      a:1
    },{
      b:2
    })
  )
  .get()

两种用法性能上并没有太大差距，可以视场景选择合适的写法。

jql支持两种类型的查询条件，以下内容有助于理解两种的区别，实际书写的时候无需过于关心是简单查询条件还是复杂查询条件，JQL会自动进行选择

where内还支持使用云端环境变量，详情参考：云端环境变量

在 unicloud-db 组件中使用where查询 参考

简单查询条件

简单查询条件包括以下几种，对应着db.command下的各种操作符以及不使用操作符的查询如where({a:1})。

运算符	说明	示例	示例解释(集合查询)
==	等于	name == 'abc'	查询name属性为abc的记录，左侧为数据库字段
!=	不等于	name != 'abc'	查询name属性不为abc的记录，左侧为数据库字段
>	大于	age>10	查询条件的 age 属性大于 10，左侧为数据库字段
>=	大于等于	age>=10	查询条件的 age 属性大于等于 10，左侧为数据库字段
<	小于	age<10	查询条件的 age 属性小于 10，左侧为数据库字段
<=	小于等于	age<=10	查询条件的 age 属性小于等于 10，左侧为数据库字段
in	存在在数组中	status in ['a','b']	查询条件的 status 是['a','b']中的一个，左侧为数据库字段
!(xx in [])	在数组中不存在	!(status in ['a','b'])	查询条件的 status 不是['a','b']中的任何一个
&&	与	uid == auth.uid && age > 10	查询记录uid属性 为 当前用户uid 并且查询条件的 age 属性大于 10
||	或	uid == auth.uid||age>10	查询记录uid属性 为 当前用户uid 或者查询条件的 age 属性大于 10
test	正则校验	/abc/.test(content)	查询 content字段内包含 abc 的记录。可用于替代sql中的like。还可以写更多正则实现更复杂的功能

这里的test方法比较强大，格式为：正则规则.test(fieldname)。

具体到这个正则 /abc/.test(content)，类似于sql中的content like '%abc%'，即查询所有字段content包含abc的数据记录。

注意

• 不支持非操作
• 编写查询条件时，除test外，均为运算符左侧为数据库字段，右侧为常量

简单查询条件内要求二元运算符两侧不可均为数据库内的字段

上述写法的查询语句可以在权限校验阶段与schema内配置的permission进行一次对比校验，如果校验通过则不会再查库进行权限校验。

复杂查询条件

HBuilderX 3.1.0起支持

复杂查询内可以使用数据库运算方法。需要注意的是，与云函数内使用数据库运算方法不同jql内对数据库运算方法的用法进行了简化。

例：数据表test内有以下数据

{
  "_id": "1",
  "name": "n1",
  "chinese": 60, // 语文
  "math": 60 // 数学
}
{
  "_id": "2",
  "name": "n2",
  "chinese": 60,
  "math": 70
}
{
  "_id": "3",
  "name": "n3",
  "chinese": 100,
  "math": 90
}

使用如下写法可以筛选语文数学总分大于150的数据

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
const res = await db.collection('test')
.where('add(chinese,math) > 150')
.get()

// 返回结果如下
res = {
  result: {
    data: [{
      "_id": "3",
      "name": "n3",
      "chinese": 100,
      "math": 90
    }]
  }
}

另外与简单查询条件相比，复杂查询条件可以比较数据库内的两个字段，简单查询条件则要求二元运算符两侧不可均为数据库内的字段，JQL会自动判断要使用简单查询还是复杂查询条件。

例：仍以上面的数据为例，以下查询语句可以查询数学得分比语文高的记录

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
const res = await db.collection('test')
.where('math > chinese')
.get()

// 返回结果如下
res = {
  result: {
    data: [{
      "_id": "2",
      "name": "n2",
      "chinese": 60,
      "math": 70
    }]
  }
}

在查询条件时也可以使用new Date()来获取一个日期对象。

例：数据表test内有以下数据

{
  "_id": "1",
  "title": "t1",
  "deadline": 1611998723948
}
{
  "_id": "2",
  "title": "t2",
  "deadline": 1512312311231
}

使用下面的写法可以查询deadline小于当前时间（云函数内的时间）的字段

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
const res = await db.collection('test')
.where('deadline < new Date().getTime()') // 暂不支持使用Date.now()，后续会支持
.get()

注意

• 使用了复杂查询条件时不可以使用正则查询

查询列表分页

可以通过skip+limit来进行分页查询

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection('book')
  .where('status == "onsale"')
  .skip(20) // 跳过前20条
  .limit(20) // 获取20条
  .get()

// 上述用法对应的分页条件为：每页20条取第2页

注意

• limit不设置的情况下默认返回100条数据；设置limit有最大值，腾讯云限制为最大1000条，阿里云限制为最大1000条。

<unicloud-db>组件提供了更简单的分页方法，包括两种模式：

1. 滚动到底加载下一页（append模式）
2. 点击页码按钮切换不同页（replace模式）

详见：https://uniapp.dcloud.net.cn/uniCloud/unicloud-db?id=page

字段过滤field

查询时可以使用field方法指定返回字段。不使用field方法时会返回所有字段

field可以指定字符串，也可以指定一个对象。

field中可以使用所有数据库运算方法

• 字符串写法：列出字段名称，多个字段以半角逗号做分隔符。比如db.collection('book').field("title,author")，查询结果会返回_id、title、author3个字段的数据。字符串写法，_id是一定会返回的

复杂嵌套json数据过滤

如果数据库里的数据结构是嵌套json，比如book表有个价格字段，包括普通价格和vip用户价格，数据如下：

{
  "_id": "1",
  "title": "西游记",
  "author": "吴承恩",
  "price":{
	  "normal":10,
	  "vip":8
  }
}

那么使用db.collection('book').field("price.vip").get()，就可以只返回vip价格，而不返回普通价格。查询结果如下：

{
  "_id": "1",
  "price":{
	  "vip":8
  }
}

对于联表查询，副表的数据嵌入到了主表的关联字段下面，此时在filed里通过{}来定义副表字段。比如之前联表查询章节举过的例子，book表和order表联表查询：

// 联表查询
db.collection('order,book') // 注意collection方法内需要传入所有用到的表名，用逗号分隔，主表需要放在第一位
  .field('book_id{title,author},quantity') // 这里联表查询book表返回book表内的title、book表内的author、order表内的quantity
  .get()

不使用{}过滤副表字段

此写法于2021年4月28日起支持

field方法内可以不使用{}进行副表字段过滤，以上面示例为例可以写为

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection('order,book')
  .where('book_id.title == "三国演义"')
  .field('book_id.title,book_id.author,quantity as order_quantity') // book_id.title、book_id.author为副表字段，使用别名时效果和上一个示例不同，请见下方说明
  .orderBy('order_quantity desc') // 按照order_quantity降序排列
  .get()
  .then(res => {
    console.log(res);
  }).catch(err => {
    console.error(err)
  })

字段别名as

自2020-11-20起JQL支持字段别名，主要用于在前端需要的字段名和数据库字段名称不一致的情况下对字段进行重命名。

用法形如：author as book_author，意思是将数据库的author字段重命名为book_author。

仍以上面的order表和book表为例

// 客户端联表查询
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection('book')
  .where('title == "三国演义"')
  .field('title as book_title,author as book_author')
  .get()
  .then(res => {
    console.log(res);
  }).catch(err => {
    console.error(err)
  })

上述查询返回结果如下

{
	"code": "",
	"message": "",
	"data": [{
      "_id": "3",
			"book_author": "罗贯中",
			"book_title": "三国演义"
		}]
}

_id是比较特殊的字段，如果对_id设置别名会同时返回_id和设置的别名字段

例：

// 客户端联表查询
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection('book')
  .where('title == "三国演义"')
  .field('_id as book_id,title as book_title,author as book_author')
  .get()
  .then(res => {
    console.log(res);
  }).catch(err => {
    console.error(err)
  })

上述查询返回结果如下

{
	"code": "",
	"message": "",
	"data": [{
      "_id": "3",
      "book_id": "3",
			"book_author": "罗贯中",
			"book_title": "三国演义"
		}]
}

联表查询时字段别名

联表查询时字段别名写法和简单查询类似

// 客户端联表查询
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection('order,book')
  .where('book_id.title == "三国演义"')
  .field('book_id{title as book_title,author as book_author},quantity as order_quantity') // 这里联表查询book表返回book表内的title、book表内的author、order表内的quantity，并将title重命名为book_title，author重命名为book_author，quantity重命名为order_quantity
  .orderBy('order_quantity desc') // 按照order_quantity降序排列
  .get()
  .then(res => {
    console.log(res);
  }).catch(err => {
    console.error(err)
  })

上述请求返回的res如下

{
	"code": "",
	"message": "",
	"data": [{
		"_id": "b8df3bd65f8f0d06018fdc250a5688bb",
		"book_id": [{
			"book_author": "罗贯中",
			"book_title": "三国演义"
		}],
		"order_quantity": 555
	}, {
		"_id": "b8df3bd65f8f0d06018fdc2315af05ec",
		"book_id": [{
			"book_author": "罗贯中",
			"book_title": "三国演义"
		}],
		"order_quantity": 333
	}]
}

副表字段使用别名需要注意，如果写成.field('book_id.title as book_id.book_title,book_id.author,quantity as order_quantity') book_title将会是由book_id下每一项的title组成的数组，这点和mongoDB内数组表现一致

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection('order,book')
  .where('book_id.title == "三国演义"')
  .field('book_id.title as book_title,book_id.author as book_author,quantity as order_quantity') // book_id.title、book_id.author为副表字段，使用别名时效果和上一个示例不同，请见下方说明
  .orderBy('order_quantity desc') // 按照order_quantity降序排列
  .get()
  .then(res => {
    console.log(res);
  }).catch(err => {
    console.error(err)
  })

返回结果如下

{
	"code": "",
	"message": "",
	"data": [{
		"_id": "b8df3bd65f8f0d06018fdc250a5688bb",
    book_title: ["三国演义"],
    book_author: ["罗贯中"],
		"order_quantity": 555
	}, {
		"_id": "b8df3bd65f8f0d06018fdc2315af05ec",
    book_title: ["三国演义"],
    book_author: ["罗贯中"],
		"order_quantity": 333
	}]
}

注意

• as后面的别名，不可以和表schema中已经存在的字段重名
• mongoDB查询指令中，上一阶段处理完毕将结果输出到下一阶段。在上面的例子中表现为where中使用的是原名，orderBy中使用的是别名
• 目前不支持对联表查询的关联字段使用别名，即上述示例中的book_id不可设置别名

各种字段运算方法

自HBuilderX 3.1.0起，JQL支持在云端数据库对字段进行一定的操作运算之后再返回，详细可用的方法列表请参考：数据库运算方法

需要注意的是，为方便书写，JQL内将数据库运算方法的用法进行了简化（相对于云函数内使用数据库运算方法而言）。用法请参考上述链接

例：数据表class内有以下数据

{
  "_id": "1",
  "grade": 6,
  "class": "A"
}
{
  "_id": "1",
  "grade": 2,
  "class": "A"
}

如下写法可以由grade计算得到一个isTopGrade来表示是否为最高年级

const res = await db.collection('class')
.field('class,eq(grade,6) as isTopGrade')
.get()

返回结果如下

{
  "_id": "1",
  "class": "A",
  "isTopGrade": true
}
{
  "_id": "1",
  "class": "A",
  "isTopGrade": false
}

注意

• 如果要访问数组的某一项请使用arrayElemAt操作符，形如：arrayElemAt(arr,1)
• 在进行权限校验时，会以field内访问的所有字段计算权限。上面的例子中会使用表的read权限和grade、class字段的权限，来进行权限校验。

排序orderBy

传统的MongoDB的排序参数是json格式，jql支持类sql的字符串格式，书写更为简单。

sort方法和orderBy方法内可以传入一个字符串来指定排序规则。

orderBy允许进行多个字段排序，以逗号分隔。每个字段可以指定 asc(升序)、desc(降序)。默认是升序。

写在前面的排序字段优先级高于后面。

示例如下：

orderBy('quantity asc, create_date desc') //按照quantity字段升序排序，quantity相同时按照create_date降序排序
// asc可以省略，上述代码和以下写法效果一致
orderBy('quantity, create_date desc')

// 注意不要写错成全角逗号

以上面的order表数据为例：

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
  db.collection('order')
    .orderBy('quantity asc, create_date desc') // 按照quantity字段升序排序，quantity相同时按照create_date降序排序
    .get()
    .then(res => {
      console.log(res);
    }).catch(err => {
      console.error(err)
    })

// 上述写法等价于
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
  db.collection('order')
    .orderBy('quantity','asc')
    .orderBy('create_date','desc')
    .get()
    .then(res => {
      console.log(res);
    }).catch(err => {
      console.error(err)
    })

限制查询记录的条数limit

使用limit方法，可以查询有限条数的数据记录。

比如查询销量top10的书籍，或者查价格最高的一本书。

// 这以上面的book表数据为例，查价格最高的一本书
  db.collection('book')
    .orderBy('price desc')
    .limit(1)
    .get()

limit默认值是100，即不设置的情况下，默认返回100条数据。limit最大值为1000。

一般情况下不应该给前端一次性返回过多数据，数据库查询也慢、网络返回也慢。可以通过分页的方式分批返回数据。

在查询的result里，有一个affectedDocs。但affectedDocs和limit略有区别。affectedDocs小于等于limit。

比如book表里只有2本书，limit虽然设了10，但查询结果只能返回2条记录，affectedDocs为2。

只查一条记录getone

使用JQL的API方式时，可以在get方法内传入参数getOne:true来返回一条数据。

getOne其实等价于上一节的limit(1)。

一般getOne和orderBy搭配。

// 这以上面的book表数据为例
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection('book')
	.where({
		title: '西游记'
	})
	.get({
		getOne:true
	})
	.then(res => {
		console.log(res);
	}).catch(err => {
		console.error(err)
	})

返回结果为

{
	"code": "",
	"message": "",
	"data": {
    "_id": "1",
    "title": "西游记",
    "author": "吴承恩"
  }
}

如果使用uniCloud-db组件，则在组件的属性上增加一个 getone。详见

统计数量getcount

统计符合查询条件的记录数，是数据库层面的概念。

在查询的result里，有一个affectedDocs。但affectedDocs和count计数不是一回事。

• affectedDocs表示从服务器返回给前端的数据条数。默认100条，可通过limit方法调整。
• count则是指符合查询条件的记录总数，至于这些记录是否返回给前端，和count无关。

例如book表里有110本书，不写任何where、limit等条件，但写了count方法或getCount参数，那么result会变成如下：

result:{
	errCode: 0,
	errMsg: "",
	count: 110,
	data:[...]
}

也就是数据库查到了110条记录，通过count返回；而网络侧只给前端返回了100条数据，通过affectedDocs表示。

count计数又有2种场景：

• 单纯统计数量，不查询数据。使用count()方法
• 查询记录返回详情，同时返回符合查询条件的数量、使用getCount参数

单纯统计数量，不返回数据明细

使用count()方法，如db.collection('order').count()

可以继续加where等条件进行数据记录过滤。

查询记录的同时返回计数

使用JQL的API方式时，可以在get方法内传入参数getCount:true来同时返回总数

// 这以上面的order表数据为例
const db = uniCloud.database()
  db.collection('order')
    .get({
      getCount:true
    })
    .then(res => {
      console.log(res);
    }).catch(err => {
      console.error(err)
    })

返回结果为

{
	"code": "",
	"message": "",
	"data": [{
		"_id": "b8df3bd65f8f0d06018fdc250a5688bb",
		"book": "3",
		"quantity": 555
	}],
	"count": 5
}

如果使用uniCloud-db组件，则在组件的属性上增加一个 getcount。详见

查询树形数据gettree

HBuilderX 3.0.3+起，JQL支持在get方法内传入getTree参数查询树状结构数据。（HBuilderX 3.0.5+ unicloud-db组件开始支持，之前版本只能通过js方式使用）

树形数据，在数据库里一般不会按照tree的层次来存储，因为按tree结构通过json对象的方式存储不同层级的数据，不利于对tree上的某个节点单独做增删改查。

一般存储树形数据，tree上的每个节点都是一条单独的数据表记录，然后通过类似parent_id来表达父子关系。

如部门的数据表，里面有2条数据，一条数据记录是“总部”，parent_id为空；另一条数据记录“一级部门A”，parent_id为总部的_id

{
    "_id": "5fe77207974b6900018c6c9c",
    "name": "总部",
    "parent_id": "",
    "status": 0
}

{
    "_id": "5fe77232974b6900018c6cb1",
    "name": "一级部门A",
    "parent_id": "5fe77207974b6900018c6c9c",
    "status": 0
}

虽然存储格式是分条记录的，但查询反馈到前端的数据仍然需要是树形的。这种转换在过去比较复杂。

JQL提供了一种简单、优雅的方案，在DB Schema里配置parentKey来表达父子关系，然后查询时声明使用Tree查询，就可以直接查出树形数据。

department部门表的schema中，将字段parent_id的"parentKey"设为"_id"，即指定了数据之间的父子关系，如下：

{
  "bsonType": "object",
  "required": ["name"],
  "properties": {
    "_id": {
      "description": "ID，系统自动生成"
    },
      "name": {
      "bsonType": "string",
      "description": "名称"
    },
    "parent_id": {
      "bsonType": "string",
      "description": "父id",
      "parentKey": "_id", // 指定父子关系为：如果数据库记录A的_id和数据库记录B的parent_id相等，则A是B的父级。
    },
    "status": {
      "bsonType": "int",
      "description": "部门状态，0-正常、1-禁用"
    }
  }
}

parentKey字段将数据表不同记录的父子关系描述了出来。查询就可以直接写了。

注意：一个表的一次查询中只能有一个父子关系。如果一个表的schema里多个字段均设为了parentKey，那么需要在JQL中通过parentKey()方法指定某个要使用的parentKey字段。

schema里描述好后，查询就变的特别简单。

查询树形数据，分为 查询所有子节点 和 查询父级路径 这2种需求。

查询所有子节点

指定符合条件的记录，然后查询它的所有子节点，并且可以指定层级，返回的结果是以符合条件的记录为一级节点的所有子节点数据，并以树形方式嵌套呈现。

只需要在JQL的get方法中增加getTree参数，如下

// get方法示例
get({
  getTree: {
    limitLevel: 10, // 最大查询层级（不包含当前层级），可以省略默认10级，最大15，最小1
    startWith: "parent_code=='' || parent_code==null"  // 第一层级条件，此初始条件可以省略，不传startWith时默认从最顶级开始查询
  }
})

// 使用getTree时上述参数可以简写为以下写法
get({
  getTree: true
})

完整的代码如下：

db.collection("department").get({
		getTree: {}
	})
	.then((res) => {
		const resdata = res.result.data
		console.log("resdata", resdata);
	}).catch((err) => {
		uni.showModal({
			content: err.message || '请求服务失败',
			showCancel: false
		})
	}).finally(() => {

	})

查询的结果如下：

"data": [{
	"_id": "5fe77207974b6900018c6c9c",
	"name": "总部",
	"parent_id": "",
	"status": 0,
	"children": [{
		"_id": "5fe77232974b6900018c6cb1",
		"name": "一级部门A",
		"parent_id": "5fe77207974b6900018c6c9c",
		"status": 0,
		"children": []
	}]
}]

可以看出，每个子节点，被嵌套在父节点的"children"下，这个"children"是一个固定的格式。

如果不指定getTree的参数，会把department表的所有数据都查出来，从总部开始到10级部门，以树形结构提供给客户端。

如果有多个总部，即多行记录的parent_id为空，则多个总部会分别作为一级节点，把它们下面的所有children一级一级拉出来。如下：

"data": [
	{
		"_id": "5fe77207974b6900018c6c9c",
		"name": "总部",
		"parent_id": "",
    "status": 0,
		"children": [{
				"_id": "5fe77232974b6900018c6cb1",
				"name": "一级部门A",
				"parent_id": "5fe77207974b6900018c6c9c",
				"status": 0,
				"children": []
		}]
	},
	{
		"_id": "5fe778a10431ca0001c1e2f8",
		"name": "总部2",
		"parent_id": "",
		"children": [{
				"_id": "5fe778e064635100013efbc2",
				"name": "总部2的一级部门B",
				"parent_id": "5fe778a10431ca0001c1e2f8",
				"children": []
		}]
	}
]

如果觉得返回的parent_id字段多余，也可以指定.field("_id,name")，过滤掉该字段。

getTree的参数limitLevel的说明

limitLevel表示查询返回的树的最大层级。超过设定层级的节点不会返回。

• limitLevel的默认值为10。
• limitLevel的合法值域为1-15之间（包含1、15）。如果数据实际层级超过15层，请分层懒加载查询。
• limitLevel为1，表示向下查一级子节点。假如数据库中有2级、3级部门，如果设limitLevel为1，且查询的是“总部”，那么返回数据包含“总部”和其下的一级部门。

getTree的参数startWith的说明

如果只需要查“总部”的子部门，不需要“总部2”，可以在startWith里指定（getTree: {"startWith":"name=='总部'"}）。

使用中请注意startWith和where的区别。where用于描述对所有层级的生效的条件（包括第一层级）。而startWith用于描述从哪个或哪些节点开始查询树。

startWith不填时，默认的条件是 'parent_id==null||parent_id==""'，即schema配置parentKey的字段为null（即不存在）或值为空字符串时，这样的节点被默认视为根节点。

假设上述部门表内有以下数据

{
    "_id": "1",
    "name": "总部",
    "parent_id": "",
    "status": 0
}
{
    "_id": "11",
    "name": "一级部门A",
    "parent_id": "1",
    "status": 0
}
{
    "_id": "12",
    "name": "一级部门B",
    "parent_id": "1",
    "status": 1
}

以下查询语句指定startWith为_id=="1"、where条件为status==0，查询总部下所有status为0的子节点。

db.collection("department")
  .where('status==0')
  .get({
    getTree: {
      startWith: '_id=="1"'
    }
	})
	.then((res) => {
		const resdata = res.result.data
		console.log("resdata", resdata);
	}).catch((err) => {
		uni.showModal({
			content: err.message || '请求服务失败',
			showCancel: false
		})
	}).finally(() => {

	})

查询的结果如下：

{
  "data": [{
    "_id": "1",
    "name": "总部",
    "parent_id": "",
    "status": 0,
    "children": [{
      "_id": "11",
      "name": "一级部门A",
      "parent_id": "1",
      "status": 0,
      "children": []
    }]
  }]
}

需要注意的是where内的条件也会对第一级数据生效，例如将上面的查询改成如下写法

db.collection("department")
  .where('status==1')
  .get({
    getTree: {
      startWith: '_id=="1"'
    }
	})
	.then((res) => {
		const resdata = res.result.data
		console.log("resdata", resdata);
	}).catch((err) => {
		uni.showModal({
			content: err.message || '请求服务失败',
			showCancel: false
		})
	}).finally(() => {

	})

此时将无法查询到数据，返回结果如下

{
  "data": []
}

通过parentKey方法指定某个parentKey

如果表的schema中有多个字段都配置了parentKey，但查询时其实只能有一个字段的parentKey关系可以生效，那么此时就需要通过parentKey()方法来指定这次查询需要的哪个parentKey关系生效。

parentKey()方法的参数是字段名。

db.collection('department')
.parentKey('parent_id') // 如果表schema只有一个字段设了parentKey，其实不需要指定。有多个字段被设parentKey才需要用这个方法指定
.get({
    getTree: true
	})

示例

插件市场有一个 家谱 的示例，可以参阅：https://ext.dcloud.net.cn/plugin?id=3798

大数据量的树形数据查询

如果tree的数据量较大，则不建议一次性把所有的树形数据返回给客户端。建议分层查询，即懒加载。

比如地区选择的场景，全国的省市区数据量很大，一次性查询所有数据返回给客户端非常耗时和耗流量。可以先查省，然后根据选择的省再查市，以此类推。

注意

• 暂不支持使用getTree的同时使用联表查询
• 如果使用了where条件会对所有查询的节点生效
• 如果使用了limit设置最大返回数量仅对根节点生效

查询树形结构父节点路径

getTree是查询子节点，而getTreePath，则是查询父节点。

get方法内传入getTreePath参数对包含父子关系的表查询返回树状结构数据某节点路径。

// get方法示例
get({
  getTreePath: {
    limitLevel: 10, // 最大查询层级（不包含当前层级），可以省略默认10级，最大15，最小1
    startWith: 'name=="一级部门A"'  // 末级节点的条件，此初始条件不可以省略
  }
})

查询返回的结果为，从“一级部门A”起向上找10级，找到最终节点后，以该节点为根，向下嵌套children，一直到达“一级部门A”。

返回结果只包括“一级部门A”的直系父，其父节点的兄弟节点不会返回。所以每一层数据均只有一个节点。

仍以上面department的表结构和数据为例

db.collection("department").get({
		getTreePath: {
			"startWith": "_id=='5fe77232974b6900018c6cb1'"
		}
	})
	.then((res) => {
		const treepath = res.result.data
		console.log("treepath", treepath);
	}).catch((err) => {
		uni.showModal({
			content: err.message || '请求服务失败',
			showCancel: false
		})
	}).finally(() => {
		uni.hideLoading()
		// console.log("finally")
	})

查询返回结果

从根节点“总部”开始，返回到“一级部门A”。“总部2”等节点不会返回。

{
  "data": [{
		"_id": "5fe77207974b6900018c6c9c",
		"name": "总部",
		"parent_id": "",
		"children": [{
			"_id": "5fe77232974b6900018c6cb1",
			"name": "一级部门A",
			"parent_id": "5fe77207974b6900018c6c9c"
		}]
	}]
}

如果startWith指定的节点没有父节点，则返回自身。

如果startWith匹配的节点不止一个，则以数组的方式，返回每个节点的treepath。

例如“总部”和“总部2”下面都有一个部门的名称叫“销售部”，且"startWith": "name=='销售部'"，则会返回“总部”和“总部2”两条treepath，如下

{
	"data": [{
		"_id": "5fe77207974b6900018c6c9c",
		"name": "总部",
		"parent_id": "",
		"children": [{
			"_id": "5fe77232974b6900018c6cb1",
			"name": "销售部",
			"parent_id": "5fe77207974b6900018c6c9c"
		}]
		}, {
		"_id": "5fe778a10431ca0001c1e2f8",
		"name": "总部2",
		"parent_id": "",
		"children": [{
			"_id": "5fe79fea23976b0001508a46",
			"name": "销售部",
			"parent_id": "5fe778a10431ca0001c1e2f8"
		}]
	}]
}

注意

• 暂不支持使用getTreePath的同时使用其他联表查询语法
• 如果使用了where条件会对所有查询的节点生效

分组统计groupby

本地调试支持：HBuilderX 3.1.0+；云端支持：2021-1-26日后更新一次云端 DB Schema 生效

数据分组统计，即根据某个字段进行分组（groupBy），然后对其他字段分组后的值进行求和、求数量、求均值。

比如统计每日新增用户数，就是按时间进行分组，对每日的用户记录进行count运算。

分组统计有groupBy和groupField。和传统sql略有不同，传统sql没有单独的groupField。

JQL的groupField里不能直接写field字段，只能使用分组运算方法来处理字段，常见的累积器计算符包括：count(*)、sum(字段名称)、avg(字段名称)。更多分组运算方法详见

其中count(*)是固定写法。

分组统计的写法如下：

const res = await db.collection('table1').groupBy('field1,field2').groupField('sum(field3) as field4').get()

如果额外还在groupBy之前使用了field方法，那么此field的含义并不是最终返回的字段，而是用于对字段预处理，然后将预处理的字段传给groupBy和groupField使用。

与field不同，使用groupField时返回结果不会默认包含_id字段。同时开发者也不应该在groupBy和groupField里使用_id字段，_id是唯一的，没有统一意义。

举例： 如果数据库score表为某次比赛统计的分数数据，每条记录为一个学生的分数。学生有所在的年级（grade）、班级（class）、姓名（name）、分数（score）等字段属性。

{
  _id: "1",
  grade: "1",
  class: "A",
  name: "zhao",
  score: 5
}
{
  _id: "2",
  grade: "1",
  class: "A",
  name: "qian",
  score: 15
}
{
  _id: "3",
  grade: "1",
  class: "B",
  name: "li",
  score: 15
}
{
  _id: "4",
  grade: "1",
  class: "B",
  name: "zhou",
  score: 25
}
{
  _id: "5",
  grade: "2",
  class: "A",
  name: "wu",
  score: 25
}
{
  _id: "6",
  grade: "2",
  class: "A",
  name: "zheng",
  score: 35
}

接下来我们对这批数据进行分组统计，分别演示如何使用求和、求均值和计数。

求和、求均值示例

groupBy内也可以使用数据库运算方法对数据进行处理，为方便书写，clientDB内将数据库运算方法的用法进行了简化（相对于云函数内使用数据库运算方法而言）。用法请参考：数据库运算方法

groupField内可以使用分组运算方法对分组结果进行统计，所有可用的累计方法请参考分组运算方法，下面以sum（求和）和avg（求均值）为例介绍如何使用

使用sum方法可以对数据进行求和统计。以上述数据为例，如下写法对不同班级进行分数统计

const res = await db.collection('score')
.groupBy('grade,class')
.groupField('sum(score) as totalScore')
.get()

返回结果如下

{
  data: [{
    grade: "1",
    class: "A",
    totalScore: 20
  },{
    grade: "1",
    class: "B",
    totalScore: 40
  },{
    grade: "2",
    class: "A",
    totalScore: 60
  }]
}

1年级A班、1年级B班、2年级A班，3个班级的总分分别是20、40、60。

求均值方法与求和类似，将上面sum方法换成avg方法即可

const res = await db.collection('score')
.groupBy('grade,class')
.groupField('avg(score) as avgScore')
.get()

返回结果如下

{
  data: [{
    grade: "1",
    class: "A",
    avgScore: 10
  },{
    grade: "1",
    class: "B",
    avgScore: 20
  },{
    grade: "2",
    class: "A",
    avgScore: 30
  }]
}

如果额外还在groupBy之前使用了field方法，此field用于决定将哪些数据传给groupBy和groupField使用

例：如果上述数据中score是一个数组

{
  _id: "1",
  grade: "1",
  class: "A",
  name: "zhao",
  score: [1,1,1,1,1]
}
{
  _id: "2",
  grade: "1",
  class: "A",
  name: "qian",
  score: [3,3,3,3,3]
}
{
  _id: "3",
  grade: "1",
  class: "B",
  name: "li",
  score: [3,3,3,3,3]
}
{
  _id: "4",
  grade: "1",
  class: "B",
  name: "zhou",
  score: [5,5,5,5,5]
}
{
  _id: "5",
  grade: "2",
  class: "A",
  name: "wu",
  score: [5,5,5,5,5]
}
{
  _id: "6",
  grade: "2",
  class: "A",
  name: "zheng",
  score: [7,7,7,7,7]
}

如下field写法将上面的score数组求和之后传递给groupBy和groupField使用。在field内没出现的字段（比如name），在后面的方法里面不能使用

const res = await db.collection('score')
.field('grade,class,sum(score) as userTotalScore')
.groupBy('grade,class')
.groupField('avg(userTotalScore) as avgScore')
.get()

返回结果如下

{
  data: [{
    grade: "1",
    class: "A",
    avgScore: 10
  },{
    grade: "1",
    class: "B",
    avgScore: 20
  },{
    grade: "2",
    class: "A",
    avgScore: 30
  }]
}

统计数量示例

使用count方法可以对记录数量进行统计。以上述数据为例，如下写法对不同班级统计参赛人数

const res = await db.collection('score')
.groupBy('grade,class')
.groupField('count(*) as totalStudents')
.get()

返回结果如下

{
  data: [{
    grade: "1",
    class: "A",
    totalStudents: 2
  },{
    grade: "1",
    class: "B",
    totalStudents: 2
  },{
    grade: "2",
    class: "A",
    totalStudents: 2
  }]
}

注意

• count(*)为固定写法，括号里的*可以省略

按日分组统计示例

按时间段统计是常见的需求，而时间段统计会用到日期运算符。

假设要统计uni-id-users表的每日新增注册用户数量。表内有以下数据：

{
  "_id": "1",
  "username": "name1",
  "register_date": 1611367810000 // 2021-01-23 10:10:10
}
{
  "_id": "2",
  "username": "name2",
  "register_date": 1611367810000 // 2021-01-23 10:10:10
}
{
  "_id": "3",
  "username": "name3",
  "register_date": 1611367810000 // 2021-01-23 10:10:10
}
{
  "_id": "4",
  "username": "name4",
  "register_date": 1611281410000 // 2021-01-22 10:10:10
}
{
  "_id": "5",
  "username": "name5",
  "register_date": 1611281410000 // 2021-01-22 10:10:10
}
{
  "_id": "6",
  "username": "name6",
  "register_date": 1611195010000 // 2021-01-21 10:10:10
}

由于register_date字段是时间戳格式，含有时分秒信息。但统计每日新增注册用户时是需要忽略时分秒的。

1. 首先使用add操作符将register_date从时间戳转化为日期类型。

add操作符的用法为add(值1,值2)。add(new Date(0),register_date)表示给字段register_date + 0，这个运算没有改变具体的时间，但把register_date的格式从时间戳转为了日期类型。

2. 然后使用dateToString将add得到的日期格式化为形如2021-01-21的字符串，去掉时分秒。

dateToString操作符的用法为dateToString(日期对象,格式化字符串,时区)。具体如下：dateToString(add(new Date(0),register_date),"%Y-%m-%d","+0800")

3. 然后根据此字符串进行分组统计，得到每天注册用户量。代码如下：

const res = await db.collection('uni-id-users')
.groupBy('dateToString(add(new Date(0),register_date),"%Y-%m-%d","+0800") as date')
.groupField('count(*) as newusercount')
.get()

查询返回结果如下：

res = {
  result: {
    data: [{
      date: '2021-01-23',
      newusercount: 3
    },{
      date: '2021-01-22',
      newusercount: 2
    },{
      date: '2021-01-21',
      newusercount: 1
    }]
  }
}

完整数据库运算方法列表请参考：JQL内可使用的数据库运算方法

count权限控制

在使用普通的累积器操作符，如sum、avg时，权限控制与常规的权限控制并无不同。

但使用count时，可以单独配置表级的count权限。

请不要轻率的把uni-id-users表的count权限设为true，即任何人都可以count。这意味着游客将可以获取到你的用户总数量。

count权限的控制逻辑如下：

• 在不使用field，仅使用groupBy和groupField的情况下，会以groupBy和groupField内访问的所有字段的权限来校验访问是否合法。
• 在额外使用field方法的情况下，会计算field内访问的所有字段计算权限。上面的例子中会使用表的read权限和grade、class、score三个字段的权限，来进行权限校验。
• 在HBuilderX 3.1.0之前，count操作都会使用表级的read权限进行验证。HBuilderX 3.1.0及之后的版本，如果配置了count权限则会使用表级的read+count权限进行校验，两条均满足才可以通过校验
• 如果schema内没有count权限，则只会使用read权限进行校验
• 所有会统计数量的操作均会触发count权限校验

数据去重distinct

通过.distinct()方法，对数据查询结果中重复的记录进行去重。

distinct方法将按照field方法指定的字段进行去重（如果field内未指定_id，不会按照_id去重）

本地调试支持：HBuilderX 3.1.0+；云端支持：2021-1-26日后更新一次云端 DB Schema生效

const res = await db.collection('table1')
.field('field1')
.distinct() // 注意distinct方法没有参数
.get()

例：如果数据库score表为某次比赛统计的分数数据，每条记录为一个学生的分数

score表的数据：

{
  _id: "1",
  grade: "1",
  class: "A",
  name: "zhao",
  score: 5
}
{
  _id: "2",
  grade: "1",
  class: "A",
  name: "qian",
  score: 15
}
{
  _id: "3",
  grade: "1",
  class: "B",
  name: "li",
  score: 15
}
{
  _id: "4",
  grade: "1",
  class: "B",
  name: "zhou",
  score: 25
}
{
  _id: "5",
  grade: "2",
  class: "A",
  name: "wu",
  score: 25
}
{
  _id: "6",
  grade: "2",
  class: "A",
  name: "zheng",
  score: 35
}

以下代码可以按照grade、class两字段去重，获取所有参赛班级

const res = await db.collection('score')
.field('grade,class')
.distinct() // 注意distinct方法没有参数
.get()

查询返回结果如下

{
  data: [{
    grade:"1",
    class: "A"
  },{
    grade:"1",
    class: "B"
  },{
    grade:"2",
    class: "A"
  }]
}

注意

• distinct指对返回结果中完全相同的记录进行去重，重复的记录只保留一条。因为_id字段是必然不同的，所以使用distinct时必须同时指定field，且field中不可存在_id字段

地理位置查询geoNear

新增于 HBuilderX 3.6.10

geoNear可用于查询位置在给定点一定距离内的数据库记录。此方法必须紧跟在collection方法或aggregate方法后。

参数

属性	类型	默认值	必填	说明
near	GeoPoint		是	GeoJSON Point，用于判断距离的点
spherical	true		是	必填，值为 true
maxDistance	number		否	距离最大值
minDistance	number		否	距离最小值
query	object|string		否	要求记录必须同时满足该条件（语法同 where）
distanceMultiplier	number		否	返回时在距离上乘以该数字
distanceField	string		是	存放距离的输出字段名，可以用点表示法表示一个嵌套字段
includeLocs	string		否	列出要用于距离计算的字段，如果记录中有多个字段都是地理位置时有用
key	string		否	选择要用的地理位置索引。如果集合由多个地理位置索引，则必须指定一个，指定的方式是指定对应的字段

示例

const res = await db.collection('geo-near').aggregate().geoNear({
    distanceField: 'distance',
    spherical: true,
    near: new db.Geo.Point(116.397689, 39.904626), // 人民英雄纪念碑
    maxDistance: 500,
    query: 'name == "readable"'
  }).end()

注意事项

• 存在geoNear时其query参数将取代where/doc作为权限校验依据，即query匹配到的结果需要满足权限才可以查询

unicloud-map 云端一体组件

若想要在地图上展示自定义的POI信息，试试 unicloud-map 云端一体组件，该组件将前端地图组件与云端数据库无缝连接，只需写一个<unicloud-map>组件，即可从数据库中获取附近的POI信息并在地图上呈现。无论是静态还是动态的POI，甚至更多自定义功能，都轻松实现。让地图开发变得愉快又高效。

下载地址：https://ext.dcloud.net.cn/plugin?name=unicloud-map

文档地址：https://uniapp.dcloud.net.cn/uniCloud/unicloud-map.html

渲染静态POI运行效果图

通过从数据库获取POI数据，渲染到地图上

渲染动态POI运行效果图

通过从数据库获取POI数据，并通过公共模块 uni-map-common 内的路线规划API，计算路线、距离、时间

运行效果图

查询某字段和另一个表的字段相等的记录

新增于 HBuilderX 3.7.12

用于匹配某字段和另一个表的字段相等的记录，类似sql语句中的in+子查询的写法，只能在where方法内使用。

示例

// company表数据
const company = [{
  _id: '1',
  status: 0
}, {
  _id: '2',
  status: 1
}]

// employee表数据
const employee = [{
  _id: '1',
  register_date: 1671000000000,
  company_id: '1'
}, {
  _id: '1',
  register_date: 1672000000000,
  company_id: '2'
}, {
  _id: '2',
  register_date: 1670000000000,
  company_id: '2'
}]

const companyFilter = db.collection('company').where('status == 0').field('_id').getTemp() // 过滤company表，取其中status为0的记录的_id组成过滤数组
const res = await db.collection('employee').where(`register_date > 1670000000000 && company_id in ${companyFilter}`).get() // 获取用户表的company_id在过滤条件内的记录

此查询匹配到的数据库记录为

[{
  _id: '1',
  register_date: 1671000000000,
  company_id: '1'
}]

注意

in的这种用法底层使用了lookup方法，在数据量很大时效率不高，推荐在使用时尽量在in之外的条件内筛选出尽量小的数据集。以上述示例中register_date > 1670000000000 && company_id in ${companyFilter}查询条件为例，register_date > 1670000000000这部分条件应筛选出尽量小的结果集以便查询能更高效。

使用限制

• 仅可以在单表读操作及getTemp的联表查询的where方法内使用，不可用于增删改及非getTemp的联表查询
• 过滤用的临时表必须指定field

新增数据记录

代码块dbadd

获取到db的表对象后，通过add方法新增数据记录。

方法：collection.add(data)

参数说明

参数	类型	必填
data	object | array	是

data支持一条记录，也支持多条记录一并新增到集合中。

data中不需要包括_id字段，数据库会自动维护该字段。

返回值

单条插入时

参数	类型	说明
id	String	插入记录的_id

批量插入时

参数	类型	说明
inserted	Number	插入成功条数
ids	Array	批量插入所有记录的_id

示例：

比如在user表里新增一个叫王五的记录：

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection('user').add({name:"王五"})

也可以批量插入数据并获取返回值

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
const collection = db.collection('user');
let res = await collection.add([{
  name: '张三'
},{
  name: '李四'
},{
  name: '王五'
}])

如果上述代码执行成功，则res的值将包括inserted:3，代表插入3条数据，同时在ids里返回3条记录的_id。

如果新增记录失败，会抛出异常，以下代码示例为捕获异常：

// 插入1条数据，同时判断成功失败状态
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection("user")
	.add({name: '张三'})
	.then((res) => {
		uni.showToast({
			title: '新增成功'
		})
	})
	.catch((err) => {
		uni.showModal({
			content: err.message || '新增失败',
			showCancel: false
		})
	})
	.finally(() => {

	})

Tips

• 如果是非admin账户新增数据，需要在数据库中待操作表的db schema中要配置permission权限，赋予create允许用户操作的权限。
• 云服务商选择阿里云时，若集合表不存在，调用add方法会自动创建集合表，并且不会报错。

删除数据记录

代码块dbremove

获取到db的表对象，然后指定要删除的记录，通过remove方法删除。

注意：如果是非admin账户删除数据，需要在数据库中待操作表的db schema中要配置permission权限，赋予delete允许用户操作的权限。

指定要删除的记录有2种方式：

通过指定文档ID删除

collection.doc(_id).remove()

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
await db.collection("table1").doc("5f79fdb337d16d0001899566").remove()

条件查找文档后删除

collection.where().remove()

// 删除字段a的值大于2的文档
try {
	await db.collection("table1").where("a>2").remove()
} catch (e) {
	uni.showModal({
		title: '提示',
		content: e.message
	})
}

删除该表所有数据

注意：数据量很多的情况下这种方式删除会超时，但是数据仍会全部删除掉

const dbCmd = db.command
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
await db.collection("table1").where({
  _id: dbCmd.neq(null)
}).remove()

响应结果

字段	类型	必填	说明
deleted	Number	否	删除的记录数量

示例：判断删除成功或失败，打印删除的记录数量

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.collection("table1")
  .where({
    _id: "5f79fdb337d16d0001899566"
  })
  .remove()
	.then((res) => {
		uni.showToast({
			title: '删除成功'
		})
		console.log("删除条数: ",res.deleted);
	}).catch((err) => {
		uni.showModal({
			content: err.message || '删除失败',
			showCancel: false
		})
	}).finally(() => {

	})

更新数据记录

代码块dbupdate

获取到db的表对象，然后指定要更新的记录，通过update方法更新。

注意：如果是非admin账户修改数据，需要在数据库中待操作表的db schema中要配置permission权限，赋予update为true。

collection.doc().update(Object data)

参数说明

参数	类型	必填	说明
data	object	是	更新字段的Object，{'name': 'Ben'} _id 非必填

回调的res响应参数

参数	类型	说明
updated	Number	更新成功条数，数据更新前后没变化时会返回0。用法与删除数据的响应参数示例相同

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
let collection = db.collection("table1")
let res = await collection.where({_id:'doc-id'})
  .update({
    name: "Hey",
    count: {
      fav: 1
    }
  });

// 更新前的数据
{
  "_id": "doc-id",
  "name": "Hello",
  "count": {
    "fav": 0,
    "follow": 0
  }
}

// 更新后的数据
{
  "_id": "doc-id",
  "name": "Hey",
  "count": {
    "fav": 1,
    "follow": 0
  }
}

更新数组时，以数组下标作为key即可，比如以下示例将数组arr内下标为1的值修改为 uniCloud

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
let collection = db.collection("table1")
let res = await collection.where({_id:'doc-id'})
  .update({
    arr: {
      1: "uniCloud"
    }
  })

// 更新前
{
  "_id": "doc-id",
  "arr": ["hello", "world"]
}
// 更新后
{
  "_id": "doc-id",
  "arr": ["hello", "uniCloud"]
}

批量更新文档

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
let collection = db.collection("table1")
let res = await collection.where("name=='hey'").update({
  age: 18,
})

更新数组内指定下标的元素

JQL暂不支持此用法

更新数组内匹配条件的元素

JQL暂不支持此用法

同时发送多条数据库请求

HBuilderX 3.1.22及以上版本支持

在实际业务中通常会遇到一个页面需要查询多次的情况，比如应用首页需要查询轮播图列表、公告列表、首页商品列表等。如果分开请求需要发送很多次网络请求，这样会影响性能。使用multiSend可以将多个数据库请求合并成一个发送。

用法

const bannerQuery = db.collection('banner').field('url,image').getTemp() // 这里使用getTemp不直接发送get请求，等到multiSend时再发送
const noticeQuery = db.collection('notice').field('text,url,level').getTemp()
const res = await db.multiSend(bannerQuery,noticeQuery)

返回值

// 上述请求返回以下结构
res = {
  errCode: 0, // 请求整体执行错误码，注意如果多条查询执行失败，这里的code依然是0，只有出现网络错误等问题时这里才会出现错误
  errMsg: "", // 错误信息
  dataList: [{
    errCode: 0, // bannerQuery 对应的错误码
    errMsg: '', // bannerQuery 对应的错误信息
    data: [] // bannerQuery 查询到的数据
  }, {
    errCode: 0, // noticeQuery 对应的错误码
    errMsg: '', // noticeQuery 对应的错误信息
    data: [] // noticeQuery 查询到的数据
  }]
}

unicloud-db组件也支持使用getTemp方法，结合multiSend可以与其他数据库请求一起发送

用法示例：

<template>
  <view>
    <!-- 设置unicloud-db 组件为手动加载 loadtime="manual" -->
    <unicloud-db collection="banner" loadtime="manual" ref="udb" v-slot:default="{data, error}">
      <view v-if="error">{{error.message}}</view>
      <view v-else>
        <view v-for="(item,index) in data" :key="index">
          <image :src="item.url"></image>
        </view>
      </view>
    </unicloud-db>
    <button type="default" @click="test">test</button>
  </view>
</template>

<script>
  export default {
    data() {
      return {
        title: 'Hello'
      }
    },
    onLoad() {

    },
    methods: {
      test() {
        // 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
        const db = uniCloud.databaseForJQL()
        const bannerQuery = this.$refs.udb.getTemp() // 调用模板内unicloud-db组件实例的getTemp方法
        const noticeQuery = db.collection('notice').getTemp()
        db.multiSend(bannerQuery, noticeQuery)
          .then(res => {
            console.log('banner', res.result.dataList[0]); // 使用unicloud-db组件的getTemp请求无需额外处理，查询结果会直接被设置到unicloud-db组件内
            console.log('notice', res.result.dataList[1]); // 不使用unicloud-db组件的getTemp请求需要自行处理返回值
          })
          .catch(err => {
            console.error(err)
          })
        // uniCloud.database().collection('test').get()
      }
    }
  }
</script>

<style>
</style>

MongoDB聚合操作

JQL API支持使用聚合操作读取数据，关于聚合操作请参考聚合操作

例：取status等于1的随机20条数据

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
const res = await db.collection('test').aggregate()
.match({
  status: 1
})
.sample({
  size: 20
})
.end()

更新操作符(重命名或删除字段)

新增于 HBuilderX 3.5.1，JQL数据库管理支持使用更新操作符

更新操作符可以在执行更新时使用。比如对字段重命名（rename）、删除字段（remove）等。适用于表结构变更后，使用 HBuilderX 的 JQL管理器进行数据变更。

db.command.rename重命名字段：

db.collection('test').update({
	field_to_rename: db.command.rename('final_field_name') // 将field_to_rename重命名为final_field_name
})

db.command.remove删除字段：

db.collection('test').update({
	field_to_remove: db.command.remove() // 删除field_to_remove字段
})

注意

• 仅 HBuilderX 3.5.1+ 中的 JQL数据库管理器中可用
• 支持批量传入重命名或删除指令
• 使用更新操作符后，将完全跳过所有数据校验操作，即无论schema中如何配置数据的值域规则，都将无法生效。所以更新操作符不宜与普通的数据增删改混在一起执行。

DBSchema

DB Schema是基于 JSON 格式定义的数据结构的规范。

它有很多重要的作用：

• 描述现有的数据格式。可以一目了然的阅读每个表、每个字段的用途。
• 设定数据操作权限(permission)。什么样的角色可以读/写哪些数据，都在这里配置。
• 设定字段值域能接受的格式(validator)，比如不能为空、需符合指定的正则格式。
• 设置数据的默认值(defaultValue/forceDefaultValue)，比如服务器当前时间、当前用户id等。
• 设定多个表的字段间映射关系(foreignKey)，将多个表按一个虚拟联表直接查询，大幅简化联表查询。
• 根据schema自动生成表单维护界面，比如新建页面和编辑页面，自动处理校验规则。

这些工具大幅减少了开发者的开发工作量和重复劳动。

DB Schema是JQL紧密相关的配套，掌握JQL离不开详读DB Schema文档。

**下面示例中使用了注释，实际使用时schema是一个标准的json文件不可使用注释。**完整属性参考schema字段

{
  "bsonType": "object", // 表级的类型，固定为object
  "required": ['book', 'quantity'], // 新增数据时必填字段
  "permission": { // 表级权限
    "read": true, // 读
    "create": false, // 新增
    "update": false, // 更新
    "delete": false, // 删除
  },
  "properties": { // 字段列表，注意这里是对象
    "book": { // 字段名book
      "bsonType": "string", // 字段类型
      "permission": { // 字段权限
        "read": true, // 字段读权限
        "write": false, // 字段写权限
      },
      "foreignKey": "book._id" // 其他表的关联字段
    },
    "quantity": {
      "bsonType": "int"
    }
  }
}

permission

DB Schema中的数据权限配置功能非常强大，请详读DB Schema的数据权限控制

在配置好DB Schema的权限后，JQL的查询写法，尤其是非JQL的聚合查询写法有些限制，具体如下：

• 不使用聚合时collection方法之后需紧跟一个where方法，这个where方法内传入的条件必须满足权限控制规则
• 使用聚合时aggregate方法之后需紧跟一个match方法，这个match方法内的条件需满足权限控制规则
• 使用lookup时只可以使用拼接子查询的写法（let+pipeline模式），做这个限制主要是因为需要确保访问需要lookup的表时也会传入查询条件，即pipeline参数里面db.command.pipeline()之后的match方法也需要像上一条里面的match一样限制
• 上面用于校验权限的match和where后的project和field是用来确定本次查询需要访问什么字段的（如果没有将会认为是在访问所有字段），访问的字段列表会用来确认使用那些字段权限校验。这个位置的project和field只能使用白名单模式
• 上面用于校验权限的match和where内如果有使用db.command.expr，那么在进行权限校验时expr方法内部的条件会被忽略，整个expr方法转化成一个不与任何条件产生交集的特别表达式，具体表现请看下面示例

schema内permission配置示例

// order表schema
{
  "bsonType": "object", // 表级的类型，固定为object
  "required": ['book', 'quantity'], // 新增数据时必填字段
  "permission": { // 表级权限
    "read": "doc.uid == auth.uid", // 每个用户只能读取用户自己的数据。前提是要操作的数据doc，里面有一个字段存放了uid，即uni-id的用户id。（不配置时等同于false）
    "create": false, // 禁止新增数据记录（不配置时等同于false）
    "update": false, // 禁止更新数据（不配置时等同于false）
    "delete": false, // 禁止删除数据（不配置时等同于false）
	"count": false, // 禁止对本表进行count计数
  },
  "properties": { // 字段列表，注意这里是对象
    "secret_field": { // 字段名
      "bsonType": "string", // 字段类型
      "permission": { // 字段权限
        "read": false, // 禁止读取secret_field字段的数据
        "write": false // 禁止写入（包括更新和新增）secret_field字段的数据，父级节点存在false时这里可以不配
      }
    },
    "uid":{
      "bsonType": "string", // 字段类型
      "foreignKey": "uni-id-users._id"
    },
    "book_id": {
      "bsonType": "string", // 字段类型
      "foreignKey": "book._id"
    }
  }
}

// book表schema
{
  "bsonType": "object",
  "required": ['book', 'quantity'], // 新增数据时必填字段
  "permission": { // 表级权限
    "read": "doc.status == 'OnSell'" // 允许所有人读取状态是OnSell的数据
  },
  "properties": { // 字段列表，注意这里是对象
    "title": {
      "bsonType": "string"
    },
    "author": {
      "bsonType": "string"
    },
    "secret_field": { // 字段名
      "bsonType": "string", // 字段类型
      "permission": { // 字段权限
        "read": false, // 禁止读取secret_field字段的数据
        "write": false // 禁止写入（包括更新和新增）secret_field字段的数据
      }
    }
  }
}

请求示例

// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
const dbCmd = db.command
const $ = dbCmd.aggregate
db.collection('order')
  .where('uid == $env.uid && book_id.status == "OnSell"')
  .field('uid,book_id{title,author}')
  .get()

在进行数据库操作之前，JQL会使用permission内配置的规则对客户端操作进行一次校验，如果本次校验不通过还会通过数据库查询再进行一次校验

例1：

// 数据库内news表有以下数据
{
  _id: "1",
  user_id: "uid_1",
  title: "abc"
}

// news表对应的schema内做如下配置
{
  "bsonType": "object",
  "permission": { // 表级权限
    "read": true,
    "update": "doc.user_id == auth.uid" // 只允许修改自己的数据
  },
  "properties": {
    "user_id": {
      "bsonType": "string"
    },
    "title": {
      "bsonType": "string"
    }
  }
}

// 用户ID为uid_1的用户在客户端使用如下操作
db.collection('news').doc('1').update({
  title: 'def'
})

此时客户端条件里面只有doc._id == 1，schema内又限制的doc.user_id == auth.uid，所以第一次预校验无法通过，会进行一次查库校验判断是否有权限进行操作。发现auth.uid确实和doc.user_id一致，上面的数据库操作允许执行。

例2：

// 数据库内goods表有以下数据
{
  _id: "1",
  name: "n1",
  status: 1
}
{
  _id: "2",
  name: "n2",
  status: 2
}
{
  _id: "3",
  name: "n3",
  status: 3
}

// news表对应的schema内做如下配置
{
  "bsonType": "object",
  "permission": { // 表级权限
    "read": "doc.status > 1",
  },
  "properties": {
    "name": {
      "bsonType": "string"
    },
    "status": {
      "bsonType": "int"
    }
  }
}

// 用户在客户端使用如下操作，可以通过第一次校验，不会触发查库校验
db.collection('goods').where('status > 1').get()

// 用户在客户端使用如下操作，无法通过第一次校验，会触发一次查库校验（原理大致是使用name == "n3" && status <= 1作为条件进行一次查询，如果有结果就认为没有权限访问，了解即可，无需深入）
db.collection('goods').where('name == "n3"').get()

// 用户在客户端使用如下操作，无法通过第一次校验，会触发一次查库校验，查库校验也会无法通过
db.collection('goods').where('name == "n1"').get()

action

注意：

从HBuilderX 3.6.11开始，推荐使用数据库触发器替代action云函数。以下内容仅为向下兼容保留

action的作用是在执行前端发起的数据库操作时，额外触发一段云函数逻辑。它是一个可选模块。action是运行于云函数内的，可以使用云函数内的所有接口。

当一个前端操作数据库的方式不能完全满足需求，仍然同时需要在云端再执行一些云函数时，就在前端发起数据库操作时，通过db.action("someactionname")方式要求云端同时执行这个叫someactionname的action。还可以在权限规则内指定某些操作必须使用指定的action，比如"action in ['action-a','action-b']"，来达到更灵活的权限控制。

注意action方法是db对象的方法，只能跟在db后面，不能跟在collection()后面

• 正确：db.action("someactionname").collection('table1')
• 错误：db.collection('table1').action("someactionname")

尽量不要在action中使用全局变量，如果一定要用请务必确保自己已经阅读并理解了云函数的启动模式

如果使用<unicloud-db>组件，该组件也有action属性，设置action="someactionname"即可。

<unicloud-db ref="udb" collection="table1" action="someactionname" v-slot:default="{data,pagination,loading,error}">

action支持一次使用多个，比如使用db.action("action-a,action-b")，其执行流程为action-a.before->action-b.before->执行数据库操作->action-b.after->action-a.after。在任一before环节抛出错误直接进入after流程，在after流程内抛出的错误会被传到下一个after流程。

action是一种特殊的云函数，它不占用服务空间的云函数数量。

新建action

每个action在uni-clientDB-actions目录下存放一个以action名称命名的js文件。

在这个js文件的代码里，包括before和after两部分，分别代表JQL具体操作数据库前和后。

• before在数据库操作执行前触发，before里的代码执行完毕后再开始操作数据库。before的常用用途：

  • 对前端传入的数据进行二次处理
  • 在此处开启数据库事务，万一操作数据库失败，可以在after里回滚
  • 使用throw阻止运行
  • 如果权限或字段值域校验不想配在schema和validateFunction里，也可以在这里做校验

• after在数据库操作执行后触发，JQL操作数据库后触发after里的代码。after的常用用途：

  • 对将要返回给前端的数据进行二次处理
  • 也可以在此处处理错误，回滚数据库事务
  • 对数据库进行二次操作，比如前端查询一篇文章详情后，在此处对文章的阅读数+1。因为permission里定义，一般是要禁止前端操作文章的阅读数字段的，此时就应该通过action，在云函数里对阅读数+1

示例：

// 客户端发起请求，给todo表新增一行数据，同时指定action为add-todo
// 注意，此处的db是通过 uniCloud.databaseForJQL() 得到，而不是 uniCloud.database()
const db = uniCloud.databaseForJQL()
db.action('add-todo') //注意action方法是db的方法，只能跟在db后面，不能跟在collection()后面
  .collection('todo')
  .add({
    title: 'todo title'
  })
  .then(res => {
    console.log(res)
  }).catch(err => {
    console.error(err)
  })

// 一个action文件示例 uni-clientDB-actions/add-todo.js
module.exports = {
  // 在数据库操作之前执行
  before: async(state,event)=>{
    // state为当前数据库操作状态其格式见下方说明
    // event为传入云函数的event对象

    // before内可以操作state上的newData对象对数据进行修改，比如：
    state.newData.create_time = Date.now()
    // 指定插入或修改的数据内的create_time为Date.now()
    // 执行了此操作之后实际插入的数据会变成 {title: 'todo title', create_time: xxxx}
    // 实际上，这个场景，有更简单的实现方案：在db schema内配置defaultValue或者forceDefaultValue，即可自动处理新增记录使用当前服务器时间
  },
  // 在数据库操作之后执行
  after:async (state,event,error,result)=>{
    // state为当前数据库操作状态其格式见下方说明
    // event为传入云函数的event对象
    // error为执行操作的错误对象，如果没有错误error的值为null
    // result为执行command返回的结果

    if(error) {
      throw error
    }

    // after内可以对result进行额外处理并返回
    result.msg = 'hello'
    return result
  }
}

state参数说明

// state参数格式如下
{
  command: {
    // getMethod('where') 获取所有的where方法，返回结果为[{$method:'where',$param: [{a:1}]}]
    getMethod,
    // getParam({name:'where',index: 0}) 获取第1个where方法的参数，结果为数组形式，例：[{a:1}]
    getParam,
    // setParam({name:'where',index: 0, param: [{a:1}]}) 设置第1个where方法的参数，调用之后where方法实际形式为：where({a:1})
    setParam
  },
  auth: {
    uid, // 用户ID，如果未获取或者获取失败uid值为null
    role, // 通过uni-id获取的用户角色，需要使用1.1.9以上版本的uni-id，如果未获取或者获取失败role值为[]
    permission // 通过uni-id获取的用户权限，需要使用1.1.9以上版本的uni-id，如果未获取或者获取失败permission值为[]，注意登录时传入needPermission才可以获取permission，请参考 https://uniapp.dcloud.net.cn/uniCloud/uni-id?id=rbac
  },
  // 事务对象，如果需要用到事务可以在action的before内使用state.transaction = await db.startTransaction()传入
  transaction,
  // 更新或新增的数据
  newData,
  // 访问的集合
  collection,
  // 操作类型，可能的值'read'、'create'、'update'、'delete'
  type
}

注意

• 如需在before和after内传参，建议直接在state上挂载。但是切勿覆盖上述属性
• action上传后可能需要一段时间才会在云端生效，通常是3分钟左右

JQL依赖公共模块和扩展库

相关文档移至：schema扩展依赖公共模块和扩展库