js-apis-data-rdb.md 72.4 KB
Newer Older
1 2 3
# @ohos.data.rdb<sup>(deprecated)</sup> (关系型数据库)

从API version 9开始,本模块被@ohos.data.relationalStore代替。
Z
zengyawen 已提交
4

W
wuyongning 已提交
5 6
关系型数据库(Relational Database,RDB)是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制,对外提供了一系列的增、删、改、查等接口,也可以直接运行用户输入的SQL语句来满足复杂的场景需要。

W
wuyongning 已提交
7
该模块提供以下关系型数据库相关的常用功能:
W
wuyongning 已提交
8

9 10
- [RdbPredicates](#rdbpredicatesdeprecated): 数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项,主要用来定义数据库的操作条件。
- [RdbStore](#rdbstoredeprecated):提供管理关系数据库(RDB)方法的接口。
W
wuyongning 已提交
11

G
ge-yafang 已提交
12
> **说明:**
13
> 
Z
zengyawen 已提交
14
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
15 16
>
>从API version 9开始,本模块被@ohos.data.relationalStore代替。
Z
zengyawen 已提交
17

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

G
ge-yafang 已提交
20
```js
G
ge-yafang 已提交
21
import data_rdb from '@ohos.data.rdb';
Z
zengyawen 已提交
22
```
L
lihuihui 已提交
23
## data_rdb.getRdbStore<sup>(deprecated)</sup>
Z
zengyawen 已提交
24

W
wuyongning 已提交
25 26
getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback&lt;RdbStore&gt;): void

W
wangxiyue 已提交
27
获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,使用callback异步回调。
W
wuyongning 已提交
28

L
lihuihui 已提交
29 30
> **说明:**
>
31
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.getRdbStore](js-apis-data-relationalStore.md#data_rdbgetrdbstore9)替代。
L
lihuihui 已提交
32 33

**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
34

P
PaDaBoo 已提交
35
**参数:**
W
wuyongning 已提交
36

L
lihuihui 已提交
37 38
| 参数名   | 类型                                       | 必填 | 说明                                                         |
| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ |
Z
zhongjianfei 已提交
39
| context  | Context                                    | 是   | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
L
lihuihui 已提交
40
| config   | [StoreConfig](#storeconfig)                | 是   | 与此RDB存储相关的数据库配置。                                |
41
| version  | number                                     | 是   | 数据库版本。<br>目前暂不支持通过version自动识别数据库升级降级操作,只能由开发者自行维护。                                                 |
L
lihuihui 已提交
42
| callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | 是   | 指定callback回调函数,返回RdbStore对象。                     |
W
wuyongning 已提交
43

P
PaDaBoo 已提交
44
**示例:**
W
wuyongning 已提交
45

46 47
FA模型示例:

W
wuyongning 已提交
48
```js
49 50
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
L
lihuihui 已提交
51
let context = featureAbility.getContext()
52 53

// 获取context后调用getRdbStore
W
wuyongning 已提交
54
const STORE_CONFIG = { name: "RdbTest.db"}
55
data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
P
PaDaBoo 已提交
56 57 58 59 60
    if (err) {
        console.info("Get RdbStore failed, err: " + err)
        return
    }
    console.log("Get RdbStore successfully.")
W
wuyongning 已提交
61 62 63
})
```

64 65 66 67 68
Stage模型示例:

```ts
// 获取context
import Ability from '@ohos.application.Ability'
L
lihuihui 已提交
69
let context
70 71
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
72 73 74
        context = this.context
    }
}
L
lihuihui 已提交
75

76 77 78
// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
L
lihuihui 已提交
79
    if (err) {
80
        console.info("Get RdbStore failed, err: " + err)
L
lihuihui 已提交
81 82
        return
    }
83
    console.log("Get RdbStore successfully.")
L
lihuihui 已提交
84 85 86
})
```

87
## data_rdb.getRdbStore<sup>(deprecated)</sup>
L
lihuihui 已提交
88

89
getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt;RdbStore&gt;
L
lihuihui 已提交
90

91
获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,使用Promise异步回调。
L
lihuihui 已提交
92

93 94 95
> **说明:**
>
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.getRdbStore](js-apis-data-relationalStore.md#data_rdbgetrdbstore9-1)替代。
L
lihuihui 已提交
96 97 98 99 100

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

**参数:**

101 102 103 104 105
| 参数名  | 类型                        | 必填 | 说明                                                         |
| ------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context                     | 是   | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| config  | [StoreConfig](#storeconfig) | 是   | 与此RDB存储相关的数据库配置。                                |
| version | number                      | 是   | 数据库版本。<br>目前暂不支持通过version自动识别数据库升级降级操作,只能由开发者自行维护。                                                 |
L
lihuihui 已提交
106 107 108

**返回值**

109 110 111
| 类型                                 | 说明                            |
| ------------------------------------ | ------------------------------- |
| Promise&lt;[RdbStore](#rdbstore)&gt; | Promise对象。返回RdbStore对象。 |
L
lihuihui 已提交
112 113 114

**示例:**

115 116
FA模型示例:

L
lihuihui 已提交
117
```js
118 119 120 121 122 123 124 125 126
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db" }
let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1);
promise.then(async (rdbStore) => {
    console.log("Get RdbStore successfully.")
L
lihuihui 已提交
127
}).catch((err) => {
128
    console.log("Get RdbStore failed, err: " + err)
L
lihuihui 已提交
129 130 131
})
```

132
Stage模型示例:
L
lihuihui 已提交
133

134 135 136 137 138 139 140 141 142
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}
L
lihuihui 已提交
143

144 145 146 147 148 149 150 151 152
// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db" }
let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1);
promise.then(async (rdbStore) => {
    console.log("Get RdbStore successfully.")
}).catch((err) => {
    console.log("Get RdbStore failed, err: " + err)
})
```
L
lihuihui 已提交
153

154 155 156 157 158 159 160 161 162
## data_rdb.deleteRdbStore<sup>(deprecated)</sup>

deleteRdbStore(context: Context, name: string, callback: AsyncCallback&lt;void&gt;): void

删除数据库,使用callback异步回调。

> **说明:**
>
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.deleteRdbStore](js-apis-data-relationalStore.md#data_rdbdeleterdbstore9)替代。
L
lihuihui 已提交
163 164 165 166 167

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

**参数:**

168 169 170 171 172
| 参数名   | 类型                      | 必填 | 说明                                                         |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                   | 是   | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| name     | string                    | 是   | 数据库名称。                                                 |
| callback | AsyncCallback&lt;void&gt; | 是   | 指定callback回调函数。                                       |
L
lihuihui 已提交
173 174 175

**示例:**

176 177
FA模型示例:

L
lihuihui 已提交
178
```js
179 180 181 182 183 184
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用deleteRdbStore
data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
L
lihuihui 已提交
185
    if (err) {
186
        console.info("Delete RdbStore failed, err: " + err)
L
lihuihui 已提交
187 188
        return
    }
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    console.log("Delete RdbStore successfully.")
})
```

Stage模型示例:

```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}

// 获取context后调用deleteRdbStore
data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
    if (err) {
        console.info("Delete RdbStore failed, err: " + err)
        return
L
lihuihui 已提交
210
    }
