
HarmonyOSAPI:@ohos.data.dataAbility (DataAbility谓词)
版本:v3.1 Beta
@ohos.data.dataAbility (DataAbility谓词)
更新时间: 2023-02-17 09:19
DataAbility谓词用于构造关系型数据库的谓词,提供用于实现不同查询方法的谓词。
说明
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
dataAbility.createRdbPredicates
createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): rdb.RdbPredicates
从DataAbilityPredicates对象创建RdbPredicates对象。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 数据库表中的表名。 |
dataAbilityPredicates | 是 | DataAbility谓词。 |
返回值:
类型 | 说明 |
rdb.RdbPredicates | 返回RdbPredicates对象。 |
示例:
DataAbilityPredicates
提供用于实现不同查询方法的谓词。
equalTo
equalTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值等于指定值的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
notEqualTo
notEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
beginWrap
beginWrap(): DataAbilityPredicates
向谓词添加左括号。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
类型 | 说明 |
返回带有左括号的DataAbility谓词。 |
示例:
endWrap
endWrap(): DataAbilityPredicates
向谓词添加右括号。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
类型 | 说明 |
返回带有右括号的DataAbility谓词。 |
示例:
or
or(): DataAbilityPredicates
将或条件添加到谓词中。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
类型 | 说明 |
返回带有或条件的DataAbility谓词。 |
示例:
and
and(): DataAbilityPredicates
将和条件添加到谓词中。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
类型 | 说明 |
返回带有和条件的DataAbility谓词。 |
示例:
contains
contains(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且value包含指定值的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | string | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
beginsWith
beginsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值以指定字符串开头的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | string | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
endsWith
endsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | string | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
isNull
isNull(field: string): DataAbilityPredicates
配置谓词以匹配值为null的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
isNotNull
isNotNull(field: string): DataAbilityPredicates
配置谓词以匹配值不为null的指定字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
like
like(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值类似于指定字符串的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | string | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
glob
glob(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string的指定字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | string | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
between
between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value在指定范围内的指定字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
low | 是 | 指示与谓词匹配的最小值。 | |
high | 是 | 指示与谓词匹配的最大值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
notBetween
notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
low | 是 | 指示与谓词匹配的最小值。 | |
high | 是 | 指示与谓词匹配的最大值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
greaterThan
greaterThan(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值大于指定值的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
lessThan
lessThan(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为valueType且value小于指定值的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
greaterThanOrEqualTo
greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
lessThanOrEqualTo
lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | 是 | 指示要与谓词匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
orderByAsc
orderByAsc(field: string): DataAbilityPredicates
配置谓词以匹配其值按升序排序的列。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
orderByDesc
orderByDesc(field: string): DataAbilityPredicates
配置谓词以匹配其值按降序排序的列。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
distinct
distinct(): DataAbilityPredicates
配置谓词以过滤重复记录并仅保留其中一个。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
返回值:
类型 | 说明 |
返回可用于过滤重复记录的谓词。 |
示例:
limitAs
limitAs(value: number): DataAbilityPredicates
设置最大数据记录数的谓词。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
value | number | 是 | 最大数据记录数。 |
返回值:
类型 | 说明 |
返回可用于设置最大数据记录数的谓词。 |
示例:
offsetAs
offsetAs(rowOffset: number): DataAbilityPredicates
配置谓词以指定返回结果的起始位置。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
rowOffset | number | 是 | 返回结果的起始位置,取值为正整数。 |
返回值:
类型 | 说明 |
返回具有指定返回结果起始位置的谓词。 |
示例:
groupBy
groupBy(fields: Array<string>): DataAbilityPredicates
配置谓词按指定列分组查询结果。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
fields | Array<string> | 是 | 指定分组依赖的列名。 |
返回值:
类型 | 说明 |
返回分组查询列的谓词。 |
示例:
indexedBy
indexedBy(field: string): DataAbilityPredicates
配置谓词以指定索引列。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
indexName | string | 是 | 索引列的名称。 |
返回值:
类型 | 说明 |
返回具有指定索引列的谓词。 |
示例:
in
in(field: string, value: Array<ValueType>): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | Array<ValueType> | 是 | 以ValueType类型数组形式指定的要匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
notIn
notIn(field: string, value: Array<ValueType>): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
field | string | 是 | 数据库表中的列名。 |
value | Array<ValueType> | 是 | 以ValueType类型数组形式指定的要匹配的值。 |
返回值:
类型 | 说明 |
返回与指定字段匹配的谓词。 |
示例:
ValueType
用于表示允许的数据字段类型。
系统能力: SystemCapability.DistributedDataManager.DataShare.Core。
类型 | 说明 |
number | 表示值类型为数字。 |
string | 表示值类型为字符。 |
boolean | 表示值类型为布尔值。 |
