鸿蒙开发接口数据管理：【@ohos.data.dataAbility (DataAbility谓词)】

DataAbility 谓词

DataAbility 谓词用于构造关系型数据库的谓词，提供用于实现不同查询方法的谓词。

说明：
开发前请熟悉鸿蒙开发指导文档 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import dataAbility from '@ohos.data.dataAbility';

dataAbility.createRdbPredicates

createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): rdb.RdbPredicates

从DataAbilityPredicates对象创建RdbPredicates对象。

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

参数：

参数名	类型	必填	说明
name	string	是	数据库表中的表名。
dataAbilityPredicates	[DataAbilityPredicates]	是	DataAbility谓词。

返回值：

类型	说明
rdb.[RdbPredicates]	返回RdbPredicates对象。

示例：

let dataAbilityPredicates = new dataAbility.DataAbilityPredicates()
dataAbilityPredicates.equalTo("NAME", "Rose").between("AGE", 16, 30)
let predicates = dataAbility.createRdbPredicates("EMPLOYEE", dataAbilityPredicates)

DataAbilityPredicates

提供用于实现不同查询方法的谓词。

equalTo

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

配置谓词以匹配数据类型为ValueType且值等于指定值的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	[ValueType]	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.equalTo("NAME", "lisi")

notEqualTo

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

配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	[ValueType]	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.notEqualTo("NAME", "lisi")

beginWrap

beginWrap(): DataAbilityPredicates

向谓词添加左括号。

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

返回值：

类型	说明
[DataAbilityPredicates]	返回带有左括号的DataAbility谓词。

示例：

dataAbilityPredicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()

endWrap

endWrap(): DataAbilityPredicates

向谓词添加右括号。

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

返回值：

类型	说明
[DataAbilityPredicates]	返回带有右括号的DataAbility谓词。

示例：

dataAbilityPredicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()

or

or(): DataAbilityPredicates

将或条件添加到谓词中。

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

返回值：

类型	说明
[DataAbilityPredicates]	返回带有或条件的DataAbility谓词。

示例：

dataAbilityPredicates.equalTo("NAME", "Lisa")
    .or()
    .equalTo("NAME", "Rose")

and

and(): DataAbilityPredicates

将和条件添加到谓词中。

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

返回值：

类型	说明
[DataAbilityPredicates]	返回带有和条件的DataAbility谓词。

示例：

dataAbilityPredicates.equalTo("NAME", "Lisa")
    .and()
    .equalTo("SALARY", 200.5)

contains

contains(field: string, value: string): DataAbilityPredicates

配置谓词以匹配数据类型为string且value包含指定值的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	string	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.contains("NAME", "os")

beginsWith

beginsWith(field: string, value: string): DataAbilityPredicates

配置谓词以匹配数据类型为string且值以指定字符串开头的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	string	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.beginsWith("NAME", "os")

endsWith

endsWith(field: string, value: string): DataAbilityPredicates

配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	string	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.endsWith("NAME", "se")

isNull

isNull(field: string): DataAbilityPredicates

配置谓词以匹配值为null的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.isNull("NAME")

isNotNull

isNotNull(field: string): DataAbilityPredicates

配置谓词以匹配值不为null的指定字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.isNotNull("NAME")

like

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

配置谓词以匹配数据类型为string且值类似于指定字符串的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	string	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.like("NAME", "%os%")

glob

glob(field: string, value: string): DataAbilityPredicates

配置谓词以匹配数据类型为string的指定字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	string	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.glob("NAME", "?h*g")

between

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

配置谓词以匹配数据类型为ValueType且value在指定范围内的指定字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
low	[ValueType]	是	指示与谓词匹配的最小值。
high	[ValueType]	是	指示与谓词匹配的最大值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.between("AGE", 10, 50)

notBetween

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

配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
low	[ValueType]	是	指示与谓词匹配的最小值。
high	[ValueType]	是	指示与谓词匹配的最大值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.notBetween("AGE", 10, 50)

greaterThan

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

配置谓词以匹配数据类型为ValueType且值大于指定值的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	[ValueType]	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.greaterThan("AGE", 18)

lessThan

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

配置谓词以匹配数据类型为valueType且value小于指定值的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	[ValueType]	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.lessThan("AGE", 20)

greaterThanOrEqualTo

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

配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	[ValueType]	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.greaterThanOrEqualTo("AGE", 18)

lessThanOrEqualTo

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

配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	[ValueType]	是	指示要与谓词匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.lessThanOrEqualTo("AGE", 20)

orderByAsc

orderByAsc(field: string): DataAbilityPredicates

配置谓词以匹配其值按升序排序的列。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.orderByAsc("NAME")

orderByDesc

orderByDesc(field: string): DataAbilityPredicates

配置谓词以匹配其值按降序排序的列。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.orderByDesc("AGE")

distinct

distinct(): DataAbilityPredicates

配置谓词以过滤重复记录并仅保留其中一个。

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

返回值：

类型	说明
[DataAbilityPredicates]	返回可用于过滤重复记录的谓词。

示例：

dataAbilityPredicates.equalTo("NAME", "Rose").distinct()

limitAs

limitAs(value: number): DataAbilityPredicates

设置最大数据记录数的谓词。

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

参数：

参数名	类型	必填	说明
value	number	是	最大数据记录数。

返回值：

类型	说明
[DataAbilityPredicates]	返回可用于设置最大数据记录数的谓词。

示例：

dataAbilityPredicates.equalTo("NAME", "Rose").limitAs(3)

offsetAs

offsetAs(rowOffset: number): DataAbilityPredicates

配置谓词以指定返回结果的起始位置。

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

参数：

参数名	类型	必填	说明
rowOffset	number	是	返回结果的起始位置，取值为正整数。

返回值：

类型	说明
[DataAbilityPredicates]	返回具有指定返回结果起始位置的谓词。

示例：

dataAbilityPredicates.equalTo("NAME", "Rose").offsetAs(3)

groupBy

groupBy(fields: Array): DataAbilityPredicates

配置谓词按指定列分组查询结果。

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

参数：

参数名	类型	必填	说明
fields	Array	是	指定分组依赖的列名。

返回值：

类型	说明
[DataAbilityPredicates]	返回分组查询列的谓词。

示例：

dataAbilityPredicates.groupBy(["AGE", "NAME"])

indexedBy

indexedBy(field: string): DataAbilityPredicates

配置谓词以指定索引列。

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

参数：

参数名	类型	必填	说明
indexName	string	是	索引列的名称。

返回值：

类型	说明
[DataAbilityPredicates]	返回具有指定索引列的谓词。

示例：

dataAbilityPredicates.indexedBy("SALARY_INDEX")

in

in(field: string, value: Array): DataAbilityPredicates

配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	Array<[ValueType]>	是	以ValueType类型数组形式指定的要匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.in("AGE", [18, 20])

notIn

notIn(field: string, value: Array): DataAbilityPredicates

配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。

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

参数：

参数名	类型	必填	说明
field	string	是	数据库表中的列名。
value	Array<[ValueType]>	是	以ValueType类型数组形式指定的要匹配的值。

返回值：

类型	说明
[DataAbilityPredicates]	返回与指定字段匹配的谓词。

示例：

dataAbilityPredicates.notIn("NAME", ["Lisa", "Rose"])

ValueType

用于表示允许的数据字段类型。

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

名称	说明HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿
number	表示值类型为数字。
string	表示值类型为字符。
boolean	表示值类型为布尔值。

审核编辑 黄宇