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 c6aaa70183fbaa796fbf3ecfe95df2823b28fa99..fe3ed31c3d6a16985641d788b32254a08d1656e7 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 @@ -13,9 +13,6 @@ import dataAbility from '@ohos.data.dataAbility' ## 系统能力 SystemCapability.DistributedDataManager.DataShare.Consumer -## 权限 - -无 ## dataAbility.createRdbPredicates 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 5cdaa16d6c1af703fd95c01b45210bb21b8960b6..9a4cb242e267981120a2ac24a7807486c49ba002 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 @@ -3,8 +3,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 系统能力 -SystemCapability.DistributedDataManager.RelationalStore.Core + ## 导入模块 @@ -12,10 +11,8 @@ SystemCapability.DistributedDataManager.RelationalStore.Core import data_rdb from '@ohos.data.rdb' ``` - -## 权限 - -无 +## 系统能力 +SystemCapability.DistributedDataManager.RelationalStore.Core ## data_rdb.getRdbStore diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md index d2f4faabdce7969e174a7a27fa005715480ea1ad..57cbfd4bdbf0e4d5be2b2a9cb90b6637f1f8cbe7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md @@ -21,9 +21,7 @@ promise.then((resultSet) => { ``` -## 权限 -无 ## ResultSet 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 9cb3b9343b120787f9bee66d84459fd905379c77..946b63da82926831778fcbabd72258f6a0c72aeb 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 @@ -17,10 +17,6 @@ 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 1b19878734e5796f6c22a17b75d6bc6b024d2e2e..2a28f0d96496d697861ef2c1aee74b7c7ae2265f 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,60 +1,33 @@ -# 分布式数据管理 +# 分布式数据管理 >![](../../public_sys-resources/icon-note.gif) **说明：** >本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 系统能力 -SystemCapability.DistributedDataManager.KVStore.DistributedKVStore -## 导入模块 +## 导入模块 ``` import distributedData from '@ohos.data.distributedData'; ``` +## 系统能力 +SystemCapability.DistributedDataManager.KVStore.DistributedKVStore -## 权限 -无 -## distributedData.createKVManager + +## distributedData.createKVManager createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void 创建一个KVManager对象实例，用于管理数据库对象，并通过callback方式返回，此方法为异步方法。 -- 参数： +- 参数： + +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| config | [KVManagerConfig](#kvmanagerconfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | +| callback | AsyncCallback<[KVManager](#kvmanager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

config

-

KVManagerConfig

-

是

-

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

-

callback

-

AsyncCallback<KVManager>

-

是

-

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

-
- 示例： @@ -81,55 +54,24 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager> } ``` - -## distributedData.createKVManager +## distributedData.createKVManager createKVManager(config: KVManagerConfig): Promise<KVManager> 创建一个KVManager对象实例，用于管理数据库对象，并通过Promise方式返回，此方法为异步方法。 - 参数： - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

config

-

KVManagerConfig

-

是

-

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

-
- + +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| config |[KVManagerConfig](#kvmanager) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | + - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<KVManager>

-

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

-
- +| 类型 | 说明 | +| -------- | -------- | +| Promise<[KVManager](#kvmanager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | + - 示例： ``` @@ -154,154 +96,53 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> ``` -## KVManagerConfig +## KVManagerConfig 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 - - - - - - - - - - - - - - - - - - -

名称

-

类型

-

必填

-

描述

-

userInfo

-

UserInfo

-

是

-

调用方的用户信息。

-

bundleName

-

string

-

是

-

调用方的包名。

-
- -## UserInfo +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ------ | ------ | +| userInfo | [UserInfo](#userinfo) | 是 | 调用方的用户信息。 | +| bundleName | string | 是 | 调用方的包名。 | + + + +## UserInfo 用户信息。 - - - - - - - - - - - - - - - - - - -

名称

-

类型

-

必填

-

描述

-

userId

-

string

-

是

-

指示要设置的用户ID。

-

userType

-

UserType

-

是

-

指示要设置的用户类型。

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

名称

-

默认值

-

说明

-

SAME_USER_ID

-

0

-

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

-
- -## KVManager +| 名称 | 默认值 | 说明 | +| ----- | ------ | ------ | +| SAME_USER_ID | 0 | 使用同一帐户登录不同设备的用户。 | + + +## 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](#constants)。 | +| options | [Options](#options) | 是 | 创建KVStore实例的配置信息。 | +| callback | AsyncCallback<T>，<T extends KVStore> | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | - 示例： @@ -331,88 +172,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](#constants)。 | +| options | [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<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); + } + ``` ### closeKVStore8+ ### @@ -420,57 +224,16 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa 通过storId的值关闭指定的kvStore数据库，并通过callback方式返回，此方法为异步方法。 -- 参数： +- 参数： + + +| 参数名 | 参数类型 | 必填 | 说明 | +| ------- | ----------------- | ---- | --------------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 | +| kvStore | [KVStore](#kvstore) | 是 | 要关闭的KvStore数据库。 | +| callback | AsyncCallback<void> | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

-

storeId

-

string

-

是

-

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

-

kvStore

-

KVStore

-

是

-

要关闭的KvStore数据库。

-

callback

-

AsyncCallback<void>

-

是

-

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

-
- 示例： @@ -497,7 +260,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa } catch (e) { console.log('closeKVStore e ' + e); } - ``` + ``` ### closeKVStore8+ ### @@ -505,65 +268,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](#constants)。 | +| kvStore | [KVStore](#kvstore) | 是 | 要关闭的KvStore数据库。 | -- 返回值： +- 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

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

-
+| 类型 | 说明 | +| ------------- | -------------- | +| Promise | Promise实例，如果数据库关闭成功则返回true，否则返回false。 | - 示例： @@ -594,7 +311,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void& } catch (e) { console.log('closeKVStore e ' + e); } - ``` + ``` ### deleteKVStore8+ ### @@ -605,46 +322,12 @@ 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](#constants)。 | +| callback | AsyncCallback<void> | 是 | 回调函数，如果成功返回true，否则返回false。 | + - 示例： @@ -671,7 +354,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void> } catch (e) { console.log('DeleteKVStore e ' + e); } - ``` + ``` ### deleteKVStore8+ ### @@ -680,55 +363,18 @@ deleteKVStore(appId: string, storeId: string): Promise<void>; 通过storeId的值删除指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 - 参数： + +| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 | - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

-

storeId

-

string

-

是

-

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

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

类型

-

说明

-

Promise<void>

-

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

