Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 f58a334b 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1122 fix：fix js-apis-distributed-data.md imprint 

Merge pull request !1122 from asfasdff/master
上级 ae445a3d 53315baf
显示空白变更内容
内联 并排
Showing with 270 addition and 268 deletion
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
浏览文件 @ f58a334b
......@@ -15,7 +15,7 @@ import distributedData from '@ohos.data.distributedData';
## distributedData.createKVManager<a name="section2771164881119"></a>
createKVManager\(config: KVManagerConfig, callback: AsyncCallback<KVManager\>\): void
createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void
创建一个KVManager对象实例，用于管理数据库对象，并通过callback方式返回，此方法为异步方法。
......@@ -62,7 +62,7 @@ createKVManager\(config: KVManagerConfig, callback: AsyncCallback<KVManager\>\):
bundleName : 'com.example.datamanagertest',
userInfo : {
userId : '0',
userType : SAME_USER_ID
userType : 0
}
}
distributedData.createKVManager(kvManagerConfig, function (err, manager) {
......@@ -81,7 +81,7 @@ createKVManager\(config: KVManagerConfig, callback: AsyncCallback<KVManager\>\):
## distributedData.createKVManager<a name="section15751121117223"></a>
createKVManager\(config: KVManagerConfig\): Promise<KVManager\>
createKVManager(config: KVManagerConfig): Promise<KVManager>
创建一个KVManager对象实例，用于管理数据库对象，并通过Promise方式返回，此方法为异步方法。
......@@ -136,7 +136,7 @@ createKVManager\(config: KVManagerConfig\): Promise<KVManager\>
bundleName : 'com.example.datamanagertest',
userInfo : {
userId : '0',
userType : SAME_USER_ID
userType : 0
}
}
distributedData.createKVManager(kvManagerConfig).then((manager) => {
......@@ -252,7 +252,7 @@ createKVManager\(config: KVManagerConfig\): Promise<KVManager\>
### getKVStore<a name="section163838594447"></a>
getKVStore<T extends KVStore\>\(storeId: string, options: Options, callback: AsyncCallback<T\>\): void
getKVStore<T extends KVStore>(storeId: string, options: Options, callback: AsyncCallback<T>): void
通过指定Options和storeId，创建并获取KVStore数据库，并通过callback方式返回，此方法为异步方法。
......@@ -310,8 +310,8 @@ getKVStore<T extends KVStore\>\(storeId: string, options: Options, callback: Asy
encrypt : false,
backup : false,
autoSync : true,
kvStoreType : SINGLE_VERSION,
securityLevel : S2,
kvStoreType : 1,
securityLevel : 3,
};
kvManager.getKVStore('storeId', options, function (err, store) {
if (err) {
......@@ -329,7 +329,7 @@ getKVStore<T extends KVStore\>\(storeId: string, options: Options, callback: Asy
### getKVStore<a name="section1614918420469"></a>
getKVStore<T extends KVStore\>\(storeId: string, options: Options\): Promise<T\>
getKVStore<T extends KVStore>(storeId: string, options: Options): Promise<T>
通过指定Options和storeId，创建并获取KVStore数据库，并通过Promise方式返回，此方法为异步方法。
......@@ -395,8 +395,8 @@ getKVStore<T extends KVStore\>\(storeId: string, options: Options\): Promise<T\>
encrypt : false,
backup : false,
autoSync : true,
kvStoreType : SINGLE_VERSION,
securityLevel : S2,
kvStoreType : 1,
securityLevel : 3,
};
kvManager.getKVStore('storeId', options).then((store) => {
console.log("getKVStore success");
......@@ -409,9 +409,9 @@ getKVStore<T extends KVStore\>\(storeId: string, options: Options\): Promise<T\>
}
```
### closeKVStore ###
### closeKVStore<sup>8+</sup> ###
closeKVStore\(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback<void\>\): void;
closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback<void>): void;
通过storId的值关闭指定的kvStore数据库，并通过callback方式返回，此方法为异步方法。
......@@ -483,9 +483,9 @@ closeKVStore\(appId: string, storeId: string, kvStore: KVStore, callback: AsyncC
}
```
### closeKVStore ###
### closeKVStore<sup>8+</sup> ###
closeKVStore\(appId: string, storeId: string, kvStore: KVStore\): Promise<void\>;
closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void>;
通过kvStore的值关闭指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。
......@@ -554,7 +554,7 @@ closeKVStore\(appId: string, storeId: string, kvStore: KVStore\): Promise<void\>
```
let KvStore;
try {
kvManager.closeKVStore('appId', 'storId', KvStore).then(() => {
kvManager.closeKVStore('appId', 'storId', kvStore).then(() => {
console.log('CloseKVStore success');
}).catch((err) => {
console.log('CloseKVStore err ' + JSON.stringify(err));
......@@ -565,7 +565,7 @@ closeKVStore\(appId: string, storeId: string, kvStore: KVStore\): Promise<void\>
```
### deleteKVStore ###
### deleteKVStore<sup>8+</sup> ###
deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): void;
......@@ -631,9 +631,9 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): vo
}
```
### deleteKVStore ###
### deleteKVStore<sup>8+</sup> ###
deleteKVStore\(appId: string, storeId: string\): Promise<void\>;
deleteKVStore(appId: string, storeId: string): Promise<void>;
通过storeId的值删除指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。
......@@ -693,7 +693,7 @@ deleteKVStore\(appId: string, storeId: string\): Promise<void\>;
```
let KvStore;
try {
kvManager.deleteKVStore('appId', 'storId', KvStore).then(() => {
kvManager.deleteKVStore('appId', 'storId', kvStore).then(() => {
console.log('deleteKVStore success');
}).catch((err) => {
console.log('deleteKVStore err ' + JSON.stringify(err));
......@@ -704,7 +704,7 @@ deleteKVStore\(appId: string, storeId: string\): Promise<void\>;
```
### getAllKVStoreId ###
### getAllKVStoreId<sup>8+</sup> ###
getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void;
......@@ -758,9 +758,9 @@ getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void;
```
### getAllKVStoreId ###
### getAllKVStoreId<sup>8+</sup> ###
getAllKVStoreId\(appId: string\): Promise<string[\]\>;
getAllKVStoreId(appId: string): Promise<string[]>;
获取所有通过getKvStore方法创建的且没有调用deleteKvStore方法删除的KvStore数据库的storeId，并通过Promise方式返回，此方法为异步方法。
......@@ -828,9 +828,9 @@ getAllKVStoreId\(appId: string\): Promise<string[\]\>;
```
### on ###
### on<sup>8+</sup> ###
on\(event: 'distributedDataServiceDie', deathCallback: Callback<void\>\): void;
on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): void;
订阅设备状态变更通知，并通过callback方式返回，此方法为异步方法。
......@@ -884,9 +884,9 @@ on\(event: 'distributedDataServiceDie', deathCallback: Callback<void\>\): void;
```
### off ###
### off<sup>8+</sup> ###
off\(event: 'distributedDataServiceDie', deathCallback: Callback<void\>\): void;
off(event: 'distributedDataServiceDie', deathCallback: Callback<void>): void;
取消订阅设备状态变更通知，并通过callback方式返回，此方法为异步方法。
......@@ -1163,11 +1163,11 @@ KVStore常量。
</tbody>
</table>
## Schema ##
## Schema<sup>8+</sup> ##
表示数据库架构，可以创建 Schema 对象，并在创建或打开数据库时将其放置在 Option 中。
### constructor ###
### constructor ###<sup>8+</sup>
constructor();
......@@ -1179,11 +1179,12 @@ constructor();
try {
let schema = new ddm.Schema();
schema.root = new ddm.FieldNode();
const str = schema.constructor();
console.log("constructor: " + str);
} catch (e) {}
```
### toJsonString ###
### toJsonString<sup>8+</sup> ###
toJsonString():string;
......@@ -1219,13 +1220,13 @@ toJsonString():string;
```
## FieldNode<a name="section33333333333"></a> ##
## FieldNode<a name="section33333333333"></a><sup>8+</sup> ##
表示 Schema 实例的节点，提供定义存储在数据库中的值的方法。
### constructor ###
### constructor<sup>8+</sup> ###
constructor\(name: string\);
constructor(name: string);
用于创建具有指定字段的 FieldNode 实例的构造函数。
......@@ -1257,14 +1258,15 @@ constructor\(name: string\);
```
try {
let node = new ddm.FieldNode("name");
const str = node.constructor();
console.log("constructor: " + str);
} catch (e) {}
```
### appendChild ###
### appendChild<sup>8+</sup> ###
appendChild\(child: FieldNode\): boolean;
appendChild(child: FieldNode): boolean;
向这个 FieldNode 添加一个子节点。
......@@ -1330,9 +1332,9 @@ appendChild\(child: FieldNode\): boolean;
```
### toJson ###
### toJson<sup>8+</sup> ###
toJson(\): string;
toJson(): string;
获取字段名称。
......@@ -1366,13 +1368,13 @@ toJson(\): string;
```
## KvStoreResultSet<a name="section111111111"></a> ##
## KvStoreResultSet<a name="section111111111"></a><sup>8+</sup> ##
提供获取KvStore数据库结果集的方法，提供查询和移动数据读取位置的方法，在调用KvStoreResultSet的方法前，需要先通过DeviceKvStore 构建一个DeviceKvStore 实例。
### getCount ###
### getCount<sup>8+</sup> ###
getCount(\): number;
getCount(): number;
获取结果集中的行数。
......@@ -1398,17 +1400,17 @@ getCount(\): number;
```
let KvStoreResultSet;
try {
count = resultSet.getCount();
console.log("getCount " + count);
const count = resultSet.getCount();
console.log("GetCount " + count);
} catch (e) {
console.log("GetCount001 fail " + e);
console.log("GetCount fail " + e);
}
```
### getPosition ###
### getPosition<sup>8+</sup> ###
getPosition(\): number;
getPosition(): number;
获取结果集中当前的读取位置。
......@@ -1442,9 +1444,9 @@ getPosition(\): number;
```
### moveToFirst ###
### moveToFirst<sup>8+</sup> ###
moveToFirst(\): boolean;
moveToFirst(): boolean;
将读取位置移动到第一行。
......@@ -1478,9 +1480,9 @@ moveToFirst(\): boolean;
```
### moveToLast ###
### moveToLast<sup>8+</sup> ###
moveToLast(\): boolean;
moveToLast(): boolean;
将读取位置移动到最后一行。
......@@ -1514,9 +1516,9 @@ moveToLast(\): boolean;
```
### moveToNext ###
### moveToNext<sup>8+</sup> ###
moveToNext(\): boolean;
moveToNext(): boolean;
将读取位置移动到下一行。
......@@ -1550,9 +1552,9 @@ moveToNext(\): boolean;
```
### moveToPrevious ###
### moveToPrevious<sup>8+</sup> ###
moveToPrevious(\): boolean;
moveToPrevious(): boolean;
将读取位置移动到上一行。
......@@ -1586,9 +1588,9 @@ moveToPrevious(\): boolean;
```
### move ###
### move<sup>8+</sup> ###
move\(offset: number\): boolean;
move(offset: number): boolean;
将读取位置移动到当前位置的相对偏移量。
......@@ -1644,9 +1646,9 @@ move\(offset: number\): boolean;
```
### moveToPosition ###
### moveToPosition<sup>8+</sup> ###
moveToPosition\(position: number\): boolean;
moveToPosition(position: number): boolean;
将读取位置从 0 移动到绝对位置。
......@@ -1702,9 +1704,9 @@ moveToPosition\(position: number\): boolean;
```
### isFirst ###
### isFirst<sup>8+</sup> ###
isFirst(\): boolean;
isFirst(): boolean;
检查读取位置是否为第一行。
......@@ -1738,9 +1740,9 @@ isFirst(\): boolean;
```
### isLast ###
### isLast<sup>8+</sup> ###
isLast(\): boolean;
isLast(): boolean;
检查读取位置是否为最后一行。
......@@ -1774,9 +1776,9 @@ isLast(\): boolean;
```
### isBeforeFirst ###
### isBeforeFirst<sup>8+</sup> ###
isBeforeFirst(\): boolean;
isBeforeFirst(): boolean;
检查读取位置是否在第一行之前。
......@@ -1810,9 +1812,9 @@ isBeforeFirst(\): boolean;
```
### isAfterLast ###
### isAfterLast<sup>8+</sup> ###
isAfterLast(\): boolean;
isAfterLast(): boolean;
检查读取位置是否在最后一行之后。
......@@ -1846,9 +1848,9 @@ isAfterLast(\): boolean;
```
### getEntry ###
### getEntry<sup>8+</sup> ###
getEntry(\): Entry;
getEntry(): Entry;
获取键值对
......@@ -1883,11 +1885,11 @@ getEntry(\): Entry;
```
## Query <a name="section22222222222"></a>##
## Query <a name="section22222222222"></a><sup>8+</sup>##
使用谓词表示数据库查询，提供创建Query实例、查询数据库中的数据和添加谓词的方法。
### constructor ###
### constructor<sup>8+</sup> ###
constructor();
......@@ -1898,13 +1900,14 @@ constructor();
```
try {
let query= new ddm.Query()
const str = query.constructor();
console.log("constructor: " + str);
} catch (e) {}
```
### reset ###
### reset<sup>8+</sup> ###
reset(\): Query;
reset(): Query;
公共查询重置。
......@@ -1942,9 +1945,9 @@ reset(\): Query;
```
### equalTo ###
### equalTo<sup>8+</sup> ###
equalTo\(field: string, value: number|string|boolean\): Query;
equalTo(field: string, value: number|string|boolean): Query;
构造一个Query对象来查询具有指定字段的条目，其值等于指定的值。
......@@ -2011,9 +2014,9 @@ equalTo\(field: string, value: number|string|boolean\): Query;
```
### notEqualTo ###
### notEqualTo<sup>8+</sup> ###
notEqualTo\(field: string, value: number|string|boolean\): Query;
notEqualTo(field: string, value: number|string|boolean): Query;
构造一个Query对象以查询具有指定字段且值不等于指定值的条目。
......@@ -2080,9 +2083,9 @@ notEqualTo\(field: string, value: number|string|boolean\): Query;
```
### greaterThan ###
### greaterThan<sup>8+</sup> ###
greaterThan\(field: string, value: number|string|boolean\): Query;
greaterThan(field: string, value: number|string|boolean): Query;
构造一个Query对象以查询具有大于指定值的指定字段的条目。
......@@ -2149,9 +2152,9 @@ greaterThan\(field: string, value: number|string|boolean\): Query;
```
### lessThan ###
### lessThan<sup>8+</sup> ###
lessThan\(field: string, value: number|string\): Query;
lessThan(field: string, value: number|string): Query;
构造一个Query对象以查询具有小于指定值的指定字段的条目。
......@@ -2218,9 +2221,9 @@ lessThan\(field: string, value: number|string\): Query;
```
### greaterThanOrEqualTo ###
### greaterThanOrEqualTo<sup>8+</sup> ###
greaterThanOrEqualTo\(field: string, value: number|string\): Query;
greaterThanOrEqualTo(field: string, value: number|string): Query;
构造一个Query对象以查询具有指定字段且值大于或等于指定值的条目。
......@@ -2287,9 +2290,9 @@ greaterThanOrEqualTo\(field: string, value: number|string\): Query;
```
### lessThanOrEqualTo ###
### lessThanOrEqualTo<sup>8+</sup> ###
lessThanOrEqualTo\(field: string, value: number|string\): Query;
lessThanOrEqualTo(field: string, value: number|string): Query;
构造一个Query对象以查询具有指定字段且值小于或等于指定值的条目。
......@@ -2356,9 +2359,9 @@ lessThanOrEqualTo\(field: string, value: number|string\): Query;
```
### isNull ###
### isNull<sup>8+</sup> ###
isNull\(field: string\): Query;
isNull(field: string): Query;
构造一个Query对象以查询具有值为null的指定字段的条目。
......@@ -2417,9 +2420,9 @@ isNull\(field: string\): Query;
```
### inNumber ###
### inNumber<sup>8+</sup> ###
inNumber\(field: string, valueList: number[\]\): Query;
inNumber(field: string, valueList: number[]): Query;
构造一个Query对象以查询具有指定字段的条目，其值在指定的值列表中。
......@@ -2486,9 +2489,9 @@ inNumber\(field: string, valueList: number[\]\): Query;
```
### inString ###
### inString<sup>8+</sup> ###
inString\(field: string, valueList: string[\]\): Query;
inString(field: string, valueList: string[]): Query;
构造一个Query对象以查询具有指定字段的条目，其值在指定的字符串值列表中。
......@@ -2555,9 +2558,9 @@ inString\(field: string, valueList: string[\]\): Query;
```
### notInNumber ###
### notInNumber<sup>8+</sup> ###
notInNumber\(field: string, valueList: number[\]\): Query;
notInNumber(field: string, valueList: number[]): Query;
构造一个Query对象以查询具有指定字段的条目，该字段的值不在指定的值列表中。
......@@ -2624,9 +2627,9 @@ notInNumber\(field: string, valueList: number[\]\): Query;
```
### notInString ###
### notInString<sup>8+</sup> ###
notInString\(field: string, valueList: string[\]\): Query;
notInString(field: string, valueList: string[]): Query;
构造一个Query对象以查询具有指定字段且值不在指定字符串值列表中的条目。
......@@ -2693,9 +2696,9 @@ notInString\(field: string, valueList: string[\]\): Query;
```
### like ###
### like<sup>8+</sup> ###
like\(field: string, value: string\): Query;
like(field: string, value: string): Query;
构造一个Query对象以查询具有与指定字符串值相似的指定字段的条目。
......@@ -2762,9 +2765,9 @@ like\(field: string, value: string\): Query;
```
### unlike ###
### unlike<sup>8+</sup> ###
unlike\(field: string, value: string\): Query;
unlike(field: string, value: string): Query;
构造一个Query对象以查询具有与指定字符串值不相似的指定字段的条目。
......@@ -2831,9 +2834,9 @@ unlike\(field: string, value: string\): Query;
```
### and ###
### and<sup>8+</sup> ###
and(\): Query;
and(): Query;
构造一个带有与条件的查询对象。
......@@ -2871,9 +2874,9 @@ and(\): Query;
```
### or ###
### or<sup>8+</sup> ###
or(\): Query;
or(): Query;
构造一个带有或条件的Query对象。
......@@ -2911,9 +2914,9 @@ or(\): Query;
```
### orderByAsc ###
### orderByAsc<sup>8+</sup> ###
orderByAsc\(field: string\): Query;
orderByAsc(field: string): Query;
构造一个Query对象，将查询结果按升序排序。
......@@ -2974,9 +2977,9 @@ orderByAsc\(field: string\): Query;
```
### orderByDesc ###
### orderByDesc<sup>8+</sup> ###
orderByDesc\(field: string\): Query;
orderByDesc(field: string): Query;
构造一个Query对象，将查询结果按降序排序。
......@@ -3036,9 +3039,9 @@ orderByDesc\(field: string\): Query;
```
### limit ###
### limit<sup>8+</sup> ###
limit\(total: number, offset: number\): Query;
limit(total: number, offset: number): Query;
构造一个Query对象来指定结果的数量和开始位置。
......@@ -3106,9 +3109,9 @@ limit\(total: number, offset: number\): Query;
```
### isNotNull ###
### isNotNull<sup>8+</sup> ###
isNotNull\(field: string\): Query;
isNotNull(field: string): Query;
使用不为空的指定字段创建查询条件。
......@@ -3167,9 +3170,9 @@ isNotNull\(field: string\): Query;
```
### beginGroup ###
### beginGroup<sup>8+</sup> ###
beginGroup\(\): Query;
beginGroup(): Query;
创建一个带有左括号的查询条件组。
......@@ -3207,9 +3210,9 @@ beginGroup\(\): Query;
```
### endGroup ###
### endGroup<sup>8+</sup> ###
endGroup\(\): Query;
endGroup(): Query;
创建一个带有右括号的查询条件组。
......@@ -3247,9 +3250,9 @@ endGroup\(\): Query;
```
### prefixKey ###
### prefixKey<sup>8+</sup> ###
prefixKey\(prefix: string\): Query;
prefixKey(prefix: string): Query;
创建具有指定键前缀的查询条件。
......@@ -3308,9 +3311,9 @@ prefixKey\(prefix: string\): Query;
```
### setSuggestIndex ###
### setSuggestIndex<sup>8+</sup> ###
setSuggestIndex\(index: string\): Query;
setSuggestIndex(index: string): Query;
设置一个指定的索引，将优先用于查询。
......@@ -3375,7 +3378,7 @@ KVStore数据库实例，提供增加数据、删除数据和订阅数据变更
### put<a name="section1942221513"></a>
put\(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback<void\>\): void
put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback<void>): void
添加指定类型键值对到数据库，并通过callback方式返回，此方法为异步方法。
......@@ -3444,7 +3447,7 @@ put\(key: string, value: Uint8Array | string | number | boolean, callback: Async
### put<a name="section43065440019"></a>
put\(key: string, value: Uint8Array | string | number | boolean\): Promise<void\>
put(key: string, value: Uint8Array | string | number | boolean): Promise<void>
添加指定类型键值对到数据库，并通过Promise方式返回，此方法为异步方法。
......@@ -3520,7 +3523,7 @@ put\(key: string, value: Uint8Array | string | number | boolean\): Promise<void\
### delete<a name="section15564125555713"></a>
delete\(key: string, callback: AsyncCallback<void\>\): void
delete(key: string, callback: AsyncCallback<void>): void
从数据库中删除指定键值的数据，并通过callback方式返回，此方法为异步方法。
......@@ -3586,7 +3589,7 @@ delete\(key: string, callback: AsyncCallback<void\>\): void
### delete<a name="section1298265189"></a>
delete\(key: string\): Promise<void\>
delete(key: string): Promise<void>
从数据库中删除指定键值的数据，并通过Promise方式返回，此方法为异步方法。
......@@ -3656,7 +3659,7 @@ delete\(key: string\): Promise<void\>
### on<a name="section9748071812"></a>
on\(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification\>\): void
on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification>): void
订阅指定类型的数据变更通知，此方法为同步方法。
......@@ -3706,7 +3709,7 @@ on\(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotificat
### on<a name="section06419235582"></a>
on\(event: 'syncComplete', syncCallback: Callback<Array<\[string, number\]\>\>\): void
on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>): void
订阅数据同步完成通知，此方法为同步方法。
......@@ -3730,7 +3733,7 @@ on\(event: 'syncComplete', syncCallback: Callback<Array<\[string, number\]\>\>\)
</tr>
<tr id="row629323499"><td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.1.4.1.1 "><p id="p629393496"><a name="p629393496"></a><a name="p629393496"></a>syncCallback</p>
</td>
<td class="cellrowborder" valign="top" width="40.160000000000004%" headers="mcps1.1.4.1.2 "><p id="p92931231917"><a name="p92931231917"></a><a name="p92931231917"></a>Callback&lt;Array&lt;[string, number]&gt;&gt;</p>
<td class="cellrowborder" valign="top" width="40.160000000000004%" headers="mcps1.1.4.1.2 "><p id="p92931231917"><a name="p92931231917"></a><a name="p92931231917"></a>Callback&lt;Array&lt;[string, number]&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="43.3%" headers="mcps1.1.4.1.3 "><p id="p529433197"><a name="p529433197"></a><a name="p529433197"></a>回调函数。</p>
</td>
......@@ -3746,9 +3749,9 @@ on\(event: 'syncComplete', syncCallback: Callback<Array<\[string, number\]\>\>\)
});
```
### off ###
### off<sup>8+</sup> ###
off\(event:'dataChange', observer: Callback<ChangeNotification\>\): void;
off(event:'dataChange', observer: Callback<ChangeNotification>): void;
取消订阅数据同步完成通知，此方法为同步方法。
......@@ -3780,9 +3783,9 @@ off\(event:'dataChange', observer: Callback<ChangeNotification\>\): void;
</tbody>
</table>
### putBatch ###
### putBatch<sup>8+</sup> ###
putBatch\(entries: Entry[], callback: AsyncCallback<void\>\): void;
putBatch(entries: Entry[], callback: AsyncCallback<void>): void;
批量插入键值对到KvStore数据库中，并通过callback方式返回，此方法为异步方法。
......@@ -3817,9 +3820,9 @@ putBatch\(entries: Entry[], callback: AsyncCallback<void\>\): void;
</tbody>
</table>
### putBatch ###
### putBatch<sup>8+</sup> ###
putBatch\(entries: Entry[\]\): Promise<void\>;
putBatch(entries: Entry[]): Promise<void>;
批量插入键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。
......@@ -3863,7 +3866,7 @@ putBatch\(entries: Entry[\]\): Promise<void\>;
</tbody>
</table>
### deleteBatch ###
### deleteBatch<sup>8+</sup> ###
deleteBatch(keys: string[], callback: AsyncCallback<void>): void;
......@@ -3900,9 +3903,9 @@ deleteBatch(keys: string[], callback: AsyncCallback<void>): void;
</tbody>
</table>
### deleteBatch ###
### deleteBatch<sup>8+</sup> ###
deleteBatch\(keys: string[\]\): Promise<void\>;
deleteBatch(keys: string[]): Promise<void>;
批量删除键值对到KvStore数据库中，并通过Promise方式返回，此方法为异步方法。
......@@ -3946,9 +3949,9 @@ deleteBatch\(keys: string[\]\): Promise<void\>;
</tbody>
</table>
### startTransaction ###
### startTransaction<sup>8+</sup> ###
startTransaction\(callback: AsyncCallback<void\>\): void;
startTransaction(callback: AsyncCallback<void>): void;
启动KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。
......@@ -3975,9 +3978,9 @@ startTransaction\(callback: AsyncCallback<void\>\): void;
</tbody>
</table>
### startTransaction ###
### startTransaction<sup>8+</sup> ###
startTransaction\(\): Promise<void\>;
startTransaction(): Promise<void>;
启动KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。
......@@ -3998,9 +4001,9 @@ startTransaction\(\): Promise<void\>;
</tbody>
</table>
### commit ###
### commit<sup>8+</sup> ###
commit\(callback: AsyncCallback<void\>\): void;
commit(callback: AsyncCallback<void>): void;
提交KvStore数据库中的事务，并通过callback方式返回，此方法为异步方法。
......@@ -4027,9 +4030,9 @@ commit\(callback: AsyncCallback<void\>\): void;
</tbody>
</table>
### commit ###
### commit<sup>8+</sup> ###
commit(\): Promise<void\>;
commit(): Promise<void>;
提交KvStore数据库中的事务，并通过Promise方式返回，此方法为异步方法。
......@@ -4050,9 +4053,9 @@ commit(\): Promise<void\>;
</tbody>
</table>
### rollback ###
### rollback<sup>8+</sup> ###
rollback\(callback: AsyncCallback<void\>\): void;
rollback(callback: AsyncCallback<void>): void;
在KvStore数据库中回滚事务，并通过callback方式返回，此方法为异步方法。
......@@ -4079,9 +4082,9 @@ rollback\(callback: AsyncCallback<void\>\): void;
</tbody>
</table>
### rollback ###
### rollback<sup>8+</sup> ###
rollback(\): Promise<void\>;
rollback(): Promise<void>;
在KvStore数据库中回滚事务，并通过Promise方式返回，此方法为异步方法。
......@@ -4102,9 +4105,9 @@ rollback(\): Promise<void\>;
</tbody>
</table>
### enableSync ###
### enableSync<sup>8+</sup> ###
enableSync\(enabled: boolean, callback: AsyncCallback<void\>\): void;
enableSync(enabled: boolean, callback: AsyncCallback<void>): void;
设定是否开启同步，并通过callback方式返回，此方法为异步方法。
......@@ -4142,9 +4145,9 @@ enableSync\(enabled: boolean, callback: AsyncCallback<void\>\): void;
</tbody>
</table>
### enableSync ###
### enableSync<sup>8+</sup> ###
enableSync\(enabled: boolean\): Promise<void\>;
enableSync(enabled: boolean): Promise<void>;
设定是否开启同步，并通过Promise方式返回，此方法为异步方法。
......@@ -4190,9 +4193,9 @@ enableSync\(enabled: boolean\): Promise<void\>;
</tbody>
</table>
### setSyncRange ###
### setSyncRange<sup>8+</sup> ###
setSyncRange\(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback<void\>\): void;
setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback<void>): void;
设置同步范围标签，并通过callback方式返回，此方法为异步方法。
......@@ -4239,9 +4242,9 @@ setSyncRange\(localLabels: string[], remoteSupportLabels: string[], callback: As
</tbody>
</table>
### setSyncRange ###
### setSyncRange<sup>8+</sup> ###
setSyncRange\(localLabels: string[], remoteSupportLabels: string[\]\): Promise<void\>;
setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise<void>;
设置同步范围标签，并通过Promise方式返回，此方法为异步方法。
......@@ -4547,7 +4550,7 @@ setSyncRange\(localLabels: string[], remoteSupportLabels: string[\]\): Promise<v
### get<a name="section107972383294"></a>
get\(key: string, callback: AsyncCallback<Uint8Array | string | boolean | number\>\): void
get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | number>): void
获取指定键的值，并通过callback方式返回，此方法为异步方法。
......@@ -4609,7 +4612,7 @@ get\(key: string, callback: AsyncCallback<Uint8Array | string | boolean | number
### get<a name="section1326485818382"></a>
get\(key: string\): Promise<Uint8Array | string | boolean | number\>
get(key: string): Promise<Uint8Array | string | boolean | number>
获取指定键的值，并通过Promise方式返回，此方法为异步方法。
......@@ -4677,9 +4680,9 @@ get\(key: string\): Promise<Uint8Array | string | boolean | number\>
}
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(keyPrefix: string, callback: AsyncCallback<Entry[\]\>\): void;
getEntries(keyPrefix: string, callback: AsyncCallback<Entry[]>): void;
获取匹配指定键前缀的所有键值对，并通过callback方式返回，此方法为异步方法。
......@@ -4747,9 +4750,9 @@ getEntries\(keyPrefix: string, callback: AsyncCallback<Entry[\]\>\): void;
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(keyPrefix: string\): Promise<Entry[\]\>;
getEntries(keyPrefix: string): Promise<Entry[]>;
获取匹配指定键前缀的所有键值对，并通过Promise方式返回，此方法为异步方法。
......@@ -4832,9 +4835,9 @@ getEntries\(keyPrefix: string\): Promise<Entry[\]\>;
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(query: Query, callback: AsyncCallback<Entry[\]\>\): void;
getEntries(query: Query, callback: AsyncCallback<Entry[]>): void;
获取与指定 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。
......@@ -4903,9 +4906,9 @@ getEntries\(query: Query, callback: AsyncCallback<Entry[\]\>\): void;
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(query: Query\): Promise<Entry[\]\>;
getEntries(query: Query): Promise<Entry[]>;
获取匹配指定键前缀的所有键值对，并通过Promise方式返回，此方法为异步方法。
......@@ -4988,9 +4991,9 @@ getEntries\(query: Query\): Promise<Entry[\]\>;
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet\>\): void;
getResultSet(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>): void;
从 KvStore 数据库中获取具有指定前缀的结果集，并通过callback方式返回，此方法为异步方法。
......@@ -5061,9 +5064,9 @@ getResultSet\(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet\>\): v
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(keyPrefix: string\): Promise<KvStoreResultSet\>;
getResultSet(keyPrefix: string): Promise<KvStoreResultSet>;
从 KvStore 数据库中获取具有指定前缀的结果集，并通过Promise方式返回，此方法为异步方法。
......@@ -5149,9 +5152,9 @@ getResultSet\(keyPrefix: string\): Promise<KvStoreResultSet\>;
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(query: Query, callback: AsyncCallback<KvStoreResultSet\>\): void;
getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): void;
获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。
......@@ -5221,9 +5224,9 @@ getResultSet\(query: Query, callback: AsyncCallback<KvStoreResultSet\>\): void;
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(query: Query\): Promise<KvStoreResultSet\>;
getResultSet(query: Query): Promise<KvStoreResultSet>;
获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。
......@@ -5307,9 +5310,9 @@ getResultSet\(query: Query\): Promise<KvStoreResultSet\>;
}
```
### closeResultSet ###
### closeResultSet<sup>8+</sup> ###
closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback<void\>\): void;
closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>): void;
关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。
......@@ -5366,9 +5369,9 @@ closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback<void\>\): v
```
### closeResultSet ###
### closeResultSet<sup>8+</sup> ###
closeResultSet\(resultSet: KvStoreResultSet\): Promise<void\>;
closeResultSet(resultSet: KvStoreResultSet): Promise<void>;
关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。
......@@ -5431,9 +5434,9 @@ closeResultSet\(resultSet: KvStoreResultSet\): Promise<void\>;
```
### getResultSize ###
### getResultSize<sup>8+</sup> ###
getResultSize\(query: Query, callback: AsyncCallback<number\>\): void;
getResultSize(query: Query, callback: AsyncCallback<number>): void;
获取与指定 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。
......@@ -5483,9 +5486,9 @@ getResultSize\(query: Query, callback: AsyncCallback<number\>\): void;
```
### getResultSize ###
### getResultSize<sup>8+</sup> ###
getResultSize\(query: Query\): Promise<number\>;
getResultSize(query: Query): Promise<number>;
获取与指定 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。
......@@ -5543,9 +5546,9 @@ getResultSize\(query: Query\): Promise<number\>;
```
### removeDeviceData ###
### removeDeviceData<sup>8+</sup> ###
removeDeviceData\(deviceId: string, callback: AsyncCallback<void\>\): void;
removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void;
删除指定设备的数据，并通过callback方式返回，此方法为异步方法。
......@@ -5595,7 +5598,6 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback<void\>\): void;
kvStore.removeDeviceData(deviceid, async function (err,data) {
if (err == undefined) {
console.log('removeDeviceData success');
done();
} else {
console.log('removeDeviceData fail');
kvStore.get(KEY_TEST_STRING_ELEMENT, async function (err,data) {
......@@ -5610,9 +5612,9 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback<void\>\): void;
```
### removeDeviceData ###
### removeDeviceData<sup>8+</sup> ###
removeDeviceData\(deviceId: string\): Promise<void\>;
removeDeviceData(deviceId: string): Promise<void>;
删除指定设备的数据，并通过Promise方式返回，此方法为异步方法。
......@@ -5686,9 +5688,9 @@ removeDeviceData\(deviceId: string\): Promise<void\>;
```
### on ###
### on<sup>8+</sup> ###
on\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>\): void;
on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>): void;
注册同步 SingleKvStore 数据库回调，并通过异步方式返回。
......@@ -5716,7 +5718,7 @@ on\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>\): vo
</tr>
<tr id="row78002038172916"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1080073812920"><a name="p1080073812920"></a><a name="p1080073812920"></a>syncCallback</p>
</td>
<td class="cellrowborder" valign="top" width="15.44%" headers="mcps1.1.5.1.2 "><p id="p380043819290"><a name="p380043819290"></a>Callback&lt;Array&lt;[string, number]&gt;&gt;></p>
<td class="cellrowborder" valign="top" width="15.44%" headers="mcps1.1.5.1.2 "><p id="p380043819290"><a name="p380043819290"></a>Callback&lt;Array&lt;[string, number]&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="8.4799999999999995%" headers="mcps1.1.5.1.3 "><p id="p280093882916"><a name="p280093882916"></a><a name="p280093882916"></a>是</p>
</td>
......@@ -5746,9 +5748,9 @@ on\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>\): vo
```
### off ###
### off<sup>8+</sup> ###
off\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>\): void;
off(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>): void;
取消注册同步 SingleKvStore 数据库回调，并通过异步方式返回。
......@@ -5776,7 +5778,7 @@ off\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>\): v
</tr>
<tr id="row78002038172916"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1080073812920"><a name="p1080073812920"></a><a name="p1080073812920"></a>syncCallback</p>
</td>
<td class="cellrowborder" valign="top" width="15.44%" headers="mcps1.1.5.1.2 "><p id="p380043819290"><a name="p380043819290"></a>Callback&lt;Array&lt;[string, number]&gt;&gt;></p>
<td class="cellrowborder" valign="top" width="15.44%" headers="mcps1.1.5.1.2 "><p id="p380043819290"><a name="p380043819290"></a>Callback&lt;Array&lt;[string, number]&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="8.4799999999999995%" headers="mcps1.1.5.1.3 "><p id="p280093882916"><a name="p280093882916"></a><a name="p280093882916"></a>是</p>
</td>
......@@ -5803,7 +5805,7 @@ off\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>\): v
### sync<a name="section619117584517"></a>
sync\(deviceIdList: string\[\], mode: SyncMode, allowedDelayMs?: number\): void
sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void
在手动同步模式下，触发数据库同步，此方法为同步方法。
......@@ -5853,12 +5855,12 @@ sync\(deviceIdList: string\[\], mode: SyncMode, allowedDelayMs?: number\): void
- 示例：
```
kvStore.sync(deviceIds, 1, 1000);
kvStore.sync('deviceIds', 1, 1000);
```
### setSyncParam ###
### setSyncParam<sup>8+</sup> ###
setSyncParam\(defaultAllowedDelayMs: number, callback: AsyncCallback<void\>\): void;
setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback<void>): void;
设置允许数据库同步的默认延迟,并通过callback方式返回，此方法为异步方法。
......@@ -5910,9 +5912,9 @@ setSyncParam\(defaultAllowedDelayMs: number, callback: AsyncCallback<void\>\): v
```
### setSyncParam ###
### setSyncParam<sup>8+</sup> ###
setSyncParam\(defaultAllowedDelayMs: number\): Promise<void\>;
setSyncParam(defaultAllowedDelayMs: number): Promise<void>;
设置允许数据库同步的默认延迟,并通过Promise方式返回，此方法为异步方法。
......@@ -5974,9 +5976,9 @@ setSyncParam\(defaultAllowedDelayMs: number\): Promise<void\>;
```
### getSecurityLevel ###
### getSecurityLevel<sup>8+</sup> ###
getSecurityLevel\(callback: AsyncCallback<SecurityLevel\>\): void;
getSecurityLevel(callback: AsyncCallback<SecurityLevel>): void;
获取数据库的安全级别，并通过callback方式返回，此方法为异步方法。
......@@ -6018,9 +6020,9 @@ getSecurityLevel\(callback: AsyncCallback<SecurityLevel\>\): void;
```
### getSecurityLevel ###
### getSecurityLevel<sup>8+</sup> ###
getSecurityLevel(\): Promise<SecurityLevel\>;
getSecurityLevel(): Promise<SecurityLevel>;
获取数据库的安全级别，并通过Promise方式返回，此方法为异步方法。
......@@ -6056,13 +6058,13 @@ getSecurityLevel(\): Promise<SecurityLevel\>;
```
## DeviceKVStore ##
## DeviceKVStore<sup>8+</sup> ##
在分布式系统中通过设备管理分布式数据，继承自KvStore，提供查询数据和同步数据的方法。在调用DeviceKVStore的方法前，需要先通过getKVStore构建一个KVStore实例。
### get ###
### get<sup>8+</sup> ###
get\(deviceId: string, key: string, callback: AsyncCallback<boolean|string|number|Uint8Array\>\): void;
get(deviceId: string, key: string, callback: AsyncCallback<boolean|string|number|Uint8Array>): void;
获取与指定设备 ID 和密钥匹配的 String 值，并通过callback方式返回，此方法为异步方法。
......@@ -6117,7 +6119,7 @@ get\(deviceId: string, key: string, callback: AsyncCallback<boolean|string|numbe
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) {
kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT, function (err,data) {
console.log('get success');
});
})
......@@ -6127,9 +6129,9 @@ get\(deviceId: string, key: string, callback: AsyncCallback<boolean|string|numbe
```
### get ###
### get<sup>8+</sup> ###
get\(deviceId: string, key: string\): Promise<boolean|string|number|Uint8Array\>;
get(deviceId: string, key: string): Promise<boolean|string|number|Uint8Array>;
获取与指定设备 ID 和密钥匹配的 String 值，并通过Promise方式返回，此方法为异步方法。
......@@ -6192,7 +6194,7 @@ get\(deviceId: string, key: string\): Promise<boolean|string|number|Uint8Array\>
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) => {
kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT).then((data) => {
console.log('get success');
}).catch((err) => {
console.log('get fail ' + JSON.stringify(err));
......@@ -6206,9 +6208,9 @@ get\(deviceId: string, key: string\): Promise<boolean|string|number|Uint8Array\>
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry[\]\>\): void;
getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry[]>): void;
获取与指定设备 ID 和密钥前缀匹配的所有键值对，并通过callback方式返回，此方法为异步方法。
......@@ -6274,7 +6276,7 @@ getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry[\
console.log('entries: ' + entries);
kvStore.putBatch(entries, async function (err,data) {
console.log('putBatch success');
kvStore.getEntries(localDeviceId, 'batch_test_string_key', function (err,entrys) {
kvStore.getEntries('localDeviceId', 'batch_test_string_key', function (err,entrys) {
console.log('getEntries success');
console.log('entrys.length: ' + entrys.length);
console.log('entrys[0]: ' + JSON.stringify(entrys[0]));
......@@ -6286,9 +6288,9 @@ getEntries\(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry[\
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(deviceId: string, keyPrefix: string\): Promise<Entry[\]\>;
getEntries(deviceId: string, keyPrefix: string): Promise<Entry[]>;
获取与指定设备 ID 和密钥前缀匹配的所有键值对，并通过Promise方式返回，此方法为异步方法。
......@@ -6362,7 +6364,7 @@ getEntries\(deviceId: string, keyPrefix: string\): Promise<Entry[\]\>;
console.log('entries: ' + entries);
kvStore.putBatch(entries).then(async (err) => {
console.log('putBatch success');
kvStore.getEntries(localDeviceId, 'batch_test_string_key').then((entrys) => {
kvStore.getEntries('localDeviceId', 'batch_test_string_key').then((entrys) => {
console.log('getEntries success');
console.log('entrys.length: ' + entrys.length);
console.log('entrys[0]: ' + JSON.stringify(entrys[0]));
......@@ -6380,9 +6382,9 @@ getEntries\(deviceId: string, keyPrefix: string\): Promise<Entry[\]\>;
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(query: Query, callback: AsyncCallback<Entry[\]\>\): void;
getEntries(query: Query, callback: AsyncCallback<Entry[]>): void;
获取与指定 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。
......@@ -6440,7 +6442,7 @@ getEntries\(query: Query, callback: AsyncCallback<Entry[\]\>\): void;
console.log('entries: ' + entries);
kvStore.putBatch(entries, async function (err,data) {
console.log('putBatch success');
kvStore.getEntries(localDeviceId, 'batch_test_bool_key', function (err,entrys) {
kvStore.getEntries('localDeviceId', 'batch_test_bool_key', function (err,entrys) {
console.log('getEntries success');
console.log('entrys.length: ' + entrys.length);
});
......@@ -6451,9 +6453,9 @@ getEntries\(query: Query, callback: AsyncCallback<Entry[\]\>\): void;
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(query: Query\): Promise<Entry[\]\>;
getEntries(query: Query): Promise<Entry[]>;
获取与指定 Query 对象匹配的键值对列表，并通过Promise方式返回，此方法为异步方法。
......@@ -6519,7 +6521,7 @@ getEntries\(query: Query\): Promise<Entry[\]\>;
console.log('entries: ' + entries);
kvStore.putBatch(entries).then(async (err) => {
console.log('putBatch success');
kvStore.getEntries(localDeviceId, 'batch_test_bool_key').then((entrys) => {
kvStore.getEntries('localDeviceId', 'batch_test_bool_key').then((entrys) => {
console.log('getEntries success');
}).catch((err) => {
console.log('getEntries fail ' + JSON.stringify(err));
......@@ -6533,9 +6535,9 @@ getEntries\(query: Query\): Promise<Entry[\]\>;
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(deviceId: string, query: Query, callback: AsyncCallback<Entry[\]\>\): void;
getEntries(deviceId: string, query: Query, callback: AsyncCallback<Entry[]>): void;
获取与指定设备 ID 和 Query 对象匹配的键值对列表，并通过callback方式返回，此方法为异步方法。
......@@ -6602,7 +6604,7 @@ getEntries\(deviceId: string, query: Query, callback: AsyncCallback<Entry[\]\>\)
console.log('entries: ' + entries);
kvStore.putBatch(entries, async function (err,data) {
console.log('putBatch success');
kvStore.getEntries(localDeviceId, 'batch_test_bool_key', function (err,entrys) {
kvStore.getEntries('localDeviceId', 'batch_test_bool_key', function (err,entrys) {
console.log('getEntries success');
console.log('entrys.length: ' + entrys.length);
});
......@@ -6613,9 +6615,9 @@ getEntries\(deviceId: string, query: Query, callback: AsyncCallback<Entry[\]\>\)
```
### getEntries ###
### getEntries<sup>8+</sup> ###
getEntries\(deviceId: string, query: Query\): Promise<Entry[\]\>;
getEntries(deviceId: string, query: Query): Promise<Entry[]>;
获取与指定设备 ID 和 Query 对象匹配的键值对列表，并通过Promise方式返回，此方法为异步方法。
......@@ -6690,7 +6692,7 @@ getEntries\(deviceId: string, query: Query\): Promise<Entry[\]\>;
console.log('entries: ' + entries);
kvStore.putBatch(entries).then(async (err) => {
console.log('putBatch success');
kvStore.getEntries(localDeviceId, 'batch_test_bool_key').then((entrys) => {
kvStore.getEntries('localDeviceId', 'batch_test_bool_key').then((entrys) => {
console.log('getEntries success');
}).catch((err) => {
console.log('getEntries fail ' + JSON.stringify(err));
......@@ -6704,9 +6706,9 @@ getEntries\(deviceId: string, query: Query\): Promise<Entry[\]\>;
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvStoreResultSet\>\): void;
getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>): void;
获取与指定设备 ID 和密钥前缀匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。
......@@ -6758,7 +6760,7 @@ getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvSto
```
try {
let resultSet;
kvStore.getResultSet(localDeviceId, 'batch_test_string_key', async function (err, result) {
kvStore.getResultSet('localDeviceId', 'batch_test_string_key', async function (err, result) {
console.log('getResultSet success');
resultSet = result;
kvStore.closeResultSet(resultSet, function (err, data) {
......@@ -6771,9 +6773,9 @@ getResultSet\(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvSto
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(deviceId: string, keyPrefix: string\): Promise<KvStoreResultSet\>;
getResultSet(deviceId: string, keyPrefix: string): Promise<KvStoreResultSet>;
获取与指定设备 ID 和密钥前缀匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。
......@@ -6833,7 +6835,7 @@ getResultSet\(deviceId: string, keyPrefix: string\): Promise<KvStoreResultSet\>;
```
try {
let resultSet;
kvStore.getResultSet(localDeviceId, 'batch_test_string_key').then((result) => {
kvStore.getResultSet('localDeviceId', 'batch_test_string_key').then((result) => {
console.log('getResultSet success');
resultSet = result;
}).catch((err) => {
......@@ -6850,9 +6852,9 @@ getResultSet\(deviceId: string, keyPrefix: string\): Promise<KvStoreResultSet\>;
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(query: Query, callback: AsyncCallback<KvStoreResultSet\>\): void;
getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): void;
获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。
......@@ -6904,9 +6906,9 @@ getResultSet\(query: Query, callback: AsyncCallback<KvStoreResultSet\>\): void;
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(query: Query\): Promise<KvStoreResultSet\>;
getResultSet(query: Query): Promise<KvStoreResultSet>;
获取与指定 Query 对象匹配的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。
......@@ -6975,7 +6977,7 @@ getResultSet\(query: Query\): Promise<KvStoreResultSet\>;
console.log('PutBatch putBatch fail ' + JSON.stringify(err));
});
const query = new factory.Query();
query.deviceId(localDeviceId);
query.deviceId('localDeviceId');
query.prefixKey("batch_test");
console.log("GetResultSet " + query.getSqlLike());
kvStore.getResultSet(query).then((result) => {
......@@ -6995,9 +6997,9 @@ getResultSet\(query: Query\): Promise<KvStoreResultSet\>;
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(deviceId: string, query: Query, callback: AsyncCallback<KvStoreResultSet\>\): void;
getResultSet(deviceId: string, query: Query, callback: AsyncCallback<KvStoreResultSet>): void;
获取与指定设备ID和Query对象匹配的KvStoreResultSet对象，并通过callback方式返回，此方法为异步方法。
......@@ -7058,9 +7060,9 @@ getResultSet\(deviceId: string, query: Query, callback: AsyncCallback<KvStoreRes
```
### getResultSet ###
### getResultSet<sup>8+</sup> ###
getResultSet\(deviceId: string, query: Query\): Promise<KvStoreResultSet\>;
getResultSet(deviceId: string, query: Query): Promise<KvStoreResultSet>;
获取与指定设备ID和Query对象匹配的KvStoreResultSet对象，并通过Promise方式返回，此方法为异步方法。
......@@ -7138,14 +7140,14 @@ getResultSet\(deviceId: string, query: Query\): Promise<KvStoreResultSet\>;
console.log('PutBatch putBatch fail ' + JSON.stringify(err));
});
const query = new factory.Query();
prefixKey("batch_test");
kvStore.getResultSet(localDeviceId, query).then((result) => {
query.prefixKey("batch_test");
kvStore.getResultSet('localDeviceId', query).then((result) => {
console.log('GetResultSet getResultSet success');
resultSet = result;
}).catch((err) => {
console.log('GetResultSet getResultSet fail ' + JSON.stringify(err));
});
query.deviceId(localDeviceId);
query.deviceId('localDeviceId');
console.log("GetResultSet " + query.getSqlLike());
kvStore.closeResultSet(resultSet).then((err) => {
console.log('GetResultSet closeResultSet success');
......@@ -7159,9 +7161,9 @@ getResultSet\(deviceId: string, query: Query\): Promise<KvStoreResultSet\>;
```
### closeResultSet ###
### closeResultSet<sup>8+</sup> ###
closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback<void\>\): void;
closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>): void;
关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过callback方式返回，此方法为异步方法。
......@@ -7218,9 +7220,9 @@ closeResultSet\(resultSet: KvStoreResultSet, callback: AsyncCallback<void\>\): v
```
### closeResultSet ###
### closeResultSet<sup>8+</sup> ###
closeResultSet\(resultSet: KvStoreResultSet\): Promise<void>;
closeResultSet(resultSet: KvStoreResultSet): Promise<void>;
关闭由 getResultSet 返回的 KvStoreResultSet 对象，并通过Promise方式返回，此方法为异步方法。
......@@ -7283,9 +7285,9 @@ closeResultSet\(resultSet: KvStoreResultSet\): Promise<void>;
```
### getResultSize ###
### getResultSize<sup>8+</sup> ###
getResultSize\(query: Query, callback: AsyncCallback<number\>\): void;
getResultSize(query: Query, callback: AsyncCallback<number>): void;
获取与指定 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。
......@@ -7335,9 +7337,9 @@ getResultSize\(query: Query, callback: AsyncCallback<number\>\): void;
```
### getResultSize ###
### getResultSize<sup>8+</sup> ###
getResultSize\(query: Query\): Promise<number\>;
getResultSize(query: Query): Promise<number>;
获取与指定 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。
......@@ -7395,9 +7397,9 @@ getResultSize\(query: Query\): Promise<number\>;
```
### getResultSize ###
### getResultSize<sup>8+</sup> ###
getResultSize\(deviceId: string, query: Query, callback: AsyncCallback<number\>\): void;
getResultSize(deviceId: string, query: Query, callback: AsyncCallback<number>): void;
获取与指定设备 ID 和 Query 对象匹配的结果数，并通过callback方式返回，此方法为异步方法。
......@@ -7456,9 +7458,9 @@ getResultSize\(deviceId: string, query: Query, callback: AsyncCallback<number\>\
```
### getResultSize ###
### getResultSize<sup>8+</sup> ###
getResultSize\(deviceId: string, query: Query\): Promise<number\>;
getResultSize(deviceId: string, query: Query): Promise<number>;
获取与指定设备 ID 和 Query 对象匹配的结果数，并通过Promise方式返回，此方法为异步方法。
......@@ -7525,9 +7527,9 @@ getResultSize\(deviceId: string, query: Query\): Promise<number\>;
```
### removeDeviceData ###
### removeDeviceData<sup>8+</sup> ###
removeDeviceData\(deviceId: string, callback: AsyncCallback<void\>\): void;
removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void;
从当前数据库中删除指定设备的数据，并通过callback方式返回，此方法为异步方法。
......@@ -7579,7 +7581,7 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback<void\>\): void;
console.log('removeDeviceData success');
} else {
console.log('testDeviceKvStoreRemoveDeviceData101 removeDeviceData fail');
kvStore.get(localDeviceId, KEY_TEST_STRING_ELEMENT, async function (err,data) {
kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT, async function (err,data) {
console.log('RemoveDeviceData get success');
});
}
......@@ -7591,9 +7593,9 @@ removeDeviceData\(deviceId: string, callback: AsyncCallback<void\>\): void;
```
### removeDeviceData ###
### removeDeviceData<sup>8+</sup> ###
removeDeviceData\(deviceId: string\): Promise<void\>;
removeDeviceData(deviceId: string): Promise<void>;
从当前数据库中删除指定设备的数据，并通过Promise方式返回，此方法为异步方法。
......@@ -7658,7 +7660,7 @@ removeDeviceData\(deviceId: string\): Promise<void\>;
console.log('RemoveDeviceData removeDeviceData fail ' + JSON.stringify(err));
});
kvStore.get(localDeviceId, KEY_TEST_STRING_ELEMENT).then((data) => {
kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT).then((data) => {
console.log('RemoveDeviceData get success data:' + data);
}).catch((err) => {
console.log('RemoveDeviceData get fail ' + JSON.stringify(err));
......@@ -7670,9 +7672,9 @@ removeDeviceData\(deviceId: string\): Promise<void\>;
```
### sync ###
### sync<sup>8+</sup> ###
sync\(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number\): void;
sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void;
同步 DeviceKvStore 数据库，该方法为异步方法。
......@@ -7739,9 +7741,9 @@ sync\(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number\): void;
}
```
### on ###
### on<sup>8+</sup> ###
on\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>\>): void;
on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>): void;
注册同步 DeviceKvStore 数据库回调，通过异步回调返回。
......@@ -7769,7 +7771,7 @@ on\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>\>): vo
</tr>
<tr id="row78002038172916"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1080073812920"><a name="p1080073812920"></a><a name="p1080073812920"></a>syncCallback</p>
</td>
<td class="cellrowborder" valign="top" width="15.44%" headers="mcps1.1.5.1.2 "><p id="p380043819290"><a name="p380043819290"></a>Callback&lt;Array&lt;[string, number]&gt;&gt;></p>
<td class="cellrowborder" valign="top" width="15.44%" headers="mcps1.1.5.1.2 "><p id="p380043819290"><a name="p380043819290"></a>Callback&lt;Array&lt;[string, number]&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="8.4799999999999995%" headers="mcps1.1.5.1.3 "><p id="p280093882916"><a name="p280093882916"></a><a name="p280093882916"></a>是</p>
</td>
......@@ -7799,9 +7801,9 @@ on\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>\>): vo
```
### off ###
### off<sup>8+</sup> ###
off\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>\): void;
off(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>): void;
取消注册同步 DeviceKvStore 数据库回调，通过异步回调返回。
......@@ -7829,7 +7831,7 @@ off\(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>\): v
</tr>
<tr id="row78002038172916"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1080073812920"><a name="p1080073812920"></a><a name="p1080073812920"></a>syncCallback</p>
</td>
<td class="cellrowborder" valign="top" width="15.44%" headers="mcps1.1.5.1.2 "><p id="p380043819290"><a name="p380043819290"></a>Callback&lt;Array&lt;[string, number]&gt;&gt;></p>
<td class="cellrowborder" valign="top" width="15.44%" headers="mcps1.1.5.1.2 "><p id="p380043819290"><a name="p380043819290"></a>Callback&lt;Array&lt;[string, number]&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="8.4799999999999995%" headers="mcps1.1.5.1.3 "><p id="p280093882916"><a name="p280093882916"></a><a name="p280093882916"></a>是</p>
</td>
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或