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

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

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

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

• 用于在媒体文件管理服务作为检索条件使用，参考相册管理模块检索条件。此种场景下，开发者无需关注数据库类型。

• 用于调用关系型数据库和键值型数据库系统接口时的检索条件使用。此种场景下，开发者根据使用的数据库类型参考对应的谓词使用方法。

说明：

• 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

• 本模块接口仅可在Stage模型下使用。

导入模块

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

DataSharePredicates

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

equalTo¹⁰⁺

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

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

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

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

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

参数：

返回值：

示例：

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

and¹⁰⁺

and(): DataSharePredicates

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

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

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

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

返回值：

示例：

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开始，该接口支持在原子化服务中使用。

参数：

返回值：

示例：

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

orderByDesc¹⁰⁺

orderByDesc(field: string): DataSharePredicates

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

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

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

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

参数：

返回值：

示例：

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

limit¹⁰⁺

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

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

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

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

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

参数：

返回值：

示例：

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开始，该接口支持在原子化服务中使用。

参数：

返回值：

示例：

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