Skip to content

D
Docs

Tonvia / Docs
与 Fork 源项目一致

Fork自 OpenHarmony / Docs

通知 1
Star 0
Fork 0
D
Docs

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

提交 6b19401a 编写于 作者: G ge-yafang
浏览文件
操作

update docs 

Signed-off-by: Nge-yafang <geyafang@huawei.com>
上级 6cbfbc2d
显示空白变更内容
内联 并排
Showing with 2167 addition and 2191 deletion
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
浏览文件 @ 6b19401a
......@@ -27,9 +27,9 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback&lt;KVManager&gt
| callback | AsyncCallback&lt;[KVManager](#kvmanager)&gt; | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 |
**示例**：
let kvManager;
try {
```
let kvManager;
try {
const kvManagerConfig = {
bundleName : 'com.example.datamanagertest',
userInfo : {
......@@ -45,9 +45,10 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback&lt;KVManager&gt
console.log("createKVManager success");
kvManager = manager;
});
} catch (e) {
} catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
}
```
## distributedData.createKVManager
......@@ -71,8 +72,9 @@ createKVManager(config: KVManagerConfig): Promise&lt;KVManager&gt;
**示例**：
let kvManager;
try {
```
let kvManager;
try {
const kvManagerConfig = {
bundleName : 'com.example.datamanagertest',
userInfo : {
......@@ -86,10 +88,10 @@ createKVManager(config: KVManagerConfig): Promise&lt;KVManager&gt;
}).catch((err) => {
console.log("createKVManager err: " + JSON.stringify(err));
});
} catch (e) {
} catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
}
```
## KVManagerConfig
......@@ -102,8 +104,6 @@ createKVManager(config: KVManagerConfig): Promise&lt;KVManager&gt;
| userInfo | [UserInfo](#userinfo) | 是 | 调用方的用户信息。 |
| bundleName | string | 是 | 调用方的包名。 |
## UserInfo
用户信息。
......@@ -131,8 +131,6 @@ createKVManager(config: KVManagerConfig): Promise&lt;KVManager&gt;
数据管理实例，用于获取KVStore的相关信息。在调用KVManager的方法前，需要先通过createKVManager构建一个KVManager实例。
### getKVStore
getKVStore&lt;T extends KVStore&gt;(storeId: string, options: Options, callback: AsyncCallback&lt;T&gt;): void
......@@ -151,10 +149,10 @@ getKVStore&lt;T extends KVStore&gt;(storeId: string, options: Options, callback:
**示例**：
```
let kvStore;
let kvManager;
try {
```
let kvStore;
let kvManager;
try {
const options = {
createIfMissing : true,
encrypt : false,
......@@ -171,10 +169,10 @@ getKVStore&lt;T extends KVStore&gt;(storeId: string, options: Options, callback:
console.log("getKVStore success");
kvStore = store;
});
} catch (e) {
} catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
```
}
```
### getKVStore
......@@ -199,13 +197,12 @@ getKVStore&lt;T extends KVStore&gt;(storeId: string, options: Options): Promise&
| -------------------------------------- | ------------------------ |
| Promise&lt;T&gt; &lt;T extends KVStore&gt; | 指定的Promise回调方法，返回创建的KVStore数据库实例。 |
**示例**：
```
let kvStore;
let kvManager;
try {
```
let kvStore;
let kvManager;
try {
const options = {
createIfMissing : true,
encrypt : false,
......@@ -220,10 +217,10 @@ getKVStore&lt;T extends KVStore&gt;(storeId: string, options: Options): Promise&
}).catch((err) => {
console.log("getKVStore err: " + JSON.stringify(err));
});
} catch (e) {
} catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
```
}
```
### closeKVStore<sup>8+</sup> ###
......@@ -243,13 +240,12 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa
| kvStore | [KVStore](#kvstore) | 是 | 要关闭的KvStore数据库。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 |
**示例**：
```
let kvStore;
let kvManager;
const options = {
```
let kvStore;
let kvManager;
const options = {
createIfMissing : true,
encrypt : false,
backup : false,
......@@ -266,10 +262,11 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa
console.log('closeKVStore success');
});
});
} catch (e) {
} catch (e) {
console.log('closeKVStore e ' + e);
}
```
}
```
### closeKVStore<sup>8+</sup> ###
......@@ -295,10 +292,10 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise&lt;void&
**示例**：
```
let kvManager;
let kvStore;
const options = {
```
let kvManager;
let kvStore;
const options = {
createIfMissing : true,
encrypt : false,
backup : false,
......@@ -306,7 +303,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise&lt;void&
kvStoreType : distributedData.KVStoreType.SINGLE_VERSION,
schema : '',
securityLevel : distributedData.SecurityLevel.S2,
}
}
try {
kvManager.getKVStore('storeId', options).then(async (store) => {
console.log('getKVStore success');
......@@ -321,8 +318,8 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise&lt;void&
});
} catch (e) {
console.log('closeKVStore e ' + e);
}
```
}
```
### deleteKVStore<sup>8+</sup> ###
......@@ -341,13 +338,12 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback&lt;void&gt
| storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，如果成功返回true，否则返回false。 |
**示例**：
```
let kvManager;
let kvStore;
const options = {
```
let kvManager;
let kvStore;
const options = {
createIfMissing : true,
encrypt : false,
backup : false,
......@@ -355,8 +351,8 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback&lt;void&gt
kvStoreType : distributedData.KVStoreType.SINGLE_VERSION,
schema : '',
securityLevel : distributedData.SecurityLevel.S2,
}
try {
}
try {
kvManager.getKVStore('store', options, async function (err, store) {
console.log('getKVStore success');
kvStore = store;
......@@ -364,10 +360,10 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback&lt;void&gt
console.log('deleteKVStore success');
});
});
} catch (e) {
} catch (e) {
console.log('DeleteKVStore e ' + e);
}
```
}
```
### deleteKVStore<sup>8+</sup> ###
......@@ -393,10 +389,10 @@ deleteKVStore(appId: string, storeId: string): Promise&lt;void&gt;
**示例**：
```
let kvManager;
let kvStore;
const options = {
```
let kvManager;
let kvStore;
const options = {
createIfMissing : true,
encrypt : false,
backup : false,
......@@ -404,8 +400,8 @@ deleteKVStore(appId: string, storeId: string): Promise&lt;void&gt;
kvStoreType : distributedData.KVStoreType.SINGLE_VERSION,
schema : '',
securityLevel : distributedData.SecurityLevel.S2,
}
try {
}
try {
kvManager.getKVStore('storId', options).then(async (store) => {
console.log('getKVStore success');
kvStore = store;
......@@ -417,10 +413,10 @@ deleteKVStore(appId: string, storeId: string): Promise&lt;void&gt;
}).catch((err) => {
console.log('getKVStore err ' + JSON.stringify(err));
});
} catch (e) {
} catch (e) {
console.log('deleteKVStore e ' + e);
}
```
}
```
### getAllKVStoreId<sup>8+</sup> ###
......@@ -440,17 +436,17 @@ getAllKVStoreId(appId: string, callback: AsyncCallback&lt;string[]&gt;): void
**示例**：
```
let kvManager;
try {
```
let kvManager;
try {
kvManager.getAllKVStoreId('appId', function (err, data) {
console.log('GetAllKVStoreId success');
console.log('GetAllKVStoreId size = ' + data.length);
});
} catch (e) {
} catch (e) {
console.log('GetAllKVStoreId e ' + e);
}
```
}
```
### getAllKVStoreId<sup>8+</sup> ###
......@@ -476,9 +472,9 @@ getAllKVStoreId(appId: string): Promise&lt;string[]&gt;
**示例**：
```
let kvManager;
try {
```
let kvManager;
try {
console.log('GetAllKVStoreId');
kvManager.getAllKVStoreId('apppId').then((data) => {
console.log('getAllKVStoreId success');
......@@ -486,10 +482,10 @@ getAllKVStoreId(appId: string): Promise&lt;string[]&gt;
}).catch((err) => {
console.log('getAllKVStoreId err ' + JSON.stringify(err));
});
} catch(e) {
} catch(e) {
console.log('getAllKVStoreId e ' + e);
}
```
}
```
### on<sup>8+</sup> ###
......@@ -507,23 +503,21 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback&lt;void&gt;): voi
| event | 'distributedDataServiceDie' | 是 | 服务状态改变时触发的事件名。 |
| deathCallback | Callback&lt;void&gt; | 是 | 回调函数，在设备状态改变时获取通知。 |
**示例**
```
let kvManager;
try {
```
let kvManager;
try {
console.log('KVManagerOn');
const deathCallback = function () {
console.log('death callback call');
}
kvManager.on('distributedDataServiceDie', deathCallback);
} catch (e) {
} catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
```
}
```
### off<sup>8+</sup> ###
......@@ -544,19 +538,19 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback&lt;void&gt;): v
**示例**
```
let kvManager;
try {
```
let kvManager;
try {
console.log('KVManagerOff');
const deathCallback = function () {
console.log('death callback call');
}
kvManager.off('distributedDataServiceDie', deathCallback);
} catch (e) {
} catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
}
```
```
## Options
......@@ -588,7 +582,6 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback&lt;void&gt;): v
| MULTI_VERSION | 2 | 表示多版本数据库。此类型当前不允许使用。 |
## SecurityLevel
用于指定创建的数据库的安全级别。
......@@ -629,7 +622,7 @@ KVStore常量。
| 名称 | 类型 | 说明 |
| --- | ---- | ----------------------- |
| root<sup>8+</sup> | [FieldNode](#fieldnode8) | 表示json根对象 |
| indexes<sup>8+</sup> | Array<string> | 表示json类型的字符串数组。 |
| indexes<sup>8+</sup> | Array\<string> | 表示json类型的字符串数组。 |
| mode<sup>8+</sup> | number | 表示Schema的模式。 |
| skip<sup>8+</sup> | number | Schema的跳跃大小。 |
......@@ -690,9 +683,9 @@ appendChild(child: FieldNode): boolean
**示例**
```
import ddm from '@ohos.data.distributedData';
try {
```
import ddm from '@ohos.data.distributedData';
try {
let node = new ddm.FieldNode("root");
let child1 = new ddm.FieldNode("child1");
let child2 = new ddm.FieldNode("child2");
......@@ -705,12 +698,10 @@ appendChild(child: FieldNode): boolean
child2 = null;
child3 = null;
node = null;
} catch (e) {
} catch (e) {
console.log("AppendChild " + e);
}
```
}
```
## KvStoreResultSet<sup>8+</sup> ##
......@@ -734,9 +725,9 @@ getCount(): number
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -746,11 +737,10 @@ getCount(): number
});
const count = resultSet.getCount();
console.log("GetCount " + count);
} catch (e) {
} catch (e) {
console.log("GetCount fail " + e);
}
```
}
```
### getPosition<sup>8+</sup> ###
......@@ -768,9 +758,9 @@ getPosition(): number
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -780,10 +770,10 @@ getPosition(): number
});
const position = resultSet.getPosition();
console.log("getPosition " + position);
} catch (e) {
} catch (e) {
console.log("GetPosition fail " + e);
}
```
}
```
### moveToFirst<sup>8+</sup> ###
......@@ -802,9 +792,9 @@ moveToFirst(): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -814,10 +804,10 @@ moveToFirst(): boolean
});
const moved = resultSet.moveToFirst();
console.log("moveToFirst " + moved);
} catch (e) {
} catch (e) {
console.log("MoveToFirst fail " + e);
}
```
}
```
### moveToLast<sup>8+</sup> ###
......@@ -836,9 +826,9 @@ moveToLast(): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -848,10 +838,10 @@ moveToLast(): boolean
});
const moved = resultSet.moveToLast();
console.log("moveToLast " + moved);
} catch (e) {
} catch (e) {
console.log("moveToLast fail " + e);
}
```
}
```
### moveToNext<sup>8+</sup> ###
......@@ -870,9 +860,9 @@ moveToNext(): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -882,10 +872,10 @@ moveToNext(): boolean
});
const moved = resultSet.moveToNext();
console.log("moveToNext " + moved);
} catch (e) {
} catch (e) {
console.log("moveToNext fail " + e);
}
```
}
```
### moveToPrevious<sup>8+</sup> ###
......@@ -904,9 +894,9 @@ moveToPrevious(): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -916,10 +906,10 @@ moveToPrevious(): boolean
});
const moved = resultSet.moveToPrevious();
console.log("moveToPrevious " + moved);
} catch (e) {
} catch (e) {
console.log("moveToPrevious fail " + e);
}
```
}
```
### move<sup>8+</sup> ###
......@@ -944,9 +934,9 @@ move(offset: number): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -956,10 +946,10 @@ move(offset: number): boolean
});
const moved = resultSet.move();
console.log("move " + moved);
} catch (e) {
} catch (e) {
console.log("move fail " + e);
}
```
}
```
### moveToPosition<sup>8+</sup> ###
......@@ -984,9 +974,9 @@ moveToPosition(position: number): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -996,10 +986,10 @@ moveToPosition(position: number): boolean
});
const moved = resultSet.moveToPosition();
console.log("moveToPosition " + moved);
} catch (e) {
} catch (e) {
console.log("moveToPosition fail " + e);
}
```
}
```
### isFirst<sup>8+</sup> ###
......@@ -1018,9 +1008,9 @@ isFirst(): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -1030,10 +1020,10 @@ isFirst(): boolean
});
const moved = resultSet.isFirst();
console.log("isFirst " + moved);
} catch (e) {
} catch (e) {
console.log("isFirst fail " + e);
}
```
}
```
### isLast<sup>8+</sup> ###
......@@ -1052,9 +1042,9 @@ isLast(): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -1064,11 +1054,10 @@ isLast(): boolean
});
const moved = resultSet.isLast();
console.log("isLast " + moved);
} catch (e) {
} catch (e) {
console.log("isLast fail " + e);
}
```
}
```
### isBeforeFirst<sup>8+</sup> ###
......@@ -1086,9 +1075,9 @@ isBeforeFirst(): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -1098,10 +1087,10 @@ isBeforeFirst(): boolean
});
const moved = resultSet.isBeforeFirst();
console.log("isBeforeFirst " + moved);
} catch (e) {
} catch (e) {
console.log("isBeforeFirst fail " + e);
}
```
}
```
### isAfterLast<sup>8+</sup> ###
......@@ -1120,9 +1109,9 @@ isAfterLast(): boolean
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -1132,10 +1121,10 @@ isAfterLast(): boolean
});
const moved = resultSet.isAfterLast();
console.log("isAfterLast " + moved);
} catch (e) {
} catch (e) {
console.log("isAfterLast fail " + e);
}
```
}
```
### getEntry<sup>8+</sup> ###
......@@ -1154,9 +1143,9 @@ getEntry(): Entry
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -1167,10 +1156,10 @@ getEntry(): Entry
const moved = resultSet.moveToNext();
const entry = resultSet.getEntry();
console.log("getEntry " + JSON.stringify(entry));
} catch (e) {
} catch (e) {
console.log("getEntry fail " + e);
}
```
}
```
## Query<sup>8+</sup> ##
......@@ -1205,18 +1194,18 @@ reset(): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.equalTo("key", "value");
console.log("query is " + query.getSqlLike());
query.reset();
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("simply calls should be ok :" + e);
}
```
}
```
### equalTo<sup>8+</sup> ###
......@@ -1242,16 +1231,16 @@ equalTo(field: string, value: number|string|boolean): Query;
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.equalTo("field", "value");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### notEqualTo<sup>8+</sup> ###
......@@ -1277,16 +1266,16 @@ notEqualTo(field: string, value: number|string|boolean): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.notEqualTo("field", "value");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### greaterThan<sup>8+</sup> ###
......@@ -1302,7 +1291,7 @@ greaterThan(field: string, value: number|string|boolean): Query
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 |
| value | number/string/boolean | 是 | 表示指定的值。|
| value | number\|string\|boolean | 是 | 表示指定的值。|
**返回值**：
......@@ -1312,16 +1301,16 @@ greaterThan(field: string, value: number|string|boolean): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.greaterThan("field", "value");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### lessThan<sup>8+</sup> ###
......@@ -1337,7 +1326,7 @@ lessThan(field: string, value: number|string): Query
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 |
| value | number/string/boolean | 是 | 表示指定的值。|
| value | number\|string\|boolean | 是 | 表示指定的值。|
**返回值**：
......@@ -1347,16 +1336,16 @@ lessThan(field: string, value: number|string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.lessThan("field", "value");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### greaterThanOrEqualTo<sup>8+</sup> ###
......@@ -1372,7 +1361,7 @@ greaterThanOrEqualTo(field: string, value: number|string): Query
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 |
| value | number/string/boolean | 是 | 表示指定的值。|
| value | number\|string\|boolean | 是 | 表示指定的值。|
**返回值**：
......@@ -1382,16 +1371,16 @@ greaterThanOrEqualTo(field: string, value: number|string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.greaterThanOrEqualTo("field", "value");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### lessThanOrEqualTo<sup>8+</sup> ###
......@@ -1407,7 +1396,7 @@ lessThanOrEqualTo(field: string, value: number|string): Query
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 |
| value | number/string/boolean | 是 | 表示指定的值。|
| value | number\|string\|boolean | 是 | 表示指定的值。|
**返回值**：
......@@ -1417,16 +1406,16 @@ lessThanOrEqualTo(field: string, value: number|string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.lessThanOrEqualTo("field", "value");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### isNull<sup>8+</sup> ###
......@@ -1452,16 +1441,16 @@ isNull(field: string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.isNull("field");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### inNumber<sup>8+</sup> ###
......@@ -1486,19 +1475,18 @@ inNumber(field: string, valueList: number[]): Query
| ------ | ------- |
| [Query](#query8) |返回查询对象。|
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.inNumber("field", [0, 1]);
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### inString<sup>8+</sup> ###
......@@ -1524,16 +1512,16 @@ inString(field: string, valueList: string[]): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.inString("field", ['test1', 'test2']);
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### notInNumber<sup>8+</sup> ###
......@@ -1559,16 +1547,16 @@ notInNumber(field: string, valueList: number[]): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.notInNumber("field", [0, 1]);
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### notInString<sup>8+</sup> ###
......@@ -1594,16 +1582,16 @@ notInString(field: string, valueList: string[]): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.notInString("field", ['test1', 'test2']);
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### like<sup>8+</sup> ###
......@@ -1629,16 +1617,16 @@ like(field: string, value: string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.like("field", "value");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### unlike<sup>8+</sup> ###
......@@ -1664,16 +1652,16 @@ unlike(field: string, value: string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.unlike("field", "value");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### and<sup>8+</sup> ###
......@@ -1692,18 +1680,18 @@ and(): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.notEqualTo("field", "value1");
query.and();
query.notEqualTo("field", "value2");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### or<sup>8+</sup> ###
......@@ -1722,18 +1710,18 @@ or(): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.notEqualTo("field", "value1");
query.or();
query.notEqualTo("field", "value2");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### orderByAsc<sup>8+</sup> ###
......@@ -1758,17 +1746,17 @@ orderByAsc(field: string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.notEqualTo("field", "value");
query.orderByAsc("field");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### orderByDesc<sup>8+</sup> ###
......@@ -1791,20 +1779,19 @@ orderByDesc(field: string): Query
| ------ | ------- |
| [Query](#query8) |返回查询对象。|
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.notEqualTo("field", "value");
query.orderByDesc("field");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### limit<sup>8+</sup> ###
......@@ -1830,17 +1817,17 @@ limit(total: number, offset: number): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.notEqualTo("field", "value");
query.limit("total", "offset");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### isNotNull<sup>8+</sup> ###
......@@ -1865,16 +1852,16 @@ isNotNull(field: string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.isNotNull("field");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### beginGroup<sup>8+</sup> ###
......@@ -1893,18 +1880,18 @@ beginGroup(): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.beginGroup();
query.isNotNull("field");
query.endGroup();
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### endGroup<sup>8+</sup> ###
......@@ -1923,18 +1910,18 @@ endGroup(): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.beginGroup();
query.isNotNull("field");
query.endGroup();
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### prefixKey<sup>8+</sup> ###
......@@ -1959,17 +1946,17 @@ prefixKey(prefix: string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.prefixKey("$.name");
query.prefixKey("0");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### setSuggestIndex<sup>8+</sup> ###
......@@ -1994,17 +1981,17 @@ setSuggestIndex(index: string): Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.setSuggestIndex("$.name");
query.setSuggestIndex("0");
console.log("query is " + query.getSqlLike());
query = null;
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok :" + e);
}
```
}
```
### deviceId<sup>8+</sup> ###
......@@ -2030,15 +2017,15 @@ deviceId(deviceId:string):Query
**示例**
```
try {
```
try {
let query = new distributedData.Query();
query.deviceId("deviceId");
console.log("query is " + query.getSqlLike());
} catch (e) {
} catch (e) {
console.log("should be ok on Method Chaining : " + e);
}
```
}
```
### getSqlLike<sup>8+</sup> ###
......@@ -2057,15 +2044,15 @@ getSqlLike():string
**示例**
```
try {
```
try {
let query = new distributedData.Query();
let sql1 = query.getSqlLike();
console.log("GetSqlLike sql=" + sql1);
} catch (e) {
} catch (e) {
console.log("dumplicated calls should be ok : " + e);
}
```
}
```
## KVStore
......@@ -2092,11 +2079,11 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
if (err != undefined) {
console.log("put err: " + JSON.stringify(err));
......@@ -2104,10 +2091,10 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC
}
console.log("put success");
});
}catch (e) {
}catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
```
}
```
### put
......@@ -2131,23 +2118,22 @@ put(key: string, value: Uint8Array | string | number | boolean): Promise&lt;void
| ------ | ------- |
| Promise&lt;void&gt; |Promise实例，用于异步处理。|
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => {
console.log("put success: " + JSON.stringify(data));
}).catch((err) => {
console.log("put err: " + JSON.stringify(err));
});
}catch (e) {
}catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
```
}
```
### delete
......@@ -2167,11 +2153,11 @@ delete(key: string, callback: AsyncCallback&lt;void&gt;): void
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
if (err != undefined) {
console.log("put err: " + JSON.stringify(err));
......@@ -2186,10 +2172,10 @@ delete(key: string, callback: AsyncCallback&lt;void&gt;): void
console.log("delete success");
});
});
}catch (e) {
}catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
```
}
```
### delete
......@@ -2214,11 +2200,11 @@ delete(key: string): Promise&lt;void&gt;
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => {
console.log("put success: " + JSON.stringify(data));
kvStore.delete(KEY_TEST_STRING_ELEMENT).then((data) => {
......@@ -2229,10 +2215,10 @@ delete(key: string): Promise&lt;void&gt;
}).catch((err) => {
console.log("put err: " + JSON.stringify(err));
});
}catch (e) {
}catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
```
}
```
### on
......@@ -2251,15 +2237,14 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;ChangeNotific
| type |[SubscribeType](#subscribetype) | 是 |表示订阅的类型。 |
| observer |Callback&lt;[ChangeNotification](#changenotification)&gt; | 是 |回调函数。 |
**示例**
```
let kvStore;
kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, function (data) {
```
let kvStore;
kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, function (data) {
console.log("dataChange callback call data: " + JSON.stringify(data));
});
```
});
```
### on
......@@ -2277,15 +2262,14 @@ on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt
| event |'syncComplete' | 是 |回调函数名称。 |
| syncCallback |Callback&lt;Array&lt;[string, number]&gt;&gt; | 是 |回调函数。 |
**示例**
```
let kvStore;
kvStore.on('syncComplete', function (data) {
```
let kvStore;
kvStore.on('syncComplete', function (data) {
console.log("syncComplete callback call data: " + data);
});
```
});
```
### off<sup>8+</sup>
......@@ -2304,15 +2288,15 @@ off(event:'dataChange', observer?: Callback&lt;ChangeNotification&gt;): void
**示例**
```
let kvStore;
kvStore.on('dataChange', function (data) {
```
let kvStore;
kvStore.on('dataChange', function (data) {
console.log("syncComplete callback call data: " + data);
});
kvStore.off('dataChange', function (data) {
});
kvStore.off('dataChange', function (data) {
console.log("syncComplete callback call data: " + data);
});
```
});
```
### putBatch<sup>8+</sup>
......@@ -2332,9 +2316,9 @@ putBatch(entries: Entry[], callback: AsyncCallback&lt;void&gt;): void
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -2356,11 +2340,10 @@ putBatch(entries: Entry[], callback: AsyncCallback&lt;void&gt;): void
console.log('entrys[0]: ' + JSON.stringify(entrys[0]));
});
});
}catch(e) {
}catch(e) {
console.log('PutBatch e ' + e);
}
```
}
```
### putBatch<sup>8+</sup>
......@@ -2385,9 +2368,9 @@ putBatch(entries: Entry[]): Promise&lt;void&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -2412,10 +2395,10 @@ putBatch(entries: Entry[]): Promise&lt;void&gt;
}).catch((err) => {
console.log('putBatch fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('PutBatch e ' + e);
}
```
}
```
### deleteBatch<sup>8+</sup>
......@@ -2435,9 +2418,9 @@ deleteBatch(keys: string[], callback: AsyncCallback&lt;void&gt;): void
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
let keys = [];
for (var i = 0; i < 5; i++) {
......@@ -2459,10 +2442,10 @@ deleteBatch(keys: string[], callback: AsyncCallback&lt;void&gt;): void
console.log('deleteBatch success');
});
});
}catch(e) {
}catch(e) {
console.log('DeleteBatch e ' + e);
}
```
}
```
### deleteBatch<sup>8+</sup> ###
......@@ -2487,9 +2470,9 @@ deleteBatch(keys: string[]): Promise&lt;void&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
let keys = [];
for (var i = 0; i < 5; i++) {
......@@ -2515,10 +2498,10 @@ deleteBatch(keys: string[]): Promise&lt;void&gt;
}).catch((err) => {
console.log('putBatch fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('DeleteBatch e ' + e);
}
```
}
```
### startTransaction<sup>8+</sup> ###
......@@ -2537,9 +2520,9 @@ startTransaction(callback: AsyncCallback&lt;void&gt;): void
**示例**
```
let kvStore;
function putBatchString(len, prefix) {
```
let kvStore;
function putBatchString(len, prefix) {
let entries = [];
for (var i = 0; i < len; i++) {
var entry = {
......@@ -2552,8 +2535,8 @@ startTransaction(callback: AsyncCallback&lt;void&gt;): void
entries.push(entry);
}
return entries;
}
try {
}
try {
var count = 0;
kvStore.on('dataChange', 0, function (data) {
console.log('startTransaction 0' + data)
......@@ -2567,10 +2550,10 @@ startTransaction(callback: AsyncCallback&lt;void&gt;): void
console.log('putBatch success');
});
});
}catch(e) {
}catch(e) {
console.log('startTransaction e ' + e);
}
```
}
```
### startTransaction<sup>8+</sup> ###
......@@ -2589,9 +2572,9 @@ startTransaction(): Promise&lt;void&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
var count = 0;
kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_ALL, function (data) {
console.log('startTransaction ' + JSON.stringify(data));
......@@ -2602,10 +2585,10 @@ startTransaction(): Promise&lt;void&gt;
}).catch((err) => {
console.log('startTransaction fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('startTransaction e ' + e);
}
```
}
```
### commit<sup>8+</sup> ###
......@@ -2624,9 +2607,9 @@ commit(callback: AsyncCallback&lt;void&gt;): void
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
kvStore.commit(function (err,data) {
if (err == undefined) {
console.log('commit success');
......@@ -2634,10 +2617,10 @@ commit(callback: AsyncCallback&lt;void&gt;): void
console.log('commit fail');
}
});
}catch(e) {
}catch(e) {
console.log('Commit e ' + e);
}
```
}
```
### commit<sup>8+</sup> ###
......@@ -2656,18 +2639,18 @@ commit(): Promise&lt;void&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
kvStore.commit().then(async (err) => {
console.log('commit success');
}).catch((err) => {
console.log('commit fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('Commit e ' + e);
}
```
}
```
### rollback<sup>8+</sup> ###
......@@ -2686,9 +2669,9 @@ rollback(callback: AsyncCallback&lt;void&gt;): void
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
kvStore.rollback(function (err,data) {
if (err == undefined) {
console.log('commit success');
......@@ -2696,10 +2679,10 @@ rollback(callback: AsyncCallback&lt;void&gt;): void
console.log('commit fail');
}
});
}catch(e) {
}catch(e) {
console.log('Rollback e ' + e);
}
```
}
```
### rollback<sup>8+</sup> ###
......@@ -2718,18 +2701,18 @@ rollback(): Promise&lt;void&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
kvStore.rollback().then(async (err) => {
console.log('rollback success');
}).catch((err) => {
console.log('rollback fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('Rollback e ' + e);
}
```
}
```
### enableSync<sup>8+</sup> ###
......@@ -2749,9 +2732,9 @@ enableSync(enabled: boolean, callback: AsyncCallback&lt;void&gt;): void
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
kvStore.enableSync(true, function (err,data) {
if (err == undefined) {
console.log('enableSync success');
......@@ -2759,10 +2742,10 @@ enableSync(enabled: boolean, callback: AsyncCallback&lt;void&gt;): void
console.log('enableSync fail');
}
});
}catch(e) {
}catch(e) {
console.log('EnableSync e ' + e);
}
```
}
```
### enableSync<sup>8+</sup> ###
......@@ -2787,18 +2770,18 @@ enableSync(enabled: boolean): Promise&lt;void&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
kvStore.enableSync(true).then((err) => {
console.log('enableSync success');
}).catch((err) => {
console.log('enableSync fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('EnableSync e ' + e);
}
```
}
```
### setSyncRange<sup>8+</sup> ###
......@@ -2819,18 +2802,18 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: Asy
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
const localLabels = ['A', 'B'];
const remoteSupportLabels = ['C', 'D'];
kvStore.setSyncRange(localLabels, remoteSupportLabels, function (err,data) {
console.log('SetSyncRange put success');
});
}catch(e) {
}catch(e) {
console.log('SetSyncRange e ' + e);
}
```
}
```
### setSyncRange<sup>8+</sup> ###
......@@ -2857,9 +2840,9 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise&lt;v
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
const localLabels = ['A', 'B'];
const remoteSupportLabels = ['C', 'D'];
kvStore.setSyncRange(localLabels, remoteSupportLabels).then((err) => {
......@@ -2867,10 +2850,10 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise&lt;v
}).catch((err) => {
console.log('delete fail ' + err);
});
}catch(e) {
}catch(e) {
console.log('SetSyncRange e ' + e);
}
```
}
```
## SubscribeType
......@@ -2957,15 +2940,15 @@ get(key: string, callback: AsyncCallback&lt;Uint8Array | string | boolean | numb
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key |string | 是 |要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback |AsyncCallback&lt;Uint8Array / string / boolean / number&gt;) | 是 |回调函数，获取查询的值。 |
| callback |AsyncCallback&lt;Uint8Array \| string \| boolean \| number&gt;) | 是 |回调函数，获取查询的值。 |
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
if (err != undefined) {
console.log("put err: " + JSON.stringify(err));
......@@ -2976,10 +2959,10 @@ get(key: string, callback: AsyncCallback&lt;Uint8Array | string | boolean | numb
console.log("get success data: " + data);
});
});
}catch (e) {
}catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
```
}
```
### get
......@@ -3001,16 +2984,15 @@ get(key: string): Promise&lt;Uint8Array | string | boolean | number>
| 类型 | 说明 |
| ------ | ------- |
|Promise&lt;Uint8Array / string / boolean / number&gt; |Promise实例，用于获取异步返回结果。|
|Promise&lt;Uint8Array \| string \| boolean \| number&gt; |Promise实例，用于获取异步返回结果。|
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => {
console.log("put success: " + JSON.stringify(data));
kvStore.get(KEY_TEST_STRING_ELEMENT).then((data) => {
......@@ -3021,10 +3003,10 @@ get(key: string): Promise&lt;Uint8Array | string | boolean | number>
}).catch((err) => {
console.log("put err: " + JSON.stringify(err));
});
}catch (e) {
}catch (e) {
console.log("An unexpected error occurred. Error:" + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -3039,13 +3021,13 @@ getEntries(keyPrefix: string, callback: AsyncCallback&lt;Entry[]&gt;): void
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| keyPrefix |string | 是 |表示要匹配的键前缀。 |
| callback |AsyncCallback&lt;Entry[]&gt; | 是 |回调函数，获取指定前缀的键值对列表。 |
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | 是 |回调函数，获取指定前缀的键值对列表。 |
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_number_key';
......@@ -3066,10 +3048,10 @@ getEntries(keyPrefix: string, callback: AsyncCallback&lt;Entry[]&gt;): void
console.log('entrys[0]: ' + JSON.stringify(entrys[0]));
});
});
}catch(e) {
}catch(e) {
console.log('PutBatch e ' + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -3094,9 +3076,9 @@ getEntries(keyPrefix: string): Promise&lt;Entry[]&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -3124,10 +3106,10 @@ getEntries(keyPrefix: string): Promise&lt;Entry[]&gt;
}).catch((err) => {
console.log('putBatch fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('PutBatch e ' + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -3143,13 +3125,13 @@ getEntries(query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示要匹配的键前缀。 |
| callback |AsyncCallback&lt;Entry[]&gt; | 是 |回调函数，获取指定前缀的键值对列表。 |
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | 是 |回调函数，获取指定前缀的键值对列表。 |
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
var arr = new Uint8Array([21,31]);
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -3175,10 +3157,10 @@ getEntries(query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
});
});
console.log('GetEntries success');
}catch(e) {
}catch(e) {
console.log('GetEntries e ' + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -3203,8 +3185,8 @@ getEntries(query: Query): Promise&lt;Entry[]&gt;
**示例**
```
try {
```
try {
var arr = new Uint8Array([21,31]);
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -3232,10 +3214,10 @@ getEntries(query: Query): Promise&lt;Entry[]&gt;
console.log('GetEntries putBatch fail ' + JSON.stringify(err))
});
console.log('GetEntries success');
}catch(e) {
}catch(e) {
console.log('GetEntries e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -3255,9 +3237,9 @@ getResultSet(keyPrefix: string, callback: AsyncCallback&lt;KvStoreResultSet&gt;)
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -3281,10 +3263,10 @@ getResultSet(keyPrefix: string, callback: AsyncCallback&lt;KvStoreResultSet&gt;)
})
});
});
}catch(e) {
}catch(e) {
console.log('GetResultSet e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -3309,9 +3291,9 @@ getResultSet(keyPrefix: string): Promise&lt;KvStoreResultSet&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -3341,10 +3323,10 @@ getResultSet(keyPrefix: string): Promise&lt;KvStoreResultSet&gt;
}).catch((err) => {
console.log('closeResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('GetResult e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -3364,9 +3346,9 @@ getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): voi
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -3389,10 +3371,10 @@ getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): voi
resultSet = result;
});
});
} catch(e) {
} catch(e) {
console.log('GetResultSet e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -3417,9 +3399,9 @@ getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -3446,10 +3428,10 @@ getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt;
}).catch((err) => {
console.log('getResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('GetResultSet e ' + e);
}
```
}
```
### closeResultSet<sup>8+</sup> ###
......@@ -3468,9 +3450,9 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback&lt;void&gt;)
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet = null;
kvStore.closeResultSet(resultSet, function (err, data) {
if (err == undefined) {
......@@ -3479,10 +3461,10 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback&lt;void&gt;)
console.log('closeResultSet fail');
}
});
}catch(e) {
}catch(e) {
console.log('CloseResultSet e ' + e);
}
```
}
```
### closeResultSet<sup>8+</sup> ###
......@@ -3507,19 +3489,19 @@ closeResultSet(resultSet: KvStoreResultSet): Promise&lt;void&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet = null;
kvStore.closeResultSet(resultSet).then(() => {
console.log('closeResultSet success');
}).catch((err) => {
console.log('closeResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('CloseResultSet e ' + e);
}
```
}
```
### getResultSize<sup>8+</sup> ###
......@@ -3539,9 +3521,9 @@ getResultSize(query: Query, callback: AsyncCallback&lt;number&gt;): void
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -3562,10 +3544,10 @@ getResultSize(query: Query, callback: AsyncCallback&lt;number&gt;): void
console.log('getResultSet success');
});
});
} catch(e) {
} catch(e) {
console.log('GetResultSize e ' + e);
}
```
}
```
### getResultSize<sup>8+</sup> ###
......@@ -3590,9 +3572,9 @@ getResultSize(query: Query): Promise&lt;number&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -3617,10 +3599,10 @@ getResultSize(query: Query): Promise&lt;number&gt;
}).catch((err) => {
console.log('getResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('GetResultSize e ' + e);
}
```
}
```
### removeDeviceData<sup>8+</sup> ###
......@@ -3640,11 +3622,11 @@ removeDeviceData(deviceId: string, callback: AsyncCallback&lt;void&gt;): void
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string_2';
const VALUE_TEST_STRING_ELEMENT = 'value-string-002';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string_2';
const VALUE_TEST_STRING_ELEMENT = 'value-string-002';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, async function (err,data) {
console.log('put success');
const deviceid = 'no_exist_device_id';
......@@ -3659,10 +3641,10 @@ removeDeviceData(deviceId: string, callback: AsyncCallback&lt;void&gt;): void
}
});
});
}catch(e) {
}catch(e) {
console.log('RemoveDeviceData e ' + e);
}
```
}
```
### removeDeviceData<sup>8+</sup> ###
......@@ -3687,11 +3669,11 @@ removeDeviceData(deviceId: string): Promise&lt;void&gt;
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string_2';
const VALUE_TEST_STRING_ELEMENT = 'value-string-001';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string_2';
const VALUE_TEST_STRING_ELEMENT = 'value-string-001';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((err) => {
console.log('removeDeviceData put success');
}).catch((err) => {
......@@ -3708,10 +3690,10 @@ removeDeviceData(deviceId: string): Promise&lt;void&gt;
}).catch((err) => {
console.log('RemoveDeviceData get fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('RemoveDeviceData e ' + e);
}
```
}
```
### on<sup>8+</sup> ###
......@@ -3731,11 +3713,11 @@ on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt
**示例**
```
let kvStore;
const KEY_TEST_FLOAT_ELEMENT = 'key_test_float';
const VALUE_TEST_FLOAT_ELEMENT = 321.12;
try {
```
let kvStore;
const KEY_TEST_FLOAT_ELEMENT = 'key_test_float';
const VALUE_TEST_FLOAT_ELEMENT = 321.12;
try {
kvStore.on('syncComplete', function (data) {
console.log('syncComplete ' + data)
});
......@@ -3744,10 +3726,10 @@ on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt
}).catch((error) => {
console.log('syncComplete put fail ' + error);
});
}catch(e) {
}catch(e) {
console.log('syncComplete put e ' + e);
}
```
}
```
### off<sup>8+</sup> ###
......@@ -3765,21 +3747,20 @@ off(event: 'syncComplete', syncCallback?: Callback&lt;Array&lt;[string, number]&
| event |'syncComplete' | 是 |同步完成时触发的事件名。 |
| syncCallback |Callback&lt;Array&lt;[string, number]&gt;&gt; | 否 |用于向调用方发送同步结果的回调。 |
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
const func = function (data) {
console.log('syncComplete ' + data)
};
kvStore.on('syncComplete', func);
kvStore.off('syncComplete', func);
}catch(e) {
}catch(e) {
console.log('syncComplete e ' + e);
}
```
}
```
### sync
......@@ -3801,10 +3782,10 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void
**示例**：
```
let kvStore;
kvStore.sync('deviceIds', distributedData.SyncMode.PULL_ONLY, 1000);
```
```
let kvStore;
kvStore.sync('deviceIds', distributedData.SyncMode.PULL_ONLY, 1000);
```
### setSyncParam<sup>8+</sup> ###
......@@ -3821,20 +3802,19 @@ setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback&lt;void&gt;)
| defaultAllowedDelayMs |number | 是 |表示数据库同步允许的默认延迟，以毫秒为单位。 |
| callback |AsyncCallback&lt;void&gt; | 是 |回调函数。 |
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
const defaultAllowedDelayMs = 500;
kvStore.setSyncParam(defaultAllowedDelayMs, function (err,data) {
console.log('SetSyncParam put success');
});
}catch(e) {
}catch(e) {
console.log('testSingleKvStoreSetSyncParam e ' + e);
}
```
}
```
### setSyncParam<sup>8+</sup> ###
......@@ -3860,19 +3840,19 @@ setSyncParam(defaultAllowedDelayMs: number): Promise&lt;void&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
const defaultAllowedDelayMs = 500;
kvStore.setSyncParam(defaultAllowedDelayMs).then((err) => {
console.log('SetSyncParam put success');
}).catch((err) => {
console.log('SetSyncParam put fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('SetSyncParam e ' + e);
}
```
}
```
### getSecurityLevel<sup>8+</sup> ###
......@@ -3891,16 +3871,16 @@ getSecurityLevel(callback: AsyncCallback&lt;SecurityLevel&gt;): void
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
kvStore.getSecurityLevel(function (err,data) {
console.log('getSecurityLevel success');
});
}catch(e) {
}catch(e) {
console.log('GetSecurityLeve e ' + e);
}
```
}
```
### getSecurityLevel<sup>8+</sup> ###
......@@ -3917,21 +3897,20 @@ getSecurityLevel(): Promise&lt;SecurityLevel&gt;
| ------ | ------- |
|Promise&lt;[SecurityLevel](#securitylevel)&gt; |Promise实例，用于获取异步返回结果。|
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
kvStore.getSecurityLevel().then((data) => {
console.log(' getSecurityLevel success');
}).catch((err) => {
console.log('getSecurityLevel fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('GetSecurityLeve e ' + e);
}
```
}
```
## DeviceKVStore<sup>8+</sup> ##
......@@ -3954,26 +3933,25 @@ get(deviceId: string, key: string, callback: AsyncCallback&lt;boolean|string|num
| ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要查询其数据的设备。 |
| key |string | 是 |表示要查询 key 值的键。 |
| callback |AsyncCallback&lt;boolean/string/number/Uint8Array&gt; | 是 |回调函数，返回匹配给定条件的字符串值。 |
| callback |AsyncCallback&lt;boolean\|string\|number\|Uint8Array&gt; | 是 |回调函数，返回匹配给定条件的字符串值。 |
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string_2';
const VALUE_TEST_STRING_ELEMENT = 'value-string-002';
try{
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string_2';
const VALUE_TEST_STRING_ELEMENT = 'value-string-002';
try{
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, async function (err,data) {
console.log('put success');
kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT, function (err,data) {
console.log('get success');
});
})
}catch(e) {
}catch(e) {
console.log('get e' + e);
}
```
}
```
### get<sup>8+</sup> ###
......@@ -3995,15 +3973,15 @@ get(deviceId: string, key: string): Promise&lt;boolean|string|number|Uint8Array&
| 类型 | 说明 |
| ------ | ------- |
|Promise&lt;boolean/string/number/Uint8Array&gt; |Promise实例，用于获取异步返回结果。|
|Promise&lt;boolean\|string\|number\|Uint8Array&gt; |Promise实例，用于获取异步返回结果。|
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string_2';
const VALUE_TEST_STRING_ELEMENT = 'value-string-002';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string_2';
const VALUE_TEST_STRING_ELEMENT = 'value-string-002';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then(async (data) => {
console.log(' put success');
kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT).then((data) => {
......@@ -4014,10 +3992,10 @@ get(deviceId: string, key: string): Promise&lt;boolean|string|number|Uint8Array&
}).catch((error) => {
console.log('put error' + error);
});
} catch (e) {
} catch (e) {
console.log('Get e ' + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -4038,9 +4016,9 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;Entry
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -4062,10 +4040,10 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;Entry
console.log('entrys[0]: ' + JSON.stringify(entrys[0]));
});
});
}catch(e) {
}catch(e) {
console.log('PutBatch e ' + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -4091,9 +4069,9 @@ getEntries(deviceId: string, keyPrefix: string): Promise&lt;Entry[]&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -4121,10 +4099,10 @@ getEntries(deviceId: string, keyPrefix: string): Promise&lt;Entry[]&gt;
}).catch((err) => {
console.log('putBatch fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('PutBatch e ' + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -4144,9 +4122,9 @@ getEntries(query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
var arr = new Uint8Array([21,31]);
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -4174,10 +4152,10 @@ getEntries(query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
});
});
console.log('GetEntries success');
}catch(e) {
}catch(e) {
console.log('GetEntries e ' + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -4202,9 +4180,9 @@ getEntries(query: Query): Promise&lt;Entry[]&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
var arr = new Uint8Array([21,31]);
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -4232,10 +4210,10 @@ getEntries(query: Query): Promise&lt;Entry[]&gt;
console.log('GetEntries putBatch fail ' + JSON.stringify(err))
});
console.log('GetEntries success');
}catch(e) {
}catch(e) {
console.log('GetEntries e ' + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -4256,9 +4234,9 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback&lt;Entry[]&gt
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
var arr = new Uint8Array([21,31]);
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -4286,10 +4264,10 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback&lt;Entry[]&gt
})
});
console.log('GetEntries success');
}catch(e) {
}catch(e) {
console.log('GetEntries e ' + e);
}
```
}
```
### getEntries<sup>8+</sup> ###
......@@ -4315,9 +4293,9 @@ getEntries(deviceId: string, query: Query): Promise&lt;Entry[]&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
var arr = new Uint8Array([21,31]);
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -4346,10 +4324,10 @@ getEntries(deviceId: string, query: Query): Promise&lt;Entry[]&gt;
console.log('putBatch fail ' + JSON.stringify(err));
});
console.log('GetEntries success');
}catch(e) {
}catch(e) {
console.log('GetEntries e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -4370,9 +4348,9 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;KvS
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('localDeviceId', 'batch_test_string_key', async function (err, result) {
console.log('getResultSet success');
......@@ -4381,10 +4359,10 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;KvS
console.log('closeResultSet success');
})
});
}catch(e) {
}catch(e) {
console.log('GetResultSet e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -4410,9 +4388,9 @@ getResultSet(deviceId: string, keyPrefix: string): Promise&lt;KvStoreResultSet&g
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
kvStore.getResultSet('localDeviceId', 'batch_test_string_key').then((result) => {
console.log('getResultSet success');
......@@ -4425,10 +4403,10 @@ getResultSet(deviceId: string, keyPrefix: string): Promise&lt;KvStoreResultSet&g
}).catch((err) => {
console.log('closeResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('GetResultSet e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -4448,9 +4426,9 @@ getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): voi
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -4477,10 +4455,10 @@ getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): voi
})
});
});
} catch(e) {
} catch(e) {
console.log('GetResultSet e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -4505,9 +4483,9 @@ getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -4541,10 +4519,10 @@ getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt;
}).catch((err) => {
console.log('closeResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('GetResultSet e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -4565,9 +4543,9 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback&lt;KvStoreR
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -4593,10 +4571,10 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback&lt;KvStoreR
})
});
});
} catch(e) {
} catch(e) {
console.log('GetResultSet e ' + e);
}
```
}
```
### getResultSet<sup>8+</sup> ###
......@@ -4622,9 +4600,9 @@ getResultSet(deviceId: string, query: Query): Promise&lt;KvStoreResultSet&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let resultSet;
let entries = [];
for (var i = 0; i < 10; i++) {
......@@ -4659,10 +4637,10 @@ getResultSet(deviceId: string, query: Query): Promise&lt;KvStoreResultSet&gt;
console.log('GetResultSet closeResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('GetResultSet e ' + e);
}
```
}
```
### closeResultSet<sup>8+</sup> ###
......@@ -4682,9 +4660,9 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback&lt;void&gt;)
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
console.log('CloseResultSet success');
let resultSet = null;
kvStore.closeResultSet(resultSet, function (err, data) {
......@@ -4694,10 +4672,10 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback&lt;void&gt;)
console.log('closeResultSet fail');
}
});
}catch(e) {
}catch(e) {
console.log('CloseResultSet e ' + e);
}
```
}
```
### closeResultSet<sup>8+</sup> ###
......@@ -4722,9 +4700,9 @@ closeResultSet(resultSet: KvStoreResultSet): Promise&lt;void&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
console.log('CloseResultSet success');
let resultSet = null;
kvStore.closeResultSet(resultSet).then(() => {
......@@ -4732,10 +4710,10 @@ closeResultSet(resultSet: KvStoreResultSet): Promise&lt;void&gt;
}).catch((err) => {
console.log('closeResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('CloseResultSet e ' + e);
}
```
}
```
### getResultSize<sup>8+</sup> ###
......@@ -4755,9 +4733,9 @@ getResultSize(query: Query, callback: AsyncCallback&lt;number&gt;): void
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -4779,10 +4757,10 @@ getResultSize(query: Query, callback: AsyncCallback&lt;number&gt;): void
console.log('getResultSet success');
});
});
} catch(e) {
} catch(e) {
console.log('GetResultSize e ' + e);
}
```
}
```
### getResultSize<sup>8+</sup> ###
......@@ -4807,9 +4785,9 @@ getResultSize(query: Query): Promise&lt;number&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -4835,10 +4813,10 @@ getResultSize(query: Query): Promise&lt;number&gt;
}).catch((err) => {
console.log('getResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('GetResultSize e ' + e);
}
```
}
```
### getResultSize<sup>8+</sup> ###
......@@ -4859,9 +4837,9 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback&lt;number&
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -4882,10 +4860,10 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback&lt;number&
console.log('getResultSet success');
});
});
} catch(e) {
} catch(e) {
console.log('GetResultSize e ' + e);
}
```
}
```
### getResultSize<sup>8+</sup> ###
......@@ -4911,9 +4889,9 @@ getResultSize(deviceId: string, query: Query): Promise&lt;number&gt;
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
let entries = [];
for (var i = 0; i < 10; i++) {
var key = 'batch_test_string_key';
......@@ -4938,10 +4916,10 @@ getResultSize(deviceId: string, query: Query): Promise&lt;number&gt;
}).catch((err) => {
console.log('getResultSet fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('GetResultSize e ' + e);
}
```
}
```
### removeDeviceData<sup>8+</sup> ###
......@@ -4961,11 +4939,11 @@ removeDeviceData(deviceId: string, callback: AsyncCallback&lt;void&gt;): void
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-string-001';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-string-001';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, async function (err,data) {
console.log('RemoveDeviceData put success');
const deviceid = 'no_exist_device_id';
......@@ -4980,10 +4958,10 @@ removeDeviceData(deviceId: string, callback: AsyncCallback&lt;void&gt;): void
}
});
});
}catch(e) {
}catch(e) {
console.log('RemoveDeviceData e ' + e);
}
```
}
```
### removeDeviceData<sup>8+</sup> ###
......@@ -5008,11 +4986,11 @@ removeDeviceData(deviceId: string): Promise&lt;void&gt;
**示例**
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-string-001';
try {
```
let kvStore;
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-string-001';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((err) => {
console.log('RemoveDeviceData put success');
}).catch((err) => {
......@@ -5029,10 +5007,10 @@ removeDeviceData(deviceId: string): Promise&lt;void&gt;
}).catch((err) => {
console.log('RemoveDeviceData get fail ' + JSON.stringify(err));
});
}catch(e) {
}catch(e) {
console.log('RemoveDeviceData e ' + e);
}
```
}
```
### sync<sup>8+</sup> ###
......@@ -5052,14 +5030,13 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void
| mode |[SyncMode](#syncmode) | 是 |表示同步方式，PUSH、PULL或PUSH_PULL。 |
| allowedDelayMs |number | 否 |可选参数，允许延时时间，单位：ms（毫秒）。 |
**示例**
```
let kvStore;
const KEY_TEST_SYNC_ELEMENT = 'key_test_sync';
const VALUE_TEST_SYNC_ELEMENT = 'value-string-001';
try {
```
let kvStore;
const KEY_TEST_SYNC_ELEMENT = 'key_test_sync';
const VALUE_TEST_SYNC_ELEMENT = 'value-string-001';
try {
kvStore.on('syncComplete', function (data) {
console.log('Sync dataChange');
});
......@@ -5069,10 +5046,10 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void
const mode = distributedData.SyncMode.PULL_ONLY;
kvStore.sync(devices, mode);
});
}catch(e) {
}catch(e) {
console.log('Sync e' + e);
}
```
}
```
### on<sup>8+</sup> ###
......@@ -5091,10 +5068,10 @@ on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt
**示例**
```
const KEY_TEST_FLOAT_ELEMENT = 'key_test_float';
const VALUE_TEST_FLOAT_ELEMENT = 321.12;
try {
```
const KEY_TEST_FLOAT_ELEMENT = 'key_test_float';
const VALUE_TEST_FLOAT_ELEMENT = 321.12;
try {
kvStore.on('syncComplete', function (data) {
console.log('syncComplete ' + data)
});
......@@ -5103,10 +5080,10 @@ on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt
}).catch((error) => {
console.log('syncComplete put fail ' + error);
});
}catch(e) {
}catch(e) {
console.log('syncComplete put e ' + e);
}
```
}
```
### off<sup>8+</sup> ###
......@@ -5124,21 +5101,20 @@ off(event: 'syncComplete', syncCallback?: Callback&lt;Array&lt;[string, number]&
| event |'syncComplete' | 是 |同步完成时触发的事件名。 |
| syncCallback |Callback<Array&lt;[string, number]&gt;&gt; | 否 |用于向调用方发送同步结果的回调。 |
**示例**
```
let kvStore;
try {
```
let kvStore;
try {
const func = function (data) {
console.log('syncComplete ' + data)
};
kvStore.on('syncComplete', func);
kvStore.off('syncComplete', func);
}catch(e) {
}catch(e) {
console.log('syncComplete e ' + e);
}
```
}
```
## SyncMode
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或