# @ohos.data.dataSharePredicates (数据共享谓词)

> phone 12+ | 2in1 13+ | tablet 12+ | tv 19+ | wearable 18+

**谓词(DataSharePredicates)** 是开发者通过DataShare查询数据库中的数据所使用的筛选条件，经常被应用在更新数据、删除数据和查询数据中。

谓词的接口函数与数据库的筛选条件一一对应，开发者在使用前需了解数据库相关知识。

谓词(DataSharePredicates)的使用场景如下：

* 用于在媒体文件管理服务作为检索条件使用，参考相册管理模块检索条件[FetchOptions](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-photoaccesshelper-i#fetchoptions)。此种场景下，开发者无需关注数据库类型。

> 说明
>
> * 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> * 本模块接口仅可在Stage模型下使用。

## 导入模块

```ts
import { dataSharePredicates } from '@kit.ArkData';
```

## DataSharePredicates

提供用于不同实现不同查询方法的数据共享谓词。该类型不是多线程安全的，如果应用中存在多线程同时操作该类派生出的实例，注意加锁保护。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

### equalTo

equalTo(field: string, value: ValueType): DataSharePredicates

该接口用于配置谓词以匹配值等于指定值的字段。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**元服务API：** 从API version 20开始，该接口支持在元服务中使用。

**参数：**

|参数名|类型|必填|说明|
|:----|:-----------------------------------------------------------------------------------------------------------------|:-|:-----------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。|
|value|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示要与谓词匹配的值。 value为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo("NAME", "Rose");
```

### and

and(): DataSharePredicates

该接口用于将和条件添加到谓词中。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**元服务API：** 从API version 20开始，该接口支持在元服务中使用。

**返回值：**

|类型|说明|
|:------------------------------------------|:----------|
|[DataSharePredicates](#datasharepredicates)|返回带有和条件的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo("NAME", "lisi")
    .and()
    .equalTo("SALARY", 200.5);
```

### orderByAsc

orderByAsc(field: string): DataSharePredicates

该接口用于配置谓词以匹配其值按升序排序的列。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**元服务API：** 从API version 20开始，该接口支持在元服务中使用。

**参数：**

|参数名|类型|必填|说明|
|:----|:-----|:-|:---------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.orderByAsc("AGE");
```

### orderByDesc

orderByDesc(field: string): DataSharePredicates

该接口用于配置谓词以匹配其值按降序排序的列。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**元服务API：** 从API version 20开始，该接口支持在元服务中使用。

**参数：**

|参数名|类型|必填|说明|
|:----|:-----|:-|:---------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.orderByDesc("AGE");
```

### limit

limit(total: number, offset: number): DataSharePredicates

该接口用于配置谓词以指定结果数和起始位置。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**元服务API：** 从API version 20开始，该接口支持在元服务中使用。

**参数：**

|参数名|类型|必填|说明|
|:-----|:-----|:-|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|total|number|是|最大数据记录数。 当使用键值型数据库且total为undefined或null时，会限制最大记录数为0。 当使用关系型数据库且total为undefined或null时，不会限制最大记录数。 当使用键值型数据库时，取值范围参考[键值型数据库limit接口](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-distributedkvstore#limit)中的total参数说明。 当使用关系型数据库时，取值范围参考[关系型数据库limitAs接口](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-data-relationalstore-rdbpredicates#limitas)中的value参数说明。|
|offset|number|是|指定查询结果的起始位置。 当offset为undefined或null时，起始位置为结果集的最前端。 当使用键值型数据库时，取值范围参考[键值型数据库limit接口](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-distributedkvstore#limit)中的offset参数说明。 当使用关系型数据库时，取值范围参考[关系型数据库offsetAs接口](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-data-relationalstore-rdbpredicates#offsetas)中的rowOffset参数说明。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo("NAME", "Rose").limit(10, 3);
```

### in

in(field: string, value: Array<ValueType>): DataSharePredicates

该接口用于配置谓词以匹配值在指定范围内的字段。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**元服务API：** 从API version 20开始，该接口支持在元服务中使用。

**参数：**

|参数名|类型|必填|说明|
|:----|:------------------------------------------------------------------------------------------------------------------------|:-|:-----------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|value|Array<[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)>|是|以ValueType型数组形式指定的要匹配的值。 value为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.in("AGE", [18, 20]);
```

### notEqualTo^23+^

notEqualTo(field: string, value: ValueType): DataSharePredicates

该接口用于配置谓词以匹配值不等于指定值的字段。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**参数：**

|参数名|类型|必填|说明|
|:----|:-----------------------------------------------------------------------------------------------------------------|:-|:------------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 当field为undefined或null时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|value|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示要与谓词匹配的值。 value为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.notEqualTo("NAME", "Rose");
```

### beginWrap^23+^

beginWrap(): DataSharePredicates

该接口用于向谓词添加左括号，相当于SQL语句的"("，必须和右括号一起使用。

目前仅关系型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**返回值：**

|类型|说明|
|:------------------------------------------|:----------|
|[DataSharePredicates](#datasharepredicates)|返回带有左括号的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap();
```

### endWrap^23+^

endWrap(): DataSharePredicates

该接口用于向谓词添加右括号，相当于SQL语句的")"，必须和左括号一起使用。

目前仅关系型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**返回值：**

|类型|说明|
|:------------------------------------------|:----------|
|[DataSharePredicates](#datasharepredicates)|返回带有右括号的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap();
```

### or^23+^

or(): DataSharePredicates

该接口用于将或条件添加到谓词中。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**返回值：**

|类型|说明|
|:------------------------------------------|:----------|
|[DataSharePredicates](#datasharepredicates)|返回带有或条件的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo("NAME", "lisi")
    .or()
    .equalTo("NAME", "Rose");
```

### like^23+^

like(field: string, value: string): DataSharePredicates

该接口用于配置谓词以匹配指定通配符表达式的字段。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**参数：**

|参数名|类型|必填|说明|
|:----|:-----|:-|:-----------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|value|string|是|指示要与谓词匹配的通配符表达式。 表达式中'%'代表零个、一个或多个数字或字符，'_'代表一个单一的数字或字符，不区分大小写。 value为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.like("NAME", "%os%");
```

### between^23+^

between(field: string, low: ValueType, high: ValueType): DataSharePredicates

该接口用于配置谓词以匹配值在指定范围内的字段。包含两端边界值，为左闭右闭区间。

目前仅关系型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**参数：**

|参数名|类型|必填|说明|
|:----|:-----------------------------------------------------------------------------------------------------------------|:-|:-----------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|low|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示与谓词匹配的最小值。 low为number时，按数值排序指定匹配范围。 low为string时，按字典序排序指定匹配范围。 low为boolean时，按数值排序指定匹配范围。|
|high|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示与谓词匹配的最大值。 high为number时，按数值排序指定匹配范围。 high为string时，按字典序排序指定匹配范围。 high为boolean时，按数值排序指定匹配范围。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.between("AGE", 10, 50);
```

### notBetween^23+^

notBetween(field: string, low: ValueType, high: ValueType): DataSharePredicates

该接口用于配置谓词以匹配值超出指定范围的字段。不包含两端边界值，为左开右开区间。

目前仅关系型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**参数：**

|参数名|类型|必填|说明|
|:----|:-----------------------------------------------------------------------------------------------------------------|:-|:-----------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|low|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示与谓词匹配的最小值。 low为number时，按数值排序指定匹配范围。 low为string时，按字典序排序指定匹配范围。 low为boolean时，按数值排序指定匹配范围。|
|high|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示与谓词匹配的最大值。 high为number时，按数值排序指定匹配范围。 high为string时，按字典序排序指定匹配范围。 high为boolean时，按数值排序指定匹配范围。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.notBetween("AGE", 10, 50);
```

### greaterThan^23+^

greaterThan(field: string, value: ValueType): DataSharePredicates

该接口用于配置谓词以匹配值大于指定值的字段。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**参数：**

|参数名|类型|必填|说明|
|:----|:-----------------------------------------------------------------------------------------------------------------|:-|:-----------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|value|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示要与谓词匹配的值。 value为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.greaterThan("AGE", 10);
```

### lessThan^23+^

lessThan(field: string, value: ValueType): DataSharePredicates

该接口用于配置谓词以匹配值小于指定值的字段。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**参数：**

|参数名|类型|必填|说明|
|:----|:-----------------------------------------------------------------------------------------------------------------|:-|:------------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 当field为null或undefined时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|value|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示要与谓词匹配的值。 value为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.lessThan("AGE", 50);
```

### greaterThanOrEqualTo^23+^

greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates

该接口用于配置谓词以匹配值大于或等于指定值的字段。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**参数：**

|参数名|类型|必填|说明|
|:----|:-----------------------------------------------------------------------------------------------------------------|:-|:-----------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|value|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示要与谓词匹配的值。 value为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.greaterThanOrEqualTo("AGE", 10);
```

### lessThanOrEqualTo^23+^

lessThanOrEqualTo(field: string, value: ValueType): DataSharePredicates

该接口用于配置谓词以匹配值小于或等于指定值的字段。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**参数：**

|参数名|类型|必填|说明|
|:----|:-----------------------------------------------------------------------------------------------------------------|:-|:-----------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|value|[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)|是|指示要与谓词匹配的值。 value为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.lessThanOrEqualTo("AGE", 50);
```

### notIn^23+^

notIn(field: string, value: Array<ValueType>): DataSharePredicates

该接口用于配置谓词以匹配值不在指定范围内的字段。

目前仅关系型数据库及键值型数据库支持该谓词。

**系统能力：** SystemCapability.DistributedDataManager.DataShare.Core

**参数：**

|参数名|类型|必填|说明|
|:----|:------------------------------------------------------------------------------------------------------------------------|:-|:-----------------------------------------------------------------------------------------------------------------|
|field|string|是|数据库表中的列名。 field为undefined或null时，此次调用接口配置的谓词无效。 当field为字符串'null'或'undefined'时，键值型数据库和关系型数据库接口使用该谓词时，可能匹配结果非预期或抛出异常。|
|value|Array<[ValueType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-data-valuesbucket#valuetype)>|是|以ValueType型数组形式指定的要匹配的值。 value为undefined或null时，此次调用接口配置的谓词无效。|

**返回值：**

|类型|说明|
|:------------------------------------------|:------------|
|[DataSharePredicates](#datasharepredicates)|返回与指定字段匹配的谓词。|

**示例：**

```ts
let predicates = new dataSharePredicates.DataSharePredicates();
predicates.notIn("NAME", ["Lisa", "Rose"]);
```