提交 d7a3fc1d 编写于 作者: G ge-yafang

update docs

Signed-off-by: Nge-yafang <geyafang@huawei.com>
上级 453e6f4d
......@@ -6,8 +6,8 @@
## 导入模块
```
import dataAbility from '@ohos.data.dataAbility'
```js
import dataAbility from '@ohos.data.dataAbility';
```
......@@ -24,8 +24,8 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates):
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库表中表名。 |
| dataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | 是 | dataAbility谓词。 |
| name | string | 是 | 数据库表中表名。 |
| dataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | 是 | DataAbility谓词。 |
- 返回值:
| 类型 | 说明 |
......@@ -33,7 +33,7 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates):
| rdb.[RdbPredicates](js-apis-data-rdb.md#rdbpredicates) | 返回RdbPredicates对象。 |
- 示例:
```
```js
let dataAbilityPredicates = new dataAbility.DataAbilityPredicates()
dataAbilityPredicates.equalTo("NAME", "Rose").between("AGE", 16, 30)
let predicates = dataAbility.createRdbPredicates("EMPLOYEE", dataAbilityPredicates)
......@@ -59,7 +59,7 @@ equalTo(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值:
| 类型 | 说明 |
......@@ -67,7 +67,7 @@ equalTo(field: string, value: ValueType): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
```
......@@ -87,7 +87,7 @@ notEqualTo(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值:
| 类型 | 说明 |
......@@ -95,7 +95,7 @@ notEqualTo(field: string, value: ValueType): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.notEqualTo("NAME", "lisi")
```
......@@ -117,7 +117,7 @@ beginWrap(): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有左括号的DataAbility谓词。 |
- 示例:
```
```js
let predicates = new dataAbilitylity.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
.beginWrap()
......@@ -144,7 +144,7 @@ endWrap(): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有右括号的DataAbility谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
.beginWrap()
......@@ -171,7 +171,7 @@ or(): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有或条件的DataAbility谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
.or()
......@@ -185,7 +185,7 @@ or(): DataAbilityPredicates
and(): DataAbilityPredicates
向谓词添加和条件
将和条件添加到谓词中
**系统能力**:SystemCapability.DistributedDataManager.DataShare.Core。
......@@ -195,7 +195,7 @@ and(): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有和条件的DataAbility谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
.and()
......@@ -209,7 +209,7 @@ and(): DataAbilityPredicates
contains(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为String且value包含指定值的字段。
配置谓词以匹配数据类型为string且value包含指定值的字段。
**系统能力**:SystemCapability.DistributedDataManager.DataShare.Core。
......@@ -225,7 +225,7 @@ contains(field: string, value: string): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.contains("NAME", "os")
```
......@@ -237,7 +237,7 @@ contains(field: string, value: string): DataAbilityPredicates
beginsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为String且值以指定字符串开头的字段。
配置谓词以匹配数据类型为string且值以指定字符串开头的字段。
**系统能力**:SystemCapability.DistributedDataManager.DataShare.Core。
......@@ -253,7 +253,7 @@ beginsWith(field: string, value: string): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.beginsWith("NAME", "os")
```
......@@ -265,7 +265,7 @@ beginsWith(field: string, value: string): DataAbilityPredicates
endsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为String且值以指定字符串结尾的字段。
配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。
**系统能力**:SystemCapability.DistributedDataManager.DataShare.Core。
......@@ -308,7 +308,7 @@ isNull(field: string): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.isNull("NAME")
```
......@@ -335,7 +335,7 @@ isNotNull(field: string): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.isNotNull("NAME")
```
......@@ -363,7 +363,7 @@ like(field: string, value: string): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.like("NAME", "%os%")
```
......@@ -375,7 +375,7 @@ like(field: string, value: string): DataAbilityPredicates
glob(field: string, value: string): DataAbilityPredicates
配置谓词匹配数据类型为string的指定字段。
配置谓词匹配数据类型为string的指定字段。
**系统能力**:SystemCapability.DistributedDataManager.DataShare.Core。
......@@ -391,7 +391,7 @@ glob(field: string, value: string): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.glob("NAME", "?h*g")
```
......@@ -403,7 +403,7 @@ glob(field: string, value: string): DataAbilityPredicates
between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
将谓词配置为匹配数据类型为ValueType且value在指定范围内的指定字段。
配置谓词以匹配数据类型为ValueType且value在指定范围内的指定字段。
**系统能力**:SystemCapability.DistributedDataManager.DataShare.Core。
......@@ -411,8 +411,8 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| low | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示与谓词匹配的最大值。 |
| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 |
- 返回值:
| 类型 | 说明 |
......@@ -420,7 +420,7 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.between("AGE", 10, 50)
```
......@@ -440,8 +440,8 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| low | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示与谓词匹配的最大值。 |
| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 |
- 返回值:
| 类型 | 说明 |
......@@ -449,7 +449,7 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.notBetween("AGE", 10, 50)
```
......@@ -469,7 +469,7 @@ greaterThan(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值:
| 类型 | 说明 |
......@@ -477,7 +477,7 @@ greaterThan(field: string, value: ValueType): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.greaterThan("AGE", 18)
```
......@@ -497,7 +497,7 @@ lessThan(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值:
| 类型 | 说明 |
......@@ -505,7 +505,7 @@ lessThan(field: string, value: ValueType): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.lessThan("AGE", 20)
```
......@@ -525,7 +525,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值:
| 类型 | 说明 |
......@@ -533,7 +533,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.greaterThanOrEqualTo("AGE", 18)
```
......@@ -553,7 +553,7 @@ lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值:
| 类型 | 说明 |
......@@ -561,7 +561,7 @@ lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.lessThanOrEqualTo("AGE", 20)
```
......@@ -588,7 +588,7 @@ orderByAsc(field: string): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.orderByAsc("NAME")
```
......@@ -615,7 +615,7 @@ orderByDesc(field: string): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.orderByDesc("AGE")
```
......@@ -637,7 +637,7 @@ distinct(): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于过滤重复记录的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").distinct("NAME")
let promiseDistinct = rdbStore.query(predicates, ["NAME"])
......@@ -670,7 +670,7 @@ limitAs(value: number): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于设置最大数据记录数的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").limitAs(3)
```
......@@ -697,7 +697,7 @@ offsetAs(rowOffset: number): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定返回结果起始位置的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").offsetAs(3)
```
......@@ -724,7 +724,7 @@ groupBy(fields: Array&lt;string&gt;): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回分组查询列的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.groupBy(["AGE", "NAME"])
```
......@@ -749,7 +749,7 @@ indexedBy(field: string): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定索引列的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.indexedBy("SALARY_INDEX")
```
......@@ -769,7 +769,7 @@ in(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array&lt;[ValueType](js-apis-data-rdb.md#valuetype)&gt; | 是 | 以ValueType型数组形式指定的要匹配的值。 |
| value | Array&lt;[ValueType](#valuetype)&gt; | 是 | 以ValueType类型数组形式指定的要匹配的值。 |
- 返回值:
......@@ -778,7 +778,7 @@ in(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.in("AGE", [18, 20])
```
......@@ -798,7 +798,7 @@ notIn(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array&lt;[ValueType](js-apis-data-rdb.md#valuetype)&gt; | 是 | 以ValueType型数组形式指定的要匹配的值。 |
| value | Array&lt;[ValueType](#valuetype)&gt; | 是 | 以ValueType类型数组形式指定的要匹配的值。 |
- 返回值:
......@@ -807,8 +807,19 @@ notIn(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例:
```
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.notIn("NAME", ["Lisa", "Rose"])
```
## ValueType
用于表示允许的数据字段类型。
**系统能力**:SystemCapability.DistributedDataManager.DataShare.Core。
| 名称 | 说明 |
| ------- | -------------------- |
| number | 表示值类型为数字。 |
| string | 表示值类型为字符。 |
| boolean | 表示值类型为布尔值。 |
......@@ -7,7 +7,7 @@
## 导入模块
```js
import distributedObject from '@ohos.data.distributedDataObject'
import distributedObject from '@ohos.data.distributedDataObject';
```
......@@ -25,11 +25,11 @@ createDistributedObject(source: object): DistributedObject
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| source | object | 是 | 设置distributedObject的属性。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [DistributedObject](#distributedobject) | 创建好的分布式对象。 |
| 类型 | 说明 |
| -------- | -------- |
| [DistributedObject](#distributedobject) | 创建完成的分布式对象。 |
**示例:**
```js
......@@ -83,7 +83,7 @@ setSessionId(sessionId?: string): boolean
| 类型 | 说明 |
| -------- | -------- |
| boolean | true:标识设置sessionId成功; <br>false:标识设置sessionId失败。 |
**示例:**
```js
......@@ -171,8 +171,6 @@ on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, st
| type | string | 是 | 事件类型,固定为'status',表示对象上下线。 |
| callback | Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }> | 是 | 监听上下线回调实例。<br>sessionId:标识变更对象的sessionId; <br>networkId:标识对象设备的networkId; <br>status:标识对象为'online'(上线)或'offline'(下线)的状态。 |
**示例:**
```js
import distributedObject from '@ohos.data.distributedDataObject'
......
......@@ -8,7 +8,7 @@
需要通过[RdbStore.query()](js-apis-data-rdb.md#query)获取resultSet对象。
```
```js
import dataRdb from '@ohos.data.rdb';
let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("AGE", 18)
......@@ -18,10 +18,6 @@ promise.then((resultSet) => {
console.log(TAG + "resultSet columnCount:" + resultSet.columnCount);})
```
## ResultSet
提供通过查询数据库生成的数据库结果集的访问方法。
......@@ -63,7 +59,7 @@ getColumnIndex(columnName: string): number
| number | 返回指定列的索引。 |
- 示例:
```
```js
resultSet.goToFirstRow()
const id = resultSet.getLong(resultSet.getColumnIndex("ID"))
const name = resultSet.getString(resultSet.getColumnIndex("NAME"))
......@@ -91,7 +87,7 @@ getColumnName(columnIndex: number): string
| string | 返回指定列的名称。 |
- 示例:
```
```js
const id = resultSet.getColumnName(0)
const name = resultSet.getColumnName(1)
const age = resultSet.getColumnName(2)
......@@ -117,7 +113,7 @@ goTo(offset:number): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
- 示例:
```
```js
let predicatesgoto = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoto = rdbStore.query(predicatesgoto, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promisequerygoto.then((resultSet) {
......@@ -148,7 +144,7 @@ goToRow(position: number): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
- 示例:
```
```js
let predicatesgotorow = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygotorow = rdbStore.query(predicatesgotorow, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promisequerygotorow.then((resultSet) {
......@@ -175,7 +171,7 @@ goToFirstRow(): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
- 示例:
```
```js
let predicatesgoFirst = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoFirst = rdbStore.query(predicatesgoFirst, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promisequerygoFirst.then((resultSet) {
......@@ -201,7 +197,7 @@ goToLastRow(): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
- 示例:
```
```js
let predicatesgoLast = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoLast = rdbStore.query(predicatesgoLast, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promisequerygoLast.then((resultSet) {
......@@ -227,7 +223,7 @@ goToNextRow(): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
- 示例:
```
```js
let predicatesgoNext = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoNext = rdbStore.query(predicatesgoNext, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promisequerygoNext.then((resultSet) {
......@@ -253,7 +249,7 @@ goToPreviousRow(): boolean
| boolean | 如果成功移动结果集,则为true;否则返回false。 |
- 示例:
```
```js
let predicatesgoPrev = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoPrev = rdbStore.query(predicatesgoPrev, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promisequerygoPrev.then((resultSet) {
......@@ -284,7 +280,7 @@ getBlob(columnIndex: number): Uint8Array
| Uint8Array | 以字节数组的形式返回指定列的值。 |
- 示例:
```
```js
const codes = resultSet.getBlob(resultSet.getColumnIndex("CODES"))
```
......@@ -308,7 +304,7 @@ getString(columnIndex: number): string
| string | 以字符串形式返回指定列的值。 |
- 示例:
```
```js
const name = resultSet.getString(resultSet.getColumnIndex("NAME"))
```
......@@ -332,7 +328,7 @@ getLong(columnIndex: number): number
| number | 以Long形式返回指定列的值。 |
- 示例:
```
```js
const age = resultSet.getLong(resultSet.getColumnIndex("AGE"))
```
......@@ -356,7 +352,7 @@ getDouble(columnIndex: number): number
| number | 以double形式返回指定列的值。 |
- 示例:
```
```js
const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"))
```
......@@ -380,7 +376,7 @@ isColumnNull(columnIndex: number): boolean
| boolean | 如果当前行中指定列的值为null,则返回true,否则返回false。 |
- 示例:
```
```js
const isColumnNull = resultSet.isColumnNull(resultSet.getColumnIndex("CODES"))
```
......@@ -394,7 +390,7 @@ close(): void
**系统能力**:SystemCapability.DistributedDataManager.RelationalStore.Core。
- 示例:
```
```js
let predicatesclose = new dataRdb.RdbPredicates("EMPLOYEE")
let predicatesclose = rdbStore.query(predicatesclose, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promisequerygoPrev.then((resultSet) {
......@@ -403,3 +399,4 @@ close(): void
console.log('query failed')
})
```
......@@ -4,23 +4,24 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
import dataStorage from '@ohos.data.storage'
```js
import dataStorage from '@ohos.data.storage';
```
## 属性
## 常量
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制,大小为80字节。 |
| MAX_VALUE_LENGTH | string | 是 | 否 | string类型value的最大长度限制,大小为8192字节。 |
| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制,大小为8192字节。 |
## dataStorage.getStorageSync
......@@ -42,7 +43,7 @@ getStorageSync(path: string): Storage
| [Storage](#storage) | 获取到要操作的Storage实例,用于进行数据存储操作。 |
- 示例:
```
```js
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'
......@@ -75,7 +76,7 @@ getStorage(path: string, callback: AsyncCallback&lt;Storage&gt;): void
| callback | AsyncCallback&lt;[Storage](#storage)&gt; | 是 | 回调函数。 |
- 示例:
```
```js
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'
......@@ -117,7 +118,7 @@ getStorage(path: string): Promise&lt;Storage&gt;
| Promise&lt;[Storage](#storage)&gt; | Promise实例,用于异步获取结果。 |
- 示例:
```
```js
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'
......@@ -173,7 +174,7 @@ deleteStorage(path: string, callback: AsyncCallback&lt;void&gt;): void
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例:
```
```js
dataStorage.deleteStorage(path + '/mystore', function (err) {
if (err) {
console.info("Deleted failed with err: " + err)
......@@ -203,7 +204,7 @@ deleteStorage(path: string): Promise&lt;void&gt;
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。 |
- 示例:
```
```js
let promisedelSt = dataStorage.deleteStorage(path + '/mystore')
promisedelSt.then(() => {
console.info("Deleted successfully.")
......@@ -229,7 +230,7 @@ removeStorageFromCacheSync(path: string): void
| path | string | 是 | 应用程序内部数据存储路径。 |
- 示例:
```
```js
dataStorage.removeStorageFromCacheSync(path + '/mystore')
```
......@@ -251,7 +252,7 @@ removeStorageFromCache(path: string, callback: AsyncCallback&lt;void&gt;): void
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例:
```
```js
dataStorage.removeStorageFromCache(path + '/mystore', function (err) {
if (err) {
console.info("Removed storage from cache failed with err: " + err)
......@@ -283,7 +284,7 @@ removeStorageFromCache(path: string): Promise&lt;void&gt;
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。 |
- 示例:
```
```js
let promiserevSt = dataStorage.removeStorageFromCache(path + '/mystore')
promiserevSt.then(() => {
console.info("Removed storage from cache successfully.")
......@@ -311,8 +312,8 @@ getSync(key: string, defValue: ValueType): ValueType
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
| defValue | ValueType | 是 | 给定key的存储不存在,则要返回的默认值。支持number、string、boolean。 |
| key | string | 是 | 要获取的存储key名称不能为空。 |
| defValue | [ValueType](#valuetype) | 是 | 给定key的存储不存在,则要返回的默认值。支持number、string、boolean。 |
- 返回值:
| 类型 | 说明 |
......@@ -320,7 +321,7 @@ getSync(key: string, defValue: ValueType): ValueType
| ValueType | 键对应的值,如果值为null或者非默认值类型,返回默认数据。 |
- 示例:
```
```js
let value = storage.getSync('startup', 'default')
console.info("The value of startup is " + value)
```
......@@ -339,12 +340,12 @@ get(key: string, defValue: ValueType, callback: AsyncCallback&lt;ValueType&gt;):
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
| defValue | ValueType | 是 | 默认返回值。支持number、string、boolean。 |
| key | string | 是 | 要获取的存储key名称不能为空。 |
| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 |
| callback | AsyncCallback&lt;ValueType&gt; | 是 | 回调函数。 |
- 示例:
```
```js
storage.get('startup', 'default', function(err, value) {
if (err) {
console.info("Get the value of startup failed with err: " + err)
......@@ -368,8 +369,8 @@ get(key: string, defValue: ValueType): Promise&lt;ValueType&gt;
- **参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
| defValue | ValueType | 是 | 默认返回值。支持number、string、boolean。 |
| key | string | 是 | 要获取的存储key名称不能为空。 |
| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 |
- 返回值:
| 类型 | 说明 |
......@@ -377,7 +378,7 @@ get(key: string, defValue: ValueType): Promise&lt;ValueType&gt;
| Promise&lt;ValueType&gt; | Promise实例,用于异步获取结果。 |
- 示例:
```
```js
let promiseget = storage.get('startup', 'default')
promiseget.then((value) => {
console.info("The value of startup is " + value)
......@@ -400,11 +401,11 @@ putSync(key: string, value: ValueType): void
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key。它不能为空。 |
| value | ValueType | 是 | 存储的新值。支持number、string、boolean。 |
| key | string | 是 | 要修改的存储的key不能为空。 |
| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 |
- 示例:
```
```js
storage.putSync('startup', 'auto')
```
......@@ -422,12 +423,12 @@ put(key: string, value: ValueType, callback: AsyncCallback&lt;void&gt;): void
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key。它不能为空。 |
| value | ValueType | 是 | 存储的新值。支持number、string、boolean。 |
| key | string | 是 | 要修改的存储的key不能为空。 |
| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例:
```
```js
storage.put('startup', 'auto', function (err) {
if (err) {
console.info("Put the value of startup failed with err: " + err)
......@@ -451,8 +452,8 @@ put(key: string, value: ValueType): Promise&lt;void&gt;
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key。它不能为空。 |
| value | ValueType | 是 | 存储的新值。支持number、string、boolean。 |
| key | string | 是 | 要修改的存储的key不能为空。 |
| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 |
- 返回值:
| 类型 | 说明 |
......@@ -460,7 +461,7 @@ put(key: string, value: ValueType): Promise&lt;void&gt;
| Promise&lt;void&gt; | Promise实例,用于异步处理。 |
- 示例:
```
```js
let promiseput = storage.put('startup', 'auto')
promiseput.then(() => {
console.info("Put the value of startup successfully.")
......@@ -483,7 +484,7 @@ hasSync(key: string): boolean
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
| key | string | 是 | 要获取的存储key名称不能为空。 |
- 返回值:
| 类型 | 说明 |
......@@ -491,7 +492,7 @@ hasSync(key: string): boolean
| boolean | true&nbsp;表示存在,false表示不存在。 |
- 示例:
```
```js
let isExist = storage.hasSync('startup')
if (isExist) {
console.info("The key of startup is contained.")
......@@ -521,7 +522,7 @@ has(key: string, callback: AsyncCallback&lt;boolean&gt;): boolean
| boolean | true表示存在,false表示不存在。 |
- 示例:
```
```js
storage.has('startup', function (err, isExist) {
if (err) {
console.info("Check the key of startup failed with err: " + err)
......@@ -547,7 +548,7 @@ has(key: string): Promise&lt;boolean&gt;
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
| key | string | 是 | 要获取的存储key名称不能为空。 |
- 返回值:
| 类型 | 说明 |
......@@ -555,7 +556,7 @@ has(key: string): Promise&lt;boolean&gt;
| Promise&lt;boolean&gt; | Promise实例,用于异步处理。 |
- 示例:
```
```js
let promisehas = storage.has('startup')
promisehas.then((isExist) => {
if (isExist) {
......@@ -583,12 +584,12 @@ deleteSync(key: string): void
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
- 示例:
```
```js
storage.deleteSync('startup')
```
### delete
### deletej
delete(key: string, callback: AsyncCallback&lt;void&gt;): void
......@@ -605,7 +606,7 @@ delete(key: string, callback: AsyncCallback&lt;void&gt;): void
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例:
```
```js
storage.delete('startup', function (err) {
if (err) {
console.info("Delete startup key failed with err: " + err)
......@@ -637,7 +638,7 @@ delete(key: string): Promise&lt;void&gt;
| Promise&lt;void&gt; | Promise实例,用于异步处理。 |
- 示例:
```
```js
let promisedel = storage.delete('startup')
promisedel.then(() => {
console.info("Deleted startup key successfully.")
......@@ -658,7 +659,7 @@ flushSync(): void
**系统能力**:SystemCapability.DistributedDataManager.Preferences.Core
- 示例:
```
```js
storage.flushSync()
```
......@@ -679,7 +680,7 @@ flush(callback: AsyncCallback&lt;void&gt;): void
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例:
```
```js
storage.flush(function (err) {
if (err) {
console.info("Flush to file failed with err: " + err)
......@@ -706,7 +707,7 @@ flush(): Promise&lt;void&gt;
| Promise&lt;void&gt; | Promise实例,用于异步处理。 |
- 示例:
```
```js
let promiseflush = storage.flush()
promiseflush.then(() => {
console.info("Flushed to file successfully.")
......@@ -727,7 +728,7 @@ clearSync(): void
**系统能力**:SystemCapability.DistributedDataManager.Preferences.Core
- 示例:
```
```js
storage.clearSync()
```
......@@ -748,7 +749,7 @@ clear(callback: AsyncCallback&lt;void&gt;): void
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例:
```
```js
storage.clear(function (err) {
if (err) {
console.info("Clear to file failed with err: " + err)
......@@ -775,7 +776,7 @@ clear(): Promise&lt;void&gt;
| Promise&lt;void&gt; | Promise实例,用于异步处理。 |
- 示例:
```
```js
let promiseclear = storage.clear()
promiseclear.then(() => {
console.info("Cleared to file successfully.")
......@@ -800,7 +801,7 @@ on(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
| callback | Callback&lt;[StorageObserver](#storageobserver)&gt; | 回调对象实例。 |
- 示例:
```
```js
var observer = function (key) {
console.info("The key of " + key + " changed.")
}
......@@ -825,7 +826,7 @@ off(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
| callback | Callback&lt;[StorageObserver](#storageobserver)&gt; | 需要取消的回调对象实例。 |
- 示例:
```
```js
var observer = function (key) {
console.info("The key of " + key + " changed.")
}
......@@ -840,3 +841,15 @@ off(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 否 | 变更的数据内容。 |
## ValueType
用于表示允许的数据字段类型。
**系统能力**:SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 说明 |
| ------- | -------------------- |
| number | 表示值类型为数字。 |
| string | 表示值类型为字符。 |
| boolean | 表示值类型为布尔值。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册