Skip to content

D
Docs

Coping0606 / Docs
与 Fork 源项目一致

Fork自 OpenHarmony / Docs

通知 1
Star 1
Fork 0
D
Docs

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

未验证 提交 be87c2e7 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!13030 add data.relationStore, update data.rdb、resultSet 

Merge pull request !13030 from PaDaBoo/master
上级 c5ac98aa 9742c8f8
隐藏空白更改
内联 并排
Showing with 3434 addition and 3484 deletion
zh-cn/application-dev/database/database-relational-guidelines.md
浏览文件 @ be87c2e7
......@@ -7,7 +7,7 @@
## 接口说明
以下是关系型数据库的常用接口说明，大部分为异步接口。异步接口均有callback和Promise两种返回形式，下表均以Promise形式为例，更多接口及使用方式请见[关系型数据库](../reference/apis/js-apis-data-rdb.md)。
以下是关系型数据库的常用接口说明，大部分为异步接口。异步接口均有callback和Promise两种返回形式，下表均以Promise形式为例，更多接口及使用方式请见[关系型数据库](../reference/apis/js-apis-data-relationalStore.md)。
### 数据库的创建和删除
......@@ -17,8 +17,8 @@
| 接口名 | 描述 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| getRdbStoreV9(context: Context, config: StoreConfigV9, version: number): Promise&lt;RdbStoreV9&gt; | 获得一个相关的RdbStoreV9，操作关系型数据库，用户可以根据自己的需求配置RdbStoreV9的参数，然后通过RdbStoreV9调用相关接口可以执行相关的数据操作，使用Promise异步回调。<br/>-context：应用程序或功能的上下文。<br/>-config：与此RDB存储相关的数据库配置。<br/>-version：数据库版本。目前暂不支持通过version自动识别数据库升级降级操作，只能由开发者自行维护。 |
| deleteRdbStoreV9(context: Context, name: string): Promise&lt;void&gt; | 使用指定的数据库文件配置删除数据库，使用Promise异步回调。<br/>-context：应用程序或功能的上下文。<br/>-name：数据库名称。 |
| getRdbStore(context: Context, config: StoreConfig): Promise&lt;RdbStore&gt; | 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，使用Promise异步回调。<br/>-context：应用上下文。<br/>-config：与此RDB存储相关的数据库配置。 |
| deleteRdbStore(context: Context, name: string): Promise&lt;void&gt; | 使用指定的数据库文件配置删除数据库，使用Promise异步回调。<br/>-context：应用上下文。<br/>-name：数据库名称。 |
### 数据库的增删改查
......@@ -33,29 +33,29 @@
| 类名 | 接口名 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbStoreV9 | insert(table: string, values: ValuesBucket): Promise&lt;number&gt; | 向目标表中插入一行数据，使用Promise异步回调。<br>如果操作成功，返回行ID；否则返回-1。<br/>-table：指定的目标表名。<br/>-values：表示要插入到表中的数据行。 |
| RdbStore | insert(table: string, values: ValuesBucket): Promise&lt;number&gt; | 向目标表中插入一行数据，使用Promise异步回调。<br>如果操作成功，返回行ID；否则返回-1。<br/>-table：指定的目标表名。<br/>-values：表示要插入到表中的数据行。 |
- **更新**
调用更新接口，传入要更新的数据，并通过RdbPredicatesV9指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败，则返回0。
调用更新接口，传入要更新的数据，并通过RdbPredicates指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败，则返回0。
**表3** 数据库更新API
| 类名 | 接口名 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbStoreV9 | update(values: ValuesBucket, predicates: RdbPredicatesV9): Promise&lt;number&gt; | 根据RdbPredicatesV9的指定实例对象更新数据库中的数据，使用Promise异步回调。<br>返回受影响的行数。<br/>-values：以ValuesBucket存储的要更新的数据。<br/>-predicates：表示RdbPredicatesV9的实例对象指定的更新条件。 |
| RdbStore | update(values: ValuesBucket, predicates: RdbPredicates): Promise&lt;number&gt; | 根据RdbPredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。<br>返回受影响的行数。<br/>-values：以ValuesBucket存储的要更新的数据。<br/>-predicates：表示RdbPredicates的实例对象指定的更新条件。 |
- **删除**
调用删除接口，通过RdbPredicatesV9指定删除条件。该接口的返回值表示删除的数据行数，可根据此值判断是否删除成功。如果删除失败，则返回0。
调用删除接口，通过RdbPredicates指定删除条件。该接口的返回值表示删除的数据行数，可根据此值判断是否删除成功。如果删除失败，则返回0。
**表4** 数据库删除API
| 类名 | 接口名 | 描述 |
| ---------- | ---------------------------------------------------------- | ------------------------------------------------------------ |
| RdbStoreV9 | delete(predicates: RdbPredicatesV9): Promise&lt;number&gt; | 根据RdbPredicatesV9的指定实例对象从数据库中删除数据，使用Promise异步回调。<br>返回受影响的行数。 <br/>-predicates：RdbPredicatesV9的实例对象指定的删除条件。 |
| RdbStore | delete(predicates: RdbPredicates): Promise&lt;number&gt; | 根据RdbPredicates的指定实例对象从数据库中删除数据，使用Promise异步回调。<br>返回受影响的行数。 <br/>-predicates：RdbPredicates的实例对象指定的删除条件。 |
- **查询**
......@@ -66,35 +66,34 @@
**表5** 数据库查询API
| 类名 | 接口名 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbStoreV9 | query(predicates: RdbPredicatesV9, columns?: Array&lt;string&gt;): Promise&lt;ResultSetV9&gt; | 根据指定条件查询数据库中的数据，使用Promise异步回调。<br/>-predicates：表示RdbPredicatesV9的实例对象指定的查询条件。<br/>-columns：表示要查询的列。如果值为空，则查询应用于所有列。 |
| RdbStoreV9 | querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;): Promise&lt;ResultSetV9&gt; | 根据指定SQL语句查询数据库中的数据，使用Promise异步回调。<br/>-sql：指定要查询的SQL语句。<br/>-bindArgs：SQL语句中参数的值。 |
| RdbStoreV9 | remoteQuery(device: string, table: string, predicates: RdbPredicatesV9, columns: Array&lt;string&gt;): Promise&lt;ResultSetV9&gt; | 根据指定条件查询指定远程设备数据库中的数据。使用Promise异步回调。<br/>-device：指定远程查询的设备networkId。<br/>-table：指定远程查询的表名。<br/>-predicates：表示RdbPredicatesV9的实例对象，指定查询的条件。<br/>-columns：表示要查询的列。如果值为空，则查询应用于所有列。 |
| 类名 | 接口名 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbStore | query(predicates: RdbPredicates, columns?: Array&lt;string&gt;): Promise&lt;ResultSet&gt; | 根据指定条件查询数据库中的数据，使用Promise异步回调。<br/>-predicates：表示RdbPredicates的实例对象指定的查询条件。<br/>-columns：表示要查询的列。如果值为空，则查询应用于所有列。 |
| RdbStore | querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;): Promise&lt;ResultSet&gt; | 根据指定SQL语句查询数据库中的数据，使用Promise异步回调。<br/>-sql：指定要查询的SQL语句。<br/>-bindArgs：SQL语句中参数的值。 |
| RdbStore | remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array&lt;string&gt;): Promise&lt;ResultSet&gt; | 根据指定条件查询指定远程设备数据库中的数据。使用Promise异步回调。<br/>-device：指定远程查询的设备networkId。<br/>-table：指定远程查询的表名。<br/>-predicates：表示RdbPredicates的实例对象，指定查询的条件。<br/>-columns：表示要查询的列。如果值为空，则查询应用于所有列。 |
### 数据库谓词的使用
关系型数据库提供了用于设置数据库操作条件的谓词RdbPredicatesV9，该类确定RDB中条件表达式的值是true还是false。
关系型数据库提供了用于设置数据库操作条件的谓词RdbPredicates，该类确定RDB中条件表达式的值是true还是false。
以下列举几个常用谓词，更多谓词的使用请见[关系型数据库谓词](../reference/apis/js-apis-data-rdb.md#rdbpredicates)。
以下列举几个常用谓词，更多谓词的使用请见[关系型数据库谓词](../reference/apis/js-apis-data-relationalStore.md#rdbpredicates)。
**表6** 数据库谓词API
| 类名 | 接口名 | 描述 |
| --------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbPredicatesV9 | equalTo(field: string, value: ValueType): RdbPredicatesV9 | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。<br/>-field：数据库表中的列名。<br/>-value：指示要与谓词匹配的值。<br/>-RdbPredicatesV9：返回与指定字段匹配的谓词。 |
| RdbPredicatesV9 | notEqualTo(field: string, value: ValueType): RdbPredicatesV9 | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。<br/>-field：数据库表中的列名。<br/>-value：指示要与谓词匹配的值。<br/>-RdbPredicatesV9：返回与指定字段匹配的谓词。 |
| RdbPredicatesV9 | or(): RdbPredicatesV9 | 将或条件添加到谓词中。<br/>-RdbPredicatesV9：返回带有或条件的谓词。 |
| RdbPredicatesV9 | and(): RdbPredicatesV9 | 向谓词添加和条件。<br/>-RdbPredicatesV9：返回带有和条件的谓词。 |
| RdbPredicatesV9 | contains(field: string, value: string): RdbPredicatesV9 | 配置谓词以匹配数据字段为String且value包含指定值的字段。<br/>-field：数据库表中的列名。<br/>-value：指示要与谓词匹配的值。<br/>-RdbPredicatesV9：返回带有包含条件的谓词。 |
| RdbPredicates | equalTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。<br/>-field：数据库表中的列名。<br/>-value：指示要与谓词匹配的值。<br/>-RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | notEqualTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。<br/>-field：数据库表中的列名。<br/>-value：指示要与谓词匹配的值。<br/>-RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | or(): RdbPredicates | 将或条件添加到谓词中。<br/>-RdbPredicates：返回带有或条件的谓词。 |
| RdbPredicates | and(): RdbPredicates | 向谓词添加和条件。<br/>-RdbPredicates：返回带有和条件的谓词。 |
| RdbPredicates | contains(field: string, value: string): RdbPredicates | 配置谓词以匹配数据字段为String且value包含指定值的字段。<br/>-field：数据库表中的列名。<br/>-value：指示要与谓词匹配的值。<br/>-RdbPredicates：返回带有包含条件的谓词。 |
### 查询结果集的使用
关系型数据库提供了查询返回的结果集ResultSetV9，其指向查询结果中的一行数据，供用户对查询结果进行遍历和访问。
关系型数据库提供了查询返回的结果集ResultSet，其指向查询结果中的一行数据，供用户对查询结果进行遍历和访问。
更多结果集的接口使用，请见[结果集](../reference/apis/js-apis-data-resultset.md)。
更多结果集的接口使用，请见[结果集](../reference/apis/js-apis-data-relationalStore.md#resultset)。
> **须知：**
> **结果集使用完后，请一定要调用close方法显式关闭。**
......@@ -103,12 +102,12 @@
| 类名 | 接口名 | 描述 |
| ----------- | ---------------------------------------- | ------------------------------------------ |
| ResultSetV9 | goToFirstRow(): boolean | 将结果集移动到第一行。 |
| ResultSetV9 | getString(columnIndex: number): string | 获取当前行指定列的值，以String类型返回。 |
| ResultSetV9 | getBlob(columnIndex: number): Uint8Array | 获取当前行指定列的值，以字节数组形式返回。 |
| ResultSetV9 | getDouble(columnIndex: number): number | 获取当前行指定列的值，以double型返回。 |
| ResultSetV9 | getLong(columnIndex: number): number | 获取当前行指定列的值，以Long形式返回。 |
| ResultSetV9 | close(): void | 关闭结果集。 |
| ResultSet | goToFirstRow(): boolean | 将结果集移动到第一行。 |
| ResultSet | getString(columnIndex: number): string | 获取当前行指定列的值，以String类型返回。 |
| ResultSet | getBlob(columnIndex: number): Uint8Array | 获取当前行指定列的值，以字节数组形式返回。 |
| ResultSet | getDouble(columnIndex: number): number | 获取当前行指定列的值，以double型返回。 |
| ResultSet | getLong(columnIndex: number): number | 获取当前行指定列的值，以Long形式返回。 |
| ResultSet | close(): void | 关闭结果集。 |
......@@ -116,7 +115,7 @@
> **说明：**
>
> - 在使用RdbStoreV9的setDistributedTables、obtainDistributedTableName、sync、on、off接口时，需要请求相应的权限：ohos.permission.DISTRIBUTED_DATASYNC。
> - 在使用RdbStore的setDistributedTables、obtainDistributedTableName、sync、on、off接口时，需要请求相应的权限：ohos.permission.DISTRIBUTED_DATASYNC。
> - 使用分布式列表前，需要先建立设备间组网，具体接口及使用可见[设备管理](../reference/apis/js-apis-device-manager.md)。
**设置分布式列表**
......@@ -125,7 +124,7 @@
| 类名 | 接口名 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbStoreV9 | setDistributedTables(tables: Array\<string>): Promise\<void> | 设置分布式列表，使用Promise异步回调。<br/>-tables：要设置的分布式列表表名。 |
| RdbStore | setDistributedTables(tables: Array\<string>): Promise\<void> | 设置分布式列表，使用Promise异步回调。<br/>-tables：要设置的分布式列表表名。 |
**根据本地表名获取指定远程设备的分布式表名**
......@@ -135,7 +134,7 @@
| 类名 | 接口名 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbStoreV9 | obtainDistributedTableName(device: string, table: string): Promise\<string> | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，使用Promise异步回调。<br/>-device：远程设备。<br/>-table：本地表名。 |
| RdbStore | obtainDistributedTableName(device: string, table: string): Promise\<string> | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，使用Promise异步回调。<br/>-device：远程设备。<br/>-table：本地表名。 |
**在设备之间同步数据**
......@@ -143,7 +142,7 @@
| 类名 | 接口名 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbStoreV9 | sync(mode: SyncMode, predicates: RdbPredicatesV9): Promise\<Array\<[string, number]>> | 在设备之间同步数据，使用Promise异步回调。<br/>-mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。<br/>-predicates：约束同步数据和设备。<br>-string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise\<Array\<[string, number]>> | 在设备之间同步数据，使用Promise异步回调。<br/>-mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。<br/>-predicates：约束同步数据和设备。<br>-string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
**注册数据库的观察者**
......@@ -151,7 +150,7 @@
| 类名 | 接口名 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbStoreV9 | on(event: 'dataChange', type: SubscribeType, observer: Callback\<Array\<string>>): void | 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。<br/>-type：订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-observer：指分布式数据库中数据更改事件的观察者。 |
| RdbStore | on(event: 'dataChange', type: SubscribeType, observer: Callback\<Array\<string>>): void | 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。<br/>-type：订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-observer：指分布式数据库中数据更改事件的观察者。 |
**从数据库中删除指定类型的指定观察者**
......@@ -159,7 +158,7 @@
| 类名 | 接口名 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| RdbStoreV9 | off(event:'dataChange', type: SubscribeType, observer: Callback\<Array\<string>>): void; | 从数据库中删除指定类型的指定观察者，使用callback异步回调。<br/>-type：订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-observer：指已注册的数据更改观察者。 |
| RdbStore | off(event:'dataChange', type: SubscribeType, observer: Callback\<Array\<string>>): void; | 从数据库中删除指定类型的指定观察者，使用callback异步回调。<br/>-type：订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-observer：指已注册的数据更改观察者。 |
### 数据库的备份和恢复
......@@ -169,7 +168,7 @@
| 类名 | 接口名 | 描述 |
| ---------- | --------------------------------------------- | ------------------------------------------------------------ |
| RdbStoreV9 | backup(destName: string): Promise&lt;void&gt; | 以指定名称备份数据库，使用Promise异步回调。<br/>-destName：指定数据库的备份文件名。 |
| RdbStore | backup(destName: string): Promise&lt;void&gt; | 以指定名称备份数据库，使用Promise异步回调。<br/>-destName：指定数据库的备份文件名。 |
**恢复**
......@@ -177,17 +176,17 @@
| 类名 | 接口名 | 描述 |
| ---------- | --------------------------------------------- | ------------------------------------------------------------ |
| RdbStoreV9 | restore(srcName: string): Promise&lt;void&gt; | 从指定的数据库备份文件恢复数据库，使用Promise异步回调。<br/>-srcName：指定数据库的备份文件名。 |
| RdbStore | restore(srcName: string): Promise&lt;void&gt; | 从指定的数据库备份文件恢复数据库，使用Promise异步回调。<br/>-srcName：指定数据库的备份文件名。 |
**事务**
### 事务
**表15** 事务
| 类名 | 接口名 | 描述 |
| -------- | ----------------------- | --------------------------------- |
| RdbStoreV9 | beginTransaction(): void | 在开始执行SQL语句之前，开始事务。 |
| RdbStoreV9 | commit(): void | 提交已执行的SQL语句。 |
| RdbStoreV9 | rollBack(): void | 回滚已经执行的SQL语句。 |
| RdbStore | beginTransaction(): void | 在开始执行SQL语句之前，开始事务。 |
| RdbStore | commit(): void | 提交已执行的SQL语句。 |
| RdbStore | rollBack(): void | 回滚已经执行的SQL语句。 |
## 开发步骤
......@@ -202,23 +201,23 @@
FA模型示例：
```js
import data_rdb from '@ohos.data.rdb'
import data_rdb from '@ohos.data.relationalStore'
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const CREATE_TABLE_TEST = "CREATE TABLE IF NOT EXISTS test (" + "id INTEGER PRIMARY KEY AUTOINCREMENT, " + "name TEXT NOT NULL, " + "age INTEGER, " + "salary REAL, " + "blobType BLOB)";
const STORE_CONFIGV9 = { name: "RdbTest.db",
const STORE_CONFIG = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1, function (err, rdbStoreV9) {
rdbStoreV9.executeSql(CREATE_TABLE_TEST)
data_rdb.getRdbStore(context, STORE_CONFIG, function (err, rdbStore) {
rdbStore.executeSql(CREATE_TABLE_TEST)
console.info('create table done.')
})
```
Stage模型示例：
```ts
import data_rdb from '@ohos.data.rdb'
import data_rdb from '@ohos.data.relationalStore'
// 获取context
import Ability from '@ohos.application.Ability'
let context = null
......@@ -230,10 +229,10 @@
const CREATE_TABLE_TEST = "CREATE TABLE IF NOT EXISTS test (" + "id INTEGER PRIMARY KEY AUTOINCREMENT, " + "name TEXT NOT NULL, " + "age INTEGER, " + "salary REAL, " + "blobType BLOB)";
const STORE_CONFIGV9 = { name: "rdbstore.db",
const STORE_CONFIG = { name: "rdbstore.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1, function (err, rdbStoreV9) {
rdbStoreV9.executeSql(CREATE_TABLE_TEST)
data_rdb.getRdbStore(context, STORE_CONFIG, function (err, rdbStore) {
rdbStore.executeSql(CREATE_TABLE_TEST)
console.info('create table done.')
})
```
......@@ -247,9 +246,24 @@
示例代码如下：
```js
var u8 = new Uint8Array([1, 2, 3])
let u8 = new Uint8Array([1, 2, 3])
const valueBucket = { "name": "Tom", "age": 18, "salary": 100.5, "blobType": u8 }
let insertPromise = rdbStoreV9.insert("test", valueBucket)
let insertPromise = rdbStore.insert("test", valueBucket)
```
```js
//使用事务插入数据
beginTransaction()
try {
let u8 = new Uint8Array([1, 2, 3])
const valueBucket1 = { "name": "Tom", "age": 18, "salary": 100.5, "blobType": u8 }
const valueBucket2 = { "name": "Jam", "age": 19, "salary": 200.5, "blobType": u8 }
let insertPromise1 = rdbStore.insert("test", valueBucket1)
let insertPromise2 = rdbStore.insert("test", valueBucket2)
commit()
} catch (e) {
rollBack()
}
```
3. 查询数据。
......@@ -263,17 +277,17 @@
示例代码如下：
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("test");
predicatesV9.equalTo("name", "Tom")
let promisequery = rdbStoreV9.query(predicatesV9)
promisequery.then((resultSetV9) => {
resultSetV9.goToFirstRow()
const id = resultSetV9.getLong(resultSetV9.getColumnIndex("id"))
const name = resultSetV9.getString(resultSetV9.getColumnIndex("name"))
const age = resultSetV9.getLong(resultSetV9.getColumnIndex("age"))
const salary = resultSetV9.getDouble(resultSetV9.getColumnIndex("salary"))
const blobType = resultSetV9.getBlob(resultSetV9.getColumnIndex("blobType"))
resultSetV9.close()
let predicates = new data_rdb.RdbPredicates("test");
predicates.equalTo("name", "Tom")
let promisequery = rdbStore.query(predicates)
promisequery.then((resultSet) => {
resultSet.goToFirstRow()
const id = resultSet.getLong(resultSet.getColumnIndex("id"))
const name = resultSet.getString(resultSet.getColumnIndex("name"))
const age = resultSet.getLong(resultSet.getColumnIndex("age"))
const salary = resultSet.getDouble(resultSet.getColumnIndex("salary"))
const blobType = resultSet.getBlob(resultSet.getColumnIndex("blobType"))
resultSet.close()
})
```
......@@ -301,7 +315,7 @@
context.requestPermissionsFromUser(['ohos.permission.DISTRIBUTED_DATASYNC'], 666, function (result) {
console.info(`result.requestCode=${result.requestCode}`)
})
let promise = rdbStoreV9.setDistributedTables(["test"])
let promise = rdbStore.setDistributedTables(["test"])
promise.then(() => {
console.info("setDistributedTables success.")
}).catch((err) => {
......@@ -320,9 +334,9 @@
示例代码如下：
```js
let predicateV9 = new data_rdb.RdbPredicatesV9('test')
predicateV9.inDevices(['12345678abcde'])
let promise = rdbStoreV9.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicateV9)
let predicate = new data_rdb.RdbPredicates('test')
predicate.inDevices(['12345678abcde'])
let promise = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicate)
promise.then((result) => {
console.log('sync done.')
for (let i = 0; i < result.length; i++) {
......@@ -349,7 +363,7 @@
}
try {
rdbStoreV9.on('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
rdbStore.on('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
console.log('register observer failed')
}
......@@ -364,8 +378,8 @@
示例代码如下：
```js
let tableName = rdbStoreV9.obtainDistributedTableName(deviceId, "test");
let resultSetV9 = rdbStoreV9.querySql("SELECT * FROM " + tableName)
let tableName = rdbStore.obtainDistributedTableName(deviceId, "test");
let resultSet = rdbStore.querySql("SELECT * FROM " + tableName)
```
8. 远程查询。
......@@ -378,17 +392,17 @@
示例代码如下：
```js
let rdbPredicateV9 = new data_rdb.RdbPredicatesV9('employee')
predicatesV9.greaterThan("id", 0)
let promiseQuery = rdbStoreV9.remoteQuery('12345678abcde', 'employee', rdbPredicateV9)
promiseQuery.then((resultSetV9) => {
while (resultSetV9.goToNextRow()) {
let idx = resultSetV9.getLong(0);
let name = resultSetV9.getString(1);
let age = resultSetV9.getLong(2);
let rdbPredicate = new data_rdb.RdbPredicates('employee')
predicates.greaterThan("id", 0)
let promiseQuery = rdbStore.remoteQuery('12345678abcde', 'employee', rdbPredicate)
promiseQuery.then((resultSet) => {
while (resultSet.goToNextRow()) {
let idx = resultSet.getLong(0);
let name = resultSet.getString(1);
let age = resultSet.getLong(2);
console.info(idx + " " + name + " " + age);
}
resultSetV9.close();
resultSet.close();
}).catch((err) => {
console.info("failed to remoteQuery, err: " + err)
})
......@@ -401,7 +415,7 @@
示例代码如下：
```js
let promiseBackup = rdbStoreV9.backup("dbBackup.db")
let promiseBackup = rdbStore.backup("dbBackup.db")
promiseBackup.then(() => {
console.info('Backup success.')
}).catch((err) => {
......@@ -413,7 +427,7 @@
示例代码如下：
```js
let promiseRestore = rdbStoreV9.restore("dbBackup.db")
let promiseRestore = rdbStore.restore("dbBackup.db")
promiseRestore.then(() => {
console.info('Restore success.')
}).catch((err) => {
......
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
浏览文件 @ be87c2e7
......@@ -4,307 +4,27 @@
该模块提供以下关系型数据库相关的常用功能：
- [RdbPredicatesV9](#rdbpredicatesv99)： 数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项，主要用来定义数据库的操作条件。
- [RdbStoreV9](#rdbstorev99)：提供管理关系数据库(RDB)方法的接口。
- [RdbPredicates](#rdbpredicates)： 数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项，主要用来定义数据库的操作条件。
- [RdbStore](#rdbstore)：提供管理关系数据库(RDB)方法的接口。
> **说明：**
>
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 从API Version 9开始，该接口不再维护，推荐使用新接口[@ohos.data.relationalStore](js-apis-data-relationalStore.md)。
## 导入模块
```js
import data_rdb from '@ohos.data.rdb';
```
## data_rdb.getRdbStoreV9<sup>9+</sup>
getRdbStoreV9(context: Context, config: StoreConfigV9, version: number, callback: AsyncCallback&lt;RdbStoreV9&gt;): void
获得一个相关的RdbStoreV9，操作关系型数据库，用户可以根据自己的需求配置RdbStoreV9的参数，然后通过RdbStoreV9调用相关接口可以执行相关的数据操作，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| config | [StoreConfigV9](#storeconfigv99) | 是 | 与此RDB存储相关的数据库配置。 |
| version | number | 是 | 数据库版本。<br>目前暂不支持通过version自动识别数据库升级降级操作，只能由开发者自行维护。 |
| callback | AsyncCallback&lt;[RdbStoreV9](#rdbstorev9)&gt; | 是 | 指定callback回调函数，返回RdbStoreV9对象。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ----------------------- |
| 14800010 | Invalid database name. |
| 14800011 | Database corrupted. |
**示例：**
FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
// 获取context后调用getRdbStoreV9
const STORE_CONFIGV9 = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1, function (err, rdbStoreV9) {
if (err) {
console.info("Get RdbStoreV9 failed, err: " + err)
return
}
console.log("Get RdbStoreV9 successfully.")
})
```
Stage模型示例：
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
// 获取context后调用getRdbStoreV9
const STORE_CONFIGV9 = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1, function (err, rdbStoreV9) {
if (err) {
console.info("Get RdbStoreV9 failed, err: " + err)
return
}
console.log("Get RdbStoreV9 successfully.")
})
```
## data_rdb.getRdbStoreV9<sup>9+</sup>
getRdbStoreV9(context: Context, config: StoreConfigV9, version: number): Promise&lt;RdbStoreV9&gt;
获得一个相关的RdbStoreV9，操作关系型数据库，用户可以根据自己的需求配置RdbStoreV9的参数，然后通过RdbStoreV9调用相关接口可以执行相关的数据操作，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| config | [StoreConfigV9](#storeconfigv99) | 是 | 与此RDB存储相关的数据库配置。 |
| version | number | 是 | 数据库版本。<br>目前暂不支持通过version自动识别数据库升级降级操作，只能由开发者自行维护。 |
**返回值**：
| 类型 | 说明 |
| ----------------------------------------- | --------------------------------- |
| Promise&lt;[RdbStoreV9](#rdbstorev99)&gt; | Promise对象。返回RdbStoreV9对象。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ----------------------- |
| 14800010 | Invalid database name. |
| 14800011 | Database corrupted. |
**示例：**
FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
// 获取context后调用getRdbStoreV9
const STORE_CONFIGV9 = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
let promise = data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1);
promise.then(async (rdbStoreV9) => {
console.log("Get RdbStoreV9 successfully.")
}).catch((err) => {
console.log("Get RdbStoreV9 failed, err: " + err)
})
```
Stage模型示例：
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
// 获取context后调用getRdbStoreV9
const STORE_CONFIGV9 = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
let promise = data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1);
promise.then(async (rdbStoreV9) => {
console.log("Get RdbStoreV9 successfully.")
}).catch((err) => {
console.log("Get RdbStoreV9 failed, err: " + err)
})
```
## data_rdb.deleteRdbStoreV9<sup>9+</sup>
deleteRdbStoreV9(context: Context, name: string, callback: AsyncCallback&lt;void&gt;): void
删除数据库，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| 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回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ----------------------- |
| 14800010 | Invalid database name. |
**示例：**
FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
// 获取context后调用deleteRdbStoreV9
data_rdb.deleteRdbStoreV9(context, "RdbTest.db", function (err) {
if (err) {
console.info("Delete RdbStorev9 failed, err: " + err)
return
}
console.log("Delete RdbStorev9 successfully.")
})
```
Stage模型示例：
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
// 获取context后调用deleteRdbStoreV9
data_rdb.deleteRdbStoreV9(context, "RdbTest.db", function (err) {
if (err) {
console.info("Delete RdbStoreV9 failed, err: " + err)
return
}
console.log("Delete RdbStoreV9 successfully.")
})
```
## data_rdb.deleteRdbStoreV9<sup>9+</sup>
deleteRdbStoreV9(context: Context, name: string): Promise&lt;void&gt;
使用指定的数据库文件配置删除数据库，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| name | string | 是 | 数据库名称。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ----------------------- |
| 14800010 | Invalid database name. |
**示例：**
FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
// 获取context后调用deleteRdbStoreV9
let promise = data_rdb.deleteRdbStoreV9(context, "RdbTest.db")
promise.then(()=>{
console.log("Delete RdbStoreV9 successfully.")
}).catch((err) => {
console.info("Delete RdbStoreV9 failed, err: " + err)
})
```
Stage模型示例：
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
// 获取context后调用deleteRdbStoreV9
let promise = data_rdb.deleteRdbStoreV9(context, "RdbTest.db")
promise.then(()=>{
console.log("Delete RdbStoreV9 successfully.")
}).catch((err) => {
console.info("Delete RdbStoreV9 failed, err: " + err)
})
```
## data_rdb.getRdbStore<sup>(deprecated)</sup>
## data_rdb.getRdbStore
getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback&lt;RdbStore&gt;): void
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，使用callback异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[data_rdb.getRdbStoreV9](#data_rdbgetrdbstorev99)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -359,16 +79,12 @@ data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
})
```
## data_rdb.getRdbStore<sup>(deprecated)</sup>
## data_rdb.getRdbStore
getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt;RdbStore&gt;
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[data_rdb.getRdbStoreV9](#data_rdbgetrdbstorev99-1)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -426,16 +142,12 @@ promise.then(async (rdbStore) => {
})
```
## data_rdb.deleteRdbStore<sup>(deprecated)</sup>
## data_rdb.deleteRdbStore
deleteRdbStore(context: Context, name: string, callback: AsyncCallback&lt;void&gt;): void
删除数据库，使用callback异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[data_rdb.deleteRdbStoreV9](#data_rdbdeleterdbstorev99)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -487,2205 +199,65 @@ data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
})
```
## data_rdb.deleteRdbStore<sup>(deprecated)</sup>
deleteRdbStore(context: Context, name: string): Promise&lt;void&gt;
使用指定的数据库文件配置删除数据库，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[data_rdb.deleteRdbStoreV9](#data_rdbdeleterdbstorev99-1)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| name | string | 是 | 数据库名称。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
FA模型示例：
```js
// 获取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.")
}).catch((err) => {
console.info("Delete RdbStore failed, err: " + err)
})
```
Stage模型示例：
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
// 获取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)
})
```
## RdbPredicatesV9<sup>9+</sup>
表示关系型数据库（RDB）的谓词。该类确定RDB中条件表达式的值是true还是false。
### constructor<sup>9+</sup>
constructor(name: string)
构造函数。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------ |
| name | string | 是 | 数据库表名。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
```
### inDevices<sup>9+</sup>
inDevices(devices: Array&lt;string&gt;): RdbPredicatesV9
同步分布式数据库时连接到组网内指定的远程设备。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------- | ---- | -------------------------- |
| devices | Array&lt;string&gt; | 是 | 指定的组网内的远程设备ID。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.inDevices(['12345678abcde'])
```
### inAllDevices<sup>9+</sup>
inAllDevices(): RdbPredicatesV9
同步分布式数据库时连接到组网内所有的远程设备。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesv9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.inAllDevices()
```
### equalTo<sup>9+</sup>
equalTo(field: string, value: ValueType): RdbPredicatesV9
配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "lisi")
```
### notEqualTo<sup>9+</sup>
notEqualTo(field: string, value: ValueType): RdbPredicatesV9
配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.notEqualTo("NAME", "lisi")
```
### beginWrap<sup>9+</sup>
beginWrap(): RdbPredicatesV9
向谓词添加左括号。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回带有左括号的Rdb谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "lisi")
.beginWrap()
.equalTo("AGE", 18)
.or()
.equalTo("SALARY", 200.5)
.endWrap()
```
### endWrap<sup>9+</sup>
endWrap(): RdbPredicatesV9
向谓词添加右括号。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回带有右括号的Rdb谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "lisi")
.beginWrap()
.equalTo("AGE", 18)
.or()
.equalTo("SALARY", 200.5)
.endWrap()
```
### or<sup>9+</sup>
or(): RdbPredicatesV9
将或条件添加到谓词中。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回带有或条件的Rdb谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
.or()
.equalTo("NAME", "Rose")
```
### and<sup>9+</sup>
and(): RdbPredicatesV9
向谓词添加和条件。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回带有和条件的Rdb谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
.and()
.equalTo("SALARY", 200.5)
```
### contains<sup>9+</sup>
contains(field: string, value: string): RdbPredicatesV9
配置谓词以匹配数据字段为string且value包含指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.contains("NAME", "os")
```
### beginsWith<sup>9+</sup>
beginsWith(field: string, value: string): RdbPredicatesV9
配置谓词以匹配数据字段为string且值以指定字符串开头的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.beginsWith("NAME", "os")
```
### endsWith<sup>9+</sup>
endsWith(field: string, value: string): RdbPredicatesV9
配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.endsWith("NAME", "se")
```
### isNull<sup>9+</sup>
isNull(field: string): RdbPredicatesV9
配置谓词以匹配值为null的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| field | string | 是 | 数据库表中的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例**：
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.isNull("NAME")
```
### isNotNull<sup>9+</sup>
isNotNull(field: string): RdbPredicatesV9
配置谓词以匹配值不为null的指定字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| field | string | 是 | 数据库表中的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.isNotNull("NAME")
```
### like<sup>9+</sup>
like(field: string, value: string): RdbPredicatesV9
配置谓词以匹配数据字段为string且值类似于指定字符串的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.like("NAME", "%os%")
```
### glob<sup>9+</sup>
glob(field: string, value: string): RdbPredicatesV9
配置RdbPredicatesV9匹配数据字段为string的指定字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。<br>支持通配符，*表示0个、1个或多个数字或字符，?表示1个数字或字符。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.glob("NAME", "?h*g")
```
### between<sup>9+</sup>
between(field: string, low: ValueType, high: ValueType): RdbPredicatesV9
将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | -------------------------- |
| field | string | 是 | 数据库表中的列名。 |
| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.between("AGE", 10, 50)
```
### notBetween<sup>9+</sup>
notBetween(field: string, low: ValueType, high: ValueType): RdbPredicatesV9
配置RdbPredicatesV9以匹配数据字段为ValueType且value超出给定范围的指定字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | -------------------------- |
| field | string | 是 | 数据库表中的列名。 |
| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.notBetween("AGE", 10, 50)
```
### greaterThan<sup>9+</sup>
greaterThan(field: string, value: ValueType): RdbPredicatesV9
配置谓词以匹配数据字段为ValueType且值大于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.greaterThan("AGE", 18)
```
### lessThan<sup>9+</sup>
lessThan(field: string, value: ValueType): RdbPredicatesV9
配置谓词以匹配数据字段为valueType且value小于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.lessThan("AGE", 20)
```
### greaterThanOrEqualTo<sup>9+</sup>
greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicatesV9
配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.greaterThanOrEqualTo("AGE", 18)
```
### lessThanOrEqualTo<sup>9+</sup>
lessThanOrEqualTo(field: string, value: ValueType): RdbPredicatesV9
配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.lessThanOrEqualTo("AGE", 20)
```
### orderByAsc<sup>9+</sup>
orderByAsc(field: string): RdbPredicatesV9
配置谓词以匹配其值按升序排序的列。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| field | string | 是 | 数据库表中的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.orderByAsc("NAME")
```
### orderByDesc<sup>9+</sup>
orderByDesc(field: string): RdbPredicatesV9
配置谓词以匹配其值按降序排序的列。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| field | string | 是 | 数据库表中的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.orderByDesc("AGE")
```
### distinct<sup>9+</sup>
distinct(): RdbPredicatesV9
配置谓词以过滤重复记录并仅保留其中一个。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------------ |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回可用于过滤重复记录的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose").distinct()
```
### limitAs<sup>9+</sup>
limitAs(value: number): RdbPredicatesV9
设置最大数据记录数的谓词。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------- |
| value | number | 是 | 最大数据记录数。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------------------ |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回可用于设置最大数据记录数的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose").limitAs(3)
```
### offsetAs<sup>9+</sup>
offsetAs(rowOffset: number): RdbPredicatesV9
配置RdbPredicatesV9以指定返回结果的起始位置。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------------------------------- |
| rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------------------ |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回具有指定返回结果起始位置的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose").offsetAs(3)
```
### groupBy<sup>9+</sup>
groupBy(fields: Array&lt;string&gt;): RdbPredicatesV9
配置RdbPredicatesV9按指定列分组查询结果。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------- | ---- | -------------------- |
| fields | Array&lt;string&gt; | 是 | 指定分组依赖的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ---------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回分组查询列的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.groupBy(["AGE", "NAME"])
```
### indexedBy<sup>9+</sup>
indexedBy(field: string): RdbPredicatesV9
配置RdbPredicatesV9以指定索引列。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- |
| field | string | 是 | 索引列的名称。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回具有指定索引列的RdbPredicatesV9。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.indexedBy("SALARY_INDEX")
```
### in<sup>9+</sup>
in(field: string, value: Array&lt;ValueType&gt;): RdbPredicatesV9
配置RdbPredicatesV9以匹配数据字段为ValueType数组且值在给定范围内的指定字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------------ | ---- | --------------------------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array&lt;[ValueType](#valuetype)&gt; | 是 | 以ValueType型数组形式指定的要匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.in("AGE", [18, 20])
```
### notIn<sup>9+</sup>
notIn(field: string, value: Array&lt;ValueType&gt;): RdbPredicatesV9
将RdbPredicatesV9配置为匹配数据字段为ValueType且值超出给定范围的指定字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------------ | ---- | ------------------------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array&lt;[ValueType](#valuetype)&gt; | 是 | 以ValueType数组形式指定的要匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicatesV9](#rdbpredicatesv99) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.notIn("NAME", ["Lisa", "Rose"])
```
## RdbStoreV9<sup>9+</sup>
提供管理关系数据库(RDB)方法的接口。
在使用以下相关接口前，请使用[executeSql](#executesql)接口初始化数据库表结构和相关数据，具体可见[关系型数据库开发指导](../../database/database-relational-guidelines.md)。
### insert<sup>9+</sup>
insert(table: string, values: ValuesBucket, callback: AsyncCallback&lt;number&gt;):void
向目标表中插入一行数据，使用callback异步回调。
**系统能力：** 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]),
}
rdbStoreV9.insert("EMPLOYEE", valueBucket, function (status, rowId) {
if (status) {
console.log("Insert is failed");
return;
}
console.log("Insert is successful, rowId = " + rowId);
})
```
### insert<sup>9+</sup>
insert(table: string, values: ValuesBucket):Promise&lt;number&gt;
向目标表中插入一行数据，使用Promise异步回调。
**系统能力：** 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 = rdbStoreV9.insert("EMPLOYEE", valueBucket)
promise.then((rowId) => {
console.log("Insert is successful, rowId = " + rowId);
}).catch((status) => {
console.log("Insert is failed");
})
```
### batchInsert<sup>9+</sup>
batchInsert(table: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;):void
向目标表中插入一组数据，使用callback异步回调。
**系统能力：** 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);
rdbStoreV9.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>9+</sup>
batchInsert(table: string, values: Array&lt;ValuesBucket&gt;):Promise&lt;number&gt;
向目标表中插入一组数据，使用Promise异步回调。
**系统能力：** 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 = rdbStoreV9.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>9+</sup>
update(values: ValuesBucket, predicates: RdbPredicatesV9, callback: AsyncCallback&lt;number&gt;):void
根据RdbPredicatesV9的指定实例对象更新数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | RdbPredicatesV9的实例对象指定的更新条件。 |
| 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 predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
rdbStoreV9.update(valueBucket, predicatesV9, function (err, ret) {
if (err) {
console.info("Updated failed, err: " + err)
return
}
console.log("Updated row count: " + ret)
})
```
### update<sup>9+</sup>
update(values: ValuesBucket, predicates: RdbPredicatesV9):Promise&lt;number&gt;
根据RdbPredicatesV9的指定实例对象更新数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------------------ | ---- | ------------------------------------------------------------ |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicatesV9 | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | RdbPredicatesV9的实例对象指定的更新条件。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ----------------------------------------- |
| Promise&lt;number&gt; | 指定的Promise回调方法。返回受影响的行数。 |
**示例：**
```js
const valueBucket = {
"NAME": "Rose",
"AGE": 22,
"SALARY": 200.5,
"CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
let promise = rdbStoreV9.update(valueBucket, predicatesV9)
promise.then(async (ret) => {
console.log("Updated row count: " + ret)
}).catch((err) => {
console.info("Updated failed, err: " + err)
})
```
### update<sup>9+</sup>
update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;):void
根据DataSharePredicates的指定实例对象更新数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| table | string | 是 | 指定的目标表名。 |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的更新条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定的callback回调方法。返回受影响的行数。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
const valueBucket = {
"NAME": "Rose",
"AGE": 22,
"SALARY": 200.5,
"CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
rdbStoreV9.update("EMPLOYEE", valueBucket, predicates, function (err, ret) {
if (err) {
console.info("Updated failed, err: " + err)
return
}
console.log("Updated row count: " + ret)
})
```
### update<sup>9+</sup>
update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates):Promise&lt;number&gt;
根据DataSharePredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| table | string | 是 | 指定的目标表名。 |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的更新条件。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ----------------------------------------- |
| Promise&lt;number&gt; | 指定的Promise回调方法。返回受影响的行数。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
const valueBucket = {
"NAME": "Rose",
"AGE": 22,
"SALARY": 200.5,
"CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
let promise = rdbStoreV9.update("EMPLOYEE", valueBucket, predicates)
promise.then(async (ret) => {
console.log("Updated row count: " + ret)
}).catch((err) => {
console.info("Updated failed, err: " + err)
})
```
### delete<sup>9+</sup>
delete(predicates: RdbPredicatesV9, callback: AsyncCallback&lt;number&gt;):void
根据RdbPredicatesV9的指定实例对象从数据库中删除数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ----------------------------------------- |
| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | RdbPredicatesV9的实例对象指定的删除条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。返回受影响的行数。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
rdbStoreV9.delete(predicatesV9, function (err, rows) {
if (err) {
console.info("Delete failed, err: " + err)
return
}
console.log("Delete rows: " + rows)
})
```
### delete<sup>9+</sup>
delete(predicates: RdbPredicatesV9):Promise&lt;number&gt;
根据RdbPredicatesV9的指定实例对象从数据库中删除数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ----------------------------------------- |
| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | RdbPredicatesV9的实例对象指定的删除条件。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ------------------------------- |
| Promise&lt;number&gt; | Promise对象。返回受影响的行数。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
let promise = rdbStoreV9.delete(predicatesV9)
promise.then((rows) => {
console.log("Delete rows: " + rows)
}).catch((err) => {
console.info("Delete failed, err: " + err)
})
```
### delete<sup>9+</sup>
delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;):void
根据DataSharePredicates的指定实例对象从数据库中删除数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
| table | string | 是 | 指定的目标表名。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的删除条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。返回受影响的行数。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
rdbStoreV9.delete("EMPLOYEE", predicates, function (err, rows) {
if (err) {
console.info("Delete failed, err: " + err)
return
}
console.log("Delete rows: " + rows)
})
```
### delete<sup>9+</sup>
delete(table: string, predicates: dataSharePredicates.DataSharePredicates):Promise&lt;number&gt;
根据DataSharePredicates的指定实例对象从数据库中删除数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
| table | string | 是 | 指定的目标表名。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的删除条件。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ------------------------------- |
| Promise&lt;number&gt; | Promise对象。返回受影响的行数。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
let promise = rdbStoreV9.delete("EMPLOYEE", predicates)
promise.then((rows) => {
console.log("Delete rows: " + rows)
}).catch((err) => {
console.info("Delete failed, err: " + err)
})
```
### query<sup>9+</sup>
query(predicates: RdbPredicatesV9, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;ResultSetV9&gt;):void
根据指定条件查询数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | RdbPredicatesV9的实例对象指定的查询条件。 |
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
| callback | AsyncCallback&lt;[ResultSetV9](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSetV9对象。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose")
rdbStoreV9.query(predicatesV9, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSetV9) {
if (err) {
console.info("Query failed, err: " + err)
return
}
console.log("ResultSet column names: " + resultSetV9.columnNames)
console.log("ResultSet column count: " + resultSetV9.columnCount)
})
```
### query<sup>9+</sup>
query(predicates: RdbPredicatesV9, columns?: Array&lt;string&gt;):Promise&lt;ResultSetV9&gt;
根据指定条件查询数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ------------------------------------------------ |
| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | RdbPredicatesV9的实例对象指定的查询条件。 |
| columns | Array&lt;string&gt; | 否 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------------------------- | -------------------------------------------------- |
| Promise&lt;[ResultSetV9](js-apis-data-resultset.md)&gt; | Promise对象。如果操作成功，则返回ResultSetV9对象。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose")
let promise = rdbStoreV9.query(predicatesV9, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promise.then((resultSetV9) => {
console.log("ResultSet column names: " + resultSetV9.columnNames)
console.log("ResultSet column count: " + resultSetV9.columnCount)
}).catch((err) => {
console.info("Query failed, err: " + err)
})
```
### query<sup>9+</sup>
query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;ResultSetV9&gt;):void
根据指定条件查询数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| table | string | 是 | 指定的目标表名。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的查询条件。 |
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
| callback | AsyncCallback&lt;[ResultSetV9](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSetV9对象。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose")
rdbStoreV9.query("EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSetV9) {
if (err) {
console.info("Query failed, err: " + err)
return
}
console.log("ResultSet column names: " + resultSetV9.columnNames)
console.log("ResultSet column count: " + resultSetV9.columnCount)
})
```
### query<sup>9+</sup>
query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns?: Array&lt;string&gt;):Promise&lt;ResultSetV9&gt;
根据指定条件查询数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ |
| table | string | 是 | 指定的目标表名。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的查询条件。 |
| columns | Array&lt;string&gt; | 否 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------------------------- | -------------------------------------------------- |
| Promise&lt;[ResultSetV9](js-apis-data-resultset.md)&gt; | Promise对象。如果操作成功，则返回ResultSetV9对象。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose")
let promise = rdbStoreV9.query("EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promise.then((resultSetV9) => {
console.log("ResultSet column names: " + resultSetV9.columnNames)
console.log("ResultSet column count: " + resultSetV9.columnCount)
}).catch((err) => {
console.info("Query failed, err: " + err)
})
```
### remoteQuery<sup>9+</sup>
remoteQuery(device: string, table: string, predicates: RdbPredicatesV9, columns: Array&lt;string&gt; , callback: AsyncCallback&lt;ResultSetV9&gt;): void
根据指定条件查询远程设备数据库中的数据。使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| device | string | 是 | 指定的远程设备的networkId。 |
| table | string | 是 | 指定的目标表名。 |
| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | RdbPredicatesV9的实例对象，指定查询的条件。 |
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
| callback | AsyncCallback&lt;[ResultSetV9](js-apis-data-resultset.md#resultset)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSetV9对象。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9('EMPLOYEE')
predicatesV9.greaterThan("id", 0)
rdbStoreV9.remoteQuery("deviceId", "EMPLOYEE", predicatesV9, ["ID", "NAME", "AGE", "SALARY", "CODES"],
function(err, resultSetV9){
if (err) {
console.info("Failed to remoteQuery, err: " + err)
return
}
console.info("ResultSet column names: " + resultSetV9.columnNames)
console.info("ResultSet column count: " + resultSetV9.columnCount)
})
```
### remoteQuery<sup>9+</sup>
remoteQuery(device: string, table: string, predicates: RdbPredicatesV9, columns: Array&lt;string&gt;): Promise&lt;ResultSetV9&gt;
根据指定条件查询远程设备数据库中的数据。使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ------------------------------------------------ |
| device | string | 是 | 指定的远程设备的networkId。 |
| table | string | 是 | 指定的目标表名。 |
| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | RdbPredicatesV9的实例对象，指定查询的条件。 |
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------------------------------ | -------------------------------------------------- |
| Promise&lt;[ResultSetV9](js-apis-data-resultset.md#resultset)&gt; | Promise对象。如果操作成功，则返回ResultSetV9对象。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9('EMPLOYEE')
predicatesV9.greaterThan("id", 0)
let promise = rdbStoreV9.remoteQuery("deviceId", "EMPLOYEE", predicatesV9, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promise.then((resultSetV9) => {
console.info("ResultSet column names: " + resultSetV9.columnNames)
console.info("ResultSet column count: " + resultSetV9.columnCount)
}).catch((err) => {
console.info("Failed to remoteQuery , err: " + err)
})
```
### querySql<sup>9+</sup>
querySql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;ResultSetV9&gt;):void
根据指定SQL语句查询数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 |
| callback | AsyncCallback&lt;[ResultSetV9](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSetV9对象。 |
**示例：**
```js
rdbStoreV9.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSetV9) {
if (err) {
console.info("Query failed, err: " + err)
return
}
console.log("ResultSet column names: " + resultSetV9.columnNames)
console.log("ResultSet column count: " + resultSetV9.columnCount)
})
```
### querySql<sup>9+</sup>
querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSetV9&gt;
根据指定SQL语句查询数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | --------------------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 否 | SQL语句中参数的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------------------------- | -------------------------------------------------- |
| Promise&lt;[ResultSetV9](js-apis-data-resultset.md)&gt; | Promise对象。如果操作成功，则返回ResultSetV9对象。 |
**示例：**
```js
let promise = rdbStoreV9.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'])
promise.then((resultSetV9) => {
console.log("ResultSet column names: " + resultSetV9.columnNames)
console.log("ResultSet column count: " + resultSetV9.columnCount)
}).catch((err) => {
console.info("Query failed, err: " + err)
})
```
### executeSql<sup>9+</sup>
executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;void&gt;):void
执行包含指定参数但不返回值的SQL语句，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ---------------------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例：**
```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)"
rdbStoreV9.executeSql(SQL_CREATE_TABLE, null, function(err) {
if (err) {
console.info("ExecuteSql failed, err: " + err)
return
}
console.info('Create table done.')
})
```
### executeSql<sup>9+</sup>
executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt;
执行包含指定参数但不返回值的SQL语句，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | --------------------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 否 | SQL语句中参数的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```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 = rdbStoreV9.executeSql(SQL_CREATE_TABLE)
promise.then(() => {
console.info('Create table done.')
}).catch((err) => {
console.info("ExecuteSql failed, err: " + err)
})
```
### beginTransaction<sup>9+</sup>
beginTransaction():void
在开始执行SQL语句之前，开始事务。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIG, 1, async function (err, rdbStoreV9) {
rdbStoreV9.beginTransaction()
const valueBucket = {
"name": "lisi",
"age": 18,
"salary": 100.5,
"blobType": new Uint8Array([1, 2, 3]),
}
await rdbStoreV9.insert("test", valueBucket)
rdbStoreV9.commit()
})
```
### commit<sup>9+</sup>
commit():void
提交已执行的SQL语句。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIG, 1, async function (err, rdbStoreV9) {
rdbStoreV9.beginTransaction()
const valueBucket = {
"name": "lisi",
"age": 18,
"salary": 100.5,
"blobType": new Uint8Array([1, 2, 3]),
}
await rdbStoreV9.insert("test", valueBucket)
rdbStoreV9.commit()
})
```
### rollBack<sup>9+</sup>
rollBack():void
回滚已经执行的SQL语句。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIG, 1, async function (err, rdbStoreV9) {
try {
rdbStoreV9.beginTransaction()
const valueBucket = {
"id": 1,
"name": "lisi",
"age": 18,
"salary": 100.5,
"blobType": new Uint8Array([1, 2, 3]),
}
await rdbStoreV9.insert("test", valueBucket)
rdbStoreV9.commit()
} catch (e) {
rdbStoreV9.rollBack()
}
})
```
### backup<sup>9+</sup>
backup(destName:string, callback: AsyncCallback&lt;void&gt;):void
以指定名称备份数据库，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------ |
| destName | string | 是 | 指定数据库的备份文件名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例：**
```js
rdbStoreV9.backup("dbBackup.db", function(err) {
if (err) {
console.info('Backup failed, err: ' + err)
return
}
console.info('Backup success.')
})
```
### backup<sup>9+</sup>
backup(destName:string): Promise&lt;void&gt;
以指定名称备份数据库，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------ |
| destName | string | 是 | 指定数据库的备份文件名。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
let promiseBackup = rdbStoreV9.backup("dbBackup.db")
promiseBackup.then(()=>{
console.info('Backup success.')
}).catch((err)=>{
console.info('Backup failed, err: ' + err)
})
```
### restore<sup>9+</sup>
restore(srcName:string, callback: AsyncCallback&lt;void&gt;):void
从指定的数据库备份文件恢复数据库，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------ |
| srcName | string | 是 | 指定数据库的备份文件名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例：**
```js
rdbStoreV9.restore("dbBackup.db", function(err) {
if (err) {
console.info('Restore failed, err: ' + err)
return
}
console.info('Restore success.')
})
```
### restore<sup>9+</sup>
restore(srcName:string): Promise&lt;void&gt;
从指定的数据库备份文件恢复数据库，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------ |
| srcName | string | 是 | 指定数据库的备份文件名。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
let promiseRestore = rdbStoreV9.restore("dbBackup.db")
promiseRestore.then(()=>{
console.info('Restore success.')
}).catch((err)=>{
console.info('Restore failed, err: ' + err)
})
```
### setDistributedTables<sup>9+</sup>
setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;void&gt;): void
设置分布式列表，使用callback异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------- |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例：**
```js
rdbStoreV9.setDistributedTables(["EMPLOYEE"], function (err) {
if (err) {
console.info('SetDistributedTables failed, err: ' + err)
return
}
console.info('SetDistributedTables successfully.')
})
```
### setDistributedTables<sup>9+</sup>
setDistributedTables(tables: Array&lt;string&gt;): Promise&lt;void&gt;
设置分布式列表，使用Promise异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------- | ---- | ------------------------ |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
let promise = rdbStoreV9.setDistributedTables(["EMPLOYEE"])
promise.then(() => {
console.info("SetDistributedTables successfully.")
}).catch((err) => {
console.info("SetDistributedTables failed, err: " + err)
})
```
### obtainDistributedTableName<sup>9+</sup>
obtainDistributedTableName(device: string, table: string, callback: AsyncCallback&lt;string&gt;): void
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 使用callback异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| device | string | 是 | 远程设备 。 |
| table | string | 是 | 本地表名。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。 |
**示例：**
```js
rdbStoreV9.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {
if (err) {
console.info('ObtainDistributedTableName failed, err: ' + err)
return
}
console.info('ObtainDistributedTableName successfully, tableName=.' + tableName)
})
```
### obtainDistributedTableName<sup>9+</sup>
obtainDistributedTableName(device: string, table: string): Promise&lt;string&gt;
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，使用Promise异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| device | string | 是 | 远程设备。 |
| table | string | 是 | 本地表名。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ----------------------------------------------------- |
| Promise&lt;string&gt; | Promise对象。如果操作成功，返回远程设备的分布式表名。 |
**示例：**
```js
let promise = rdbStoreV9.obtainDistributedTableName("12345678abcde", "EMPLOYEE")
promise.then((tableName) => {
console.info('ObtainDistributedTableName successfully, tableName= ' + tableName)
}).catch((err) => {
console.info('ObtainDistributedTableName failed, err: ' + err)
})
```
### sync<sup>9+</sup>
sync(mode: SyncMode, predicates: RdbPredicatesV9, callback: AsyncCallback&lt;Array&lt;[string, number]&gt;&gt;): void
在设备之间同步数据, 使用callback异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ |
| mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 |
| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | 约束同步数据和设备。 |
| callback | AsyncCallback&lt;Array&lt;[string, number]&gt;&gt; | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9('EMPLOYEE')
predicatesV9.inDevices(['12345678abcde'])
rdbStoreV9.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicatesV9, function (err, result) {
if (err) {
console.log('Sync failed, err: ' + err)
return
}
console.log('Sync done.')
for (let i = 0; i < result.length; i++) {
console.log('device=' + result[i][0] + ' status=' + result[i][1])
}
})
```
### sync<sup>9+</sup>
sync(mode: SyncMode, predicates: RdbPredicatesV9): Promise&lt;Array&lt;[string, number]&gt;&gt;
在设备之间同步数据，使用Promise异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ------------------------------ |
| mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 |
| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | 是 | 约束同步数据和设备。 |
**返回值**：
| 类型 | 说明 |
| -------------------------------------------- | ------------------------------------------------------------ |
| Promise&lt;Array&lt;[string, number]&gt;&gt; | Promise对象，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
**示例：**
```js
let predicatesV9 = new data_rdb.RdbPredicatesV9('EMPLOYEE')
predicatesV9.inDevices(['12345678abcde'])
let promise = rdbStoreV9.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicatesV9)
promise.then((resultSetV9) =>{
console.log('Sync done.')
for (let i = 0; i < resultSetV9.length; i++) {
console.log('device=' + resultSetV9[i][0] + ' status=' + resultSetV9[i][1])
}
}).catch((err) => {
console.log('Sync failed')
})
```
### on('dataChange')<sup>9+</sup>
on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void
注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------- |
| event | string | 是 | 取值为'dataChange'，表示数据更改。 |
| type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指分布式数据库中数据更改事件的观察者。 |
**示例：**
```js
function storeObserver(devices) {
for (let i = 0; i < devices.length; i++) {
console.log('device=' + devices[i] + ' data changed')
}
}
try {
rdbStoreV9.on('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
console.log('Register observer failed')
}
```
### off('dataChange')<sup>9+</sup>
## data_rdb.deleteRdbStore
off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void
deleteRdbStore(context: Context, name: string): Promise&lt;void&gt;
从数据库中删除指定类型的指定观察者, 使用callback异步回调。
使用指定的数据库文件配置删除数据库，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------- |
| event | string | 是 | 取值为'dataChange'，表示数据更改。 |
| type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指已注册的数据更改观察者。 |
**参数**
**示例：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| name | string | 是 | 数据库名称。 |
```js
function storeObserver(devices) {
for (let i = 0; i < devices.length; i++) {
console.log('device=' + devices[i] + ' data changed')
}
}
try {
rdbStoreV9.off('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
console.log('Unregister observer failed')
}
```
**返回值**：
## StoreConfigV9<sup>9+</sup>
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
管理关系数据库配置。
**示例：**
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
FA模型示例：
| 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------- | ---- | --------------------------------------------------------- |
| name | string | 是 | 数据库文件名。 |
| securityLevel | SecurityLevel | 是 | 设置数据库安全级别 |
| encrypt | boolean | 否 | 指定数据库是否加密。<br/> true:加密。<br/> false:非加密。 |
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
## SecurityLevel<sup>9+</sup>
// 获取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)
})
```
数据库的安全级别枚举。
Stage模型示例：
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
| 名称 | 值 | 说明 |
| ---- | ---- | ------------------------------------------------------------ |
| S1 | 1 | 表示数据库的安全级别为低级别，当数据泄露时会产生较低影响。例如，包含壁纸等系统数据的数据库。 |
| S2 | 2 | 表示数据库的安全级别为中级别，当数据泄露时会产生较大影响。例如，包含录音、视频等用户生成数据或通话记录等信息的数据库。 |
| S3 | 3 | 表示数据库的安全级别为高级别，当数据泄露时会产生重大影响。例如，包含用户运动、健康、位置等信息的数据库。 |
| S4 | 4 | 表示数据库的安全级别为关键级别，当数据泄露时会产生严重影响。例如，包含认证凭据、财务数据等信息的数据库。 |
// 获取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)
})
```
## ValueType
......@@ -2714,7 +286,7 @@ try {
指数据库同步模式。
**系统能力：**SystemCapability.DistributedDataManager.RelationalStore.Core
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 值 | 说明 |
| -------------- | ---- | ---------------------------------- |
......@@ -2733,25 +305,26 @@ try {
| --------------------- | ---- | ------------------ |
| SUBSCRIBE_TYPE_REMOTE | 0 | 订阅远程数据更改。 |
## RdbPredicates<sup>(deprecated)</sup>
## StoreConfig
表示关系型数据库（RDB）的谓词。该类确定RDB中条件表达式的值是true还是false。
管理关系数据库配置。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[RdbPredicatesV9](#rdbpredicatesv99)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库文件名。 |
## RdbPredicates
### constructor<sup>(deprecated)</sup>
表示关系型数据库（RDB）的谓词。该类确定RDB中条件表达式的值是true还是false。
### constructor
constructor(name: string)
构造函数。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[constructor](#constructor9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -2766,16 +339,12 @@ constructor(name: string)
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
```
### inDevices<sup>(deprecated)</sup>
### inDevices<sup>8+</sup>
inDevices(devices: Array&lt;string&gt;): RdbPredicates
同步分布式数据库时连接到组网内指定的远程设备。
> **说明：**
>
> 从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用[inDevices](#indevices9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -2797,16 +366,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inDevices(['12345678abcde'])
```
### inAllDevices<sup>(deprecated)</sup>
### inAllDevices<sup>8+</sup>
inAllDevices(): RdbPredicates
同步分布式数据库时连接到组网内所有的远程设备。
> **说明：**
>
> 从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用[inAllDevices](#inalldevices9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
......@@ -2822,16 +387,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inAllDevices()
```
### equalTo<sup>(deprecated)</sup>
### equalTo
equalTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[equalTo](#equalto9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -2855,16 +416,12 @@ predicates.equalTo("NAME", "lisi")
```
### notEqualTo<sup>(deprecated)</sup>
### notEqualTo
notEqualTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[notEqualTo](#notequalto9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -2888,16 +445,12 @@ predicates.notEqualTo("NAME", "lisi")
```
### beginWrap<sup>(deprecated)</sup>
### beginWrap
beginWrap(): RdbPredicates
向谓词添加左括号。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[beginWrap](#beginwrap9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
......@@ -2918,16 +471,12 @@ predicates.equalTo("NAME", "lisi")
.endWrap()
```
### endWrap<sup>(deprecated)</sup>
### endWrap
endWrap(): RdbPredicates
向谓词添加右括号。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[endWrap](#endwrap9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
......@@ -2948,16 +497,12 @@ predicates.equalTo("NAME", "lisi")
.endWrap()
```
### or<sup>(deprecated)</sup>
### or
or(): RdbPredicates
将或条件添加到谓词中。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[or](#or9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
......@@ -2975,16 +520,12 @@ predicates.equalTo("NAME", "Lisa")
.equalTo("NAME", "Rose")
```
### and<sup>(deprecated)</sup>
### and
and(): RdbPredicates
向谓词添加和条件。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[and](#and9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
......@@ -3002,16 +543,12 @@ predicates.equalTo("NAME", "Lisa")
.equalTo("SALARY", 200.5)
```
### contains<sup>(deprecated)</sup>
### contains
contains(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且value包含指定值的字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[contains](#contains9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3034,16 +571,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.contains("NAME", "os")
```
### beginsWith<sup>(deprecated)</sup>
### beginsWith
beginsWith(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且值以指定字符串开头的字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[beginsWith](#beginswith9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3066,16 +599,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.beginsWith("NAME", "os")
```
### endsWith<sup>(deprecated)</sup>
### endsWith
endsWith(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[endsWith](#endswith9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3098,16 +627,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.endsWith("NAME", "se")
```
### isNull<sup>(deprecated)</sup>
### isNull
isNull(field: string): RdbPredicates
配置谓词以匹配值为null的字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[isNull](#isnull9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3128,16 +653,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNull("NAME")
```
### isNotNull<sup>(deprecated)</sup>
### isNotNull
isNotNull(field: string): RdbPredicates
配置谓词以匹配值不为null的指定字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[isNotNull](#isnotnull9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3159,16 +680,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNotNull("NAME")
```
### like<sup>(deprecated)</sup>
### like
like(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且值类似于指定字符串的字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[like](#like9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3191,16 +708,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.like("NAME", "%os%")
```
### glob<sup>(deprecated)</sup>
### glob
glob(field: string, value: string): RdbPredicates
配置RdbPredicates匹配数据字段为string的指定字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[glob](#glob9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3223,16 +736,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.glob("NAME", "?h*g")
```
### between<sup>(deprecated)</sup>
### between
between(field: string, low: ValueType, high: ValueType): RdbPredicates
将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[between](#between9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3256,16 +765,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.between("AGE", 10, 50)
```
### notBetween<sup>(deprecated)</sup>
### notBetween
notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates
配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[notBetween](#notbetween9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3289,16 +794,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notBetween("AGE", 10, 50)
```
### greaterThan<sup>(deprecated)</sup>
### greaterThan
greaterThan(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且值大于指定值的字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[greaterThan](#greaterthan9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3321,16 +822,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThan("AGE", 18)
```
### lessThan<sup>(deprecated)</sup>
### lessThan
lessThan(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为valueType且value小于指定值的字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[lessThan](#lessthan9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3353,16 +850,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThan("AGE", 20)
```
### greaterThanOrEqualTo<sup>(deprecated)</sup>
### greaterThanOrEqualTo
greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[greaterThanOrEqualTo](#greaterthanorequalto9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3385,16 +878,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThanOrEqualTo("AGE", 18)
```
### lessThanOrEqualTo<sup>(deprecated)</sup>
### lessThanOrEqualTo
lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[lessThanOrEqualTo](#lessthanorequalto9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3417,16 +906,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThanOrEqualTo("AGE", 20)
```
### orderByAsc<sup>(deprecated)</sup>
### orderByAsc
orderByAsc(field: string): RdbPredicates
配置谓词以匹配其值按升序排序的列。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[orderByAsc](#orderbyasc9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3448,16 +933,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByAsc("NAME")
```
### orderByDesc<sup>(deprecated)</sup>
### orderByDesc
orderByDesc(field: string): RdbPredicates
配置谓词以匹配其值按降序排序的列。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[orderByDesc](#orderbydesc9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3479,16 +960,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByDesc("AGE")
```
### distinct<sup>(deprecated)</sup>
### distinct
distinct(): RdbPredicates
配置谓词以过滤重复记录并仅保留其中一个。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[distinct](#distinct9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
......@@ -3504,16 +981,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").distinct()
```
### limitAs<sup>(deprecated)</sup>
### limitAs
limitAs(value: number): RdbPredicates
设置最大数据记录数的谓词。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[limitAs](#limitas9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3535,16 +1008,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").limitAs(3)
```
### offsetAs<sup>(deprecated)</sup>
### offsetAs
offsetAs(rowOffset: number): RdbPredicates
配置RdbPredicates以指定返回结果的起始位置。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[offsetAs](#offsetas9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3566,16 +1035,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").offsetAs(3)
```
### groupBy<sup>(deprecated)</sup>
### groupBy
groupBy(fields: Array&lt;string&gt;): RdbPredicates
配置RdbPredicates按指定列分组查询结果。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[groupBy](#groupby9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3597,16 +1062,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.groupBy(["AGE", "NAME"])
```
### indexedBy<sup>(deprecated)</sup>
### indexedBy
indexedBy(field: string): RdbPredicates
配置RdbPredicates以指定索引列。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[indexedBy](#indexedby9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3629,16 +1090,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.indexedBy("SALARY_INDEX")
```
### in<sup>(deprecated)</sup>
### in
in(field: string, value: Array&lt;ValueType&gt;): RdbPredicates
配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[in](#in9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3661,16 +1118,12 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.in("AGE", [18, 20])
```
### notIn<sup>(deprecated)</sup>
### notIn
notIn(field: string, value: Array&lt;ValueType&gt;): RdbPredicates
将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[notIn](#notin9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3693,26 +1146,18 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notIn("NAME", ["Lisa", "Rose"])
```
## RdbStore<sup>(deprecated)</sup>
## RdbStore
提供管理关系数据库(RDB)方法的接口。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[RdbStoreV9](#rdbstorev99)替代。
在使用以下相关接口前，请使用[executeSql](#executesql)接口初始化数据库表结构和相关数据，具体可见[关系型数据库开发指导](../../database/database-relational-guidelines.md)。
在使用以下相关接口前，请使用[executeSql](#executesql8)接口初始化数据库表结构和相关数据，具体可见[关系型数据库开发指导](../../database/database-relational-guidelines.md)。
### insert<sup>(deprecated)</sup>
### insert
insert(table: string, values: ValuesBucket, callback: AsyncCallback&lt;number&gt;):void
向目标表中插入一行数据，使用callback异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[insert](#insert9-1)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3741,16 +1186,12 @@ rdbStore.insert("EMPLOYEE", valueBucket, function (status, rowId) {
})
```
### insert<sup>(deprecated)</sup>
### insert
insert(table: string, values: ValuesBucket):Promise&lt;number&gt;
向目标表中插入一行数据，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[insert](#insert9-2)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3783,16 +1224,12 @@ promise.then((rowId) => {
})
```
### batchInsert<sup>(deprecated)</sup>
### batchInsert
batchInsert(table: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;):void
向目标表中插入一组数据，使用callback异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[batchInsert](#batchinsert9-1)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3835,16 +1272,12 @@ rdbStore.batchInsert("EMPLOYEE", valueBuckets, function(status, insertNum) {
})
```
### batchInsert<sup>(deprecated)</sup>
### batchInsert
batchInsert(table: string, values: Array&lt;ValuesBucket&gt;):Promise&lt;number&gt;
向目标表中插入一组数据，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[batchInsert](#batchinsert9-2)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3891,16 +1324,12 @@ promise.then((insertNum) => {
})
```
### update<sup>(deprecated)</sup>
### update
update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void
根据RdbPredicates的指定实例对象更新数据库中的数据，使用callback异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[update](#update9-1)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3922,25 +1351,21 @@ const valueBucket = {
}
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
rdbStore.update(valueBucket, predicates, function (err, ret) {
rdbStore.update(valueBucket, predicates, function (err, rows) {
if (err) {
console.info("Updated failed, err: " + err)
return
}
console.log("Updated row count: " + ret)
console.log("Updated row count: " + rows)
})
```
### update<sup>(deprecated)</sup>
### update
update(values: ValuesBucket, predicates: RdbPredicates):Promise&lt;number&gt;
根据RdbPredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[update](#update9-2)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -3968,23 +1393,19 @@ const valueBucket = {
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)
promise.then(async (rows) => {
console.log("Updated row count: " + rows)
}).catch((err) => {
console.info("Updated failed, err: " + err)
})
```
### delete<sup>(deprecated)</sup>
### delete
delete(predicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void
根据RdbPredicates的指定实例对象从数据库中删除数据，使用callback异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[delete](#delete9-1)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4008,16 +1429,12 @@ rdbStore.delete(predicates, function (err, rows) {
})
```
### delete<sup>(deprecated)</sup>
### delete
delete(predicates: RdbPredicates):Promise&lt;number&gt;
根据RdbPredicates的指定实例对象从数据库中删除数据，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[delete](#delete9-2)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4045,16 +1462,12 @@ promise.then((rows) => {
})
```
### query<sup>(deprecated)</sup>
### query
query(predicates: RdbPredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;ResultSet&gt;):void
根据指定条件查询数据库中的数据，使用callback异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[query](#query9-1)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4080,16 +1493,12 @@ rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (e
})
```
### query<sup>(deprecated)</sup>
### query
query(predicates: RdbPredicates, columns?: Array&lt;string&gt;):Promise&lt;ResultSet&gt;
根据指定条件查询数据库中的数据，使用Promise异步回调。
> **说明：**
>
> 从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[query](#query9-2)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4119,16 +1528,12 @@ query(predicates: RdbPredicates, columns?: Array&lt;string&gt;):Promise&lt;Resul
})
```
### querySql<sup>(deprecated)</sup>
### querySql<sup>8+</sup>
querySql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;ResultSet&gt;):void
根据指定SQL语句查询数据库中的数据，使用callback异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[querySql](#querysql9-1)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4152,16 +1557,12 @@ rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?",
})
```
### querySql<sup>(deprecated)</sup>
### querySql<sup>8+</sup>
querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt;
根据指定SQL语句查询数据库中的数据，使用Promise异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[querySql](#querysql9-2)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4189,16 +1590,12 @@ promise.then((resultSet) => {
})
```
### executeSql<sup>(deprecated)</sup>
### executeSql<sup>8+</sup>
executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;void&gt;):void
执行包含指定参数但不返回值的SQL语句，使用callback异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[executeSql](#executesql9-1)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4222,16 +1619,12 @@ rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) {
})
```
### executeSql<sup>(deprecated)</sup>
### executeSql<sup>8+</sup>
executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt;
执行包含指定参数但不返回值的SQL语句，使用Promise异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[executeSql](#executesql9-2)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4259,16 +1652,12 @@ promise.then(() => {
})
```
### beginTransaction<sup>(deprecated)</sup>
### beginTransaction<sup>8+</sup>
beginTransaction():void
在开始执行SQL语句之前，开始事务。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[beginTransaction](#begintransaction9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
......@@ -4290,16 +1679,12 @@ data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
})
```
### commit<sup>(deprecated)</sup>
### commit<sup>8+</sup>
commit():void
提交已执行的SQL语句。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[commit](#commit9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
......@@ -4321,16 +1706,12 @@ data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
})
```
### rollBack<sup>(deprecated)</sup>
### rollBack<sup>8+</sup>
rollBack():void
回滚已经执行的SQL语句。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[rollBack](#rollback9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
......@@ -4357,16 +1738,12 @@ data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
})
```
### setDistributedTables<sup>(deprecated)</sup>
### setDistributedTables<sup>8+</sup>
setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;void&gt;): void
设置分布式列表，使用callback异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[setDistributedTables](#setdistributedtables9-1)替代。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
......@@ -4390,16 +1767,12 @@ rdbStore.setDistributedTables(["EMPLOYEE"], function (err) {
})
```
### setDistributedTables<sup>(deprecated)</sup>
### setDistributedTables<sup>8+</sup>
setDistributedTables(tables: Array&lt;string&gt;): Promise&lt;void&gt;
设置分布式列表，使用Promise异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[setDistributedTables](#setdistributedtables9-2)替代。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
......@@ -4427,16 +1800,12 @@ promise.then(() => {
})
```
### obtainDistributedTableName<sup>(deprecated)</sup>
### obtainDistributedTableName<sup>8+</sup>
obtainDistributedTableName(device: string, table: string, callback: AsyncCallback&lt;string&gt;): void
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 使用callback异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[obtainDistributedTableName](#obtaindistributedtablename9-1)替代。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
......@@ -4461,16 +1830,12 @@ rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err,
})
```
### obtainDistributedTableName<sup>(deprecated)</sup>
### obtainDistributedTableName<sup>8+</sup>
obtainDistributedTableName(device: string, table: string): Promise&lt;string&gt;
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，使用Promise异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[obtainDistributedTableName](#obtaindistributedtablename9-2)替代。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
......@@ -4499,16 +1864,12 @@ promise.then((tableName) => {
})
```
### sync<sup>(deprecated)</sup>
### sync<sup>8+</sup>
sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback&lt;Array&lt;[string, number]&gt;&gt;): void
在设备之间同步数据, 使用callback异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[sync](#sync9-1)替代。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
......@@ -4538,16 +1899,12 @@ rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, resul
})
```
### sync<sup>(deprecated)</sup>
### sync<sup>8+</sup>
sync(mode: SyncMode, predicates: RdbPredicates): Promise&lt;Array&lt;[string, number]&gt;&gt;
在设备之间同步数据，使用Promise异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[sync](#sync9-2)替代。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
......@@ -4581,16 +1938,12 @@ promise.then((result) =>{
})
```
### on('dataChange')<sup>(deprecated)</sup>
### on('dataChange')<sup>8+</sup>
on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void
注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[on](#ondatachange9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4598,7 +1951,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 取值为'dataChange'，表示数据更改。 |
| type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
| type | [SubscribeType](#subscribetype8) | 是 | 订阅类型。 |
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指分布式数据库中数据更改事件的观察者。 |
**示例：**
......@@ -4616,16 +1969,12 @@ try {
}
```
### off('dataChange')<sup>(deprecated)</sup>
### off('dataChange')<sup>8+</sup>
off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void
从数据库中删除指定类型的指定观察者, 使用callback异步回调。
> **说明：**
>
> 从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用[off](#offdatachange9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -4633,7 +1982,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 取值为'dataChange'，表示数据更改。 |
| type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
| type | [SubscribeType](#subscribetype8) | 是 | 订阅类型。 |
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指已注册的数据更改观察者。|
**示例：**
......@@ -4650,18 +1999,3 @@ try {
console.log('Unregister observer failed')
}
```
## StoreConfig<sup>(deprecated)</sup>
管理关系数据库配置。
**说明：**
从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用[StoreConfigV9](#storeconfigv99)替代。
**系统能力：**SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库文件名。 |
zh-cn/application-dev/reference/apis/js-apis-data-relationalStore.md 0 → 100644
浏览文件 @ be87c2e7
# @ohos.data.relationalStore (关系型数据库)
关系型数据库（Relational Database，RDB）是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制，对外提供了一系列的增、删、改、查等接口，也可以直接运行用户输入的SQL语句来满足复杂的场景需要。
该模块提供以下关系型数据库相关的常用功能：
- [RdbPredicates](#rdbpredicates)： 数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项，主要用来定义数据库的操作条件。
- [RdbStore](#rdbstore)：提供管理关系数据库(RDB)方法的接口。
- [Resultset](#resultset)：提供用户调用关系型数据库查询接口之后返回的结果集合。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
import data_rdb from '@ohos.data.relationalStore';
```
## data_rdb.getRdbStore
getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback&lt;RdbStore&gt;): void
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| 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存储相关的数据库配置。 |
| callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | 是 | 指定callback回调函数，返回RdbStore对象。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ----------------------- |
| 14800010 | If failed delete database by invalid database name. |
| 14800011 | If failed open database by database corrupted. |
**示例：**
FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
// 获取context后调用getRdbStore
const STORE_CONFIG = {
name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1
}
data_rdb.getRdbStore(context, STORE_CONFIG, function (err, RdbStore) {
if (err) {
console.info("Get RdbStore failed, err: " + err)
return
}
if (rdbStore.openStatus == OpenStatus.ON_CREATA) {
console.log("RdbStore status is ON_CREATA")
} else if (rdbStore.openStatus == OpenStatus.ON_OPEN) {
console.log("RdbStore status is ON_OPEN")
} else {
return
}
console.log("Get RdbStore successfully.")
})
```
Stage模型示例：
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
// 获取context后调用getRdbStore
const STORE_CONFIG = {
name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1
}
data_rdb.getRdbStore(context, STORE_CONFIG, function (err, RdbStore) {
if (err) {
console.info("Get RdbStore failed, err: " + err)
return
}
if (rdbStore.openStatus == OpenStatus.ON_CREATA) {
console.log("RdbStore status is ON_CREATA")
} else if (rdbStore.openStatus == OpenStatus.ON_OPEN) {
console.log("RdbStore status is ON_OPEN")
} else {
return
}
console.log("Get RdbStore successfully.")
})
```
## data_rdb.getRdbStore
getRdbStore(context: Context, config: StoreConfig): Promise&lt;RdbStore&gt;
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------------------------- | ---- | ------------------------------------------------------------ |
| 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存储相关的数据库配置。 |
**返回值**：
| 类型 | 说明 |
| ----------------------------------------- | --------------------------------- |
| Promise&lt;[RdbStore](#rdbstore)&gt; | Promise对象。返回RdbStore对象。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ----------------------- |
| 14800010 | If failed delete database by invalid database name. |
| 14800011 | If failed open database by database corrupted. |
**示例：**
FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
// 获取context后调用getRdbStore
const STORE_CONFIG = {
name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1
}
let promise = data_rdb.getRdbStore(context, STORE_CONFIG);
promise.then(async (rdbStore) => {
if (rdbStore.openStatus == OpenStatus.ON_CREATA) {
console.log("RdbStore status is ON_CREATA")
} else if (rdbStore.openStatus == OpenStatus.ON_OPEN) {
console.log("RdbStore status is ON_OPEN")
} else {
return
}
console.log("Get RdbStore successfully.")
}).catch((err) => {
console.log("Get RdbStore failed, err: " + err)
})
```
Stage模型示例：
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
// 获取context后调用getRdbStore
const STORE_CONFIG = {
name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1
}
let promise = data_rdb.getRdbStore(context, STORE_CONFIG);
promise.then(async (rdbStore) => {
if (rdbStore.openStatus == OpenStatus.ON_CREATA) {
console.log("RdbStore status is ON_CREATA")
} else if (rdbStore.openStatus == OpenStatus.ON_OPEN) {
console.log("RdbStore status is ON_OPEN")
} else {
return
}
console.log("Get RdbStore successfully.")
}).catch((err) => {
console.log("Get RdbStore failed, err: " + err)
})
```
## data_rdb.deleteRdbStore
deleteRdbStore(context: Context, name: string, callback: AsyncCallback&lt;void&gt;): void
删除数据库，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| 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回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ----------------------- |
| 14800010 | If failed delete database by invalid database name. |
**示例：**
FA模型示例：
```js
// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
// 获取context后调用deleteRdbStore
data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
if (err) {
console.info("Delete RdbStore failed, err: " + err)
return
}
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
}
console.log("Delete RdbStore successfully.")
})
```
## data_rdb.deleteRdbStore
deleteRdbStore(context: Context, name: string): Promise&lt;void&gt;
使用指定的数据库文件配置删除数据库，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
| name | string | 是 | 数据库名称。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ----------------------- |
| 14800010 | If failed delete database by invalid database name. |
**示例：**
FA模型示例：
```js
// 获取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.")
}).catch((err) => {
console.info("Delete RdbStore failed, err: " + err)
})
```
Stage模型示例：
```ts
// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
onWindowStageCreate(windowStage){
context = this.context
}
}
// 获取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)
})
```
## StoreConfig
管理关系数据库配置。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------- | ---- | --------------------------------------------------------- |
| name | string | 是 | 数据库文件名。 |
| securityLevel | [SecurityLevel](#securitylevel) | 是 | 设置数据库安全级别 |
| encrypt | boolean | 否 | 指定数据库是否加密。<br/> true:加密。<br/> false:非加密。 |
## SecurityLevel
数据库的安全级别枚举。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 值 | 说明 |
| ---- | ---- | ------------------------------------------------------------ |
| S1 | 1 | 表示数据库的安全级别为低级别，当数据泄露时会产生较低影响。例如，包含壁纸等系统数据的数据库。 |
| S2 | 2 | 表示数据库的安全级别为中级别，当数据泄露时会产生较大影响。例如，包含录音、视频等用户生成数据或通话记录等信息的数据库。 |
| S3 | 3 | 表示数据库的安全级别为高级别，当数据泄露时会产生重大影响。例如，包含用户运动、健康、位置等信息的数据库。 |
| S4 | 4 | 表示数据库的安全级别为关键级别，当数据泄露时会产生严重影响。例如，包含认证凭据、财务数据等信息的数据库。 |
## ValueType
用于表示允许的数据字段类型。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 类型 | 说明 |
| ------- | -------------------- |
| number | 表示值类型为数字。 |
| string | 表示值类型为字符。 |
| boolean | 表示值类型为布尔值。 |
## ValuesBucket
用于存储键值对的类型。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 键类型 | 值类型 |
| ------ | ----------------------------------------------------------- |
| string | [ValueType](#valuetype)\|&nbsp;Uint8Array&nbsp;\|&nbsp;null |
## SyncMode
指数据库同步模式。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 值 | 说明 |
| -------------- | ---- | ---------------------------------- |
| SYNC_MODE_PUSH | 0 | 表示数据从本地设备推送到远程设备。 |
| SYNC_MODE_PULL | 1 | 表示数据从远程设备拉至本地设备。 |
## SubscribeType
描述订阅类型。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 值 | 说明 |
| --------------------- | ---- | ------------------ |
| SUBSCRIBE_TYPE_REMOTE | 0 | 订阅远程数据更改。 |
## ConflictResolution<sup>10+</sup>
插入和修改接口的冲突解决方式。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 值 | 说明 |
| -------------------- | ---- | ------------------------------------------------------------ |
| ON_CONFLICT_NONE | 0 | 表示当冲突发生时，不做任何处理。 |
| ON_CONFLICT_ROLLBACK | 1 | 表示当冲突发生时，中止SQL语句并回滚当前事务。 |
| ON_CONFLICT_ABORT | 2 | 表示当冲突发生时，中止当前SQL语句，并撤销当前 SQL 语句所做的任何更改，但是由同一事务中先前的 SQL 语句引起的更改被保留并且事务保持活动状态。 |
| ON_CONFLICT_FAIL | 3 | 表示当冲突发生时，中止当前 SQL 语句。但它不会撤销失败的 SQL 语句的先前更改，也不会结束事务。 |
| ON_CONFLICT_IGNORE | 4 | 表示当冲突发生时，跳过包含违反约束的行并继续处理 SQL 语句的后续行。 |
| ON_CONFLICT_REPLACE | 5 | 表示当冲突发生时，在插入或更新当前行之前删除导致约束违例的预先存在的行，并且命令会继续正常执行。 |
## OpenStatus<sup>10+</sup>
RdbStore的状态枚举。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 值 | 说明 |
| --------- | ---- | --------------------------------------------------- |
| ON_CREATE | 0 | 表示RdbStore首次创建，处于ON_CREATE状态。 |
| ON_OPEN | 1 | 表示RdbStore非首次创建，处于ON_OPEN状态。 |
## RdbPredicates
表示关系型数据库（RDB）的谓词。该类确定RDB中条件表达式的值是true还是false。
### constructor
constructor(name: string)
构造函数。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------ |
| name | string | 是 | 数据库表名。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
```
### inDevices
inDevices(devices: Array&lt;string&gt;): RdbPredicates
同步分布式数据库时连接到组网内指定的远程设备。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------- | ---- | -------------------------- |
| devices | Array&lt;string&gt; | 是 | 指定的组网内的远程设备ID。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inDevices(['12345678abcde'])
```
### inAllDevices
inAllDevices(): RdbPredicates
同步分布式数据库时连接到组网内所有的远程设备。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inAllDevices()
```
### equalTo
equalTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
```
### notEqualTo
notEqualTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notEqualTo("NAME", "lisi")
```
### beginWrap
beginWrap(): RdbPredicates
向谓词添加左括号。
**系统能力：** 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
endWrap(): RdbPredicates
向谓词添加右括号。
**系统能力：** 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
or(): RdbPredicates
将或条件添加到谓词中。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回带有或条件的Rdb谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
.or()
.equalTo("NAME", "Rose")
```
### and
and(): RdbPredicates
向谓词添加和条件。
**系统能力：** 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
contains(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且value包含指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.contains("NAME", "os")
```
### beginsWith
beginsWith(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且值以指定字符串开头的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.beginsWith("NAME", "os")
```
### endsWith
endsWith(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.endsWith("NAME", "se")
```
### isNull
isNull(field: string): RdbPredicates
配置谓词以匹配值为null的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| field | string | 是 | 数据库表中的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**：
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNull("NAME")
```
### isNotNull
isNotNull(field: string): RdbPredicates
配置谓词以匹配值不为null的指定字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| field | string | 是 | 数据库表中的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNotNull("NAME")
```
### like
like(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且值类似于指定字符串的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.like("NAME", "%os%")
```
### glob
glob(field: string, value: string): RdbPredicates
配置RdbPredicates匹配数据字段为string的指定字段。
**系统能力：** 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
between(field: string, low: ValueType, high: ValueType): RdbPredicates
将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。
**系统能力：** 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
notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates
配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。
**系统能力：** 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
greaterThan(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且值大于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThan("AGE", 18)
```
### lessThan
lessThan(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为valueType且value小于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThan("AGE", 20)
```
### greaterThanOrEqualTo
greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThanOrEqualTo("AGE", 18)
```
### lessThanOrEqualTo
lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThanOrEqualTo("AGE", 20)
```
### orderByAsc
orderByAsc(field: string): RdbPredicates
配置谓词以匹配其值按升序排序的列。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| field | string | 是 | 数据库表中的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByAsc("NAME")
```
### orderByDesc
orderByDesc(field: string): RdbPredicates
配置谓词以匹配其值按降序排序的列。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| field | string | 是 | 数据库表中的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | -------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByDesc("AGE")
```
### distinct
distinct(): RdbPredicates
配置谓词以过滤重复记录并仅保留其中一个。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------------ |
| [RdbPredicates](#rdbpredicates) | 返回可用于过滤重复记录的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").distinct()
```
### limitAs
limitAs(value: number): RdbPredicates
设置最大数据记录数的谓词。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------- |
| value | number | 是 | 最大数据记录数。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------------------ |
| [RdbPredicates](#rdbpredicates) | 返回可用于设置最大数据记录数的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").limitAs(3)
```
### offsetAs
offsetAs(rowOffset: number): RdbPredicates
配置RdbPredicates以指定返回结果的起始位置。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------------------------------- |
| rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------------------ |
| [RdbPredicates](#rdbpredicates) | 返回具有指定返回结果起始位置的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").offsetAs(3)
```
### groupBy
groupBy(fields: Array&lt;string&gt;): RdbPredicates
配置RdbPredicates按指定列分组查询结果。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------- | ---- | -------------------- |
| fields | Array&lt;string&gt; | 是 | 指定分组依赖的列名。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ---------------------- |
| [RdbPredicates](#rdbpredicates) | 返回分组查询列的谓词。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.groupBy(["AGE", "NAME"])
```
### indexedBy
indexedBy(field: string): RdbPredicates
配置RdbPredicates以指定索引列。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- |
| field | string | 是 | 索引列的名称。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------ | ------------------------------------- |
| [RdbPredicates](#rdbpredicates) | 返回具有指定索引列的RdbPredicates。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.indexedBy("SALARY_INDEX")
```
### in
in(field: string, value: Array&lt;ValueType&gt;): RdbPredicates
配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。
**系统能力：** 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
notIn(field: string, value: Array&lt;ValueType&gt;): RdbPredicates
将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。
**系统能力：** 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
提供管理关系数据库(RDB)方法的接口。
在使用以下相关接口前，请使用[executeSql](#executesql)接口初始化数据库表结构和相关数据，具体可见[关系型数据库开发指导](../../database/database-relational-guidelines.md)。
### 属性<sup>10+</sup>
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 类型 | 必填 | 说明 |
| ------------ | ----------- | ---- | -------------------------------- |
| openStatus<sup>10+</sup> | number | 是 | RdbStore的状态。值为0时，表示RdbStore首次创建，处于ON_CREATE状态。值为1时，表示RdbStore非首次创建，处于ON_OPEN状态。 |
### insert
insert(table: string, values: ValuesBucket, callback: AsyncCallback&lt;number&gt;):void
向目标表中插入一行数据，使用callback异步回调。
**系统能力：** 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>10+</sup>
insert(table: string, values: ValuesBucket, conflict: ConflictResolution, callback: AsyncCallback&lt;number&gt;):void
向目标表中插入一行数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ---------------------------------------------------------- |
| table | string | 是 | 指定的目标表名。 |
| values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 |
| conflict | [ConflictResolution](#conflictresolution10) | 是 | 指定冲突解决方式。 |
| 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, data_rdb.ConflictResolution.ON_CONFLICT_REPLACE, function (status, rowId) {
if (status) {
console.log("Insert is failed");
return;
}
console.log("Insert is successful, rowId = " + rowId);
})
```
### insert
insert(table: string, values: ValuesBucket):Promise&lt;number&gt;
向目标表中插入一行数据，使用Promise异步回调。
**系统能力：** 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");
})
```
### insert<sup>10+</sup>
insert(table: string, values: ValuesBucket, conflict: ConflictResolution):Promise&lt;number&gt;
向目标表中插入一行数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | -------------------------- |
| table | string | 是 | 指定的目标表名。 |
| values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 |
| conflict | [ConflictResolution](#conflictresolution10) | 是 | 指定冲突解决方式。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ------------------------------------------------- |
| 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, data_rdb.ConflictResolution.ON_CONFLICT_REPLACE)
promise.then((rowId) => {
console.log("Insert is successful, rowId = " + rowId);
}).catch((status) => {
console.log("Insert is failed");
})
```
### batchInsert
batchInsert(table: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;):void
向目标表中插入一组数据，使用callback异步回调。
**系统能力：** 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
batchInsert(table: string, values: Array&lt;ValuesBucket&gt;):Promise&lt;number&gt;
向目标表中插入一组数据，使用Promise异步回调。
**系统能力：** 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
update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void
根据RdbPredicates的指定实例对象更新数据库中的数据，使用callback异步回调。
**系统能力：** 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, rows) {
if (err) {
console.info("Updated failed, err: " + err)
return
}
console.log("Updated row count: " + rows)
})
```
### update<sup>10+</sup>
update(values: ValuesBucket, predicates: RdbPredicates, conflict: ConflictResolution, callback: AsyncCallback&lt;number&gt;):void
根据RdbPredicates的指定实例对象更新数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的更新条件。 |
| conflict | [ConflictResolution](#conflictresolution10) | 是 | 指定冲突解决方式。 |
| 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, data_rdb.ConflictResolution.ON_CONFLICT_REPLACE, function (err, rows) {
if (err) {
console.info("Updated failed, err: " + err)
return
}
console.log("Updated row count: " + rows)
})
```
### update
update(values: ValuesBucket, predicates: RdbPredicates):Promise&lt;number&gt;
根据RdbPredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。
**系统能力：** 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 (rows) => {
console.log("Updated row count: " + rows)
}).catch((err) => {
console.info("Updated failed, err: " + err)
})
```
### update<sup>10+</sup>
update(values: ValuesBucket, predicates: RdbPredicates, conflict: ConflictResolution):Promise&lt;number&gt;
根据RdbPredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的更新条件。 |
| conflict | [ConflictResolution](#conflictresolution10) | 是 | 指定冲突解决方式。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ----------------------------------------- |
| 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, data_rdb.ConflictResolution.ON_CONFLICT_REPLACE)
promise.then(async (rows) => {
console.log("Updated row count: " + rows)
}).catch((err) => {
console.info("Updated failed, err: " + err)
})
```
### update
update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;):void
根据DataSharePredicates的指定实例对象更新数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| table | string | 是 | 指定的目标表名。 |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的更新条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定的callback回调方法。返回受影响的行数。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
const valueBucket = {
"NAME": "Rose",
"AGE": 22,
"SALARY": 200.5,
"CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
rdbStore.update("EMPLOYEE", valueBucket, predicates, function (err, rows) {
if (err) {
console.info("Updated failed, err: " + err)
return
}
console.log("Updated row count: " + rows)
})
```
### update
update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates):Promise&lt;number&gt;
根据DataSharePredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| table | string | 是 | 指定的目标表名。 |
| values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的更新条件。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ----------------------------------------- |
| Promise&lt;number&gt; | 指定的Promise回调方法。返回受影响的行数。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
const valueBucket = {
"NAME": "Rose",
"AGE": 22,
"SALARY": 200.5,
"CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
let promise = rdbStore.update("EMPLOYEE", valueBucket, predicates)
promise.then(async (rows) => {
console.log("Updated row count: " + rows)
}).catch((err) => {
console.info("Updated failed, err: " + err)
})
```
### delete
delete(predicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void
根据RdbPredicates的指定实例对象从数据库中删除数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ----------------------------------------- |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。返回受影响的行数。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
rdbStore.delete(predicates, function (err, rows) {
if (err) {
console.info("Delete failed, err: " + err)
return
}
console.log("Delete rows: " + rows)
})
```
### delete
delete(predicates: RdbPredicates):Promise&lt;number&gt;
根据RdbPredicates的指定实例对象从数据库中删除数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ----------------------------------------- |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ------------------------------- |
| Promise&lt;number&gt; | Promise对象。返回受影响的行数。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
let promise = rdbStore.delete(predicates)
promise.then((rows) => {
console.log("Delete rows: " + rows)
}).catch((err) => {
console.info("Delete failed, err: " + err)
})
```
### delete
delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;):void
根据DataSharePredicates的指定实例对象从数据库中删除数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
| table | string | 是 | 指定的目标表名。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的删除条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。返回受影响的行数。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
rdbStore.delete("EMPLOYEE", predicates, function (err, rows) {
if (err) {
console.info("Delete failed, err: " + err)
return
}
console.log("Delete rows: " + rows)
})
```
### delete
delete(table: string, predicates: dataSharePredicates.DataSharePredicates):Promise&lt;number&gt;
根据DataSharePredicates的指定实例对象从数据库中删除数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
| table | string | 是 | 指定的目标表名。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的删除条件。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ------------------------------- |
| Promise&lt;number&gt; | Promise对象。返回受影响的行数。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
let promise = rdbStore.delete("EMPLOYEE", predicates)
promise.then((rows) => {
console.log("Delete rows: " + rows)
}).catch((err) => {
console.info("Delete failed, err: " + err)
})
```
### query
query(predicates: RdbPredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;ResultSet&gt;):void
根据指定条件查询数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的查询条件。 |
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
| callback | AsyncCallback&lt;[ResultSet](#resultset)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose")
rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) {
if (err) {
console.info("Query failed, err: " + err)
return
}
console.log("ResultSet column names: " + resultSet.columnNames)
console.log("ResultSet column count: " + resultSet.columnCount)
})
```
### query
query(predicates: RdbPredicates, columns?: Array&lt;string&gt;):Promise&lt;ResultSet&gt;
根据指定条件查询数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ------------------------------------------------ |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的查询条件。 |
| columns | Array&lt;string&gt; | 否 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------------------------- | -------------------------------------------------- |
| Promise&lt;[ResultSet](#resultset)&gt; | Promise对象。如果操作成功，则返回ResultSet对象。 |
**示例：**
```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)
})
```
### query
query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;ResultSet&gt;):void
根据指定条件查询数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| table | string | 是 | 指定的目标表名。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的查询条件。 |
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
| callback | AsyncCallback&lt;[ResultSet](#resultset)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose")
rdbStore.query("EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) {
if (err) {
console.info("Query failed, err: " + err)
return
}
console.log("ResultSet column names: " + resultSet.columnNames)
console.log("ResultSet column count: " + resultSet.columnCount)
})
```
### query
query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns?: Array&lt;string&gt;):Promise&lt;ResultSet&gt;
根据指定条件查询数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**系统接口：** 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ |
| table | string | 是 | 指定的目标表名。 |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的查询条件。 |
| columns | Array&lt;string&gt; | 否 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------------------------- | -------------------------------------------------- |
| Promise&lt;[ResultSet](#resultset)&gt; | Promise对象。如果操作成功，则返回ResultSet对象。 |
**示例：**
```js
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose")
let promise = rdbStore.query("EMPLOYEE", 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)
})
```
### remoteQuery
remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array&lt;string&gt; , callback: AsyncCallback&lt;ResultSet&gt;): void
根据指定条件查询远程设备数据库中的数据。使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| device | string | 是 | 指定的远程设备的networkId。 |
| table | string | 是 | 指定的目标表名。 |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象，指定查询的条件。 |
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
| callback | AsyncCallback&lt;[ResultSet](#resultset)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.greaterThan("id", 0)
rdbStore.remoteQuery("deviceId", "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"],
function(err, resultSet){
if (err) {
console.info("Failed to remoteQuery, err: " + err)
return
}
console.info("ResultSet column names: " + resultSet.columnNames)
console.info("ResultSet column count: " + resultSet.columnCount)
})
```
### remoteQuery
remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array&lt;string&gt;): Promise&lt;ResultSet&gt;
根据指定条件查询远程设备数据库中的数据。使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ------------------------------------------------ |
| device | string | 是 | 指定的远程设备的networkId。 |
| table | string | 是 | 指定的目标表名。 |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象，指定查询的条件。 |
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------------------------------ | -------------------------------------------------- |
| Promise&lt;[ResultSet](#resultset)&gt; | Promise对象。如果操作成功，则返回ResultSet对象。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.greaterThan("id", 0)
let promise = rdbStore.remoteQuery("deviceId", "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promise.then((resultSet) => {
console.info("ResultSet column names: " + resultSet.columnNames)
console.info("ResultSet column count: " + resultSet.columnCount)
}).catch((err) => {
console.info("Failed to remoteQuery , err: " + err)
})
```
### querySql
querySql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;ResultSet&gt;):void
根据指定SQL语句查询数据库中的数据，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 |
| callback | AsyncCallback&lt;[ResultSet](#resultset)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
**示例：**
```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
}
console.log("ResultSet column names: " + resultSet.columnNames)
console.log("ResultSet column count: " + resultSet.columnCount)
})
```
### querySql
querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt;
根据指定SQL语句查询数据库中的数据，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | --------------------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 否 | SQL语句中参数的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------------------------------------------- | -------------------------------------------------- |
| Promise&lt;[ResultSet](#resultset)&gt; | Promise对象。如果操作成功，则返回ResultSet对象。 |
**示例：**
```js
let promise = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'])
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)
})
```
### executeSql
executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;void&gt;):void
执行包含指定参数但不返回值的SQL语句，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ---------------------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例：**
```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) {
console.info("ExecuteSql failed, err: " + err)
return
}
console.info('Create table done.')
})
```
### executeSql
executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt;
执行包含指定参数但不返回值的SQL语句，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | --------------------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 否 | SQL语句中参数的值。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```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(() => {
console.info('Create table done.')
}).catch((err) => {
console.info("ExecuteSql failed, err: " + err)
})
```
### beginTransaction
beginTransaction():void
在开始执行SQL语句之前，开始事务。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStore(context, STORE_CONFIG, 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()
})
```
### commit
commit():void
提交已执行的SQL语句。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStore(context, STORE_CONFIG, 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()
})
```
### rollBack
rollBack():void
回滚已经执行的SQL语句。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db",
securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStore(context, STORE_CONFIG, 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()
}
})
```
### backup
backup(destName:string, callback: AsyncCallback&lt;void&gt;):void
以指定名称备份数据库，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------ |
| destName | string | 是 | 指定数据库的备份文件名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例：**
```js
rdbStore.backup("dbBackup.db", function(err) {
if (err) {
console.info('Backup failed, err: ' + err)
return
}
console.info('Backup success.')
})
```
### backup
backup(destName:string): Promise&lt;void&gt;
以指定名称备份数据库，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------ |
| destName | string | 是 | 指定数据库的备份文件名。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
let promiseBackup = rdbStore.backup("dbBackup.db")
promiseBackup.then(()=>{
console.info('Backup success.')
}).catch((err)=>{
console.info('Backup failed, err: ' + err)
})
```
### restore
restore(srcName:string, callback: AsyncCallback&lt;void&gt;):void
从指定的数据库备份文件恢复数据库，使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------ |
| srcName | string | 是 | 指定数据库的备份文件名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例：**
```js
rdbStore.restore("dbBackup.db", function(err) {
if (err) {
console.info('Restore failed, err: ' + err)
return
}
console.info('Restore success.')
})
```
### restore
restore(srcName:string): Promise&lt;void&gt;
从指定的数据库备份文件恢复数据库，使用Promise异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------ |
| srcName | string | 是 | 指定数据库的备份文件名。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
let promiseRestore = rdbStore.restore("dbBackup.db")
promiseRestore.then(()=>{
console.info('Restore success.')
}).catch((err)=>{
console.info('Restore failed, err: ' + err)
})
```
### setDistributedTables
setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;void&gt;): void
设置分布式列表，使用callback异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------- |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例：**
```js
rdbStore.setDistributedTables(["EMPLOYEE"], function (err) {
if (err) {
console.info('SetDistributedTables failed, err: ' + err)
return
}
console.info('SetDistributedTables successfully.')
})
```
### setDistributedTables
setDistributedTables(tables: Array&lt;string&gt;): Promise&lt;void&gt;
设置分布式列表，使用Promise异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------- | ---- | ------------------------ |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名。 |
**返回值**：
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
let promise = rdbStore.setDistributedTables(["EMPLOYEE"])
promise.then(() => {
console.info("SetDistributedTables successfully.")
}).catch((err) => {
console.info("SetDistributedTables failed, err: " + err)
})
```
### obtainDistributedTableName
obtainDistributedTableName(device: string, table: string, callback: AsyncCallback&lt;string&gt;): void
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 使用callback异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| device | string | 是 | 远程设备 。 |
| table | string | 是 | 本地表名。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。 |
**示例：**
```js
rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {
if (err) {
console.info('ObtainDistributedTableName failed, err: ' + err)
return
}
console.info('ObtainDistributedTableName successfully, tableName=.' + tableName)
})
```
### obtainDistributedTableName
obtainDistributedTableName(device: string, table: string): Promise&lt;string&gt;
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，使用Promise异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| device | string | 是 | 远程设备。 |
| table | string | 是 | 本地表名。 |
**返回值**：
| 类型 | 说明 |
| --------------------- | ----------------------------------------------------- |
| Promise&lt;string&gt; | Promise对象。如果操作成功，返回远程设备的分布式表名。 |
**示例：**
```js
let promise = rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE")
promise.then((tableName) => {
console.info('ObtainDistributedTableName successfully, tableName= ' + tableName)
}).catch((err) => {
console.info('ObtainDistributedTableName failed, err: ' + err)
})
```
### sync
sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback&lt;Array&lt;[string, number]&gt;&gt;): void
在设备之间同步数据, 使用callback异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ |
| mode | [SyncMode](#syncmode) | 是 | 指同步模式。该值可以是推、拉。 |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | 约束同步数据和设备。 |
| callback | AsyncCallback&lt;Array&lt;[string, number]&gt;&gt; | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.inDevices(['12345678abcde'])
rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) {
if (err) {
console.log('Sync failed, err: ' + err)
return
}
console.log('Sync done.')
for (let i = 0; i < result.length; i++) {
console.log('device=' + result[i][0] + ' status=' + result[i][1])
}
})
```
### sync
sync(mode: SyncMode, predicates: RdbPredicates): Promise&lt;Array&lt;[string, number]&gt;&gt;
在设备之间同步数据，使用Promise异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ------------------------------ |
| mode | [SyncMode](#syncmode) | 是 | 指同步模式。该值可以是推、拉。 |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | 约束同步数据和设备。 |
**返回值**：
| 类型 | 说明 |
| -------------------------------------------- | ------------------------------------------------------------ |
| Promise&lt;Array&lt;[string, number]&gt;&gt; | Promise对象，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
**示例：**
```js
let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.inDevices(['12345678abcde'])
let promise = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates)
promise.then((resultSet) =>{
console.log('Sync done.')
for (let i = 0; i < resultSet.length; i++) {
console.log('device=' + resultSet[i][0] + ' status=' + resultSet[i][1])
}
}).catch((err) => {
console.log('Sync failed')
})
```
### on('dataChange')
on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void
注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------- |
| event | string | 是 | 取值为'dataChange'，表示数据更改。 |
| type | [SubscribeType](#subscribetype) | 是 | 订阅类型。 |
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指分布式数据库中数据更改事件的观察者。 |
**示例：**
```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) {
console.log('Register observer failed')
}
```
### off('dataChange')
off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void
从数据库中删除指定类型的指定观察者, 使用callback异步回调。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ------------------------------------------ |
| event | string | 是 | 取值为'dataChange'，表示数据更改。 |
| type | [SubscribeType](#subscribetype) | 是 | 订阅类型。 |
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指已注册的数据更改观察者。 |
**示例：**
```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) {
console.log('Unregister observer failed')
}
```
## ResultSet
提供通过查询数据库生成的数据库结果集的访问方法。结果集是指用户调用关系型数据库查询接口之后返回的结果集合，提供了多种灵活的数据访问方式，以便用户获取各项数据。
### 使用说明
需要通过[RdbStore.query()](#query)获取resultSet对象。
```js
import dataRdb from '@ohos.data.rdb';
let predicates = new dataRdb.RdbPredicates("EMPLOYEE");
predicates.equalTo("AGE", 18);
let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSet) => {
console.log(TAG + "resultSet columnNames:" + resultSet.columnNames);
console.log(TAG + "resultSet columnCount:" + resultSet.columnCount);
});
```
### 属性
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 类型 | 必填 | 说明 |
| ------------ | ------------------- | ---- | -------------------------------- |
| columnNames | Array&lt;string&gt; | 是 | 获取结果集中所有列的名称。 |
| columnCount | number | 是 | 获取结果集中的列数。 |
| rowCount | number | 是 | 获取结果集中的行数。 |
| rowIndex | number | 是 | 获取结果集当前行的索引。 |
| isAtFirstRow | boolean | 是 | 检查结果集是否位于第一行。 |
| isAtLastRow | boolean | 是 | 检查结果集是否位于最后一行。 |
| isEnded | boolean | 是 | 检查结果集是否位于最后一行之后。 |
| isStarted | boolean | 是 | 检查指针是否移动过。 |
| isClosed | boolean | 是 | 检查当前结果集是否关闭。 |
### getColumnIndex
getColumnIndex(columnName: string): number
根据指定的列名获取列索引。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | -------------------------- |
| columnName | string | 是 | 表示结果集中指定列的名称。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------ |
| number | 返回指定列的索引。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
resultSet.goToFirstRow();
const id = resultSet.getLong(resultSet.getColumnIndex("ID"));
const name = resultSet.getString(resultSet.getColumnIndex("NAME"));
const age = resultSet.getLong(resultSet.getColumnIndex("AGE"));
const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"));
```
### getColumnName
getColumnName(columnIndex: number): string
根据指定的列索引获取列名。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------------------------- |
| columnIndex | number | 是 | 表示结果集中指定列的索引。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------ |
| string | 返回指定列的名称。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
const id = resultSet.getColumnName(0);
const name = resultSet.getColumnName(1);
const age = resultSet.getColumnName(2);
```
### goTo
goTo(offset:number): boolean
向前或向后转至结果集的指定行，相对于其当前位置偏移。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------- |
| offset | number | 是 | 表示相对于当前位置的偏移量。 |
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicates = new dataRdb.RdbPredicates("EMPLOYEE");
let promise= rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSet) => {
resultSet.goTo(1);
resultSet.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToRow
goToRow(position: number): boolean
转到结果集的指定行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------ |
| position | number | 是 | 表示要移动到的指定位置。 |
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicates = new dataRdb.RdbPredicates("EMPLOYEE");
let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSet) => {
resultSet.(5);
resultSet.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToFirstRow
goToFirstRow(): boolean
转到结果集的第一行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicates = new dataRdb.RdbPredicates("EMPLOYEE");
let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSet) => {
resultSet.goToFirstRow();
resultSet.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToLastRow
goToLastRow(): boolean
转到结果集的最后一行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicates = new dataRdb.RdbPredicates("EMPLOYEE");
let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSet) => {
resultSet.goToLastRow();
resultSet.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToNextRow
goToNextRow(): boolean
转到结果集的下一行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicates = new dataRdb.RdbPredicates("EMPLOYEE");
let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSet) => {
resultSet.goToNextRow();
resultSet.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToPreviousRow
goToPreviousRow(): boolean
转到结果集的上一行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicates = new dataRdb.RdbPredicates("EMPLOYEE");
let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSet) => {
resultSet.goToPreviousRow();
resultSet.close();
}).catch((err) => {
console.log('query failed');
});
```
### getBlob
getBlob(columnIndex: number): Uint8Array
以字节数组的形式获取当前行中指定列的值。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ---------- | -------------------------------- |
| Uint8Array | 以字节数组的形式返回指定列的值。 |
**示例：**
```js
const codes = resultSet.getBlob(resultSet.getColumnIndex("CODES"));
```
### getString
getString(columnIndex: number): string
以字符串形式获取当前行中指定列的值。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ------ | ---------------------------- |
| string | 以字符串形式返回指定列的值。 |
**示例：**
```js
const name = resultSet.getString(resultSet.getColumnIndex("NAME"));
```
### getLong
getLong(columnIndex: number): number
以Long形式获取当前行中指定列的值。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ------ | -------------------------- |
| number | 以Long形式返回指定列的值。 |
**示例：**
```js
const age = resultSet.getLong(resultSet.getColumnIndex("AGE"));
```
### getDouble
getDouble(columnIndex: number): number
以double形式获取当前行中指定列的值。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ------ | ---------------------------- |
| number | 以double形式返回指定列的值。 |
**示例：**
```js
const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"));
```
### isColumnNull
isColumnNull(columnIndex: number): boolean
检查当前行中指定列的值是否为null。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------------------- |
| boolean | 如果当前行中指定列的值为null，则返回true，否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
const isColumnNull = resultSet.isColumnNull(resultSet.getColumnIndex("CODES"));
```
### close
close(): void
关闭结果集。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
```js
let predicatesClose = new dataRdb.RdbPredicates("EMPLOYEE");
let promiseClose = rdbStore.query(predicatesClose, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promiseClose.then((resultSet) => {
resultSet.close();
}).catch((err) => {
console.log('resultset close failed');
});
```
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
zh-cn/application-dev/reference/apis/js-apis-data-resultset.md
浏览文件 @ be87c2e7
......@@ -5,545 +5,13 @@
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 从API Version 9开始，该接口不再维护，推荐使用新接口[@ohos.data.relationalStore#ResultSet](js-apis-data-relationalStore.md#resultset)。
## ResultSetV9<sup>9+</sup>
提供通过查询数据库生成的数据库结果集的访问方法。
### 使用说明
需要通过[RdbStoreV9.query()](js-apis-data-rdb.md#query)获取resultSetV9对象。
```js
import dataRdb from '@ohos.data.rdb';
let predicatesV9 = new dataRdb.RdbPredicatesV9("EMPLOYEE");
predicatesV9.equalTo("AGE", 18);
let promise = rdbStoreV9.query(predicatesV9, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promise.then((resultSetV9) => {
console.log(TAG + "resultSet columnNames:" + resultSetV9.columnNames);
console.log(TAG + "resultSet columnCount:" + resultSetV9.columnCount);
});
```
### 属性<sup>9+</sup>
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 类型 | 必填 | 说明 |
| ------------ | ------------------- | ---- | -------------------------------- |
| columnNames | Array&lt;string&gt; | 是 | 获取结果集中所有列的名称。 |
| columnCount | number | 是 | 获取结果集中的列数。 |
| rowCount | number | 是 | 获取结果集中的行数。 |
| rowIndex | number | 是 | 获取结果集当前行的索引。 |
| isAtFirstRow | boolean | 是 | 检查结果集是否位于第一行。 |
| isAtLastRow | boolean | 是 | 检查结果集是否位于最后一行。 |
| isEnded | boolean | 是 | 检查结果集是否位于最后一行之后。 |
| isStarted | boolean | 是 | 检查指针是否移动过。 |
| isClosed | boolean | 是 | 检查当前结果集是否关闭。 |
### getColumnIndex<sup>9+</sup>
getColumnIndex(columnName: string): number
根据指定的列名获取列索引。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | -------------------------- |
| columnName | string | 是 | 表示结果集中指定列的名称。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------ |
| number | 返回指定列的索引。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
resultSetV9.goToFirstRow();
const id = resultSetV9.getLong(resultSetV9.getColumnIndex("ID"));
const name = resultSetV9.getString(resultSetV9.getColumnIndex("NAME"));
const age = resultSetV9.getLong(resultSetV9.getColumnIndex("AGE"));
const salary = resultSetV9.getDouble(resultSetV9.getColumnIndex("SALARY"));
```
### getColumnName<sup>9+</sup>
getColumnName(columnIndex: number): string
根据指定的列索引获取列名。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------------------------- |
| columnIndex | number | 是 | 表示结果集中指定列的索引。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------ |
| string | 返回指定列的名称。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
const id = resultSetV9.getColumnName(0);
const name = resultSetV9.getColumnName(1);
const age = resultSetV9.getColumnName(2);
```
### goTo<sup>9+</sup>
goTo(offset:number): boolean
向前或向后转至结果集的指定行，相对于其当前位置偏移。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------- |
| offset | number | 是 | 表示相对于当前位置的偏移量。 |
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicatesV9goto = new dataRdb.RdbPredicatesV9("EMPLOYEE");
let promisequerygoto = rdbStoreV9.query(predicatesV9goto, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promisequerygoto.then((resultSetV9) => {
resultSetV9.goTo(1);
resultSetV9.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToRow<sup>9+</sup>
goToRow(position: number): boolean
转到结果集的指定行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------ |
| position | number | 是 | 表示要移动到的指定位置。 |
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicatesV9gotorow = new dataRdb.RdbPredicatesV9("EMPLOYEE");
let promisequerygotorow = rdbStoreV9.query(predicatesV9gotorow, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promisequerygotorow.then((resultSetV9) => {
resultSetV9.goToRow(5);
resultSetV9.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToFirstRow<sup>9+</sup>
goToFirstRow(): boolean
转到结果集的第一行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicatesV9goFirst = new dataRdb.RdbPredicatesV9("EMPLOYEE");
let promisequerygoFirst = rdbStoreV9.query(predicatesV9goFirst, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promisequerygoFirst.then((resultSetV9) => {
resultSetV9.goToFirstRow();
resultSetV9.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToLastRow<sup>9+</sup>
goToLastRow(): boolean
转到结果集的最后一行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicatesV9goLast = new dataRdb.RdbPredicatesV9("EMPLOYEE");
let promisequerygoLast = rdbStoreV9.query(predicatesV9goLast, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promisequerygoLast.then((resultSetV9) => {
resultSetV9.goToLastRow();
resultSetV9.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToNextRow<sup>9+</sup>
goToNextRow(): boolean
转到结果集的下一行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicatesV9goNext = new dataRdb.RdbPredicatesV9("EMPLOYEE");
let promisequerygoNext = rdbStoreV9.query(predicatesV9goNext, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promisequerygoNext.then((resultSetV9) => {
resultSetV9.goToNextRow();
resultSetV9.close();
}).catch((err) => {
console.log('query failed');
});
```
### goToPreviousRow<sup>9+</sup>
goToPreviousRow(): boolean
转到结果集的上一行。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
**示例：**
```js
let predicatesV9goPrev = new dataRdb.RdbPredicatesV9("EMPLOYEE");
let promisequerygoPrev = rdbStoreV9.query(predicatesV9goPrev, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promisequerygoPrev.then((resultSetV9) => {
resultSetV9.goToPreviousRow();
resultSetV9.close();
}).catch((err) => {
console.log('query failed');
});
```
### getBlob<sup>9+</sup>
getBlob(columnIndex: number): Uint8Array
以字节数组的形式获取当前行中指定列的值。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ---------- | -------------------------------- |
| Uint8Array | 以字节数组的形式返回指定列的值。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
const codes = resultSetV9.getBlob(resultSetV9.getColumnIndex("CODES"));
```
### getString<sup>9+</sup>
getString(columnIndex: number): string
以字符串形式获取当前行中指定列的值。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ------ | ---------------------------- |
| string | 以字符串形式返回指定列的值。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
const name = resultSetV9.getString(resultSetV9.getColumnIndex("NAME"));
```
### getLong<sup>9+</sup>
getLong(columnIndex: number): number
以Long形式获取当前行中指定列的值。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ------ | -------------------------- |
| number | 以Long形式返回指定列的值。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
const age = resultSetV9.getLong(resultSetV9.getColumnIndex("AGE"));
```
### getDouble<sup>9+</sup>
getDouble(columnIndex: number): number
以double形式获取当前行中指定列的值。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ------ | ---------------------------- |
| number | 以double形式返回指定列的值。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
const salary = resultSetV9.getDouble(resultSetV9.getColumnIndex("SALARY"));
```
### isColumnNull<sup>9+</sup>
isColumnNull(columnIndex: number): boolean
检查当前行中指定列的值是否为null。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
**返回值：**
| 类型 | 说明 |
| ------- | --------------------------------------------------------- |
| boolean | 如果当前行中指定列的值为null，则返回true，否则返回false。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800013 | The column value is null or the column type is incompatible. |
**示例：**
```js
const isColumnNull = resultSetV9.isColumnNull(resultSetV9.getColumnIndex("CODES"));
```
### close<sup>9+</sup>
close(): void
关闭结果集。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
```js
let predicatesV9Close = new dataRdb.RdbPredicatesV9("EMPLOYEE");
let promiseClose = rdbStoreV9.query(predicatesV9Close, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
promiseClose.then((resultSetV9) => {
resultSetV9.close();
}).catch((err) => {
console.log('resultset close failed');
});
```
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------------------ |
| 14800012 | The result set is empty or the specified location is invalid. |
## ResultSet<sup>(deprecated)</sup>
## ResultSet
提供通过查询数据库生成的数据库结果集的访问方法。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[ResultSetV9](#resultsetv99)替代。
### 使用说明
需要通过[RdbStore.query()](js-apis-data-rdb.md#query)获取resultSet对象。
......@@ -559,11 +27,7 @@ promise.then((resultSet) => {
});
```
### 属性<sup>(deprecated)</sup>
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[属性](#属性9)替代。
### 属性
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
......@@ -579,16 +43,12 @@ promise.then((resultSet) => {
| isStarted | boolean | 是 | 检查指针是否移动过。 |
| isClosed | boolean | 是 | 检查当前结果集是否关闭。 |
### getColumnIndex<sup>(deprecated)</sup>
### getColumnIndex
getColumnIndex(columnName: string): number
根据指定的列名获取列索引。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[getColumnIndex](#getcolumnindex9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -613,16 +73,12 @@ getColumnIndex(columnName: string): number
const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"));
```
### getColumnName<sup>(deprecated)</sup>
### getColumnName
getColumnName(columnIndex: number): string
根据指定的列索引获取列名。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[getColumnName](#getcolumnname9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -645,16 +101,12 @@ getColumnName(columnIndex: number): string
const age = resultSet.getColumnName(2);
```
### goTo<sup>(deprecated)</sup>
### goTo
goTo(offset:number): boolean
向前或向后转至结果集的指定行，相对于其当前位置偏移。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[goTo](#goto9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -682,16 +134,12 @@ goTo(offset:number): boolean
});
```
### goToRow<sup>(deprecated)</sup>
### goToRow
goToRow(position: number): boolean
转到结果集的指定行。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[goToRow](#gotorow9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -719,16 +167,12 @@ goToRow(position: number): boolean
});
```
### goToFirstRow<sup>(deprecated)</sup>
### goToFirstRow
goToFirstRow(): boolean
转到结果集的第一行。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[goToFirstRow](#gotofirstrow9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
......@@ -750,16 +194,12 @@ goToFirstRow(): boolean
});
```
### goToLastRow<sup>(deprecated)</sup>
### goToLastRow
goToLastRow(): boolean
转到结果集的最后一行。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[goToLastRow](#gotolastrow9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
......@@ -781,16 +221,12 @@ goToLastRow(): boolean
});
```
### goToNextRow<sup>(deprecated)</sup>
### goToNextRow
goToNextRow(): boolean
转到结果集的下一行。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[goToNextRow](#gotonextrow9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
......@@ -812,16 +248,12 @@ goToNextRow(): boolean
});
```
### goToPreviousRow<sup>(deprecated)</sup>
### goToPreviousRow
goToPreviousRow(): boolean
转到结果集的上一行。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[goToPreviousRow](#gotopreviousrow9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**返回值：**
......@@ -843,16 +275,12 @@ goToPreviousRow(): boolean
});
```
### getBlob<sup>(deprecated)</sup>
### getBlob
getBlob(columnIndex: number): Uint8Array
以字节数组的形式获取当前行中指定列的值。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[getBlob](#getblob9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -873,16 +301,12 @@ getBlob(columnIndex: number): Uint8Array
const codes = resultSet.getBlob(resultSet.getColumnIndex("CODES"));
```
### getString<sup>(deprecated)</sup>
### getString
getString(columnIndex: number): string
以字符串形式获取当前行中指定列的值。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[getString](#getstring9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -903,16 +327,12 @@ getString(columnIndex: number): string
const name = resultSet.getString(resultSet.getColumnIndex("NAME"));
```
### getLong<sup>(deprecated)</sup>
### getLong
getLong(columnIndex: number): number
以Long形式获取当前行中指定列的值。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[getLong](#getlong9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -933,16 +353,12 @@ getLong(columnIndex: number): number
const age = resultSet.getLong(resultSet.getColumnIndex("AGE"));
```
### getDouble<sup>(deprecated)</sup>
### getDouble
getDouble(columnIndex: number): number
以double形式获取当前行中指定列的值。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[getDouble](#getdouble9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -963,16 +379,12 @@ getDouble(columnIndex: number): number
const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"));
```
### isColumnNull<sup>(deprecated)</sup>
### isColumnNull
isColumnNull(columnIndex: number): boolean
检查当前行中指定列的值是否为null。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[isColumnNull](#iscolumnnull9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
......@@ -993,16 +405,12 @@ isColumnNull(columnIndex: number): boolean
const isColumnNull = resultSet.isColumnNull(resultSet.getColumnIndex("CODES"));
```
### close<sup>(deprecated)</sup>
### close
close(): void
关闭结果集。
> **说明：**
>
> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[close](#close9)替代。
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**示例：**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或