-
+| 类型 | 说明 | +| ------------- | -------------- | +| Promise<void> | Promise实例，如果成功返回true，否则返回false。 | - 示例： @@ -759,7 +405,7 @@ deleteKVStore(appId: string, storeId: string): Promise<void>; } catch (e) { console.log('deleteKVStore e ' + e); } - ``` + ``` ### getAllKVStoreId8+ ### @@ -770,37 +416,10 @@ getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

-

callback

-

AsyncCallback<void>

-

是

-

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

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| appId | string | 是 | 所调用数据库方的包名。 | +| callback | AsyncCallback<void> | 是 |回调函数，返回所有创建的 KvStore 数据库的 storeId。 | - 示例： @@ -814,7 +433,7 @@ getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void; } catch (e) { console.log('GetAllKVStoreId e ' + e); } - ``` + ``` ### getAllKVStoreId8+ ### @@ -825,45 +444,16 @@ getAllKVStoreId(appId: string): Promise<string[]>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

appId

-

string

-

是

-

所调用数据库方的包名。

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

类型

-

说明

-

Promise<string[]>

-

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

-
+- 返回值： + +| 类型 | 说明 | +| ------------- | -------------- | +| Promise<string[]>| Promise实例，返回所有创建的 KvStore 数据库的 storeId。 | - 示例： @@ -880,7 +470,7 @@ getAllKVStoreId(appId: string): Promise<string[]>; } catch(e) { console.log('getAllKVStoreId e ' + e); } - ``` + ``` ### on8+ ### @@ -891,34 +481,12 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): voi - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'distributedDataServiceDie'

-

是

-

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

-

deathCallback

-

Callback<void>

-

是

-

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

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event | 'distributedDataServiceDie' | 是 | 服务状态改变时触发的事件名。 | +| deathCallback | Callback<void> | 是 | 回调函数，在设备状态改变时获取通知。 | + + - 示例 @@ -934,7 +502,7 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): voi } catch (e) { console.log("An unexpected error occurred. Error:" + e); } - ``` + ``` ### off8+ ### @@ -945,34 +513,11 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'distributedDataServiceDie'

-

是

-

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

-

deathCallback

-

Callback<void>

-

否

-

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

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event | 'distributedDataServiceDie' | 是 | 服务状态改变时触发的事件名。 | +| deathCallback | Callback<void> | 否 | 回调函数，取消设备状态改变时获取通知。 | + - 示例 @@ -987,233 +532,61 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v } catch (e) { console.log("An unexpected error occurred. Error:" + e); } + + ``` - ``` - -## Options +## Options 用于提供创建数据库的配置信息。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

createIfMissing

-

boolean

-

否

-

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

-

encrypt

-

boolean

-

否

-

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

-

backup

-

boolean

-

否

-

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

-

autoSync

-

boolean

-

否

-

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

-

kvStoreType

-

KVStoreType

-

否

-

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

-

securityLevel

-

SecurityLevel

-

否

-

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

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

名称

-

默认值

-

说明

-

DEVICE_COLLABORATION

-

0

-

表示多设备协同数据库。

-

SINGLE_VERSION

-

1

-

表示单版本数据库。

-

MULTI_VERSION

-

2

-

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

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

名称

-

默认值

-

说明

-

NO_LEVEL

-

0

-

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

-

S0

-

1

-

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

-

S1

-

2

-

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

-

S2

-

3

-

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

-

S3

-

5

-

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

-

S4

-

6

-

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

-
- -## Constants +| 名称 | 默认值 | 说明 | +| --- | ---- | ----------------------- | +| NO_LEVEL | 0 | 表示数据库不设置安全级别。 | +| S0 | 1 | 表示数据库的安全级别为公共级别安全。 | +| S1 | 2 | 表示数据库的安全级别为低级别安全，当数据泄露时会产生较低影响。 | +| S2 | 3 | 表示数据库的安全级别为中级别安全，当数据泄露时会产生较大影响。 | +| S3 | 5 | 表示数据库的安全级别为高级别安全，当数据泄露时会产生重大影响。 | +| S4 | 6 | 表示数据库的安全级别为关键级别安全，当数据泄露时会产生严重影响。 | + + +## 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+ ## @@ -1227,20 +600,9 @@ toJsonString():string; - 返回值： - - - - - - - - - -

类型

-

说明

-

string

-

以 json 格式返回Schema。

-
+| 类型 | 说明 | +| ------------- | -------------- | +| string |以 json 格式返回Schema。 | - 示例 @@ -1253,10 +615,10 @@ toJsonString():string; } catch (e) { console.log("toJsonString " + e); } - ``` + ``` -## FieldNode8+ ## +## FieldNode8+ ## 表示 Schema 实例的节点，提供定义存储在数据库中的值的方法。 @@ -1268,43 +630,16 @@ appendChild(child: FieldNode): boolean; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

child

-

FieldNode

-

是

-

要附加的域节点。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| child | [FieldNode](#FieldNode) | 是 | 要附加的域节点。 | + - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果子节点成功添加到这个FieldNode，则返回 true；否则返回 false。

-
+| 类型 | 说明 | +| ------------- | -------------- | +| boolean |如果子节点成功添加到这个FieldNode，则返回 true；否则返回 false。 | - 示例 @@ -1326,7 +661,7 @@ appendChild(child: FieldNode): boolean; } catch (e) { console.log("AppendChild " + e); } - ``` + ``` ### toJson8+ ### @@ -1337,20 +672,9 @@ toJson(): string; - 返回值： - - - - - - - - - -

类型

-

说明

-

string

-

返回节点的字段名称。

-
+| 类型 | 说明 | +| ------ | -------------- | +| string |返回节点的字段名称。 | - 示例 @@ -1364,10 +688,10 @@ toJson(): string; } catch (e) { console.log("ToJson " + e); } - ``` + ``` -## KvStoreResultSet8+ ## +## KvStoreResultSet8+ ## 提供获取KvStore数据库结果集的方法，提供查询和移动数据读取位置的方法，在调用KvStoreResultSet的方法前，需要先通过KvStore 构建一个KvStore 实例。 @@ -1379,20 +703,9 @@ getCount(): number; - 返回值： - - - - - - - - - -

类型

-

说明

-

number

-

返回行数。

-
+| 类型 | 说明 | +| ------ | -------------- | +| number |返回行数。 | - 示例 @@ -1411,7 +724,7 @@ getCount(): number; } catch (e) { console.log("GetCount fail " + e); } - ``` + ``` ### getPosition8+ ### @@ -1422,20 +735,9 @@ getPosition(): number; - 返回值： - - - - - - - - - -

类型

-

说明

-

number

-

返回当前读取位置。

