未验证 提交 95426e25 编写于 作者: 葛亚芳 提交者: Gitee

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

Signed-off-by: N葛亚芳 <geyafang@huawei.com>
上级 677b39db
...@@ -13,13 +13,10 @@ DataAbility 谓词用于构造关系型数据库的谓词,提供用于实现 ...@@ -13,13 +13,10 @@ DataAbility 谓词用于构造关系型数据库的谓词,提供用于实现
import dataAbility from '@ohos.data.dataAbility'; import dataAbility from '@ohos.data.dataAbility';
``` ```
## dataAbility.createRdbPredicates ## dataAbility.createRdbPredicates
createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): rdb.RdbPredicates createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): rdb.RdbPredicates
从DataAbilityPredicates对象创建RdbPredicates对象。 从DataAbilityPredicates对象创建RdbPredicates对象。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
...@@ -32,93 +29,93 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): ...@@ -32,93 +29,93 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates):
| dataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | 是 | DataAbility谓词。 | | dataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | 是 | DataAbility谓词。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| rdb.[RdbPredicates](js-apis-data-rdb.md#rdbpredicates) | 返回RdbPredicates对象。 | | rdb.[RdbPredicates](js-apis-data-rdb.md#rdbpredicates) | 返回RdbPredicates对象。 |
**示例:** **示例:**
```js ```js
let dataAbilityPredicates = new dataAbility.DataAbilityPredicates() let dataAbilityPredicates = new dataAbility.DataAbilityPredicates()
dataAbilityPredicates.equalTo("NAME", "Rose").between("AGE", 16, 30) dataAbilityPredicates.equalTo("NAME", "Rose")
let predicates = dataAbility.createRdbPredicates("EMPLOYEE", dataAbilityPredicates) let predicates = dataAbility.createRdbPredicates("EMPLOYEE", dataAbilityPredicates)
``` ```
## DataAbilityPredicates ## DataAbilityPredicates
提供用于实现不同查询方法的谓词。 提供用于实现不同查询方法的谓词。
### equalTo ### equalTo
equalTo(field: string, value: ValueType): DataAbilityPredicates equalTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值等于指定值的字段。 配置谓词以匹配数据类型为ValueType且值等于指定值的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.equalTo("NAME", "lisi") dataAbilityPredicates.equalTo("NAME", "lisi")
``` ```
### notEqualTo ### notEqualTo
notEqualTo(field: string, value: ValueType): DataAbilityPredicates notEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。 配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.notEqualTo("NAME", "lisi") dataAbilityPredicates.notEqualTo("NAME", "lisi")
``` ```
### beginWrap ### beginWrap
beginWrap(): DataAbilityPredicates beginWrap(): DataAbilityPredicates
向谓词添加左括号。 向谓词添加左括号。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有左括号的DataAbility谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有左括号的DataAbility谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.equalTo("NAME", "lisi") dataAbilityPredicates.equalTo("NAME", "lisi")
.beginWrap() .beginWrap()
...@@ -128,23 +125,22 @@ beginWrap(): DataAbilityPredicates ...@@ -128,23 +125,22 @@ beginWrap(): DataAbilityPredicates
.endWrap() .endWrap()
``` ```
### endWrap ### endWrap
endWrap(): DataAbilityPredicates endWrap(): DataAbilityPredicates
向谓词添加右括号。 向谓词添加右括号。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有右括号的DataAbility谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有右括号的DataAbility谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.equalTo("NAME", "lisi") dataAbilityPredicates.equalTo("NAME", "lisi")
.beginWrap() .beginWrap()
...@@ -154,251 +150,247 @@ endWrap(): DataAbilityPredicates ...@@ -154,251 +150,247 @@ endWrap(): DataAbilityPredicates
.endWrap() .endWrap()
``` ```
### or ### or
or(): DataAbilityPredicates or(): DataAbilityPredicates
将或条件添加到谓词中。 将或条件添加到谓词中。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有或条件的DataAbility谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有或条件的DataAbility谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.equalTo("NAME", "Lisa") dataAbilityPredicates.equalTo("NAME", "Lisa")
.or() .or()
.equalTo("NAME", "Rose") .equalTo("NAME", "Rose")
``` ```
### and ### and
and(): DataAbilityPredicates and(): DataAbilityPredicates
将和条件添加到谓词中。 将和条件添加到谓词中。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有和条件的DataAbility谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有和条件的DataAbility谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.equalTo("NAME", "Lisa") dataAbilityPredicates.equalTo("NAME", "Lisa")
.and() .and()
.equalTo("SALARY", 200.5) .equalTo("SALARY", 200.5)
``` ```
### contains ### contains
contains(field: string, value: string): DataAbilityPredicates contains(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且value包含指定值的字段。 配置谓词以匹配数据类型为string且value包含指定值的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 | | value | string | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.contains("NAME", "os") dataAbilityPredicates.contains("NAME", "os")
``` ```
### beginsWith ### beginsWith
beginsWith(field: string, value: string): DataAbilityPredicates beginsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值以指定字符串开头的字段。 配置谓词以匹配数据类型为string且值以指定字符串开头的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 | | value | string | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.beginsWith("NAME", "os") dataAbilityPredicates.beginsWith("NAME", "os")
``` ```
### endsWith ### endsWith
endsWith(field: string, value: string): DataAbilityPredicates endsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。 配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 | | value | string | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
``` ```
dataAbilityPredicates.endsWith("NAME", "se") dataAbilityPredicates.endsWith("NAME", "se")
``` ```
### isNull ### isNull
isNull(field: string): DataAbilityPredicates isNull(field: string): DataAbilityPredicates
配置谓词以匹配值为null的字段。 配置谓词以匹配值为null的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.isNull("NAME") dataAbilityPredicates.isNull("NAME")
``` ```
### isNotNull ### isNotNull
isNotNull(field: string): DataAbilityPredicates isNotNull(field: string): DataAbilityPredicates
配置谓词以匹配值不为null的指定字段。 配置谓词以匹配值不为null的指定字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.isNotNull("NAME") dataAbilityPredicates.isNotNull("NAME")
``` ```
### like ### like
like(field: string, value: string): DataAbilityPredicates like(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值类似于指定字符串的字段。 配置谓词以匹配数据类型为string且值类似于指定字符串的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 | | value | string | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.like("NAME", "%os%") dataAbilityPredicates.like("NAME", "%os%")
``` ```
### glob ### glob
glob(field: string, value: string): DataAbilityPredicates glob(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string的指定字段。 配置谓词以匹配数据类型为string的指定字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 | | value | string | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.glob("NAME", "?h*g") dataAbilityPredicates.glob("NAME", "?h*g")
``` ```
### between ### between
between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value在指定范围内的指定字段。 配置谓词以匹配数据类型为ValueType且value在指定范围内的指定字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -406,27 +398,27 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates ...@@ -406,27 +398,27 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
| high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 | | high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.between("AGE", 10, 50) dataAbilityPredicates.between("AGE", 10, 50)
``` ```
### notBetween ### notBetween
notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicates notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。 配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -434,244 +426,245 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate ...@@ -434,244 +426,245 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate
| high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 | | high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.notBetween("AGE", 10, 50) dataAbilityPredicates.notBetween("AGE", 10, 50)
``` ```
### greaterThan ### greaterThan
greaterThan(field: string, value: ValueType): DataAbilityPredicates greaterThan(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值大于指定值的字段。 配置谓词以匹配数据类型为ValueType且值大于指定值的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.greaterThan("AGE", 18) dataAbilityPredicates.greaterThan("AGE", 18)
``` ```
### lessThan ### lessThan
lessThan(field: string, value: ValueType): DataAbilityPredicates lessThan(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为valueType且value小于指定值的字段。 配置谓词以匹配数据类型为valueType且value小于指定值的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.lessThan("AGE", 20) dataAbilityPredicates.lessThan("AGE", 20)
``` ```
### greaterThanOrEqualTo ### greaterThanOrEqualTo
greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。 配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.greaterThanOrEqualTo("AGE", 18) dataAbilityPredicates.greaterThanOrEqualTo("AGE", 18)
``` ```
### lessThanOrEqualTo ### lessThanOrEqualTo
lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。 配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.lessThanOrEqualTo("AGE", 20) dataAbilityPredicates.lessThanOrEqualTo("AGE", 20)
``` ```
### orderByAsc ### orderByAsc
orderByAsc(field: string): DataAbilityPredicates orderByAsc(field: string): DataAbilityPredicates
配置谓词以匹配其值按升序排序的列。 配置谓词以匹配其值按升序排序的列。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.orderByAsc("NAME") dataAbilityPredicates.orderByAsc("NAME")
``` ```
### orderByDesc ### orderByDesc
orderByDesc(field: string): DataAbilityPredicates orderByDesc(field: string): DataAbilityPredicates
配置谓词以匹配其值按降序排序的列。 配置谓词以匹配其值按降序排序的列。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.orderByDesc("AGE") dataAbilityPredicates.orderByDesc("AGE")
``` ```
### distinct ### distinct
distinct(): DataAbilityPredicates distinct(): DataAbilityPredicates
配置谓词以过滤重复记录并仅保留其中一个。 配置谓词以过滤重复记录并仅保留其中一个。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于过滤重复记录的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于过滤重复记录的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.equalTo("NAME", "Rose").distinct() dataAbilityPredicates.equalTo("NAME", "Rose").distinct()
``` ```
### limitAs ### limitAs
limitAs(value: number): DataAbilityPredicates limitAs(value: number): DataAbilityPredicates
设置最大数据记录数的谓词。 设置最大数据记录数的谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | number | 是 | 最大数据记录数。 | | value | number | 是 | 最大数据记录数。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于设置最大数据记录数的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于设置最大数据记录数的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.equalTo("NAME", "Rose").limitAs(3) dataAbilityPredicates.equalTo("NAME", "Rose").limitAs(3)
``` ```
### offsetAs ### offsetAs
offsetAs(rowOffset: number): DataAbilityPredicates offsetAs(rowOffset: number): DataAbilityPredicates
配置谓词以指定返回结果的起始位置。 配置谓词以指定返回结果的起始位置。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rowOffset | number | 是 | 返回结果的起始位置,取值为正整数。 | | rowOffset | number | 是 | 返回结果的起始位置,取值为正整数。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定返回结果起始位置的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定返回结果起始位置的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.equalTo("NAME", "Rose").offsetAs(3) dataAbilityPredicates.equalTo("NAME", "Rose").offsetAs(3)
``` ```
...@@ -679,66 +672,66 @@ offsetAs(rowOffset: number): DataAbilityPredicates ...@@ -679,66 +672,66 @@ offsetAs(rowOffset: number): DataAbilityPredicates
### groupBy ### groupBy
groupBy(fields: Array&lt;string&gt;): DataAbilityPredicates groupBy(fields: Array&lt;string&gt;): DataAbilityPredicates
配置谓词按指定列分组查询结果。 配置谓词按指定列分组查询结果。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| fields | Array&lt;string&gt; | 是 | 指定分组依赖的列名。 | | fields | Array&lt;string&gt; | 是 | 指定分组依赖的列名。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回分组查询列的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回分组查询列的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.groupBy(["AGE", "NAME"]) dataAbilityPredicates.groupBy(["AGE", "NAME"])
``` ```
### indexedBy ### indexedBy
indexedBy(field: string): DataAbilityPredicates indexedBy(field: string): DataAbilityPredicates
配置谓词以指定索引列。 配置谓词以指定索引列。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| indexName | string | 是 | 索引列的名称。 | | indexName | string | 是 | 索引列的名称。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定索引列的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定索引列的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.indexedBy("SALARY_INDEX") dataAbilityPredicates.indexedBy("SALARY_INDEX")
``` ```
### in ### in
in(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates in(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。 配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -746,39 +739,40 @@ in(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates ...@@ -746,39 +739,40 @@ in(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.in("AGE", [18, 20]) dataAbilityPredicates.in("AGE", [18, 20])
``` ```
### notIn ### notIn
notIn(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates notIn(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。 配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。 **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
| value | Array&lt;[ValueType](#valuetype)&gt; | 是 | 以ValueType类型数组形式指定的要匹配的值。 | | value | Array&lt;[ValueType](#valuetype)&gt; | 是 | 以ValueType类型数组形式指定的要匹配的值。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
**示例:** **示例:**
```js ```js
dataAbilityPredicates.notIn("NAME", ["Lisa", "Rose"]) dataAbilityPredicates.notIn("NAME", ["Lisa", "Rose"])
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册