From 7c872ba91f4acc8c47ca44284e312ecfafdc29fc Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Thu, 10 Feb 2022 20:30:04 +0800 Subject: [PATCH 01/14] test --- .../apis/js-apis-distributed-data.md | 78 +++++++------------ 1 file changed, 27 insertions(+), 51 deletions(-) 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 8c11ab5057b..e1c212959b0 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 @@ -1,57 +1,32 @@ -# 分布式数据管理 +# 分布式数据管理 >![](../../public_sys-resources/icon-note.gif) **说明：** >本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 + +## 导入模块 ``` import distributedData from '@ohos.data.distributedData'; ``` -## 权限 + +## 权限 无 -## distributedData.createKVManager +## distributedData.createKVManager createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void 创建一个KVManager对象实例，用于管理数据库对象，并通过callback方式返回，此方法为异步方法。 -- 参数： +- 参数： +| 参数名 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| config | KVManagerConfig | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | +| callback | AsyncCallback | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

config

-

KVManagerConfig

-

是

-

提供KVManager实例的配置信息，包括调用方的包名和用户信息。

-

callback

-

AsyncCallback<KVManager>

-

是

-

KVManager实例创建时调用的回调，返回KVManager对象实例。

-
- 示例： @@ -494,7 +469,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa } catch (e) { console.log('closeKVStore e ' + e); } - ``` + ``` ### closeKVStore8+ ### @@ -591,7 +566,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void& } catch (e) { console.log('closeKVStore e ' + e); } - ``` + ``` ### deleteKVStore8+ ### @@ -668,7 +643,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void> } catch (e) { console.log('DeleteKVStore e ' + e); } - ``` + ``` ### deleteKVStore8+ ### @@ -756,7 +731,7 @@ deleteKVStore(appId: string, storeId: string): Promise<void>; } catch (e) { console.log('deleteKVStore e ' + e); } - ``` + ``` ### getAllKVStoreId8+ ### @@ -811,7 +786,7 @@ getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void; } catch (e) { console.log('GetAllKVStoreId e ' + e); } - ``` + ``` ### getAllKVStoreId8+ ### @@ -877,7 +852,7 @@ getAllKVStoreId(appId: string): Promise<string[]>; } catch(e) { console.log('getAllKVStoreId e ' + e); } - ``` + ``` ### on8+ ### @@ -931,7 +906,7 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): voi } catch (e) { console.log("An unexpected error occurred. Error:" + e); } - ``` + ``` ### off8+ ### @@ -984,8 +959,8 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v } catch (e) { console.log("An unexpected error occurred. Error:" + e); } - - ``` + + ``` ## Options @@ -1250,7 +1225,7 @@ toJsonString():string; } catch (e) { console.log("toJsonString " + e); } - ``` + ``` ## FieldNode8+ ## @@ -1323,7 +1298,7 @@ appendChild(child: FieldNode): boolean; } catch (e) { console.log("AppendChild " + e); } - ``` + ``` ### toJson8+ ### @@ -1361,7 +1336,7 @@ toJson(): string; } catch (e) { console.log("ToJson " + e); } - ``` + ``` ## KvStoreResultSet8+ ## @@ -1408,7 +1383,7 @@ getCount(): number; } catch (e) { console.log("GetCount fail " + e); } - ``` + ``` ### getPosition8+ ### @@ -4031,7 +4006,7 @@ putBatch(entries: Entry[], callback: AsyncCallback<void>): void; }catch(e) { console.log('PutBatch e ' + e); } - + ``` @@ -7803,7 +7778,7 @@ getResultSet(deviceId: string, query: Query): Promise<KvStoreResultSet>; }).catch((err) => { console.log('GetResultSet closeResultSet fail ' + JSON.stringify(err)); }); - + }catch(e) { console.log('GetResultSet e ' + e); } @@ -8598,6 +8573,7 @@ off(event: 'syncComplete', syncCallback?: Callback +

名称

默认值