211
    console.log("Delete RdbStore successfully.")
L
lihuihui 已提交
212 213 214
})
```

215
## data_rdb.deleteRdbStore<sup>(deprecated)</sup>
L
lihuihui 已提交
216

217
deleteRdbStore(context: Context, name: string): Promise&lt;void&gt;
L
lihuihui 已提交
218

219
使用指定的数据库文件配置删除数据库,使用Promise异步回调。
L
lihuihui 已提交
220

221 222 223
> **说明:**
>
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.deleteRdbStore](js-apis-data-relationalStore.md#data_rdbdeleterdbstore9-1)替代。
L
lihuihui 已提交
224 225 226

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

227
**参数**
L
lihuihui 已提交
228

229 230 231 232
| 参数名  | 类型    | 必填 | 说明                                                         |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是   | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| name    | string  | 是   | 数据库名称。                                                 |
L
lihuihui 已提交
233 234 235

**返回值**

236 237 238
| 类型                | 说明                      |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
lihuihui 已提交
239 240 241

**示例:**

242 243
FA模型示例:

L
lihuihui 已提交
244
```js
245 246 247 248 249 250 251 252
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用deleteRdbStore
let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
promise.then(() => {
    console.log("Delete RdbStore successfully.")
L
lihuihui 已提交
253
}).catch((err) => {
254
    console.info("Delete RdbStore failed, err: " + err)
L
lihuihui 已提交
255 256 257
})
```

258
Stage模型示例:
L
lihuihui 已提交
259

260 261 262 263 264 265 266
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
L
lihuihui 已提交
267 268 269
    }
}

270 271 272 273 274 275 276
// 获取context后调用deleteRdbStore
let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
promise.then(()=>{
    console.log("Delete RdbStore successfully.")
}).catch((err) => {
    console.info("Delete RdbStore failed, err: " + err)
})
L
lihuihui 已提交
277 278 279 280 281 282 283 284 285 286 287 288 289
```

数据库的安全级别枚举。

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

| 名称 | 值   | 说明                                                         |
| ---- | ---- | ------------------------------------------------------------ |
| S1   | 1    | 表示数据库的安全级别为低级别,当数据泄露时会产生较低影响。例如,包含壁纸等系统数据的数据库。 |
| S2   | 2    | 表示数据库的安全级别为中级别,当数据泄露时会产生较大影响。例如,包含录音、视频等用户生成数据或通话记录等信息的数据库。 |
| S3   | 3    | 表示数据库的安全级别为高级别,当数据泄露时会产生重大影响。例如,包含用户运动、健康、位置等信息的数据库。 |
| S4   | 4    | 表示数据库的安全级别为关键级别,当数据泄露时会产生严重影响。例如,包含认证凭据、财务数据等信息的数据库。 |

290
## ValueType<sup>(deprecated)</sup>
L
lihuihui 已提交
291 292 293

用于表示允许的数据字段类型。