-
+| 类型 | 说明 | +| ------ | -------------- | +| number |返回当前读取位置。 | - 示例 @@ -1465,20 +767,9 @@ moveToFirst(): boolean; - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果操作成功则返回true，否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果操作成功则返回true，否则返回 false。 | - 示例 @@ -1508,20 +799,9 @@ moveToLast(): boolean; - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果操作成功则返回true，否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果操作成功则返回true，否则返回 false。 | - 示例 @@ -1551,20 +831,9 @@ moveToNext(): boolean; - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果操作成功则返回true，否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果操作成功则返回true，否则返回 false。 | - 示例 @@ -1594,20 +863,9 @@ moveToPrevious(): boolean; - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果操作成功则返回true，否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果操作成功则返回true，否则返回 false。 | - 示例 @@ -1637,42 +895,15 @@ move(offset: number): boolean; - 参数： - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

offset

-

number

-

是

-

表示与当前位置的相对偏移量，负偏移表示向后移动，正偏移表示向前移动。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| offset | number | 是 | 表示与当前位置的相对偏移量，负偏移表示向后移动，正偏移表示向前移动。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果操作成功则返回true，否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果操作成功则返回true，否则返回 false。 | - 示例 @@ -1702,42 +933,15 @@ moveToPosition(position: number): boolean; - 参数： - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

position

-

number

-

是

-

表示绝对位置。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| position | number | 是 |表示绝对位置。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果操作成功则返回true，否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果操作成功则返回true，否则返回 false。 | - 示例 @@ -1767,20 +971,9 @@ isFirst(): boolean; - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果读取位置是第一行，则返回 true；否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果读取位置是第一行，则返回 true；否则返回 false。 | - 示例 @@ -1810,20 +1003,9 @@ isLast(): boolean; - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果读取位置是最后一行，则返回 true；否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果读取位置是最后一行，则返回 true；否则返回 false。 | - 示例 @@ -1853,20 +1035,9 @@ isBeforeFirst(): boolean; - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果读取位置在第一行之前，则返回 true；否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果读取位置在第一行之前，则返回 true；否则返回 false。 | - 示例 @@ -1896,20 +1067,9 @@ isAfterLast(): boolean; - 返回值： - - - - - - - - - -

类型

-

说明

-

boolean

-

如果读取位置在最后一行之后，则返回 true；否则返回 false。

-
+| 类型 | 说明 | +| ------ | -------------- | +| boolean |如果读取位置在最后一行之后，则返回 true；否则返回 false。 | - 示例 @@ -1939,20 +1099,9 @@ getEntry(): Entry; - 返回值： - - - - - - - - - -

类型

-

说明

-

Entry

-

返回键值对。

-
+| 类型 | 说明 | +| ------ | ------- | +| Entry |返回键值对。| - 示例 @@ -1975,7 +1124,7 @@ getEntry(): Entry; ``` -## Query 8+ ## +## Query8+ ## 使用谓词表示数据库查询，提供创建Query实例、查询数据库中的数据和添加谓词的方法。 @@ -1987,20 +1136,9 @@ reset(): Query; - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回重置的 Query 对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回重置的 Query 对象。| - 示例 @@ -2026,51 +1164,16 @@ equalTo(field: string, value: number|string|boolean): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

value

-

number | string | boolean

-

是

-

表示指定的值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| value | number/string/boolean | 是 | 表示指定的值。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回重置的 Query 对象。| - 示例 @@ -2094,51 +1197,16 @@ notEqualTo(field: string, value: number|string|boolean): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

value

-

number|string|boolean

-

是

-

表示指定的值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| value | number/string/boolean | 是 | 表示指定的值。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回重置的 Query 对象。| - 示例 @@ -2162,51 +1230,16 @@ greaterThan(field: string, value: number|string|boolean): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

value

-

number|string|boolean

-

是

-

表示指定的值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| value | number/string/boolean | 是 | 表示指定的值。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2230,51 +1263,16 @@ lessThan(field: string, value: number|string): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

value

-

number|string

-

是

-

表示指定的值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| value | number/string/boolean | 是 | 表示指定的值。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2298,51 +1296,16 @@ greaterThanOrEqualTo(field: string, value: number|string): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

value

-

number|string

-

是

-

表示指定的值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| value | number/string/boolean | 是 | 表示指定的值。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2366,51 +1329,16 @@ lessThanOrEqualTo(field: string, value: number|string): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

value

-

number|string

-

是

-

表示指定的值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| value | number/string/boolean | 是 | 表示指定的值。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2434,43 +1362,15 @@ isNull(field: string): Query; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2494,51 +1394,17 @@ inNumber(field: string, valueList: number[]): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

valueList

-

number[]

-

是

-

表示指定的值列表。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| valueList | number[] | 是 | 表示指定的值列表。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| + - 示例 @@ -2562,51 +1428,16 @@ inString(field: string, valueList: string[]): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

valueList

-

string[]

-

是

-

表示指定的字符串值列表。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| valueList | string[] | 是 | 表示指定的字符串值列表。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2630,51 +1461,16 @@ notInNumber(field: string, valueList: number[]): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

valueList

-

number[]

-

是

-

表示指定的值列表。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| valueList | number[] | 是 | 表示指定的值列表。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2698,51 +1494,16 @@ notInString(field: string, valueList: string[]): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

valueList

-

string[]

-

是

-

表示指定的字符串值列表。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| valueList | string[] | 是 | 表示指定的字符串值列表。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2766,51 +1527,16 @@ like(field: string, value: string): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

value

-

string

-

是

-

表示指定的字符串值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| valueList | string | 是 | 表示指定的字符串值。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2834,51 +1560,16 @@ unlike(field: string, value: string): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-

value

-

string

-

是

-

表示指定的字符串值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | +| valueList | string | 是 | 表示指定的字符串值。| - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2902,20 +1593,9 @@ and(): Query; - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2941,20 +1621,9 @@ or(): Query; - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -2980,44 +1649,15 @@ orderByAsc(field: string): Query; - 参数： - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -3042,43 +1682,16 @@ orderByDesc(field: string): Query; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段，必须以$开头， 并且不能包含' ^ '。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| + - 示例 @@ -3103,51 +1716,16 @@ limit(total: number, offset: number): Query; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

total

-

number

-

是

-

表示指定的结果数。

-

offset

-

number

-

是

-

表示起始位置。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| total | number | 是 |表示指定的结果数。 | +| offset | number | 是 |表示起始位置。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -3172,43 +1750,15 @@ isNotNull(field: string): Query; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

fieId

-

string

-

是

-

表示指定字段。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| fieId | string | 是 |表示指定字段。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -3232,20 +1782,9 @@ beginGroup(): Query; - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -3271,20 +1810,9 @@ endGroup(): Query; - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -3310,43 +1838,15 @@ prefixKey(prefix: string): Query; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

prefix

-

string

-

是

-

表示指定的键前缀。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| prefix | string | 是 |表示指定的键前缀。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -3371,43 +1871,15 @@ setSuggestIndex(index: string): Query; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

index

-

string

-

是

-

指示要设置的索引。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| index | string | 是 |指示要设置的索引。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -3432,43 +1904,16 @@ deviceId(deviceId:string):Query; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

指示查询的设备 ID。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId | string | 是 |指示查询的设备 ID。 | + - 返回值： - - - - - - - - - -

类型

-

说明

-

Query

-

返回查询对象。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -3491,20 +1936,9 @@ getSqlLike():string; - 返回值： - - - - - - - - - -

类型

-

说明

-

string

-

返回指定Query对象的查询语句。

-
+| 类型 | 说明 | +| ------ | ------- | +| [Query](#querysup8sup) |返回查询对象。| - 示例 @@ -3519,11 +1953,11 @@ getSqlLike():string; ``` -## KVStore +## KVStore KVStore数据库实例，提供增加数据、删除数据和订阅数据变更、订阅同步完成的方法。在调用KVStore的方法前，需要先通过getKVStore构建一个KVStore实例。 -### put +### put put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback<void>): void @@ -3531,47 +1965,12 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