-- Gitee From 8d11688520ae5d03553d6039deb08efa6645e904 Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Thu, 10 Feb 2022 20:38:48 +0800 Subject: [PATCH 02/14] test1 --- .../application-dev/reference/apis/js-apis-distributed-data.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 e1c212959b0..16163068634 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 @@ -22,8 +22,9 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager> 创建一个KVManager对象实例，用于管理数据库对象，并通过callback方式返回，此方法为异步方法。 - 参数： + | 参数名 | 参数类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | +| ----- | ------ | ------ | ------ | | config | KVManagerConfig | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | | callback | AsyncCallback | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | -- Gitee From 5b8d12f7f3e43b6a37c070736d16345487798fbc Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Thu, 10 Feb 2022 20:56:22 +0800 Subject: [PATCH 03/14] 1 --- .../application-dev/reference/apis/js-apis-distributed-data.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) 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 16163068634..e823c91ed16 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 @@ -54,8 +54,7 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager> } ``` - -## distributedData.createKVManager +## distributedData.createKVManager createKVManager(config: KVManagerConfig): Promise<KVManager> -- Gitee From 286317bd70b4261c3f4b2598f6ab004d14fe2f80 Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Thu, 10 Feb 2022 21:07:13 +0800 Subject: [PATCH 04/14] 2 --- .../apis/js-apis-distributed-data.md | 33 +++++-------------- 1 file changed, 9 insertions(+), 24 deletions(-) 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 e823c91ed16..c2199ab7e8d 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 @@ -61,32 +61,17 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> 创建一个KVManager对象实例，用于管理数据库对象，并通过Promise方式返回，此方法为异步方法。 - 参数： - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

config

-

KVManagerConfig

-

是

-

提供KVManager实例的配置信息，包括调用方的包名和用户信息。

-
- + | 参数名 | 参数类型 | 必填 | 说明 | + | ----- | ------ | ------ | ------ | + | config | KVManagerConfig | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | + - 返回值： +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [Promise](#KVManager) | 获取到要操作的Storage实例，用于进行数据存储操作。 | + -- Gitee From 8eca203c9fa993504f6331af94d3a1930a63a58c Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Thu, 10 Feb 2022 21:40:13 +0800 Subject: [PATCH 05/14] 3 --- .../apis/js-apis-distributed-data.md | 57 +++---------------- 1 file changed, 8 insertions(+), 49 deletions(-) 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 c2199ab7e8d..d17b89e0973 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 @@ -67,26 +67,10 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> - 返回值： -- 返回值： | 类型 | 说明 | | -------- | -------- | - | [Promise](#KVManager) | 获取到要操作的Storage实例，用于进行数据存储操作。 | + | [Promise](#KVManager) | 指定的Promise回调方法，返回创建的KVManager对象实例。 | - -

类型

- - - - - - - -

类型

-

说明

-

Promise<KVManager>

-

指定的Promise回调方法，返回创建的KVManager对象实例。

-
- - 示例： ``` @@ -111,41 +95,16 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> ``` -## KVManagerConfig +## KVManagerConfig 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 - - - - - - - - - - - - - - - - - - -

名称

-

类型

-

必填

-

描述

-

userInfo

-

UserInfo

-

是

-

调用方的用户信息。

-

bundleName

-

string

-

是

-

调用方的包名。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| userInfo | [UserInfo](#UserInfo) | 是 | 调用方的用户信息。 | +| bundleName | string | 是 | 调用方的包名。 | + + ## UserInfo -- Gitee From 49d592bd4b63da2985c13a3ba4b5b5785a0acfcd Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Thu, 10 Feb 2022 21:43:46 +0800 Subject: [PATCH 06/14] 111 --- .../reference/apis/js-apis-distributed-data.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 d17b89e0973..f1a34927073 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 @@ -63,13 +63,13 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> - 参数： | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | - | config | KVManagerConfig | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | + | config |[KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | - 返回值： | 类型 | 说明 | | -------- | -------- | - | [Promise](#KVManager) | 指定的Promise回调方法，返回创建的KVManager对象实例。 | + | Promise<[KVManager](#KVManager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | - 示例： -- Gitee From 9817ae763faf90dc11f2fd1b2f4eff0de7c241cf Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Thu, 10 Feb 2022 21:45:33 +0800 Subject: [PATCH 07/14] 232 --- .../application-dev/reference/apis/js-apis-distributed-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 f1a34927073..1cf42cbedb4 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 @@ -101,7 +101,7 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | -| userInfo | [UserInfo](#UserInfo) | 是 | 调用方的用户信息。 | +| userInfo | [UserInfo](##UserInfo) | 是 | 调用方的用户信息。 | | bundleName | string | 是 | 调用方的包名。 | -- Gitee From 87ec389baa5c6f8794239999217b3e4fe91d75f3 Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Fri, 11 Feb 2022 15:07:27 +0800 Subject: [PATCH 08/14] 26363 --- .../apis/js-apis-distributed-data.md | 355 ++++-------------- 1 file changed, 77 insertions(+), 278 deletions(-) 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 1cf42cbedb4..6be4090c037 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 @@ -25,8 +25,8 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager> | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | -| config | KVManagerConfig | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | -| callback | AsyncCallback | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | +| config | [KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | +| callback | AsyncCallback<[KVManager](#KVManager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | - 示例： @@ -101,123 +101,46 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | -| userInfo | [UserInfo](##UserInfo) | 是 | 调用方的用户信息。 | +| userInfo | [UserInfo](#UserInfo) | 是 | 调用方的用户信息。 | | bundleName | string | 是 | 调用方的包名。 | -## UserInfo +## UserInfo 用户信息。 - - - - - - - - - - - - - - - - - - -

名称

-

类型

-

必填

-

描述

-

userId

-

string

-

是

-

指示要设置的用户ID。

-

userType

-

UserType

-

是

-

指示要设置的用户类型。

-
+| 名称 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| userId | string | 是 | 指示要设置的用户ID。 | +| userType | [UserType](#UserType) | 是 | 指示要设置的用户类型。 | + -## UserType +## UserType 用户类型。 - - - - - - - - - - - -

名称

-

默认值

-

说明

-

SAME_USER_ID

-

0

-

使用同一帐户登录不同设备的用户。

-
+| 名称 | 默认值 | 说明 | +| ----- | ------ | ------ | +| SAME_USER_ID | 0 | 使用同一帐户登录不同设备的用户。 | -## KVManager + +## KVManager 数据管理实例，用于获取KVStore的相关信息。在调用KVManager的方法前，需要先通过createKVManager构建一个KVManager实例。 -### getKVStore +### getKVStore getKVStore(storeId: string, options: Options, callback: AsyncCallback<T>): void 通过指定Options和storeId，创建并获取KVStore数据库，并通过callback方式返回，此方法为异步方法。 -- 参数： - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

storeId

-

string

-

是

-

数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。

-

options

-

Options

-

是

-

创建KVStore实例的配置信息。

-

callback

-

AsyncCallback<T>，

-

<T extends KVStore>

-

是

-

创建KVStore实例的回调，返回KVStore对象实例。

-
+- 参数： +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| options | Options | 是 | 创建KVStore实例的配置信息。 | +| callback | AsyncCallback， | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | - 示例： @@ -247,88 +170,51 @@ getKVStore(storeId: string, options: Options, callback: Async ``` -### getKVStore +### getKVStore getKVStore<T extends KVStore>(storeId: string, options: Options): Promise<T> 通过指定Options和storeId，创建并获取KVStore数据库，并通过Promise方式返回，此方法为异步方法。 -- 参数： +- 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

