Skip to content

Commit

Permalink
feat(doc): update query documentation (#551)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ahoo-Wang
Ahoo-Wang authored Mar 5, 2024
1 parent 1637dd7 commit 4d5ea5f
Showing 1 changed file with 26 additions and 118 deletions.
144 changes: 26 additions & 118 deletions documentation/docs/guide/query.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,124 +2,32 @@

## 操作符

```kotlin
enum class Operator {
/**
* 对提供的条件列表执行逻辑与
*/
AND,

/**
* 对提供的条件列表执行逻辑或
*/
OR,

/**
* 匹配`id`字段值等于指定值的所有文档
*/
ID,

/**
* 匹配`id`字段值等于指定值列表中的任何值的所有文档
*/
IDS,

/**
* 匹配所有文档
*/
ALL,

/**
* 匹配字段名称值等于指定值的所有文档
*/
EQ,

/**
* 匹配字段名称值不等于指定值的所有文档
*/
NE,

/**
* 匹配给定字段的值大于指定值的所有文档
*/
GT,

/**
* 匹配给定字段的值小于指定值的所有文档
*/
LT,

/**
* 匹配给定字段的值大于或等于指定值的所有文档
*/
GTE,

/**
* 匹配给定字段的值小于或等于指定值的所有文档
*/
LTE,

/**
* 匹配给定字段的值包含指定值的所有文档
*/
CONTAINS,

/**
* 匹配字段值等于指定值列表中的任何值的所有文档
*/
IN,

/**
* 匹配字段值不等于任何指定值或不存在的所有文档
*/
NOT_IN,

/**
* 匹配字段值在指定值范围区间的所有文档
*/
BETWEEN,

/**
* 匹配所有文档，其中字段值是包含所有指定值的数组
*/
ALL_IN,

/**
* 匹配字段值以指定字符串开头的文档
*/
STARTS_WITH,

/**
* 匹配字段值以指定字符串结尾的文档
*/
ENDS_WITH,

/**
* 条件与包含数组字段的所有文档相匹配，其中数组中至少有一个成员与给定的条件匹配。
*/
ELEM_MATCH,

/**
* 匹配字段值在指定值为`null`的所有文档
*/
NULL,

/**
* 匹配字段值在指定值不为`null`的所有文档
*/
NOT_NULL,

/**
* 匹配字段值在指定值为`true`的所有文档
*/
TRUE,

/**
* 匹配字段值在指定值为`false`的所有文档
*/
FALSE
}
```
| 操作符 | 描述 |
|-------------|-----------------------------------------|
| AND | 对提供的条件列表执行逻辑与 |
| OR | 对提供的条件列表执行逻辑或 |
| ID | 匹配`id`字段值等于指定值的所有文档 |
| IDS | 匹配`id`字段值等于指定值列表中的任何值的所有文档 |
| ALL | 匹配所有文档 |
| EQ | 匹配字段名称值等于指定值的所有文档 |
| NE | 匹配字段名称值不等于指定值的所有文档 |
| GT | 匹配给定字段的值大于指定值的所有文档 |
| LT | 匹配给定字段的值小于指定值的所有文档 |
| GTE | 匹配给定字段的值大于或等于指定值的所有文档 |
| LTE | 匹配给定字段的值小于或等于指定值的所有文档 |
| CONTAINS | 匹配给定字段的值包含指定值的所有文档 |
| IN | 匹配字段值等于指定值列表中的任何值的所有文档 |
| NOT_IN | 匹配字段值不等于任何指定值或不存在的所有文档 |
| BETWEEN | 匹配字段值在指定值范围区间的所有文档 |
| ALL_IN | 匹配所有文档，其中字段值是包含所有指定值的数组 |
| STARTS_WITH | 匹配字段值以指定字符串开头的文档 |
| ENDS_WITH | 匹配字段值以指定字符串结尾的文档 |
| ELEM_MATCH | 条件与包含数组字段的所有文档相匹配，其中数组中至少有一个成员与给定的条件匹配。 |
| NULL | 匹配字段值在指定值为`null`的所有文档 |
| NOT_NULL | 匹配字段值在指定值不为`null`的所有文档 |
| TRUE | 匹配字段值在指定值为`true`的所有文档 |
| FALSE | 匹配字段值在指定值为`false`的所有文档 |
| RAW | 原始操作符，将条件值直接作为原始的数据库查询条件 |

## Query DSL

Expand Down

0 comments on commit 4d5ea5f

Please sign in to comment.