key

-

string

-

是

-

要添加数据的key，不能为空且长度不大于MAX_KEY_LENGTH。

-

value

-

Uint8Array | string | number | boolean

-

是

-

要添加数据的value，支持Uint8Array、number 、 string 、boolean，

-

Uint8Array、string 的长度不大于MAX_VALUE_LENGTH。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| key | string | 是 |要添加数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 | +| value | Uint8Array / string / number / boolean | 是 |要添加数据的value，支持Uint8Array、number 、 string 、boolean， +Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#constants)。 | + - 示例 @@ -3593,7 +1992,7 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC ``` -### put +### put put(key: string, value: Uint8Array | string | number | boolean): Promise<void> @@ -3601,55 +2000,17 @@ put(key: string, value: Uint8Array | string | number | boolean): Promise<void - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

key

-

string

-

是

-

要添加数据的key，不能为空且长度不大于MAX_KEY_LENGTH。

-

value

-

Uint8Array | string | number | boolean

-

是

-

要添加数据的value，支持Uint8Array、number 、 string 、boolean，

-

Uint8Array、string 的长度不大于MAX_VALUE_LENGTH。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| key | string | 是 |要添加数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 | +| value | Uint8Array / string / number / boolean | 是 |要添加数据的value，支持Uint8Array、number 、 string 、boolean， +Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#constants)。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于异步处理。

-
+| 类型 | 说明 | +| ------ | ------- | +| Promise<void> |Promise实例，用于异步处理。| - 示例 @@ -3670,7 +2031,7 @@ put(key: string, value: Uint8Array | string | number | boolean): Promise<void ``` -### delete +### delete delete(key: string, callback: AsyncCallback<void>): void @@ -3678,37 +2039,10 @@ delete(key: string, callback: AsyncCallback<void>): void - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

key

-

string

-

是

-

要删除数据的key，不能为空且长度不大于MAX_KEY_LENGTH。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| key | string | 是 |要删除数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 | +| callback | AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -3737,7 +2071,7 @@ delete(key: string, callback: AsyncCallback<void>): void ``` -### delete +### delete delete(key: string): Promise<void> @@ -3745,45 +2079,15 @@ delete(key: string): Promise<void> - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

key

-

string

-

是

-

要删除数据的key，不能为空且长度不大于MAX_KEY_LENGTH。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| key | string | 是 |要删除数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于异步处理。

-
+| 类型 | 说明 | +| ------ | ------- | +| Promise<void> |Promise实例，用于异步处理。| - 示例 @@ -3808,7 +2112,7 @@ delete(key: string): Promise<void> ``` -### on +### on on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification>): void @@ -3816,46 +2120,12 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotific - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'dataChange'

-

是

-

回调函数名称。

-

type

-

SubscribeType

-

是

-

表示订阅的类型。

-

observer

-

Callback<ChangeNotification>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event |'dataChange' | 是 |回调函数名称。 | +| type |[SubscribeType](#subscribetypea) | 是 |表示订阅的类型。 | +| observer |Callback<[ChangeNotification](#changenotificationa)> | 是 |回调函数。 | + - 示例 @@ -3867,7 +2137,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotific ``` -### on +### on on(event: 'syncComplete', syncCallback: Callback - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'syncComplete'

-

是

-

回调函数名称。

-

syncCallback

-

