未验证 提交 3a3414d1 编写于 作者: 葛亚芳 提交者: Gitee

update zh-cn/application-dev/reference/apis/js-apis-data-dataSharePredicates.md.

Signed-off-by: N@ge-yafang <geyafang@huawei.com>
上级 4ca92de4
master OpenHarmony-3.2-Beta3 OpenHarmony-3.2-Beta4 OpenHarmony-3.2-Beta5 OpenHarmony-3.2-Release OpenHarmony-4.0-Beta1 OpenHarmony-4.0-Beta2 bak_OpenHarmony-4.0-Beta1_20230529 docs-modify monthly_20220816 monthly_20221018 monthly_20230815 revert-merge-17651-master revert-merge-19334-OpenHarmony-4.0-Beta1 revert-merge-19586-master revert-merge-20613-master revert-merge-21757-OpenHarmony-4.0-Beta2 revert-merge-21765-OpenHarmony-4.0-Beta2 revert-merge-23766-master weekly_20220816 weekly_20220823 weekly_20220830 weekly_20220906 weekly_20220913 weekly_20220920 weekly_20220927 weekly_20221004 weekly_20221011 weekly_20221018 weekly_20221025 weekly_20221101 weekly_20221108 weekly_20221115 weekly_20221122 weekly_20221129 weekly_20221206 weekly_20221213 weekly_20221220 weekly_20221227 weekly_20230103 weekly_20230110 weekly_20230117 weekly_20230124 weekly_20230131 weekly_20230207 weekly_20230214 weekly_20230221 weekly_20230228 weekly_20230307 weekly_20230314 weekly_20230321 weekly_20230328 weekly_20230404 weekly_20230411 weekly_20230418 weekly_20230425 weekly_20230502 weekly_20230509 weekly_20230516 weekly_20230523 weekly_20230530 weekly_20230606 weekly_20230613 weekly_20230619 weekly_20230626 weekly_20230627 weekly_20230704 weekly_20230712 weekly_20230725 weekly_20230801 weekly_20230808 weekly_20230815 weekly_20230822 weekly_20230829 weekly_20230905 OpenHarmony-v4.0-Beta2 OpenHarmony-v4.0-Beta1 OpenHarmony-v3.2.3-Release OpenHarmony-v3.2.2-Release OpenHarmony-v3.2.1-Release OpenHarmony-v3.2-Release OpenHarmony-v3.2-Beta5 OpenHarmony-v3.2-Beta4 OpenHarmony-v3.2-Beta3
无相关合并请求
......@@ -2,14 +2,16 @@
**谓词(DataSharePredicates)** 是用户通过DataShare查询数据库中的数据所使用的筛选条件,经常被应用在更新数据([update](js-apis-data-dataShare.md#update))、删除数据([delete](js-apis-data-dataShare.md#delete))和查询数据([query](js-apis-data-dataShare.md#query))中。
>**说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口为系统接口。
## 导入模块
```ts
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates';
```
......@@ -20,7 +22,7 @@ import dataSharePredicates from '@ohos.data.dataSharePredicates';
equalTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值等于指定值的字段。
该接口用于配置谓词以匹配值等于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -41,7 +43,7 @@ equalTo(field: string, value: ValueType): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose")
```
......@@ -50,7 +52,7 @@ predicates.equalTo("NAME", "Rose")
notEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。
该接口用于配置谓词以匹配值不等于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -71,7 +73,7 @@ notEqualTo(field: string, value: ValueType): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.notEqualTo("NAME", "Rose")
```
......@@ -80,7 +82,9 @@ predicates.notEqualTo("NAME", "Rose")
beginWrap(): DataSharePredicates
该接口用于向谓词添加左括号。目前仅RDB支持该谓词。
该接口用于向谓词添加左括号。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -92,7 +96,7 @@ beginWrap(): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "lisi")
.beginWrap()
......@@ -106,7 +110,9 @@ predicates.equalTo("NAME", "lisi")
endWrap(): DataSharePredicates
该接口用于向谓词添加右括号。目前仅RDB支持该谓词。
该接口用于向谓词添加右括号。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -118,7 +124,7 @@ endWrap(): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "lisi")
.beginWrap()
......@@ -146,7 +152,7 @@ or(): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "lisi")
.or()
......@@ -171,7 +177,7 @@ and(): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "lisi")
.and()
......@@ -182,7 +188,9 @@ predicates.equalTo("NAME", "lisi")
contains(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值包含指定的字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配包含指定的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -201,7 +209,7 @@ contains(field: string, value: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.contains("NAME", "os")
```
......@@ -210,7 +218,9 @@ predicates.contains("NAME", "os")
beginsWith(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值以指定字符串起始的字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配值以指定字符串起始的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -229,7 +239,7 @@ beginsWith(field: string, value: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.beginsWith("NAME", "os")
```
......@@ -238,7 +248,9 @@ predicates.beginsWith("NAME", "os")
endsWith(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配值以指定字符串结尾的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -257,7 +269,7 @@ endsWith(field: string, value: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.endsWith("NAME", "os")
```
......@@ -286,7 +298,7 @@ isNull(field: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.isNull("NAME")
```
......@@ -295,7 +307,7 @@ predicates.isNull("NAME")
isNotNull(field: string): DataSharePredicates
该接口用于配置谓词以匹配值不为null的指定字段。
该接口用于配置谓词以匹配值不为null的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -315,7 +327,7 @@ isNotNull(field: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.isNotNull("NAME")
```
......@@ -324,7 +336,7 @@ predicates.isNotNull("NAME")
like(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值类似于指定字符串的字段。
该接口用于配置谓词以匹配值类似于指定字符串的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -345,7 +357,7 @@ like(field: string, value: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.like("NAME", "%os%")
```
......@@ -354,7 +366,7 @@ predicates.like("NAME", "%os%")
unlike(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值不类似于指定字符串的字段。
该接口用于配置谓词以匹配值不类似于指定字符串的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -375,7 +387,7 @@ unlike(field: string, value: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.unlike("NAME", "%os%")
```
......@@ -384,7 +396,9 @@ predicates.unlike("NAME", "%os%")
glob(field: string, value: string): DataSharePredicates
该接口用于配置谓词匹配数据类型为string的指定字段。目前仅RDB支持该谓词。
该接口用于配置谓词匹配数据类型为string的指定字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -403,7 +417,7 @@ glob(field: string, value: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.glob("NAME", "?h*g")
```
......@@ -412,7 +426,9 @@ predicates.glob("NAME", "?h*g")
between(field: string, low: ValueType, high: ValueType): DataSharePredicates
该接口用于将谓词配置为匹配数据类型为ValueType且值在指定范围内的指定字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配值在指定范围内的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -432,7 +448,7 @@ between(field: string, low: ValueType, high: ValueType): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.between("AGE", 10, 50)
```
......@@ -441,7 +457,9 @@ predicates.between("AGE", 10, 50)
notBetween(field: string, low: ValueType, high: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值超出给定范围的指定字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配值超出指定范围的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -461,7 +479,7 @@ notBetween(field: string, low: ValueType, high: ValueType): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.notBetween("AGE", 10, 50)
```
......@@ -470,7 +488,7 @@ predicates.notBetween("AGE", 10, 50)
greaterThan(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值大于指定值的字段。
该接口用于配置谓词以匹配值大于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -491,7 +509,7 @@ greaterThan(field: string, value: ValueType): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.greaterThan("AGE", 10)
```
......@@ -500,7 +518,7 @@ predicates.greaterThan("AGE", 10)
lessThan(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值小于指定值的字段。
该接口用于配置谓词以匹配值小于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -521,7 +539,7 @@ lessThan(field: string, value: ValueType): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.lessThan("AGE", 50)
```
......@@ -530,7 +548,7 @@ predicates.lessThan("AGE", 50)
greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值大于或等于指定值的字段。
该接口用于配置谓词以匹配值大于或等于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -551,7 +569,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.greaterThanOrEqualTo("AGE", 10)
```
......@@ -560,7 +578,7 @@ predicates.greaterThanOrEqualTo("AGE", 10)
lessThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值小于或等于指定值的字段。
该接口用于配置谓词以匹配值小于或等于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -581,7 +599,7 @@ lessThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.lessThanOrEqualTo("AGE", 50)
```
......@@ -610,7 +628,7 @@ orderByAsc(field: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.orderByAsc("AGE")
```
......@@ -639,7 +657,7 @@ orderByDesc(field: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.orderByDesc("AGE")
```
......@@ -648,7 +666,9 @@ predicates.orderByDesc("AGE")
distinct(): DataSharePredicates
该接口用于配置谓词以过滤重复记录并仅保留其中一个。目前仅RDB支持该谓词。
该接口用于配置谓词以过滤重复记录并仅保留其中一个。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -660,7 +680,7 @@ distinct(): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose").distinct()
```
......@@ -690,7 +710,7 @@ limit(total: number, offset: number): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose").limit(10, 3)
```
......@@ -699,7 +719,9 @@ predicates.equalTo("NAME", "Rose").limit(10, 3)
groupBy(fields: Array&lt;string&gt;): DataSharePredicates
该接口用于配置谓词按指定列分组查询结果。目前仅RDB支持该谓词。
该接口用于配置谓词按指定列分组查询结果。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -717,7 +739,7 @@ groupBy(fields: Array&lt;string&gt;): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.groupBy(["AGE", "NAME"])
```
......@@ -726,7 +748,9 @@ predicates.groupBy(["AGE", "NAME"])
indexedBy(field: string): DataSharePredicates
该接口用于配置谓词按指定索引列查询结果。目前仅RDB支持该谓词。
该接口用于配置谓词按指定索引列查询结果。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -744,7 +768,7 @@ indexedBy(field: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.indexedBy("SALARY_INDEX")
```
......@@ -753,7 +777,7 @@ predicates.indexedBy("SALARY_INDEX")
in(field: string, value: Array&lt;ValueType&gt;): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。
该接口用于配置谓词以匹配值在指范围内的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -774,7 +798,7 @@ in(field: string, value: Array&lt;ValueType&gt;): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.in("AGE", [18, 20])
```
......@@ -783,7 +807,7 @@ predicates.in("AGE", [18, 20])
notIn(field: string, value: Array&lt;ValueType&gt;): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。
该接口用于配置谓词以匹配值不在指定范围内的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -804,7 +828,7 @@ notIn(field: string, value: Array&lt;ValueType&gt;): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.notIn("NAME", ["Lisa", "Rose"])
```
......@@ -813,7 +837,9 @@ predicates.notIn("NAME", ["Lisa", "Rose"])
prefixKey(prefix: string): DataSharePredicates
该接口用于配置谓词以匹配键前缀的指定字段。目前仅KVDB支持该谓词。
该接口用于配置谓词以匹配键前缀的指定字段。
目前仅KVDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -831,7 +857,7 @@ prefixKey(prefix: string): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.prefixKey("NAME")
```
......@@ -840,7 +866,9 @@ predicates.prefixKey("NAME")
inKeys(keys: Array&lt;string&gt;): DataSharePredicates
该接口用于配置谓词以匹配键在给定范围内的指定字段。目前仅KVDB支持该谓词。
该接口用于配置谓词以匹配键在指定范围内的字段。
目前仅KVDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -848,7 +876,7 @@ inKeys(keys: Array&lt;string&gt;): DataSharePredicates
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------- | ---- | ------------------ |
| inKeys | Array&lt;string&gt; | 是 | 定范围的键数组。 |
| inKeys | Array&lt;string&gt; | 是 | 定范围的键数组。 |
**返回值:**
......@@ -858,7 +886,7 @@ inKeys(keys: Array&lt;string&gt;): DataSharePredicates
**示例:**
```ts
```js
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.inKeys(["Lisa", "Rose"])
```
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册
反馈
建议
客服 返回
顶部