storeId

-

string

-

是

-

数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。

-

options

-

Options

-

是

-

创建KVStore实例的配置信息。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ------- | ---------------------- | ---- | -------------------- | +| storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| options | Options | 是 | 创建KVStore实例的配置信息。| -- 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<T>

-

<T extends KVStore>

-

指定的Promise回调方法，返回创建的KVStore数据库实例。

-
+- 返回值： -- 示例： - - ``` - let kvStore; - let kvManager; - try { - const options = { - createIfMissing : true, - encrypt : false, - backup : false, - autoSync : true, - kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, - securityLevel : distributedData.SecurityLevel.S2, - }; - kvManager.getKVStore('storeId', options).then((store) => { - console.log("getKVStore success"); - kvStore = store; - }).catch((err) => { - console.log("getKVStore err: " + JSON.stringify(err)); - }); - } catch (e) { - console.log("An unexpected error occurred. Error:" + e); - } - ``` +| 类型 | 说明 | +| -------------------------------------- | ------------------------ | +| Promise | 指定的Promise回调方法，返回创建的KVStore数据库实例。 | + + +- 示例： + + ``` + let kvStore; + let kvManager; + try { + const options = { + createIfMissing : true, + encrypt : false, + backup : false, + autoSync : true, + kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, + securityLevel : distributedData.SecurityLevel.S2, + }; + kvManager.getKVStore('storeId', options).then((store) => { + console.log("getKVStore success"); + kvStore = store; + }).catch((err) => { + console.log("getKVStore err: " + JSON.stringify(err)); + }); + } catch (e) { + console.log("An unexpected error occurred. Error:" + e); + } + ``` ### closeKVStore8+ ### @@ -336,57 +222,16 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa 通过storId的值关闭指定的kvStore数据库，并通过callback方式返回，此方法为异步方法。 -- 参数： +- 参数： + + +| 参数名 | 参数类型 | 必填 | 说明 | +| ------- | ----------------- | ---- | --------------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | +| callback | AsyncCallback | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

-

storeId

-

string

-

是

-

要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。

-

kvStore

-

KVStore

-

是

-

要关闭的KvStore数据库。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数，如果数据库关闭成功则返回true，否则返回false。

-
- 示例： @@ -421,65 +266,19 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void& 通过kvStore的值关闭指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 -- 参数： +- 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

-

storeId

-

string

-

是

-

要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。

-

kvStore

-

KVStore

-

是

-

要关闭的数据库。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | -- 返回值： +- 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，如果数据库关闭成功则返回true，否则返回false。