Callback<Array<[string, number]>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event |'syncComplete' | 是 |回调函数名称。 | +| syncCallback |Callback<Array<[string, number]> | 是 |回调函数。 | + - 示例 @@ -3916,7 +2160,7 @@ on(event: 'syncComplete', syncCallback: Callback8+ ### +### off8+ off(event:'dataChange', observer?: Callback<ChangeNotification>): void; @@ -3924,36 +2168,10 @@ off(event:'dataChange', observer?: Callback<ChangeNotification>): void; - 参数： - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'datachange'

-

是

-

回调函数名称。

-

observer

-

Callback<ChangeNotification>

-

否

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event |'dataChange' | 是 |回调函数名称。 | +| observer |Callback<[ChangeNotification](#changenotificationa)> |否 |回调函数。 | - 示例 @@ -3968,7 +2186,7 @@ off(event:'dataChange', observer?: Callback<ChangeNotification>): void; ``` -### putBatch8+ ### +### putBatch8+ putBatch(entries: Entry[], callback: AsyncCallback<void>): void; @@ -3976,34 +2194,10 @@ putBatch(entries: Entry[], callback: AsyncCallback<void>): void; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

entries

-

Entry[]

-

是

-

表示要批量插入的键值对。

-

callback

-

Asyncallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| entries |[Entry](#entry)[] | 是 |表示要批量插入的键值对。 | +| callback |Asyncallback<void> |是 |回调函数。 | - 示例 @@ -4034,11 +2228,11 @@ putBatch(entries: Entry[], callback: AsyncCallback<void>): void; }catch(e) { console.log('PutBatch e ' + e); } - + ``` -### putBatch8+ ### +### putBatch8+ putBatch(entries: Entry[]): Promise<void>; @@ -4046,43 +2240,15 @@ putBatch(entries: Entry[]): Promise<void>; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

entries

-

Entry[]

-

是

-

表示要批量插入的键值对。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| entries |[Entry](#entry)[] | 是 |表示要批量插入的键值对。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于异步处理。

-
+| 类型 | 说明 | +| ------ | ------- | +| Promise<void> |Promise实例，用于异步处理。| - 示例 @@ -4119,7 +2285,7 @@ putBatch(entries: Entry[]): Promise<void>; ``` -### deleteBatch8+ ### +### deleteBatch8+ deleteBatch(keys: string[], callback: AsyncCallback<void>): void; @@ -4127,34 +2293,10 @@ deleteBatch(keys: string[], callback: AsyncCallback<void>): void; - 参数： - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

keys

-

string[]

-

是

-

表示要批量删除的键值对。

-

callback

-

Asyncallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| keys |string[] | 是 |表示要批量删除的键值对。 | +| callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -4196,43 +2338,15 @@ deleteBatch(keys: string[]): Promise<void>; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

keys

-

string[]

-

是

-

表示要批量删除的键值对。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| keys |string[] | 是 |表示要批量删除的键值对。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于异步处理。

-
+| 类型 | 说明 | +| ------ | ------- | +| Promise<void> |Promise实例，用于异步处理。| - 示例 @@ -4278,26 +2392,9 @@ startTransaction(callback: AsyncCallback<void>): void; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -4345,20 +2442,9 @@ startTransaction(): Promise<void>; - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于异步处理。

-
+| 类型 | 说明 | +| ------ | ------- | +| Promise<void> |Promise实例，用于异步处理。| - 示例 @@ -4389,26 +2475,9 @@ commit(callback: AsyncCallback<void>): void; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -4436,20 +2505,9 @@ commit(): Promise<void>; - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于异步处理。

-
+| 类型 | 说明 | +| ------ | ------- | +| Promise<void> |Promise实例，用于异步处理。| - 示例 @@ -4475,26 +2533,9 @@ rollback(callback: AsyncCallback<void>): void; - 参数： - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -4522,20 +2563,9 @@ rollback(): Promise<void>; - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于异步处理。

-
+| 类型 | 说明 | +| ------ | ------- | +| Promise<void> |Promise实例，用于异步处理。| - 示例 @@ -4561,37 +2591,10 @@ enableSync(enabled: boolean, callback: AsyncCallback<void>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

enabled

-

boolean

-

是

-

指定是否开启同步，ture表示开启同步，false表示不启用同步。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| enabled |boolean | 是 |指定是否开启同步，ture表示开启同步，false表示不启用同步。 | +| callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -4619,45 +2622,15 @@ enableSync(enabled: boolean): Promise<void>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

enabled

-

boolean

-

是

-

指定是否开启同步，ture表示开启同步，false表示不启用同步。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| enabled |boolean | 是 |指定是否开启同步，ture表示开启同步，false表示不启用同步。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于异步处理。

-
+| 类型 | 说明 | +| ------ | ------- | +| Promise<void> |Promise实例，用于异步处理。| - 示例 @@ -4683,46 +2656,11 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: Asy - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

localLabels

-

string[]

-

是

-

表示本地设备的同步标签。

-

remoteSupportLabels

-

string[]

-

是

-

表示要同步数据的设备的同步标签。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| localLabels |string[] | 是 |表示本地设备的同步标签。 | +| remoteSupportLabels |string[] | 是 |表示要同步数据的设备的同步标签。 | +| callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -4748,54 +2686,17 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise<v - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

localLabels

-

string[]

-

是

-

表示本地设备的同步标签。

-

remoteSupportLabels

-

string[]

-

是

-

表示要同步数据的设备的同步标签。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| localLabels |string[] | 是 |表示本地设备的同步标签。 | +| remoteSupportLabels |string[] | 是 |表示要同步数据的设备的同步标签。 | + - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于异步处理。

-
+| 类型 | 说明 | +| ------ | ------- | +| Promise<void> |Promise实例，用于异步处理。| - 示例 @@ -4815,256 +2716,66 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise<v ``` -## SubscribeType +## SubscribeType 描述订阅类型。 - - - - - - - - - - - - - - - - - - - -

名称

-

默认值

-

说明

-

SUBSCRIBE_TYPE_LOCAL

-

0

-

表示订阅本地数据变更。

-

SUBSCRIBE_TYPE_REMOTE

-

1

-

表示订阅远端数据变更。

-

SUBSCRIBE_TYPE_ALL

-

2

-

表示订阅远端和本地数据变更。

-
- -## ChangeNotification +| 名称 | 默认值 | 说明 | +| ----- | ------ | ----------------------- | +| SUBSCRIBE_TYPE_LOCAL |0 |表示订阅本地数据变更。 | +| SUBSCRIBE_TYPE_REMOTE |1 |表示订阅远端数据变更。 | +| SUBSCRIBE_TYPE_ALL |2 |表示订阅远端和本地数据变更。 | + +## ChangeNotification 数据变更时通知的对象，包括数据插入的数据、更新的数据、删除的数据和设备ID。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

名称

-

参数类型

-

可读

-

可写

-

说明

-

insertEntries

-

Entry[]

-

是

-

是

-

数据添加记录。

-

updateEntries

-

Entry[]

-

是

-

是

-

数据更新记录。

-

deleteEntries

-

Entry[]

-

是

-

是

-

数据删除记录。

-

deviceId

-

string

-

是

-

是

-

设备ID，此处为设备UUID。

-
- -## Entry +| 名称 | 参数类型 |可读 |可写 | 说明 | +| ----- | ------- | -----| ------|------------------------ | +| insertEntries | [Entry](#entry)[] | 是 | 是 |数据添加记录。 | +| updateEntries | [Entry](#entry)[] | 是 | 是 |数据更新记录。 | +| deleteEntries | [Entry](#entry)[] | 是 | 是 |数据删除记录。 | +| deviceId | string | 是 | 是 |设备ID，此处为设备UUID。 | + +## Entry 存储在数据库中的键值对。 - - - - - - - - - - - - - - - - - - - - - -

名称

-

参数类型

-

可读

-

可写

-

说明

-

key

-

string

-

是

-

是

-

键值。

-

value

-

Value

-

是

-

是

-

值对象。

-
- -## Value +| 名称 | 参数类型 |可读 |可写 | 说明 | +| ----- | ------- | -----| ------|------------------------ | +| key | string | 是 | 是 |键值。 | +| value | [Value](#value) | 是 | 是 |值对象。 | + + +## Value 存储在数据库中的对象。 - - - - - - - - - - - - - - - - - - - - - -

名称

-

参数类型

-

可读

-

可写

-

说明

-

type

-

ValueType

-

是

-

是

-

值类型。

-

value

-

Uint8Array | string | number | boolean

-

是

-

是

-

值，Uint8Array、string 的长度不大于MAX_VALUE_LENGTH。

-
- -## ValueType +| 名称 | 参数类型 |可读 |可写 | 说明 | +| ----- | ------- | -----| ------|------------------------ | +| type | [ValueType](#value) | 是 | 是 |值类型。 | +| value | Uint8Array / string / number / boolean| 是 | 是 |值对象。 | + +## ValueType 用于表示数据类型。 只能被内部应用使用。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

名称

-

默认值

-

说明

-

STRING

-

0

-

表示值类型为字符串。

-

INTEGER

-

1

-

表示值类型为整数。

-

FLOAT

-

2

-

表示值类型为浮点数。

-

BYTE_ARRAY

-

3

-

表示值类型为字节数组。

-

BOOLEAN

-

4

-

表示值类型为布尔值。

-

DOUBLE

-

5

-

表示值类型为双浮点数。

-
- -## SingleKVStore +| 名称 | 默认值 | 说明 | +| ----- | ------ | ----------------------- | +| STRING |0 |表示值类型为字符串。 | +| INTEGER |1 |表示值类型为整数。 | +| FLOAT |2 |表示值类型为浮点数。 | +| BYTE_ARRAY |3 |表示值类型为字节数组。 | +| BOOLEAN |4 |表示值类型为布尔值。 | +| DOUBLE |5 |表示值类型为双浮点数。 | + +## SingleKVStore 单版本分布式数据库，继承自KVStore，提供查询数据和同步数据的方法。在调用 SingleKVStore 的方法前，需要先通过 getKVStore 构建一个 SingleKVStore 实例。 -### get +### get get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | number>): void @@ -5072,37 +2783,10 @@ get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | numb - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

key

-

string

-

是

-

要查询数据的key，不能为空且长度不大于MAX_KEY_LENGTH。

-

callback

-

AsyncCallback<Uint8Array | string | boolean | number>

-

是

-

回调函数，获取查询的值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| key |string | 是 |要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 | +| callback |AsyncCallback<Uint8Array / string / boolean / number>) | 是 |回调函数，获取查询的值。 | - 示例 @@ -5127,7 +2811,7 @@ get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | numb ``` -### get +### get get(key: string): Promise<Uint8Array | string | boolean | number> @@ -5135,45 +2819,16 @@ get(key: string): Promise<Uint8Array | string | boolean | number> - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

key

-

string

-

是

-

要查询数据的key，不能为空且长度不大于MAX_KEY_LENGTH。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| key |string | 是 |要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 | + - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<Uint8Array | string | boolean | number>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<Uint8Array / string / boolean / number> |Promise实例，用于获取异步返回结果。| - 示例 @@ -5206,37 +2861,10 @@ getEntries(keyPrefix: string, callback: AsyncCallback<Entry[]>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

keyPrefix

-

string

-

是

-

表示要匹配的键前缀。

-

callback

-

AsyncCallback<Entry[]>

-

是

-

回调函数，获取指定前缀的键值对列表。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| keyPrefix |string | 是 |表示要匹配的键前缀。 | +| callback |AsyncCallback<Entry[]> | 是 |回调函数，获取指定前缀的键值对列表。 | - 示例 @@ -5277,45 +2905,15 @@ getEntries(keyPrefix: string): Promise<Entry[]>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

keyPrefix

-

string

-

是

-

表示要匹配的键前缀。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| keyPrefix |string | 是 |表示要匹配的键前缀。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<Entry[]>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[Entry](#entry)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -5363,37 +2961,10 @@ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-

callback

-

AsyncCallback<Entry[]>

-

是

-

回调函数，获取指定前缀的键值对列表。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示要匹配的键前缀。 | +| callback |AsyncCallback<Entry[]> | 是 |回调函数，获取指定前缀的键值对列表。 | - 示例 @@ -5439,45 +3010,15 @@ getEntries(query: Query): Promise<Entry[]>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<Entry[]>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[Entry](#entry)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -5524,37 +3065,10 @@ getResultSet(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>) - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

keyPrefix

-

string

-

是

-

表示要匹配的键前缀。

-

callback

-

AsyncCallback<KvStoreResultSet>

-

是

-

回调函数，获取具有指定前缀的结果集。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| keyPrefix |string | 是 |表示要匹配的键前缀。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)> | 是 |表示要匹配的键前缀。 | - 示例 @@ -5598,45 +3112,15 @@ getResultSet(keyPrefix: string): Promise<KvStoreResultSet>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

keyPrefix

-

string

-

是

-

表示要匹配的键前缀。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| keyPrefix |string | 是 |表示要匹配的键前缀。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<KvStoreResultSet>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)> |Promise实例，用于获取异步返回结果。| - 示例 @@ -5686,37 +3170,10 @@ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): voi - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-

callback

-

AsyncCallback<KvStoreResultSet>

-

是

-

回调函数，获取与指定 Query 对象匹配的 KvStoreResultSet 对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |Query | 是 |表示查询对象。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)> | 是 |回调函数，获取与指定 Query 对象匹配的 KvStoreResultSet 对象。 | - 示例 @@ -5759,45 +3216,15 @@ getResultSet(query: Query): Promise<KvStoreResultSet>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<KvStoreResultSet>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)> |Promise实例，用于获取异步返回结果。| - 示例 @@ -5843,37 +3270,10 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>) - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

resultSet

-

KvStoreResultSet

-

是

-

表示要关闭的 KvStoreResultSet 对象。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数，获取由 getResultSet 返回的 KvStoreResultSet 对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| resultSet |[KvStoreResultSet](#kvstoreresultsetsup8sup) | 是 |表示要关闭的 KvStoreResultSet 对象。 | +| callback |AsyncCallback<void> | 是 |回调函数，获取由 getResultSet 返回的 KvStoreResultSet 对象。 | - 示例 @@ -5902,45 +3302,15 @@ closeResultSet(resultSet: KvStoreResultSet): Promise<void>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

resultSet

-

KvStoreResultSet

-

是

-

表示要关闭的 KvStoreResultSet 对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| resultSet |[KvStoreResultSet](#kvstoreresultsetsup8sup) | 是 |表示要关闭的 KvStoreResultSet 对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<void> |Promise实例，用于获取异步返回结果。| - 示例 @@ -5967,37 +3337,10 @@ getResultSize(query: Query, callback: AsyncCallback<number>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-

callback

-

AsyncCallback<number>

-

是

-

回调函数，获取与指定 Query 对象匹配的结果数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| callback |AsyncCallback<number> | 是 |回调函数，获取与指定 Query 对象匹配的结果数。 | - 示例 @@ -6038,45 +3381,15 @@ getResultSize(query: Query): Promise<number>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<number>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<number> |Promise实例，用于获取异步返回结果。| - 示例 @@ -6121,37 +3434,10 @@ removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

表示要删除设备的名称。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |表示要删除设备的名称。 | +| callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -6188,45 +3474,15 @@ removeDeviceData(deviceId: string): Promise<void>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

表示要删除设备的名称。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |表示要删除设备的名称。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<void> |Promise实例，用于获取异步返回结果。| - 示例 @@ -6265,37 +3521,10 @@ on(event: 'syncComplete', syncCallback: Callback - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'syncComplete'

-

是

-

同步完成时触发的事件名。

-

syncCallback

-

Callback<Array<[string, number]>

-

是

-

用于向调用方发送同步结果的回调。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event |'syncComplete' | 是 |同步完成时触发的事件名。 | +| syncCallback |Callback - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'syncComplete'

-

是

-

同步完成时触发的事件名。

-

syncCallback

-

Callback<Array<[string, number]>

-

否

-

用于向调用方发送同步结果的回调。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event |'syncComplete' | 是 |同步完成时触发的事件名。 | +| syncCallback |Callback +### sync sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void @@ -6382,46 +3585,11 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceIdList

-

string[]

-

是

-

同一组网环境下，需要同步的设备的deviceId列表。

-

mode

-

SyncMode

-

是

-

同步类型。

-

allowedDelayMs

-

number

-

否

-

可选参数，允许延时时间，单位：ms（毫秒）。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceIdList |string[] | 是 |同一组网环境下，需要同步的设备的deviceId列表。 | +| mode |[SyncMode](#syncmode) | 是 |同步类型。 | +| allowedDelayMs |number | 否 |可选参数，允许延时时间，单位：ms（毫秒）。 | - 示例： @@ -6438,37 +3606,11 @@ setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback<void>) - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

defaultAllowedDelayMs

-

number

-

是

-

表示数据库同步允许的默认延迟，以毫秒为单位。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| defaultAllowedDelayMs |number | 是 |表示数据库同步允许的默认延迟，以毫秒为单位。 | +| callback |AsyncCallback<void> | 是 |回调函数。 | + - 示例 @@ -6493,45 +3635,16 @@ setSyncParam(defaultAllowedDelayMs: number): Promise<void>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

defaultAllowedDelayMs

-

number

-

是

-

表示数据库同步允许的默认延迟，以毫秒为单位。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| defaultAllowedDelayMs |number | 是 |表示数据库同步允许的默认延迟，以毫秒为单位。 | + - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<void> |Promise实例，用于获取异步返回结果。| - 示例 @@ -6558,28 +3671,9 @@ getSecurityLevel(callback: AsyncCallback<SecurityLevel>): void; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<SecurityLevel>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| callback |AsyncCallback<[SecurityLevel](#securitylevel)> | 是 |回调函数。 | - 示例 @@ -6603,20 +3697,10 @@ getSecurityLevel(): Promise<SecurityLevel>; - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<SecurityLevel>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[SecurityLevel](#securitylevel)> |Promise实例，用于获取异步返回结果。| + - 示例 @@ -6646,46 +3730,12 @@ get(deviceId: string, key: string, callback: AsyncCallback<boolean|string|num - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

标识要查询其数据的设备。

-

key

-

string

-

是

-

表示要查询 key 值的键。

-

callback

-

AsyncCallback<boolean|string|number|Uint8Array>

-

是

-

回调函数，返回匹配给定条件的字符串值。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |标识要查询其数据的设备。 | +| key |string | 是 |表示要查询 key 值的键。 | +| callback |AsyncCallback<boolean/string/number/Uint8Array> | 是 |回调函数，返回匹配给定条件的字符串值。 | + - 示例 @@ -6714,54 +3764,16 @@ get(deviceId: string, key: string): Promise<boolean|string|number|Uint8Array& - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

标识要查询其数据的设备。

-

key

-

string

-

是

-

表示要查询的 key 值的键。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |标识要查询其数据的设备。 | +| key |string | 是 |表示要查询 key 值的键。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<boolean|string|number|Uint8Array>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<boolean/string/number/Uint8Array> |Promise实例，用于获取异步返回结果。| - 示例 @@ -6794,46 +3806,11 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

标识要查询其数据的设备。

-

keyPrefix

-

string

-

是

-

表示要匹配的键前缀。

-

callback

-

AsyncCallback<Entry[]>

-

是

-

回调函数，返回满足给定条件的所有键值对的列表。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |标识要查询其数据的设备。 | +| keyPrefix |string | 是 |表示要匹配的键前缀。 | +| callback |AsyncCallback<[Entry](#entry)[]> | 是 |回调函数，返回满足给定条件的所有键值对的列表。 | - 示例 @@ -6875,54 +3852,16 @@ getEntries(deviceId: string, keyPrefix: string): Promise<Entry[]>; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

标识要查询其数据的设备。

-

keyPrefix

-

string

-

是

-

表示要匹配的键前缀。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |标识要查询其数据的设备。 | +| keyPrefix |string | 是 |表示要匹配的键前缀。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<Entry[]>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[Entry](#entry)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -6970,37 +3909,10 @@ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-

callback

-

AsyncCallback<Entry[]>

-

是

-

回调函数，返回与指定 Query 对象匹配的键值对列表。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| callback |AsyncCallback<[Entry](#entry)[]> | 是 |回调函数，返回与指定 Query 对象匹配的键值对列表。 | - 示例 @@ -7048,45 +3960,15 @@ getEntries(query: Query): Promise<Entry[]>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<Entry[]>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[Entry](#entry)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -7134,46 +4016,11 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback<Entry[]> - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

键值对所属的设备ID。

-

query

-

Query

-

是

-

表示查询对象。

-

callback

-

AsyncCallback<Entry[]>

-

是

-

回调函数，返回与指定 Query 对象匹配的键值对列表。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |键值对所属的设备ID。 | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| callback |AsyncCallback<[Entry](#entry)[]> | 是 |回调函数，返回与指定 Query 对象匹配的键值对列表。 | - 示例 @@ -7221,54 +4068,16 @@ getEntries(deviceId: string, query: Query): Promise<Entry[]>; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

键值对所属的设备ID。

-

query

-

Query

-

是

-

表示查询对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |键值对所属的设备ID。 | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<Entry[]>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[Entry](#entry)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -7317,46 +4126,11 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvS - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

标识要查询其数据的设备。

-

keyPrefix

-

string

-

是

-

表示要匹配的键前缀。

-

callback

-

AsyncCallback<KvStoreResultSet>

-

是

-

回调函数，返回 KvStoreResultSet 对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |标识要查询其数据的设备。 | +| keyPrefix |string | 是 |表示要匹配的键前缀。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> | 是 |回调函数，返回 KvStoreResultSet 对象。 | - 示例 @@ -7385,54 +4159,16 @@ getResultSet(deviceId: string, keyPrefix: string): Promise<KvStoreResultSet&g - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

标识要查询其数据的设备。

-

keyPrefix

-

string

-

是

-

表示要匹配的键前缀。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |标识要查询其数据的设备。 | +| keyPrefix |string | 是 |表示要匹配的键前缀。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<KvStoreResultSet>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -7465,37 +4201,10 @@ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): voi - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-

callback

-

AsyncCallback<KvStoreResultSet>

-

是

-

回调函数，返回与指定 Query 对象匹配的 KvStoreResultSet 对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> | 是 |回调函数，返回与指定 Query 对象匹配的 KvStoreResultSet 对象。 | - 示例 @@ -7542,45 +4251,15 @@ getResultSet(query: Query): Promise<KvStoreResultSet>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<KvStoreResultSet>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -7634,46 +4313,11 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback<KvStoreR - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

KvStoreResultSet对象所属的设备ID。

-

query

-

Query

-

是

-

表示查询对象。

-

callback

-

AsyncCallback<KvStoreResultSet>

-

是

-

回调函数，返回与指定 Query 对象匹配的 KvStoreResultSet 对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> | 是 |回调函数，返回与指定 Query 对象匹配的 KvStoreResultSet 对象。 | - 示例 @@ -7719,54 +4363,16 @@ getResultSet(deviceId: string, query: Query): Promise<KvStoreResultSet>; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

KvStoreResultSet对象所属的设备ID。

-

query

-

Query

-

是

-

表示查询对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<KvStoreResultSet>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -7806,7 +4412,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); } @@ -7821,37 +4427,10 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>) - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

resultSet

-

KvStoreResultSet

-

是

-

指示要关闭的 KvStoreResultSet 对象。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| resultSet |[KvStoreResultSet](#getresultsetsup8sup) | 是 |指示要关闭的 KvStoreResultSet 对象。 | +| callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -7881,45 +4460,15 @@ closeResultSet(resultSet: KvStoreResultSet): Promise<void>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

resultSet

-

KvStoreResultSet

-

是

-

指示要关闭的 KvStoreResultSet 对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| resultSet |[KvStoreResultSet](#getresultsetsup8sup) | 是 |指示要关闭的 KvStoreResultSet 对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<void> |Promise实例，用于获取异步返回结果。| - 示例 @@ -7947,37 +4496,10 @@ getResultSize(query: Query, callback: AsyncCallback<number>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-

callback

-

AsyncCallback<number>

-

是

-

回调函数，返回与指定 Query 对象匹配的结果数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| callback |AsyncCallback<number> | 是 |回调函数，返回与指定 Query 对象匹配的结果数。 | - 示例 @@ -8019,45 +4541,15 @@ getResultSize(query: Query): Promise<number>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

query

-

Query

-

是

-

表示查询对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<number>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<number> |Promise实例，用于获取异步返回结果。| - 示例 @@ -8103,46 +4595,11 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback<number& - 参数： - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

表示结果所属的设备ID。

-

query

-

Query

-

是

-

表示查询对象。

-

callback

-

AsyncCallback<number>

-

是

-

回调函数，返回与指定 Query 对象匹配的结果数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| callback |AsyncCallback<number> | 是 |回调函数，返回与指定 Query 对象匹配的结果数。 | - 示例 @@ -8183,54 +4640,16 @@ getResultSize(deviceId: string, query: Query): Promise<number>; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

表示结果所属的设备ID。

-

query

-

Query

-

是

-

表示查询对象。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | +| query |[Query](#querysup8sup) | 是 |表示查询对象。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<number>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<number> |Promise实例，用于获取异步返回结果。| - 示例 @@ -8275,37 +4694,10 @@ removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void; - 参数： - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

标识要删除其数据的设备。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |标识要删除其数据的设备。 | +| callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -8342,45 +4734,15 @@ removeDeviceData(deviceId: string): Promise<void>; - 参数： - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceId

-

string

-

是

-

标识要删除其数据的设备。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceId |string | 是 |标识要删除其数据的设备。 | - 返回值： - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise实例，用于获取异步返回结果。

-
+| 类型 | 说明 | +| ------ | ------- | +|Promise<void> |Promise实例，用于获取异步返回结果。| - 示例 @@ -8419,46 +4781,12 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void; - 参数： - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

deviceIdList

-

string[]

-

是

-

需要同步DeviceKvStore数据库的设备ID列表。

-

mode

-

SyncMode

-

是

-

表示同步方式，PUSH、PULL或PUSH_PULL。

-

allowedDelayMs

-

- number

-

否

-

可选参数，允许延时时间，单位：ms（毫秒）。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| deviceIdList |string[] | 是 |需要同步DeviceKvStore数据库的设备ID列表。 | +| mode |[SyncMode](#syncmode) | 是 |表示同步方式，PUSH、PULL或PUSH_PULL。 | +| allowedDelayMs |number | 否 |可选参数，允许延时时间，单位：ms（毫秒）。 | + - 示例 @@ -8489,37 +4817,10 @@ on(event: 'syncComplete', syncCallback: Callback - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'syncComplete'

-

是

-

同步完成时触发的事件名。

-

syncCallback

-

Callback<Array<[string, number]>

-

是

-

用于向调用方发送同步结果的回调。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event |'syncComplete' | 是 |同步完成时触发的事件名。 | +| syncCallback |Callback - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

event

-

'syncComplete'

-

是

-

同步完成时触发的事件名。

-

syncCallback

-

Callback<Array<[string, number]>

-

否

-

用于向调用方发送同步结果的回调。

-
+| 参数名 | 参数类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------- | +| event |'syncComplete' | 是 |同步完成时触发的事件名。 | +| syncCallback |Callback +## SyncMode 用于指定同步模式。 - - - - - - - - - - - - - - - - - - - -

名称

-

默认值

-

说明

-

PULL_ONLY

-

0

-

表示只能从远端拉取数据到本端。

-

PUSH_ONLY

-

1

-

表示只能从本端推送数据到对端。

-

PUSH_PULL

-

2

-

表示从本端推送数据到远端，然后从远端拉取数据到本端。

-
\ No newline at end of file +| 名称 | 默认值 | 说明 | +| ----- | ------ | ----------------------- | +| PULL_ONLY |0 |表示只能从远端拉取数据到本端。 | +| PUSH_ONLY |1 |表示只能从本端推送数据到对端。 | +| PUSH_PULL |2 |表示从本端推送数据到远端，然后从远端拉取数据到本端。 |