diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md index c4b2c0992f59d61dcf5b0bdd03660834e79fd0e1..419030fc432b2c7cd35820bdf982a3f43e0de9a9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md @@ -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<string>): 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<ValueType>): DataAbilityPredicates | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | - | value | Array<[ValueType](js-apis-data-rdb.md#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 | + | value | Array<[ValueType](#valuetype)> | 是 | 以ValueType类型数组形式指定的要匹配的值。 | - 返回值： @@ -778,7 +778,7 @@ in(field: string, value: Array<ValueType>): DataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | - 示例： - ``` + ```js let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE") predicates.in("AGE", [18, 20]) ``` @@ -798,7 +798,7 @@ notIn(field: string, value: Array<ValueType>): DataAbilityPredicates | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | - | value | Array<[ValueType](js-apis-data-rdb.md#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 | + | value | Array<[ValueType](#valuetype)> | 是 | 以ValueType类型数组形式指定的要匹配的值。 | - 返回值： @@ -807,8 +807,19 @@ notIn(field: string, value: Array<ValueType>): DataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | - 示例： - ``` + ```js let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE") predicates.notIn("NAME", ["Lisa", "Rose"]) ``` +## ValueType + +用于表示允许的数据字段类型。 + +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 + +| 名称 | 说明 | +| ------- | -------------------- | +| number | 表示值类型为数字。 | +| string | 表示值类型为字符。 | +| boolean | 表示值类型为布尔值。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md b/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md index d58bd4d28df434a77775d14bf5acaccc82a442e8..2c3325a26d8bdd2b903086d616242e11467fd28d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md @@ -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成功；
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' }> | 是 | 监听上下线回调实例。
sessionId：标识变更对象的sessionId；
networkId：标识对象设备的networkId；
status：标识对象为'online'(上线)或'offline'(下线)的状态。 | - - **示例：** ```js import distributedObject from '@ohos.data.distributedDataObject' diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-preferences.md b/zh-cn/application-dev/reference/apis/js-apis-data-preferences.md index 187d51942adaa53d3b82d7818281b5f493157f27..ca1de5dcf99358aba8b28f1a206a563e7bda823b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-preferences.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-preferences.md @@ -10,18 +10,17 @@ ## 导入模块 ```ts -import data_preferences from '@ohos.data.preferences' +import data_preferences from '@ohos.data.preferences'; ``` -## 属性 +## 常量 **系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制，大小为80字节。 | -| MAX_VALUE_LENGTH | string | 是 | 否 | string类型value的最大长度限制，大小为8192字节。 | -| ValueType | number丨string丨boolean | 是 | 否 | 默认返回值，支持number、string、boolean。 | +| MAX_VALUE_LENGTH | string | 是 | 否 | value的最大长度限制，大小为8192字节。 | ## data_preferences.getPreferences @@ -45,7 +44,7 @@ getPreferences(context: Context, name: string, callback: AsyncCallback<Prefer import Ability from '@ohos.application.Ability' import data_preferences from '@ohos.data.preferences' export default class MainAbility extends Ability { - + data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) { if (err) { console.info("Get the preferences failed") @@ -94,7 +93,7 @@ getPreferences(context: Context, name: string): Promise<Preferences> import Ability from '@ohos.application.Ability' import data_preferences from '@ohos.data.preferences' export default class MainAbility extends Ability { - + let promise = data_preferences.getPreferences(this.context, 'mystore') promise.then((preferences) => { preferences.put('startup', 'auto', function (err) { @@ -139,7 +138,7 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi import Ability from '@ohos.application.Ability' import data_preferences from '@ohos.data.preferences' export default class MainAbility extends Ability { - + data_preferences.deletePreferences(this.context, 'mystore', function (err) { if (err) { console.info("Deleted failed, err: " + err) @@ -176,7 +175,7 @@ deletePreferences(context: Context, name: string): Promise<void> import Ability from '@ohos.application.Ability' import data_preferences from '@ohos.data.preferences' export default class MainAbility extends Ability { - + let promise = data_preferences.deletePreferences(this.context, 'mystore') promise.then(() => { console.info("Deleted successfully.") @@ -191,7 +190,9 @@ deletePreferences(context: Context, name: string): Promise<void> removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback<void>): void -从内存中移除指定首选项持久化文件对应的Preferences单实例。移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，该方法使用callback方式作为异步方法。 +从内存中移除指定首选项持久化文件对应的Preferences单实例。 + +移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，该方法使用callback方式作为异步方法。 **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core @@ -207,7 +208,7 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba import Ability from '@ohos.application.Ability' import data_preferences from '@ohos.data.preferences' export default class MainAbility extends Ability { - + data_preferences.removePreferencesFromCache(this.context, 'mystore', function (err) { if (err) { console.info("Removed preferences from cache failed, err: " + err) @@ -223,7 +224,9 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba removePreferencesFromCache(context: Context, name: string): Promise<void> -从内存中移除指定首选项持久化文件对应的Preferences单实例。移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，该方法使用Promise方式作为异步方法。 +从内存中移除指定首选项持久化文件对应的Preferences单实例。 + +移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，该方法使用Promise方式作为异步方法。 **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core @@ -243,7 +246,7 @@ removePreferencesFromCache(context: Context, name: string): Promise<void> import Ability from '@ohos.application.Ability' import data_preferences from '@ohos.data.preferences' export default class MainAbility extends Ability { - + let promise = data_preferences.removePreferencesFromCache(this.context, 'mystore') promise.then(() => { console.info("Removed preferences from cache successfully.") @@ -271,7 +274,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | key | string | 是 | 要获取的存储key名称，不能为空。 | - | defValue | [ValueType](#属性) | 是 | 默认返回值。支持number、string、boolean。 | + | defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 | | callback | AsyncCallback<ValueType> | 是 | 回调函数。 | - 示例： @@ -309,7 +312,7 @@ get(key: string, defValue: ValueType): Promise<ValueType> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | key | string | 是 | 要获取的存储key名称，不能为空。 | - | defValue | [ValueType](#属性) | 是 | 默认返回值。支持number、string、boolean。 | + | defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 | - 返回值： | 类型 | 说明 | @@ -349,7 +352,7 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | key | string | 是 | 要修改的存储的key，不能为空。 | - | value | [ValueType](#属性) | 是 | 存储的新值。支持number、string、boolean。 | + | value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | - 示例： @@ -387,7 +390,7 @@ put(key: string, value: ValueType): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | key | string | 是 | 要修改的存储的key，不能为空。 | - | value | [ValueType](#属性) | 是 | 存储的新值。支持number、string、boolean。 | + | value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | - 返回值： | 类型 | 说明 | @@ -484,7 +487,7 @@ has(key: string): Promise<boolean> import Ability from '@ohos.application.Ability' import data_preferences from '@ohos.data.preferences' export default class MainAbility extends Ability { - + let promise = data_preferences.getPreferences(this.context, 'mystore') promise.then((preferences) => { let promiseHas = preferences.has('startup') @@ -814,3 +817,15 @@ off(type: 'change', callback: Callback<{ key : string }>): void }) } ``` + +## ValueType + +用于表示允许的数据字段类型。 + +**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core + +| 名称 | 说明 | +| ------- | -------------------- | +| number | 表示值类型为数字。 | +| string | 表示值类型为字符。 | +| boolean | 表示值类型为布尔值。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md index 7cc705e0c15b771d3ac84b1ada795c843335f704..a7a80185e977caa68ab1c7549e8e5ebe3237416e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md @@ -7,8 +7,8 @@ ## 导入模块 -``` -import data_rdb from '@ohos.data.rdb' +```js +import data_rdb from '@ohos.data.rdb'; ``` @@ -21,16 +21,17 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | context8+ | Context | 是 | 应用程序或功能的上下文 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | version | number | 是 | 数据库版本。 | -| callback | AsyncCallback<[RdbStore](#rdbstore)> | 是 | 指定callback回调函数。返回一个RdbStore。 | +| callback | AsyncCallback<[RdbStore](#rdbstore)> | 是 | 指定callback回调函数，返回一个RdbStore。 | **示例**： -``` +```js import data_rdb from '@ohos.data.rdb' const STORE_CONFIG = { name: "RdbTest.db"} const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" @@ -40,9 +41,9 @@ data_rdb.getRdbStore(STORE_CONFIG, 1, function (err, rdbStore) { }) ``` -API9的示例请参考如下代码： +API 9的示例请参考如下代码： -``` +```ts import Ability from '@ohos.application.Ability' import data_rdb from '@ohos.data.rdb' export default class MainAbility extends Ability { @@ -79,7 +80,7 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise< **示例**： -``` +```js import data_rdb from '@ohos.data.rdb' const STORE_CONFIG = { name: "RdbTest.db" } const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" @@ -96,9 +97,9 @@ promisegetRdb.then(async (rdbStore) => { }) ``` -API9的示例请参考如下代码： +API 9的示例请参考如下代码： -``` +```ts import Ability from '@ohos.application.Ability' import data_rdb from '@ohos.data.rdb' export default class MainAbility extends Ability { @@ -134,16 +135,16 @@ deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void&g | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例**： - ``` + ```js import data_rdb from '@ohos.data.rdb' data_rdb.deleteRdbStore("RdbTest.db", function (err, rdbStore) { console.info('delete store done.') }) ``` -API9的示例请参考如下代码： +API 9的示例请参考如下代码： -``` +```ts import Ability from '@ohos.application.Ability' import data_rdb from '@ohos.data.rdb' export default class MainAbility extends Ability { @@ -173,7 +174,7 @@ deleteRdbStore(context: Context, name: string): Promise<void> | Promise<void> | 指定Promise回调函数。 | **示例**： - ``` + ```js import data_rdb from '@ohos.data.rdb' let promisedeleteRdb = data_rdb.deleteRdbStore("RdbTest.db") promisedeleteRdb.then(()=>{ @@ -183,9 +184,9 @@ deleteRdbStore(context: Context, name: string): Promise<void> }) ``` -API9的示例请参考如下代码： +API 9的示例请参考如下代码： -``` +```ts import Ability from '@ohos.application.Ability' import data_rdb from '@ohos.data.rdb' export default class MainAbility extends Ability { @@ -218,7 +219,7 @@ constructor(name: string) | name | string | 是 | 数据库表名。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") ``` @@ -242,7 +243,7 @@ inDevices(devices: Array<string>): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicate.inDevices(['12345678abcde']) ``` @@ -262,7 +263,7 @@ inAllDevices(): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.inAllDevices() ``` @@ -288,7 +289,7 @@ equalTo(field: string, value: ValueType): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") ``` @@ -315,7 +316,7 @@ notEqualTo(field: string, value: ValueType): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notEqualTo("NAME", "lisi") ``` @@ -336,7 +337,7 @@ beginWrap(): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回带有左括号的Rdb谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") .beginWrap() @@ -362,7 +363,7 @@ endWrap(): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回带有右括号的Rdb谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") .beginWrap() @@ -388,7 +389,7 @@ or(): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回带有或条件的Rdb谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") .or() @@ -411,7 +412,7 @@ and(): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回带有和条件的Rdb谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") .and() @@ -423,7 +424,7 @@ and(): RdbPredicates contains(field: string, value: string): RdbPredicates -配置谓词以匹配数据字段为String且value包含指定值的字段。 +配置谓词以匹配数据字段为string且value包含指定值的字段。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 @@ -439,7 +440,7 @@ contains(field: string, value: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.contains("NAME", "os") ``` @@ -450,7 +451,7 @@ contains(field: string, value: string): RdbPredicates beginsWith(field: string, value: string): RdbPredicates -配置谓词以匹配数据字段为String且值以指定字符串开头的字段。 +配置谓词以匹配数据字段为string且值以指定字符串开头的字段。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 @@ -466,7 +467,7 @@ beginsWith(field: string, value: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.beginsWith("NAME", "os") ``` @@ -477,7 +478,7 @@ beginsWith(field: string, value: string): RdbPredicates endsWith(field: string, value: string): RdbPredicates -配置谓词以匹配数据字段为String且值以指定字符串结尾的字段。 +配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 @@ -493,7 +494,7 @@ endsWith(field: string, value: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.endsWith("NAME", "se") ``` @@ -519,7 +520,7 @@ isNull(field: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | - 示例 - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNull("NAME") ``` @@ -545,7 +546,7 @@ isNotNull(field: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNotNull("NAME") ``` @@ -556,7 +557,7 @@ isNotNull(field: string): RdbPredicates like(field: string, value: string): RdbPredicates -配置谓词以匹配数据字段为String且值类似于指定字符串的字段。 +配置谓词以匹配数据字段为string且值类似于指定字符串的字段。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 @@ -572,7 +573,7 @@ like(field: string, value: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.like("NAME", "%os%") ``` @@ -583,7 +584,7 @@ like(field: string, value: string): RdbPredicates glob(field: string, value: string): RdbPredicates -配置RdbPredicates匹配数据字段为String的指定字段。 +配置RdbPredicates匹配数据字段为string的指定字段。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 @@ -599,7 +600,7 @@ glob(field: string, value: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.glob("NAME", "?h*g") ``` @@ -627,7 +628,7 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.between("AGE", 10, 50) ``` @@ -655,7 +656,7 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notBetween("AGE", 10, 50) ``` @@ -681,7 +682,7 @@ greaterThan(field: string, value: ValueType): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThan("AGE", 18) ``` @@ -708,7 +709,7 @@ lessThan(field: string, value: ValueType): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThan("AGE", 20) ``` @@ -736,7 +737,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThanOrEqualTo("AGE", 18) ``` @@ -764,7 +765,7 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThanOrEqualTo("AGE", 20) ``` @@ -791,7 +792,7 @@ orderByAsc(field: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByAsc("NAME") ``` @@ -818,7 +819,7 @@ orderByDesc(field: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByDesc("AGE") ``` @@ -839,7 +840,7 @@ distinct(): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回可用于过滤重复记录的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").distinct("NAME") let promisequery = rdbStore.query(predicates, ["NAME"]) @@ -872,7 +873,7 @@ limitAs(value: number): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回可用于设置最大数据记录数的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").limitAs(3) ``` @@ -898,7 +899,7 @@ offsetAs(rowOffset: number): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回具有指定返回结果起始位置的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").offsetAs(3) ``` @@ -924,7 +925,7 @@ groupBy(fields: Array<string>): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回分组查询列的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.groupBy(["AGE", "NAME"]) ``` @@ -950,7 +951,7 @@ indexedBy(field: string): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回具有指定索引列的RdbPredicates。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.indexedBy("SALARY_INDEX") ``` @@ -978,7 +979,7 @@ in(field: string, value: Array<ValueType>): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.in("AGE", [18, 20]) ``` @@ -1006,7 +1007,7 @@ notIn(field: string, value: Array<ValueType>): RdbPredicates | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notIn("NAME", ["Lisa", "Rose"]) ``` @@ -1033,7 +1034,7 @@ insert(name: string, values: ValuesBucket, callback: AsyncCallback<number> | callback | AsyncCallback<number> | 是 | 指定callback回调函数。如果操作成功，返回行ID；否则返回-1。 | **示例**： - ``` + ```js const valueBucket = { "NAME": "Lisa", "AGE": 18, @@ -1066,7 +1067,7 @@ insert(name: string, values: ValuesBucket):Promise<number> | Promise<number> | 指定Promise回调函数。如果操作成功，返回行ID；否则返回-1。 | **示例**： - ``` + ```js const valueBucket = { "NAME": "Lisa", "AGE": 18, @@ -1098,7 +1099,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。返回受影响的行数。 | **示例**： - ``` + ```js const valueBucket = { "NAME": "Rose", "AGE": 22, @@ -1132,7 +1133,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise<number> | Promise<number> | 指定的Promise回调方法。返回受影响的行数。 | **示例**： - ``` + ```js const valueBucket = { "NAME": "Rose", "AGE": 22, @@ -1166,7 +1167,7 @@ delete(rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void | callback | AsyncCallback<number> | 是 | 指定callback回调函数。返回受影响的行数。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") rdbStore.delete(predicates, function (err, rows) { @@ -1194,7 +1195,7 @@ delete(rdbPredicates: RdbPredicates):Promise<number> | Promise<number> | 指定Promise回调函数。返回受影响的行数。 | **示例**： - ``` + ```js let predicatesdelete = new data_rdb.RdbPredicates("EMPLOYEE") predicatesdelete.equalTo("NAME", "Lisa") let promisedelete = rdbStore.delete(predicates) @@ -1222,7 +1223,7 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>, callback: Asyn | callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) { @@ -1252,7 +1253,7 @@ query(rdbPredicates: RdbPredicates, columns?: Array<string>):Promise<Re | Promise<[ResultSet](../apis/js-apis-data-resultset.md)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | **示例**： - ``` + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") let promisequery = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) @@ -1281,7 +1282,7 @@ querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback& | callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | **示例**： - ``` + ```js rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) { console.log("resultSet column names:" + resultSet.columnNames) console.log("resultSet column count:" + resultSet.columnCount) @@ -1309,7 +1310,7 @@ querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> | Promise<[ResultSet](../apis/js-apis-data-resultset.md)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | **示例**： - ``` + ```js let promisequerySql = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo']) promisequerySql.then((resultSet) => { console.log("resultSet column names:" + resultSet.columnNames) @@ -1336,7 +1337,7 @@ executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallbac | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例**： - ``` + ```js rdbStore.executeSql("DELETE FROM EMPLOYEE", null, function () { console.info('delete done.') }) @@ -1363,7 +1364,7 @@ executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void> | Promise<void> | 指定Promise回调函数。 | **示例**： - ``` + ```js let promiseexecuteSql = rdbStore.executeSql("DELETE FROM EMPLOYEE") promiseexecuteSql.then(() => { console.info('delete done.') @@ -1381,7 +1382,7 @@ beginTransaction():void **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **示例**： -``` +```js rdbStore.beginTransaction() const valueBucket = { "name": "lisi", @@ -1405,7 +1406,7 @@ commit():void **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **示例**： -``` +```js rdbStore.beginTransaction() const valueBucket = { "name": "lisi", @@ -1430,7 +1431,7 @@ rollBack():void; **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **示例**： -``` +```js try { rdbStore.beginTransaction() const valueBucket = { @@ -1465,7 +1466,7 @@ setDistributedTables(tables: Array<string>, callback: AsyncCallback<voi | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例**： - ``` + ```js rdbStore.setDistributedTables(["EMPLOYEE"], function (err) { if (err) { console.info('setDistributedTables failed.') @@ -1495,7 +1496,7 @@ setDistributedTables(tables: Array<string>, callback: AsyncCallback<voi | Promise<void> | 指定Promise回调函数。 | **示例**： - ``` + ```js let promiseset = rdbStore.setDistributedTables(["EMPLOYEE"]) promiseset.then(() => { console.info("setDistributedTables success.") @@ -1520,7 +1521,7 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac | callback | AsyncCallback<string> | 是 | 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。 | **示例**： - ``` + ```js rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE", function (err, tableName) { if (err) { console.info('obtainDistributedTableName failed.') @@ -1551,7 +1552,7 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac | Promise<string> | 指定Promise回调函数。如果操作成功，返回远程设备的分布式表名。 | **示例**： - ``` + ```js let promiseDistr = rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE") promiseDistr.then((tableName) => { console.info('obtainDistributedTableName success, tableName=' + tableName) @@ -1576,7 +1577,7 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array | callback | AsyncCallback<Array<[string, number]>> | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。| **示例**： - ``` + ```js let predicate = new rdb.RdbPredicates('EMPLOYEE') predicate.inDevices(['12345678abcde']) rdbStore.sync(rdb.SyncMode.SYNC_MODE_PUSH, predicate, function (err, result) { @@ -1613,7 +1614,7 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array | Promise<Array<[string, number]>> | 指定Promise回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | **示例**： - ``` + ```js let predicatesync = new data_rdb.RdbPredicates('EMPLOYEE') predicatesync.inDevices(['12345678abcde']) let promisesync = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicatesync) @@ -1644,7 +1645,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<stri | observer | Callback<Array<string>> | 是 | 指分布式数据库中数据更改事件的观察者。 | **示例**： - ``` + ```js function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { console.log('device=' + device[i] + ' data changed') @@ -1675,7 +1676,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback<Array<stri **示例**： - ``` + ```js function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { console.log('device=' + device[i] + ' data changed') @@ -1688,7 +1689,6 @@ off(event:'dataChange', type: SubscribeType, observer: Callback<Array<stri } ``` - ## StoreConfig 管理关系数据库配置。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md index 08dfbda473b6e3d47d1ed9d4de8bcc6ba2281c8b..bb6117cd61ba5fc11635cef917fc449eeccdcf35 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md @@ -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') }) ``` + diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md index 0de7d0a2385fa4f998295217b454a17acc77495b..09c94ce9de65bfd8a98cbd38ad62f0a04d9997e7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md @@ -12,18 +12,18 @@ ## 导入模块 -``` -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 @@ -45,7 +45,7 @@ getStorageSync(path: string): Storage | [Storage](#storage) | 获取到要操作的Storage实例，用于进行数据存储操作。 | - 示例： - ``` + ```js import dataStorage from '@ohos.data.storage' import featureAbility from '@ohos.ability.featureAbility' @@ -78,7 +78,7 @@ getStorage(path: string, callback: AsyncCallback<Storage>): void | callback | AsyncCallback<[Storage](#storage)> | 是 | 回调函数。 | - 示例： - ``` + ```js import dataStorage from '@ohos.data.storage' import featureAbility from '@ohos.ability.featureAbility' @@ -120,7 +120,7 @@ getStorage(path: string): Promise<Storage> | Promise<[Storage](#storage)> | Promise实例，用于异步获取结果。 | - 示例： - ``` + ```js import dataStorage from '@ohos.data.storage' import featureAbility from '@ohos.ability.featureAbility' @@ -176,7 +176,7 @@ deleteStorage(path: string, callback: AsyncCallback<void>): void | callback | AsyncCallback<void> | 是 | 回调函数。 | - 示例： - ``` + ```js dataStorage.deleteStorage(path + '/mystore', function (err) { if (err) { console.info("Deleted failed with err: " + err) @@ -206,7 +206,7 @@ deleteStorage(path: string): Promise<void> | Promise<void> | Promise实例，用于异步获取结果。 | - 示例： - ``` + ```js let promisedelSt = dataStorage.deleteStorage(path + '/mystore') promisedelSt.then(() => { console.info("Deleted successfully.") @@ -232,7 +232,7 @@ removeStorageFromCacheSync(path: string): void | path | string | 是 | 应用程序内部数据存储路径。 | - 示例： - ``` + ```js dataStorage.removeStorageFromCacheSync(path + '/mystore') ``` @@ -254,7 +254,7 @@ removeStorageFromCache(path: string, callback: AsyncCallback<void>): void | callback | AsyncCallback<void> | 是 | 回调函数。 | - 示例： - ``` + ```js dataStorage.removeStorageFromCache(path + '/mystore', function (err) { if (err) { console.info("Removed storage from cache failed with err: " + err) @@ -286,7 +286,7 @@ removeStorageFromCache(path: string): Promise<void> | Promise<void> | Promise实例，用于异步获取结果。 | - 示例： - ``` + ```js let promiserevSt = dataStorage.removeStorageFromCache(path + '/mystore') promiserevSt.then(() => { console.info("Removed storage from cache successfully.") @@ -314,8 +314,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。 | - 返回值： | 类型 | 说明 | @@ -323,7 +323,7 @@ getSync(key: string, defValue: ValueType): ValueType | ValueType | 键对应的值，如果值为null或者非默认值类型，返回默认数据。 | - 示例： - ``` + ```js let value = storage.getSync('startup', 'default') console.info("The value of startup is " + value) ``` @@ -342,12 +342,12 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称。它不能为空。 | - | defValue | ValueType | 是 | 默认返回值。支持number、string、boolean。 | + | key | string | 是 | 要获取的存储key名称，不能为空。 | + | defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 | | callback | AsyncCallback<ValueType> | 是 | 回调函数。 | - 示例： - ``` + ```js storage.get('startup', 'default', function(err, value) { if (err) { console.info("Get the value of startup failed with err: " + err) @@ -371,8 +371,8 @@ get(key: string, defValue: ValueType): Promise<ValueType> - **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称。它不能为空。 | - | defValue | ValueType | 是 | 默认返回值。支持number、string、boolean。 | + | key | string | 是 | 要获取的存储key名称，不能为空。 | + | defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 | - 返回值： | 类型 | 说明 | @@ -380,7 +380,7 @@ get(key: string, defValue: ValueType): Promise<ValueType> | Promise<ValueType> | Promise实例，用于异步获取结果。 | - 示例： - ``` + ```js let promiseget = storage.get('startup', 'default') promiseget.then((value) => { console.info("The value of startup is " + value) @@ -403,11 +403,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') ``` @@ -425,12 +425,12 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | key | string | 是 | 要修改的存储的key。它不能为空。 | - | value | ValueType | 是 | 存储的新值。支持number、string、boolean。 | + | key | string | 是 | 要修改的存储的key，不能为空。 | + | value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | - 示例： - ``` + ```js storage.put('startup', 'auto', function (err) { if (err) { console.info("Put the value of startup failed with err: " + err) @@ -454,8 +454,8 @@ put(key: string, value: ValueType): Promise<void> - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | key | string | 是 | 要修改的存储的key。它不能为空。 | - | value | ValueType | 是 | 存储的新值。支持number、string、boolean。 | + | key | string | 是 | 要修改的存储的key，不能为空。 | + | value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 | - 返回值： | 类型 | 说明 | @@ -463,7 +463,7 @@ put(key: string, value: ValueType): Promise<void> | Promise<void> | Promise实例，用于异步处理。 | - 示例： - ``` + ```js let promiseput = storage.put('startup', 'auto') promiseput.then(() => { console.info("Put the value of startup successfully.") @@ -486,7 +486,7 @@ hasSync(key: string): boolean - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称。它不能为空。 | + | key | string | 是 | 要获取的存储key名称，不能为空。 | - 返回值： | 类型 | 说明 | @@ -494,7 +494,7 @@ hasSync(key: string): boolean | boolean | true 表示存在，false表示不存在。 | - 示例： - ``` + ```js let isExist = storage.hasSync('startup') if (isExist) { console.info("The key of startup is contained.") @@ -524,7 +524,7 @@ has(key: string, callback: AsyncCallback<boolean>): boolean | boolean | true表示存在，false表示不存在。 | - 示例： - ``` + ```js storage.has('startup', function (err, isExist) { if (err) { console.info("Check the key of startup failed with err: " + err) @@ -550,7 +550,7 @@ has(key: string): Promise<boolean> - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | key | string | 是 | 要获取的存储key名称。它不能为空。 | + | key | string | 是 | 要获取的存储key名称，不能为空。 | - 返回值： | 类型 | 说明 | @@ -558,7 +558,7 @@ has(key: string): Promise<boolean> | Promise<boolean> | Promise实例，用于异步处理。 | - 示例： - ``` + ```js let promisehas = storage.has('startup') promisehas.then((isExist) => { if (isExist) { @@ -586,12 +586,12 @@ deleteSync(key: string): void | key | string | 是 | 要获取的存储key名称。它不能为空。 | - 示例： - ``` + ```js storage.deleteSync('startup') ``` -### delete +### deletej delete(key: string, callback: AsyncCallback<void>): void @@ -608,7 +608,7 @@ delete(key: string, callback: AsyncCallback<void>): void | callback | AsyncCallback<void> | 是 | 回调函数。 | - 示例： - ``` + ```js storage.delete('startup', function (err) { if (err) { console.info("Delete startup key failed with err: " + err) @@ -640,7 +640,7 @@ delete(key: string): Promise<void> | Promise<void> | Promise实例，用于异步处理。 | - 示例： - ``` + ```js let promisedel = storage.delete('startup') promisedel.then(() => { console.info("Deleted startup key successfully.") @@ -661,7 +661,7 @@ flushSync(): void **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core - 示例： - ``` + ```js storage.flushSync() ``` @@ -682,7 +682,7 @@ flush(callback: AsyncCallback<void>): void | callback | AsyncCallback<void> | 是 | 回调函数。 | - 示例： - ``` + ```js storage.flush(function (err) { if (err) { console.info("Flush to file failed with err: " + err) @@ -709,7 +709,7 @@ flush(): Promise<void> | Promise<void> | Promise实例，用于异步处理。 | - 示例： - ``` + ```js let promiseflush = storage.flush() promiseflush.then(() => { console.info("Flushed to file successfully.") @@ -730,7 +730,7 @@ clearSync(): void **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core - 示例： - ``` + ```js storage.clearSync() ``` @@ -751,7 +751,7 @@ clear(callback: AsyncCallback<void>): void | callback | AsyncCallback<void> | 是 | 回调函数。 | - 示例： - ``` + ```js storage.clear(function (err) { if (err) { console.info("Clear to file failed with err: " + err) @@ -778,7 +778,7 @@ clear(): Promise<void> | Promise<void> | Promise实例，用于异步处理。 | - 示例： - ``` + ```js let promiseclear = storage.clear() promiseclear.then(() => { console.info("Cleared to file successfully.") @@ -803,7 +803,7 @@ on(type: 'change', callback: Callback<StorageObserver>): void | callback | Callback<[StorageObserver](#storageobserver)> | 回调对象实例。 | - 示例： - ``` + ```js var observer = function (key) { console.info("The key of " + key + " changed.") } @@ -828,7 +828,7 @@ off(type: 'change', callback: Callback<StorageObserver>): void | callback | Callback<[StorageObserver](#storageobserver)> | 需要取消的回调对象实例。 | - 示例： - ``` + ```js var observer = function (key) { console.info("The key of " + key + " changed.") } @@ -843,3 +843,15 @@ off(type: 'change', callback: Callback<StorageObserver>): void | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | key | string | 否 | 变更的数据内容。 | + +## ValueType + +用于表示允许的数据字段类型。 + +**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core + +| 名称 | 说明 | +| ------- | -------------------- | +| number | 表示值类型为数字。 | +| string | 表示值类型为字符。 | +| boolean | 表示值类型为布尔值。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index 26d8878669c097e7c3b3588c31d9847487652895..81f7759e3d366fe056e99c7e87e4957e831261cd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -6,7 +6,7 @@ ## 导入模块 -``` +```js import distributedData from '@ohos.data.distributedData'; ``` @@ -27,7 +27,7 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager> | callback | AsyncCallback<[KVManager](#kvmanager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | **示例**： -``` +```js let kvManager; try { const kvManagerConfig = { @@ -72,7 +72,7 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> **示例**： -``` +```js let kvManager; try { const kvManagerConfig = { @@ -129,7 +129,7 @@ try { ## KVManager -数据管理实例，用于获取KVStore的相关信息。在调用KVManager的方法前，需要先通过createKVManager构建一个KVManager实例。 +数据管理实例，用于获取KVStore的相关信息。在调用KVManager的方法前，需要先通过[createKVManager](#distributeddatacreatekvmanager)构建一个KVManager实例。 ### getKVStore @@ -145,11 +145,11 @@ getKVStore<T extends KVStore>(storeId: string, options: Options, callback: | ----- | ------ | ------ | ------ | | storeId | string | 是 | 数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 | | options | [Options](#options) | 是 | 创建KVStore实例的配置信息。 | -| callback | AsyncCallback<T>，<T extends KVStore> | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | +| callback | AsyncCallback<T>，<T extends [KVStore](#kvstore)> | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | **示例**： -``` +```js let kvStore; let kvManager; try { @@ -195,11 +195,11 @@ getKVStore<T extends KVStore>(storeId: string, options: Options): Promise& | 类型 | 说明 | | -------------------------------------- | ------------------------ | -| Promise<T> <T extends KVStore> | 指定的Promise回调方法，返回创建的KVStore数据库实例。 | +| Promise<T> <T extends [KVStore](#kvstore)> | 指定的Promise回调方法，返回创建的KVStore数据库实例。 | **示例**： -``` +```js let kvStore; let kvManager; try { @@ -226,7 +226,7 @@ try { closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback<void>): void -通过storId的值关闭指定的kvStore数据库，并通过callback方式返回，此方法为异步方法。 +通过storeId的值关闭指定的KVStore数据库，并通过callback方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -237,12 +237,12 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa | ------- | ----------------- | ---- | --------------------------- | | appId | string | 是 | 所调用数据库方的包名。 | | storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 | -| kvStore | [KVStore](#kvstore) | 是 | 要关闭的KvStore数据库。 | +| kvStore | [KVStore](#kvstore) | 是 | 要关闭的KVStore数据库。 | | callback | AsyncCallback<void> | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 | **示例**： -``` +```js let kvStore; let kvManager; const options = { @@ -272,7 +272,7 @@ const options = { closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void> -通过kvStore的值关闭指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 +通过storeId的值关闭指定的KVStore数据库，并通过Promise方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -282,17 +282,17 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void& | ----- | ------ | ---- | ----------------------------- | | appId | string | 是 | 所调用数据库方的包名。 | | storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 | -| kvStore | [KVStore](#kvstore) | 是 | 要关闭的KvStore数据库。 | +| kvStore | [KVStore](#kvstore) | 是 | 要关闭的KVStore数据库。 | **返回值**： | 类型 | 说明 | | ------------- | -------------- | -| Promise | Promise实例，如果数据库关闭成功则返回true，否则返回false。 | +| Promise\ | Promise实例，如果数据库关闭成功则返回true，否则返回false。 | **示例**： -``` +```js let kvManager; let kvStore; const options = { @@ -326,7 +326,7 @@ const options = { deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): void -通过storeId的值删除指定的kvStore数据库，并通过callback方式返回，此方法为异步方法。 +通过storeId的值删除指定的KVStore数据库，并通过callback方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -340,7 +340,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void> **示例**： -``` +```js let kvManager; let kvStore; const options = { @@ -369,7 +369,7 @@ try { deleteKVStore(appId: string, storeId: string): Promise<void> -通过storeId的值删除指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 +通过storeId的值删除指定的KVStore数据库，并通过Promise方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -389,7 +389,7 @@ deleteKVStore(appId: string, storeId: string): Promise<void> **示例**： -``` +```js let kvManager; let kvStore; const options = { @@ -402,7 +402,7 @@ const options = { securityLevel : distributedData.SecurityLevel.S2, } try { - kvManager.getKVStore('storId', options).then(async (store) => { + kvManager.getKVStore('storeId', options).then(async (store) => { console.log('getKVStore success'); kvStore = store; await kvManager.deleteKVStore('appId', 'storeId').then(() => { @@ -423,7 +423,7 @@ try { getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void -获取所有通过getKvStore方法创建的且没有调用deleteKvStore方法删除的KvStore数据库的storeId，并通过callback方式返回，此方法为异步方法。 +获取所有通过[getKVStore](#getkvstore)方法创建的且没有调用[deleteKVStore](#deletekvstore8)方法删除的KVStore数据库的storeId，并通过callback方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -436,7 +436,7 @@ getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void **示例**： -``` +```js let kvManager; try { kvManager.getAllKVStoreId('appId', function (err, data) { @@ -453,7 +453,7 @@ try { getAllKVStoreId(appId: string): Promise<string[]> -获取所有通过getKvStore方法创建的且没有调用deleteKvStore方法删除的KvStore数据库的storeId，并通过Promise方式返回，此方法为异步方法。 +获取所有通过[getKVStore](#getkvstore)方法创建的且没有调用[deleteKVStore](#deletekvstore8)方法删除的KVStore数据库的storeId，并通过Promise方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -472,7 +472,7 @@ getAllKVStoreId(appId: string): Promise<string[]> **示例**： -``` +```js let kvManager; try { console.log('GetAllKVStoreId'); @@ -505,7 +505,7 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): voi **示例** -``` +```js let kvManager; try { @@ -538,7 +538,7 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v **示例** -``` +```js let kvManager; try { console.log('KVManagerOff'); @@ -563,7 +563,7 @@ try { | createIfMissing | boolean | 否 | 当数据库文件不存在时是否创建数据库，默认创建。 | | encrypt | boolean | 否 |设置数据库文件是否加密，默认不加密。 | | backup | boolean | 否 |设置数据库文件是否备份，默认备份。 | -| autoSync | boolean | 否 |设置数据库文件是否自动同步，默认不自动同步。**需要权限**： ohos.permission.DISTRIBUTED_DATASYNC。 | +| autoSync | boolean | 否 |设置数据库文件是否自动同步，默认不自动同步。
**需要权限**： ohos.permission.DISTRIBUTED_DATASYNC。 | | kvStoreType | [KVStoreType](#kvstoretype) | 否 |设置要创建的数据库类型，默认为多设备协同数据库。 | | securityLevel | [SecurityLevel](#securitylevel) | 否 |设置数据库安全级别，默认不设置安全级别。 | | schema8+ | [Schema](#schema8) | 否 | 设置定义存储在数据库中的值。 | @@ -621,7 +621,7 @@ KVStore常量。 | 名称 | 类型 | 说明 | | --- | ---- | ----------------------- | -| root8+ | [FieldNode](#fieldnode8) | 表示json根对象 | +| root8+ | [FieldNode](#fieldnode8) | 表示json根对象。 | | indexes8+ | Array\ | 表示json类型的字符串数组。 | | mode8+ | number | 表示Schema的模式。 | | skip8+ | number | Schema的跳跃大小。 | @@ -674,7 +674,6 @@ appendChild(child: FieldNode): boolean | ----- | ------ | ---- | ----------------------- | | child | [FieldNode](#fieldnode8) | 是 | 要附加的域节点。 | - **返回值**： | 类型 | 说明 | @@ -683,7 +682,7 @@ appendChild(child: FieldNode): boolean **示例** -``` +```js import ddm from '@ohos.data.distributedData'; try { let node = new ddm.FieldNode("root"); @@ -706,7 +705,7 @@ try { ## KvStoreResultSet8+ ## -提供获取KvStore数据库结果集的方法，提供查询和移动数据读取位置的方法，在调用KvStoreResultSet的方法前，需要先通过KvStore 构建一个KvStore 实例。 +提供获取KVStore数据库结果集的方法，提供查询和移动数据读取位置的方法，在调用KvStoreResultSet的方法前，需要先通过KVStore 构建一个KVStore 实例。 ### getCount8+ ### @@ -725,7 +724,7 @@ getCount(): number **示例** -``` +```js let kvStore; try { let resultSet; @@ -758,7 +757,7 @@ getPosition(): number **示例** -``` +```js let kvStore; try { let resultSet; @@ -792,7 +791,7 @@ moveToFirst(): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -826,7 +825,7 @@ moveToLast(): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -860,7 +859,7 @@ moveToNext(): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -894,7 +893,7 @@ moveToPrevious(): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -934,7 +933,7 @@ move(offset: number): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -974,7 +973,7 @@ moveToPosition(position: number): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -1008,7 +1007,7 @@ isFirst(): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -1042,7 +1041,7 @@ isLast(): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -1075,7 +1074,7 @@ isBeforeFirst(): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -1109,7 +1108,7 @@ isAfterLast(): boolean **示例** -``` +```js let kvStore; try { let resultSet; @@ -1131,7 +1130,7 @@ try { getEntry(): Entry -获取键值对 +获取键值对。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -1139,11 +1138,11 @@ getEntry(): Entry | 类型 | 说明 | | ------ | ------- | -| Entry |返回键值对。| +| [Entry](#entry) |返回键值对。| **示例** -``` +```js let kvStore; try { let resultSet; @@ -1172,7 +1171,7 @@ try { constructor() -用于创建Schema实例的构造函数 +用于创建Schema实例的构造函数。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -1194,7 +1193,7 @@ reset(): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.equalTo("key", "value"); @@ -1210,7 +1209,7 @@ try { ### equalTo8+ ### -equalTo(field: string, value: number|string|boolean): Query; +equalTo(field: string, value: number|string|boolean): Query 构造一个Query对象来查询具有指定字段的条目，其值等于指定的值。 @@ -1221,7 +1220,7 @@ equalTo(field: string, value: number|string|boolean): Query; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | -| value | number/string/boolean | 是 | 表示指定的值。| +| value | number\|string\|boolean | 是 | 表示指定的值。| **返回值**： @@ -1231,7 +1230,7 @@ equalTo(field: string, value: number|string|boolean): Query; **示例** -``` +```js try { let query = new distributedData.Query(); query.equalTo("field", "value"); @@ -1256,7 +1255,7 @@ notEqualTo(field: string, value: number|string|boolean): Query | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | -| value | number/string/boolean | 是 | 表示指定的值。| +| value | number\|string\|boolean | 是 | 表示指定的值。| **返回值**： @@ -1266,7 +1265,7 @@ notEqualTo(field: string, value: number|string|boolean): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.notEqualTo("field", "value"); @@ -1301,7 +1300,7 @@ greaterThan(field: string, value: number|string|boolean): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.greaterThan("field", "value"); @@ -1336,7 +1335,7 @@ lessThan(field: string, value: number|string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.lessThan("field", "value"); @@ -1371,7 +1370,7 @@ greaterThanOrEqualTo(field: string, value: number|string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.greaterThanOrEqualTo("field", "value"); @@ -1406,7 +1405,7 @@ lessThanOrEqualTo(field: string, value: number|string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.lessThanOrEqualTo("field", "value"); @@ -1441,7 +1440,7 @@ isNull(field: string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.isNull("field"); @@ -1477,7 +1476,7 @@ inNumber(field: string, valueList: number[]): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.inNumber("field", [0, 1]); @@ -1512,7 +1511,7 @@ inString(field: string, valueList: string[]): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.inString("field", ['test1', 'test2']); @@ -1547,7 +1546,7 @@ notInNumber(field: string, valueList: number[]): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.notInNumber("field", [0, 1]); @@ -1582,7 +1581,7 @@ notInString(field: string, valueList: string[]): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.notInString("field", ['test1', 'test2']); @@ -1617,7 +1616,7 @@ like(field: string, value: string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.like("field", "value"); @@ -1652,7 +1651,7 @@ unlike(field: string, value: string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.unlike("field", "value"); @@ -1680,7 +1679,7 @@ and(): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.notEqualTo("field", "value1"); @@ -1710,7 +1709,7 @@ or(): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.notEqualTo("field", "value1"); @@ -1746,7 +1745,7 @@ orderByAsc(field: string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.notEqualTo("field", "value"); @@ -1781,7 +1780,7 @@ orderByDesc(field: string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.notEqualTo("field", "value"); @@ -1817,7 +1816,7 @@ limit(total: number, offset: number): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.notEqualTo("field", "value"); @@ -1852,7 +1851,7 @@ isNotNull(field: string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.isNotNull("field"); @@ -1880,7 +1879,7 @@ beginGroup(): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.beginGroup(); @@ -1910,7 +1909,7 @@ endGroup(): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.beginGroup(); @@ -1946,7 +1945,7 @@ prefixKey(prefix: string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.prefixKey("$.name"); @@ -1981,7 +1980,7 @@ setSuggestIndex(index: string): Query **示例** -``` +```js try { let query = new distributedData.Query(); query.setSuggestIndex("$.name"); @@ -2017,7 +2016,7 @@ deviceId(deviceId:string):Query **示例** -``` +```js try { let query = new distributedData.Query(); query.deviceId("deviceId"); @@ -2044,7 +2043,7 @@ getSqlLike():string **示例** -``` +```js try { let query = new distributedData.Query(); let sql1 = query.getSqlLike(); @@ -2079,7 +2078,7 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; @@ -2120,7 +2119,7 @@ put(key: string, value: Uint8Array | string | number | boolean): Promise<void **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; @@ -2153,7 +2152,7 @@ delete(key: string, callback: AsyncCallback<void>): void **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; @@ -2200,7 +2199,7 @@ delete(key: string): Promise<void> **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; @@ -2233,13 +2232,13 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotific | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'dataChange' | 是 |回调函数名称。 | +| event |'dataChange' | 是 |回调函数名称。
'dataChange'表示数据变更事件。 | | type |[SubscribeType](#subscribetype) | 是 |表示订阅的类型。 | | observer |Callback<[ChangeNotification](#changenotification)> | 是 |回调函数。 | **示例** -``` +```js let kvStore; kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, function (data) { console.log("dataChange callback call data: " + JSON.stringify(data)); @@ -2259,7 +2258,7 @@ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]> | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'syncComplete' | 是 |回调函数名称。 | +| event |'syncComplete' | 是 |回调函数名称。
'syncComplete'表示同步完成事件。 | | syncCallback |Callback<Array<[string, number]>> | 是 |回调函数。 | **示例** @@ -2283,12 +2282,12 @@ off(event:'dataChange', observer?: Callback<ChangeNotification>): void | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'dataChange' | 是 |回调函数名称。 | +| event |'dataChange' | 是 |回调函数名称。
'dataChange'表示数据变更事件。 | | observer |Callback<[ChangeNotification](#changenotification)> |否 |回调函数。 | **示例** -``` +```js let kvStore; kvStore.on('dataChange', function (data) { console.log("syncComplete callback call data: " + data); @@ -2303,7 +2302,7 @@ kvStore.off('dataChange', function (data) { putBatch(entries: Entry[], callback: AsyncCallback<void>): void -批量插入键值对到KvStore数据库中，并通过callback方式返回，此方法为异步方法。 +批量插入键值对到KVStore数据库中，并通过callback方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2316,7 +2315,7 @@ putBatch(entries: Entry[], callback: AsyncCallback<void>): void **示例** -``` +```js let kvStore; try { let entries = []; @@ -2350,7 +2349,7 @@ try { putBatch(entries: Entry[]): Promise<void> -批量插入键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。 +批量插入键值对到KVStore数据库中，并通过Promise方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2368,7 +2367,7 @@ putBatch(entries: Entry[]): Promise<void> **示例** -``` +```js let kvStore; try { let entries = []; @@ -2405,7 +2404,7 @@ try { deleteBatch(keys: string[], callback: AsyncCallback<void>): void -批量删除KvStore数据库中的键值对，并通过callback方式返回，此方法为异步方法。 +批量删除KVStore数据库中的键值对，并通过callback方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2418,7 +2417,7 @@ deleteBatch(keys: string[], callback: AsyncCallback<void>): void **示例** -``` +```js let kvStore; try { let entries = []; @@ -2452,7 +2451,7 @@ try { deleteBatch(keys: string[]): Promise<void> -批量删除键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。 +批量删除KVStore数据库中的键值对，并通过Promise方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2470,7 +2469,7 @@ deleteBatch(keys: string[]): Promise<void> **示例** -``` +```js let kvStore; try { let entries = []; @@ -2508,7 +2507,7 @@ try { startTransaction(callback: AsyncCallback<void>): void -启动KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 +启动KVStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2520,7 +2519,7 @@ startTransaction(callback: AsyncCallback<void>): void **示例** -``` +```js let kvStore; function putBatchString(len, prefix) { let entries = []; @@ -2560,7 +2559,7 @@ try { startTransaction(): Promise<void> -启动KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 +启动KVStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2572,7 +2571,7 @@ startTransaction(): Promise<void> **示例** -``` +```js let kvStore; try { var count = 0; @@ -2595,7 +2594,7 @@ try { commit(callback: AsyncCallback<void>): void -提交KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 +提交KVStore数据库中的事务，并通过callback方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2607,7 +2606,7 @@ commit(callback: AsyncCallback<void>): void **示例** -``` +```js let kvStore; try { kvStore.commit(function (err,data) { @@ -2627,7 +2626,7 @@ try { commit(): Promise<void> -提交KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 +提交KVStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2639,7 +2638,7 @@ commit(): Promise<void> **示例** -``` +```js let kvStore; try { kvStore.commit().then(async (err) => { @@ -2657,7 +2656,7 @@ try { rollback(callback: AsyncCallback<void>): void -在KvStore数据库中回滚事务，并通过callback方式返回，此方法为异步方法。 +在KVStore数据库中回滚事务，并通过callback方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2669,7 +2668,7 @@ rollback(callback: AsyncCallback<void>): void **示例** -``` +```js let kvStore; try { kvStore.rollback(function (err,data) { @@ -2689,7 +2688,7 @@ try { rollback(): Promise<void> -在KvStore数据库中回滚事务，并通过Promise方式返回，此方法为异步方法。 +在KVStore数据库中回滚事务，并通过Promise方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2701,7 +2700,7 @@ rollback(): Promise<void> **示例** -``` +```js let kvStore; try { kvStore.rollback().then(async (err) => { @@ -2732,7 +2731,7 @@ enableSync(enabled: boolean, callback: AsyncCallback<void>): void **示例** -``` +```js let kvStore; try { kvStore.enableSync(true, function (err,data) { @@ -2770,7 +2769,7 @@ enableSync(enabled: boolean): Promise<void> **示例** -``` +```js let kvStore; try { kvStore.enableSync(true).then((err) => { @@ -2802,7 +2801,7 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: Asy **示例** -``` +```js let kvStore; try { const localLabels = ['A', 'B']; @@ -2840,7 +2839,7 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise<v **示例** -``` +```js let kvStore; try { const localLabels = ['A', 'B']; @@ -2902,7 +2901,7 @@ try { | 名称 | 参数类型 |可读 |可写 | 说明 | | ----- | ------- | -----| ------|------------------------ | | type | [ValueType](#value) | 是 | 是 |值类型。 | -| value | Uint8Array / string / number / boolean| 是 | 是 |值对象。 | +| value | Uint8Array \| string \| number \| boolean| 是 | 是 |值对象。 | ## ValueType @@ -2923,7 +2922,7 @@ try { ## SingleKVStore -单版本分布式数据库，继承自KVStore，提供查询数据和同步数据的方法。在调用 SingleKVStore 的方法前，需要先通过 getKVStore 构建一个 SingleKVStore 实例。 +单版本分布式数据库，继承自KVStore，提供查询数据和同步数据的方法。在调用 SingleKVStore 的方法前，需要先通过 [getKVStore](#getkvstore) 构建一个 SingleKVStore 实例。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2944,7 +2943,7 @@ get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | numb **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; @@ -2988,7 +2987,7 @@ get(key: string): Promise<Uint8Array | string | boolean | number> **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; @@ -3025,7 +3024,7 @@ getEntries(keyPrefix: string, callback: AsyncCallback<Entry[]>): void **示例** -``` +```js let kvStore; try { let entries = []; @@ -3076,7 +3075,7 @@ getEntries(keyPrefix: string): Promise<Entry[]> **示例** -``` +```js let kvStore; try { let entries = []; @@ -3129,7 +3128,7 @@ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void **示例** -``` +```js let kvStore; try { var arr = new Uint8Array([21,31]); @@ -3185,7 +3184,7 @@ getEntries(query: Query): Promise<Entry[]> **示例** -``` +```js try { var arr = new Uint8Array([21,31]); let entries = []; @@ -3237,7 +3236,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>) **示例** -``` +```js let kvStore; try { let resultSet; @@ -3273,7 +3272,7 @@ try { getResultSet(keyPrefix: string): Promise<KvStoreResultSet> -从 KvStore 数据库中获取具有指定前缀的结果集，并通过Promise方式返回，此方法为异步方法。 +从 KVStore 数据库中获取具有指定前缀的结果集，并通过Promise方式返回，此方法为异步方法。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -3291,7 +3290,7 @@ getResultSet(keyPrefix: string): Promise<KvStoreResultSet> **示例** -``` +```js let kvStore; try { let resultSet; @@ -3346,7 +3345,7 @@ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): voi **示例** -``` +```js let kvStore; try { let resultSet; @@ -3399,7 +3398,7 @@ getResultSet(query: Query): Promise<KvStoreResultSet> **示例** -``` +```js let kvStore; try { let resultSet; @@ -3450,7 +3449,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>) **示例** -``` +```js let kvStore; try { let resultSet = null; @@ -3489,7 +3488,7 @@ closeResultSet(resultSet: KvStoreResultSet): Promise<void> **示例** -``` +```js let kvStore; try { let resultSet = null; @@ -3521,7 +3520,7 @@ getResultSize(query: Query, callback: AsyncCallback<number>): void **示例** -``` +```js let kvStore; try { let entries = []; @@ -3572,7 +3571,7 @@ getResultSize(query: Query): Promise<number> **示例** -``` +```js let kvStore; try { let entries = []; @@ -3622,7 +3621,7 @@ removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string_2'; const VALUE_TEST_STRING_ELEMENT = 'value-string-002'; @@ -3669,7 +3668,7 @@ removeDeviceData(deviceId: string): Promise<void> **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string_2'; const VALUE_TEST_STRING_ELEMENT = 'value-string-001'; @@ -3749,7 +3748,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]& **示例** -``` +```js let kvStore; try { const func = function (data) { @@ -3768,6 +3767,7 @@ try { sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void 在手动模式下，触发数据库同步，此方法为同步方法。 + **需要权限**： ohos.permission.DISTRIBUTED_DATASYNC。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -3782,7 +3782,7 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void **示例**： -``` +```js let kvStore; kvStore.sync('deviceIds', distributedData.SyncMode.PULL_ONLY, 1000); ``` @@ -3804,7 +3804,7 @@ setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback<void>) **示例** -``` +```js let kvStore; try { const defaultAllowedDelayMs = 500; @@ -3840,7 +3840,7 @@ setSyncParam(defaultAllowedDelayMs: number): Promise<void> **示例** -``` +```js let kvStore; try { const defaultAllowedDelayMs = 500; @@ -3871,7 +3871,7 @@ getSecurityLevel(callback: AsyncCallback<SecurityLevel>): void **示例** -``` +```js let kvStore; try { kvStore.getSecurityLevel(function (err,data) { @@ -3899,7 +3899,7 @@ getSecurityLevel(): Promise<SecurityLevel> **示例** -``` +```js let kvStore; try { kvStore.getSecurityLevel().then((data) => { @@ -3915,7 +3915,7 @@ try { ## DeviceKVStore8+ ## -在分布式系统中按设备管理分布式数据，继承自KvStore，提供查询数据和同步数据的方法。在调用DeviceKVStore的方法前，需要先通过getKVStore构建一个DeviceKVStore实例。 +在分布式系统中按设备管理分布式数据，继承自KVStore，提供查询数据和同步数据的方法。在调用DeviceKVStore的方法前，需要先通过[getKVStore](#getkvstore)构建一个DeviceKVStore实例。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 @@ -3937,7 +3937,7 @@ get(deviceId: string, key: string, callback: AsyncCallback<boolean|string|num **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string_2'; const VALUE_TEST_STRING_ELEMENT = 'value-string-002'; @@ -3977,7 +3977,7 @@ get(deviceId: string, key: string): Promise<boolean|string|number|Uint8Array& **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string_2'; const VALUE_TEST_STRING_ELEMENT = 'value-string-002'; @@ -4016,7 +4016,7 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry **示例** -``` +```js let kvStore; try { let entries = []; @@ -4069,7 +4069,7 @@ getEntries(deviceId: string, keyPrefix: string): Promise<Entry[]> **示例** -``` +```js let kvStore; try { let entries = []; @@ -4122,7 +4122,7 @@ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void **示例** -``` +```js let kvStore; try { var arr = new Uint8Array([21,31]); @@ -4180,7 +4180,7 @@ getEntries(query: Query): Promise<Entry[]> **示例** -``` +```js let kvStore; try { var arr = new Uint8Array([21,31]); @@ -4234,7 +4234,7 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback<Entry[]> **示例** -``` +```js let kvStore; try { var arr = new Uint8Array([21,31]); @@ -4293,7 +4293,7 @@ getEntries(deviceId: string, query: Query): Promise<Entry[]> **示例** -``` +```js let kvStore; try { var arr = new Uint8Array([21,31]); @@ -4348,7 +4348,7 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvS **示例** -``` +```js let kvStore; try { let resultSet; @@ -4388,7 +4388,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise<KvStoreResultSet&g **示例** -``` +```js let kvStore; try { let resultSet; @@ -4426,7 +4426,7 @@ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): voi **示例** -``` +```js let kvStore; try { let resultSet; @@ -4483,7 +4483,7 @@ getResultSet(query: Query): Promise<KvStoreResultSet> **示例** -``` +```js let kvStore; try { let resultSet; @@ -4543,7 +4543,7 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback<KvStoreR **示例** -``` +```js let kvStore; try { let resultSet; @@ -4600,7 +4600,7 @@ getResultSet(deviceId: string, query: Query): Promise<KvStoreResultSet> **示例** -``` +```js let kvStore; try { let resultSet; @@ -4660,7 +4660,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>) **示例** -``` +```js let kvStore; try { console.log('CloseResultSet success'); @@ -4700,7 +4700,7 @@ closeResultSet(resultSet: KvStoreResultSet): Promise<void> **示例** -``` +```js let kvStore; try { console.log('CloseResultSet success'); @@ -4733,7 +4733,7 @@ getResultSize(query: Query, callback: AsyncCallback<number>): void **示例** -``` +```js let kvStore; try { let entries = []; @@ -4785,7 +4785,7 @@ getResultSize(query: Query): Promise<number> **示例** -``` +```js let kvStore; try { let entries = []; @@ -4837,7 +4837,7 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback<number& **示例** -``` +```js let kvStore; try { let entries = []; @@ -4889,7 +4889,7 @@ getResultSize(deviceId: string, query: Query): Promise<number> **示例** -``` +```js let kvStore; try { let entries = []; @@ -4939,7 +4939,7 @@ removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-string-001'; @@ -4986,7 +4986,7 @@ removeDeviceData(deviceId: string): Promise<void> **示例** -``` +```js let kvStore; const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-string-001'; @@ -5018,6 +5018,7 @@ try { sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void 在手动模式下，触发数据库同步，此方法为同步方法。 + **需要权限**： ohos.permission.DISTRIBUTED_DATASYNC。 **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 @@ -5032,7 +5033,7 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void **示例** -``` +```js let kvStore; const KEY_TEST_SYNC_ELEMENT = 'key_test_sync'; const VALUE_TEST_SYNC_ELEMENT = 'value-string-001'; @@ -5068,7 +5069,7 @@ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]> **示例** -``` +```js const KEY_TEST_FLOAT_ELEMENT = 'key_test_float'; const VALUE_TEST_FLOAT_ELEMENT = 321.12; try { @@ -5103,7 +5104,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]& **示例** -``` +```js let kvStore; try { const func = function (data) {