-
+| 类型 | 说明 | +| ------------- | -------------- | +| Promise | Promise实例，如果数据库关闭成功则返回true，否则返回false。 | - 示例： -- Gitee From 2d5eec69c545ab28613ac56c6a702e771ebc1b54 Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Fri, 11 Feb 2022 15:46:50 +0800 Subject: [PATCH 09/14] 51 --- .../apis/js-apis-distributed-data.md | 61 +++++-------------- 1 file changed, 15 insertions(+), 46 deletions(-) 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 6be4090c037..f629d2369b4 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 @@ -61,15 +61,16 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> 创建一个KVManager对象实例，用于管理数据库对象，并通过Promise方式返回，此方法为异步方法。 - 参数： - | 参数名 | 参数类型 | 必填 | 说明 | - | ----- | ------ | ------ | ------ | - | config |[KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | + +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| config |[KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | - 返回值： - | 类型 | 说明 | - | -------- | -------- | - | Promise<[KVManager](#KVManager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<[KVManager](#KVManager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | - 示例： @@ -320,46 +321,14 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void> - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

-

storeId

-

string

-

是

-

要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数，如果成功返回true，否则返回false。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| callback | AsyncCallback | 是 | 回调函数，如果成功返回true，否则返回false。 | + + + - 示例： -- Gitee From 59ea8d120a23c6dda1eb4714c7ae2a82a2e59e1c Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Fri, 11 Feb 2022 16:00:20 +0800 Subject: [PATCH 10/14] 566 --- .../apis/js-apis-distributed-data.md | 161 +++++++----------- 1 file changed, 61 insertions(+), 100 deletions(-) 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 f629d2369b4..75a20137ac8 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 @@ -23,10 +23,10 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager> - 参数： -| 参数名 | 参数类型 | 必填 | 说明 | -| ----- | ------ | ------ | ------ | -| config | [KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | -| callback | AsyncCallback<[KVManager](#KVManager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | + | 参数名 | 参数类型 | 必填 | 说明 | + | ----- | ------ | ------ | ------ | + | config | [KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | + | callback | AsyncCallback<[KVManager](#KVManager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | - 示例： @@ -62,16 +62,16 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> - 参数： -| 参数名 | 参数类型 | 必填 | 说明 | -| ----- | ------ | ------ | ------ | -| config |[KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | + | 参数名 | 参数类型 | 必填 | 说明 | + | ----- | ------ | ------ | ------ | + | config |[KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | - 返回值： -| 类型 | 说明 | -| -------- | -------- | -| Promise<[KVManager](#KVManager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | - + | 类型 | 说明 | + | -------- | -------- | + | Promise<[KVManager](#KVManager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | + - 示例： ``` @@ -100,10 +100,10 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 -| 参数名 | 参数类型 | 必填 | 说明 | -| ----- | ------ | ------ | ------ | -| userInfo | [UserInfo](#UserInfo) | 是 | 调用方的用户信息。 | -| bundleName | string | 是 | 调用方的包名。 | + | 参数名 | 参数类型 | 必填 | 说明 | + | ----- | ------ | ------ | ------ | + | userInfo | [UserInfo](#UserInfo) | 是 | 调用方的用户信息。 | + | bundleName | string | 是 | 调用方的包名。 | @@ -111,19 +111,19 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> 用户信息。 -| 名称 | 参数类型 | 必填 | 说明 | -| ----- | ------ | ------ | ------ | -| userId | string | 是 | 指示要设置的用户ID。 | -| userType | [UserType](#UserType) | 是 | 指示要设置的用户类型。 | + | 名称 | 参数类型 | 必填 | 说明 | + | ----- | ------ | ------ | ------ | + | userId | string | 是 | 指示要设置的用户ID。 | + | userType | [UserType](#UserType) | 是 | 指示要设置的用户类型。 | ## UserType 用户类型。 -| 名称 | 默认值 | 说明 | -| ----- | ------ | ------ | -| SAME_USER_ID | 0 | 使用同一帐户登录不同设备的用户。 | + | 名称 | 默认值 | 说明 | + | ----- | ------ | ------ | + | SAME_USER_ID | 0 | 使用同一帐户登录不同设备的用户。 | ## KVManager @@ -137,11 +137,11 @@ getKVStore(storeId: string, options: Options, callback: Async 通过指定Options和storeId，创建并获取KVStore数据库，并通过callback方式返回，此方法为异步方法。 - 参数： -| 参数名 | 参数类型 | 必填 | 说明 | -| ----- | ------ | ------ | ------ | -| storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | -| options | Options | 是 | 创建KVStore实例的配置信息。 | -| callback | AsyncCallback， | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | + | 参数名 | 参数类型 | 必填 | 说明 | + | ----- | ------ | ------ | ------ | + | storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | + | options | Options | 是 | 创建KVStore实例的配置信息。 | + | callback | AsyncCallback， | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | - 示例： @@ -179,17 +179,17 @@ getKVStore<T extends KVStore>(storeId: string, options: Options): Promise& - 参数： -| 参数名 | 参数类型 | 必填 | 说明 | -| ------- | ---------------------- | ---- | -------------------- | -| storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | -| options | Options | 是 | 创建KVStore实例的配置信息。| + | 参数名 | 参数类型 | 必填 | 说明 | + | ------- | ---------------------- | ---- | -------------------- | + | storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | + | options | Options | 是 | 创建KVStore实例的配置信息。| - 返回值： -| 类型 | 说明 | -| -------------------------------------- | ------------------------ | -| Promise | 指定的Promise回调方法，返回创建的KVStore数据库实例。 | + | 类型 | 说明 | + | -------------------------------------- | ------------------------ | + | Promise | 指定的Promise回调方法，返回创建的KVStore数据库实例。 | - 示例： @@ -226,12 +226,12 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa - 参数： -| 参数名 | 参数类型 | 必填 | 说明 | -| ------- | ----------------- | ---- | --------------------------- | -| appId | string | 是 | 所调用数据库方的包名。 | -| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | -| kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | -| callback | AsyncCallback | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 | + | 参数名 | 参数类型 | 必填 | 说明 | + | ------- | ----------------- | ---- | --------------------------- | + | appId | string | 是 | 所调用数据库方的包名。 | + | storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | + | kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | + | callback | AsyncCallback | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 | - 示例： @@ -269,17 +269,17 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void& - 参数： -| 参数名 | 参数类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------------------------- | -| appId | string | 是 | 所调用数据库方的包名。 | -| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | -| kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | + | 参数名 | 参数类型 | 必填 | 说明 | + | ----- | ------ | ---- | ----------------------------- | + | appId | string | 是 | 所调用数据库方的包名。 | + | storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | + | kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | - 返回值： -| 类型 | 说明 | -| ------------- | -------------- | -| Promise | Promise实例，如果数据库关闭成功则返回true，否则返回false。 | + | 类型 | 说明 | + | ------------- | -------------- | + | Promise | Promise实例，如果数据库关闭成功则返回true，否则返回false。 | - 示例： @@ -321,13 +321,11 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void> - 参数： -| 参数名 | 参数类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------------------- | -| appId | string | 是 | 所调用数据库方的包名。 | -| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | -| callback | AsyncCallback | 是 | 回调函数，如果成功返回true，否则返回false。 | - - + | 参数名 | 参数类型 | 必填 | 说明 | + | ----- | ------ | ---- | ----------------------- | + | appId | string | 是 | 所调用数据库方的包名。 | + | storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | + | callback | AsyncCallback | 是 | 回调函数，如果成功返回true，否则返回false。 | - 示例： @@ -364,55 +362,18 @@ deleteKVStore(appId: string, storeId: string): Promise<void>; 通过storeId的值删除指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 - 参数： + + | 参数名 | 参数类型 | 必填 | 说明 | + | ----- | ------ | ---- | ----------------------- | + | appId | string | 是 | 所调用数据库方的包名。 | + | storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

-

storeId

-

string

-

是

-

要删除数据库的唯一标识符，长度不大于MAX_STORE_ID_LENGTH。

-
- 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，如果成功返回true，否则返回false。

-
+ | 类型 | 说明 | + | ------------- | -------------- | + | Promise | Promise实例，如果成功返回true，否则返回false。 | - 示例： -- Gitee From fc853bb2336de3ff6c0065237873987143043eeb Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Fri, 11 Feb 2022 16:04:07 +0800 Subject: [PATCH 11/14] e --- .../apis/js-apis-distributed-data.md | 118 +++++++++--------- 1 file changed, 59 insertions(+), 59 deletions(-) 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 75a20137ac8..f049d11d3a7 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 @@ -23,10 +23,10 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager> - 参数： - | 参数名 | 参数类型 | 必填 | 说明 | - | ----- | ------ | ------ | ------ | - | config | [KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | - | callback | AsyncCallback<[KVManager](#KVManager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| config | [KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | +| callback | AsyncCallback<[KVManager](#KVManager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | - 示例： @@ -62,15 +62,15 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> - 参数： - | 参数名 | 参数类型 | 必填 | 说明 | - | ----- | ------ | ------ | ------ | - | config |[KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| config |[KVManagerConfig](#KVManagerConfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | - 返回值： - | 类型 | 说明 | - | -------- | -------- | - | Promise<[KVManager](#KVManager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<[KVManager](#KVManager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | - 示例： @@ -100,10 +100,10 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 - | 参数名 | 参数类型 | 必填 | 说明 | - | ----- | ------ | ------ | ------ | - | userInfo | [UserInfo](#UserInfo) | 是 | 调用方的用户信息。 | - | bundleName | string | 是 | 调用方的包名。 | +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| userInfo | [UserInfo](#UserInfo) | 是 | 调用方的用户信息。 | +| bundleName | string | 是 | 调用方的包名。 | @@ -111,19 +111,19 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> 用户信息。 - | 名称 | 参数类型 | 必填 | 说明 | - | ----- | ------ | ------ | ------ | - | userId | string | 是 | 指示要设置的用户ID。 | - | userType | [UserType](#UserType) | 是 | 指示要设置的用户类型。 | +| 名称 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| userId | string | 是 | 指示要设置的用户ID。 | +| userType | [UserType](#UserType) | 是 | 指示要设置的用户类型。 | ## UserType 用户类型。 - | 名称 | 默认值 | 说明 | - | ----- | ------ | ------ | - | SAME_USER_ID | 0 | 使用同一帐户登录不同设备的用户。 | +| 名称 | 默认值 | 说明 | +| ----- | ------ | ------ | +| SAME_USER_ID | 0 | 使用同一帐户登录不同设备的用户。 | ## KVManager @@ -137,11 +137,11 @@ getKVStore(storeId: string, options: Options, callback: Async 通过指定Options和storeId，创建并获取KVStore数据库，并通过callback方式返回，此方法为异步方法。 - 参数： - | 参数名 | 参数类型 | 必填 | 说明 | - | ----- | ------ | ------ | ------ | - | storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | - | options | Options | 是 | 创建KVStore实例的配置信息。 | - | callback | AsyncCallback， | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| options | Options | 是 | 创建KVStore实例的配置信息。 | +| callback | AsyncCallback， | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | - 示例： @@ -179,17 +179,17 @@ getKVStore<T extends KVStore>(storeId: string, options: Options): Promise& - 参数： - | 参数名 | 参数类型 | 必填 | 说明 | - | ------- | ---------------------- | ---- | -------------------- | - | storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | - | options | Options | 是 | 创建KVStore实例的配置信息。| +| 参数名 | 参数类型 | 必填 | 说明 | +| ------- | ---------------------- | ---- | -------------------- | +| storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| options | Options | 是 | 创建KVStore实例的配置信息。| - 返回值： - | 类型 | 说明 | - | -------------------------------------- | ------------------------ | - | Promise | 指定的Promise回调方法，返回创建的KVStore数据库实例。 | +| 类型 | 说明 | +| -------------------------------------- | ------------------------ | +| Promise | 指定的Promise回调方法，返回创建的KVStore数据库实例。 | - 示例： @@ -226,12 +226,12 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa - 参数： - | 参数名 | 参数类型 | 必填 | 说明 | - | ------- | ----------------- | ---- | --------------------------- | - | appId | string | 是 | 所调用数据库方的包名。 | - | storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | - | kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | - | callback | AsyncCallback | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 | +| 参数名 | 参数类型 | 必填 | 说明 | +| ------- | ----------------- | ---- | --------------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | +| callback | AsyncCallback | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 | - 示例： @@ -269,17 +269,17 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void& - 参数： - | 参数名 | 参数类型 | 必填 | 说明 | - | ----- | ------ | ---- | ----------------------------- | - | appId | string | 是 | 所调用数据库方的包名。 | - | storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | - | kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | - 返回值： - | 类型 | 说明 | - | ------------- | -------------- | - | Promise | Promise实例，如果数据库关闭成功则返回true，否则返回false。 | +| 类型 | 说明 | +| ------------- | -------------- | +| Promise | Promise实例，如果数据库关闭成功则返回true，否则返回false。 | - 示例： @@ -321,11 +321,11 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void> - 参数： - | 参数名 | 参数类型 | 必填 | 说明 | - | ----- | ------ | ---- | ----------------------- | - | appId | string | 是 | 所调用数据库方的包名。 | - | storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | - | callback | AsyncCallback | 是 | 回调函数，如果成功返回true，否则返回false。 | +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| callback | AsyncCallback | 是 | 回调函数，如果成功返回true，否则返回false。 | - 示例： @@ -363,17 +363,17 @@ deleteKVStore(appId: string, storeId: string): Promise<void>; - 参数： - | 参数名 | 参数类型 | 必填 | 说明 | - | ----- | ------ | ---- | ----------------------- | - | appId | string | 是 | 所调用数据库方的包名。 | - | storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | - 返回值： - | 类型 | 说明 | - | ------------- | -------------- | - | Promise | Promise实例，如果成功返回true，否则返回false。 | +| 类型 | 说明 | +| ------------- | -------------- | +| Promise | Promise实例，如果成功返回true，否则返回false。 | - 示例： -- Gitee From 87ceade277ffde8f2e334440a794eb30eec238d9 Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Fri, 11 Feb 2022 17:08:30 +0800 Subject: [PATCH 12/14] 552522 --- .../apis/js-apis-distributed-data.md | 393 +++--------------- 1 file changed, 60 insertions(+), 333 deletions(-) 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 f049d11d3a7..f59e23e5d08 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 @@ -415,37 +415,10 @@ getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数，返回所有创建的 KvStore 数据库的 storeId。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| callback | AsyncCallback | 是 |回调函数，返回所有创建的 KvStore 数据库的 storeId。 | - 示例： @@ -470,45 +443,16 @@ getAllKVStoreId(appId: string): Promise<string[]>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | -- 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<string[]>

-

Promise实例，返回所有创建的 KvStore 数据库的 storeId。。

-
+- 返回值： + +| 类型 | 说明 | +| ------------- | -------------- | +| Promise| Promise实例，返回所有创建的 KvStore 数据库的 storeId。 | - 示例： @@ -536,34 +480,12 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): voi - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'distributedDataServiceDie'

-

是

-

服务状态改变时触发的事件名。

-

deathCallback

-

Callback<void>

-

是

-

回调函数，在设备状态改变时获取通知。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event | 'distributedDataServiceDie' | 是 | 服务状态改变时触发的事件名。 | +| deathCallback | Callback | 是 | 回调函数，在设备状态改变时获取通知。 | + + - 示例 @@ -590,34 +512,11 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'distributedDataServiceDie'

-

是

-

服务状态改变时触发的事件名。

-

deathCallback

-

Callback<void>

-

否

-

回调函数，取消设备状态改变时获取通知。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event | 'distributedDataServiceDie' | 是 | 服务状态改变时触发的事件名。 | +| deathCallback | Callback | 否 | 回调函数，取消设备状态改变时获取通知。 | + - 示例 @@ -635,230 +534,58 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v ``` -## Options +## Options 用于提供创建数据库的配置信息。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

createIfMissing

-

boolean

-

否

-

当数据库文件不存在时是否创建数据库，默认创建。

-

encrypt

-

boolean

-

否

-

设置数据库文件是否加密，默认不加密。

-

backup

-

boolean

-

否

-

设置数据库文件是否备份，默认备份。

-

autoSync

-

boolean

-

否

-

设置数据库文件是否自动同步，默认不自动同步。

-

kvStoreType

-

KVStoreType

-

否

-

设置要创建的数据库类型，默认为多设备协同数据库。

-

securityLevel

-

SecurityLevel

-

否

-

设置数据库安全级别，默认不设置安全级别。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| createIfMissing | boolean | 否 | 当数据库文件不存在时是否创建数据库，默认创建。 | +| encrypt | boolean | 否 |设置数据库文件是否加密，默认不加密。 | +| backup | boolean | 否 |设置数据库文件是否备份，默认备份。 | +| autoSync | boolean | 否 |设置数据库文件是否自动同步，默认不自动同步。 | +| kvStoreType | KVStoreType | 否 |设置要创建的数据库类型，默认为多设备协同数据库。 | +| securityLevel | SecurityLevel | 否 |设置数据库安全级别，默认不设置安全级别。 | -## KVStoreType + +## KVStoreType 用于指定创建的数据库的类型。 - - - - - - - - - - - - - - - - - - - -

名称

-

默认值

-

说明

-

DEVICE_COLLABORATION

-

0

-

表示多设备协同数据库。

-

SINGLE_VERSION

-

1

-

表示单版本数据库。

-

MULTI_VERSION

-

2

-

表示多版本数据库。此类型当前不允许使用。

-
+| 名称 | 默认值 | 说明 | +| --- | ---- | ----------------------- | +| DEVICE_COLLABORATION | 0 | 表示多设备协同数据库。 | +| SINGLE_VERSION | 1 | 表示单版本数据库。 | +| MULTI_VERSION | 2 | 表示多版本数据库。此类型当前不允许使用。 | + -## SecurityLevel + +## SecurityLevel 用于指定创建的数据库的安全级别。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

名称

-

默认值

-

说明

-

NO_LEVEL

-

0

-

表示数据库不设置安全级别。

-

S0

-

1

-

表示数据库的安全级别为公共级别安全。

-

S1

-

2

-

表示数据库的安全级别为低级别安全，当数据泄露时会产生较低影响。

-

S2

-

3

-

表示数据库的安全级别为中级别安全，当数据泄露时会产生较大影响。

-

S3

-

5

-

表示数据库的安全级别为高级别安全，当数据泄露时会产生重大影响。

-

S4

-

6

-

表示数据库的安全级别为关键级别安全，当数据泄露时会产生严重影响。

-
+| 名称 | 默认值 | 说明 | +| --- | ---- | ----------------------- | +| NO_LEVEL | 0 | 表示数据库不设置安全级别。 | +| S0 | 1 | 表示数据库的安全级别为公共级别安全。 | +| S1 | 2 | 表示数据库的安全级别为低级别安全，当数据泄露时会产生较低影响。 | +| S2 | 3 | 表示数据库的安全级别为中级别安全，当数据泄露时会产生较大影响。 | +| S3 | 5 | 表示数据库的安全级别为高级别安全，当数据泄露时会产生重大影响。 | +| S4 | 6 | 表示数据库的安全级别为关键级别安全，当数据泄露时会产生严重影响。 | + -## Constants +## Constants KVStore常量。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

名称

-

默认值

-

说明

-

MAX_KEY_LENGTH

-

1024

-

数据库中Key允许最大长度，单位字节。

-

MAX_VALUE_LENGTH

-

4194303

-

数据库中Value允许的最大长度，单位字节。

-

MAX_KEY_LENGTH_DEVICE

-

896

-

最大设备坐标密钥长度。

-

MAX_STORE_ID_LENGTH

-

128

-

数据库标识符允许的最大长度，单位字节。

-

MAX_QUERY_LENGTH

-

512000

-

最大查询长度。

-

MAX_BATCH_SIZE

-

128

-

最大批处理操作大小。

-
+| 名称 | 默认值 | 说明 | +| --- | ---- | ----------------------- | +| MAX_KEY_LENGTH | 1024 | 数据库中Key允许最大长度，单位字节。 | +| MAX_VALUE_LENGTH | 4194303 | 数据库中Value允许的最大长度，单位字节。 | +| MAX_KEY_LENGTH_DEVICE | 896 | 最大设备坐标密钥长度。 | +| MAX_STORE_ID_LENGTH | 128 | 数据库标识符允许的最大长度，单位字节。 | +| MAX_QUERY_LENGTH | 512000 | 最大查询长度。 | +| MAX_BATCH_SIZE | 128 | 最大批处理操作大小。 | ## Schema8+ ## -- Gitee From 7b32f307cf0552421cf6918f26772792712e056c Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Fri, 11 Feb 2022 18:16:29 +0800 Subject: [PATCH 13/14] constants --- .../apis/js-apis-distributed-data.md | 25 ++++++++++--------- 1 file changed, 13 insertions(+), 12 deletions(-) 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 f59e23e5d08..08b40bd7f10 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 @@ -137,10 +137,11 @@ getKVStore(storeId: string, options: Options, callback: Async 通过指定Options和storeId，创建并获取KVStore数据库，并通过callback方式返回，此方法为异步方法。 - 参数： + | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | -| storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | -| options | Options | 是 | 创建KVStore实例的配置信息。 | +| storeId | string | 是 | 数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#Constants)。 | +| options | [Options](#Options) | 是 | 创建KVStore实例的配置信息。 | | callback | AsyncCallback， | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | - 示例： @@ -181,8 +182,8 @@ getKVStore<T extends KVStore>(storeId: string, options: Options): Promise& | 参数名 | 参数类型 | 必填 | 说明 | | ------- | ---------------------- | ---- | -------------------- | -| storeId | string | 是 | 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | -| options | Options | 是 | 创建KVStore实例的配置信息。| +| storeId | string | 是 | 数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#Constants)。 | +| options | [Options](#Options) | 是 | 创建KVStore实例的配置信息。| - 返回值： @@ -229,8 +230,8 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa | 参数名 | 参数类型 | 必填 | 说明 | | ------- | ----------------- | ---- | --------------------------- | | appId | string | 是 | 所调用数据库方的包名。 | -| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | -| kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | +| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#Constants)。 | +| kvStore | [KVStore](#KVStore) | 是 | 要关闭的KvStore数据库。 | | callback | AsyncCallback | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 | @@ -272,8 +273,8 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void& | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------------- | | appId | string | 是 | 所调用数据库方的包名。 | -| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | -| kvStore | KVStore | 是 | 要关闭的KvStore数据库。 | +| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#Constants)。 | +| kvStore | [KVStore](#KVStore) | 是 | 要关闭的KvStore数据库。 | - 返回值： @@ -324,7 +325,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void> | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | appId | string | 是 | 所调用数据库方的包名。 | -| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#Constants)。 | | callback | AsyncCallback | 是 | 回调函数，如果成功返回true，否则返回false。 | @@ -366,7 +367,7 @@ deleteKVStore(appId: string, storeId: string): Promise<void>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | appId | string | 是 | 所调用数据库方的包名。 | -| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 | +| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#Constants)。 | - 返回值： @@ -544,8 +545,8 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v | encrypt | boolean | 否 |设置数据库文件是否加密，默认不加密。 | | backup | boolean | 否 |设置数据库文件是否备份，默认备份。 | | autoSync | boolean | 否 |设置数据库文件是否自动同步，默认不自动同步。 | -| kvStoreType | KVStoreType | 否 |设置要创建的数据库类型，默认为多设备协同数据库。 | -| securityLevel | SecurityLevel | 否 |设置数据库安全级别，默认不设置安全级别。 | +| kvStoreType | [KVStoreType](#KVStoreType) | 否 |设置要创建的数据库类型，默认为多设备协同数据库。 | +| securityLevel | [SecurityLevel](#SecurityLevel) | 否 |设置数据库安全级别，默认不设置安全级别。 | ## KVStoreType -- Gitee From 1dac0e7ed81706bdb65f1142d7bbf9f98d624dc2 Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Mon, 14 Feb 2022 14:28:40 +0800 Subject: [PATCH 14/14] Signed-off-by: test <1029079951@qq.com> Changes to be committed: modified: js-apis-data-ability.md modified: js-apis-data-rdb.md modified: js-apis-data-storage.md modified: js-apis-distributed-data.md --- zh-cn/application-dev/reference/apis/js-apis-data-ability.md | 2 ++ zh-cn/application-dev/reference/apis/js-apis-data-rdb.md | 3 +++ zh-cn/application-dev/reference/apis/js-apis-data-storage.md | 3 +++ .../application-dev/reference/apis/js-apis-distributed-data.md | 3 ++- 4 files changed, 10 insertions(+), 1 deletion(-) 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 7b82a0b98d1..c6aaa70183f 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 @@ -10,6 +10,8 @@ import dataAbility from '@ohos.data.dataAbility' ``` +## 系统能力 +SystemCapability.DistributedDataManager.DataShare.Consumer ## 权限 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 44c6e7089da..a0adcbae489 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 @@ -10,6 +10,9 @@ import dataRdb from '@ohos.data.rdb' ``` +## 系统能力 +SystemCapability.DistributedDataManager.RelationalStore.Core + ## 权限 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 37f09d0cbf1..9cb3b9343b1 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 @@ -13,6 +13,9 @@ import dataStorage from '@ohos.data.storage' ``` +## 系统能力 +SystemCapability.DistributedDataManager.Preference.Core + ## 权限 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 08b40bd7f10..130ec0ad7d3 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 @@ -9,7 +9,8 @@ ``` import distributedData from '@ohos.data.distributedData'; ``` - +## 系统能力 +SystemCapability.DistributedDataManager.KVStore.DistributedKVStore ## 权限 -- Gitee