js-apis-distributed-data.md 172.7 KB
Newer Older
1
# 分布式数据管理
Z
zengyawen 已提交
2

G
ge-yafang 已提交
3 4 5 6 7 8 9 10 11 12
分布式数据管理为应用程序提供不同设备间数据库的分布式协同能力。通过调用分布式数据各个接口,应用程序可将数据保存到分布式数据库中,并可对分布式数据库中的数据进行增加、删除、修改、查询、同步等操作。

该模块提供以下分布式数据管理相关的常用功能:

- [KVManager](#kvmanager):数据管理实例,用于获取KVStore的相关信息。
- [KvStoreResultSet<sup>8+</sup>](#kvstoreresultset8):提供获取KVStore数据库结果集的相关方法,包括查询和移动数据读取位置等。
- [Query<sup>8+</sup>](#query8):使用谓词表示数据库查询,提供创建Query实例、查询数据库中的数据和添加谓词的方法。
- [KVStore](#kvstore):KVStore数据库实例,提供增加数据、删除数据和订阅数据变更、订阅数据同步完成的方法。
- [SingleKVStore](#singlekvstore):单版本分布式数据库,继承自[KVStore](#kvstore),不对数据所属设备进行区分,提供查询数据和同步数据的方法。
- [DeviceKVStore<sup>8+</sup>](#devicekvstore8):设备协同数据库,继承自[KVStore](#kvstore),以设备维度对数据进行区分,提供查询数据和同步数据的方法。
G
ge-yafang 已提交
13

G
ge-yafang 已提交
14
>**说明:** 
G
ge-yafang 已提交
15
>
A
asfasdff 已提交
16
>本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
17

18

19
## 导入模块
Z
zengyawen 已提交
20

G
ge-yafang 已提交
21
```js
Z
zengyawen 已提交
22 23 24 25
import distributedData from '@ohos.data.distributedData';
```


26
## distributedData.createKVManager
Z
zengyawen 已提交
27

A
asfasdff 已提交
28
createKVManager(config: KVManagerConfig, callback: AsyncCallback&lt;KVManager&gt;): void
Z
zengyawen 已提交
29

G
ge-yafang 已提交
30
创建一个KVManager对象实例,用于管理数据库对象,使用callback异步回调。
Z
zengyawen 已提交
31

G
ge-yafang 已提交
32
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
W
wufengshan 已提交
33

G
ge-yafang 已提交
34
**参数:**
35 36 37 38

| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| config | [KVManagerConfig](#kvmanagerconfig) | 是  | 提供KVManager实例的配置信息,包括调用方的包名和用户信息。 |
G
ge-yafang 已提交
39
| callback | AsyncCallback&lt;[KVManager](#kvmanager)&gt; | 是  | 回调函数。返回创建的KVManager对象实例。 |
A
asfasdff 已提交
40

G
ge-yafang 已提交
41
**示例:**
42

W
wangkai 已提交
43
Stage模型下的示例:
W
wangkai 已提交
44
```ts
W
wangkai 已提交
45
import AbilityStage from '@ohos.application.Ability'
G
ge-yafang 已提交
46
let kvManager;
W
wangkai 已提交
47
export default class MyAbilityStage extends AbilityStage {
S
siyuan.liu 已提交
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
    onCreate() {
        console.log("MyAbilityStage onCreate")
        let context = this.context
        const kvManagerConfig = {
            context: context,
            bundleName: 'com.example.datamanagertest',
            userInfo: {
                userId: '0',
                userType: distributedData.UserType.SAME_USER_ID
            }
        }
        distributedData.createKVManager(kvManagerConfig, function (err, manager) {
            if (err) {
                console.log("Failed to create KVManager: " + JSON.stringify(err));
                return;
            }
            console.log("Succeeded in creating KVManager");
            kvManager = manager;
        });
A
asfasdff 已提交
67
    }
W
wangkai 已提交
68 69 70
}
```

W
wangkai 已提交
71
FA模型下的示例:
W
wangkai 已提交
72
```js
S
siyuan.liu 已提交
73
import featureAbility from '@ohos.ability.featureAbility'
W
wangkai 已提交
74
let kvManager;
S
siyuan.liu 已提交
75 76
let context = featureAbility.getContext()
const kvManagerConfig = {
S
siyuan.liu 已提交
77 78 79 80 81 82
    context: context,
    bundleName: 'com.example.datamanagertest',
    userInfo: {
        userId: '0',
        userType: distributedData.UserType.SAME_USER_ID
    }
W
wangkai 已提交
83
}
S
siyuan.liu 已提交
84
distributedData.createKVManager(kvManagerConfig, function (err, manager) {
S
siyuan.liu 已提交
85 86 87 88 89 90
    if (err) {
        console.log("Failed to create KVManager: " + JSON.stringify(err));
        return;
    }
    console.log("Created KVManager");
    kvManager = manager;
S
siyuan.liu 已提交
91
});
W
wangkai 已提交
92
```
A
asfasdff 已提交
93

94
## distributedData.createKVManager
A
asfasdff 已提交
95

A
asfasdff 已提交
96
createKVManager(config: KVManagerConfig): Promise&lt;KVManager&gt;
Z
zengyawen 已提交
97

G
ge-yafang 已提交
98
创建一个KVManager对象实例,用于管理数据库对象,使用Promise异步回调。
Z
zengyawen 已提交
99

G
ge-yafang 已提交
100
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
W
wufengshan 已提交
101

G
ge-yafang 已提交
102
**参数:**
Z
zengyawen 已提交
103

104 105 106
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| config |[KVManagerConfig](#kvmanager) | 是  | 提供KVManager实例的配置信息,包括调用方的包名和用户信息。 |
Z
zengyawen 已提交
107

G
ge-yafang 已提交
108
**返回值:**
A
asfasdff 已提交
109

110 111
| 类型 | 说明 |
| -------- | -------- |
G
ge-yafang 已提交
112
| Promise&lt;[KVManager](#kvmanager)&gt; | Promise对象。返回创建的KVManager对象实例。 |
Z
zengyawen 已提交
113

G
ge-yafang 已提交
114
**示例:**
115

W
wangkai 已提交
116
Stage模型下的示例:
W
wangkai 已提交
117
```ts
W
wangkai 已提交
118 119 120
import AbilityStage from '@ohos.application.Ability'
let kvManager;
export default class MyAbilityStage extends AbilityStage {
S
siyuan.liu 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
    onCreate() {
        console.log("MyAbilityStage onCreate")
        let context = this.context
        const kvManagerConfig = {
            context: context,
            bundleName: 'com.example.datamanagertest',
            userInfo: {
                userId: '0',
                userType: distributedData.UserType.SAME_USER_ID
            }
        }
        distributedData.createKVManager(kvManagerConfig).then((manager) => {
            console.log("Succeeded in creating KVManager");
            kvManager = manager;
        }).catch((err) => {
            console.log("Failed to create KVManager: " + JSON.stringify(err));
        });
W
wangkai 已提交
138 139 140
    }
}
```
A
asfasdff 已提交
141

W
wangkai 已提交
142
FA模型下的示例:
G
ge-yafang 已提交
143
```js
S
siyuan.liu 已提交
144
import featureAbility from '@ohos.ability.featureAbility'
G
ge-yafang 已提交
145
let kvManager;
S
siyuan.liu 已提交
146 147
let context = featureAbility.getContext()
const kvManagerConfig = {
S
siyuan.liu 已提交
148 149 150 151 152 153
    context: context,
    bundleName: 'com.example.datamanagertest',
    userInfo: {
        userId: '0',
        userType: distributedData.UserType.SAME_USER_ID
    }
G
ge-yafang 已提交
154
}
S
siyuan.liu 已提交
155
distributedData.createKVManager(kvManagerConfig).then((manager) => {
S
siyuan.liu 已提交
156 157
    console.log("Succeeded in creating KVManager");
    kvManager = manager;
S
siyuan.liu 已提交
158
}).catch((err) => {
S
siyuan.liu 已提交
159
    console.log("Failed to create KVManager: " + JSON.stringify(err));
S
siyuan.liu 已提交
160
});
G
ge-yafang 已提交
161
```
A
asfasdff 已提交
162

163
## KVManagerConfig
Z
zengyawen 已提交
164 165 166

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

G
ge-yafang 已提交
167
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
W
wufengshan 已提交
168

169 170
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
171
| context<sup>9+<sup> | Context | 是 | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。|
172 173 174 175
| userInfo | [UserInfo](#userinfo) | 是  | 调用方的用户信息。 |
| bundleName | string | 是  | 调用方的包名。 |

## UserInfo
Z
zengyawen 已提交
176 177 178

用户信息。

G
ge-yafang 已提交
179
**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core
W
wufengshan 已提交
180

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


## UserType
Z
zengyawen 已提交
188

G
ge-yafang 已提交
189
用户类型枚举。
Z
zengyawen 已提交
190

G
ge-yafang 已提交
191
**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core
W
wufengshan 已提交
192

G
ge-yafang 已提交
193
| 名称 | 值 | 说明 |
194 195 196 197 198
| ----- | ------ | ------ |
| SAME_USER_ID | 0 | 使用同一帐户登录不同设备的用户。 |


## KVManager
Z
zengyawen 已提交
199

G
ge-yafang 已提交
200
数据管理实例,用于获取KVStore的相关信息。在调用KVManager的方法前,需要先通过[createKVManager](#distributeddatacreatekvmanager)构建一个KVManager实例。
Z
zengyawen 已提交
201

202
### getKVStore
Z
zengyawen 已提交
203

204
getKVStore&lt;T extends KVStore&gt;(storeId: string, options: Options, callback: AsyncCallback&lt;T&gt;): void
Z
zengyawen 已提交
205

G
ge-yafang 已提交
206
通过指定Options和storeId,创建并获取KVStore数据库,使用callback异步回调。
Z
zengyawen 已提交
207

G
ge-yafang 已提交
208
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
W
wufengshan 已提交
209

G
ge-yafang 已提交
210
**参数:**
A
asfasdff 已提交
211

212 213 214 215
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| storeId | string | 是  | 数据库唯一标识符,长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
| options | [Options](#options) | 是  | 创建KVStore实例的配置信息。 |
G
ge-yafang 已提交
216
| callback | AsyncCallback&lt;T&gt;&lt;T extends [KVStore](#kvstore)&gt; | 是  | 回调函数。返回创建的KVStore数据库实例。 |
A
asfasdff 已提交
217

G
ge-yafang 已提交
218
**示例:**
A
asfasdff 已提交
219

G
ge-yafang 已提交
220
```js
G
ge-yafang 已提交
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
let kvStore;
let kvManager;
try {
    const options = {
        createIfMissing : true,
        encrypt : false,
        backup : false,
        autoSync : true,
        kvStoreType : distributedData.KVStoreType.SINGLE_VERSION,
        securityLevel : distributedData.SecurityLevel.S2,
    };
    kvManager.getKVStore('storeId', options, function (err, store) {
        if (err) {
            console.log("getKVStore err: "  + JSON.stringify(err));
            return;
        }
        console.log("getKVStore success");
        kvStore = store;
    });
} catch (e) {
    console.log("An unexpected error occurred. Error:" + e);
}
```
A
asfasdff 已提交
244 245


246
### getKVStore
A
asfasdff 已提交
247

A
asfasdff 已提交
248
getKVStore&lt;T extends KVStore&gt;(storeId: string, options: Options): Promise&lt;T&gt;
Z
zengyawen 已提交
249

G
ge-yafang 已提交
250
通过指定Options和storeId,创建并获取KVStore数据库,使用Promise异步回调。
Z
zengyawen 已提交
251

G
ge-yafang 已提交
252
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
W
wufengshan 已提交
253

G
ge-yafang 已提交
254
**参数:**
A
asfasdff 已提交
255

256 257 258 259
| 参数名   | 参数类型                | 必填  | 说明    |
| ------- | ---------------------- | ---- | -------------------- |
| storeId  | string      | 是   | 数据库唯一标识符,长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
| options  | [Options](#options)   | 是   | 创建KVStore实例的配置信息。|
A
asfasdff 已提交
260 261


G
ge-yafang 已提交
262
**返回值:**
A
asfasdff 已提交
263

264 265
| 类型                                    | 说明        |
| -------------------------------------- | ------------------------ |
G
ge-yafang 已提交
266
| Promise&lt;T&gt;&lt;T extends [KVStore](#kvstore)&gt; | Promise对象。返回创建的KVStore数据库实例。 |
267

G
ge-yafang 已提交
268
**示例:**
269

G
ge-yafang 已提交
270
```js
G
ge-yafang 已提交
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
let kvStore;
let kvManager;
try {
    const options = {
        createIfMissing : true,
        encrypt : false,
        backup : false,
        autoSync : true,
        kvStoreType : distributedData.KVStoreType.SINGLE_VERSION,
        securityLevel : distributedData.SecurityLevel.S2,
    };
    kvManager.getKVStore('storeId', options).then((store) => {
        console.log("getKVStore success");
        kvStore = store;
    }).catch((err) => {
        console.log("getKVStore err: "  + JSON.stringify(err));
    });
} catch (e) {
    console.log("An unexpected error occurred. Error:" + e);
}
```
A
asfasdff 已提交
292

293
### closeKVStore<sup>8+</sup>
A
asfasdff 已提交
294

295
closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
296

G
ge-yafang 已提交
297
通过storeId的值关闭指定的KVStore数据库,使用callback异步回调。
A
asfasdff 已提交
298

G
ge-yafang 已提交
299
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
300

G
ge-yafang 已提交
301
**参数:**
302 303 304 305 306 307


| 参数名   | 参数类型              | 必填 | 说明         |
| ------- | -----------------   | ---- | --------------------------- |
| appId    | string              | 是   | 所调用数据库方的包名。         |
| storeId  | string  | 是   | 要关闭的数据库唯一标识符,长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
G
ge-yafang 已提交
308
| kvStore  | [KVStore](#kvstore) | 是   | 要关闭的KVStore数据库。     |
G
ge-yafang 已提交
309
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
A
asfasdff 已提交
310

G
ge-yafang 已提交
311
**示例:**
A
asfasdff 已提交
312

G
ge-yafang 已提交
313
```js
G
ge-yafang 已提交
314 315 316
let kvStore;
let kvManager;
const options = {
S
siyuan.liu 已提交
317 318 319 320 321 322 323 324 325
    createIfMissing: true,
    encrypt: false,
    backup: false,
    autoSync: true,
    kvStoreType: distributedData.KVStoreType.SINGLE_VERSION,
    schema: '',
    securityLevel: distributedData.SecurityLevel.S2,
}
try {
G
ge-yafang 已提交
326
    kvManager.getKVStore('storeId', options, async function (err, store) {
S
siyuan.liu 已提交
327 328 329 330 331
        console.log('getKVStore success');
        kvStore = store;
        kvManager.closeKVStore('appId', 'storeId', kvStore, function (err, data) {
            console.log('closeKVStore success');
        });
G
ge-yafang 已提交
332 333 334 335 336 337
    });
} catch (e) {
    console.log('closeKVStore e ' + e);
}
```

A
asfasdff 已提交
338

339
### closeKVStore<sup>8+</sup>
A
asfasdff 已提交
340

341
closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise&lt;void&gt;
A
asfasdff 已提交
342

G
ge-yafang 已提交
343
通过storeId的值关闭指定的KVStore数据库,使用Promise异步回调。
A
asfasdff 已提交
344

G
ge-yafang 已提交
345
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
346

G
ge-yafang 已提交
347
**参数:**
A
asfasdff 已提交
348

349 350 351 352
| 参数名  | 参数类型 | 必填  | 说明        |
| -----  | ------  | ---- | ----------------------------- |
| appId  | string  | 是   | 所调用数据库方的包名。            |
| storeId | string | 是   | 要关闭的数据库唯一标识符,长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
G
ge-yafang 已提交
353
| kvStore | [KVStore](#kvstore)  | 是   | 要关闭的KVStore数据库。        |
A
asfasdff 已提交
354

G
ge-yafang 已提交
355
**返回值:**
A
asfasdff 已提交
356

357 358
| 类型          | 说明            |
| ------------- | -------------- |
G
ge-yafang 已提交
359
| Promise\<void> | 无返回结果的Promise对象。 |
A
asfasdff 已提交
360

G
ge-yafang 已提交
361
**示例:**
A
asfasdff 已提交
362

G
ge-yafang 已提交
363
```js
G
ge-yafang 已提交
364 365 366
let kvManager;
let kvStore;
const options = {
S
siyuan.liu 已提交
367 368 369 370 371 372 373
    createIfMissing: true,
    encrypt: false,
    backup: false,
    autoSync: true,
    kvStoreType: distributedData.KVStoreType.SINGLE_VERSION,
    schema: '',
    securityLevel: distributedData.SecurityLevel.S2,
G
ge-yafang 已提交
374
}
S
siyuan.liu 已提交
375
try {
G
ge-yafang 已提交
376
    kvManager.getKVStore('storeId', options).then(async (store) => {
S
siyuan.liu 已提交
377 378 379 380 381 382 383
        console.log('getKVStore success');
        kvStore = store;
        kvManager.closeKVStore('appId', 'storeId', kvStore).then(() => {
            console.log('closeKVStore success');
        }).catch((err) => {
            console.log('closeKVStore err ' + JSON.stringify(err));
        });
G
ge-yafang 已提交
384 385 386
    }).catch((err) => {
        console.log('CloseKVStore getKVStore err ' + JSON.stringify(err));
    });
S
siyuan.liu 已提交
387
} catch (e) {
G
ge-yafang 已提交
388
    console.log('closeKVStore e ' + e);
S
siyuan.liu 已提交
389
}
G
ge-yafang 已提交
390
```
A
asfasdff 已提交
391 392


393
### deleteKVStore<sup>8+</sup>
A
asfasdff 已提交
394

395
deleteKVStore(appId: string, storeId: string, callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
396

G
ge-yafang 已提交
397
通过storeId的值删除指定的KVStore数据库,使用callback异步回调。
A
asfasdff 已提交
398

G
ge-yafang 已提交
399
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
400

G
ge-yafang 已提交
401
**参数:**
A
asfasdff 已提交
402

403 404 405 406
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| appId  | string  | 是   | 所调用数据库方的包名。     |
| storeId | string | 是   | 要删除的数据库唯一标识符,长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
G
ge-yafang 已提交
407
| callback | AsyncCallback&lt;void&gt;  | 是   | 回调函数。 |
408

G
ge-yafang 已提交
409
**示例:**
A
asfasdff 已提交
410

G
ge-yafang 已提交
411
```js
G
ge-yafang 已提交
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
let kvManager;
let kvStore;
const options = {
    createIfMissing : true,
    encrypt : false,
    backup : false,
    autoSync : true,
    kvStoreType : distributedData.KVStoreType.SINGLE_VERSION,
    schema : '',
    securityLevel : distributedData.SecurityLevel.S2,
}
try {
    kvManager.getKVStore('store', options, async function (err, store) {
        console.log('getKVStore success');
        kvStore = store;
W
wangkai 已提交
427
        kvManager.deleteKVStore('appId', 'storeId', function (err, data) {
G
ge-yafang 已提交
428
            console.log('deleteKVStore success');
A
asfasdff 已提交
429
        });
G
ge-yafang 已提交
430 431 432 433 434
    });
} catch (e) {
    console.log('DeleteKVStore e ' + e);
}
```
A
asfasdff 已提交
435

436
### deleteKVStore<sup>8+</sup>
A
asfasdff 已提交
437

438
deleteKVStore(appId: string, storeId: string): Promise&lt;void&gt;
A
asfasdff 已提交
439

G
ge-yafang 已提交
440
通过storeId的值删除指定的KVStore数据库,使用Promise异步回调。
A
asfasdff 已提交
441

G
ge-yafang 已提交
442
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
443

G
ge-yafang 已提交
444
**参数:**
Z
zengyawen 已提交
445

446 447 448 449
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| appId  | string  | 是   | 所调用数据库方的包名。     |
| storeId | string | 是   | 要删除的数据库唯一标识符,长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
A
asfasdff 已提交
450 451


G
ge-yafang 已提交
452
**返回值:**
A
asfasdff 已提交
453

454 455
| 类型          | 说明            |
| ------------- | -------------- |
G
ge-yafang 已提交
456
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
A
asfasdff 已提交
457

G
ge-yafang 已提交
458
**示例:**
A
asfasdff 已提交
459

G
ge-yafang 已提交
460
```js
G
ge-yafang 已提交
461 462 463 464 465 466 467 468 469 470 471 472
let kvManager;
let kvStore;
const options = {
    createIfMissing : true,
    encrypt : false,
    backup : false,
    autoSync : true,
    kvStoreType : distributedData.KVStoreType.SINGLE_VERSION,
    schema : '',
    securityLevel : distributedData.SecurityLevel.S2,
}
try {
G
ge-yafang 已提交
473
    kvManager.getKVStore('storeId', options).then(async (store) => {
G
ge-yafang 已提交
474 475
        console.log('getKVStore success');
        kvStore = store;
W
wangkai 已提交
476
        kvManager.deleteKVStore('appId', 'storeId').then(() => {
G
ge-yafang 已提交
477
            console.log('deleteKVStore success');
A
asfasdff 已提交
478
        }).catch((err) => {
G
ge-yafang 已提交
479
            console.log('deleteKVStore err ' + JSON.stringify(err));
A
asfasdff 已提交
480
        });
G
ge-yafang 已提交
481 482 483 484 485 486 487
    }).catch((err) => {
        console.log('getKVStore err ' + JSON.stringify(err));
    });
} catch (e) {
    console.log('deleteKVStore e ' + e);
}
```
A
asfasdff 已提交
488 489


490
### getAllKVStoreId<sup>8+</sup>
A
asfasdff 已提交
491

492
getAllKVStoreId(appId: string, callback: AsyncCallback&lt;string[]&gt;): void
A
asfasdff 已提交
493

G
ge-yafang 已提交
494
获取所有通过[getKVStore](#getkvstore)方法创建的且没有调用[deleteKVStore](#deletekvstore8)方法删除的KVStore数据库的storeId,使用callback异步回调。
A
asfasdff 已提交
495

G
ge-yafang 已提交
496
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
497

G
ge-yafang 已提交
498
**参数:**
A
asfasdff 已提交
499

500 501 502
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| appId  | string  | 是    | 所调用数据库方的包名。     |
G
ge-yafang 已提交
503
| callback | AsyncCallback&lt;string[]&gt; | 是   |回调函数。返回所有创建的KvStore数据库的storeId。 |
A
asfasdff 已提交
504

G
ge-yafang 已提交
505
**示例:**
A
asfasdff 已提交
506

G
ge-yafang 已提交
507
```js
G
ge-yafang 已提交
508 509 510 511 512 513 514 515 516 517
let kvManager;
try {
    kvManager.getAllKVStoreId('appId', function (err, data) {
        console.log('GetAllKVStoreId success');
        console.log('GetAllKVStoreId size = ' + data.length);
    });
} catch (e) {
    console.log('GetAllKVStoreId e ' + e);
}
```
A
asfasdff 已提交
518 519


520
### getAllKVStoreId<sup>8+</sup>
A
asfasdff 已提交
521

522
getAllKVStoreId(appId: string): Promise&lt;string[]&gt;
A
asfasdff 已提交
523

G
ge-yafang 已提交
524
获取所有通过[getKVStore](#getkvstore)方法创建的且没有调用[deleteKVStore](#deletekvstore8)方法删除的KVStore数据库的storeId,使用Promise异步回调。
A
asfasdff 已提交
525

G
ge-yafang 已提交
526
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
527

G
ge-yafang 已提交
528
**参数:**
A
asfasdff 已提交
529

530 531 532
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| appId  | string  | 是    | 所调用数据库方的包名。     |
A
asfasdff 已提交
533 534


G
ge-yafang 已提交
535
**返回值:**
Z
zengyawen 已提交
536

537 538
| 类型          | 说明            |
| ------------- | -------------- |
G
ge-yafang 已提交
539
| Promise&lt;string[]&gt;| Promise对象。返回所有创建的KvStore数据库的storeId。 |
A
asfasdff 已提交
540

G
ge-yafang 已提交
541
**示例:**
A
asfasdff 已提交
542

G
ge-yafang 已提交
543
```js
G
ge-yafang 已提交
544 545 546
let kvManager;
try {
    console.log('GetAllKVStoreId');
547
    kvManager.getAllKVStoreId('appId').then((data) => {
G
ge-yafang 已提交
548 549 550 551 552 553 554 555 556
        console.log('getAllKVStoreId success');
        console.log('size = ' + data.length);
    }).catch((err) => {
        console.log('getAllKVStoreId err ' + JSON.stringify(err));
    });
} catch(e) {
    console.log('getAllKVStoreId e ' + e);
}
```
A
asfasdff 已提交
557 558


559
### on('distributedDataServiceDie')<sup>8+</sup>
A
asfasdff 已提交
560

561
on(event: 'distributedDataServiceDie', deathCallback: Callback&lt;void&gt;): void
A
asfasdff 已提交
562

563
订阅服务状态变更通知,此方法为同步方法。
A
asfasdff 已提交
564

G
ge-yafang 已提交
565
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。
566

G
ge-yafang 已提交
567
**参数:**
A
asfasdff 已提交
568

569 570
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
571
| event  | string | 是    | 订阅的事件名,固定为'distributedDataServiceDie',即服务状态变更事件。 |
G
ge-yafang 已提交
572
| deathCallback  | Callback&lt;void&gt;  | 是    | 回调函数。 |
573

G
ge-yafang 已提交
574
**示例:**
A
asfasdff 已提交
575

G
ge-yafang 已提交
576
```js
G
ge-yafang 已提交
577 578 579 580 581
let kvManager;
try {
    console.log('KVManagerOn');
    const deathCallback = function () {
        console.log('death callback call');
A
asfasdff 已提交
582
    }
G
ge-yafang 已提交
583 584 585 586 587
    kvManager.on('distributedDataServiceDie', deathCallback);
} catch (e) {
    console.log("An unexpected error occurred. Error:" + e);
}
```
A
asfasdff 已提交
588 589


590
### off('distributedDataServiceDie')<sup>8+</sup>
A
asfasdff 已提交
591

592
off(event: 'distributedDataServiceDie', deathCallback?: Callback&lt;void&gt;): void
A
asfasdff 已提交
593

594
取消订阅服务状态变更通知,此方法为同步方法。
A
asfasdff 已提交
595

G
ge-yafang 已提交
596
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。
597

G
ge-yafang 已提交
598
**参数:**
A
asfasdff 已提交
599

600 601
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
602
| event  | string | 是    | 取消订阅的事件名,固定为'distributedDataServiceDie',即服务状态变更事件。 |
G
ge-yafang 已提交
603
| deathCallback  | Callback&lt;void&gt;  | 否    | 回调函数。 |
Z
zengyawen 已提交
604

A
asfasdff 已提交
605

G
ge-yafang 已提交
606
**示例:**
A
asfasdff 已提交
607

G
ge-yafang 已提交
608
```js
G
ge-yafang 已提交
609 610 611 612 613
let kvManager;
try {
    console.log('KVManagerOff');
    const deathCallback = function () {
        console.log('death callback call');
A
asfasdff 已提交
614
    }
G
ge-yafang 已提交
615 616 617 618
    kvManager.off('distributedDataServiceDie', deathCallback);
} catch (e) {
    console.log("An unexpected error occurred. Error:" + e);
}
619
    
G
ge-yafang 已提交
620
```
A
asfasdff 已提交
621

622
## Options
Z
zengyawen 已提交
623 624 625

用于提供创建数据库的配置信息。

626

627 628
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
629 630 631 632 633 634 635
| createIfMissing  | boolean | 否 | 当数据库文件不存在时是否创建数据库,默认创建。 <br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core    |
| encrypt  | boolean | 否 |设置数据库文件是否加密,默认不加密。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core     |
| backup  | boolean | 否 |设置数据库文件是否备份,默认备份。 <br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core    |
| autoSync  | boolean | 否 |设置数据库文件是否自动同步,默认不自动同步。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core<br>**需要权限**: ohos.permission.DISTRIBUTED_DATASYNC     |
| kvStoreType | [KVStoreType](#kvstoretype) | 否 |设置要创建的数据库类型,默认为多设备协同数据库。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core |
| securityLevel | [SecurityLevel](#securitylevel) | 否 |设置数据库安全级别,默认不设置安全级别。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core  |
| schema<sup>8+</sup> | [Schema](#schema8) | 否 | 设置定义存储在数据库中的值。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
636 637 638


## KVStoreType
Z
zengyawen 已提交
639

G
ge-yafang 已提交
640
KVStore数据库类型枚举。
Z
zengyawen 已提交
641

642

G
ge-yafang 已提交
643
| 名称  | 值 | 说明                    |
644
| ---   | ----  | ----------------------- |
645 646 647
| DEVICE_COLLABORATION  | 0 | 表示多设备协同数据库。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore   |
| SINGLE_VERSION  | 1 | 表示单版本数据库。 <br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core |
| MULTI_VERSION   | 2 | 表示多版本数据库。此类型当前不允许使用。 <br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore |
648 649 650


## SecurityLevel
Z
zengyawen 已提交
651

G
ge-yafang 已提交
652
数据库的安全级别枚举。
Z
zengyawen 已提交
653

G
ge-yafang 已提交
654
| 名称  | 值 | 说明                    |
655
| ---   | ----  | ----------------------- |
S
siyuan.liu 已提交
656 657 658 659 660 661
| NO_LEVEL  | 0 | 表示数据库不设置安全级别。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore   |
| S0  | 1 | 表示数据库的安全级别为公共级别。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core    |
| S1  | 2 | 表示数据库的安全级别为低级别,当数据泄露时会产生较低影响。例如,包含壁纸等系统数据的数据库。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core    |
| S2  | 3 | 表示数据库的安全级别为中级别,当数据泄露时会产生较大影响。例如,包含录音、视频等用户生成数据或通话记录等信息的数据库。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core    |
| S3  | 5 | 表示数据库的安全级别为高级别,当数据泄露时会产生重大影响。例如,包含用户运动、健康、位置等信息的数据库。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core    |
| S4  | 6 | 表示数据库的安全级别为关键级别,当数据泄露时会产生严重影响。例如,包含认证凭据、财务数据等信息的数据库。<br>**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core    |
662 663 664


## Constants
Z
zengyawen 已提交
665 666 667

KVStore常量。

G
ge-yafang 已提交
668
**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core
669

G
ge-yafang 已提交
670
| 名称  | 值 | 说明                    |
671
| ---   | ----  | ----------------------- |
G
ge-yafang 已提交
672
| MAX_KEY_LENGTH  | 1024 | 数据库中Key允许的最大长度,单位字节。  |
673
| MAX_VALUE_LENGTH  | 4194303 | 数据库中Value允许的最大长度,单位字节。  |
G
ge-yafang 已提交
674
| MAX_KEY_LENGTH_DEVICE  | 896 | 最大设备密钥长度,单位字节。 |
675
| MAX_STORE_ID_LENGTH  | 128 | 数据库标识符允许的最大长度,单位字节。  |
G
ge-yafang 已提交
676 677
| MAX_QUERY_LENGTH  | 512000 | 最大查询长度,单位字节。 |
| MAX_BATCH_SIZE  | 128 | 最大批处理操作数量。 |
A
asfasdff 已提交
678

A
asfasdff 已提交
679
## Schema<sup>8+</sup> ##
A
asfasdff 已提交
680

G
ge-yafang 已提交
681
表示数据库模式,可以在创建或打开数据库时创建Schema对象并将它们放入[Options](#options)中。
A
asfasdff 已提交
682

G
ge-yafang 已提交
683
**系统能力:** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。
A
asfasdff 已提交
684

W
wufengshan 已提交
685
| 名称  | 类型 | 说明                    |
686
| ---   | ----  | ----------------------- |
G
ge-yafang 已提交
687
| root<sup>8+</sup>  | [FieldNode](#fieldnode8) | 表示json根对象。 |
G
ge-yafang 已提交
688
| indexes<sup>8+</sup>  | Array\<string> | 表示json类型的字符串数组。  |
W
wufengshan 已提交
689 690
| mode<sup>8+</sup>  | number | 表示Schema的模式。  |
| skip<sup>8+</sup>  | number |  Schema的跳跃大小。  |
691

692
### constructor<sup>8+</sup> 
693 694 695 696 697

constructor()

用于创建Schema实例的构造函数。

G
ge-yafang 已提交
698
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。
699

700
## FieldNode<sup>8+</sup> ##
A
asfasdff 已提交
701 702 703

表示 Schema 实例的节点,提供定义存储在数据库中的值的方法。

G
ge-yafang 已提交
704
**系统能力:** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。
705

W
wufengshan 已提交
706
| 名称  | 类型 | 说明                    |
707
| ---   | ----  | ----------------------- |
W
wufengshan 已提交
708
| nullable<sup>8+</sup>  | boolean | 表示数据库字段是否可以为空。   |
Z
zengyawen 已提交
709
| default<sup>8+</sup>  | string | 表示Fieldnode的默认值。 |
G
ge-yafang 已提交
710
| type<sup>8+</sup>  | number | 表示指定节点对应数据类型的值。 |
711

712
### constructor<sup>8+</sup>
713 714 715 716 717

constructor(name: string)

用于创建带有string字段FieldNode实例的构造函数。

G
ge-yafang 已提交
718
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。
719

G
ge-yafang 已提交
720
**参数:**
721

Z
zengyawen 已提交
722 723 724
| 参数名 | 参数类型 | 必填 | 说明            |
| ------ | -------- | ---- | --------------- |
| name   | string   | 是   | FieldNode的值。 |
725

726
### appendChild<sup>8+</sup>
A
asfasdff 已提交
727

728
appendChild(child: FieldNode): boolean
A
asfasdff 已提交
729

G
ge-yafang 已提交
730
在当前 FieldNode 中添加一个子节点。
A
asfasdff 已提交
731

G
ge-yafang 已提交
732
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。
733

G
ge-yafang 已提交
734
**参数:**
A
asfasdff 已提交
735

736 737
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
Z
zengyawen 已提交
738
| child  | [FieldNode](#fieldnode8) | 是    | 要附加的域节点。   |
Z
zengyawen 已提交
739

G
ge-yafang 已提交
740
**返回值:**
A
asfasdff 已提交
741

742 743
| 类型          | 说明            |
| ------------- | -------------- |
G
ge-yafang 已提交
744
| boolean |返回true表示子节点成功添加到FieldNode;返回false则表示操作失败。 |
A
asfasdff 已提交
745

G
ge-yafang 已提交
746
**示例:**
A
asfasdff 已提交
747

G
ge-yafang 已提交
748
```js
G
ge-yafang 已提交
749 750 751 752 753 754 755 756 757
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");
    let child3 = new ddm.FieldNode("child3");
    node.appendChild(child1);
    node.appendChild(child2);
    node.appendChild(child3);
W
wangkai 已提交
758
    console.log("appendNode " + JSON.stringify(node));
G
ge-yafang 已提交
759 760 761 762 763 764 765 766
    child1 = null;
    child2 = null;
    child3 = null;
    node = null;
} catch (e) {
    console.log("AppendChild " + e);
}
```
A
asfasdff 已提交
767 768


769
## KvStoreResultSet<sup>8+</sup> ##
A
asfasdff 已提交
770

G
ge-yafang 已提交
771 772 773
提供获取KVStore数据库结果集的相关方法,包括查询和移动数据读取位置等。

在调用KvStoreResultSet的方法前,需要先通过[getKVStore](#getkvstore)构建一个KVStore实例。
A
asfasdff 已提交
774

775

776
### getCount<sup>8+</sup>
A
asfasdff 已提交
777

778
getCount(): number
A
asfasdff 已提交
779

G
ge-yafang 已提交
780
获取结果集中的总行数。
A
asfasdff 已提交
781

G
ge-yafang 已提交
782
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
783

G
ge-yafang 已提交
784
**返回值:**
A
asfasdff 已提交
785

786 787
| 类型   | 说明               |
| ------ | --------------    |
G
ge-yafang 已提交
788
| number |返回数据的总行数。          |
A
asfasdff 已提交
789

G
ge-yafang 已提交
790
**示例:**
A
asfasdff 已提交
791

G
ge-yafang 已提交
792
```js
G
ge-yafang 已提交
793 794 795 796
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
797
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
798 799
        resultSet = result;
    }).catch((err) => {
800
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
801 802
    });
    const count = resultSet.getCount();
G
ge-yafang 已提交
803
    console.log("getCount succeed:" + count);
G
ge-yafang 已提交
804
} catch (e) {
G
ge-yafang 已提交
805
    console.log("getCount failed: " + e);
G
ge-yafang 已提交
806 807
}
```
A
asfasdff 已提交
808

809
### getPosition<sup>8+</sup>
A
asfasdff 已提交
810

811
getPosition(): number
A
asfasdff 已提交
812 813 814

获取结果集中当前的读取位置。

G
ge-yafang 已提交
815
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
816

G
ge-yafang 已提交
817
**返回值:**
A
asfasdff 已提交
818

819 820 821
| 类型   | 说明               |
| ------ | --------------    |
| number |返回当前读取位置。   |
A
asfasdff 已提交
822

G
ge-yafang 已提交
823
**示例:**
A
asfasdff 已提交
824

G
ge-yafang 已提交
825
```js
G
ge-yafang 已提交
826 827 828 829
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
830
        console.log('getResultSet succeeded.');
G
ge-yafang 已提交
831 832
        resultSet = result;
    }).catch((err) => {
833
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
834 835
    });
    const position = resultSet.getPosition();
G
ge-yafang 已提交
836
    console.log("getPosition succeed:" + position);
G
ge-yafang 已提交
837
} catch (e) {
G
ge-yafang 已提交
838
    console.log("getPosition failed: " + e);
G
ge-yafang 已提交
839 840
}
```
A
asfasdff 已提交
841 842


843
### moveToFirst<sup>8+</sup>
A
asfasdff 已提交
844

845
moveToFirst(): boolean
A
asfasdff 已提交
846

G
ge-yafang 已提交
847
将读取位置移动到第一行。如果结果集为空,则返回false。
A
asfasdff 已提交
848

G
ge-yafang 已提交
849
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
850

G
ge-yafang 已提交
851
**返回值:**
A
asfasdff 已提交
852

853 854
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
855
| boolean |返回true表示操作成功;返回false则表示操作失败。   |
A
asfasdff 已提交
856

G
ge-yafang 已提交
857
**示例:**
A
asfasdff 已提交
858

G
ge-yafang 已提交
859
```js
G
ge-yafang 已提交
860 861 862 863
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
864
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
865 866
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
867
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
868
    });
G
ge-yafang 已提交
869 870
    const moved1 = resultSet.moveToFirst();
    console.log("moveToFirst succeed: " + moved1);
G
ge-yafang 已提交
871
} catch (e) {
G
ge-yafang 已提交
872
    console.log("moveToFirst failed " + e);
G
ge-yafang 已提交
873 874
}
```
A
asfasdff 已提交
875 876


877
### moveToLast<sup>8+</sup>
A
asfasdff 已提交
878

879
moveToLast(): boolean
A
asfasdff 已提交
880

G
ge-yafang 已提交
881
将读取位置移动到最后一行。如果结果集为空,则返回false。
A
asfasdff 已提交
882

G
ge-yafang 已提交
883
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
884

G
ge-yafang 已提交
885
**返回值:**
A
asfasdff 已提交
886

887 888
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
889
| boolean |返回true表示操作成功;返回false则表示操作失败。   |
A
asfasdff 已提交
890

G
ge-yafang 已提交
891
**示例:**
A
asfasdff 已提交
892

G
ge-yafang 已提交
893
```js
G
ge-yafang 已提交
894 895 896 897
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
898
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
899 900
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
901
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
902
    });
G
ge-yafang 已提交
903 904
    const moved2 = resultSet.moveToLast();
    console.log("moveToLast succeed:" + moved2);
G
ge-yafang 已提交
905
} catch (e) {
G
ge-yafang 已提交
906
    console.log("moveToLast failed: " + e);
G
ge-yafang 已提交
907 908
}
```
A
asfasdff 已提交
909 910


911
### moveToNext<sup>8+</sup>
A
asfasdff 已提交
912

913
moveToNext(): boolean
A
asfasdff 已提交
914

G
ge-yafang 已提交
915
将读取位置移动到下一行。如果结果集为空,则返回false。
A
asfasdff 已提交
916

G
ge-yafang 已提交
917
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
918

G
ge-yafang 已提交
919
**返回值:**
A
asfasdff 已提交
920

921 922
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
923
| boolean |返回true表示操作成功;返回false则表示操作失败。   |
A
asfasdff 已提交
924

G
ge-yafang 已提交
925
**示例:**
A
asfasdff 已提交
926

G
ge-yafang 已提交
927
```js
G
ge-yafang 已提交
928 929 930 931
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
932
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
933 934
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
935
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
936
    });
G
ge-yafang 已提交
937 938
    const moved3 = resultSet.moveToNext();
    console.log("moveToNext succeed: " + moved3);
G
ge-yafang 已提交
939
} catch (e) {
G
ge-yafang 已提交
940
    console.log("moveToNext failed: " + e);
G
ge-yafang 已提交
941 942
}
```
A
asfasdff 已提交
943 944


945
### moveToPrevious<sup>8+</sup>
A
asfasdff 已提交
946

947
moveToPrevious(): boolean
A
asfasdff 已提交
948

G
ge-yafang 已提交
949
将读取位置移动到上一行。如果结果集为空,则返回false。
A
asfasdff 已提交
950

G
ge-yafang 已提交
951
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
952

G
ge-yafang 已提交
953
**返回值:**
A
asfasdff 已提交
954

955 956
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
957
| boolean |返回true表示操作成功;返回false则表示操作失败。   |
A
asfasdff 已提交
958

G
ge-yafang 已提交
959
**示例:**
A
asfasdff 已提交
960

G
ge-yafang 已提交
961
```js
G
ge-yafang 已提交
962 963 964 965
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
966
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
967 968
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
969
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
970
    });
G
ge-yafang 已提交
971 972
    const moved4 = resultSet.moveToPrevious();
    console.log("moveToPrevious succeed:" + moved4);
G
ge-yafang 已提交
973
} catch (e) {
G
ge-yafang 已提交
974
    console.log("moveToPrevious failed: " + e);
G
ge-yafang 已提交
975 976
}
```
A
asfasdff 已提交
977 978


979
### move<sup>8+</sup>
A
asfasdff 已提交
980

981
move(offset: number): boolean
A
asfasdff 已提交
982 983 984

将读取位置移动到当前位置的相对偏移量。

G
ge-yafang 已提交
985
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
986

G
ge-yafang 已提交
987
**参数:**
A
asfasdff 已提交
988

989 990 991
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| offset  | number  | 是    | 表示与当前位置的相对偏移量,负偏移表示向后移动,正偏移表示向前移动。   |
A
asfasdff 已提交
992

G
ge-yafang 已提交
993
**返回值:**
A
asfasdff 已提交
994

995 996
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
997
| boolean |返回true表示操作成功;返回false则表示操作失败。   |
A
asfasdff 已提交
998

G
ge-yafang 已提交
999
**示例:**
A
asfasdff 已提交
1000

G
ge-yafang 已提交
1001
```js
G
ge-yafang 已提交
1002 1003 1004 1005
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
1006
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
1007 1008
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
1009
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
1010
    });
G
ge-yafang 已提交
1011 1012
    const moved5 = resultSet.move();
    console.log("move succeed:" + moved5);
G
ge-yafang 已提交
1013
} catch (e) {
G
ge-yafang 已提交
1014
    console.log("move failed: " + e);
G
ge-yafang 已提交
1015 1016
}
```
A
asfasdff 已提交
1017 1018


1019
### moveToPosition<sup>8+</sup>
A
asfasdff 已提交
1020

1021
moveToPosition(position: number): boolean
A
asfasdff 已提交
1022 1023 1024

将读取位置从 0 移动到绝对位置。

G
ge-yafang 已提交
1025
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1026

G
ge-yafang 已提交
1027
**参数:**
A
asfasdff 已提交
1028

1029 1030 1031
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| position  | number  | 是    |表示绝对位置。          |
A
asfasdff 已提交
1032

G
ge-yafang 已提交
1033
**返回值:**
A
asfasdff 已提交
1034

1035 1036
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
1037
| boolean |返回true表示操作成功;返回false则表示操作失败。   |
A
asfasdff 已提交
1038

G
ge-yafang 已提交
1039
**示例:**
A
asfasdff 已提交
1040

G
ge-yafang 已提交
1041
```js
G
ge-yafang 已提交
1042 1043 1044 1045
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
1046
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
1047 1048
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
1049
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
1050
    });
G
ge-yafang 已提交
1051 1052
    const moved6 = resultSet.moveToPosition();
    console.log("moveToPosition succeed: " + moved6);
G
ge-yafang 已提交
1053
} catch (e) {
G
ge-yafang 已提交
1054
    console.log("moveToPosition failed: " + e);
G
ge-yafang 已提交
1055 1056
}
```
A
asfasdff 已提交
1057 1058


1059
### isFirst<sup>8+</sup>
A
asfasdff 已提交
1060

1061
isFirst(): boolean
A
asfasdff 已提交
1062 1063 1064

检查读取位置是否为第一行。

G
ge-yafang 已提交
1065
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1066

G
ge-yafang 已提交
1067
**返回值:**
A
asfasdff 已提交
1068

1069 1070
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
1071
| boolean |返回true表示读取位置为第一行;返回false表示读取位置不是第一行。   |
A
asfasdff 已提交
1072

G
ge-yafang 已提交
1073
**示例:**
A
asfasdff 已提交
1074

G
ge-yafang 已提交
1075
```js
G
ge-yafang 已提交
1076 1077 1078 1079
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
1080
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
1081 1082
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
1083
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
1084
    });
G
ge-yafang 已提交
1085 1086
    const isfirst = resultSet.isFirst();
    console.log("Check isFirst succeed:" + isfirst);
G
ge-yafang 已提交
1087
} catch (e) {
G
ge-yafang 已提交
1088
    console.log("Check isFirst failed: " + e);
G
ge-yafang 已提交
1089 1090
}
```
A
asfasdff 已提交
1091 1092


1093
### isLast<sup>8+</sup>
A
asfasdff 已提交
1094

1095
isLast(): boolean
A
asfasdff 已提交
1096 1097 1098

检查读取位置是否为最后一行。

G
ge-yafang 已提交
1099
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1100

G
ge-yafang 已提交
1101
**返回值:**
A
asfasdff 已提交
1102

1103 1104
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
1105
| boolean |返回true表示读取位置为最后一行;返回false表示读取位置不是最后一行。   |
A
asfasdff 已提交
1106

G
ge-yafang 已提交
1107
**示例:**
A
asfasdff 已提交
1108

G
ge-yafang 已提交
1109
```js
G
ge-yafang 已提交
1110 1111 1112 1113
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
1114
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
1115 1116
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
1117
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
1118
    });
G
ge-yafang 已提交
1119 1120
    const islast = resultSet.isLast();
    console.log("Check isLast succeed: " + islast);
G
ge-yafang 已提交
1121
} catch (e) {
G
ge-yafang 已提交
1122
    console.log("Check isLast failed: " + e);
G
ge-yafang 已提交
1123 1124
}
```
A
asfasdff 已提交
1125

1126
### isBeforeFirst<sup>8+</sup>
A
asfasdff 已提交
1127

1128
isBeforeFirst(): boolean
A
asfasdff 已提交
1129 1130 1131

检查读取位置是否在第一行之前。

G
ge-yafang 已提交
1132
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1133

G
ge-yafang 已提交
1134
**返回值:**
A
asfasdff 已提交
1135

1136 1137
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
1138
| boolean |返回true表示读取位置在第一行之前;返回false表示读取位置不在第一行之前。  |
A
asfasdff 已提交
1139

G
ge-yafang 已提交
1140
**示例:**
A
asfasdff 已提交
1141

G
ge-yafang 已提交
1142
```js
G
ge-yafang 已提交
1143 1144 1145 1146
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
1147
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
1148 1149
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
1150
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
1151
    });
G
ge-yafang 已提交
1152 1153
    const isbeforefirst = resultSet.isBeforeFirst();
    console.log("Check isBeforeFirst succeed: " + isbeforefirst);
G
ge-yafang 已提交
1154
} catch (e) {
G
ge-yafang 已提交
1155
    console.log("Check isBeforeFirst failed: " + e);
G
ge-yafang 已提交
1156 1157
}
```
A
asfasdff 已提交
1158 1159


1160
### isAfterLast<sup>8+</sup>
A
asfasdff 已提交
1161

1162
isAfterLast(): boolean
A
asfasdff 已提交
1163 1164 1165

检查读取位置是否在最后一行之后。

G
ge-yafang 已提交
1166
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1167

G
ge-yafang 已提交
1168
**返回值:**
A
asfasdff 已提交
1169

1170 1171
| 类型    | 说明               |
| ------  | --------------    |
G
ge-yafang 已提交
1172
| boolean |返回true表示读取位置在最后一行之后;返回false表示读取位置不在最后一行之后。  |
A
asfasdff 已提交
1173

G
ge-yafang 已提交
1174
**示例:**
A
asfasdff 已提交
1175

G
ge-yafang 已提交
1176
```js
G
ge-yafang 已提交
1177 1178 1179 1180
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
1181
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
1182 1183
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
1184
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
1185
    });
G
ge-yafang 已提交
1186 1187
    const isafterlast = resultSet.isAfterLast();
    console.log("Check isAfterLast succeed:" + isafterlast);
G
ge-yafang 已提交
1188
} catch (e) {
G
ge-yafang 已提交
1189
    console.log("Check isAfterLast failed: " + e);
G
ge-yafang 已提交
1190 1191
}
```
A
asfasdff 已提交
1192 1193


1194
### getEntry<sup>8+</sup>
A
asfasdff 已提交
1195

1196
getEntry(): Entry
A
asfasdff 已提交
1197

G
ge-yafang 已提交
1198
从当前位置获取对应的键值对。
A
asfasdff 已提交
1199

G
ge-yafang 已提交
1200
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1201

G
ge-yafang 已提交
1202
**返回值:**
A
asfasdff 已提交
1203

1204 1205
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1206
| [Entry](#entry) |返回键值对。|
A
asfasdff 已提交
1207

G
ge-yafang 已提交
1208
**示例:**
A
asfasdff 已提交
1209

G
ge-yafang 已提交
1210
```js
G
ge-yafang 已提交
1211 1212 1213 1214
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
1215
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
1216 1217
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
1218
        console.log('getResultSet failed: ' + err);
G
ge-yafang 已提交
1219 1220
    });
    const entry  = resultSet.getEntry();
G
ge-yafang 已提交
1221
    console.log("getEntry succeed:" + JSON.stringify(entry));
G
ge-yafang 已提交
1222
} catch (e) {
G
ge-yafang 已提交
1223
    console.log("getEntry failed: " + e);
G
ge-yafang 已提交
1224 1225
}
```
A
asfasdff 已提交
1226 1227


1228
## Query<sup>8+</sup> ##
A
asfasdff 已提交
1229 1230 1231

使用谓词表示数据库查询,提供创建Query实例、查询数据库中的数据和添加谓词的方法。

G
ge-yafang 已提交
1232
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1233

1234
### constructor<sup>8+</sup>
1235 1236 1237

constructor() 

G
ge-yafang 已提交
1238
用于创建Schema实例的构造函数。
1239

G
ge-yafang 已提交
1240
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1241

1242

1243
### reset<sup>8+</sup>
A
asfasdff 已提交
1244

1245
reset(): Query
A
asfasdff 已提交
1246

G
ge-yafang 已提交
1247
重置Query对象。
A
asfasdff 已提交
1248

G
ge-yafang 已提交
1249
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1250 1251


G
ge-yafang 已提交
1252
**返回值:**
A
asfasdff 已提交
1253

1254 1255
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1256
| [Query](#query8) |返回重置的Query对象。|
A
asfasdff 已提交
1257

G
ge-yafang 已提交
1258
**示例:**
A
asfasdff 已提交
1259

G
ge-yafang 已提交
1260
```js
G
ge-yafang 已提交
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
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) {
    console.log("simply calls should be ok :" + e);
}
```
A
asfasdff 已提交
1272 1273


1274
### equalTo<sup>8+</sup>
A
asfasdff 已提交
1275

G
ge-yafang 已提交
1276
equalTo(field: string, value: number|string|boolean): Query
A
asfasdff 已提交
1277 1278 1279

构造一个Query对象来查询具有指定字段的条目,其值等于指定的值。

G
ge-yafang 已提交
1280
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1281

G
ge-yafang 已提交
1282
**参数:**
A
asfasdff 已提交
1283

G
ge-yafang 已提交
1284
| 参数名  | 参数类型 | 必填  | 说明                    |
1285
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1286
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
G
ge-yafang 已提交
1287
| value  | number\|string\|boolean  | 是    | 表示指定的值。|
A
asfasdff 已提交
1288

G
ge-yafang 已提交
1289
**返回值:**
A
asfasdff 已提交
1290

1291 1292
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1293
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1294

G
ge-yafang 已提交
1295
**示例:**
A
asfasdff 已提交
1296

G
ge-yafang 已提交
1297
```js
G
ge-yafang 已提交
1298 1299 1300 1301 1302 1303
try {
    let query = new distributedData.Query();
    query.equalTo("field", "value");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1304
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1305 1306
}
```
A
asfasdff 已提交
1307 1308


1309
### notEqualTo<sup>8+</sup>
A
asfasdff 已提交
1310

1311
notEqualTo(field: string, value: number|string|boolean): Query
A
asfasdff 已提交
1312 1313 1314

构造一个Query对象以查询具有指定字段且值不等于指定值的条目。

G
ge-yafang 已提交
1315
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1316

G
ge-yafang 已提交
1317
**参数:**
A
asfasdff 已提交
1318

1319 1320
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1321
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
G
ge-yafang 已提交
1322
| value  | number\|string\|boolean  | 是    | 表示指定的值。|
A
asfasdff 已提交
1323

G
ge-yafang 已提交
1324
**返回值:**
A
asfasdff 已提交
1325

1326 1327
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1328
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1329

G
ge-yafang 已提交
1330
**示例:**
A
asfasdff 已提交
1331

G
ge-yafang 已提交
1332
```js
G
ge-yafang 已提交
1333 1334 1335 1336 1337 1338
try {
    let query = new distributedData.Query();
    query.notEqualTo("field", "value");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1339
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1340 1341
}
```
A
asfasdff 已提交
1342 1343


1344
### greaterThan<sup>8+</sup>
A
asfasdff 已提交
1345

1346
greaterThan(field: string, value: number|string|boolean): Query
A
asfasdff 已提交
1347 1348 1349

构造一个Query对象以查询具有大于指定值的指定字段的条目。

G
ge-yafang 已提交
1350
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1351

G
ge-yafang 已提交
1352
**参数:**
A
asfasdff 已提交
1353

1354 1355
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1356
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
G
ge-yafang 已提交
1357
| value  | number\|string\|boolean  | 是    | 表示指定的值。|
A
asfasdff 已提交
1358

G
ge-yafang 已提交
1359
**返回值:**
A
asfasdff 已提交
1360

1361 1362
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1363
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1364

G
ge-yafang 已提交
1365
**示例:**
A
asfasdff 已提交
1366

G
ge-yafang 已提交
1367
```js
G
ge-yafang 已提交
1368 1369 1370 1371 1372 1373
try {
    let query = new distributedData.Query();
    query.greaterThan("field", "value");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1374
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1375 1376
}
```
A
asfasdff 已提交
1377 1378


1379
### lessThan<sup>8+</sup>
A
asfasdff 已提交
1380

1381
lessThan(field: string, value: number|string): Query
A
asfasdff 已提交
1382 1383 1384

构造一个Query对象以查询具有小于指定值的指定字段的条目。

G
ge-yafang 已提交
1385
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1386

G
ge-yafang 已提交
1387
**参数:**
A
asfasdff 已提交
1388

1389 1390
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1391
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
G
ge-yafang 已提交
1392
| value  | number\|string\|boolean  | 是    | 表示指定的值。|
A
asfasdff 已提交
1393

G
ge-yafang 已提交
1394
**返回值:**
A
asfasdff 已提交
1395

1396 1397
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1398
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1399

G
ge-yafang 已提交
1400
**示例:**
A
asfasdff 已提交
1401

G
ge-yafang 已提交
1402
```js
G
ge-yafang 已提交
1403 1404 1405 1406 1407 1408
try {
    let query = new distributedData.Query();
    query.lessThan("field", "value");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1409
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1410 1411
}
```
A
asfasdff 已提交
1412 1413


1414
### greaterThanOrEqualTo<sup>8+</sup>
A
asfasdff 已提交
1415

1416
greaterThanOrEqualTo(field: string, value: number|string): Query
A
asfasdff 已提交
1417 1418 1419

构造一个Query对象以查询具有指定字段且值大于或等于指定值的条目。

G
ge-yafang 已提交
1420
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1421

G
ge-yafang 已提交
1422
**参数:**
A
asfasdff 已提交
1423

1424 1425
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1426
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
G
ge-yafang 已提交
1427
| value  | number\|string\|boolean  | 是    | 表示指定的值。|
A
asfasdff 已提交
1428

G
ge-yafang 已提交
1429
**返回值:**
A
asfasdff 已提交
1430

1431 1432
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1433
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1434

G
ge-yafang 已提交
1435
**示例:**
A
asfasdff 已提交
1436

G
ge-yafang 已提交
1437
```js
G
ge-yafang 已提交
1438 1439 1440 1441 1442 1443
try {
    let query = new distributedData.Query();
    query.greaterThanOrEqualTo("field", "value");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1444
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1445 1446
}
```
A
asfasdff 已提交
1447 1448


1449
### lessThanOrEqualTo<sup>8+</sup>
A
asfasdff 已提交
1450

1451
lessThanOrEqualTo(field: string, value: number|string): Query
A
asfasdff 已提交
1452 1453 1454

构造一个Query对象以查询具有指定字段且值小于或等于指定值的条目。

G
ge-yafang 已提交
1455
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1456

G
ge-yafang 已提交
1457
**参数:**
A
asfasdff 已提交
1458

1459 1460
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1461
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
G
ge-yafang 已提交
1462
| value  | number\|string\|boolean  | 是    | 表示指定的值。|
A
asfasdff 已提交
1463

G
ge-yafang 已提交
1464
**返回值:**
A
asfasdff 已提交
1465

1466 1467
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1468
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1469

G
ge-yafang 已提交
1470
**示例:**
A
asfasdff 已提交
1471

G
ge-yafang 已提交
1472
```js
G
ge-yafang 已提交
1473 1474 1475 1476 1477 1478
try {
    let query = new distributedData.Query();
    query.lessThanOrEqualTo("field", "value");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1479
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1480 1481
}
```
A
asfasdff 已提交
1482 1483


1484
### isNull<sup>8+</sup>
A
asfasdff 已提交
1485

1486
isNull(field: string): Query
A
asfasdff 已提交
1487 1488 1489

构造一个Query对象以查询具有值为null的指定字段的条目。

G
ge-yafang 已提交
1490
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1491

G
ge-yafang 已提交
1492
**参数:**
A
asfasdff 已提交
1493

1494 1495
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1496
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
A
asfasdff 已提交
1497

G
ge-yafang 已提交
1498
**返回值:**
A
asfasdff 已提交
1499

1500 1501
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1502
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1503

G
ge-yafang 已提交
1504
**示例:**
A
asfasdff 已提交
1505

G
ge-yafang 已提交
1506
```js
G
ge-yafang 已提交
1507 1508 1509 1510 1511 1512
try {
    let query = new distributedData.Query();
    query.isNull("field");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1513
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1514 1515
}
```
A
asfasdff 已提交
1516 1517


1518
### inNumber<sup>8+</sup>
A
asfasdff 已提交
1519

1520
inNumber(field: string, valueList: number[]): Query
A
asfasdff 已提交
1521 1522 1523

构造一个Query对象以查询具有指定字段的条目,其值在指定的值列表中。

1524

G
ge-yafang 已提交
1525
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1526

G
ge-yafang 已提交
1527
**参数:**
A
asfasdff 已提交
1528

1529 1530
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1531
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
1532
| valueList  | number[]  | 是    | 表示指定的值列表。|
A
asfasdff 已提交
1533

G
ge-yafang 已提交
1534
**返回值:**
A
asfasdff 已提交
1535

1536 1537
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1538
| [Query](#query8) |返回Query对象。|
1539

G
ge-yafang 已提交
1540
**示例:**
A
asfasdff 已提交
1541

G
ge-yafang 已提交
1542
```js
G
ge-yafang 已提交
1543 1544 1545 1546 1547 1548
try {
    let query = new distributedData.Query();
    query.inNumber("field", [0, 1]);
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1549
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1550 1551
}
```
A
asfasdff 已提交
1552 1553


1554
### inString<sup>8+</sup>
A
asfasdff 已提交
1555

1556
inString(field: string, valueList: string[]): Query
A
asfasdff 已提交
1557 1558 1559

构造一个Query对象以查询具有指定字段的条目,其值在指定的字符串值列表中。

G
ge-yafang 已提交
1560
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1561

G
ge-yafang 已提交
1562
**参数:**
A
asfasdff 已提交
1563

1564 1565
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1566
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
1567
| valueList  | string[]  | 是    | 表示指定的字符串值列表。|
A
asfasdff 已提交
1568

G
ge-yafang 已提交
1569
**返回值:**
A
asfasdff 已提交
1570

1571 1572
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1573
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1574

G
ge-yafang 已提交
1575
**示例:**
A
asfasdff 已提交
1576

G
ge-yafang 已提交
1577
```js
G
ge-yafang 已提交
1578 1579 1580 1581 1582 1583
try {
    let query = new distributedData.Query();
    query.inString("field", ['test1', 'test2']);
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1584
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1585 1586
}
```
A
asfasdff 已提交
1587 1588


1589
### notInNumber<sup>8+</sup>
A
asfasdff 已提交
1590

1591
notInNumber(field: string, valueList: number[]): Query
A
asfasdff 已提交
1592 1593 1594

构造一个Query对象以查询具有指定字段的条目,该字段的值不在指定的值列表中。

G
ge-yafang 已提交
1595
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1596

G
ge-yafang 已提交
1597
**参数:**
A
asfasdff 已提交
1598

1599 1600
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1601
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
1602
| valueList  | number[]  | 是    | 表示指定的值列表。|
A
asfasdff 已提交
1603

G
ge-yafang 已提交
1604
**返回值:**
A
asfasdff 已提交
1605

1606 1607
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1608
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1609

G
ge-yafang 已提交
1610
**示例:**
A
asfasdff 已提交
1611

G
ge-yafang 已提交
1612
```js
G
ge-yafang 已提交
1613 1614 1615 1616 1617 1618
try {
    let query = new distributedData.Query();
    query.notInNumber("field", [0, 1]);
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1619
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1620 1621
}
```
A
asfasdff 已提交
1622 1623


1624
### notInString<sup>8+</sup>
A
asfasdff 已提交
1625

1626
notInString(field: string, valueList: string[]): Query
A
asfasdff 已提交
1627 1628 1629

构造一个Query对象以查询具有指定字段且值不在指定字符串值列表中的条目。

G
ge-yafang 已提交
1630
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1631

G
ge-yafang 已提交
1632
**参数:**
A
asfasdff 已提交
1633

1634 1635
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1636
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
1637
| valueList  | string[]  | 是    | 表示指定的字符串值列表。|
A
asfasdff 已提交
1638

G
ge-yafang 已提交
1639
**返回值:**
A
asfasdff 已提交
1640

1641 1642
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1643
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1644

G
ge-yafang 已提交
1645
**示例:**
A
asfasdff 已提交
1646

G
ge-yafang 已提交
1647
```js
G
ge-yafang 已提交
1648 1649 1650 1651 1652 1653
try {
    let query = new distributedData.Query();
    query.notInString("field", ['test1', 'test2']);
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1654
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1655 1656
}
```
A
asfasdff 已提交
1657 1658


1659
### like<sup>8+</sup>
A
asfasdff 已提交
1660

1661
like(field: string, value: string): Query
A
asfasdff 已提交
1662 1663 1664

构造一个Query对象以查询具有与指定字符串值相似的指定字段的条目。

G
ge-yafang 已提交
1665
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1666

G
ge-yafang 已提交
1667
**参数:**
A
asfasdff 已提交
1668

1669 1670
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1671
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
G
ge-yafang 已提交
1672
| value  | string  | 是    | 表示指定的字符串值。|
A
asfasdff 已提交
1673

G
ge-yafang 已提交
1674
**返回值:**
A
asfasdff 已提交
1675

1676 1677
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1678
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1679

G
ge-yafang 已提交
1680
**示例:**
A
asfasdff 已提交
1681

G
ge-yafang 已提交
1682
```js
G
ge-yafang 已提交
1683 1684 1685 1686 1687 1688
try {
    let query = new distributedData.Query();
    query.like("field", "value");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1689
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1690 1691
}
```
A
asfasdff 已提交
1692 1693


1694
### unlike<sup>8+</sup>
A
asfasdff 已提交
1695

1696
unlike(field: string, value: string): Query
A
asfasdff 已提交
1697 1698 1699

构造一个Query对象以查询具有与指定字符串值不相似的指定字段的条目。

G
ge-yafang 已提交
1700
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1701

G
ge-yafang 已提交
1702
**参数:**
A
asfasdff 已提交
1703

1704 1705
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1706
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
G
ge-yafang 已提交
1707
| value  | string  | 是    | 表示指定的字符串值。|
A
asfasdff 已提交
1708

G
ge-yafang 已提交
1709
**返回值:**
A
asfasdff 已提交
1710

1711 1712
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1713
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1714

G
ge-yafang 已提交
1715
**示例:**
A
asfasdff 已提交
1716

G
ge-yafang 已提交
1717
```js
G
ge-yafang 已提交
1718 1719 1720 1721 1722 1723
try {
    let query = new distributedData.Query();
    query.unlike("field", "value");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1724
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1725 1726
}
```
A
asfasdff 已提交
1727 1728


1729
### and<sup>8+</sup>
A
asfasdff 已提交
1730

1731
and(): Query
A
asfasdff 已提交
1732 1733 1734

构造一个带有与条件的查询对象。

G
ge-yafang 已提交
1735
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1736

G
ge-yafang 已提交
1737
**返回值:**
A
asfasdff 已提交
1738

1739 1740
| 类型    | 说明       |
| ------  | -------   |
Z
zengyawen 已提交
1741
| [Query](#query8) |返回查询对象。|
A
asfasdff 已提交
1742

G
ge-yafang 已提交
1743
**示例:**
A
asfasdff 已提交
1744

G
ge-yafang 已提交
1745
```js
G
ge-yafang 已提交
1746 1747 1748 1749 1750 1751 1752 1753
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) {
W
wangkai 已提交
1754
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1755 1756
}
```
A
asfasdff 已提交
1757 1758


1759
### or<sup>8+</sup>
A
asfasdff 已提交
1760

1761
or(): Query
A
asfasdff 已提交
1762 1763 1764

构造一个带有或条件的Query对象。

G
ge-yafang 已提交
1765
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1766

G
ge-yafang 已提交
1767
**返回值:**
A
asfasdff 已提交
1768

1769 1770
| 类型    | 说明       |
| ------  | -------   |
Z
zengyawen 已提交
1771
| [Query](#query8) |返回查询对象。|
A
asfasdff 已提交
1772

G
ge-yafang 已提交
1773
**示例:**
A
asfasdff 已提交
1774

G
ge-yafang 已提交
1775
```js
G
ge-yafang 已提交
1776 1777 1778 1779 1780 1781 1782 1783
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) {
W
wangkai 已提交
1784
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1785 1786
}
```
A
asfasdff 已提交
1787 1788


1789
### orderByAsc<sup>8+</sup>
A
asfasdff 已提交
1790

1791
orderByAsc(field: string): Query
A
asfasdff 已提交
1792 1793 1794

构造一个Query对象,将查询结果按升序排序。

G
ge-yafang 已提交
1795
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1796

G
ge-yafang 已提交
1797
**参数:**
A
asfasdff 已提交
1798

1799 1800
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1801
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
A
asfasdff 已提交
1802

G
ge-yafang 已提交
1803
**返回值:**
A
asfasdff 已提交
1804

1805 1806
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1807
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1808

G
ge-yafang 已提交
1809
**示例:**
A
asfasdff 已提交
1810

G
ge-yafang 已提交
1811
```js
G
ge-yafang 已提交
1812 1813 1814 1815 1816 1817 1818
try {
    let query = new distributedData.Query();
    query.notEqualTo("field", "value");
    query.orderByAsc("field");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1819
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1820 1821
}
```
A
asfasdff 已提交
1822 1823


1824
### orderByDesc<sup>8+</sup>
A
asfasdff 已提交
1825

1826
orderByDesc(field: string): Query
A
asfasdff 已提交
1827 1828 1829

构造一个Query对象,将查询结果按降序排序。

G
ge-yafang 已提交
1830
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1831

G
ge-yafang 已提交
1832
**参数:**
A
asfasdff 已提交
1833

1834 1835
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1836
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。  |
A
asfasdff 已提交
1837

G
ge-yafang 已提交
1838
**返回值:**
A
asfasdff 已提交
1839

1840 1841
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1842
| [Query](#query8) |返回Query对象。|
1843

G
ge-yafang 已提交
1844
**示例:**
A
asfasdff 已提交
1845

G
ge-yafang 已提交
1846
```js
G
ge-yafang 已提交
1847 1848 1849 1850 1851 1852 1853
try {
    let query = new distributedData.Query();
    query.notEqualTo("field", "value");
    query.orderByDesc("field");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1854
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1855 1856
}
```
A
asfasdff 已提交
1857 1858


1859
### limit<sup>8+</sup>
A
asfasdff 已提交
1860

1861
limit(total: number, offset: number): Query
A
asfasdff 已提交
1862 1863 1864

构造一个Query对象来指定结果的数量和开始位置。

G
ge-yafang 已提交
1865
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1866

G
ge-yafang 已提交
1867
**参数:**
A
asfasdff 已提交
1868

1869 1870 1871 1872
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| total  | number  | 是    |表示指定的结果数。  |
| offset | number  | 是    |表示起始位置。  |
A
asfasdff 已提交
1873

G
ge-yafang 已提交
1874
**返回值:**
A
asfasdff 已提交
1875

1876 1877
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1878
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1879

G
ge-yafang 已提交
1880
**示例:**
A
asfasdff 已提交
1881

G
ge-yafang 已提交
1882
```js
G
ge-yafang 已提交
1883 1884
let total = 10;
let offset = 1;
G
ge-yafang 已提交
1885 1886 1887
try {
    let query = new distributedData.Query();
    query.notEqualTo("field", "value");
G
ge-yafang 已提交
1888
    query.limit(total, offset);
G
ge-yafang 已提交
1889 1890 1891
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1892
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1893 1894
}
```
A
asfasdff 已提交
1895 1896


1897
### isNotNull<sup>8+</sup>
A
asfasdff 已提交
1898

1899
isNotNull(field: string): Query
A
asfasdff 已提交
1900

G
ge-yafang 已提交
1901
构造一个Query对象以查询具有值不为null的指定字段的条目。
A
asfasdff 已提交
1902

G
ge-yafang 已提交
1903
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1904

G
ge-yafang 已提交
1905
**参数:**
A
asfasdff 已提交
1906

1907 1908
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
1909
| fieId  | string  | 是    |表示指定字段,不能包含' ^ '。      |
A
asfasdff 已提交
1910

G
ge-yafang 已提交
1911
**返回值:**
A
asfasdff 已提交
1912

1913 1914
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1915
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1916

G
ge-yafang 已提交
1917
**示例:**
A
asfasdff 已提交
1918

G
ge-yafang 已提交
1919
```js
G
ge-yafang 已提交
1920 1921 1922 1923 1924 1925
try {
    let query = new distributedData.Query();
    query.isNotNull("field");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1926
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1927 1928
}
```
A
asfasdff 已提交
1929 1930


1931
### beginGroup<sup>8+</sup>
A
asfasdff 已提交
1932

1933
beginGroup(): Query
A
asfasdff 已提交
1934 1935 1936

创建一个带有左括号的查询条件组。

G
ge-yafang 已提交
1937
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1938

G
ge-yafang 已提交
1939
**返回值:**
A
asfasdff 已提交
1940

1941 1942
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1943
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1944

G
ge-yafang 已提交
1945
**示例:**
A
asfasdff 已提交
1946

G
ge-yafang 已提交
1947
```js
G
ge-yafang 已提交
1948 1949 1950 1951 1952 1953 1954 1955
try {
    let query = new distributedData.Query();
    query.beginGroup();
    query.isNotNull("field");
    query.endGroup();
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1956
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1957 1958
}
```
A
asfasdff 已提交
1959 1960


1961
### endGroup<sup>8+</sup>
A
asfasdff 已提交
1962

1963
endGroup(): Query
A
asfasdff 已提交
1964 1965 1966

创建一个带有右括号的查询条件组。

G
ge-yafang 已提交
1967
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1968

G
ge-yafang 已提交
1969
**返回值:**
A
asfasdff 已提交
1970

1971 1972
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
1973
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
1974

G
ge-yafang 已提交
1975
**示例:**
A
asfasdff 已提交
1976

G
ge-yafang 已提交
1977
```js
G
ge-yafang 已提交
1978 1979 1980 1981 1982 1983 1984 1985
try {
    let query = new distributedData.Query();
    query.beginGroup();
    query.isNotNull("field");
    query.endGroup();
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
1986
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
1987 1988
}
```
A
asfasdff 已提交
1989 1990


1991
### prefixKey<sup>8+</sup>
A
asfasdff 已提交
1992

1993
prefixKey(prefix: string): Query
A
asfasdff 已提交
1994 1995 1996

创建具有指定键前缀的查询条件。

G
ge-yafang 已提交
1997
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
1998

G
ge-yafang 已提交
1999
**参数:**
A
asfasdff 已提交
2000

2001 2002 2003
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| prefix | string  | 是    |表示指定的键前缀。     |
A
asfasdff 已提交
2004

G
ge-yafang 已提交
2005
**返回值:**
A
asfasdff 已提交
2006

2007 2008
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
2009
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
2010

G
ge-yafang 已提交
2011
**示例:**
A
asfasdff 已提交
2012

G
ge-yafang 已提交
2013
```js
G
ge-yafang 已提交
2014 2015 2016 2017 2018 2019 2020
try {
    let query = new distributedData.Query();
    query.prefixKey("$.name");
    query.prefixKey("0");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
2021
    console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
2022 2023
}
```
A
asfasdff 已提交
2024 2025


2026
### setSuggestIndex<sup>8+</sup>
A
asfasdff 已提交
2027

2028
setSuggestIndex(index: string): Query
A
asfasdff 已提交
2029 2030 2031

设置一个指定的索引,将优先用于查询。

G
ge-yafang 已提交
2032
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2033

G
ge-yafang 已提交
2034
**参数:**
A
asfasdff 已提交
2035

2036 2037 2038
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| index  | string  | 是    |指示要设置的索引。   |
A
asfasdff 已提交
2039

G
ge-yafang 已提交
2040
**返回值:**
A
asfasdff 已提交
2041

2042 2043
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
2044
| [Query](#query8) |返回Query对象。|
A
asfasdff 已提交
2045

G
ge-yafang 已提交
2046
**示例:**
A
asfasdff 已提交
2047

G
ge-yafang 已提交
2048
```js
G
ge-yafang 已提交
2049 2050 2051 2052 2053 2054 2055
try {
    let query = new distributedData.Query();
    query.setSuggestIndex("$.name");
    query.setSuggestIndex("0");
    console.log("query is " + query.getSqlLike());
    query = null;
} catch (e) {
W
wangkai 已提交
2056
   console.log("duplicated calls should be ok :" + e);
G
ge-yafang 已提交
2057 2058
}
```
A
asfasdff 已提交
2059 2060


2061
### deviceId<sup>8+</sup>
A
fix up  
asfasdff 已提交
2062

2063
deviceId(deviceId:string):Query
A
fix up  
asfasdff 已提交
2064 2065 2066

添加设备ID作为key的前缀。

G
ge-yafang 已提交
2067
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2068

G
ge-yafang 已提交
2069
**参数:**
A
fix up  
asfasdff 已提交
2070

2071 2072
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
2073
| deviceId | string  | 是    |指示查询的设备ID。   |
2074

A
fix up  
asfasdff 已提交
2075

G
ge-yafang 已提交
2076
**返回值:**
A
fix up  
asfasdff 已提交
2077

2078 2079
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
2080
| [Query](#query8) |返回Query对象。|
A
fix up  
asfasdff 已提交
2081

G
ge-yafang 已提交
2082
**示例:**
A
fix up  
asfasdff 已提交
2083

G
ge-yafang 已提交
2084
```js
G
ge-yafang 已提交
2085 2086 2087 2088 2089 2090 2091 2092
try {
    let query = new distributedData.Query();
    query.deviceId("deviceId");
    console.log("query is " + query.getSqlLike());
} catch (e) {
    console.log("should be ok on Method Chaining : " + e);
}
```
A
fix up  
asfasdff 已提交
2093 2094


2095
### getSqlLike<sup>8+</sup>
A
fix up  
asfasdff 已提交
2096

2097
getSqlLike():string
A
fix up  
asfasdff 已提交
2098

G
ge-yafang 已提交
2099
获取Query对象的查询语句。
A
fix up  
asfasdff 已提交
2100

G
ge-yafang 已提交
2101
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2102

G
ge-yafang 已提交
2103
**返回值:**
A
fix up  
asfasdff 已提交
2104

2105 2106
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
2107
| string |返回一个字段列中包含对应子串的结果。|
A
fix up  
asfasdff 已提交
2108

G
ge-yafang 已提交
2109
**示例:**
A
fix up  
asfasdff 已提交
2110

G
ge-yafang 已提交
2111
```js
G
ge-yafang 已提交
2112 2113 2114 2115 2116
try {
    let query = new distributedData.Query();
    let sql1 = query.getSqlLike();
    console.log("GetSqlLike sql=" + sql1);
} catch (e) {
W
wangkai 已提交
2117
    console.log("duplicated calls should be ok : " + e);
G
ge-yafang 已提交
2118 2119
}
```
A
fix up  
asfasdff 已提交
2120 2121


2122
## KVStore
Z
zengyawen 已提交
2123

G
ge-yafang 已提交
2124 2125 2126
KVStore数据库实例,提供增加数据、删除数据和订阅数据变更、订阅数据同步完成的方法。

在调用KVStore的方法前,需要先通过[getKVStore](#getkvstore)构建一个KVStore实例。
2127

2128
### put
Z
zengyawen 已提交
2129

A
asfasdff 已提交
2130
put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
2131

G
ge-yafang 已提交
2132
添加指定类型键值对到数据库,使用callback异步回调。
Z
zengyawen 已提交
2133

G
ge-yafang 已提交
2134
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2135

G
ge-yafang 已提交
2136
**参数:**
A
asfasdff 已提交
2137

2138 2139 2140
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| key    | string  | 是    |要添加数据的key,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。   |
Z
zengyawen 已提交
2141
| value  | Uint8Array \| string \| number \| boolean | 是    |要添加数据的value,支持Uint8Array、number 、 string 、boolean,Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#constants)。   |
2142
| callback | AsyncCallback&lt;void&gt; | 是    |回调函数。   |
A
asfasdff 已提交
2143

G
ge-yafang 已提交
2144
**示例:**
A
asfasdff 已提交
2145

G
ge-yafang 已提交
2146
```js
G
ge-yafang 已提交
2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161
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));
            return;
        }
        console.log("put success");
    });
}catch (e) {
    console.log("An unexpected error occurred. Error:" + e);
}
```
A
asfasdff 已提交
2162 2163


2164
### put
A
asfasdff 已提交
2165

A
asfasdff 已提交
2166
put(key: string, value: Uint8Array | string | number | boolean): Promise&lt;void&gt;
Z
zengyawen 已提交
2167

G
ge-yafang 已提交
2168
添加指定类型键值对到数据库,使用Promise异步回调。
Z
zengyawen 已提交
2169

G
ge-yafang 已提交
2170
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2171

G
ge-yafang 已提交
2172
**参数:**
A
asfasdff 已提交
2173

2174 2175 2176
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| key    | string  | 是    |要添加数据的key,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。   |
Z
zengyawen 已提交
2177
| value  | Uint8Array \| string \| number \| boolean | 是    |要添加数据的value,支持Uint8Array、number 、 string 、boolean,Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#constants)。   |
A
asfasdff 已提交
2178

G
ge-yafang 已提交
2179
**返回值:**
A
asfasdff 已提交
2180

2181 2182
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
2183
| Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
2184

G
ge-yafang 已提交
2185
**示例:**
A
asfasdff 已提交
2186

G
ge-yafang 已提交
2187
```js
G
ge-yafang 已提交
2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200
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) {
    console.log("An unexpected error occurred. Error:" + e);
}
```
A
asfasdff 已提交
2201

2202
### delete
A
asfasdff 已提交
2203

A
asfasdff 已提交
2204
delete(key: string, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
2205

G
ge-yafang 已提交
2206
从数据库中删除指定键值的数据,使用callback异步回调。
Z
zengyawen 已提交
2207

G
ge-yafang 已提交
2208
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2209

G
ge-yafang 已提交
2210
**参数:**
A
asfasdff 已提交
2211

2212 2213 2214 2215
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| key    | string  | 是    |要删除数据的key,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。   |
| callback  | AsyncCallback&lt;void&gt;  | 是    |回调函数。   |
A
asfasdff 已提交
2216

G
ge-yafang 已提交
2217
**示例:**
A
asfasdff 已提交
2218

G
ge-yafang 已提交
2219
```js
G
ge-yafang 已提交
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
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));
            return;
        }
        console.log("put success");
        kvStore.delete(KEY_TEST_STRING_ELEMENT, function (err,data) {
A
asfasdff 已提交
2231
            if (err != undefined) {
G
ge-yafang 已提交
2232
                console.log("delete err: " + JSON.stringify(err));
A
asfasdff 已提交
2233 2234
                return;
            }
G
ge-yafang 已提交
2235
            console.log("delete success");
A
asfasdff 已提交
2236
        });
G
ge-yafang 已提交
2237 2238 2239 2240 2241
    });
}catch (e) {
    console.log("An unexpected error occurred. Error:" + e);
}
```
A
asfasdff 已提交
2242

2243
### delete
A
asfasdff 已提交
2244

A
asfasdff 已提交
2245
delete(key: string): Promise&lt;void&gt;
Z
zengyawen 已提交
2246

G
ge-yafang 已提交
2247
从数据库中删除指定键值的数据,使用Promise异步回调。
Z
zengyawen 已提交
2248

G
ge-yafang 已提交
2249
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2250

G
ge-yafang 已提交
2251
**参数:**
A
asfasdff 已提交
2252

2253 2254 2255
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| key    | string  | 是    |要删除数据的key,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。   |
A
asfasdff 已提交
2256

G
ge-yafang 已提交
2257
**返回值:**
A
asfasdff 已提交
2258

2259 2260
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
2261
| Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
2262

G
ge-yafang 已提交
2263
**示例:**
A
asfasdff 已提交
2264

G
ge-yafang 已提交
2265
```js
G
ge-yafang 已提交
2266 2267 2268 2269 2270 2271 2272 2273
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) => {
            console.log("delete success");
A
asfasdff 已提交
2274
        }).catch((err) => {
G
ge-yafang 已提交
2275
            console.log("delete err: " + JSON.stringify(err));
A
asfasdff 已提交
2276
        });
G
ge-yafang 已提交
2277 2278 2279 2280 2281 2282 2283
    }).catch((err) => {
        console.log("put err: " + JSON.stringify(err));
    });
}catch (e) {
    console.log("An unexpected error occurred. Error:" + e);
}
```
W
wangkai 已提交
2284 2285 2286

### delete<sup>9+</sup>

2287
delete(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;void&gt;)
W
wangkai 已提交
2288

2289 2290 2291
从数据库中删除符合predicates条件的键值对,使用callback异步回调。

**系统接口:** 此接口为系统接口。
W
wangkai 已提交
2292 2293 2294 2295 2296 2297 2298

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
2299
| predicates    | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates)  | 是    |指示筛选条件,当此参数为null时,应定义处理逻辑。|
W
wangkai 已提交
2300 2301 2302 2303 2304
| callback  | AsyncCallback&lt;void&gt;  | 是    |回调函数。   |

**示例:**

```js
2305
import dataSharePredicates from '@ohos.data.dataSharePredicates';
W
wangkai 已提交
2306 2307
let kvStore;
try {
W
wangkai 已提交
2308 2309
	let predicates = new dataSharePredicates.DataSharePredicates();
	kvStore.delete(predicates, function (err, data) {
W
wangkai 已提交
2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
		if (err == undefined) {
			console.log('delete success');
		} else {
			console.log('delete fail' + err);
		}
    });  
} catch (e) {
	console.log('An unexpected error occurred. Error:' + e);
}
```

### delete<sup>9+</sup>

W
wangkai 已提交
2323
delete(predicates: dataSharePredicates.DataSharePredicates): Promise&lt;void&gt;
W
wangkai 已提交
2324

2325 2326 2327
从数据库中删除符合predicates条件的键值对,使用Promise异步回调。

**系统接口:** 此接口为系统接口。
W
wangkai 已提交
2328 2329 2330 2331 2332 2333 2334

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
2335
| predicates    | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates)  | 是    |指示筛选条件,当此参数为null时,应定义处理逻辑。|
W
wangkai 已提交
2336 2337 2338 2339 2340 2341


**返回值:**

| 类型    | 说明       |
| ------  | -------   |
2342
| Promise&lt;void&gt; |无返回结果的Promise对象。|
W
wangkai 已提交
2343 2344 2345 2346

**示例:**

```js
2347
import dataSharePredicates from '@ohos.data.dataSharePredicates';
W
wangkai 已提交
2348 2349
let kvStore;
try {
W
wangkai 已提交
2350
	let predicates = new dataSharePredicates.DataSharePredicates();
W
wangkai 已提交
2351 2352 2353 2354 2355
	let arr = ["name"];
	predicates.inKeys(arr);
	kvStore.put("name", "bob").then((data) => {
		console.log('put success' + JSON.stringify(data));
		kvStore.delete(predicates).then((data) => {
W
wangkai 已提交
2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368
			console.log('delete success');
		}).catch((err) => {
			console.log('delete fail' + JSON.stringify(err));
		});
	}) .catch((err) => {
		console.log(' put fail' + err);
	});
}catch (e) {
	console.log("An unexpected error occurred. Error:" + e);
}

```

Z
zuojiangjiang 已提交
2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395
### backup<sup>9+</sup>

backup(file:string, callback: AsyncCallback&lt;void&gt;):void

以指定名称备份数据库,使用callback异步回调。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名   | 参数类型                  | 必填 | 说明                                                         |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| file     | string                    | 是   | 备份数据库的指定名称,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。当以指定名称备份数据库成功,err为undefined,否则为错误对象。 |

**示例:**

```js
let kvStore;
let file = "BK001";
try {
    kvStore.backup(file, (err, data) => {
        if (err) {
            console.info("backup err : " + err);
        } else {
            console.info("backup data : " + data);
        }
Z
zuojiangjiang 已提交
2396
    });
Z
zuojiangjiang 已提交
2397
} catch (e) {
Z
zuojiangjiang 已提交
2398
    console.log("An unexpected error occurred. Error : " + e);
Z
zuojiangjiang 已提交
2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428
}

```

### backup<sup>9+</sup>

backup(file:string): Promise&lt;void&gt;

以指定名称备份数据库,使用Promise异步回调。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名 | 参数类型 | 必填 | 说明                                                         |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| file   | string   | 是   | 备份数据库的指定名称,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |

**返回值:**

| 类型                | 说明                      |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |

**示例:**

```js
let kvStore;
let file = "BK001";
try {
Z
zuojiangjiang 已提交
2429
    kvStore.backup(file).then((data) => {
Z
zuojiangjiang 已提交
2430 2431 2432 2433 2434
        console.info("backup data : " + data);
    }).catch((err) => {
        console.info("backup err : " + err);
    });
} catch (e) {
Z
zuojiangjiang 已提交
2435
    console.log("An unexpected error occurred. Error : " + e);
Z
zuojiangjiang 已提交
2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581
}

```

### restore<sup>9+</sup>

restore(file:string, callback: AsyncCallback&lt;void&gt;):void

从指定的数据库文件恢复数据库,使用callback异步回调。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名   | 参数类型                  | 必填 | 说明                                                         |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| file     | string                    | 是   | 指定的数据库文件名称,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。当从指定的数据库文件恢复数据库成功,err为undefined,否则为错误对象。 |

**示例:**

```js
let kvStore;
let file = "BK001";
try {
    kvStore.restore(file, (err, data) => {
        if (err) {
            console.info("restore err : " + err);
        } else {
            console.info("restore data : " + data);
        }
    });
} catch (e) {
    console.log("An unexpected error occurred. Error : " + e);
}

```

### restore<sup>9+</sup>

restore(file:string): Promise&lt;void&gt;

从指定的数据库文件恢复数据库,使用Promise异步回调。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名 | 参数类型 | 必填 | 说明                                                         |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| file   | string   | 是   | 指定的数据库文件名称,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |

**返回值:**

| 类型                | 说明                      |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |

**示例:**

```js
let kvStore;
let file = "BK001";
try {
    kvStore.restore(file).then((data) => {
        console.info("restore data : " + data);
    }).catch((err) => {
        console.info("restore err : " + err);
    });
} catch (e) {
    console.log("An unexpected error occurred. Error : " + e);
}

```

### deleteBackup<sup>9+</sup>

deleteBackup(files:Array&lt;string&gt;, callback: AsyncCallback&lt;Array&lt;[string, number]&gt;&gt;):void

根据指定名称删除备份文件,使用callback异步回调。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名   | 参数类型                                           | 必填 | 说明                                                         |
| -------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ |
| files    | Array&lt;string&gt;                                | 是   | 删除备份文件所指定的名称,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |
| callback | AsyncCallback&lt;Array&lt;[string, number]&gt;&gt; | 是   | 回调函数,返回删除备份的文件名及其处理结果。                 |

**示例:**

```js
let kvStore;
let files = ["BK001", "BK002"];
try {
    kvStore.deleteBackup(files, (err, data) => {
        if (err) {
            console.info("deleteBackup err : " + err);
        } else {
            console.info("deleteBackup data : " + data);
        }
    });
} catch (e) {
    console.log("An unexpected error occurred. Error : " + e);
}

```

### deleteBackup<sup>9+</sup>

deleteBackup(files:Array&lt;string&gt;): Promise&lt;Array&lt;[string, number]&gt;&gt;

根据指定名称删除备份文件,使用Promise异步回调。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名 | 参数类型 | 必填 | 说明                                                         |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| files  | Array&lt;string&gt;   | 是   | 删除备份文件所指定的名称,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 |

**返回值:**

| 类型                                         | 说明                                            |
| -------------------------------------------- | ----------------------------------------------- |
| Promise&lt;Array&lt;[string, number]&gt;&gt; | Promise对象,返回删除备份的文件名及其处理结果。 |

**示例:**

```js
let kvStore;
let files = ["BK001", "BK002"];
try {
    kvStore.deleteBackup(files).then((data) => {
        console.info("deleteBackup data : " + data);
    }).catch((err) => {
        console.info("deleteBackup err : " + err);
    })
} catch (e) {
    console.log("An unexpected error occurred. Error : " + e);
}

```

G
ge-yafang 已提交
2582
### on('dataChange')
A
asfasdff 已提交
2583

2584
on(event: 'dataChange', type: SubscribeType, listener: Callback&lt;ChangeNotification&gt;): void
Z
zengyawen 已提交
2585

2586
订阅指定类型的数据变更通知,此方法为同步方法。
Z
zengyawen 已提交
2587

G
ge-yafang 已提交
2588
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2589

G
ge-yafang 已提交
2590
**参数:**
A
asfasdff 已提交
2591

2592 2593
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
2594
| event  |string  | 是    |订阅的事件名,固定为'dataChange',表示数据变更事件。       |
Z
zengyawen 已提交
2595
| type  |[SubscribeType](#subscribetype) | 是    |表示订阅的类型。     |
2596
| listener |Callback&lt;[ChangeNotification](#changenotification)&gt; | 是    |回调函数。 |
2597

G
ge-yafang 已提交
2598
**示例:**
A
asfasdff 已提交
2599

G
ge-yafang 已提交
2600
```js
G
ge-yafang 已提交
2601 2602 2603 2604 2605
let kvStore;
kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, function (data) {
    console.log("dataChange callback call data: " + JSON.stringify(data));
});
```
A
asfasdff 已提交
2606 2607


G
ge-yafang 已提交
2608
### on('syncComplete')
A
asfasdff 已提交
2609

2610
on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt;&gt;): void
Z
zengyawen 已提交
2611

2612
订阅同步完成事件回调通知,此方法为同步方法。
Z
zengyawen 已提交
2613

G
ge-yafang 已提交
2614
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2615

G
ge-yafang 已提交
2616
**参数:**
A
asfasdff 已提交
2617

2618 2619
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
2620
| event  |string | 是    |订阅的事件名,固定为'syncComplete',表示同步完成事件。       |
2621
| syncCallback  |Callback&lt;Array&lt;[string, number]&gt;&gt; | 是    |回调函数。     |
2622

G
ge-yafang 已提交
2623
**示例:**
A
asfasdff 已提交
2624

2625
```js
G
ge-yafang 已提交
2626 2627
let kvStore;
kvStore.on('syncComplete', function (data) {
2628
    console.log("callback call data: " + data);
G
ge-yafang 已提交
2629 2630
});
```
A
asfasdff 已提交
2631

G
ge-yafang 已提交
2632
### off('dataChange')<sup>8+</sup>
A
asfasdff 已提交
2633

2634
off(event:'dataChange', listener?: Callback&lt;ChangeNotification&gt;): void
A
asfasdff 已提交
2635

2636
取消订阅数据变更通知,此方法为同步方法。
A
asfasdff 已提交
2637

G
ge-yafang 已提交
2638
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2639

G
ge-yafang 已提交
2640
**参数:**
A
asfasdff 已提交
2641

2642 2643
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
2644
| event  |string  | 是    |取消订阅的事件名,固定为'dataChange',表示数据变更事件。       |
2645
| listener |Callback&lt;[ChangeNotification](#changenotification)&gt; |否    |回调函数。 |
A
asfasdff 已提交
2646

G
ge-yafang 已提交
2647
**示例:**
A
asfasdff 已提交
2648

G
ge-yafang 已提交
2649
```js
Z
zuojiangjiang 已提交
2650 2651
let kvStore;
class KvstoreModel {
2652 2653 2654 2655
    call(data) {
        console.log("dataChange: " + data);
    }
    subscribeDataChange() {
Z
zuojiangjiang 已提交
2656 2657
        if (kvStore != null) {
            kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_REMOTE, this.call);
2658 2659 2660
        }
    }
    unsubscribeDataChange() {
Z
zuojiangjiang 已提交
2661 2662
        if (kvStore != null) {
            kvStore.off('dataChange', this.call);
2663 2664 2665
        }
    }
}
G
ge-yafang 已提交
2666
```
A
asfasdff 已提交
2667

W
wangkai 已提交
2668 2669 2670 2671
### off('syncComplete')<sup>9+</sup>

off(event: 'syncComplete', syncCallback?: Callback&lt;Array&lt;[string, number]&gt;&gt;): void

2672
取消订阅同步完成事件回调通知,此方法为同步方法。
W
wangkai 已提交
2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| event  |string  | 是    |取消订阅的事件名,固定为'syncComplete',表示同步完成事件。       |
| syncCallback  |Callback&lt;Array&lt;[string, number]&gt;&gt;   | 否    |用于向调用方发送同步结果的回调。    |

**示例:**

```js
Z
zuojiangjiang 已提交
2686 2687
let kvStore;
class KvstoreModel {
2688 2689 2690 2691
    call(data) {
        console.log("syncComplete: " + data);
    }
    subscribeSyncComplete() {
Z
zuojiangjiang 已提交
2692 2693
        if (kvStore != null) {
            kvStore.on('syncComplete', this.call);
2694 2695 2696
        }
    }
    unsubscribeSyncComplete() {
Z
zuojiangjiang 已提交
2697 2698
        if (kvStore != null) {
            kvStore.off('syncComplete', this.call);
2699 2700
        }
    }
W
wangkai 已提交
2701 2702 2703
}
```

A
asfasdff 已提交
2704

2705
### putBatch<sup>8+</sup>
A
asfasdff 已提交
2706

2707
putBatch(entries: Entry[], callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
2708

G
ge-yafang 已提交
2709
批量插入键值对到KVStore数据库中,使用callback异步回调。
A
asfasdff 已提交
2710

G
ge-yafang 已提交
2711
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2712

G
ge-yafang 已提交
2713
**参数:**
A
asfasdff 已提交
2714

2715 2716 2717 2718
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| entries  |[Entry](#entry)[] | 是    |表示要批量插入的键值对。  |
| callback |Asyncallback&lt;void&gt; |是     |回调函数。 |
A
asfasdff 已提交
2719

G
ge-yafang 已提交
2720
**示例:**
A
asfasdff 已提交
2721

G
ge-yafang 已提交
2722
```js
G
ge-yafang 已提交
2723 2724 2725 2726 2727 2728 2729 2730 2731 2732
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
2733 2734
            }
        }
G
ge-yafang 已提交
2735
        entries.push(entry);
A
asfasdff 已提交
2736
    }
G
ge-yafang 已提交
2737 2738 2739
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries, async function (err,data) {
        console.log('putBatch success');
2740
        kvStore.getEntries('batch_test_string_key', function (err,entries) {
G
ge-yafang 已提交
2741
            console.log('getEntries success');
2742 2743
            console.log('entries.length: ' + entries.length);
            console.log('entries[0]: ' + JSON.stringify(entries[0]));
G
ge-yafang 已提交
2744 2745 2746
        });
    });
}catch(e) {
G
ge-yafang 已提交
2747
    console.log('PutBatch e ' + JSON.stringify(e));
G
ge-yafang 已提交
2748 2749
}
```
A
asfasdff 已提交
2750 2751


2752
### putBatch<sup>8+</sup>
A
asfasdff 已提交
2753

2754
putBatch(entries: Entry[]): Promise&lt;void&gt;
A
asfasdff 已提交
2755

G
ge-yafang 已提交
2756
批量插入键值对到KVStore数据库中,使用Promise异步回调。
A
asfasdff 已提交
2757

G
ge-yafang 已提交
2758
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2759

G
ge-yafang 已提交
2760
**参数:**
A
asfasdff 已提交
2761

2762 2763 2764
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| entries  |[Entry](#entry)[] | 是    |表示要批量插入的键值对。  |
A
asfasdff 已提交
2765

G
ge-yafang 已提交
2766
**返回值:**
A
asfasdff 已提交
2767

2768 2769
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
2770
| Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
2771

G
ge-yafang 已提交
2772
**示例:**
A
asfasdff 已提交
2773

G
ge-yafang 已提交
2774
```js
G
ge-yafang 已提交
2775 2776 2777 2778 2779 2780 2781 2782 2783 2784
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
2785 2786
            }
        }
G
ge-yafang 已提交
2787 2788 2789 2790 2791
        entries.push(entry);
    }
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
2792
        kvStore.getEntries('batch_test_string_key').then((entries) => {
G
ge-yafang 已提交
2793 2794
            console.log('getEntries success');
            console.log('PutBatch ' + JSON.stringify(entries));
A
asfasdff 已提交
2795
        }).catch((err) => {
G
ge-yafang 已提交
2796
            console.log('getEntries fail ' + JSON.stringify(err));
A
asfasdff 已提交
2797
        });
G
ge-yafang 已提交
2798 2799 2800 2801
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
}catch(e) {
G
ge-yafang 已提交
2802
    console.log('PutBatch e ' + JSON.stringify(e));
G
ge-yafang 已提交
2803 2804
}
```
A
asfasdff 已提交
2805

W
wangkai 已提交
2806 2807 2808
### putBatch<sup>9+</sup>

putBatch(value: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;void&gt;): void
G
ge-yafang 已提交
2809

2810 2811 2812
将值写入KvStore数据库,使用callback异步回调。

**系统接口:** 此接口为系统接口。
W
wangkai 已提交
2813 2814 2815 2816 2817 2818 2819

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
W
wangkai 已提交
2820
| value   |Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是    |表示要插入的数据。  |
W
wangkai 已提交
2821 2822 2823 2824 2825 2826 2827
| callback |Asyncallback&lt;void&gt; |是     |回调函数。 |

**示例:**

```js
let kvStore;
try {
W
wangkai 已提交
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837
    let v8Arr = [];
    let arr = new Uint8Array([4,5,6,7]);
    let vb1 = {key : "name_1", value : 32}
    let vb2 = {key : "name_2", value : arr};
    let vb3 = {key : "name_3", value : "lisi"};

    v8Arr.push(vb1);
    v8Arr.push(vb2);
    v8Arr.push(vb3);
    kvStore.putBatch(v8Arr, async function (err,data) {
W
wangkai 已提交
2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850
                console.log('putBatch success');
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('putBatch e ' + JSON.stringify(e));
}
```

### putBatch<sup>9+</sup>

putBatch(value: Array&lt;ValuesBucket&gt;): Promise&lt;void&gt;

2851 2852 2853
将valuesbucket类型的值写入KvStore数据库,使用Promise异步回调。

**系统接口:** 此接口为系统接口。
W
wangkai 已提交
2854 2855 2856 2857 2858 2859 2860

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
W
wangkai 已提交
2861
| value  |Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是    |表示要插入的数据。  |
W
wangkai 已提交
2862 2863 2864 2865 2866

**返回值:**

| 类型    | 说明       |
| ------  | -------   |
2867
| Promise&lt;void&gt; |五返回结果的Promise对象。|
W
wangkai 已提交
2868 2869 2870 2871 2872 2873

**示例:**

```js
let kvStore;
try {
W
wangkai 已提交
2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884
    let v8Arr = [];
    let arr = new Uint8Array([4,5,6,7]);
    let vb1 = {key : "name_1", value : 32}
    let vb2 = {key : "name_2", value : arr};
    let vb3 = {key : "name_3", value : "lisi"};

    v8Arr.push(vb1);
    v8Arr.push(vb2);
    v8Arr.push(vb3);
    kvStore.putBatch(v8Arr).then(async (err) => {
        console.log('putBatch success');
W
wangkai 已提交
2885 2886 2887 2888 2889 2890 2891 2892
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('PutBatch e ' + JSON.stringify(e));
}

```
A
asfasdff 已提交
2893

2894
### deleteBatch<sup>8+</sup>
A
asfasdff 已提交
2895

2896
deleteBatch(keys: string[], callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
2897

G
ge-yafang 已提交
2898
批量删除KVStore数据库中的键值对,使用callback异步回调。
A
asfasdff 已提交
2899

G
ge-yafang 已提交
2900
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2901

G
ge-yafang 已提交
2902
**参数:**
A
asfasdff 已提交
2903

2904 2905 2906 2907
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| keys  |string[] | 是    |表示要批量删除的键值对。  |
| callback  |AsyncCallback&lt;void&gt; | 是    |回调函数。  |
A
asfasdff 已提交
2908

G
ge-yafang 已提交
2909
**示例:**
A
asfasdff 已提交
2910

G
ge-yafang 已提交
2911
```js
G
ge-yafang 已提交
2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922
let kvStore;
try {
    let entries = [];
    let keys = [];
    for (var i = 0; i < 5; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
2923 2924
            }
        }
G
ge-yafang 已提交
2925 2926
        entries.push(entry);
        keys.push(key + i);
A
asfasdff 已提交
2927
    }
G
ge-yafang 已提交
2928 2929 2930
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries, async function (err,data) {
        console.log('putBatch success');
W
wangkai 已提交
2931
        kvStore.deleteBatch(keys, async function (err,data) {
G
ge-yafang 已提交
2932 2933 2934 2935 2936 2937 2938
            console.log('deleteBatch success');
        });
    });
}catch(e) {
    console.log('DeleteBatch e ' + e);
}
```
A
asfasdff 已提交
2939 2940


2941
### deleteBatch<sup>8+</sup>
A
asfasdff 已提交
2942

2943
deleteBatch(keys: string[]): Promise&lt;void&gt;
A
asfasdff 已提交
2944

G
ge-yafang 已提交
2945
批量删除KVStore数据库中的键值对,使用Promise异步回调。
A
asfasdff 已提交
2946

G
ge-yafang 已提交
2947
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
2948

G
ge-yafang 已提交
2949
**参数:**
A
asfasdff 已提交
2950

2951 2952 2953
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| keys   |string[] | 是    |表示要批量删除的键值对。  |
A
asfasdff 已提交
2954

G
ge-yafang 已提交
2955
**返回值:**
A
asfasdff 已提交
2956

2957 2958
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
2959
| Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
2960

G
ge-yafang 已提交
2961
**示例:**
A
asfasdff 已提交
2962

G
ge-yafang 已提交
2963
```js
G
ge-yafang 已提交
2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974
let kvStore;
try {
    let entries = [];
    let keys = [];
    for (var i = 0; i < 5; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
2975 2976
            }
        }
G
ge-yafang 已提交
2977 2978 2979 2980 2981 2982
        entries.push(entry);
        keys.push(key + i);
    }
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
W
wangkai 已提交
2983
        kvStore.deleteBatch(keys).then((err) => {
G
ge-yafang 已提交
2984
            console.log('deleteBatch success');
A
asfasdff 已提交
2985
        }).catch((err) => {
G
ge-yafang 已提交
2986
            console.log('deleteBatch fail ' + JSON.stringify(err));
A
asfasdff 已提交
2987
        });
G
ge-yafang 已提交
2988 2989 2990 2991 2992 2993 2994
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('DeleteBatch e ' + e);
}
```
A
asfasdff 已提交
2995 2996


2997
### startTransaction<sup>8+</sup>
A
asfasdff 已提交
2998

2999
startTransaction(callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
3000

G
ge-yafang 已提交
3001
启动KVStore数据库中的事务,使用callback异步回调。
A
asfasdff 已提交
3002

G
ge-yafang 已提交
3003
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3004

G
ge-yafang 已提交
3005
**参数:**
A
asfasdff 已提交
3006

3007 3008 3009
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| callback  |AsyncCallback&lt;void&gt; | 是    |回调函数。  |
A
asfasdff 已提交
3010

G
ge-yafang 已提交
3011
**示例:**
A
asfasdff 已提交
3012

G
ge-yafang 已提交
3013
```js
G
ge-yafang 已提交
3014 3015 3016 3017 3018 3019 3020 3021 3022
let kvStore;
function putBatchString(len, prefix) {
    let entries = [];
    for (var i = 0; i < len; i++) {
        var entry = {
            key : prefix + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
3023 3024
            }
        }
G
ge-yafang 已提交
3025
        entries.push(entry);
A
asfasdff 已提交
3026
    }
G
ge-yafang 已提交
3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038
    return entries;
}
try {
    var count = 0;
    kvStore.on('dataChange', 0, function (data) {
        console.log('startTransaction 0' + data)
        count++;
    });
    kvStore.startTransaction(async function (err,data) {
        console.log('startTransaction success');
        let entries = putBatchString(10, 'batch_test_string_key');
        console.log('entries: ' + JSON.stringify(entries));
W
wangkai 已提交
3039
        kvStore.putBatch(entries, async function (err,data) {
G
ge-yafang 已提交
3040
            console.log('putBatch success');
A
asfasdff 已提交
3041
        });
G
ge-yafang 已提交
3042 3043 3044 3045 3046
    });
}catch(e) {
    console.log('startTransaction e ' + e);
}
```
A
asfasdff 已提交
3047 3048


3049
### startTransaction<sup>8+</sup>
A
asfasdff 已提交
3050

3051
startTransaction(): Promise&lt;void&gt;
A
asfasdff 已提交
3052

G
ge-yafang 已提交
3053
启动KVStore数据库中的事务,使用Promise异步回调。
A
asfasdff 已提交
3054

G
ge-yafang 已提交
3055
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3056

G
ge-yafang 已提交
3057
**返回值:**
A
asfasdff 已提交
3058

3059 3060
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3061
| Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
3062

G
ge-yafang 已提交
3063
**示例:**
A
asfasdff 已提交
3064

G
ge-yafang 已提交
3065
```js
G
ge-yafang 已提交
3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081
let kvStore;
try {
    var count = 0;
    kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_ALL, function (data) {
        console.log('startTransaction ' + JSON.stringify(data));
        count++;
    });
    kvStore.startTransaction().then(async (err) => {
        console.log('startTransaction success');
    }).catch((err) => {
        console.log('startTransaction fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('startTransaction e ' + e);
}
```
A
asfasdff 已提交
3082 3083


3084
### commit<sup>8+</sup>
A
asfasdff 已提交
3085

3086
commit(callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
3087

G
ge-yafang 已提交
3088
提交KVStore数据库中的事务,使用callback异步回调。
A
asfasdff 已提交
3089

G
ge-yafang 已提交
3090
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3091

G
ge-yafang 已提交
3092
**参数:**
A
asfasdff 已提交
3093

3094 3095 3096
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| callback  |AsyncCallback&lt;void&gt; | 是    |回调函数。  |
A
asfasdff 已提交
3097

G
ge-yafang 已提交
3098
**示例:**
A
asfasdff 已提交
3099

G
ge-yafang 已提交
3100
```js
G
ge-yafang 已提交
3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113
let kvStore;
try {
    kvStore.commit(function (err,data) {
        if (err == undefined) {
            console.log('commit success');
        } else {
            console.log('commit fail');
        }
    });
}catch(e) {
    console.log('Commit e ' + e);
}
```
A
asfasdff 已提交
3114 3115


3116
### commit<sup>8+</sup>
A
asfasdff 已提交
3117

3118
commit(): Promise&lt;void&gt;
A
asfasdff 已提交
3119

G
ge-yafang 已提交
3120
提交KVStore数据库中的事务,使用Promise异步回调。
A
asfasdff 已提交
3121

G
ge-yafang 已提交
3122
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3123

G
ge-yafang 已提交
3124
**返回值:**
A
asfasdff 已提交
3125

3126 3127
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3128
| Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
3129

G
ge-yafang 已提交
3130
**示例:**
A
asfasdff 已提交
3131

G
ge-yafang 已提交
3132
```js
G
ge-yafang 已提交
3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143
let kvStore;
try {
    kvStore.commit().then(async (err) => {
        console.log('commit success');
    }).catch((err) => {
        console.log('commit fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('Commit e ' + e);
}
```
A
asfasdff 已提交
3144 3145


3146
### rollback<sup>8+</sup>
A
asfasdff 已提交
3147

3148
rollback(callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
3149

G
ge-yafang 已提交
3150
在KVStore数据库中回滚事务,使用callback异步回调。
A
asfasdff 已提交
3151

G
ge-yafang 已提交
3152
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3153

G
ge-yafang 已提交
3154
**参数:**
A
asfasdff 已提交
3155

3156 3157 3158
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| callback  |AsyncCallback&lt;void&gt; | 是    |回调函数。  |
A
asfasdff 已提交
3159

G
ge-yafang 已提交
3160
**示例:**
A
asfasdff 已提交
3161

G
ge-yafang 已提交
3162
```js
G
ge-yafang 已提交
3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175
let kvStore;
try {
    kvStore.rollback(function (err,data) {
        if (err == undefined) {
            console.log('commit success');
        } else {
            console.log('commit fail');
        }
    });
}catch(e) {
    console.log('Rollback e ' + e);
}
```
A
asfasdff 已提交
3176 3177


3178
### rollback<sup>8+</sup>
A
asfasdff 已提交
3179

3180
rollback(): Promise&lt;void&gt;
A
asfasdff 已提交
3181

G
ge-yafang 已提交
3182
在KVStore数据库中回滚事务,使用Promise异步回调。
A
asfasdff 已提交
3183

G
ge-yafang 已提交
3184
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3185

G
ge-yafang 已提交
3186
**返回值:**
A
asfasdff 已提交
3187

3188 3189
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3190
| Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
3191

G
ge-yafang 已提交
3192
**示例:**
A
asfasdff 已提交
3193

G
ge-yafang 已提交
3194
```js
G
ge-yafang 已提交
3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205
let kvStore;
try {
    kvStore.rollback().then(async (err) => {
        console.log('rollback success');
    }).catch((err) => {
        console.log('rollback fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('Rollback e ' + e);
}
```
A
asfasdff 已提交
3206 3207


3208
### enableSync<sup>8+</sup>
A
asfasdff 已提交
3209

3210
enableSync(enabled: boolean, callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
3211

G
ge-yafang 已提交
3212
设定是否开启同步,使用callback异步回调。
A
asfasdff 已提交
3213

G
ge-yafang 已提交
3214
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3215

G
ge-yafang 已提交
3216
**参数:**
A
asfasdff 已提交
3217

3218 3219
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
3220
| enabled  |boolean | 是    |设定是否开启同步,true表示开启同步,false表示不启用同步。  |
3221
| callback  |AsyncCallback&lt;void&gt; | 是    |回调函数。  |
A
asfasdff 已提交
3222

G
ge-yafang 已提交
3223
**示例:**
A
asfasdff 已提交
3224

G
ge-yafang 已提交
3225
```js
G
ge-yafang 已提交
3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238
let kvStore;
try {
    kvStore.enableSync(true, function (err,data) {
        if (err == undefined) {
            console.log('enableSync success');
        } else {
            console.log('enableSync fail');
        }
    });
}catch(e) {
    console.log('EnableSync e ' + e);
}
```
A
asfasdff 已提交
3239 3240


3241
### enableSync<sup>8+</sup>
A
asfasdff 已提交
3242

3243
enableSync(enabled: boolean): Promise&lt;void&gt;
A
asfasdff 已提交
3244

G
ge-yafang 已提交
3245
设定是否开启同步,使用Promise异步回调。
A
asfasdff 已提交
3246

G
ge-yafang 已提交
3247
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3248

G
ge-yafang 已提交
3249
**参数:**
A
asfasdff 已提交
3250

3251 3252
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
G
ge-yafang 已提交
3253
| enabled  |boolean | 是    |设定是否开启同步,true表示开启同步,false表示不启用同步。  |
A
asfasdff 已提交
3254

G
ge-yafang 已提交
3255
**返回值:**
A
asfasdff 已提交
3256

3257 3258
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3259
| Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
3260

G
ge-yafang 已提交
3261
**示例:**
A
asfasdff 已提交
3262

G
ge-yafang 已提交
3263
```js
G
ge-yafang 已提交
3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274
let kvStore;
try {
    kvStore.enableSync(true).then((err) => {
        console.log('enableSync success');
    }).catch((err) => {
        console.log('enableSync fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('EnableSync e ' + e);
}
```
A
asfasdff 已提交
3275 3276


3277
### setSyncRange<sup>8+</sup>
A
asfasdff 已提交
3278

3279
setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
3280

G
ge-yafang 已提交
3281
设置同步范围标签,使用callback异步回调。
A
asfasdff 已提交
3282

G
ge-yafang 已提交
3283
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3284

G
ge-yafang 已提交
3285
**参数:**
A
asfasdff 已提交
3286

3287 3288 3289 3290 3291
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| localLabels  |string[] | 是    |表示本地设备的同步标签。  |
| remoteSupportLabels  |string[] | 是    |表示要同步数据的设备的同步标签。  |
| callback  |AsyncCallback&lt;void&gt; | 是    |回调函数。  |
A
asfasdff 已提交
3292

G
ge-yafang 已提交
3293
**示例:**
A
asfasdff 已提交
3294

G
ge-yafang 已提交
3295
```js
G
ge-yafang 已提交
3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306
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) {
    console.log('SetSyncRange e ' + e);
}
```
A
asfasdff 已提交
3307 3308


3309
### setSyncRange<sup>8+</sup>
A
asfasdff 已提交
3310

3311
setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise&lt;void&gt;
A
asfasdff 已提交
3312

G
ge-yafang 已提交
3313
设置同步范围标签,使用Promise异步回调。
A
asfasdff 已提交
3314

G
ge-yafang 已提交
3315
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3316

G
ge-yafang 已提交
3317
**参数:**
A
asfasdff 已提交
3318

3319 3320 3321 3322 3323
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| localLabels  |string[] | 是    |表示本地设备的同步标签。  |
| remoteSupportLabels  |string[] | 是    |表示要同步数据的设备的同步标签。  |

A
asfasdff 已提交
3324

G
ge-yafang 已提交
3325
**返回值:**
A
asfasdff 已提交
3326

3327 3328
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3329
| Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
3330

G
ge-yafang 已提交
3331
**示例:**
A
asfasdff 已提交
3332

G
ge-yafang 已提交
3333
```js
G
ge-yafang 已提交
3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346
let kvStore;
try {
    const localLabels = ['A', 'B'];
    const remoteSupportLabels = ['C', 'D'];
    kvStore.setSyncRange(localLabels, remoteSupportLabels).then((err) => {
        console.log('setSyncRange success');
    }).catch((err) => {
        console.log('delete fail ' + err);
    });
}catch(e) {
    console.log('SetSyncRange e ' + e);
}
```
A
asfasdff 已提交
3347 3348


3349
## SubscribeType
Z
zengyawen 已提交
3350

G
ge-yafang 已提交
3351
订阅类型枚举。
Z
zengyawen 已提交
3352

G
ge-yafang 已提交
3353
**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core
3354

G
ge-yafang 已提交
3355
| 名称  | 值   | 说明                    |
3356 3357 3358 3359 3360 3361
| -----  | ------   | ----------------------- |
| SUBSCRIBE_TYPE_LOCAL  |0 |表示订阅本地数据变更。  |
| SUBSCRIBE_TYPE_REMOTE |1 |表示订阅远端数据变更。  |
| SUBSCRIBE_TYPE_ALL  |2 |表示订阅远端和本地数据变更。  |

## ChangeNotification
Z
zengyawen 已提交
3362 3363 3364

数据变更时通知的对象,包括数据插入的数据、更新的数据、删除的数据和设备ID。

G
ge-yafang 已提交
3365
**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core
3366

3367 3368 3369 3370 3371 3372 3373 3374
| 名称  | 参数类型   |可读   |可写   | 说明                    |
| ----- | -------   | -----| ------|------------------------ |
| insertEntries | [Entry](#entry)[]   | 是  |  是 |数据添加记录。   |
| updateEntries | [Entry](#entry)[]   | 是  |  是 |数据更新记录。   |
| deleteEntries | [Entry](#entry)[]   | 是  |  是 |数据删除记录。   |
| deviceId | string   | 是  |  是 |设备ID,此处为设备UUID。  |

## Entry
Z
zengyawen 已提交
3375 3376 3377

存储在数据库中的键值对。

G
ge-yafang 已提交
3378
**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core
3379

3380 3381 3382 3383 3384 3385 3386
| 名称  | 参数类型   |可读   |可写   | 说明                    |
| ----- | -------   | -----| ------|------------------------ |
| key | string   | 是  |  是 |键值。   |
| value | [Value](#value) | 是  |  是 |值对象。   |


## Value
Z
zengyawen 已提交
3387

G
ge-yafang 已提交
3388
存储在数据库中的值对象。
Z
zengyawen 已提交
3389

G
ge-yafang 已提交
3390
**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core
3391

3392 3393 3394
| 名称  | 参数类型   |可读   |可写   | 说明                    |
| ----- | -------   | -----| ------|------------------------ |
| type | [ValueType](#value)   | 是  |  是 |值类型。   |
G
ge-yafang 已提交
3395
| value | Uint8Array \| string \| number \| boolean| 是  |  是 |值。   |
3396 3397

## ValueType
Z
zengyawen 已提交
3398

G
ge-yafang 已提交
3399
数据类型枚举。
Z
zengyawen 已提交
3400

G
ge-yafang 已提交
3401
**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core
3402

G
ge-yafang 已提交
3403
| 名称  | 值   | 说明                    |
3404 3405 3406 3407 3408 3409 3410 3411 3412
| -----  | ------   | ----------------------- |
| STRING  |0 |表示值类型为字符串。  |
| INTEGER |1 |表示值类型为整数。  |
| FLOAT   |2 |表示值类型为浮点数。  |
| BYTE_ARRAY   |3 |表示值类型为字节数组。  |
| BOOLEAN   |4 |表示值类型为布尔值。  |
| DOUBLE   |5 |表示值类型为双浮点数。  |

## SingleKVStore
Z
zengyawen 已提交
3413

G
ge-yafang 已提交
3414 3415 3416 3417 3418
单版本数据库,继承自[KVStore](#kvstore)数据库,提供查询数据和同步数据的方法。

单版本数据库,不对数据所属设备进行区分,不同设备使用相同键写入数据会互相覆盖。比如,可以使用单版本数据库实现个人日历、联系人数据在不同设备间的数据同步。

在调用SingleKVStore的方法前,需要先通过[getKVStore](#getkvstore)构建一个SingleKVStore实例。
3419

3420
### get
Z
zengyawen 已提交
3421

A
asfasdff 已提交
3422
get(key: string, callback: AsyncCallback&lt;Uint8Array | string | boolean | number&gt;): void
Z
zengyawen 已提交
3423

G
ge-yafang 已提交
3424
获取指定键的值,使用callback异步回调。
Z
zengyawen 已提交
3425

G
ge-yafang 已提交
3426
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3427

G
ge-yafang 已提交
3428
**参数:**
A
asfasdff 已提交
3429

3430 3431 3432
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| key    |string   | 是    |要查询数据的key,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。  |
G
ge-yafang 已提交
3433
| callback  |AsyncCallback&lt;Uint8Array \| string \| boolean \| number&gt;) | 是    |回调函数。返回获取查询的值。  |
A
asfasdff 已提交
3434

G
ge-yafang 已提交
3435
**示例:**
A
asfasdff 已提交
3436

G
ge-yafang 已提交
3437
```js
G
ge-yafang 已提交
3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449
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));
            return;
        }
        console.log("put success");
        kvStore.get(KEY_TEST_STRING_ELEMENT, function (err,data) {
            console.log("get success data: " + data);
A
asfasdff 已提交
3450
        });
G
ge-yafang 已提交
3451 3452 3453 3454 3455
    });
}catch (e) {
    console.log("An unexpected error occurred. Error:" + e);
}
```
A
asfasdff 已提交
3456 3457


3458
### get
A
asfasdff 已提交
3459

3460
get(key: string): Promise&lt;Uint8Array | string | boolean | number&gt;
Z
zengyawen 已提交
3461

G
ge-yafang 已提交
3462
获取指定键的值,使用Promise异步回调。
Z
zengyawen 已提交
3463

G
ge-yafang 已提交
3464
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3465

G
ge-yafang 已提交
3466
**参数:**
A
asfasdff 已提交
3467

3468 3469 3470 3471
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| key    |string   | 是    |要查询数据的key,不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。  |

A
asfasdff 已提交
3472

G
ge-yafang 已提交
3473
**返回值:**
A
asfasdff 已提交
3474

3475 3476
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3477
|Promise&lt;Uint8Array \| string \| boolean \| number&gt; |Promise对象。返回获取查询的值。|
A
asfasdff 已提交
3478

G
ge-yafang 已提交
3479
**示例:**
A
asfasdff 已提交
3480

G
ge-yafang 已提交
3481
```js
G
ge-yafang 已提交
3482 3483 3484 3485 3486 3487 3488 3489
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) => {
            console.log("get success data: " + data);
A
asfasdff 已提交
3490
        }).catch((err) => {
G
ge-yafang 已提交
3491
            console.log("get err: " + JSON.stringify(err));
A
asfasdff 已提交
3492
        });
G
ge-yafang 已提交
3493 3494 3495 3496 3497 3498 3499
    }).catch((err) => {
        console.log("put err: " + JSON.stringify(err));
    });
}catch (e) {
    console.log("An unexpected error occurred. Error:" + e);
}
```
A
asfasdff 已提交
3500

3501
### getEntries<sup>8+</sup>
A
asfasdff 已提交
3502

3503
getEntries(keyPrefix: string, callback: AsyncCallback&lt;Entry[]&gt;): void
A
asfasdff 已提交
3504

G
ge-yafang 已提交
3505
获取匹配指定键前缀的所有键值对,使用callback异步回调。
A
asfasdff 已提交
3506

G
ge-yafang 已提交
3507
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3508

G
ge-yafang 已提交
3509
**参数:**
A
asfasdff 已提交
3510

3511 3512 3513
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| keyPrefix    |string   | 是    |表示要匹配的键前缀。  |
G
ge-yafang 已提交
3514
| callback    |AsyncCallback&lt;[Entry](#entry)[]&gt;   | 是    |回调函数。返回匹配指定前缀的键值对列表。  |
A
asfasdff 已提交
3515

G
ge-yafang 已提交
3516
**示例:**
A
asfasdff 已提交
3517

G
ge-yafang 已提交
3518
```js
G
ge-yafang 已提交
3519 3520 3521 3522 3523 3524 3525 3526 3527 3528
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_number_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.INTEGER,
                value : 222
A
asfasdff 已提交
3529 3530
            }
        }
G
ge-yafang 已提交
3531
        entries.push(entry);
A
asfasdff 已提交
3532
    }
G
ge-yafang 已提交
3533 3534
    kvStore.putBatch(entries, async function (err,data) {
        console.log('putBatch success');
3535
        kvStore.getEntries('batch_test_number_key', function (err,entries) {
G
ge-yafang 已提交
3536
            console.log('getEntries success');
3537 3538
            console.log('entries.length: ' + entries.length);
            console.log('entries[0]: ' + JSON.stringify(entries[0]));
G
ge-yafang 已提交
3539 3540 3541 3542 3543 3544
        });
    });
}catch(e) {
    console.log('PutBatch e ' + e);
}
```
A
asfasdff 已提交
3545 3546


3547
### getEntries<sup>8+</sup>
A
asfasdff 已提交
3548

3549
getEntries(keyPrefix: string): Promise&lt;Entry[]&gt;
A
asfasdff 已提交
3550

G
ge-yafang 已提交
3551
获取匹配指定键前缀的所有键值对,使用Promise异步回调。
A
asfasdff 已提交
3552

G
ge-yafang 已提交
3553
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3554

G
ge-yafang 已提交
3555
**参数:**
A
asfasdff 已提交
3556

3557 3558 3559
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| keyPrefix    |string   | 是    |表示要匹配的键前缀。  |
A
asfasdff 已提交
3560

G
ge-yafang 已提交
3561
**返回值:**
A
asfasdff 已提交
3562

3563 3564
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3565
|Promise&lt;[Entry](#entry)[]&gt; |Promise对象。返回匹配指定前缀的键值对列表。|
A
asfasdff 已提交
3566

G
ge-yafang 已提交
3567
**示例:**
A
asfasdff 已提交
3568

G
ge-yafang 已提交
3569
```js
G
ge-yafang 已提交
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
3580 3581
            }
        }
G
ge-yafang 已提交
3582 3583 3584 3585 3586
        entries.push(entry);
    }
    console.log('entries: ' + entries);
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
3587
        kvStore.getEntries('batch_test_string_key').then((entries) => {
G
ge-yafang 已提交
3588
            console.log('getEntries success');
3589 3590 3591 3592
            console.log('entries.length: ' + entries.length);
            console.log('entries[0]: ' + JSON.stringify(entries[0]));
            console.log('entries[0].value: ' + JSON.stringify(entries[0].value));
            console.log('entries[0].value.value: ' + entries[0].value.value);
A
asfasdff 已提交
3593
        }).catch((err) => {
G
ge-yafang 已提交
3594
            console.log('getEntries fail ' + JSON.stringify(err));
A
asfasdff 已提交
3595
        });
G
ge-yafang 已提交
3596 3597 3598 3599 3600 3601 3602
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('PutBatch e ' + e);
}
```
A
asfasdff 已提交
3603 3604


3605
### getEntries<sup>8+</sup>
A
asfasdff 已提交
3606

3607
getEntries(query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
A
asfasdff 已提交
3608

G
ge-yafang 已提交
3609
获取与指定Query对象匹配的键值对列表,使用callback异步回调。
A
asfasdff 已提交
3610

G
ge-yafang 已提交
3611
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3612

G
ge-yafang 已提交
3613
**参数:**
A
asfasdff 已提交
3614

3615 3616
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
Z
zengyawen 已提交
3617
| query  |[Query](#query8)   | 是    |表示要匹配的键前缀。  |
G
ge-yafang 已提交
3618
| callback  |AsyncCallback&lt;[Entry](#entry)[]&gt;   | 是    |回调函数。返回与指定Query对象匹配的键值对列表。  |
A
asfasdff 已提交
3619

G
ge-yafang 已提交
3620
**示例:**
A
asfasdff 已提交
3621

G
ge-yafang 已提交
3622
```js
G
ge-yafang 已提交
3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633
let kvStore;
try {
    var arr = new Uint8Array([21,31]);
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_bool_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.BYTE_ARRAY,
                value : arr
A
asfasdff 已提交
3634 3635
            }
        }
G
ge-yafang 已提交
3636
        entries.push(entry);
A
asfasdff 已提交
3637
    }
G
ge-yafang 已提交
3638 3639 3640 3641 3642
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries, async function (err,data) {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
3643
        kvStore.getEntries(query, function (err,entries) {
G
ge-yafang 已提交
3644
            console.log('getEntries success');
3645 3646
            console.log('entries.length: ' + entries.length);
            console.log('entries[0]: ' + JSON.stringify(entries[0]));
G
ge-yafang 已提交
3647 3648 3649 3650 3651 3652 3653
        });
    });
    console.log('GetEntries success');
}catch(e) {
    console.log('GetEntries e ' + e);
}
```
A
asfasdff 已提交
3654 3655


3656
### getEntries<sup>8+</sup>
A
asfasdff 已提交
3657

3658
getEntries(query: Query): Promise&lt;Entry[]&gt;
A
asfasdff 已提交
3659

G
ge-yafang 已提交
3660
获取与指定Query对象匹配的键值对列表,使用Promise异步回调。
A
asfasdff 已提交
3661

G
ge-yafang 已提交
3662
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3663

G
ge-yafang 已提交
3664
**参数:**
A
asfasdff 已提交
3665

3666 3667
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
Z
zengyawen 已提交
3668
| query  |[Query](#query8)   | 是    |表示查询对象。  |
A
asfasdff 已提交
3669

G
ge-yafang 已提交
3670
**返回值:**
A
asfasdff 已提交
3671

3672 3673
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3674
|Promise&lt;[Entry](#entry)[]&gt; |Promise对象。返回与指定Query对象匹配的键值对列表。|
A
asfasdff 已提交
3675

G
ge-yafang 已提交
3676
**示例:**
A
asfasdff 已提交
3677

G
ge-yafang 已提交
3678
```js
W
wangkai 已提交
3679
let kvStore;
G
ge-yafang 已提交
3680 3681 3682 3683 3684 3685 3686 3687 3688 3689
try {
    var arr = new Uint8Array([21,31]);
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_bool_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.BYTE_ARRAY,
                value : arr
A
asfasdff 已提交
3690 3691
            }
        }
G
ge-yafang 已提交
3692 3693 3694 3695 3696 3697 3698
        entries.push(entry);
    }
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
3699
        kvStore.getEntries(query).then((entries) => {
G
ge-yafang 已提交
3700
            console.log('getEntries success');
A
asfasdff 已提交
3701
        }).catch((err) => {
G
ge-yafang 已提交
3702
            console.log('getEntries fail ' + JSON.stringify(err));
A
asfasdff 已提交
3703
        });
G
ge-yafang 已提交
3704 3705 3706 3707 3708 3709 3710 3711
    }).catch((err) => {
        console.log('GetEntries putBatch fail ' + JSON.stringify(err))
    });
    console.log('GetEntries success');
}catch(e) {
    console.log('GetEntries e ' + e);
}
```
A
asfasdff 已提交
3712 3713


3714
### getResultSet<sup>8+</sup><a name="singlekvstore_getresultset"></a>
A
asfasdff 已提交
3715

3716
getResultSet(keyPrefix: string, callback: AsyncCallback&lt;KvStoreResultSet&gt;): void
A
asfasdff 已提交
3717

G
ge-yafang 已提交
3718
从KvStore数据库中获取具有指定前缀的结果集,使用callback异步回调。
A
asfasdff 已提交
3719

G
ge-yafang 已提交
3720
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3721

G
ge-yafang 已提交
3722
**参数:**
A
asfasdff 已提交
3723

3724 3725 3726
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| keyPrefix  |string   | 是    |表示要匹配的键前缀。 |
G
ge-yafang 已提交
3727
| callback  |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt;   | 是    |回调函数。返回具有指定前缀的结果集。 |
A
asfasdff 已提交
3728

G
ge-yafang 已提交
3729
**示例:**
A
asfasdff 已提交
3730

G
ge-yafang 已提交
3731
```js
G
ge-yafang 已提交
3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742
let kvStore;
try {
    let resultSet;
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
3743 3744
            }
        }
G
ge-yafang 已提交
3745
        entries.push(entry);
A
asfasdff 已提交
3746
    }
G
ge-yafang 已提交
3747 3748
    kvStore.putBatch(entries, async function (err, data) {
        console.log('GetResultSet putBatch success');
W
wangkai 已提交
3749
        kvStore.getResultSet('batch_test_string_key', async function (err, result) {
G
ge-yafang 已提交
3750
            console.log('GetResultSet getResultSet succeed.');
G
ge-yafang 已提交
3751 3752 3753 3754 3755 3756 3757 3758 3759 3760
            resultSet = result;
            kvStore.closeResultSet(resultSet, function (err, data) {
                console.log('GetResultSet closeResultSet success');
            })
        });
    });
}catch(e) {
    console.log('GetResultSet e ' + e);
}
```
A
asfasdff 已提交
3761 3762


3763
### getResultSet<sup>8+</sup>
A
asfasdff 已提交
3764

3765
getResultSet(keyPrefix: string): Promise&lt;KvStoreResultSet&gt;
A
asfasdff 已提交
3766

G
ge-yafang 已提交
3767
从KVStore数据库中获取具有指定前缀的结果集,使用Promise异步回调。
A
asfasdff 已提交
3768

G
ge-yafang 已提交
3769
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3770

G
ge-yafang 已提交
3771
**参数:**
A
asfasdff 已提交
3772

3773 3774 3775
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| keyPrefix  |string   | 是    |表示要匹配的键前缀。 |
A
asfasdff 已提交
3776

G
ge-yafang 已提交
3777
**返回值:**
A
asfasdff 已提交
3778

3779 3780
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3781
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise对象。返回具有指定前缀的结果集。|
A
asfasdff 已提交
3782

G
ge-yafang 已提交
3783
**示例:**
A
asfasdff 已提交
3784

G
ge-yafang 已提交
3785
```js
G
ge-yafang 已提交
3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796
let kvStore;
try {
    let resultSet;
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
3797 3798
            }
        }
G
ge-yafang 已提交
3799
        entries.push(entry);
A
asfasdff 已提交
3800
    }
G
ge-yafang 已提交
3801 3802 3803 3804 3805 3806
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
    }).catch((err) => {
        console.log('PutBatch putBatch fail ' + JSON.stringify(err));
    });
    kvStore.getResultSet('batch_test_string_key').then((result) => {
G
ge-yafang 已提交
3807
        console.log('GetResult getResultSet succeed.');
G
ge-yafang 已提交
3808 3809
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
3810
        console.log('getResultSet failed: ' + JSON.stringify(err));
G
ge-yafang 已提交
3811 3812 3813 3814 3815 3816 3817 3818 3819 3820
    });
    kvStore.closeResultSet(resultSet).then((err) => {
        console.log('GetResult closeResultSet success');
    }).catch((err) => {
        console.log('closeResultSet fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('GetResult e ' + e);
}
```
A
asfasdff 已提交
3821 3822


3823
### getResultSet<sup>8+</sup>
A
asfasdff 已提交
3824

3825
getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): void
A
asfasdff 已提交
3826

G
ge-yafang 已提交
3827
获取与指定Query对象匹配的KvStoreResultSet对象,使用callback异步回调。
A
asfasdff 已提交
3828

G
ge-yafang 已提交
3829
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3830

G
ge-yafang 已提交
3831
**参数:**
A
asfasdff 已提交
3832

3833 3834 3835
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| query  |Query    | 是    |表示查询对象。             |
G
ge-yafang 已提交
3836
| callback  |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt;   | 是    |回调函数,获取与指定Query对象匹配的KvStoreResultSet对象。 |
A
asfasdff 已提交
3837

G
ge-yafang 已提交
3838
**示例:**
A
asfasdff 已提交
3839

G
ge-yafang 已提交
3840
```js
G
ge-yafang 已提交
3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851
let kvStore;
try {
    let resultSet;
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
3852 3853
            }
        }
G
ge-yafang 已提交
3854
        entries.push(entry);
A
asfasdff 已提交
3855
    }
G
ge-yafang 已提交
3856 3857 3858 3859
    kvStore.putBatch(entries, async function (err, data) {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
W
wangkai 已提交
3860
        kvStore.getResultSet(query, async function (err, result) {
G
ge-yafang 已提交
3861
            console.log('getResultSet succeed.');
G
ge-yafang 已提交
3862 3863 3864 3865 3866 3867 3868
            resultSet = result;
        });
    });
} catch(e) {
    console.log('GetResultSet e ' + e);
}
```
A
asfasdff 已提交
3869 3870


3871
### getResultSet<sup>8+</sup>
A
asfasdff 已提交
3872

3873
getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt;
A
asfasdff 已提交
3874

G
ge-yafang 已提交
3875
获取与指定Query对象匹配的KvStoreResultSet对象,使用Promise异步回调。
A
asfasdff 已提交
3876

G
ge-yafang 已提交
3877
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
3878

G
ge-yafang 已提交
3879
**参数:**
A
asfasdff 已提交
3880

3881 3882
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
Z
zengyawen 已提交
3883
| query  |[Query](#query8)    | 是    |表示查询对象。             |
A
asfasdff 已提交
3884

G
ge-yafang 已提交
3885
**返回值:**
A
asfasdff 已提交
3886

3887 3888
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
3889
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise对象。获取与指定Query对象匹配的KvStoreResultSet对象。|
A
asfasdff 已提交
3890

G
ge-yafang 已提交
3891
**示例:**
A
asfasdff 已提交
3892

G
ge-yafang 已提交
3893
```js
G
ge-yafang 已提交
3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904
let kvStore;
try {
    let resultSet;
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
3905 3906
            }
        }
G
ge-yafang 已提交
3907
        entries.push(entry);
A
asfasdff 已提交
3908
    }
G
ge-yafang 已提交
3909 3910 3911 3912 3913 3914 3915 3916
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
    const query = new distributedData.Query();
    query.prefixKey("batch_test");
    kvStore.getResultSet(query).then((result) => {
G
ge-yafang 已提交
3917
        console.log(' getResultSet succeed.');
G
ge-yafang 已提交
3918 3919
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
3920
        console.log('getResultSet failed: ' + JSON.stringify(err));
G
ge-yafang 已提交
3921 3922 3923 3924 3925
    });
}catch(e) {
    console.log('GetResultSet e ' + e);
}
```
A
asfasdff 已提交
3926

3927
### getResultSet<sup>9+</sup>
W
wangkai 已提交
3928

W
wangkai 已提交
3929
getResultSet(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;KvStoreResultSet&gt;): void
W
wangkai 已提交
3930

3931 3932 3933
获取与指定Predicate对象匹配的KvStoreResultSet对象,使用callback异步回调。

**系统接口:** 此接口为系统接口。
W
wangkai 已提交
3934 3935 3936 3937 3938 3939 3940

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
3941
| predicates  | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates)    | 是    |指示筛选条件,当此参数为null时,应定义处理逻辑。             |
G
ge-yafang 已提交
3942
| callback  |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt;   | 是    |回调函数,获取与指定Predicates对象匹配的KvStoreResultSet对象。 |
W
wangkai 已提交
3943 3944 3945 3946

**示例:**

```js
3947
import dataSharePredicates from '@ohos.data.dataSharePredicates';
W
wangkai 已提交
3948 3949 3950
let kvStore;
try {
    let resultSet;
W
wangkai 已提交
3951
    let predicates = new dataSharePredicates.DataSharePredicates();
W
wangkai 已提交
3952
    predicates.prefixKey("batch_test_string_key");
W
wangkai 已提交
3953
    kvStore.getResultSet(predicates, async function (err, result) {
W
wangkai 已提交
3954 3955
    console.log(' GetResultSet success');
    resultSet = result;
W
wangkai 已提交
3956
    kvStore.closeResultSet(resultSet, function (err, data) {
W
wangkai 已提交
3957 3958 3959 3960 3961 3962 3963
        console.log(' closeResultSet success');
        })
    });
}catch(e) {
    console.log('An unexpected error occurred. Error:' + e);
}
```
3964
### getResultSet<sup>9+</sup>
W
wangkai 已提交
3965

W
wangkai 已提交
3966
getResultSet(predicates: dataSharePredicates.DataSharePredicates): Promise&lt;KvStoreResultSet&gt;
W
wangkai 已提交
3967

3968 3969 3970
获取与指定Predicate对象匹配的KvStoreResultSet对象,使用Promise异步回调。

**系统接口:** 此接口为系统接口。
W
wangkai 已提交
3971 3972 3973 3974 3975 3976 3977

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
3978
| predicates  |[DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates)  | 是    |指示筛选条件,当此参数为null时,应定义处理逻辑。            |
W
wangkai 已提交
3979 3980 3981 3982 3983

**返回值:**

| 类型    | 说明       |
| ------  | -------   |
3984
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |无返回结果的Promise对象。|
W
wangkai 已提交
3985 3986 3987 3988

**示例:**

```js
3989
import dataSharePredicates from '@ohos.data.dataSharePredicates';
W
wangkai 已提交
3990 3991 3992
let kvStore;
try {
	let resultSet;
W
wangkai 已提交
3993
    let predicates =  new dataSharePredicates.DataSharePredicates();
W
wangkai 已提交
3994
    predicates.prefixKey("batch_test_string_key");
W
wangkai 已提交
3995
    kvStore.getResultSet(predicates) .then((result) => {
W
wangkai 已提交
3996 3997
        console.log(' GetResultSet success');
        resultSet = result;
3998
        kvStore.closeResultSet(resultSet, function (err, data) {
W
wangkai 已提交
3999 4000 4001 4002 4003 4004 4005
            console.log(' closeResultSet success');
        })
    });
}catch(e) {
	console.log('An unexpected error occurred. Error:' + e);
}
```
4006
### closeResultSet<sup>8+</sup>
A
asfasdff 已提交
4007

4008
closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
4009

G
ge-yafang 已提交
4010
关闭由[SingleKvStore.getResultSet](#singlekvstore_getresultset)返回的KvStoreResultSet对象,使用callback异步回调。
A
asfasdff 已提交
4011

G
ge-yafang 已提交
4012
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4013

G
ge-yafang 已提交
4014
**参数:**
A
asfasdff 已提交
4015

4016 4017
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
G
ge-yafang 已提交
4018 4019
| resultSet  |[KvStoreResultSet](#kvstoreresultset8)   | 是    |表示要关闭的KvStoreResultSet对象。             |
| callback  |AsyncCallback&lt;void&gt;   | 是    |回调函数。             |
A
asfasdff 已提交
4020

G
ge-yafang 已提交
4021
**示例:**
A
asfasdff 已提交
4022

G
ge-yafang 已提交
4023
```js
G
ge-yafang 已提交
4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037
let kvStore;
try {
    let resultSet = null;
    kvStore.closeResultSet(resultSet, function (err, data) {
        if (err == undefined) {
            console.log('closeResultSet success');
        } else {
            console.log('closeResultSet fail');
        }
    });
}catch(e) {
    console.log('CloseResultSet e ' + e);
}
```
A
asfasdff 已提交
4038 4039


4040
### closeResultSet<sup>8+</sup>
A
asfasdff 已提交
4041

4042
closeResultSet(resultSet: KvStoreResultSet): Promise&lt;void&gt;
A
asfasdff 已提交
4043

G
ge-yafang 已提交
4044
关闭由[SingleKvStore.getResultSet](#singlekvstore_getresultset)返回的KvStoreResultSet对象,使用Promise异步回调。
A
asfasdff 已提交
4045

G
ge-yafang 已提交
4046
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4047

G
ge-yafang 已提交
4048
**参数:**
A
asfasdff 已提交
4049

4050 4051
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
G
ge-yafang 已提交
4052
| resultSet  |[KvStoreResultSet](#kvstoreresultset8)   | 是    |表示要关闭的KvStoreResultSet对象。             |
A
asfasdff 已提交
4053

G
ge-yafang 已提交
4054
**返回值:**
A
asfasdff 已提交
4055

4056 4057
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
4058
|Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
4059

G
ge-yafang 已提交
4060
**示例:**
A
asfasdff 已提交
4061

G
ge-yafang 已提交
4062
```js
G
ge-yafang 已提交
4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074
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) {
    console.log('CloseResultSet e ' + e);
}
```
A
asfasdff 已提交
4075 4076


4077
### getResultSize<sup>8+</sup>
A
asfasdff 已提交
4078

4079
getResultSize(query: Query, callback: AsyncCallback&lt;number&gt;): void
A
asfasdff 已提交
4080

G
ge-yafang 已提交
4081
获取与指定Query对象匹配的结果数,使用callback异步回调。
A
asfasdff 已提交
4082

G
ge-yafang 已提交
4083
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4084

G
ge-yafang 已提交
4085
**参数:**
A
asfasdff 已提交
4086

4087 4088
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
Z
zengyawen 已提交
4089
| query  |[Query](#query8)   | 是    |表示查询对象。         |
G
ge-yafang 已提交
4090
| callback  |AsyncCallback&lt;number&gt;   | 是    |回调函数。返回与指定Query对象匹配的结果数。         |
A
asfasdff 已提交
4091

G
ge-yafang 已提交
4092
**示例:**
A
asfasdff 已提交
4093

G
ge-yafang 已提交
4094
```js
G
ge-yafang 已提交
4095 4096 4097 4098 4099 4100 4101 4102 4103 4104
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
4105 4106
            }
        }
G
ge-yafang 已提交
4107
        entries.push(entry);
A
asfasdff 已提交
4108
    }
G
ge-yafang 已提交
4109 4110 4111 4112
    kvStore.putBatch(entries, async function (err, data) {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
W
wangkai 已提交
4113
        kvStore.getResultSize(query, async function (err, resultSize) {
G
ge-yafang 已提交
4114
            console.log('getResultSet succeed.');
G
ge-yafang 已提交
4115 4116 4117 4118 4119 4120
        });
    });
} catch(e) {
    console.log('GetResultSize e ' + e);
}
```
A
asfasdff 已提交
4121 4122


4123
### getResultSize<sup>8+</sup>
A
asfasdff 已提交
4124

4125
getResultSize(query: Query): Promise&lt;number&gt;
A
asfasdff 已提交
4126

G
ge-yafang 已提交
4127
获取与指定Query对象匹配的结果数,使用Promise异步回调。
A
asfasdff 已提交
4128

G
ge-yafang 已提交
4129
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4130

G
ge-yafang 已提交
4131
**参数:**
A
asfasdff 已提交
4132

4133 4134
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
Z
zengyawen 已提交
4135
| query  |[Query](#query8)   | 是    |表示查询对象。         |
A
asfasdff 已提交
4136

G
ge-yafang 已提交
4137
**返回值:**
A
asfasdff 已提交
4138

4139 4140
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
4141
|Promise&lt;number&gt; |Promise对象。获取与指定Query对象匹配的结果数。|
A
asfasdff 已提交
4142

G
ge-yafang 已提交
4143
**示例:**
A
asfasdff 已提交
4144

G
ge-yafang 已提交
4145
```js
G
ge-yafang 已提交
4146 4147 4148 4149 4150 4151 4152 4153 4154 4155
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
4156 4157
            }
        }
G
ge-yafang 已提交
4158
        entries.push(entry);
A
asfasdff 已提交
4159
    }
G
ge-yafang 已提交
4160 4161 4162 4163 4164 4165 4166 4167
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
    const query = new distributedData.Query();
    query.prefixKey("batch_test");
    kvStore.getResultSize(query).then((resultSize) => {
G
ge-yafang 已提交
4168
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
4169
    }).catch((err) => {
G
ge-yafang 已提交
4170
        console.log('getResultSet failed: ' + JSON.stringify(err));
G
ge-yafang 已提交
4171 4172 4173 4174 4175
    });
}catch(e) {
    console.log('GetResultSize e ' + e);
}
```
A
asfasdff 已提交
4176 4177


4178
### removeDeviceData<sup>8+</sup>
A
asfasdff 已提交
4179

4180
removeDeviceData(deviceId: string, callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
4181

G
ge-yafang 已提交
4182
删除指定设备的数据,使用callback异步回调。
A
asfasdff 已提交
4183

G
ge-yafang 已提交
4184
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4185

G
ge-yafang 已提交
4186
**参数:**
A
asfasdff 已提交
4187

4188 4189 4190 4191
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string   | 是    |表示要删除设备的名称。       |
| callback  |AsyncCallback&lt;void&gt;   | 是    |回调函数。      |
A
asfasdff 已提交
4192

G
ge-yafang 已提交
4193
**示例:**
A
asfasdff 已提交
4194

G
ge-yafang 已提交
4195
```js
G
ge-yafang 已提交
4196 4197 4198 4199 4200 4201 4202
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';
W
wangkai 已提交
4203
        kvStore.removeDeviceData(deviceid, async function (err,data) {
G
ge-yafang 已提交
4204 4205 4206 4207
            if (err == undefined) {
                console.log('removeDeviceData success');
            } else {
                console.log('removeDeviceData fail');
W
wangkai 已提交
4208
                kvStore.get(KEY_TEST_STRING_ELEMENT, async function (err,data) {
G
ge-yafang 已提交
4209 4210 4211
                    console.log('RemoveDeviceData get success');
                });
            }
A
asfasdff 已提交
4212
        });
G
ge-yafang 已提交
4213 4214 4215 4216 4217
    });
}catch(e) {
    console.log('RemoveDeviceData e ' + e);
}
```
A
asfasdff 已提交
4218 4219


4220
### removeDeviceData<sup>8+</sup>
A
asfasdff 已提交
4221

4222
removeDeviceData(deviceId: string): Promise&lt;void&gt;
A
asfasdff 已提交
4223

G
ge-yafang 已提交
4224
删除指定设备的数据,使用Promise异步回调。
A
asfasdff 已提交
4225

G
ge-yafang 已提交
4226
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4227

G
ge-yafang 已提交
4228
**参数:**
A
asfasdff 已提交
4229

4230 4231 4232
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string   | 是    |表示要删除设备的名称。       |
A
asfasdff 已提交
4233

G
ge-yafang 已提交
4234
**返回值:**
A
asfasdff 已提交
4235

4236 4237
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
4238
|Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
4239

G
ge-yafang 已提交
4240
**示例:**
A
asfasdff 已提交
4241

G
ge-yafang 已提交
4242
```js
G
ge-yafang 已提交
4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266
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) => {
        console.log('put fail ' + JSON.stringify(err));
    });
    const deviceid = 'no_exist_device_id';
    kvStore.removeDeviceData(deviceid).then((err) => {
        console.log('removeDeviceData success');
    }).catch((err) => {
        console.log('removeDeviceData fail ' + JSON.stringify(err));
    });
    kvStore.get(KEY_TEST_STRING_ELEMENT).then((data) => {
        console.log('get success data:' + data);
    }).catch((err) => {
        console.log('RemoveDeviceData get fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('RemoveDeviceData e ' + e);
}
```
A
asfasdff 已提交
4267 4268


4269
### on('syncComplete')<sup>8+</sup>
A
asfasdff 已提交
4270

4271
on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt;&gt;): void
A
asfasdff 已提交
4272

4273
订阅同步完成事件回调通知,此方法为同步方法。
A
asfasdff 已提交
4274

G
ge-yafang 已提交
4275
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4276

G
ge-yafang 已提交
4277
**参数:**
A
asfasdff 已提交
4278

4279 4280
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
G
ge-yafang 已提交
4281
| event  |string   | 是    |订阅的事件名,固定为'syncComplete',表示同步完成事件。    |
G
ge-yafang 已提交
4282
| syncCallback  |Callback&lt;Array&lt;[string, number]&gt;&gt;   | 是    |回调函数。用于向调用方发送同步结果的回调。    |
A
asfasdff 已提交
4283

G
ge-yafang 已提交
4284
**示例:**
A
asfasdff 已提交
4285

G
ge-yafang 已提交
4286
```js
G
ge-yafang 已提交
4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302
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)
    });
    kvStore.put(KEY_TEST_FLOAT_ELEMENT, VALUE_TEST_FLOAT_ELEMENT).then((data) => {
        console.log('syncComplete put success');
    }).catch((error) => {
        console.log('syncComplete put fail ' + error);
    });
}catch(e) {
    console.log('syncComplete put e ' + e);
}
```
A
asfasdff 已提交
4303 4304


4305
### off('syncComplete')<sup>8+</sup>
A
asfasdff 已提交
4306

4307
off(event: 'syncComplete', syncCallback?: Callback&lt;Array&lt;[string, number]&gt;&gt;): void
A
asfasdff 已提交
4308

4309
取消订阅同步完成事件回调通知,此方法为同步方法。
A
asfasdff 已提交
4310

G
ge-yafang 已提交
4311
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4312

G
ge-yafang 已提交
4313
**参数:**
A
asfasdff 已提交
4314

4315 4316
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
G
ge-yafang 已提交
4317
| event  |string   | 是    |取消订阅的事件名,固定为'syncComplete',表示同步完成事件。    |
G
ge-yafang 已提交
4318
| syncCallback  |Callback&lt;Array&lt;[string, number]&gt;&gt;   | 否    |回调函数。用于向调用方发送同步结果的回调。    |
4319

G
ge-yafang 已提交
4320
**示例:**
A
asfasdff 已提交
4321

G
ge-yafang 已提交
4322
```js
Z
zuojiangjiang 已提交
4323 4324
let kvStore;
class KvstoreModel {
4325 4326 4327 4328
    call(data) {
        console.log("syncComplete: " + data);
    }
    subscribeSyncComplete() {
Z
zuojiangjiang 已提交
4329 4330
        if (kvStore != null) {
            kvStore.on('syncComplete', this.call);
4331 4332 4333
        }
    }
    unsubscribeSyncComplete() {
Z
zuojiangjiang 已提交
4334 4335
        if (kvStore != null) {
            kvStore.off('syncComplete', this.call);
4336 4337
        }
    }
G
ge-yafang 已提交
4338 4339
}
```
A
asfasdff 已提交
4340

4341
### on('dataChange')<sup>9+</sup>
W
wangkai 已提交
4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366

on(event: 'dataChange', type: SubscribeType, listener: Callback&lt;ChangeNotification&gt;): void

订阅指定类型的数据变更通知,此方法为同步方法。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| event  |string  | 是    |订阅的事件名,固定为'dataChange',表示数据变更事件。       |
| type  |[SubscribeType](#subscribetype) | 是    |表示订阅的类型。     |
| listener |Callback&lt;[ChangeNotification](#changenotification)&gt; | 是    |回调函数。 |

**示例:**

```js
let kvStore;
kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, function (data) {
    console.log("dataChange callback call data: " + JSON.stringify(data));
});

```

4367
### off('dataChange')<sup>9+</sup>
W
wangkai 已提交
4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382

off(event:'dataChange', listener?: Callback&lt;ChangeNotification&gt;): void

取消订阅数据变更通知,此方法为同步方法。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| event  |string  | 是    |取消订阅的事件名,固定为'dataChange',表示数据变更事件。       |
| listener |Callback&lt;[ChangeNotification](#changenotification)&gt; |否    |回调函数。 |

**示例:**
A
asfasdff 已提交
4383

W
wangkai 已提交
4384
```js
Z
zuojiangjiang 已提交
4385 4386
let kvStore;
class KvstoreModel {
4387 4388 4389 4390
    call(data) {
        console.log("dataChange: " + data);
    }
    subscribeDataChange() {
Z
zuojiangjiang 已提交
4391 4392
        if (kvStore != null) {
            kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_REMOTE, this.call);
4393 4394 4395
        }
    }
    unsubscribeDataChange() {
Z
zuojiangjiang 已提交
4396 4397
        if (kvStore != null) {
            kvStore.off('dataChange', this.call);
4398 4399 4400
        }
    }
}
W
wangkai 已提交
4401 4402 4403
```
### sync<sup>7+</sup>

A
asfasdff 已提交
4404

W
wangkai 已提交
4405
sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
Z
zengyawen 已提交
4406

G
ge-yafang 已提交
4407
在手动同步方式下,触发数据库同步。关于分布式数据服务的同步方式说明,请见[分布式数据服务概述](../../database/database-mdds-overview.md)
G
ge-yafang 已提交
4408

Z
zuojiangjiang 已提交
4409
**需要权限**: ohos.permission.DISTRIBUTED_DATASYNC。
Z
zengyawen 已提交
4410

G
ge-yafang 已提交
4411
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4412

G
ge-yafang 已提交
4413
**参数:**
A
asfasdff 已提交
4414

4415 4416
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
W
wangkai 已提交
4417
| deviceIds  |string[]  | 是    |同一组网环境下,需要同步的设备的deviceId列表。    |
G
ge-yafang 已提交
4418
| mode  |[SyncMode](#syncmode)   | 是   |同步模式。    |
W
wangkai 已提交
4419
| delayMs  |number   | 否   |可选参数,允许延时时间,单位:ms(毫秒)。   |
A
asfasdff 已提交
4420

G
ge-yafang 已提交
4421
**示例:**
A
asfasdff 已提交
4422

G
ge-yafang 已提交
4423
```js
G
ge-yafang 已提交
4424 4425 4426
let kvStore;
kvStore.sync('deviceIds', distributedData.SyncMode.PULL_ONLY, 1000);
```
A
asfasdff 已提交
4427

W
wangkai 已提交
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441
### sync<sup>9+</sup>
sync(deviceIds: string[], query: Query, mode: SyncMode, delayMs?: number): void

在手动同步方式下,触发数据库同步,此方法为同步方法。关于分布式数据服务的同步方式说明,请见[分布式数据服务概述](../../database/database-mdds-overview.md)

**需要权限**: ohos.permission.DISTRIBUTED_DATASYNC。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceIds  |string[]  | 是    |同一组网环境下,需要同步的设备的deviceId列表。    |
W
wangkai 已提交
4442
| mode            |[SyncMode](#syncmode)  | 是    |同步模式。  |
G
ge-yafang 已提交
4443
| query  |[Query](#query8)   | 是   |表示数据库的查询谓词条件  |
W
wangkai 已提交
4444 4445 4446 4447 4448
| delayMs  |number   | 否   |可选参数,允许延时时间,单位:ms(毫秒)。   |

**示例:**

```js
4449
let kvStore;
W
wangkai 已提交
4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462
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');
    });
    kvStore.put(KEY_TEST_SYNC_ELEMENT + 'testSync101', VALUE_TEST_SYNC_ELEMENT, function (err,data) {
        console.log('Sync put success');
        const devices = ['deviceList'];
        const mode = distributedData.SyncMode.PULL_ONLY;
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
        query.deviceId('localDeviceId');
W
wangkai 已提交
4463
        kvStore.sync(devices, query, mode , 1000);
W
wangkai 已提交
4464 4465 4466 4467 4468 4469
    });
}catch(e) {
    console.log('Sync e' + e);
}
```

4470
### setSyncParam<sup>8+</sup>
A
asfasdff 已提交
4471

4472
setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
4473

G
ge-yafang 已提交
4474
设置数据库同步允许的默认延迟,使用callback异步回调。
A
asfasdff 已提交
4475

G
ge-yafang 已提交
4476
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4477

G
ge-yafang 已提交
4478
**参数:**
A
asfasdff 已提交
4479

4480 4481 4482 4483 4484
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| defaultAllowedDelayMs  |number  | 是    |表示数据库同步允许的默认延迟,以毫秒为单位。    |
| callback  |AsyncCallback&lt;void&gt;  | 是   |回调函数。   |

G
ge-yafang 已提交
4485
**示例:**
A
asfasdff 已提交
4486

G
ge-yafang 已提交
4487
```js
G
ge-yafang 已提交
4488 4489 4490 4491 4492 4493 4494 4495 4496 4497
let kvStore;
try {
    const defaultAllowedDelayMs = 500;
    kvStore.setSyncParam(defaultAllowedDelayMs, function (err,data) {
        console.log('SetSyncParam put success');
    });
}catch(e) {
    console.log('testSingleKvStoreSetSyncParam e ' + e);
}
```
A
asfasdff 已提交
4498 4499


4500
### setSyncParam<sup>8+</sup>
A
asfasdff 已提交
4501

4502
setSyncParam(defaultAllowedDelayMs: number): Promise&lt;void&gt;
A
asfasdff 已提交
4503

G
ge-yafang 已提交
4504
设置数据库同步允许的默认延迟,使用Promise异步回调。
A
asfasdff 已提交
4505

G
ge-yafang 已提交
4506
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4507

G
ge-yafang 已提交
4508
**参数:**
A
asfasdff 已提交
4509

4510 4511 4512 4513
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| defaultAllowedDelayMs  |number  | 是    |表示数据库同步允许的默认延迟,以毫秒为单位。    |

A
asfasdff 已提交
4514

G
ge-yafang 已提交
4515
**返回值:**
A
asfasdff 已提交
4516

4517 4518
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
4519
|Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
4520

G
ge-yafang 已提交
4521
**示例:**
A
asfasdff 已提交
4522

G
ge-yafang 已提交
4523
```js
G
ge-yafang 已提交
4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535
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) {
    console.log('SetSyncParam e ' + e);
}
```
A
asfasdff 已提交
4536 4537


4538
### getSecurityLevel<sup>8+</sup>
A
asfasdff 已提交
4539

4540
getSecurityLevel(callback: AsyncCallback&lt;SecurityLevel&gt;): void
A
asfasdff 已提交
4541

G
ge-yafang 已提交
4542
获取数据库的安全级别,使用callback异步回调。
A
asfasdff 已提交
4543

G
ge-yafang 已提交
4544
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4545

G
ge-yafang 已提交
4546
**参数:**
A
asfasdff 已提交
4547

4548 4549
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
G
ge-yafang 已提交
4550
| callback  |AsyncCallback&lt;[SecurityLevel](#securitylevel)&gt;  | 是    |回调函数。返回数据库的安全级别。    |
A
asfasdff 已提交
4551

G
ge-yafang 已提交
4552
**示例:**
A
asfasdff 已提交
4553

G
ge-yafang 已提交
4554
```js
G
ge-yafang 已提交
4555 4556 4557 4558 4559 4560
let kvStore;
try {
    kvStore.getSecurityLevel(function (err,data) {
        console.log('getSecurityLevel success');
    });
}catch(e) {
4561
    console.log('GetSecurityLevel e ' + e);
G
ge-yafang 已提交
4562 4563
}
```
A
asfasdff 已提交
4564 4565


4566
### getSecurityLevel<sup>8+</sup>
A
asfasdff 已提交
4567

4568
getSecurityLevel(): Promise&lt;SecurityLevel&gt;
A
asfasdff 已提交
4569

G
ge-yafang 已提交
4570
获取数据库的安全级别,使用Promise异步回调。
A
asfasdff 已提交
4571

G
ge-yafang 已提交
4572
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
4573

G
ge-yafang 已提交
4574
**返回值:**
A
asfasdff 已提交
4575

4576 4577
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
4578
|Promise&lt;[SecurityLevel](#securitylevel)&gt; |Promise对象。返回数据库的安全级别。|
4579

G
ge-yafang 已提交
4580
**示例:**
A
asfasdff 已提交
4581

G
ge-yafang 已提交
4582
```js
G
ge-yafang 已提交
4583 4584 4585 4586 4587 4588 4589 4590
let kvStore;
try {
    kvStore.getSecurityLevel().then((data) => {
        console.log(' getSecurityLevel success');
    }).catch((err) => {
        console.log('getSecurityLevel fail ' + JSON.stringify(err));
    });
}catch(e) {
4591
    console.log('GetSecurityLevel e ' + e);
G
ge-yafang 已提交
4592 4593
}
```
A
asfasdff 已提交
4594 4595


A
asfasdff 已提交
4596
## DeviceKVStore<sup>8+</sup> ##
A
asfasdff 已提交
4597

G
ge-yafang 已提交
4598 4599 4600 4601 4602 4603 4604
设备协同数据库,继承自KVStore,提供查询数据和同步数据的方法。

设备协同数据库,以设备维度对数据进行区分,每台设备仅能写入和修改本设备的数据,其它设备的数据对其是只读的,无法修改其它设备的数据。

比如,可以使用设备协同数据库实现设备间的图片分享,可以查看其他设备的图片,但无法修改和删除其他设备的图片。

在调用DeviceKVStore的方法前,需要先通过[getKVStore](#getkvstore)构建一个DeviceKVStore实例。
A
asfasdff 已提交
4605

4606
### get<sup>8+</sup>
A
asfasdff 已提交
4607

4608
get(deviceId: string, key: string, callback: AsyncCallback&lt;boolean|string|number|Uint8Array&gt;): void
A
asfasdff 已提交
4609

G
ge-yafang 已提交
4610
获取与指定设备ID和key匹配的string值,使用callback异步回调。
A
asfasdff 已提交
4611

G
ge-yafang 已提交
4612
**系统能力:**   SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
4613

G
ge-yafang 已提交
4614
**参数:**
A
asfasdff 已提交
4615

4616 4617 4618
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |标识要查询其数据的设备。    |
G
ge-yafang 已提交
4619
| key       |string  | 是    |表示要查询key值的键。    |
G
ge-yafang 已提交
4620
| callback  |AsyncCallback&lt;boolean\|string\|number\|Uint8Array&gt;  | 是    |回调函数,返回匹配给定条件的字符串值。    |
A
asfasdff 已提交
4621

G
ge-yafang 已提交
4622
**示例:**
A
asfasdff 已提交
4623

G
ge-yafang 已提交
4624
```js
G
ge-yafang 已提交
4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638
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) {
    console.log('get e' + e);
}
```
A
asfasdff 已提交
4639 4640


4641
### get<sup>8+</sup>
A
asfasdff 已提交
4642

4643
get(deviceId: string, key: string): Promise&lt;boolean|string|number|Uint8Array&gt;
A
asfasdff 已提交
4644

G
ge-yafang 已提交
4645
获取与指定设备ID和key匹配的string值,使用Promise异步回调。
A
asfasdff 已提交
4646

G
ge-yafang 已提交
4647
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
4648

G
ge-yafang 已提交
4649
**参数:**
A
asfasdff 已提交
4650

4651 4652 4653
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |标识要查询其数据的设备。    |
G
ge-yafang 已提交
4654
| key       |string  | 是    |表示要查询key值的键。    |
A
asfasdff 已提交
4655

G
ge-yafang 已提交
4656
**返回值:**
A
asfasdff 已提交
4657

4658 4659
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
4660
|Promise&lt;boolean\|string\|number\|Uint8Array&gt; |Promise对象。返回匹配给定条件的字符串值。|
A
asfasdff 已提交
4661

G
ge-yafang 已提交
4662
**示例:**
A
asfasdff 已提交
4663

G
ge-yafang 已提交
4664
```js
G
ge-yafang 已提交
4665 4666 4667 4668 4669 4670 4671 4672 4673 4674
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) => {
            console.log('get success');
        }).catch((err) => {
            console.log('get fail ' + JSON.stringify(err));
A
asfasdff 已提交
4675
        });
G
ge-yafang 已提交
4676 4677 4678 4679 4680 4681 4682
    }).catch((error) => {
        console.log('put error' + error);
    });
} catch (e) {
    console.log('Get e ' + e);
}
```
A
asfasdff 已提交
4683 4684


4685
### getEntries<sup>8+</sup>
A
asfasdff 已提交
4686

4687
getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;Entry[]&gt;): void
A
asfasdff 已提交
4688

G
ge-yafang 已提交
4689
获取与指定设备ID和key前缀匹配的所有键值对,使用callback异步回调。
A
asfasdff 已提交
4690

G
ge-yafang 已提交
4691
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
4692

G
ge-yafang 已提交
4693
**参数:**
A
asfasdff 已提交
4694

4695 4696 4697 4698 4699
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |标识要查询其数据的设备。    |
| keyPrefix |string  | 是    |表示要匹配的键前缀。    |
| callback  |AsyncCallback&lt;[Entry](#entry)[]&gt;  | 是  |回调函数,返回满足给定条件的所有键值对的列表。    |
A
asfasdff 已提交
4700

G
ge-yafang 已提交
4701
**示例:**
A
asfasdff 已提交
4702

G
ge-yafang 已提交
4703
```js
G
ge-yafang 已提交
4704 4705 4706 4707 4708 4709 4710 4711 4712 4713
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
4714 4715
            }
        }
G
ge-yafang 已提交
4716
        entries.push(entry);
A
asfasdff 已提交
4717
    }
G
ge-yafang 已提交
4718 4719 4720
    console.log('entries: ' + entries);
    kvStore.putBatch(entries, async function (err,data) {
        console.log('putBatch success');
4721
        kvStore.getEntries('localDeviceId', 'batch_test_string_key', function (err,entries) {
G
ge-yafang 已提交
4722
            console.log('getEntries success');
4723 4724
            console.log('entries.length: ' + entries.length);
            console.log('entries[0]: ' + JSON.stringify(entries[0]));
G
ge-yafang 已提交
4725 4726 4727 4728 4729 4730
        });
    });
}catch(e) {
    console.log('PutBatch e ' + e);
}
```
A
asfasdff 已提交
4731 4732


4733
### getEntries<sup>8+</sup>
A
asfasdff 已提交
4734

4735
getEntries(deviceId: string, keyPrefix: string): Promise&lt;Entry[]&gt;
A
asfasdff 已提交
4736

G
ge-yafang 已提交
4737
获取与指定设备ID和key前缀匹配的所有键值对,使用Promise异步回调。
A
asfasdff 已提交
4738

G
ge-yafang 已提交
4739
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
4740

G
ge-yafang 已提交
4741
**参数:**
A
asfasdff 已提交
4742

4743 4744 4745 4746
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |标识要查询其数据的设备。    |
| keyPrefix |string  | 是    |表示要匹配的键前缀。    |
A
asfasdff 已提交
4747

G
ge-yafang 已提交
4748
**返回值:**
A
asfasdff 已提交
4749

4750 4751
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
4752
|Promise&lt;[Entry](#entry)[]&gt; |Promise对象。返回匹配给定条件的所有键值对的列表。|
A
asfasdff 已提交
4753

G
ge-yafang 已提交
4754
**示例:**
A
asfasdff 已提交
4755

G
ge-yafang 已提交
4756
```js
G
ge-yafang 已提交
4757 4758 4759 4760 4761 4762 4763 4764 4765 4766
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
4767 4768
            }
        }
G
ge-yafang 已提交
4769 4770 4771 4772 4773
        entries.push(entry);
    }
    console.log('entries: ' + entries);
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
4774
        kvStore.getEntries('localDeviceId', 'batch_test_string_key').then((entries) => {
G
ge-yafang 已提交
4775
            console.log('getEntries success');
4776
            console.log('entries.length: ' + entries.length);
4777
            console.log('entries[0]: ' + JSON.stringify(entries[0]));
4778 4779
            console.log('entries[0].value: ' + JSON.stringify(entries[0].value));
            console.log('entries[0].value.value: ' + entries[0].value.value);
A
asfasdff 已提交
4780
        }).catch((err) => {
G
ge-yafang 已提交
4781
            console.log('getEntries fail ' + JSON.stringify(err));
A
asfasdff 已提交
4782
        });
G
ge-yafang 已提交
4783 4784 4785 4786 4787 4788 4789
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('PutBatch e ' + e);
}
```
A
asfasdff 已提交
4790 4791


4792
### getEntries<sup>8+</sup>
A
asfasdff 已提交
4793

4794
getEntries(query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
A
asfasdff 已提交
4795

G
ge-yafang 已提交
4796
获取与指定Query对象匹配的键值对列表,使用callback异步回调。
A
asfasdff 已提交
4797

G
ge-yafang 已提交
4798
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
4799

G
ge-yafang 已提交
4800
**参数:**
A
asfasdff 已提交
4801

4802 4803
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
Z
zengyawen 已提交
4804
| query  |[Query](#query8)  | 是    |表示查询对象。    |
G
ge-yafang 已提交
4805
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt;  | 是    |回调函数,返回与指定Query对象匹配的键值对列表。    |
A
asfasdff 已提交
4806

G
ge-yafang 已提交
4807
**示例:**
A
asfasdff 已提交
4808

G
ge-yafang 已提交
4809
```js
G
ge-yafang 已提交
4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820
let kvStore;
try {
    var arr = new Uint8Array([21,31]);
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_bool_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.BYTE_ARRAY,
                value : arr
A
asfasdff 已提交
4821 4822
            }
        }
G
ge-yafang 已提交
4823
        entries.push(entry);
A
asfasdff 已提交
4824
    }
G
ge-yafang 已提交
4825 4826 4827 4828 4829 4830
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries, async function (err,data) {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
        query.deviceId('localDeviceId');
4831
        kvStore.getEntries(query, function (err,entries) {
G
ge-yafang 已提交
4832
            console.log('getEntries success');
4833 4834
            console.log('entries.length: ' + entries.length);
            console.log('entries[0]: ' + JSON.stringify(entries[0]));
G
ge-yafang 已提交
4835 4836 4837 4838 4839 4840 4841
        });
    });
    console.log('GetEntries success');
}catch(e) {
    console.log('GetEntries e ' + e);
}
```
A
asfasdff 已提交
4842 4843


4844
### getEntries<sup>8+</sup>
A
asfasdff 已提交
4845

4846
getEntries(query: Query): Promise&lt;Entry[]&gt;
A
asfasdff 已提交
4847

G
ge-yafang 已提交
4848
获取与指定Query对象匹配的键值对列表,使用Promise异步回调。
A
asfasdff 已提交
4849

G
ge-yafang 已提交
4850
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
4851

G
ge-yafang 已提交
4852
**参数:**
A
asfasdff 已提交
4853

4854 4855
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
Z
zengyawen 已提交
4856
| query  |[Query](#query8)  | 是    |表示查询对象。    |
A
asfasdff 已提交
4857

G
ge-yafang 已提交
4858
**返回值:**
A
asfasdff 已提交
4859

4860 4861
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
4862
|Promise&lt;[Entry](#entry)[]&gt; |Promise对象。返回与指定Query对象匹配的键值对列表。|
A
asfasdff 已提交
4863

G
ge-yafang 已提交
4864
**示例:**
A
asfasdff 已提交
4865

G
ge-yafang 已提交
4866
```js
G
ge-yafang 已提交
4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877
let kvStore;
try {
    var arr = new Uint8Array([21,31]);
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_bool_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.BYTE_ARRAY,
                value : arr
A
asfasdff 已提交
4878 4879
            }
        }
G
ge-yafang 已提交
4880 4881 4882 4883 4884 4885 4886
        entries.push(entry);
    }
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
4887
        kvStore.getEntries(query).then((entries) => {
G
ge-yafang 已提交
4888
            console.log('getEntries success');
A
asfasdff 已提交
4889
        }).catch((err) => {
G
ge-yafang 已提交
4890
            console.log('getEntries fail ' + JSON.stringify(err));
A
asfasdff 已提交
4891
        });
G
ge-yafang 已提交
4892 4893 4894 4895 4896 4897 4898 4899
    }).catch((err) => {
        console.log('GetEntries putBatch fail ' + JSON.stringify(err))
    });
    console.log('GetEntries success');
}catch(e) {
    console.log('GetEntries e ' + e);
}
```
A
asfasdff 已提交
4900 4901


4902
### getEntries<sup>8+</sup>
A
asfasdff 已提交
4903

4904
getEntries(deviceId: string, query: Query, callback: AsyncCallback&lt;Entry[]&gt;): void
A
asfasdff 已提交
4905

G
ge-yafang 已提交
4906
获取与指定设备ID和Query对象匹配的键值对列表,使用callback异步回调。
A
asfasdff 已提交
4907

G
ge-yafang 已提交
4908
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
4909

G
ge-yafang 已提交
4910
**参数:**
A
asfasdff 已提交
4911

4912 4913 4914
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |键值对所属的设备ID。    |
Z
zengyawen 已提交
4915
| query  |[Query](#query8)  | 是    |表示查询对象。    |
G
ge-yafang 已提交
4916
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt;  | 是    |回调函数。返回与指定设备ID和Query对象匹配的键值对列表。    |
A
asfasdff 已提交
4917

G
ge-yafang 已提交
4918
**示例:**
A
asfasdff 已提交
4919

G
ge-yafang 已提交
4920
```js
G
ge-yafang 已提交
4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931
let kvStore;
try {
    var arr = new Uint8Array([21,31]);
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_bool_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.BYTE_ARRAY,
                value : arr
A
asfasdff 已提交
4932 4933
            }
        }
G
ge-yafang 已提交
4934
        entries.push(entry);
A
asfasdff 已提交
4935
    }
G
ge-yafang 已提交
4936 4937 4938 4939 4940 4941
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries, async function (err,data) {
        console.log('putBatch success');
        var query = new distributedData.Query();
        query.deviceId('localDeviceId');
        query.prefixKey("batch_test");
4942
        kvStore.getEntries('localDeviceId', query, function (err,entries) {
G
ge-yafang 已提交
4943
            console.log('getEntries success');
4944 4945
            console.log('entries.length: ' + entries.length);
            console.log('entries[0]: ' + JSON.stringify(entries[0]));
G
ge-yafang 已提交
4946 4947 4948 4949 4950 4951 4952
        })
    });
    console.log('GetEntries success');
}catch(e) {
    console.log('GetEntries e ' + e);
}
```
A
asfasdff 已提交
4953 4954


4955
### getEntries<sup>8+</sup>
A
asfasdff 已提交
4956

4957
getEntries(deviceId: string, query: Query): Promise&lt;Entry[]&gt;
A
asfasdff 已提交
4958

G
ge-yafang 已提交
4959
获取与指定设备ID和Query对象匹配的键值对列表,使用Promise异步回调。
A
asfasdff 已提交
4960

G
ge-yafang 已提交
4961
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
4962

G
ge-yafang 已提交
4963
**参数:**
A
asfasdff 已提交
4964

4965 4966 4967
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |键值对所属的设备ID。    |
Z
zengyawen 已提交
4968
| query  |[Query](#query8)  | 是    |表示查询对象。    |
A
asfasdff 已提交
4969

G
ge-yafang 已提交
4970
**返回值:**
A
asfasdff 已提交
4971

4972 4973
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
4974
|Promise&lt;[Entry](#entry)[]&gt; |Promise对象。返回与指定设备ID和Query对象匹配的键值对列表。|
A
asfasdff 已提交
4975

G
ge-yafang 已提交
4976
**示例:**
A
asfasdff 已提交
4977

G
ge-yafang 已提交
4978
```js
G
ge-yafang 已提交
4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989
let kvStore;
try {
    var arr = new Uint8Array([21,31]);
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_bool_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.BYTE_ARRAY,
                value : arr
A
asfasdff 已提交
4990 4991
            }
        }
G
ge-yafang 已提交
4992 4993 4994 4995 4996 4997 4998 4999
        entries.push(entry);
    }
    console.log('entries: ' + JSON.stringify(entries));
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
        var query = new distributedData.Query();
        query.deviceId('localDeviceId');
        query.prefixKey("batch_test");
5000
        kvStore.getEntries('localDeviceId', query).then((entries) => {
G
ge-yafang 已提交
5001
            console.log('getEntries success');
A
asfasdff 已提交
5002
        }).catch((err) => {
G
ge-yafang 已提交
5003
            console.log('getEntries fail ' + JSON.stringify(err));
A
asfasdff 已提交
5004
        });
G
ge-yafang 已提交
5005 5006 5007 5008 5009 5010 5011 5012
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
    console.log('GetEntries success');
}catch(e) {
    console.log('GetEntries e ' + e);
}
```
A
asfasdff 已提交
5013 5014


5015
### getResultSet<sup>8+</sup><a name="devicekvstore_getresultset"></a>
A
asfasdff 已提交
5016

5017
getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;KvStoreResultSet&gt;): void
A
asfasdff 已提交
5018

G
ge-yafang 已提交
5019
获取与指定设备ID和key前缀匹配的KvStoreResultSet对象,使用callback异步回调。
A
asfasdff 已提交
5020

G
ge-yafang 已提交
5021
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5022

G
ge-yafang 已提交
5023
**参数:**
A
asfasdff 已提交
5024

5025 5026 5027 5028
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |标识要查询其数据的设备。    |
| keyPrefix |string  | 是    |表示要匹配的键前缀。    |
G
ge-yafang 已提交
5029
| callback  |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt;  | 是  |回调函数。返回与指定设备ID和key前缀匹配的KvStoreResultSet对象。    |
A
asfasdff 已提交
5030

G
ge-yafang 已提交
5031
**示例:**
A
asfasdff 已提交
5032

G
ge-yafang 已提交
5033
```js
G
ge-yafang 已提交
5034 5035 5036 5037
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('localDeviceId', 'batch_test_string_key', async function (err, result) {
G
ge-yafang 已提交
5038
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
5039
        resultSet = result;
W
wangkai 已提交
5040
        kvStore.closeResultSet(resultSet, function (err, data) {
G
ge-yafang 已提交
5041 5042 5043 5044 5045 5046 5047
            console.log('closeResultSet success');
        })
    });
}catch(e) {
    console.log('GetResultSet e ' + e);
}
```
A
asfasdff 已提交
5048 5049


5050
### getResultSet<sup>8+</sup>
A
asfasdff 已提交
5051

5052
getResultSet(deviceId: string, keyPrefix: string): Promise&lt;KvStoreResultSet&gt;
A
asfasdff 已提交
5053

G
ge-yafang 已提交
5054
获取与指定设备ID和key前缀匹配的KvStoreResultSet对象,使用Promise异步回调。
A
asfasdff 已提交
5055

G
ge-yafang 已提交
5056
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5057

G
ge-yafang 已提交
5058
**参数:**
A
asfasdff 已提交
5059

5060 5061 5062 5063
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |标识要查询其数据的设备。    |
| keyPrefix |string  | 是    |表示要匹配的键前缀。    |
A
asfasdff 已提交
5064

G
ge-yafang 已提交
5065
**返回值:**
A
asfasdff 已提交
5066

5067 5068
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
5069
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; |Promise对象。返回与指定设备ID和key前缀匹配的KvStoreResultSet对象。|
A
asfasdff 已提交
5070

G
ge-yafang 已提交
5071
**示例:**
A
asfasdff 已提交
5072

G
ge-yafang 已提交
5073
```js
G
ge-yafang 已提交
5074 5075 5076 5077
let kvStore;
try {
    let resultSet;
    kvStore.getResultSet('localDeviceId', 'batch_test_string_key').then((result) => {
G
ge-yafang 已提交
5078
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
5079 5080
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
5081
        console.log('getResultSet failed: ' + JSON.stringify(err));
G
ge-yafang 已提交
5082 5083 5084 5085 5086 5087 5088 5089 5090 5091
    });
    kvStore.closeResultSet(resultSet).then((err) => {
        console.log('closeResultSet success');
    }).catch((err) => {
        console.log('closeResultSet fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('GetResultSet e ' + e);
}
```
A
asfasdff 已提交
5092 5093


5094
### getResultSet<sup>8+</sup>
A
asfasdff 已提交
5095

5096
getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): void
A
asfasdff 已提交
5097

G
ge-yafang 已提交
5098
获取与指定Query对象匹配的KvStoreResultSet对象,使用callback异步回调。
A
asfasdff 已提交
5099

G
ge-yafang 已提交
5100
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5101

G
ge-yafang 已提交
5102
**参数:**
A
asfasdff 已提交
5103

5104 5105
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
Z
zengyawen 已提交
5106
| query  |[Query](#query8)  | 是    |表示查询对象。    |
G
ge-yafang 已提交
5107
| callback  |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt;  | 是  |回调函数,返回与指定Query对象匹配的KvStoreResultSet对象。    |
A
asfasdff 已提交
5108

G
ge-yafang 已提交
5109
**示例:**
A
asfasdff 已提交
5110

G
ge-yafang 已提交
5111
```js
G
ge-yafang 已提交
5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122
let kvStore;
try {
    let resultSet;
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
5123 5124
            }
        }
G
ge-yafang 已提交
5125
        entries.push(entry);
A
asfasdff 已提交
5126
    }
G
ge-yafang 已提交
5127 5128 5129 5130 5131
    kvStore.putBatch(entries, async function (err, data) {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
        query.deviceId('localDeviceId');
W
wangkai 已提交
5132
        kvStore.getResultSet(query, async function (err, result) {
G
ge-yafang 已提交
5133
            console.log('getResultSet succeed.');
G
ge-yafang 已提交
5134
            resultSet = result;
W
wangkai 已提交
5135
            kvStore.closeResultSet(resultSet, function (err, data) {
G
ge-yafang 已提交
5136 5137 5138 5139 5140 5141 5142 5143
                console.log('closeResultSet success');
            })
        });
    });
} catch(e) {
    console.log('GetResultSet e ' + e);
}
```
A
asfasdff 已提交
5144 5145


5146
### getResultSet<sup>8+</sup>
A
asfasdff 已提交
5147

5148
getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt;
A
asfasdff 已提交
5149

G
ge-yafang 已提交
5150
获取与指定Query对象匹配的KvStoreResultSet对象,使用Promise异步回调。
A
asfasdff 已提交
5151

G
ge-yafang 已提交
5152
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5153

G
ge-yafang 已提交
5154
**参数:**
A
asfasdff 已提交
5155

5156 5157
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
Z
zengyawen 已提交
5158
| query  |[Query](#query8)  | 是    |表示查询对象。    |
A
asfasdff 已提交
5159

G
ge-yafang 已提交
5160
**返回值:**
A
asfasdff 已提交
5161

5162 5163
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
5164
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; |Promise对象。返回与指定Query对象匹配的KvStoreResultSet对象。|
A
asfasdff 已提交
5165

G
ge-yafang 已提交
5166
**示例:**
A
asfasdff 已提交
5167

G
ge-yafang 已提交
5168
```js
G
ge-yafang 已提交
5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179
let kvStore;
try {
    let resultSet;
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
5180 5181
            }
        }
G
ge-yafang 已提交
5182
        entries.push(entry);
A
asfasdff 已提交
5183
    }
G
ge-yafang 已提交
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
    }).catch((err) => {
        console.log('putBatch fail ' + err);
    });
    const query = new distributedData.Query();
    query.deviceId('localDeviceId');
    query.prefixKey("batch_test");
    console.log("GetResultSet " + query.getSqlLike());
    kvStore.getResultSet(query).then((result) => {
G
ge-yafang 已提交
5194
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
5195 5196
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
5197
        console.log('getResultSet failed: ' + JSON.stringify(err));
G
ge-yafang 已提交
5198 5199 5200 5201 5202 5203 5204 5205 5206 5207
    });
    kvStore.closeResultSet(resultSet).then((err) => {
        console.log('closeResultSet success');
    }).catch((err) => {
        console.log('closeResultSet fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('GetResultSet e ' + e);
}
```
A
asfasdff 已提交
5208 5209


5210
### getResultSet<sup>8+</sup>
A
asfasdff 已提交
5211

5212
getResultSet(deviceId: string, query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): void
A
asfasdff 已提交
5213

G
ge-yafang 已提交
5214
获取与指定设备ID和Query对象匹配的KvStoreResultSet对象,使用callback异步回调。
A
asfasdff 已提交
5215

G
ge-yafang 已提交
5216
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5217

G
ge-yafang 已提交
5218
**参数:**
A
asfasdff 已提交
5219

5220 5221 5222
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |KvStoreResultSet对象所属的设备ID。    |
Z
zengyawen 已提交
5223
| query  |[Query](#query8)  | 是    |表示查询对象。    |
G
ge-yafang 已提交
5224
| callback  |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt;  | 是  |回调函数。返回与指定设备ID和Query对象匹配的KvStoreResultSet对象。    |
A
asfasdff 已提交
5225

G
ge-yafang 已提交
5226
**示例:**
A
asfasdff 已提交
5227

G
ge-yafang 已提交
5228
```js
G
ge-yafang 已提交
5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239
let kvStore;
try {
    let resultSet;
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
5240 5241
            }
        }
G
ge-yafang 已提交
5242
        entries.push(entry);
A
asfasdff 已提交
5243
    }
G
ge-yafang 已提交
5244 5245 5246 5247
    kvStore.putBatch(entries, async function (err, data) {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
W
wangkai 已提交
5248
        kvStore.getResultSet('localDeviceId', query, async function (err, result) {
G
ge-yafang 已提交
5249
            console.log('getResultSet succeed.');
G
ge-yafang 已提交
5250
            resultSet = result;
W
wangkai 已提交
5251
            kvStore.closeResultSet(resultSet, function (err, data) {
G
ge-yafang 已提交
5252 5253 5254 5255 5256 5257 5258 5259
                console.log('closeResultSet success');
            })
        });
    });
} catch(e) {
    console.log('GetResultSet e ' + e);
}
```
A
asfasdff 已提交
5260 5261


5262
### getResultSet<sup>8+</sup>
A
asfasdff 已提交
5263

5264
getResultSet(deviceId: string, query: Query): Promise&lt;KvStoreResultSet&gt;
A
asfasdff 已提交
5265

G
ge-yafang 已提交
5266
获取与指定设备ID和Query对象匹配的KvStoreResultSet对象,使用Promise异步回调。
A
asfasdff 已提交
5267

G
ge-yafang 已提交
5268
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5269

G
ge-yafang 已提交
5270
**参数:**
A
asfasdff 已提交
5271

5272 5273 5274
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |KvStoreResultSet对象所属的设备ID。    |
Z
zengyawen 已提交
5275
| query  |[Query](#query8)  | 是    |表示查询对象。    |
A
asfasdff 已提交
5276

G
ge-yafang 已提交
5277
**返回值:**
A
asfasdff 已提交
5278

5279 5280
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
5281
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; |Promise对象。返回与指定设备ID和Query对象匹配的KvStoreResultSet对象。|
A
asfasdff 已提交
5282

G
ge-yafang 已提交
5283
**示例:**
A
asfasdff 已提交
5284

G
ge-yafang 已提交
5285
```js
G
ge-yafang 已提交
5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296
let kvStore;
try {
    let resultSet;
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
5297 5298
            }
        }
G
ge-yafang 已提交
5299
        entries.push(entry);
A
asfasdff 已提交
5300
    }
G
ge-yafang 已提交
5301 5302 5303 5304 5305 5306 5307 5308
    kvStore.putBatch(entries).then(async (err) => {
        console.log('GetResultSet putBatch success');
    }).catch((err) => {
        console.log('PutBatch putBatch fail ' + JSON.stringify(err));
    });
    const query = new distributedData.Query();
    query.prefixKey("batch_test");
    kvStore.getResultSet('localDeviceId', query).then((result) => {
G
ge-yafang 已提交
5309
        console.log('GetResultSet getResultSet succeed.');
G
ge-yafang 已提交
5310 5311
        resultSet = result;
    }).catch((err) => {
G
ge-yafang 已提交
5312
        console.log('GetResultSet getResultSet failed: ' + JSON.stringify(err));
G
ge-yafang 已提交
5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325
    });
    query.deviceId('localDeviceId');
    console.log("GetResultSet " + query.getSqlLike());
    kvStore.closeResultSet(resultSet).then((err) => {
        console.log('GetResultSet closeResultSet success');
    }).catch((err) => {
        console.log('GetResultSet closeResultSet fail ' + JSON.stringify(err));
    });

}catch(e) {
    console.log('GetResultSet e ' + e);
}
```
A
asfasdff 已提交
5326 5327


5328
### closeResultSet<sup>8+</sup>
A
asfasdff 已提交
5329

5330
closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
5331

G
ge-yafang 已提交
5332
关闭由[DeviceKVStore.getResultSet](#devicekvstore_getresultset)返回的KvStoreResultSet对象,使用callback异步回调。
A
asfasdff 已提交
5333

G
ge-yafang 已提交
5334
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5335

G
ge-yafang 已提交
5336
**参数:**
A
asfasdff 已提交
5337

5338 5339
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
G
ge-yafang 已提交
5340
| resultSet  |[KvStoreResultSet](#getresultset8)  | 是    |指示要关闭的KvStoreResultSet对象。   |
5341
| callback   |AsyncCallback&lt;void&gt;                 | 是    |回调函数。    |
A
asfasdff 已提交
5342

G
ge-yafang 已提交
5343
**示例:**
A
asfasdff 已提交
5344

G
ge-yafang 已提交
5345
```js
G
ge-yafang 已提交
5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360
let kvStore;
try {
    console.log('CloseResultSet success');
    let resultSet = null;
    kvStore.closeResultSet(resultSet, function (err, data) {
        if (err == undefined) {
            console.log('closeResultSet success');
        } else {
            console.log('closeResultSet fail');
        }
    });
}catch(e) {
    console.log('CloseResultSet e ' + e);
}
```
A
asfasdff 已提交
5361 5362


5363
### closeResultSet<sup>8+</sup>
A
asfasdff 已提交
5364

5365
closeResultSet(resultSet: KvStoreResultSet): Promise&lt;void&gt;
A
asfasdff 已提交
5366

G
ge-yafang 已提交
5367
关闭由[DeviceKVStore.getResultSet](#devicekvstore_getresultset)返回的KvStoreResultSet对象,使用Promise异步回调。
A
asfasdff 已提交
5368

G
ge-yafang 已提交
5369
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5370

G
ge-yafang 已提交
5371
**参数:**
A
asfasdff 已提交
5372

5373 5374
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
G
ge-yafang 已提交
5375
| resultSet  |[KvStoreResultSet](#getresultset8)  | 是    |指示要关闭的KvStoreResultSet对象。   |
A
asfasdff 已提交
5376

G
ge-yafang 已提交
5377
**返回值:**
A
asfasdff 已提交
5378

5379 5380
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
5381
|Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
5382

G
ge-yafang 已提交
5383
**示例:**
A
asfasdff 已提交
5384

G
ge-yafang 已提交
5385
```js
G
ge-yafang 已提交
5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398
let kvStore;
try {
    console.log('CloseResultSet success');
    let resultSet = null;
    kvStore.closeResultSet(resultSet).then(() => {
        console.log('closeResultSet success');
    }).catch((err) => {
        console.log('closeResultSet fail ' + JSON.stringify(err));
    });
}catch(e) {
    console.log('CloseResultSet e ' + e);
}
```
A
asfasdff 已提交
5399 5400


5401
### getResultSize<sup>8+</sup>
A
asfasdff 已提交
5402

5403
getResultSize(query: Query, callback: AsyncCallback&lt;number&gt;): void
A
asfasdff 已提交
5404

G
ge-yafang 已提交
5405
获取与指定Query对象匹配的结果数,使用callback异步回调。
A
asfasdff 已提交
5406

G
ge-yafang 已提交
5407
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5408

G
ge-yafang 已提交
5409
**参数:**
A
asfasdff 已提交
5410

5411 5412
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
Z
zengyawen 已提交
5413
| query     |[Query](#query8)       | 是    |表示查询对象。    |
G
ge-yafang 已提交
5414
| callback  |AsyncCallback&lt;number&gt;  | 是    |回调函数,返回与指定Query对象匹配的结果数。    |
A
asfasdff 已提交
5415

G
ge-yafang 已提交
5416
**示例:**
A
asfasdff 已提交
5417

G
ge-yafang 已提交
5418
```js
G
ge-yafang 已提交
5419 5420 5421 5422 5423 5424 5425 5426 5427 5428
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
5429 5430
            }
        }
G
ge-yafang 已提交
5431
        entries.push(entry);
A
asfasdff 已提交
5432
    }
G
ge-yafang 已提交
5433 5434 5435 5436 5437
    kvStore.putBatch(entries, async function (err, data) {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
        query.deviceId('localDeviceId');
W
wangkai 已提交
5438
        kvStore.getResultSize(query, async function (err, resultSize) {
G
ge-yafang 已提交
5439
            console.log('getResultSet succeed.');
G
ge-yafang 已提交
5440 5441 5442 5443 5444 5445
        });
    });
} catch(e) {
    console.log('GetResultSize e ' + e);
}
```
A
asfasdff 已提交
5446 5447


5448
### getResultSize<sup>8+</sup>
A
asfasdff 已提交
5449

5450
getResultSize(query: Query): Promise&lt;number&gt;
A
asfasdff 已提交
5451

G
ge-yafang 已提交
5452
获取与指定Query对象匹配的结果数,使用Promise异步回调。
A
asfasdff 已提交
5453

G
ge-yafang 已提交
5454
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5455

G
ge-yafang 已提交
5456
**参数:**
A
asfasdff 已提交
5457

5458 5459
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
Z
zengyawen 已提交
5460
| query     |[Query](#query8)       | 是    |表示查询对象。    |
A
asfasdff 已提交
5461

G
ge-yafang 已提交
5462
**返回值:**
A
asfasdff 已提交
5463

5464 5465
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
5466
|Promise&lt;number&gt; |Promise对象。返回与指定Query对象匹配的结果数。|
A
asfasdff 已提交
5467

G
ge-yafang 已提交
5468
**示例:**
A
asfasdff 已提交
5469

G
ge-yafang 已提交
5470
```js
G
ge-yafang 已提交
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
5481 5482
            }
        }
G
ge-yafang 已提交
5483
        entries.push(entry);
A
asfasdff 已提交
5484
    }
G
ge-yafang 已提交
5485 5486 5487 5488 5489 5490 5491 5492 5493
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
    const query = new distributedData.Query();
    query.prefixKey("batch_test");
    query.deviceId('localDeviceId');
    kvStore.getResultSize(query).then((resultSize) => {
G
ge-yafang 已提交
5494
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
5495
    }).catch((err) => {
G
ge-yafang 已提交
5496
        console.log('getResultSet failed: ' + JSON.stringify(err));
G
ge-yafang 已提交
5497 5498 5499 5500 5501
    });
}catch(e) {
    console.log('GetResultSize e ' + e);
}
```
A
asfasdff 已提交
5502 5503


5504
### getResultSize<sup>8+</sup>
A
asfasdff 已提交
5505

A
asfasdff 已提交
5506
getResultSize(deviceId: string, query: Query, callback: AsyncCallback&lt;number&gt;): void;
A
asfasdff 已提交
5507

G
ge-yafang 已提交
5508
获取与指定设备ID和Query对象匹配的结果数,使用callback异步回调。
A
asfasdff 已提交
5509

G
ge-yafang 已提交
5510
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5511

G
ge-yafang 已提交
5512
**参数:**
A
asfasdff 已提交
5513

5514 5515 5516
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string                       | 是    |KvStoreResultSet对象所属的设备ID。    |
Z
zengyawen 已提交
5517
| query     |[Query](#query8)       | 是    |表示查询对象。    |
G
ge-yafang 已提交
5518
| callback  |AsyncCallback&lt;number&gt;  | 是    |回调函数。返回与指定设备ID和Query对象匹配的结果数。    |
A
asfasdff 已提交
5519

G
ge-yafang 已提交
5520
**示例:**
A
asfasdff 已提交
5521

G
ge-yafang 已提交
5522
```js
G
ge-yafang 已提交
5523 5524 5525 5526 5527 5528 5529 5530 5531 5532
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
5533 5534
            }
        }
G
ge-yafang 已提交
5535
        entries.push(entry);
A
asfasdff 已提交
5536
    }
G
ge-yafang 已提交
5537 5538 5539 5540
    kvStore.putBatch(entries, async function (err, data) {
        console.log('putBatch success');
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
W
wangkai 已提交
5541
        kvStore.getResultSize('localDeviceId', query, async function (err, resultSize) {
G
ge-yafang 已提交
5542
            console.log('getResultSet succeed.');
G
ge-yafang 已提交
5543 5544 5545 5546 5547 5548
        });
    });
} catch(e) {
    console.log('GetResultSize e ' + e);
}
```
A
asfasdff 已提交
5549 5550


5551
### getResultSize<sup>8+</sup>
A
asfasdff 已提交
5552

5553
getResultSize(deviceId: string, query: Query): Promise&lt;number&gt;
A
asfasdff 已提交
5554

G
ge-yafang 已提交
5555
获取与指定设备ID和Query对象匹配的结果数,使用Promise异步回调。
A
asfasdff 已提交
5556

G
ge-yafang 已提交
5557
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5558

G
ge-yafang 已提交
5559
**参数:**
A
asfasdff 已提交
5560

5561 5562 5563
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string                       | 是    |KvStoreResultSet对象所属的设备ID。    |
Z
zengyawen 已提交
5564
| query     |[Query](#query8)       | 是    |表示查询对象。    |
A
asfasdff 已提交
5565

G
ge-yafang 已提交
5566
**返回值:**
A
asfasdff 已提交
5567

5568 5569
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
5570
|Promise&lt;number&gt; |Promise对象。返回与指定设备ID和Query对象匹配的结果数。|
A
asfasdff 已提交
5571

G
ge-yafang 已提交
5572
**示例:**
A
asfasdff 已提交
5573

G
ge-yafang 已提交
5574
```js
G
ge-yafang 已提交
5575 5576 5577 5578 5579 5580 5581 5582 5583 5584
let kvStore;
try {
    let entries = [];
    for (var i = 0; i < 10; i++) {
        var key = 'batch_test_string_key';
        var entry = {
            key : key + i,
            value : {
                type : distributedData.ValueType.STRING,
                value : 'batch_test_string_value'
A
asfasdff 已提交
5585 5586
            }
        }
G
ge-yafang 已提交
5587
        entries.push(entry);
A
asfasdff 已提交
5588
    }
G
ge-yafang 已提交
5589 5590 5591 5592 5593 5594 5595 5596
    kvStore.putBatch(entries).then(async (err) => {
        console.log('putBatch success');
    }).catch((err) => {
        console.log('putBatch fail ' + JSON.stringify(err));
    });
    var query = new distributedData.Query();
    query.prefixKey("batch_test");
    kvStore.getResultSize('localDeviceId', query).then((resultSize) => {
G
ge-yafang 已提交
5597
        console.log('getResultSet succeed.');
G
ge-yafang 已提交
5598
    }).catch((err) => {
G
ge-yafang 已提交
5599
        console.log('getResultSet failed: ' + JSON.stringify(err));
G
ge-yafang 已提交
5600 5601 5602 5603 5604
    });
}catch(e) {
    console.log('GetResultSize e ' + e);
}
```
A
asfasdff 已提交
5605 5606


5607
### removeDeviceData<sup>8+</sup>
A
asfasdff 已提交
5608

5609
removeDeviceData(deviceId: string, callback: AsyncCallback&lt;void&gt;): void
A
asfasdff 已提交
5610

G
ge-yafang 已提交
5611
从当前数据库中删除指定设备的数据,使用callback异步回调。
A
asfasdff 已提交
5612

G
ge-yafang 已提交
5613
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5614

G
ge-yafang 已提交
5615
**参数:**
A
asfasdff 已提交
5616

5617 5618 5619 5620
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string                       | 是    |标识要删除其数据的设备。  |
| callback  |AsyncCallback&lt;void&gt;    | 是    |回调函数。    |
A
asfasdff 已提交
5621

G
ge-yafang 已提交
5622
**示例:**
A
asfasdff 已提交
5623

G
ge-yafang 已提交
5624
```js
G
ge-yafang 已提交
5625 5626 5627 5628 5629 5630 5631
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';
W
wangkai 已提交
5632
        kvStore.removeDeviceData(deviceid, async function (err,data) {
G
ge-yafang 已提交
5633 5634 5635 5636
            if (err == undefined) {
                console.log('removeDeviceData success');
            } else {
                console.log('removeDeviceData fail');
W
wangkai 已提交
5637
                kvStore.get('localDeviceId', KEY_TEST_STRING_ELEMENT, async function (err,data) {
G
ge-yafang 已提交
5638 5639 5640
                    console.log('RemoveDeviceData get success');
                });
            }
A
asfasdff 已提交
5641
        });
G
ge-yafang 已提交
5642 5643 5644 5645 5646
    });
}catch(e) {
    console.log('RemoveDeviceData e ' + e);
}
```
A
asfasdff 已提交
5647 5648


5649
### removeDeviceData<sup>8+</sup>
A
asfasdff 已提交
5650

5651
removeDeviceData(deviceId: string): Promise&lt;void&gt;
A
asfasdff 已提交
5652

G
ge-yafang 已提交
5653
从当前数据库中删除指定设备的数据,使用Promise异步回调。
A
asfasdff 已提交
5654

G
ge-yafang 已提交
5655
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
5656

G
ge-yafang 已提交
5657
**参数:**
A
asfasdff 已提交
5658

5659 5660 5661
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceId  |string  | 是    |标识要删除其数据的设备。  |
A
asfasdff 已提交
5662

G
ge-yafang 已提交
5663
**返回值:**
A
asfasdff 已提交
5664

5665 5666
| 类型    | 说明       |
| ------  | -------   |
G
ge-yafang 已提交
5667
|Promise&lt;void&gt; |无返回结果的Promise对象。|
A
asfasdff 已提交
5668

G
ge-yafang 已提交
5669
**示例:**
A
asfasdff 已提交
5670

G
ge-yafang 已提交
5671
```js
G
ge-yafang 已提交
5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695
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) => {
        console.log('RemoveDeviceData put fail ' + JSON.stringify(err));
    });
    const deviceid = 'no_exist_device_id';
    kvStore.removeDeviceData(deviceid).then((err) => {
        console.log('removeDeviceData success');
    }).catch((err) => {
        console.log('removeDeviceData fail ' + JSON.stringify(err));
    });
    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));
    });
}catch(e) {
    console.log('RemoveDeviceData e ' + e);
}
```
A
asfasdff 已提交
5696 5697


5698
### sync<sup>8+</sup>
A
asfasdff 已提交
5699

W
wangkai 已提交
5700
sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
A
asfasdff 已提交
5701

G
ge-yafang 已提交
5702
在手动同步方式下,触发数据库同步。关于分布式数据服务的同步方式说明,请见[分布式数据服务概述](../../database/database-mdds-overview.md)
G
ge-yafang 已提交
5703

Z
zuojiangjiang 已提交
5704
**需要权限**: ohos.permission.DISTRIBUTED_DATASYNC。
A
asfasdff 已提交
5705

G
ge-yafang 已提交
5706
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
5707

G
ge-yafang 已提交
5708
**参数:**
A
asfasdff 已提交
5709

5710 5711
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
W
wangkai 已提交
5712
| deviceIds    |string[]               | 是    |需要同步DeviceKvStore数据库的设备ID列表。 |
G
ge-yafang 已提交
5713
| mode            |[SyncMode](#syncmode)  | 是    |同步模式。  |
W
wangkai 已提交
5714
| delayMs  |number                 | 否    |可选参数,允许延时时间,单位:ms(毫秒)。  |
5715

G
ge-yafang 已提交
5716
**示例:**
A
asfasdff 已提交
5717

G
ge-yafang 已提交
5718
```js
G
ge-yafang 已提交
5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735
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');
    });
    kvStore.put(KEY_TEST_SYNC_ELEMENT + 'testSync101', VALUE_TEST_SYNC_ELEMENT, function (err,data) {
        console.log('Sync put success');
        const devices = ['deviceList'];
        const mode = distributedData.SyncMode.PULL_ONLY;
        kvStore.sync(devices, mode);
    });
}catch(e) {
    console.log('Sync e' + e);
}
```
A
asfasdff 已提交
5736

5737
### sync<sup>9+</sup>
W
wangkai 已提交
5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751

sync(deviceIds: string[], query: Query, mode: SyncMode, delayMs?: number): void

在手动同步方式下, 触发数据库同步,此方法为同步方法。关于分布式数据服务的同步方式说明,请见[分布式数据服务概述](../../database/database-mdds-overview.md)

**需要权限**: ohos.permission.DISTRIBUTED_DATASYNC。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
| deviceIds    |string[]               | 是    |需要同步DeviceKvStore数据库的设备ID列表。 |
W
wangkai 已提交
5752
| query            |[Query](#query8)  | 是    | 数据库的查询谓词条件。|
W
wangkai 已提交
5753 5754 5755 5756 5757
| delayMs  |number                 | 否    |可选参数,允许延时时间,单位:ms(毫秒)。  |

**示例:**

```js
5758
let kvStore;
W
wangkai 已提交
5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778
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');
    });
    kvStore.put(KEY_TEST_SYNC_ELEMENT + 'testSync101', VALUE_TEST_SYNC_ELEMENT, function (err,data) {
        console.log('Sync put success');
        const devices = ['deviceList'];
        const mode = distributedData.SyncMode.PULL_ONLY;
        const query = new distributedData.Query();
        query.prefixKey("batch_test");
        query.deviceId('localDeviceId');
        kvStore.sync(devices, query, 1000);
    });
}catch(e) {
    console.log('Sync e' + e);
}
```

5779
### on('syncComplete')<sup>8+</sup>
A
asfasdff 已提交
5780

Z
zengyawen 已提交
5781
on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string, number]&gt;&gt;): void
A
asfasdff 已提交
5782

5783
订阅同步完成事件回调通知,此方法为同步方法。
A
asfasdff 已提交
5784

G
ge-yafang 已提交
5785
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
5786

G
ge-yafang 已提交
5787
**参数:**
A
asfasdff 已提交
5788

5789 5790
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
G
ge-yafang 已提交
5791
| event    |string      | 是    |订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
G
ge-yafang 已提交
5792
| syncCallback            |Callback<Array&lt;[string, number]&gt;> | 是    |回调函数。用于向调用方发送同步结果的回调。  |
A
asfasdff 已提交
5793

G
ge-yafang 已提交
5794
**示例:**
Z
zengyawen 已提交
5795

G
ge-yafang 已提交
5796
```js
W
wangkai 已提交
5797
let kvStore;
G
ge-yafang 已提交
5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812
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)
    });
    kvStore.put(KEY_TEST_FLOAT_ELEMENT, VALUE_TEST_FLOAT_ELEMENT).then((data) => {
        console.log('syncComplete put success');
    }).catch((error) => {
        console.log('syncComplete put fail ' + error);
    });
}catch(e) {
    console.log('syncComplete put e ' + e);
}
```
A
asfasdff 已提交
5813 5814


5815
### off('syncComplete')<sup>8+</sup>
A
asfasdff 已提交
5816

5817
off(event: 'syncComplete', syncCallback?: Callback&lt;Array&lt;[string, number]&gt;&gt;): void
A
asfasdff 已提交
5818

5819
取消订阅同步完成事件回调通知,此方法为同步方法。
A
asfasdff 已提交
5820

G
ge-yafang 已提交
5821
**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core
5822

G
ge-yafang 已提交
5823
**参数:**
A
asfasdff 已提交
5824

5825 5826
| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------   | ----  | ----------------------- |
G
ge-yafang 已提交
5827
| event         |string                           | 是    |取消订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
G
ge-yafang 已提交
5828
| syncCallback  |Callback<Array&lt;[string, number]&gt;&gt; | 否    |回调函数。用于向调用方发送同步结果的回调。  |
5829

G
ge-yafang 已提交
5830
**示例:**
A
asfasdff 已提交
5831

G
ge-yafang 已提交
5832
```js
Z
zuojiangjiang 已提交
5833 5834
let kvStore;
class KvstoreModel {
5835 5836 5837 5838
    call(data) {
        console.log("syncComplete: " + data);
    }
    subscribeSyncComplete() {
Z
zuojiangjiang 已提交
5839 5840
        if (kvStore != null) {
            kvStore.on('syncComplete', this.call);
5841 5842 5843
        }
    }
    unsubscribeSyncComplete() {
Z
zuojiangjiang 已提交
5844 5845
        if (kvStore != null) {
            kvStore.off('syncComplete', this.call);
5846 5847
        }
    }
G
ge-yafang 已提交
5848 5849
}
```
A
asfasdff 已提交
5850

5851
### on('dataChange')<sup>9+</sup>
W
wangkai 已提交
5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876

on(event: 'dataChange', type: SubscribeType, listener: Callback&lt;ChangeNotification&gt;): void

订阅指定类型的数据变更通知,此方法为同步方法。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| event  |string  | 是    |订阅的事件名,固定为'dataChange',表示数据变更事件。       |
| type  |[SubscribeType](#subscribetype) | 是    |表示订阅的类型。     |
| listener |Callback&lt;[ChangeNotification](#changenotification)&gt; | 是    |回调函数。 |

**示例:**

```js
let kvStore;
kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, function (data) {
    console.log("dataChange callback call data: " + JSON.stringify(data));
});
```


5877
### off('dataChange')<sup>9+</sup>
W
wangkai 已提交
5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894

off(event:'dataChange', listener?: Callback&lt;ChangeNotification&gt;): void

取消订阅数据变更通知,此方法为同步方法。

**系统能力:**  SystemCapability.DistributedDataManager.KVStore.Core

**参数:**

| 参数名  | 参数类型 | 必填  | 说明                    |
| -----  | ------  | ----  | ----------------------- |
| event  |string  | 是    |取消订阅的事件名,固定为'dataChange',表示数据变更事件。       |
| listener |Callback&lt;[ChangeNotification](#changenotification)&gt; |否    |回调函数。 |

**示例:**

```js
Z
zuojiangjiang 已提交
5895 5896
let kvStore;
class KvstoreModel {
5897 5898 5899 5900
    call(data) {
        console.log("dataChange: " + data);
    }
    subscribeDataChange() {
Z
zuojiangjiang 已提交
5901 5902
        if (kvStore != null) {
            kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_REMOTE, this.call);
5903 5904 5905
        }
    }
    unsubscribeDataChange() {
Z
zuojiangjiang 已提交
5906 5907
        if (kvStore != null) {
            kvStore.off('dataChange', this.call);
5908 5909 5910
        }
    }
}
W
wangkai 已提交
5911 5912
```

5913
## SyncMode
Z
zengyawen 已提交
5914

G
ge-yafang 已提交
5915
同步模式枚举。
Z
zengyawen 已提交
5916

G
ge-yafang 已提交
5917
**系统能力:** SystemCapability.DistributedDataManager.KVStore.Core
5918

G
ge-yafang 已提交
5919
| 名称       | 值     | 说明                    |
5920 5921
| -----      | ------    | ----------------------- |
| PULL_ONLY  |0          |表示只能从远端拉取数据到本端。 |
G
ge-yafang 已提交
5922
| PUSH_ONLY  |1          |表示只能从本端推送数据到远端。 |
5923
| PUSH_PULL  |2          |表示从本端推送数据到远端,然后从远端拉取数据到本端。 |