Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 6e9991ab 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!11622 分布式文档格式整改 

Merge pull request !11622 from Wangkai/master
上级 6ed4fdb1 d836377b
隐藏空白更改
内联 并排
Showing with 272 addition and 272 deletion
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
浏览文件 @ 6e9991ab
......@@ -35,7 +35,7 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| config | [KVManagerConfig](#kvmanagerconfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 |
| callback | AsyncCallback<[KVManager](#kvmanager)> | 是 | 回调函数。返回创建的KVManager对象实例。 |
......@@ -75,7 +75,7 @@ createKVManager(config: KVManagerConfig): Promise<KVManager>
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| config |[KVManagerConfig](#kvmanager) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 |
......@@ -116,10 +116,10 @@ try {
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| userInfo | [UserInfo](#userinfo) | 是 | 调用方的用户信息。 |
| bundleName | string | 是 | 调用方的包名。 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ------ | ------ | ------ |
| userInfo | [UserInfo](#userinfo) | 是 | 是 | 调用方的用户信息。 |
| bundleName | string | 是 | 是 | 调用方的包名。 |
## UserInfo
......@@ -127,10 +127,10 @@ try {
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
| 名称 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| userId | string | 是 | 指示要设置的用户ID。 |
| userType | [UserType](#usertype) | 是 | 指示要设置的用户类型。 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ------ | ------ | ------ |
| userId | string | 是 | 是 | 指示要设置的用户ID。 |
| userType | [UserType](#usertype) | 是 | 是 | 指示要设置的用户类型。 |
## UserType
......@@ -158,7 +158,7 @@ getKVStore<T extends KVStore>(storeId: string, options: Options, callback:
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| storeId | string | 是 | 数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
| options | [Options](#options) | 是 | 创建KVStore实例的配置信息。 |
......@@ -202,7 +202,7 @@ getKVStore<T extends KVStore>(storeId: string, options: Options): Promise&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------- | ---- | -------------------- |
| storeId | string | 是 | 数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
| options | [Options](#options) | 是 | 创建KVStore实例的配置信息。|
......@@ -250,7 +250,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | --------------------------- |
| appId | string | 是 | 所调用数据库方的包名。 |
| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
......@@ -295,7 +295,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------- |
| appId | string | 是 | 所调用数据库方的包名。 |
| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
......@@ -349,7 +349,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| appId | string | 是 | 所调用数据库方的包名。 |
| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
......@@ -392,7 +392,7 @@ deleteKVStore(appId: string, storeId: string): Promise<void>
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| appId | string | 是 | 所调用数据库方的包名。 |
| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
......@@ -446,7 +446,7 @@ getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| appId | string | 是 | 所调用数据库方的包名。 |
| callback | AsyncCallback<string[]> | 是 |回调函数。返回所有创建的KvStore数据库的storeId。 |
......@@ -476,7 +476,7 @@ getAllKVStoreId(appId: string): Promise<string[]>
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| appId | string | 是 | 所调用数据库方的包名。 |
......@@ -515,7 +515,7 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): voi
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event | string | 是 | 订阅的事件名，固定为'distributedDataServiceDie'，即服务状态变更事件。 |
| deathCallback | Callback<void> | 是 | 回调函数。 |
......@@ -546,7 +546,7 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event | string | 是 | 取消订阅的事件名，固定为'distributedDataServiceDie'，即服务状态变更事件。 |
| deathCallback | Callback<void> | 否 | 回调函数。 |
......@@ -573,15 +573,15 @@ try {
用于提供创建数据库的配置信息。
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| createIfMissing | boolean | 否 | 当数据库文件不存在时是否创建数据库，默认创建。 <br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| encrypt | boolean | 否 |设置数据库文件是否加密，默认不加密。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| backup | boolean | 否 |设置数据库文件是否备份，默认备份。 <br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| autoSync | boolean | 否 |设置数据库文件是否自动同步，默认不自动同步。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core<br>**需要权限**： ohos.permission.DISTRIBUTED_DATASYNC |
| kvStoreType | [KVStoreType](#kvstoretype) | 否 |设置要创建的数据库类型，默认为多设备协同数据库。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| securityLevel | [SecurityLevel](#securitylevel) | 否 |设置数据库安全级别，默认不设置安全级别。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| schema<sup>8+</sup> | [Schema](#schema8) | 否 | 设置定义存储在数据库中的值。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ------ | ------ | -------------------|
| createIfMissing | boolean | 是 | 是 | 当数据库文件不存在时是否创建数据库，默认创建。 <br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| encrypt | boolean | 是 | 是 |设置数据库文件是否加密，默认不加密。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| backup | boolean | 是 | 是 |设置数据库文件是否备份，默认备份。 <br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| autoSync | boolean | 是 | 是 |设置数据库文件是否自动同步，默认不自动同步。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core<br>**需要权限**： ohos.permission.DISTRIBUTED_DATASYNC |
| kvStoreType | [KVStoreType](#kvstoretype) | 是 | 是 |设置要创建的数据库类型，默认为多设备协同数据库。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| securityLevel | [SecurityLevel](#securitylevel) | 是 | 是 |设置数据库安全级别，默认不设置安全级别。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| schema<sup>8+</sup> | [Schema](#schema8) | 是 | 是 | 设置定义存储在数据库中的值。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
## KVStoreType
......@@ -631,12 +631,12 @@ KVStore常量。
**系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
| 名称 | 类型 | 说明 |
| --- | ---- | ----------------------- |
| root<sup>8+</sup> | [FieldNode](#fieldnode8) | 表示json根对象。 |
| indexes<sup>8+</sup> | Array\<string> | 表示json类型的字符串数组。 |
| mode<sup>8+</sup> | number | 表示Schema的模式。 |
| skip<sup>8+</sup> | number | Schema的跳跃大小。 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --- | ---- | ---- | ---- | ----------------------- |
| root<sup>8+</sup> | [FieldNode](#fieldnode8) | 是 | 是 | 表示json根对象。 |
| indexes<sup>8+</sup> | Array\<string> | 是 | 是 | 表示json类型的字符串数组。 |
| mode<sup>8+</sup> | number | 是 | 是 | 表示Schema的模式。 |
| skip<sup>8+</sup> | number | 是 | 是 | Schema的跳跃大小。 |
### constructor<sup>8+</sup>
......@@ -652,11 +652,11 @@ constructor()
**系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
| 名称 | 类型 | 说明 |
| --- | ---- | ----------------------- |
| nullable<sup>8+</sup> | boolean | 表示数据库字段是否可以为空。 |
| default<sup>8+</sup> | string | 表示Fieldnode的默认值。 |
| type<sup>8+</sup> | number | 表示指定节点对应数据类型的值。 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --- | ---- | ---- | ---- | ----------------------- |
| nullable<sup>8+</sup> | boolean | 是 | 是 | 表示数据库字段是否可以为空。 |
| default<sup>8+</sup> | string | 是 | 是 | 表示Fieldnode的默认值。 |
| type<sup>8+</sup> | number | 是 | 是 | 表示指定节点对应数据类型的值。 |
### constructor<sup>8+</sup>
......@@ -668,7 +668,7 @@ constructor(name: string)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | --------------- |
| name | string | 是 | FieldNode的值。 |
......@@ -682,7 +682,7 @@ appendChild(child: FieldNode): boolean
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| child | [FieldNode](#fieldnode8) | 是 | 要附加的域节点。 |
......@@ -935,7 +935,7 @@ move(offset: number): boolean
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| offset | number | 是 | 表示与当前位置的相对偏移量，负偏移表示向后移动，正偏移表示向前移动。 |
......@@ -975,7 +975,7 @@ moveToPosition(position: number): boolean
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| position | number | 是 |表示绝对位置。 |
......@@ -1230,7 +1230,7 @@ equalTo(field: string, value: number|string|boolean): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string\|boolean | 是 | 表示指定的值。|
......@@ -1265,7 +1265,7 @@ notEqualTo(field: string, value: number|string|boolean): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string\|boolean | 是 | 表示指定的值。|
......@@ -1300,7 +1300,7 @@ greaterThan(field: string, value: number|string|boolean): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string\|boolean | 是 | 表示指定的值。|
......@@ -1335,10 +1335,10 @@ lessThan(field: string, value: number|string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string\|boolean | 是 | 表示指定的值。|
| value | number\|string | 是 | 表示指定的值。|
**返回值：**
......@@ -1370,10 +1370,10 @@ greaterThanOrEqualTo(field: string, value: number|string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string\|boolean | 是 | 表示指定的值。|
| value | number\|string | 是 | 表示指定的值。|
**返回值：**
......@@ -1405,10 +1405,10 @@ lessThanOrEqualTo(field: string, value: number|string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string\|boolean | 是 | 表示指定的值。|
| value | number\|string | 是 | 表示指定的值。|
**返回值：**
......@@ -1440,7 +1440,7 @@ isNull(field: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
......@@ -1475,7 +1475,7 @@ inNumber(field: string, valueList: number[]): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| valueList | number[] | 是 | 表示指定的值列表。|
......@@ -1510,7 +1510,7 @@ inString(field: string, valueList: string[]): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| valueList | string[] | 是 | 表示指定的字符串值列表。|
......@@ -1545,7 +1545,7 @@ notInNumber(field: string, valueList: number[]): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| valueList | number[] | 是 | 表示指定的值列表。|
......@@ -1580,7 +1580,7 @@ notInString(field: string, valueList: string[]): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| valueList | string[] | 是 | 表示指定的字符串值列表。|
......@@ -1615,7 +1615,7 @@ like(field: string, value: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | string | 是 | 表示指定的字符串值。|
......@@ -1650,7 +1650,7 @@ unlike(field: string, value: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | string | 是 | 表示指定的字符串值。|
......@@ -1745,7 +1745,7 @@ orderByAsc(field: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
......@@ -1780,7 +1780,7 @@ orderByDesc(field: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
......@@ -1815,7 +1815,7 @@ limit(total: number, offset: number): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| total | number | 是 |表示指定的结果数。 |
| offset | number | 是 |表示起始位置。 |
......@@ -1853,7 +1853,7 @@ isNotNull(field: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
......@@ -1947,7 +1947,7 @@ prefixKey(prefix: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| prefix | string | 是 |表示指定的键前缀。 |
......@@ -1982,7 +1982,7 @@ setSuggestIndex(index: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| index | string | 是 |指示要设置的索引。 |
......@@ -2017,7 +2017,7 @@ deviceId(deviceId:string):Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId | string | 是 |指示查询的设备ID。 |
......@@ -2084,7 +2084,7 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key | string | 是 |要添加数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| value | Uint8Array \| string \| number \| boolean | 是 |要添加数据的value，支持Uint8Array、number 、 string 、boolean，Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#constants)。 |
......@@ -2119,7 +2119,7 @@ put(key: string, value: Uint8Array | string | number | boolean): Promise&lt;void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key | string | 是 |要添加数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| value | Uint8Array \| string \| number \| boolean | 是 |要添加数据的value，支持Uint8Array、number 、 string 、boolean，Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#constants)。 |
......@@ -2157,7 +2157,7 @@ delete(key: string, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key | string | 是 |要删除数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback | AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -2198,7 +2198,7 @@ delete(key: string): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key | string | 是 |要删除数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
......@@ -2240,7 +2240,7 @@ on(event: 'dataChange', type: SubscribeType, listener: Callback&lt;ChangeNotific
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event |string | 是 |订阅的事件名，固定为'dataChange'，表示数据变更事件。 |
| type |[SubscribeType](#subscribetype) | 是 |表示订阅的类型。 |
......@@ -2265,7 +2265,7 @@ on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event |string | 是 |订阅的事件名，固定为'syncComplete'，表示同步完成事件。 |
| syncCallback |Callback&lt;Array&lt;[string, number]&gt;&gt; | 是 |回调函数。 |
......@@ -2289,7 +2289,7 @@ off(event:'dataChange', listener?: Callback&lt;ChangeNotification&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event |string | 是 |取消订阅的事件名，固定为'dataChange'，表示数据变更事件。 |
| listener |Callback&lt;[ChangeNotification](#changenotification)&gt; |否 |回调函数。 |
......@@ -2325,7 +2325,7 @@ putBatch(entries: Entry[], callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| entries |[Entry](#entry)[] | 是 |表示要批量插入的键值对。 |
| callback |Asyncallback&lt;void&gt; |是 |回调函数。 |
......@@ -2372,7 +2372,7 @@ putBatch(entries: Entry[]): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| entries |[Entry](#entry)[] | 是 |表示要批量插入的键值对。 |
......@@ -2426,7 +2426,7 @@ deleteBatch(keys: string[], callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| keys |string[] | 是 |表示要批量删除的键值对。 |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -2473,7 +2473,7 @@ deleteBatch(keys: string[]): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| keys |string[] | 是 |表示要批量删除的键值对。 |
......@@ -2529,7 +2529,7 @@ startTransaction(callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -2616,7 +2616,7 @@ commit(callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -2678,7 +2678,7 @@ rollback(callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -2740,7 +2740,7 @@ enableSync(enabled: boolean, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| enabled |boolean | 是 |设定是否开启同步，true表示开启同步，false表示不启用同步。 |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -2773,7 +2773,7 @@ enableSync(enabled: boolean): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| enabled |boolean | 是 |设定是否开启同步，true表示开启同步，false表示不启用同步。 |
......@@ -2809,7 +2809,7 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: Asy
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| localLabels |string[] | 是 |表示本地设备的同步标签。 |
| remoteSupportLabels |string[] | 是 |表示要同步数据的设备的同步标签。 |
......@@ -2841,7 +2841,7 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise&lt;v
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| localLabels |string[] | 是 |表示本地设备的同步标签。 |
| remoteSupportLabels |string[] | 是 |表示要同步数据的设备的同步标签。 |
......@@ -2889,7 +2889,7 @@ try {
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
| 名称 | 参数类型 |可读 |可写 | 说明 |
| 名称 | 类型 |可读 |可写 | 说明 |
| ----- | ------- | -----| ------|------------------------ |
| insertEntries | [Entry](#entry)[] | 是 | 是 |数据添加记录。 |
| updateEntries | [Entry](#entry)[] | 是 | 是 |数据更新记录。 |
......@@ -2902,7 +2902,7 @@ try {
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
| 名称 | 参数类型 |可读 |可写 | 说明 |
| 名称 | 类型 |可读 |可写 | 说明 |
| ----- | ------- | -----| ------|------------------------ |
| key | string | 是 | 是 |键值。 |
| value | [Value](#value) | 是 | 是 |值对象。 |
......@@ -2914,7 +2914,7 @@ try {
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
| 名称 | 参数类型 |可读 |可写 | 说明 |
| 名称 | 类型 |可读 |可写 | 说明 |
| ----- | ------- | -----| ------|------------------------ |
| type | [ValueType](#value) | 是 | 是 |值类型。 |
| value | Uint8Array \| string \| number \| boolean| 是 | 是 |值。 |
......@@ -2952,7 +2952,7 @@ get(key: string, callback: AsyncCallback&lt;Uint8Array | string | boolean | numb
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key |string | 是 |要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback |AsyncCallback&lt;Uint8Array \| string \| boolean \| number&gt;) | 是 |回调函数。返回获取查询的值。 |
......@@ -2990,7 +2990,7 @@ get(key: string): Promise&lt;Uint8Array | string | boolean | number&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key |string | 是 |要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
......@@ -3033,7 +3033,7 @@ getEntries(keyPrefix: string, callback: AsyncCallback&lt;Entry[]&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| keyPrefix |string | 是 |表示要匹配的键前缀。 |
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | 是 |回调函数。返回匹配指定前缀的键值对列表。 |
......@@ -3079,7 +3079,7 @@ getEntries(keyPrefix: string): Promise&lt;Entry[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| keyPrefix |string | 是 |表示要匹配的键前缀。 |
......@@ -3137,7 +3137,7 @@ getEntries(query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示要匹配的键前缀。 |
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | 是 |回调函数。返回与指定Query对象匹配的键值对列表。 |
......@@ -3188,7 +3188,7 @@ getEntries(query: Query): Promise&lt;Entry[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -3246,7 +3246,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback&lt;KvStoreResultSet&gt;)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| keyPrefix |string | 是 |表示要匹配的键前缀。 |
| callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | 是 |回调函数。返回具有指定前缀的结果集。 |
......@@ -3295,7 +3295,7 @@ getResultSet(keyPrefix: string): Promise&lt;KvStoreResultSet&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| keyPrefix |string | 是 |表示要匹配的键前缀。 |
......@@ -3355,7 +3355,7 @@ getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): voi
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |Query | 是 |表示查询对象。 |
| callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | 是 |回调函数，获取与指定Query对象匹配的KvStoreResultSet对象。 |
......@@ -3403,7 +3403,7 @@ getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -3459,7 +3459,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback&lt;void&gt;)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| resultSet |[KvStoreResultSet](#kvstoreresultset8) | 是 |表示要关闭的KvStoreResultSet对象。 |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -3493,7 +3493,7 @@ closeResultSet(resultSet: KvStoreResultSet): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| resultSet |[KvStoreResultSet](#kvstoreresultset8) | 是 |表示要关闭的KvStoreResultSet对象。 |
......@@ -3530,7 +3530,7 @@ getResultSize(query: Query, callback: AsyncCallback&lt;number&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
| callback |AsyncCallback&lt;number&gt; | 是 |回调函数。返回与指定Query对象匹配的结果数。 |
......@@ -3576,7 +3576,7 @@ getResultSize(query: Query): Promise&lt;number&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -3631,7 +3631,7 @@ removeDeviceData(deviceId: string, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |表示要删除设备的名称。 |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -3673,7 +3673,7 @@ removeDeviceData(deviceId: string): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |表示要删除设备的名称。 |
......@@ -3722,7 +3722,7 @@ on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event |string | 是 |订阅的事件名，固定为'syncComplete'，表示同步完成事件。 |
| syncCallback |Callback&lt;Array&lt;[string, number]&gt;&gt; | 是 |回调函数。用于向调用方发送同步结果的回调。 |
......@@ -3758,7 +3758,7 @@ off(event: 'syncComplete', syncCallback?: Callback&lt;Array&lt;[string, number]&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event |string | 是 |取消订阅的事件名，固定为'syncComplete'，表示同步完成事件。 |
| syncCallback |Callback&lt;Array&lt;[string, number]&gt;&gt; | 否 |回调函数。用于向调用方发送同步结果的回调。 |
......@@ -3797,7 +3797,7 @@ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceIds |string[] | 是 |同一组网环境下，需要同步的设备的deviceId列表。 |
| mode |[SyncMode](#syncmode) | 是 |同步模式。 |
......@@ -3820,7 +3820,7 @@ setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback&lt;void&gt;)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| defaultAllowedDelayMs |number | 是 |表示数据库同步允许的默认延迟，以毫秒为单位。 |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -3850,7 +3850,7 @@ setSyncParam(defaultAllowedDelayMs: number): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| defaultAllowedDelayMs |number | 是 |表示数据库同步允许的默认延迟，以毫秒为单位。 |
......@@ -3888,7 +3888,7 @@ getSecurityLevel(callback: AsyncCallback&lt;SecurityLevel&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| callback |AsyncCallback&lt;[SecurityLevel](#securitylevel)&gt; | 是 |回调函数。返回数据库的安全级别。 |
......@@ -3956,7 +3956,7 @@ get(deviceId: string, key: string, callback: AsyncCallback&lt;boolean|string|num
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要查询其数据的设备。 |
| key |string | 是 |表示要查询key值的键。 |
......@@ -3991,7 +3991,7 @@ get(deviceId: string, key: string): Promise&lt;boolean|string|number|Uint8Array&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要查询其数据的设备。 |
| key |string | 是 |表示要查询key值的键。 |
......@@ -4035,7 +4035,7 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;Entry
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要查询其数据的设备。 |
| keyPrefix |string | 是 |表示要匹配的键前缀。 |
......@@ -4083,7 +4083,7 @@ getEntries(deviceId: string, keyPrefix: string): Promise&lt;Entry[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要查询其数据的设备。 |
| keyPrefix |string | 是 |表示要匹配的键前缀。 |
......@@ -4142,7 +4142,7 @@ getEntries(query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | 是 |回调函数，返回与指定Query对象匹配的键值对列表。 |
......@@ -4194,7 +4194,7 @@ getEntries(query: Query): Promise&lt;Entry[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -4252,7 +4252,7 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback&lt;Entry[]&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |键值对所属的设备ID。 |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -4305,7 +4305,7 @@ getEntries(deviceId: string, query: Query): Promise&lt;Entry[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |键值对所属的设备ID。 |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -4365,7 +4365,7 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;KvS
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要查询其数据的设备。 |
| keyPrefix |string | 是 |表示要匹配的键前缀。 |
......@@ -4400,7 +4400,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise&lt;KvStoreResultSet&g
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要查询其数据的设备。 |
| keyPrefix |string | 是 |表示要匹配的键前缀。 |
......@@ -4444,7 +4444,7 @@ getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): voi
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
| callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; | 是 |回调函数，返回与指定Query对象匹配的KvStoreResultSet对象。 |
......@@ -4496,7 +4496,7 @@ getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -4560,7 +4560,7 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback&lt;KvStoreR
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -4612,7 +4612,7 @@ getResultSet(deviceId: string, query: Query): Promise&lt;KvStoreResultSet&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -4678,7 +4678,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback&lt;void&gt;)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| resultSet |[KvStoreResultSet](#getresultset8) | 是 |指示要关闭的KvStoreResultSet对象。 |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -4713,7 +4713,7 @@ closeResultSet(resultSet: KvStoreResultSet): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| resultSet |[KvStoreResultSet](#getresultset8) | 是 |指示要关闭的KvStoreResultSet对象。 |
......@@ -4751,7 +4751,7 @@ getResultSize(query: Query, callback: AsyncCallback&lt;number&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
| callback |AsyncCallback&lt;number&gt; | 是 |回调函数，返回与指定Query对象匹配的结果数。 |
......@@ -4798,7 +4798,7 @@ getResultSize(query: Query): Promise&lt;number&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -4854,7 +4854,7 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback&lt;number&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -4901,7 +4901,7 @@ getResultSize(deviceId: string, query: Query): Promise&lt;number&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 |
| query |[Query](#query8) | 是 |表示查询对象。 |
......@@ -4957,7 +4957,7 @@ removeDeviceData(deviceId: string, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要删除其数据的设备。 |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
......@@ -4999,7 +4999,7 @@ removeDeviceData(deviceId: string): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要删除其数据的设备。 |
......@@ -5050,7 +5050,7 @@ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceIds |string[] | 是 |需要同步DeviceKvStore数据库的设备ID列表。 |
| mode |[SyncMode](#syncmode) | 是 |同步模式。 |
......@@ -5087,7 +5087,7 @@ on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event |string | 是 |订阅的事件名，固定为'syncComplete'，表示同步完成事件。 |
| syncCallback |Callback<Array&lt;[string, number]&gt;> | 是 |回调函数。用于向调用方发送同步结果的回调。 |
......@@ -5123,7 +5123,7 @@ off(event: 'syncComplete', syncCallback?: Callback&lt;Array&lt;[string, number]&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| event |string | 是 |取消订阅的事件名，固定为'syncComplete'，表示同步完成事件。 |
| syncCallback |Callback<Array&lt;[string, number]&gt;&gt; | 否 |回调函数。用于向调用方发送同步结果的回调。 |
......
zh-cn/application-dev/reference/apis/js-apis-distributedKVStore.md
浏览文件 @ 6e9991ab
......@@ -26,10 +26,10 @@ import distributedKVStore from '@ohos.data.distributedKVStore';
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
| 参数名 | 参数类型 | 必填 | 说明 |
| ---------- | --------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-Context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| bundleName | string | 是 | 调用方的包名。 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- | --------------------- | ---- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 是 |应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-Context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| bundleName | string | 是 | 是 | 调用方的包名。 |
## Constants
......@@ -67,7 +67,7 @@ import distributedKVStore from '@ohos.data.distributedKVStore';
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
| 名称 | 参数类型 |可读 |可写 | 说明 |
| 名称 | 类型 |可读 |可写 | 说明 |
| ----- | ------- | -----| ------|------------------------ |
| type | [ValueType](#valuetype) | 是 | 是 |值类型。 |
| value | Uint8Array \| string \| number \| boolean| 是 | 是 |值。 |
......@@ -78,7 +78,7 @@ import distributedKVStore from '@ohos.data.distributedKVStore';
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | --------------- | ---- | ---- | -------- |
| key | string | 是 | 是 | 键值。 |
| value | [Value](#value) | 是 | 是 | 值对象。 |
......@@ -89,7 +89,7 @@ import distributedKVStore from '@ohos.data.distributedKVStore';
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------- | ----------------- | ---- | ---- | ------------------------ |
| insertEntries | [Entry](#entry)[] | 是 | 是 | 数据添加记录。 |
| updateEntries | [Entry](#entry)[] | 是 | 是 | 数据更新记录。 |
......@@ -146,15 +146,15 @@ import distributedKVStore from '@ohos.data.distributedKVStore';
用于提供创建数据库的配置信息。
| 参数名 | 参数类型 | 必填 | 说明 |
| --------------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| createIfMissing | boolean | 否 | 当数据库文件不存在时是否创建数据库，默认创建。 <br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| encrypt | boolean | 否 | 设置数据库文件是否加密，默认不加密。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| backup | boolean | 否 | 设置数据库文件是否备份，默认备份。 <br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| autoSync | boolean | 否 | 设置数据库文件是否自动同步，默认不自动同步。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core<br>**需要权限**： ohos.permission.DISTRIBUTED_DATASYNC |
| kvStoreType | [KVStoreType](#kvstoretype) | 否 | 设置要创建的数据库类型，默认为多设备协同数据库。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| securityLevel | [SecurityLevel](#securitylevel) | 是 | 设置数据库安全级别。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| schema | [Schema](#schema) | 否 | 设置定义存储在数据库中的值，默认不使用Schema。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------- | ------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| createIfMissing | boolean | 是 | 是 | 当数据库文件不存在时是否创建数据库，默认创建。 <br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| encrypt | boolean | 是 | 是 | 设置数据库文件是否加密，默认不加密。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| backup | boolean | 是 | 是 | 设置数据库文件是否备份，默认备份。 <br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| autoSync | boolean | 是 | 是 | 设置数据库文件是否自动同步，默认不自动同步。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core<br>**需要权限**： ohos.permission.DISTRIBUTED_DATASYNC |
| kvStoreType | [KVStoreType](#kvstoretype) | 是 | 是 | 设置要创建的数据库类型，默认为多设备协同数据库。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| securityLevel | [SecurityLevel](#securitylevel) | 是 | 是 |设置数据库安全级别。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core |
| schema | [Schema](#schema) | 是 | 是 | 设置定义存储在数据库中的值，默认不使用Schema。<br>**系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
## Schema
......@@ -162,12 +162,12 @@ import distributedKVStore from '@ohos.data.distributedKVStore';
**系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
| 名称 | 类型 | 说明 |
| ------- | ----------------------- | -------------------------- |
| root | [FieldNode](#fieldnode) | 表示json根对象。 |
| indexes | Array\<string> | 表示json类型的字符串数组。 |
| mode | number | 表示Schema的模式。 |
| skip | number | Schema的跳跃大小。 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------- | ----------------------- | ---- | ---- | -------------------------- |
| root | [FieldNode](#fieldnode) | 是 | 是 | 表示json根对象。 |
| indexes | Array\<string> | 是 | 是 | 表示json类型的字符串数组。 |
| mode | number | 是 | 是 | 表示Schema的模式。 |
| skip | number | 是 | 是 | Schema的跳跃大小。 |
### constructor
......@@ -183,11 +183,11 @@ constructor()
**系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
| 名称 | 类型 | 说明 |
| -------- | ------- | ------------------------------ |
| nullable | boolean | 表示数据库字段是否可以为空。 |
| default | string | 表示Fieldnode的默认值。 |
| type | number | 表示指定节点对应数据类型的值。 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | ------- | ---- | ---- | ------------------------------ |
| nullable | boolean | 是 | 是 | 表示数据库字段是否可以为空。 |
| default | string | 是 | 是 | 表示Fieldnode的默认值。 |
| type | number | 是 | 是 | 表示指定节点对应数据类型的值。 |
### constructor
......@@ -199,7 +199,7 @@ constructor(name: string)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | --------------- |
| name | string | 是 | FieldNode的值。 |
......@@ -213,7 +213,7 @@ appendChild(child: FieldNode): boolean
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------- |
| child | [FieldNode](#fieldnode) | 是 | 要附加的域节点。 |
......@@ -256,7 +256,7 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback&lt;KVManager&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------- | ---- | ----------------------------------------------------------- |
| config | [KVManagerConfig](#kvmanagerconfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和应用上下文。 |
| callback | AsyncCallback&lt;[KVManager](#kvmanager)&gt; | 是 | 回调函数。返回创建的KVManager对象实例。 |
......@@ -326,7 +326,7 @@ createKVManager(config: KVManagerConfig): Promise&lt;KVManager&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | --------------------------------------------------------- |
| config | [KVManagerConfig](#kvmanager) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 |
......@@ -401,7 +401,7 @@ getKVStore&lt;T &gt;(storeId: string, options: Options, callback: AsyncCallback&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| storeId | string | 是 | 数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
| options | [Options](#options) | 是 | 创建分布式键值实例的配置信息。 |
......@@ -453,7 +453,7 @@ getKVStore&lt;T &gt;(storeId: string, options: Options): Promise&lt;T&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------- | ---- | ------------------------------------------------------------ |
| storeId | string | 是 | 数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
| options | [Options](#options) | 是 | 创建分布式键值实例的配置信息。 |
......@@ -508,7 +508,7 @@ closeKVStore(appId: string, storeId: string, callback: AsyncCallback&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| appId | string | 是 | 所调用数据库方的包名。 |
| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
......@@ -541,7 +541,7 @@ try {
});
});
} catch (e) {
console.error(`An unexpected error occurred.code is ${err.code},message is ${err.message}`);
console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}
```
......@@ -555,7 +555,7 @@ closeKVStore(appId: string, storeId: string): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | ------------------------------------------------------------ |
| appId | string | 是 | 所调用数据库方的包名。 |
| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
......@@ -607,7 +607,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback&lt;void&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| appId | string | 是 | 所调用数据库方的包名。 |
| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
......@@ -666,7 +666,7 @@ deleteKVStore(appId: string, storeId: string): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | ------------------------------------------------------------ |
| appId | string | 是 | 所调用数据库方的包名。 |
| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
......@@ -726,7 +726,7 @@ getAllKVStoreId(appId: string, callback: AsyncCallback&lt;string[]&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | --------------------------------------------------- |
| appId | string | 是 | 所调用数据库方的包名。 |
| callback | AsyncCallback&lt;string[]&gt; | 是 | 回调函数。返回所有创建的分布式键值数据库的storeId。 |
......@@ -738,7 +738,7 @@ let kvManager;
try {
kvManager.getAllKVStoreId('appId', function (err, data) {
if (err != undefined) {
console.error(`Fail to get AllKVStoreId.code is ${e.code},message is ${e.message}`);
console.error(`Fail to get AllKVStoreId.code is ${err.code},message is ${err.message}`);
return;
}
console.log('Succeeded in getting AllKVStoreId');
......@@ -759,7 +759,7 @@ getAllKVStoreId(appId: string): Promise&lt;string[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ---------------------- |
| appId | string | 是 | 所调用数据库方的包名。 |
......@@ -796,7 +796,7 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback&lt;void&gt;): voi
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------------------- | ---- | ------------------------------------------------------------ |
| event | string | 是 | 订阅的事件名，固定为'distributedDataServiceDie'，即服务状态变更事件。 |
| deathCallback | Callback&lt;void&gt; | 是 | 回调函数。 |
......@@ -826,7 +826,7 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback&lt;void&gt;): v
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------------------- | ---- | ------------------------------------------------------------ |
| event | string | 是 | 取消订阅的事件名，固定为'distributedDataServiceDie'，即服务状态变更事件。 |
| deathCallback | Callback&lt;void&gt; | 否 | 回调函数。 |
......@@ -1060,7 +1060,7 @@ move(offset: number): boolean
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| offset | number | 是 | 表示与当前位置的相对偏移量，负偏移表示向后移动，正偏移表示向前移动。 |
......@@ -1099,7 +1099,7 @@ moveToPosition(position: number): boolean
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | -------------- |
| position | number | 是 | 表示绝对位置。 |
......@@ -1346,7 +1346,7 @@ equalTo(field: string, value: number|string|boolean): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string\|boolean | 是 | 表示指定的值。|
......@@ -1380,7 +1380,7 @@ notEqualTo(field: string, value: number|string|boolean): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string\|boolean | 是 | 表示指定的值。|
......@@ -1413,7 +1413,7 @@ greaterThan(field: string, value: number|string|boolean): Query
**系统能力：** SystemCapability.DistributedDataManager.KVStore.Core
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string\|boolean | 是 | 表示指定的值。|
......@@ -1448,7 +1448,7 @@ lessThan(field: string, value: number|string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string | 是 | 表示指定的值。|
......@@ -1483,7 +1483,7 @@ greaterThanOrEqualTo(field: string, value: number|string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string | 是 | 表示指定的值。|
......@@ -1518,7 +1518,7 @@ lessThanOrEqualTo(field: string, value: number|string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，不能包含' ^ '。 |
| value | number\|string | 是 | 表示指定的值。|
......@@ -1552,7 +1552,7 @@ isNull(field: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
......@@ -1585,7 +1585,7 @@ inNumber(field: string, valueList: number[]): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
| valueList | number[] | 是 | 表示指定的值列表。 |
......@@ -1619,7 +1619,7 @@ inString(field: string, valueList: string[]): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
| valueList | string[] | 是 | 表示指定的字符串值列表。 |
......@@ -1653,7 +1653,7 @@ notInNumber(field: string, valueList: number[]): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
| valueList | number[] | 是 | 表示指定的值列表。 |
......@@ -1687,7 +1687,7 @@ notInString(field: string, valueList: string[]): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
| valueList | string[] | 是 | 表示指定的字符串值列表。 |
......@@ -1721,7 +1721,7 @@ like(field: string, value: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
| value | string | 是 | 表示指定的字符串值。 |
......@@ -1755,7 +1755,7 @@ unlike(field: string, value: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
| value | string | 是 | 表示指定的字符串值。 |
......@@ -1847,7 +1847,7 @@ orderByAsc(field: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
......@@ -1881,7 +1881,7 @@ orderByDesc(field: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
......@@ -1915,7 +1915,7 @@ limit(total: number, offset: number): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------ |
| total | number | 是 | 表示指定的结果数。 |
| offset | number | 是 | 表示起始位置。 |
......@@ -1952,7 +1952,7 @@ isNotNull(field: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ----------------------------- |
| fieId | string | 是 | 表示指定字段，不能包含' ^ '。 |
......@@ -2043,7 +2043,7 @@ prefixKey(prefix: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------ |
| prefix | string | 是 | 表示指定的键前缀。 |
......@@ -2077,7 +2077,7 @@ setSuggestIndex(index: string): Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------ |
| index | string | 是 | 指示要设置的索引。 |
......@@ -2111,7 +2111,7 @@ deviceId(deviceId:string):Query
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------ |
| deviceId | string | 是 | 指示查询的设备ID。 |
......@@ -2175,7 +2175,7 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key | string | 是 |要添加数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| value | Uint8Array \| string \| number \| boolean | 是 |要添加数据的value，支持Uint8Array、number 、 string 、boolean，Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#constants)。 |
......@@ -2219,7 +2219,7 @@ put(key: string, value: Uint8Array | string | number | boolean): Promise&lt;void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key | string | 是 |要添加数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| value | Uint8Array \| string \| number \| boolean | 是 |要添加数据的value，支持Uint8Array、number 、 string 、boolean，Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#constants)。 |
......@@ -2266,7 +2266,7 @@ putBatch(entries: Entry[], callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------ |
| entries | [Entry](#entry)[] | 是 | 表示要批量插入的键值对。 |
| callback | Asyncallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -2328,7 +2328,7 @@ putBatch(entries: Entry[]): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | ------------------------ |
| entries | [Entry](#entry)[] | 是 | 表示要批量插入的键值对。 |
......@@ -2393,7 +2393,7 @@ putBatch(value: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;void&gt;):
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ |
| value | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 表示要插入的数据。 |
| callback | Asyncallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -2445,7 +2445,7 @@ putBatch(value: Array&lt;ValuesBucket&gt;): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------------------------------------ | ---- | ------------------ |
| value | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 表示要插入的数据。 |
......@@ -2498,7 +2498,7 @@ delete(key: string, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| key | string | 是 | 要删除数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -2535,7 +2535,7 @@ try {
});
});
} catch (e) {
console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`;
console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}
```
......@@ -2549,7 +2549,7 @@ delete(key: string): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| key | string | 是 | 要删除数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
......@@ -2603,7 +2603,7 @@ delete(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallb
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时，应定义处理逻辑。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -2649,7 +2649,7 @@ delete(predicates: dataSharePredicates.DataSharePredicates): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时，应定义处理逻辑。 |
......@@ -2704,7 +2704,7 @@ deleteBatch(keys: string[], callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------ |
| keys | string[] | 是 | 表示要批量删除的键值对。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -2768,7 +2768,7 @@ deleteBatch(keys: string[]): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------ |
| keys | string[] | 是 | 表示要批量删除的键值对。 |
......@@ -2833,7 +2833,7 @@ removeDeviceData(deviceId: string, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------- |
| deviceId | string | 是 | 表示要删除设备的名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -2882,7 +2882,7 @@ removeDeviceData(deviceId: string): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ---------------------- |
| deviceId | string | 是 | 表示要删除设备的名称。 |
......@@ -2938,10 +2938,10 @@ get(key: string, callback: AsyncCallback<boolean | string| number | Uint8Array>)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key |string | 是 |要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback |AsyncCallback&lt;Uint8Array \| string \| boolean \| number&gt;) | 是 |回调函数。返回获取查询的值。 |
| callback |AsyncCallback&lt;boolean \| string \| number \| Uint8Array&gt;) | 是 |回调函数。返回获取查询的值。 |
**错误码：**
......@@ -2989,7 +2989,7 @@ get(key: string): Promise&lt;boolean | string| number | Uint8Array&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| key | string | 是 | 要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
......@@ -3041,7 +3041,7 @@ getEntries(keyPrefix: string, callback: AsyncCallback&lt;Entry[]&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | ---------------------------------------- |
| keyPrefix | string | 是 | 表示要匹配的键前缀。 |
| callback | AsyncCallback&lt;[Entry](#entry)[]&gt; | 是 | 回调函数。返回匹配指定前缀的键值对列表。 |
......@@ -3104,7 +3104,7 @@ getEntries(keyPrefix: string): Promise&lt;Entry[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | -------------------- |
| keyPrefix | string | 是 | 表示要匹配的键前缀。 |
......@@ -3167,7 +3167,7 @@ getEntries(query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ----------------------------------------------- |
| query | [Query](query) | 是 | 表示要匹配的键前缀。 |
| callback | AsyncCallback&lt;[Entry](#entry)[]&gt; | 是 | 回调函数。返回与指定Query对象匹配的键值对列表。 |
......@@ -3230,7 +3230,7 @@ getEntries(query: Query): Promise&lt;Entry[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | -------------- |
| query | [Query](query) | 是 | 表示查询对象。 |
......@@ -3297,7 +3297,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback&lt;KVStoreResultSet&gt;)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------------------------- | ---- | ------------------------------------ |
| keyPrefix | string | 是 | 表示要匹配的键前缀。 |
| callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | 是 | 回调函数。返回具有指定前缀的结果集。 |
......@@ -3366,7 +3366,7 @@ getResultSet(keyPrefix: string): Promise&lt;KVStoreResultSet&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | -------------------- |
| keyPrefix | string | 是 | 表示要匹配的键前缀。 |
......@@ -3434,7 +3434,7 @@ getResultSet(query: Query, callback: AsyncCallback&lt;KVStoreResultSet&gt;): voi
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------------- | ---- | --------------------------------------------------------- |
| query | Query | 是 | 表示查询对象。 |
| callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | 是 | 回调函数，获取与指定Query对象匹配的KVStoreResultSet对象。 |
......@@ -3497,7 +3497,7 @@ getResultSet(query: Query): Promise&lt;KVStoreResultSet&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | -------------- |
| query | [Query](query) | 是 | 表示查询对象。 |
......@@ -3564,7 +3564,7 @@ getResultSet(predicates: dataSharePredicates.DataSharePredicates, callback: Asyn
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时，应定义处理逻辑。 |
| callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | 是 | 回调函数，获取与指定Predicates对象匹配的KVStoreResultSet对象。 |
......@@ -3620,7 +3620,7 @@ getResultSet(predicates: dataSharePredicates.DataSharePredicates): Promise&lt;KV
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时，应定义处理逻辑。 |
......@@ -3675,7 +3675,7 @@ closeResultSet(resultSet: KVStoreResultSet, callback: AsyncCallback&lt;void&gt;)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------- | ---- | ---------------------------------- |
| resultSet | [KVStoreResultSet](#kvstoreresultset) | 是 | 表示要关闭的KVStoreResultSet对象。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -3708,7 +3708,7 @@ closeResultSet(resultSet: KVStoreResultSet): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------- | ---- | ---------------------------------- |
| resultSet | [KVStoreResultSet](#kvstoreresultset) | 是 | 表示要关闭的KVStoreResultSet对象。 |
......@@ -3744,7 +3744,7 @@ getResultSize(query: Query, callback: AsyncCallback&lt;number&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------- |
| query | [Query](query) | 是 | 表示查询对象。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回与指定Query对象匹配的结果数。 |
......@@ -3802,7 +3802,7 @@ getResultSize(query: Query): Promise&lt;number&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | -------------- |
| query | [Query](query) | 是 | 表示查询对象。 |
......@@ -3865,7 +3865,7 @@ backup(file:string, callback: AsyncCallback&lt;void&gt;):void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| file | string | 是 | 备份数据库的指定名称，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当以指定名称备份数据库成功，err为undefined，否则为错误对象。 |
......@@ -3907,7 +3907,7 @@ backup(file:string): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| file | string | 是 | 备份数据库的指定名称，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
......@@ -3952,7 +3952,7 @@ restore(file:string, callback: AsyncCallback&lt;void&gt;):void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| file | string | 是 | 指定的数据库文件名称，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当从指定的数据库文件恢复数据库成功，err为undefined，否则为错误对象。 |
......@@ -3994,7 +3994,7 @@ restore(file:string): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| file | string | 是 | 指定的数据库文件名称，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
......@@ -4039,7 +4039,7 @@ deleteBackup(files:Array&lt;string&gt;, callback: AsyncCallback&lt;Array&lt;[str
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ |
| files | Array&lt;string&gt; | 是 | 删除备份文件所指定的名称，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback | AsyncCallback&lt;Array&lt;[string, number]&gt;&gt; | 是 | 回调函数，返回删除备份的文件名及其处理结果。 |
......@@ -4072,7 +4072,7 @@ deleteBackup(files:Array&lt;string&gt;): Promise&lt;Array&lt;[string, number]&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------- | ---- | ------------------------------------------------------------ |
| files | Array&lt;string&gt; | 是 | 删除备份文件所指定的名称，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
......@@ -4108,7 +4108,7 @@ startTransaction(callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -4147,7 +4147,7 @@ try {
});
kvStore.startTransaction(async function (err, data) {
if (err != undefined) {
console.error(`Fail to start Transaction.code is ${e.code},message is ${e.message}`);
console.error(`Fail to start Transaction.code is ${err.code},message is ${err.message}`);
return;
}
console.log('Succeeded in starting Transaction');
......@@ -4155,7 +4155,7 @@ try {
console.log(`entries: ${entries}`);
kvStore.putBatch(entries, async function (err, data) {
if (err != undefined) {
console.error(`Fail to put batch.code is ${e.code},message is ${e.message}`);
console.error(`Fail to put batch.code is ${err.code},message is ${err.message}`);
return;
}
console.log('Succeeded in putting Batch');
......@@ -4218,7 +4218,7 @@ commit(callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -4294,7 +4294,7 @@ rollback(callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -4370,7 +4370,7 @@ enableSync(enabled: boolean, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------------------------------------------------- |
| enabled | boolean | 是 | 设定是否开启同步，true表示开启同步，false表示不启用同步。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -4402,7 +4402,7 @@ enableSync(enabled: boolean): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | --------------------------------------------------------- |
| enabled | boolean | 是 | 设定是否开启同步，true表示开启同步，false表示不启用同步。 |
......@@ -4437,7 +4437,7 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: Asy
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------------- | ------------------------- | ---- | -------------------------------- |
| localLabels | string[] | 是 | 表示本地设备的同步标签。 |
| remoteSupportLabels | string[] | 是 | 表示要同步数据的设备的同步标签。 |
......@@ -4472,7 +4472,7 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise&lt;v
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------------- | -------- | ---- | -------------------------------- |
| localLabels | string[] | 是 | 表示本地设备的同步标签。 |
| remoteSupportLabels | string[] | 是 | 表示要同步数据的设备的同步标签。 |
......@@ -4510,7 +4510,7 @@ setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback&lt;void&gt;)
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------------------- | ------------------------- | ---- | -------------------------------------------- |
| defaultAllowedDelayMs | number | 是 | 表示数据库同步允许的默认延迟，以毫秒为单位。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
......@@ -4543,7 +4543,7 @@ setSyncParam(defaultAllowedDelayMs: number): Promise&lt;void&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------------------- | -------- | ---- | -------------------------------------------- |
| defaultAllowedDelayMs | number | 是 | 表示数据库同步允许的默认延迟，以毫秒为单位。 |
......@@ -4581,7 +4581,7 @@ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------- | ---- | ---------------------------------------------- |
| deviceIds | string[] | 是 | 同一组网环境下，需要同步的设备的deviceId列表。 |
| mode | [SyncMode](#syncmode) | 是 | 同步模式。 |
......@@ -4619,7 +4619,7 @@ sync(deviceIds: string[], query: Query, mode: SyncMode, delayMs?: number): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------- | ---- | ---------------------------------------------- |
| deviceIds | string[] | 是 | 同一组网环境下，需要同步的设备的deviceId列表。 |
| mode | [SyncMode](#syncmode) | 是 | 同步模式。 |
......@@ -4673,7 +4673,7 @@ on(event: 'dataChange', type: SubscribeType, listener: Callback&lt;ChangeNotific
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ---------------------------------------------------- |
| event | string | 是 | 订阅的事件名，固定为'dataChange'，表示数据变更事件。 |
| type | [SubscribeType](#subscribetype) | 是 | 表示订阅的类型。 |
......@@ -4711,7 +4711,7 @@ on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------------- | ---- | ------------------------------------------------------ |
| event | string | 是 | 订阅的事件名，固定为'syncComplete'，表示同步完成事件。 |
| syncCallback | Callback&lt;Array&lt;[string, number]&gt;&gt; | 是 | 回调函数。用于向调用方发送同步结果的回调。 |
......@@ -4746,7 +4746,7 @@ off(event:'dataChange', listener?: Callback&lt;ChangeNotification&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | -------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名，固定为'dataChange'，表示数据变更事件。 |
| listener | Callback&lt;[ChangeNotification](#changenotification)&gt; | 否 | 回调函数。 |
......@@ -4800,7 +4800,7 @@ off(event: 'syncComplete', syncCallback?: Callback&lt;Array&lt;[string, number]&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名，固定为'syncComplete'，表示同步完成事件。 |
| syncCallback | Callback&lt;Array&lt;[string, number]&gt;&gt; | 否 | 回调函数。用于向调用方发送同步结果的回调。 |
......@@ -4846,7 +4846,7 @@ getSecurityLevel(callback: AsyncCallback&lt;SecurityLevel&gt;): void
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback&lt;[SecurityLevel](#securitylevel)&gt; | 是 | 回调函数。返回数据库的安全级别。 |
......@@ -4932,7 +4932,7 @@ get(deviceId: string, key: string, callback: AsyncCallback&lt;boolean|string|num
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要查询其数据的设备。 |
| key |string | 是 |表示要查询key值的键。 |
......@@ -4984,7 +4984,7 @@ get(deviceId: string, key: string): Promise&lt;boolean|string|number|Uint8Array&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------ |
| deviceId | string | 是 | 标识要查询其数据的设备。 |
| key | string | 是 | 表示要查询key值的键。 |
......@@ -5020,7 +5020,7 @@ try {
console.error(`Fail to get.code is ${err.code},message is ${err.message}`);
});
}).catch((error) => {
console.error(`Fail to put.code is ${err.code},message is ${err.message}`);
console.error(`Fail to put.code is ${error.code},message is ${error.message}`);
});
} catch (e) {
console.error(`Fail to get.code is ${e.code},message is ${e.message}`);
......@@ -5037,7 +5037,7 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;Entry
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | ---------------------------------------------- |
| deviceId | string | 是 | 标识要查询其数据的设备。 |
| keyPrefix | string | 是 | 表示要匹配的键前缀。 |
......@@ -5101,7 +5101,7 @@ getEntries(deviceId: string, keyPrefix: string): Promise&lt;Entry[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | ------------------------ |
| deviceId | string | 是 | 标识要查询其数据的设备。 |
| keyPrefix | string | 是 | 表示要匹配的键前缀。 |
......@@ -5168,7 +5168,7 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback&lt;Entry[]&gt
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ------------------------------------------------------- |
| deviceId | string | 是 | 键值对所属的设备ID。 |
| query | [Query](query) | 是 | 表示查询对象。 |
......@@ -5238,7 +5238,7 @@ getEntries(deviceId: string, query: Query): Promise&lt;Entry[]&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | -------------------- |
| deviceId | string | 是 | 键值对所属的设备ID。 |
| query | [Query](query) | 是 | 表示查询对象。 |
......@@ -5293,7 +5293,7 @@ try {
});
console.log('Succeeded in getting entries');
} catch (e) {
console.error(`Fail to get entries.code is ${err.code},message is ${err.message}`);
console.error(`Fail to get entries.code is ${e.code},message is ${e.message}`);
}
```
......@@ -5307,7 +5307,7 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;KVS
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 标识要查询其数据的设备。 |
| keyPrefix | string | 是 | 表示要匹配的键前缀。 |
......@@ -5358,7 +5358,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise&lt;KVStoreResultSet&g
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | ------------------------ |
| deviceId | string | 是 | 标识要查询其数据的设备。 |
| keyPrefix | string | 是 | 表示要匹配的键前缀。 |
......@@ -5410,7 +5410,7 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback&lt;KVStoreR
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | KVStoreResultSet对象所属的设备ID。 |
| query | [Query](query) | 是 | 表示查询对象。 |
......@@ -5482,7 +5482,7 @@ getResultSet(deviceId: string, query: Query): Promise&lt;KVStoreResultSet&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ---------------------------------- |
| deviceId | string | 是 | KVStoreResultSet对象所属的设备ID。 |
| query | [Query](query) | 是 | 表示查询对象。 |
......@@ -5558,7 +5558,7 @@ getResultSet(deviceId: string, predicates: dataSharePredicates.DataSharePredicat
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 标识要查询其数据的设备。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时，应定义处理逻辑。 |
......@@ -5615,7 +5615,7 @@ getResultSet(deviceId: string, predicates: dataSharePredicates.DataSharePredicat
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| deviceId | string | 是 | 标识要查询其数据的设备。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时，应定义处理逻辑。 |
......@@ -5670,7 +5670,7 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback&lt;number&
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------------------------------------------- |
| deviceId | string | 是 | KVStoreResultSet对象所属的设备ID。 |
| query | [Query](query) | 是 | 表示查询对象。 |
......@@ -5734,7 +5734,7 @@ getResultSize(deviceId: string, query: Query): Promise&lt;number&gt;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ---------------------------------- |
| deviceId | string | 是 | KVStoreResultSet对象所属的设备ID。 |
| query | [Query](query) | 是 | 表示查询对象。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或