294 295 296 297
> **说明:**
>
> 从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.ValueType](js-apis-data-relationalStore.md#valuetype9)替代。

L
lihuihui 已提交
298 299 300 301 302 303 304 305 306
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core

| 类型    | 说明                 |
| ------- | -------------------- |
| number  | 表示值类型为数字。   |
| string  | 表示值类型为字符。   |
| boolean | 表示值类型为布尔值。 |


307
## ValuesBucket<sup>(deprecated)</sup>
L
lihuihui 已提交
308 309 310

用于存储键值对的类型。

311 312 313 314
> **说明:**
>
> 从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.ValuesBucket](js-apis-data-relationalStore.md#valuesbucket9)替代。

L
lihuihui 已提交
315 316 317 318 319 320
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core

| 键类型 | 值类型                                                      |
| ------ | ----------------------------------------------------------- |
| string | [ValueType](#valuetype)\|&nbsp;Uint8Array&nbsp;\|&nbsp;null |

321
## SyncMode<sup>(deprecated)</sup>
L
lihuihui 已提交
322 323 324

指数据库同步模式。

325 326 327 328
> **说明:**
>
> 从 API Version 8 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.SyncMode](js-apis-data-relationalStore.md#syncmode9)替代。

L
lihuihui 已提交
329 330 331 332 333 334 335
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core

| 名称           | 值   | 说明                               |
| -------------- | ---- | ---------------------------------- |
| SYNC_MODE_PUSH | 0    | 表示数据从本地设备推送到远程设备。 |
| SYNC_MODE_PULL | 1    | 表示数据从远程设备拉至本地设备。   |

336
## SubscribeType<sup>(deprecated)</sup>
L
lihuihui 已提交
337 338 339

描述订阅类型。

340 341 342 343
> **说明:**
>
> 从 API Version 8 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.SubscribeType](js-apis-data-relationalStore.md#subscribetype9)替代。

L
lihuihui 已提交
344 345 346 347 348 349 350 351
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC

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

| 名称                  | 值   | 说明               |
| --------------------- | ---- | ------------------ |
| SUBSCRIBE_TYPE_REMOTE | 0    | 订阅远程数据更改。 |

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
## StoreConfig<sup>(deprecated)</sup>

管理关系数据库配置。

> **说明:**
>
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.StoreConfig](js-apis-data-relationalStore.md#storeconfig9)替代。


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

| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库文件名。 |

L
lihuihui 已提交
367 368 369 370 371 372
## RdbPredicates<sup>(deprecated)</sup>

表示关系型数据库(RDB)的谓词。该类确定RDB中条件表达式的值是true还是false。

> **说明:**
>
373
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates](js-apis-data-relationalStore.md#rdbpredicates9)替代。
L
lihuihui 已提交
374 375 376 377 378 379 380 381 382 383


### constructor<sup>(deprecated)</sup>

constructor(name: string)

构造函数。

> **说明:**
>
384
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.constructor](js-apis-data-relationalStore.md#constructor9)替代。
L
lihuihui 已提交
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库表名。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
```

### inDevices<sup>(deprecated)</sup>

inDevices(devices: Array&lt;string&gt;): RdbPredicates

同步分布式数据库时连接到组网内指定的远程设备。

> **说明:**
>
408
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.inDevices](js-apis-data-relationalStore.md#indevices9)替代。
L
lihuihui 已提交
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| devices | Array&lt;string&gt; | 是 | 指定的组网内的远程设备ID。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inDevices(['12345678abcde'])
```

### inAllDevices<sup>(deprecated)</sup>

inAllDevices(): RdbPredicates

同步分布式数据库时连接到组网内所有的远程设备。

> **说明:**
>
439
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.inAllDevices](js-apis-data-relationalStore.md#inalldevices9)替代。
L
lihuihui 已提交
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463

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

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inAllDevices()
```

### equalTo<sup>(deprecated)</sup>

equalTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且值等于指定值的字段。

> **说明:**
>
464 465
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.equalTo](js-apis-data-relationalStore.md#equalto9)替代。

L
lihuihui 已提交
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
```


### notEqualTo<sup>(deprecated)</sup>

notEqualTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。

> **说明:**
>
498
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.notEqualTo](js-apis-data-relationalStore.md#notequalto9)替代。
L
lihuihui 已提交
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notEqualTo("NAME", "lisi")
```


### beginWrap<sup>(deprecated)</sup>

beginWrap(): RdbPredicates

向谓词添加左括号。

> **说明:**
>
531
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.beginWrap](js-apis-data-relationalStore.md#beginwrap9)替代。
L
lihuihui 已提交
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560

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

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回带有左括号的Rdb谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()
```

### endWrap<sup>(deprecated)</sup>

endWrap(): RdbPredicates

向谓词添加右括号。

> **说明:**
>
561
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.endWrap](js-apis-data-relationalStore.md#endwrap9)替代。
L
lihuihui 已提交
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590

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

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回带有右括号的Rdb谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()
```

### or<sup>(deprecated)</sup>

or(): RdbPredicates

将或条件添加到谓词中。

> **说明:**
>
591
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.or](js-apis-data-relationalStore.md#or9)替代。
L
lihuihui 已提交
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617

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

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回带有或条件的Rdb谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
    .or()
    .equalTo("NAME", "Rose")
```

### and<sup>(deprecated)</sup>

and(): RdbPredicates

向谓词添加和条件。

> **说明:**
>
618
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.and](js-apis-data-relationalStore.md#and9)替代。
L
lihuihui 已提交
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644

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

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回带有和条件的Rdb谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
    .and()
    .equalTo("SALARY", 200.5)
```

### contains<sup>(deprecated)</sup>

contains(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且value包含指定值的字段。

> **说明:**
>
645 646
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.contains](js-apis-data-relationalStore.md#contains9)替代。

L
lihuihui 已提交
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.contains("NAME", "os")
```

### beginsWith<sup>(deprecated)</sup>

beginsWith(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且值以指定字符串开头的字段。

> **说明:**
>
678
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.beginsWith](js-apis-data-relationalStore.md#beginswith9)替代。
L
lihuihui 已提交
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.beginsWith("NAME", "os")
```

### endsWith<sup>(deprecated)</sup>

endsWith(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。

> **说明:**
>
710
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.endsWith](js-apis-data-relationalStore.md#endswith9)替代。
L
lihuihui 已提交
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.endsWith("NAME", "se")
```

### isNull<sup>(deprecated)</sup>

isNull(field: string): RdbPredicates

配置谓词以匹配值为null的字段。

> **说明:**
>
742
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.isNull](js-apis-data-relationalStore.md#isnull9)替代。
L
lihuihui 已提交
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNull("NAME")
```

### isNotNull<sup>(deprecated)</sup>

isNotNull(field: string): RdbPredicates

配置谓词以匹配值不为null的指定字段。

> **说明:**
>
772
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.isNotNull](js-apis-data-relationalStore.md#isnotnull9)替代。
L
lihuihui 已提交
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNotNull("NAME")
```

### like<sup>(deprecated)</sup>

like(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且值类似于指定字符串的字段。

> **说明:**
>
803 804
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.like](js-apis-data-relationalStore.md#like9)替代。

L
lihuihui 已提交
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.like("NAME", "%os%")
```

### glob<sup>(deprecated)</sup>

glob(field: string, value: string): RdbPredicates

配置RdbPredicates匹配数据字段为string的指定字段。

> **说明:**
>
836 837
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.glob](js-apis-data-relationalStore.md#glob9)替代。

L
lihuihui 已提交
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。<br>支持通配符,*表示0个、1个或多个数字或字符,?表示1个数字或字符。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.glob("NAME", "?h*g")
```

### between<sup>(deprecated)</sup>

between(field: string, low: ValueType, high: ValueType): RdbPredicates

将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。

> **说明:**
>
869
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.between](js-apis-data-relationalStore.md#between9)替代。
L
lihuihui 已提交
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.between("AGE", 10, 50)
```

### notBetween<sup>(deprecated)</sup>

notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates

配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。

> **说明:**
>
902
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.notBetweens](js-apis-data-relationalStore.md#notbetween9)替代。
L
lihuihui 已提交
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notBetween("AGE", 10, 50)
```

### greaterThan<sup>(deprecated)</sup>

greaterThan(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且值大于指定值的字段。

> **说明:**
>
935
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.greaterThan](js-apis-data-relationalStore.md#greaterthan9)替代。
L
lihuihui 已提交
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThan("AGE", 18)
```

### lessThan<sup>(deprecated)</sup>

lessThan(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为valueType且value小于指定值的字段。

> **说明:**
>
967 968
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.lessThan](js-apis-data-relationalStore.md#lessthan9)替代。

L
lihuihui 已提交
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThan("AGE", 20)
```

### greaterThanOrEqualTo<sup>(deprecated)</sup>

greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。

> **说明:**
>
1000
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.greaterThanOrEqualTo](js-apis-data-relationalStore.md#greaterthanorequalto9)替代。
L
lihuihui 已提交
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThanOrEqualTo("AGE", 18)
```

### lessThanOrEqualTo<sup>(deprecated)</sup>

lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。

> **说明:**
>
1032
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.lessThanOrEqualTo](js-apis-data-relationalStore.md#lessthanorequalto9)替代。
L
lihuihui 已提交
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThanOrEqualTo("AGE", 20)
```

### orderByAsc<sup>(deprecated)</sup>

orderByAsc(field: string): RdbPredicates

配置谓词以匹配其值按升序排序的列。

> **说明:**
>
1064
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.orderByAsc](js-apis-data-relationalStore.md#orderbyasc9)替代。
L
lihuihui 已提交
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByAsc("NAME")
```

### orderByDesc<sup>(deprecated)</sup>

orderByDesc(field: string): RdbPredicates

配置谓词以匹配其值按降序排序的列。

> **说明:**
>
1095
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.orderByDesc](js-apis-data-relationalStore.md#orderbydesc9)替代。
L
lihuihui 已提交
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByDesc("AGE")
```

### distinct<sup>(deprecated)</sup>

distinct(): RdbPredicates

配置谓词以过滤重复记录并仅保留其中一个。

> **说明:**
>
1126 1127
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.distinct](js-apis-data-relationalStore.md#distinct9)替代。

L
lihuihui 已提交
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151

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

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回可用于过滤重复记录的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").distinct()
```

### limitAs<sup>(deprecated)</sup>

limitAs(value: number): RdbPredicates

设置最大数据记录数的谓词。

> **说明:**
>
1152
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.limitAs](js-apis-data-relationalStore.md#limitas9)替代。
L
lihuihui 已提交
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | number | 是 | 最大数据记录数。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回可用于设置最大数据记录数的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").limitAs(3)
```

### offsetAs<sup>(deprecated)</sup>

offsetAs(rowOffset: number): RdbPredicates

配置RdbPredicates以指定返回结果的起始位置。

> **说明:**
>
1183
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.offsetAs](js-apis-data-relationalStore.md#offsetas9)替代。
L
lihuihui 已提交
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| rowOffset | number | 是 | 返回结果的起始位置,取值为正整数。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回具有指定返回结果起始位置的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").offsetAs(3)
```

### groupBy<sup>(deprecated)</sup>

groupBy(fields: Array&lt;string&gt;): RdbPredicates

配置RdbPredicates按指定列分组查询结果。

> **说明:**
>
1214
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.groupBy](js-apis-data-relationalStore.md#groupby9)替代。
L
lihuihui 已提交
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| fields | Array&lt;string&gt; | 是 | 指定分组依赖的列名。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回分组查询列的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.groupBy(["AGE", "NAME"])
```

### indexedBy<sup>(deprecated)</sup>

indexedBy(field: string): RdbPredicates

配置RdbPredicates以指定索引列。

> **说明:**
>
1245
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.indexedBy](js-apis-data-relationalStore.md#indexedby9)替代。
L
lihuihui 已提交
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 索引列的名称。 |

**返回值**


| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回具有指定索引列的RdbPredicates。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.indexedBy("SALARY_INDEX")
```

### in<sup>(deprecated)</sup>

in(field: string, value: Array&lt;ValueType&gt;): RdbPredicates

配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。

> **说明:**
>
1277
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.in](js-apis-data-relationalStore.md#in9)替代。
L
lihuihui 已提交
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array&lt;[ValueType](#valuetype)&gt; | 是 | 以ValueType型数组形式指定的要匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.in("AGE", [18, 20])
```

### notIn<sup>(deprecated)</sup>

notIn(field: string, value: Array&lt;ValueType&gt;): RdbPredicates

将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。

> **说明:**
>
1309
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbPredicates.notIn](js-apis-data-relationalStore.md#notin9)替代。
L
lihuihui 已提交
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array&lt;[ValueType](#valuetype)&gt; | 是 | 以ValueType数组形式指定的要匹配的值。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |

**示例:**

```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notIn("NAME", ["Lisa", "Rose"])
```

## RdbStore<sup>(deprecated)</sup>

提供管理关系数据库(RDB)方法的接口。

> **说明:**
>
1339
> 从 API Version 7开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore](js-apis-data-relationalStore.md#rdbstore9)替代。
L
lihuihui 已提交
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350

在使用以下相关接口前,请使用[executeSql](#executesql)接口初始化数据库表结构和相关数据,具体可见[关系型数据库开发指导](../../database/database-relational-guidelines.md)

### insert<sup>(deprecated)</sup>

insert(table: string, values: ValuesBucket, callback: AsyncCallback&lt;number&gt;):void

向目标表中插入一行数据,使用callback异步回调。

> **说明:**
>
1351
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.insert](js-apis-data-relationalStore.md#insert9)替代。
L
lihuihui 已提交
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| table | string | 是 | 指定的目标表名。 |
| values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。如果操作成功,返回行ID;否则返回-1。 |

**示例:**

```js
const valueBucket = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
rdbStore.insert("EMPLOYEE", valueBucket, function (status, rowId) {
    if (status) {
        console.log("Insert is failed");
        return;
    }
    console.log("Insert is successful, rowId = " + rowId);
})
```

### insert<sup>(deprecated)</sup>

insert(table: string, values: ValuesBucket):Promise&lt;number&gt;

向目标表中插入一行数据,使用Promise异步回调。

> **说明:**
>
1389 1390
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.insert](js-apis-data-relationalStore.md#insert9-1)替代。

L
lihuihui 已提交
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| table | string | 是 | 指定的目标表名。 |
| values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;number&gt; | Promise对象。如果操作成功,返回行ID;否则返回-1。 |

**示例:**

```js
const valueBucket = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let promise = rdbStore.insert("EMPLOYEE", valueBucket)
promise.then((rowId) => {
    console.log("Insert is successful, rowId = " + rowId);
}).catch((status) => {
    console.log("Insert is failed");
})
```

### batchInsert<sup>(deprecated)</sup>

batchInsert(table: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;):void

向目标表中插入一组数据,使用callback异步回调。

> **说明:**
>
1432
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.batchInsert](js-apis-data-relationalStore.md#batchinsert9)替代。
L
lihuihui 已提交
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| table | string | 是 | 指定的目标表名。 |
| values | Array&lt;[ValuesBucket](#valuesbucket)&gt; | 是 | 表示要插入到表中的一组数据。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。如果操作成功,返回插入的数据个数,否则返回-1。 |

**示例:**

```js
const valueBucket1 = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5])
}
const valueBucket2 = {
    "NAME": "Jack",
    "AGE": 19,
    "SALARY": 101.5,
    "CODES": new Uint8Array([6, 7, 8, 9, 10])
}
const valueBucket3 = {
    "NAME": "Tom",
    "AGE": 20,
    "SALARY": 102.5,
    "CODES": new Uint8Array([11, 12, 13, 14, 15])
}

let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
rdbStore.batchInsert("EMPLOYEE", valueBuckets, function(status, insertNum) {
    if (status) {
        console.log("batchInsert is failed, status = " + status);
        return;
    }
    console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
})
```

### batchInsert<sup>(deprecated)</sup>

batchInsert(table: string, values: Array&lt;ValuesBucket&gt;):Promise&lt;number&gt;

向目标表中插入一组数据,使用Promise异步回调。

> **说明:**
>
1484
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.batchInsert](js-apis-data-relationalStore.md#batchinsert9-1)替代。
L
lihuihui 已提交
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| table | string | 是 | 指定的目标表名。 |
| values | Array&lt;[ValuesBucket](#valuesbucket)&gt; | 是 | 表示要插入到表中的一组数据。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;number&gt; | Promise对象。如果操作成功,返回插入的数据个数,否则返回-1。 |

**示例:**

```js
const valueBucket1 = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5])
}
const valueBucket2 = {
    "NAME": "Jack",
    "AGE": 19,
    "SALARY": 101.5,
    "CODES": new Uint8Array([6, 7, 8, 9, 10])
}
const valueBucket3 = {
    "NAME": "Tom",
    "AGE": 20,
    "SALARY": 102.5,
    "CODES": new Uint8Array([11, 12, 13, 14, 15])
}

let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
let promise = rdbStore.batchInsert("EMPLOYEE", valueBuckets);
promise.then((insertNum) => {
    console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
}).catch((status) => {
    console.log("batchInsert is failed, status = " + status);
})
```

### update<sup>(deprecated)</sup>

update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void

根据RdbPredicates的指定实例对象更新数据库中的数据,使用callback异步回调。

> **说明:**
>
1540
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.update](js-apis-data-relationalStore.md#update9)替代。
L
lihuihui 已提交
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的更新条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定的callback回调方法。返回受影响的行数。 |

**示例:**

```js
const valueBucket = {
    "NAME": "Rose",
    "AGE": 22,
    "SALARY": 200.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
rdbStore.update(valueBucket, predicates, function (err, ret) {
    if (err) {
        console.info("Updated failed, err: " + err)
        return
    }
    console.log("Updated row count: " + ret)
})
```

### update<sup>(deprecated)</sup>

update(values: ValuesBucket, predicates: RdbPredicates):Promise&lt;number&gt;

根据RdbPredicates的指定实例对象更新数据库中的数据,使用Promise异步回调。

> **说明:**
>
1580
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.update](js-apis-data-relationalStore.md#update9-1)替代。
L
lihuihui 已提交
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的更新条件。 |

**返回值**

| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;number&gt; | 指定的Promise回调方法。返回受影响的行数。 |

**示例:**

```js
const valueBucket = {
    "NAME": "Rose",
    "AGE": 22,
    "SALARY": 200.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
let promise = rdbStore.update(valueBucket, predicates)
promise.then(async (ret) => {
    console.log("Updated row count: " + ret)
}).catch((err) => {
    console.info("Updated failed, err: " + err)
})
```

### delete<sup>(deprecated)</sup>

delete(predicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void

根据RdbPredicates的指定实例对象从数据库中删除数据,使用callback异步回调。

> **说明:**
>
1624
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.delete](js-apis-data-relationalStore.md#delete9)替代。
L
lihuihui 已提交
1625 1626 1627 1628 1629 1630 1631 1632 1633

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。返回受影响的行数。 |
1634 1635

**示例:**
1636

1637
```js
L
lihuihui 已提交
1638 1639 1640
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
rdbStore.delete(predicates, function (err, rows) {
1641
    if (err) {
L
lihuihui 已提交
1642
        console.info("Delete failed, err: " + err)
1643 1644
        return
    }
L
lihuihui 已提交
1645
    console.log("Delete rows: " + rows)
1646 1647 1648
})
```

L
lihuihui 已提交
1649
### delete<sup>(deprecated)</sup>
1650

L
lihuihui 已提交
1651
delete(predicates: RdbPredicates):Promise&lt;number&gt;
1652

L
lihuihui 已提交
1653
根据RdbPredicates的指定实例对象从数据库中删除数据,使用Promise异步回调。
1654

L
lihuihui 已提交
1655 1656
> **说明:**
>
1657 1658
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.delete](js-apis-data-relationalStore.md#delete9-1)替代。

1659

L
lihuihui 已提交
1660
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
1661 1662

**参数:**
1663

1664 1665
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
L
lihuihui 已提交
1666
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 |
1667 1668

**返回值**
L
li_juntao 已提交
1669

1670 1671
| 类型 | 说明 |
| -------- | -------- |
L
lihuihui 已提交
1672
| Promise&lt;number&gt; | Promise对象。返回受影响的行数。 |
1673 1674

**示例:**
1675

1676
```js
L
lihuihui 已提交
1677 1678 1679 1680 1681
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
let promise = rdbStore.delete(predicates)
promise.then((rows) => {
    console.log("Delete rows: " + rows)
1682
}).catch((err) => {
L
lihuihui 已提交
1683
    console.info("Delete failed, err: " + err)
1684 1685
})
```
Z
zengyawen 已提交
1686

L
lihuihui 已提交
1687
### query<sup>(deprecated)</sup>
1688

L
lihuihui 已提交
1689
query(predicates: RdbPredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;ResultSet&gt;):void
1690

L
lihuihui 已提交
1691 1692 1693 1694
根据指定条件查询数据库中的数据,使用callback异步回调。

> **说明:**
>
1695
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.query](js-apis-data-relationalStore.md#query9)替代。
1696

L
li_juntao 已提交
1697
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
1698 1699

**参数:**
L
li_juntao 已提交
1700

1701 1702
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
L
lihuihui 已提交
1703
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的查询条件。 |
1704
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空,则查询应用于所有列。 |
L
lihuihui 已提交
1705
| callback | AsyncCallback&lt;[ResultSet](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功,则返回ResultSet对象。 |
1706 1707

**示例:**
L
li_juntao 已提交
1708

1709
```js
L
lihuihui 已提交
1710 1711 1712
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose")
rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) {
L
li_juntao 已提交
1713
    if (err) {
L
lihuihui 已提交
1714
        console.info("Query failed, err: " + err)
L
li_juntao 已提交
1715 1716
        return
    }
L
lihuihui 已提交
1717 1718
    console.log("ResultSet column names: " + resultSet.columnNames)
    console.log("ResultSet column count: " + resultSet.columnCount)
1719 1720 1721
})
```

L
lihuihui 已提交
1722 1723 1724
### query<sup>(deprecated)</sup>

query(predicates: RdbPredicates, columns?: Array&lt;string&gt;):Promise&lt;ResultSet&gt;
1725

L
lihuihui 已提交
1726
根据指定条件查询数据库中的数据,使用Promise异步回调。
1727

L
lihuihui 已提交
1728 1729
> **说明:**
>
1730
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.query](js-apis-data-relationalStore.md#query9-1)替代。
1731

L
li_juntao 已提交
1732
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
1733 1734 1735 1736 1737

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
L
lihuihui 已提交
1738
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的查询条件。 |
1739 1740
| columns | Array&lt;string&gt; | 否 | 表示要查询的列。如果值为空,则查询应用于所有列。 |

L
li_juntao 已提交
1741 1742
**返回值**

L
lihuihui 已提交
1743 1744 1745
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[ResultSet](js-apis-data-resultset.md)&gt; | Promise对象。如果操作成功,则返回ResultSet对象。 |
L
li_juntao 已提交
1746

1747 1748
**示例:**

L
lihuihui 已提交
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
  ```js
  let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
  predicates.equalTo("NAME", "Rose")
  let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
  promise.then((resultSet) => {
      console.log("ResultSet column names: " + resultSet.columnNames)
      console.log("ResultSet column count: " + resultSet.columnCount)
  }).catch((err) => {
      console.info("Query failed, err: " + err)
  })
  ```
1760

L
lihuihui 已提交
1761
### querySql<sup>(deprecated)</sup>
M
mangtsang 已提交
1762 1763 1764

querySql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;ResultSet&gt;):void

W
wangxiyue 已提交
1765
根据指定SQL语句查询数据库中的数据,使用callback异步回调。
M
mangtsang 已提交
1766

L
lihuihui 已提交
1767 1768
> **说明:**
>
1769
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.querySql](js-apis-data-relationalStore.md#querysql9)替代。
L
lihuihui 已提交
1770 1771

**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
1772

P
PaDaBoo 已提交
1773
**参数:**
1774

Z
zengyawen 已提交
1775 1776 1777 1778 1779
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 |
| callback | AsyncCallback&lt;[ResultSet](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功,则返回ResultSet对象。 |
M
mangtsang 已提交
1780

P
PaDaBoo 已提交
1781
**示例:**
1782

P
PaDaBoo 已提交
1783 1784 1785 1786 1787 1788
```js
rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) {
    if (err) {
        console.info("Query failed, err: " + err)
        return
    }
W
wuyongning 已提交
1789 1790
    console.log("ResultSet column names: " + resultSet.columnNames)
    console.log("ResultSet column count: " + resultSet.columnCount)
P
PaDaBoo 已提交
1791 1792
})
```
M
mangtsang 已提交
1793

L
lihuihui 已提交
1794
### querySql<sup>(deprecated)</sup>
M
mangtsang 已提交
1795 1796 1797

querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt;

W
wangxiyue 已提交
1798
根据指定SQL语句查询数据库中的数据,使用Promise异步回调。
M
mangtsang 已提交
1799

L
lihuihui 已提交
1800 1801
> **说明:**
>
1802 1803
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.querySql](js-apis-data-relationalStore.md#querysql9-1)替代。

L
lihuihui 已提交
1804 1805

**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
1806

P
PaDaBoo 已提交
1807
**参数:**
1808

Z
zengyawen 已提交
1809 1810 1811 1812
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 否 | SQL语句中参数的值。 |
M
mangtsang 已提交
1813

Z
zengyawen 已提交
1814
**返回值**
1815

Z
zengyawen 已提交
1816 1817
| 类型 | 说明 |
| -------- | -------- |
L
lihuihui 已提交
1818
| Promise&lt;[ResultSet](js-apis-data-resultset.md)&gt; | Promise对象。如果操作成功,则返回ResultSet对象。 |
M
mangtsang 已提交
1819

P
PaDaBoo 已提交
1820
**示例:**
1821

P
PaDaBoo 已提交
1822 1823 1824
```js
let promise = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'])
promise.then((resultSet) => {
W
wuyongning 已提交
1825 1826
    console.log("ResultSet column names: " + resultSet.columnNames)
    console.log("ResultSet column count: " + resultSet.columnCount)
P
PaDaBoo 已提交
1827 1828 1829 1830
}).catch((err) => {
    console.info("Query failed, err: " + err)
})
```
M
mangtsang 已提交
1831

L
lihuihui 已提交
1832
### executeSql<sup>(deprecated)</sup>
Z
zengyawen 已提交
1833 1834

executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;void&gt;):void
Z
zengyawen 已提交
1835

W
wangxiyue 已提交
1836
执行包含指定参数但不返回值的SQL语句,使用callback异步回调。
Z
zengyawen 已提交
1837

L
lihuihui 已提交
1838 1839
> **说明:**
>
1840
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.executeSql](js-apis-data-relationalStore.md#executesql9)替代。
L
lihuihui 已提交
1841 1842

**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
1843

P
PaDaBoo 已提交
1844
**参数:**
1845

Z
zengyawen 已提交
1846 1847 1848 1849 1850
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
Z
zengyawen 已提交
1851

P
PaDaBoo 已提交
1852
**示例:**
1853

P
PaDaBoo 已提交
1854 1855 1856 1857
```js
const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) {
    if (err) {
W
wuyongning 已提交
1858
        console.info("ExecuteSql failed, err: " + err)
P
PaDaBoo 已提交
1859 1860
        return
    }
W
wuyongning 已提交
1861
    console.info('Create table done.')
P
PaDaBoo 已提交
1862 1863
})
```
Z
zengyawen 已提交
1864

L
lihuihui 已提交
1865
### executeSql<sup>(deprecated)</sup>
Z
zengyawen 已提交
1866

M
mangtsang 已提交
1867
executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt;
Z
zengyawen 已提交
1868

W
wangxiyue 已提交
1869
执行包含指定参数但不返回值的SQL语句,使用Promise异步回调。
Z
zengyawen 已提交
1870

L
lihuihui 已提交
1871 1872
> **说明:**
>
1873
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.executeSql](js-apis-data-relationalStore.md#executesql9-1)替代。
L
lihuihui 已提交
1874 1875

**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
1876

P
PaDaBoo 已提交
1877
**参数:**
1878

Z
zengyawen 已提交
1879 1880 1881 1882
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 否 | SQL语句中参数的值。 |
Z
zengyawen 已提交
1883

Z
zengyawen 已提交
1884
**返回值**
1885

Z
zengyawen 已提交
1886 1887
| 类型 | 说明 |
| -------- | -------- |
L
lihuihui 已提交
1888
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
Z
zengyawen 已提交
1889

P
PaDaBoo 已提交
1890
**示例:**
1891

P
PaDaBoo 已提交
1892 1893 1894 1895
```js
const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
let promise = rdbStore.executeSql(SQL_CREATE_TABLE)
promise.then(() => {
W
wuyongning 已提交
1896
    console.info('Create table done.')
P
PaDaBoo 已提交
1897 1898 1899 1900
}).catch((err) => {
    console.info("ExecuteSql failed, err: " + err)
})
```
S
sun-dou 已提交
1901

L
lihuihui 已提交
1902
### beginTransaction<sup>(deprecated)</sup>
W
wuyongning 已提交
1903 1904 1905 1906 1907

beginTransaction():void

在开始执行SQL语句之前,开始事务。

L
lihuihui 已提交
1908 1909
> **说明:**
>
1910
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.beginTransaction](js-apis-data-relationalStore.md#begintransaction9)替代。
L
lihuihui 已提交
1911 1912

**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
1913

P
PaDaBoo 已提交
1914
**示例:**
1915

G
ge-yafang 已提交
1916
```js
L
add  
ltdong 已提交
1917
import featureAbility from '@ohos.ability.featureAbility'
L
lihuihui 已提交
1918
let context = featureAbility.getContext()
L
add  
ltdong 已提交
1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
    rdbStore.beginTransaction()
	const valueBucket = {
		"name": "lisi",
		"age": 18,
		"salary": 100.5,
		"blobType": new Uint8Array([1, 2, 3]),
	}
	await rdbStore.insert("test", valueBucket)
	rdbStore.commit()
})
W
wuyongning 已提交
1931 1932
```

L
lihuihui 已提交
1933
### commit<sup>(deprecated)</sup>
W
wuyongning 已提交
1934 1935 1936 1937 1938

commit():void

提交已执行的SQL语句。

L
lihuihui 已提交
1939 1940
> **说明:**
>
1941
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.commit](js-apis-data-relationalStore.md#commit9)替代。
L
lihuihui 已提交
1942 1943

**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
1944

P
PaDaBoo 已提交
1945
**示例:**
1946

G
ge-yafang 已提交
1947
```js
L
add  
ltdong 已提交
1948
import featureAbility from '@ohos.ability.featureAbility'
L
lihuihui 已提交
1949
let context = featureAbility.getContext()
L
add  
ltdong 已提交
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
    rdbStore.beginTransaction()
	const valueBucket = {
		"name": "lisi",
		"age": 18,
		"salary": 100.5,
		"blobType": new Uint8Array([1, 2, 3]),
	}
	await rdbStore.insert("test", valueBucket)
	rdbStore.commit()
})
W
wuyongning 已提交
1962 1963
```

L
lihuihui 已提交
1964
### rollBack<sup>(deprecated)</sup>
W
wuyongning 已提交
1965

1966
rollBack():void
W
wuyongning 已提交
1967 1968 1969

回滚已经执行的SQL语句。

L
lihuihui 已提交
1970 1971
> **说明:**
>
1972
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.rollBack](js-apis-data-relationalStore.md#rollback9)替代。
L
lihuihui 已提交
1973 1974

**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
1975

P
PaDaBoo 已提交
1976
**示例:**
1977

G
ge-yafang 已提交
1978
```js
L
add  
ltdong 已提交
1979
import featureAbility from '@ohos.ability.featureAbility'
L
lihuihui 已提交
1980
let context = featureAbility.getContext()
L
add  
ltdong 已提交
1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
    try {
		rdbStore.beginTransaction()
		const valueBucket = {
			"id": 1,
			"name": "lisi",
			"age": 18,
			"salary": 100.5,
			"blobType": new Uint8Array([1, 2, 3]),
		}
		await rdbStore.insert("test", valueBucket)
		rdbStore.commit()
	} catch (e) {
		rdbStore.rollBack()
	}
})
W
wuyongning 已提交
1998 1999
```

L
lihuihui 已提交
2000
### setDistributedTables<sup>(deprecated)</sup>
S
sun-dou 已提交
2001

W
wuyongning 已提交
2002
setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;void&gt;): void
S
sun-dou 已提交
2003

W
wangxiyue 已提交
2004
设置分布式列表,使用callback异步回调。
S
sun-dou 已提交
2005

L
lihuihui 已提交
2006 2007
> **说明:**
>
2008
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.setDistributedTables](js-apis-data-relationalStore.md#setdistributedtables9)替代。
L
lihuihui 已提交
2009

W
wuyongning 已提交
2010 2011
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC

L
lihuihui 已提交
2012
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
2013

P
PaDaBoo 已提交
2014
**参数:**
2015

Z
zengyawen 已提交
2016 2017 2018 2019
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
S
sun-dou 已提交
2020

P
PaDaBoo 已提交
2021
**示例:**
2022

P
PaDaBoo 已提交
2023 2024 2025
```js
rdbStore.setDistributedTables(["EMPLOYEE"], function (err) {
    if (err) {
W
wuyongning 已提交
2026
        console.info('SetDistributedTables failed, err: ' + err)
P
PaDaBoo 已提交
2027 2028
        return
    }
W
wuyongning 已提交
2029
    console.info('SetDistributedTables successfully.')
P
PaDaBoo 已提交
2030
})
2031
```
S
sun-dou 已提交
2032

L
lihuihui 已提交
2033
### setDistributedTables<sup>(deprecated)</sup>
S
sun-dou 已提交
2034

W
wuyongning 已提交
2035
 setDistributedTables(tables: Array&lt;string&gt;): Promise&lt;void&gt;
S
sun-dou 已提交
2036

W
wangxiyue 已提交
2037
设置分布式列表,使用Promise异步回调。
S
sun-dou 已提交
2038

L
lihuihui 已提交
2039 2040
> **说明:**
>
2041
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.setDistributedTables](js-apis-data-relationalStore.md#setdistributedtables9-1)替代。
L
lihuihui 已提交
2042

W
wuyongning 已提交
2043 2044
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC

L
lihuihui 已提交
2045
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
2046

P
PaDaBoo 已提交
2047
**参数:**
2048

Z
zengyawen 已提交
2049 2050 2051
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名。 |
S
sun-dou 已提交
2052

Z
zengyawen 已提交
2053
**返回值**
2054

Z
zengyawen 已提交
2055 2056
| 类型 | 说明 |
| -------- | -------- |
L
lihuihui 已提交
2057
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
S
sun-dou 已提交
2058

P
PaDaBoo 已提交
2059
**示例:**
2060

P
PaDaBoo 已提交
2061 2062 2063
```js
let promise = rdbStore.setDistributedTables(["EMPLOYEE"])
promise.then(() => {
W
wuyongning 已提交
2064
    console.info("SetDistributedTables successfully.")
P
PaDaBoo 已提交
2065
}).catch((err) => {
W
wuyongning 已提交
2066
    console.info("SetDistributedTables failed, err: " + err)
P
PaDaBoo 已提交
2067 2068
})
```
S
sun-dou 已提交
2069

L
lihuihui 已提交
2070
### obtainDistributedTableName<sup>(deprecated)</sup>
S
sun-dou 已提交
2071

W
wuyongning 已提交
2072
obtainDistributedTableName(device: string, table: string, callback: AsyncCallback&lt;string&gt;): void
S
sun-dou 已提交
2073

W
wangxiyue 已提交
2074
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名, 使用callback异步回调。
S
sun-dou 已提交
2075

L
lihuihui 已提交
2076 2077
> **说明:**
>
2078 2079
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.obtainDistributedTableName](js-apis-data-relationalStore.md#obtaindistributedtablename9)替代。

L
lihuihui 已提交
2080

W
wuyongning 已提交
2081 2082
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC

L
lihuihui 已提交
2083
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
2084

P
PaDaBoo 已提交
2085
**参数:**
2086

Z
zengyawen 已提交
2087 2088 2089 2090 2091
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| device | string | 是 | 远程设备 。|
| table | string | 是 | 本地表名。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 指定的callback回调函数。如果操作成功,返回远程设备的分布式表名。 |
S
sun-dou 已提交
2092

P
PaDaBoo 已提交
2093
**示例:**
2094

P
PaDaBoo 已提交
2095
```js
W
wuyongning 已提交
2096
rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {
P
PaDaBoo 已提交
2097
    if (err) {
W
wuyongning 已提交
2098
        console.info('ObtainDistributedTableName failed, err: ' + err)
P
PaDaBoo 已提交
2099 2100
        return
    }
W
wuyongning 已提交
2101
    console.info('ObtainDistributedTableName successfully, tableName=.' + tableName)
P
PaDaBoo 已提交
2102 2103
})
```
S
sun-dou 已提交
2104

L
lihuihui 已提交
2105
### obtainDistributedTableName<sup>(deprecated)</sup>
S
sun-dou 已提交
2106

W
wuyongning 已提交
2107
 obtainDistributedTableName(device: string, table: string): Promise&lt;string&gt;
S
sun-dou 已提交
2108

W
wangxiyue 已提交
2109
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,使用Promise异步回调。
S
sun-dou 已提交
2110

L
lihuihui 已提交
2111 2112
> **说明:**
>
2113
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.obtainDistributedTableName](js-apis-data-relationalStore.md#obtaindistributedtablename9-1)替代。
L
lihuihui 已提交
2114

W
wuyongning 已提交
2115 2116
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC

L
lihuihui 已提交
2117
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
2118

P
PaDaBoo 已提交
2119
**参数:**
2120

Z
zengyawen 已提交
2121 2122 2123 2124
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| device | string | 是 | 远程设备。 |
| table | string | 是 | 本地表名。 |
S
sun-dou 已提交
2125

Z
zengyawen 已提交
2126
**返回值**
2127

Z
zengyawen 已提交
2128 2129
| 类型 | 说明 |
| -------- | -------- |
L
lihuihui 已提交
2130
| Promise&lt;string&gt; | Promise对象。如果操作成功,返回远程设备的分布式表名。 |
S
sun-dou 已提交
2131

P
PaDaBoo 已提交
2132
**示例:**
2133

P
PaDaBoo 已提交
2134
```js
W
wuyongning 已提交
2135
let promise = rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE")
P
PaDaBoo 已提交
2136
promise.then((tableName) => {
W
wuyongning 已提交
2137
    console.info('ObtainDistributedTableName successfully, tableName= ' + tableName)
P
PaDaBoo 已提交
2138
}).catch((err) => {
W
wuyongning 已提交
2139
    console.info('ObtainDistributedTableName failed, err: ' + err)
P
PaDaBoo 已提交
2140 2141
})
```
S
sun-dou 已提交
2142

L
lihuihui 已提交
2143
### sync<sup>(deprecated)</sup>
S
sun-dou 已提交
2144

W
wuyongning 已提交
2145
sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback&lt;Array&lt;[string, number]&gt;&gt;): void
S
sun-dou 已提交
2146

W
wangxiyue 已提交
2147
在设备之间同步数据, 使用callback异步回调。
S
sun-dou 已提交
2148

L
lihuihui 已提交
2149 2150
> **说明:**
>
2151
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.sync](js-apis-data-relationalStore.md#sync9)替代。
L
lihuihui 已提交
2152

W
wuyongning 已提交
2153 2154
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC

L
lihuihui 已提交
2155
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
2156

P
PaDaBoo 已提交
2157
**参数:**
2158

Z
zengyawen 已提交
2159 2160
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
P
PaDaBoo 已提交
2161
| mode | [SyncMode](#syncmodedeprecated) | 是 | 指同步模式。该值可以是推、拉。 |
Z
zengyawen 已提交
2162 2163
| predicates | [RdbPredicates](#rdbpredicates) | 是 | 约束同步数据和设备。 |
| callback | AsyncCallback&lt;Array&lt;[string, number]&gt;&gt; | 是 | 指定的callback回调函数,用于向调用者发送同步结果。string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。|
S
sun-dou 已提交
2164

P
PaDaBoo 已提交
2165
**示例:**
2166

P
PaDaBoo 已提交
2167
```js
W
wuyongning 已提交
2168
let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
P
PaDaBoo 已提交
2169
predicates.inDevices(['12345678abcde'])
W
wuyongning 已提交
2170
rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) {
P
PaDaBoo 已提交
2171
    if (err) {
W
wuyongning 已提交
2172
        console.log('Sync failed, err: ' + err)
P
PaDaBoo 已提交
2173 2174
        return
    }
W
wuyongning 已提交
2175
    console.log('Sync done.')
P
PaDaBoo 已提交
2176 2177 2178 2179 2180
    for (let i = 0; i < result.length; i++) {
        console.log('device=' + result[i][0] + ' status=' + result[i][1])
    }
})
```
S
sun-dou 已提交
2181

L
lihuihui 已提交
2182
### sync<sup>(deprecated)</sup>
S
sun-dou 已提交
2183

W
wuyongning 已提交
2184
 sync(mode: SyncMode, predicates: RdbPredicates): Promise&lt;Array&lt;[string, number]&gt;&gt;
S
sun-dou 已提交
2185

W
wangxiyue 已提交
2186
在设备之间同步数据,使用Promise异步回调。
S
sun-dou 已提交
2187

L
lihuihui 已提交
2188 2189
> **说明:**
>
2190
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.sync](js-apis-data-relationalStore.md#sync9-1)替代。
L
lihuihui 已提交
2191

W
wuyongning 已提交
2192 2193
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC

L
lihuihui 已提交
2194
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
2195

P
PaDaBoo 已提交
2196
**参数:**
2197

Z
zengyawen 已提交
2198 2199
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
P
PaDaBoo 已提交
2200
| mode | [SyncMode](#syncmodedeprecated) | 是 | 指同步模式。该值可以是推、拉。 |
Z
zengyawen 已提交
2201
| predicates | [RdbPredicates](#rdbpredicates) | 是 | 约束同步数据和设备。 |
S
sun-dou 已提交
2202

Z
zengyawen 已提交
2203
**返回值**
Z
zengyawen 已提交
2204 2205 2206

| 类型 | 说明 |
| -------- | -------- |
L
lihuihui 已提交
2207
| Promise&lt;Array&lt;[string, number]&gt;&gt; | Promise对象,用于向调用者发送同步结果。string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。 |
S
sun-dou 已提交
2208

P
PaDaBoo 已提交
2209
**示例:**
2210

P
PaDaBoo 已提交
2211 2212 2213 2214 2215
```js
let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.inDevices(['12345678abcde'])
let promise = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates)
promise.then((result) =>{
W
wuyongning 已提交
2216
    console.log('Sync done.')
P
PaDaBoo 已提交
2217 2218 2219 2220
    for (let i = 0; i < result.length; i++) {
        console.log('device=' + result[i][0] + ' status=' + result[i][1])
    }
}).catch((err) => {
W
wuyongning 已提交
2221
    console.log('Sync failed')
P
PaDaBoo 已提交
2222 2223
})
```
S
sun-dou 已提交
2224

L
lihuihui 已提交
2225
### on('dataChange')<sup>(deprecated)</sup>
S
sun-dou 已提交
2226

W
wuyongning 已提交
2227
on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void
S
sun-dou 已提交
2228 2229 2230

注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。

L
lihuihui 已提交
2231 2232
> **说明:**
>
2233
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.on](js-apis-data-relationalStore.md#ondatachange9)替代。
W
wuyongning 已提交
2234

L
lihuihui 已提交
2235
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
2236

P
PaDaBoo 已提交
2237
**参数:**
Z
zengyawen 已提交
2238

Z
zengyawen 已提交
2239 2240 2241
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 取值为'dataChange',表示数据更改。 |
P
PaDaBoo 已提交
2242
| type | [SubscribeType](#subscribetypedeprecated) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
Z
zengyawen 已提交
2243
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指分布式数据库中数据更改事件的观察者。 |
S
sun-dou 已提交
2244

P
PaDaBoo 已提交
2245
**示例:**
2246

P
PaDaBoo 已提交
2247 2248 2249 2250 2251 2252 2253 2254 2255
```js
function storeObserver(devices) {
    for (let i = 0; i < devices.length; i++) {
        console.log('device=' + devices[i] + ' data changed')
    }
}
try {
    rdbStore.on('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
W
wuyongning 已提交
2256
    console.log('Register observer failed')
P
PaDaBoo 已提交
2257 2258
}
```
S
sun-dou 已提交
2259

L
lihuihui 已提交
2260
### off('dataChange')<sup>(deprecated)</sup>
S
sun-dou 已提交
2261

W
wuyongning 已提交
2262
off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void
S
sun-dou 已提交
2263

W
wangxiyue 已提交
2264
从数据库中删除指定类型的指定观察者, 使用callback异步回调。
S
sun-dou 已提交
2265

L
lihuihui 已提交
2266 2267
> **说明:**
>
2268
> 从 API Version 7 开始支持,从 API Version 9 开始废弃,建议使用[@ohos.data.relationalStore.RdbStore.off](js-apis-data-relationalStore.md#offdatachange9)替代。
W
wuyongning 已提交
2269

L
lihuihui 已提交
2270
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
W
wuyongning 已提交
2271

P
PaDaBoo 已提交
2272
**参数:**
Z
zengyawen 已提交
2273

Z
zengyawen 已提交
2274 2275 2276
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 取值为'dataChange',表示数据更改。 |
P
PaDaBoo 已提交
2277
| type | [SubscribeType](#subscribetypedeprecated)    | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
Z
zengyawen 已提交
2278
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指已注册的数据更改观察者。|
S
sun-dou 已提交
2279

P
PaDaBoo 已提交
2280
**示例:**
2281

P
PaDaBoo 已提交
2282 2283 2284 2285 2286 2287 2288 2289 2290
```js
function storeObserver(devices) {
    for (let i = 0; i < devices.length; i++) {
        console.log('device=' + devices[i] + ' data changed')
    }
}
try {
    rdbStore.off('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
W
wuyongning 已提交
2291
    console.log('Unregister observer failed')
P
PaDaBoo 已提交
2292 2293
}
```