Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
95426e25
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
95426e25
编写于
9月 09, 2022
作者:
葛
葛亚芳
提交者:
Gitee
9月 09, 2022
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update zh-cn/application-dev/reference/apis/js-apis-data-ability.md.
Signed-off-by:
N
葛亚芳
<
geyafang@huawei.com
>
上级
677b39db
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
82 addition
and
88 deletion
+82
-88
zh-cn/application-dev/reference/apis/js-apis-data-ability.md
zh-cn/application-dev/reference/apis/js-apis-data-ability.md
+82
-88
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-data-ability.md
浏览文件 @
95426e25
...
...
@@ -13,13 +13,10 @@ DataAbility 谓词用于构造关系型数据库的谓词,提供用于实现
import
dataAbility
from
'
@ohos.data.dataAbility
'
;
```
## dataAbility.createRdbPredicates
createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): rdb.RdbPredicates
从DataAbilityPredicates对象创建RdbPredicates对象。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
...
...
@@ -32,93 +29,93 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates):
| dataAbilityPredicates |
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 是 | DataAbility谓词。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| rdb.
[
RdbPredicates
](
js-apis-data-rdb.md#rdbpredicates
)
| 返回RdbPredicates对象。 |
**示例:**
```
js
let
dataAbilityPredicates
=
new
dataAbility
.
DataAbilityPredicates
()
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
Rose
"
)
.
between
(
"
AGE
"
,
16
,
30
)
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
Rose
"
)
let
predicates
=
dataAbility
.
createRdbPredicates
(
"
EMPLOYEE
"
,
dataAbilityPredicates
)
```
## DataAbilityPredicates
提供用于实现不同查询方法的谓词。
### equalTo
equalTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值等于指定值的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
lisi
"
)
```
### notEqualTo
notEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
notEqualTo
(
"
NAME
"
,
"
lisi
"
)
```
### beginWrap
beginWrap(): DataAbilityPredicates
向谓词添加左括号。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回带有左括号的DataAbility谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
lisi
"
)
.
beginWrap
()
...
...
@@ -128,23 +125,22 @@ beginWrap(): DataAbilityPredicates
.
endWrap
()
```
### endWrap
endWrap(): DataAbilityPredicates
向谓词添加右括号。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回带有右括号的DataAbility谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
lisi
"
)
.
beginWrap
()
...
...
@@ -154,251 +150,247 @@ endWrap(): DataAbilityPredicates
.
endWrap
()
```
### or
or(): DataAbilityPredicates
将或条件添加到谓词中。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回带有或条件的DataAbility谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
Lisa
"
)
.
or
()
.
equalTo
(
"
NAME
"
,
"
Rose
"
)
```
### and
and(): DataAbilityPredicates
将和条件添加到谓词中。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回带有和条件的DataAbility谓词。 |
**示例:**
```
js
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
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
contains
(
"
NAME
"
,
"
os
"
)
```
### beginsWith
beginsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值以指定字符串开头的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
beginsWith
(
"
NAME
"
,
"
os
"
)
```
### endsWith
endsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
dataAbilityPredicates.endsWith("NAME", "se")
```
### isNull
isNull(field: string): DataAbilityPredicates
配置谓词以匹配值为null的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
isNull
(
"
NAME
"
)
```
### isNotNull
isNotNull(field: string): DataAbilityPredicates
配置谓词以匹配值不为null的指定字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
isNotNull
(
"
NAME
"
)
```
### like
like(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值类似于指定字符串的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
like
(
"
NAME
"
,
"
%os%
"
)
```
### glob
glob(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string的指定字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
glob
(
"
NAME
"
,
"
?h*g
"
)
```
### between
between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value在指定范围内的指定字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
...
...
@@ -406,27 +398,27 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
| high |
[
ValueType
](
#valuetype
)
| 是 | 指示与谓词匹配的最大值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
between
(
"
AGE
"
,
10
,
50
)
```
### notBetween
notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
...
...
@@ -434,244 +426,245 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate
| high |
[
ValueType
](
#valuetype
)
| 是 | 指示与谓词匹配的最大值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
notBetween
(
"
AGE
"
,
10
,
50
)
```
### greaterThan
greaterThan(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值大于指定值的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
greaterThan
(
"
AGE
"
,
18
)
```
### lessThan
lessThan(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为valueType且value小于指定值的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
lessThan
(
"
AGE
"
,
20
)
```
### greaterThanOrEqualTo
greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
greaterThanOrEqualTo
(
"
AGE
"
,
18
)
```
### lessThanOrEqualTo
lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value |
[
ValueType
](
#valuetype
)
| 是 | 指示要与谓词匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
lessThanOrEqualTo
(
"
AGE
"
,
20
)
```
### orderByAsc
orderByAsc(field: string): DataAbilityPredicates
配置谓词以匹配其值按升序排序的列。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
orderByAsc
(
"
NAME
"
)
```
### orderByDesc
orderByDesc(field: string): DataAbilityPredicates
配置谓词以匹配其值按降序排序的列。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
orderByDesc
(
"
AGE
"
)
```
### distinct
distinct(): DataAbilityPredicates
配置谓词以过滤重复记录并仅保留其中一个。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回可用于过滤重复记录的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
Rose
"
).
distinct
()
```
### limitAs
limitAs(value: number): DataAbilityPredicates
设置最大数据记录数的谓词。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | number | 是 | 最大数据记录数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回可用于设置最大数据记录数的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
Rose
"
).
limitAs
(
3
)
```
### offsetAs
offsetAs(rowOffset: number): DataAbilityPredicates
配置谓词以指定返回结果的起始位置。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| rowOffset | number | 是 | 返回结果的起始位置,取值为正整数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回具有指定返回结果起始位置的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
equalTo
(
"
NAME
"
,
"
Rose
"
).
offsetAs
(
3
)
```
...
...
@@ -679,66 +672,66 @@ offsetAs(rowOffset: number): DataAbilityPredicates
### groupBy
groupBy(fields: Array
<
string
>
): DataAbilityPredicates
配置谓词按指定列分组查询结果。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| fields | Array
<
string
>
| 是 | 指定分组依赖的列名。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回分组查询列的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
groupBy
([
"
AGE
"
,
"
NAME
"
])
```
### indexedBy
indexedBy(field: string): DataAbilityPredicates
配置谓词以指定索引列。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| indexName | string | 是 | 索引列的名称。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回具有指定索引列的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
indexedBy
(
"
SALARY_INDEX
"
)
```
### in
in(field: string, value: Array
<
ValueType
>
): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
...
...
@@ -746,39 +739,40 @@ in(field: string, value: Array<ValueType>): DataAbilityPredicates
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
in
(
"
AGE
"
,
[
18
,
20
])
```
### notIn
notIn(field: string, value: Array
<
ValueType
>
): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。
**系统能力:**
SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array
<
[ValueType](#valuetype)
>
| 是 | 以ValueType类型数组形式指定的要匹配的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
DataAbilityPredicates
](
#dataabilitypredicates
)
| 返回与指定字段匹配的谓词。 |
**示例:**
```
js
dataAbilityPredicates
.
notIn
(
"
NAME
"
,
[
"
Lisa
"
,
"
Rose
"
])
```
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录