diff --git a/en/application-dev/reference/apis/js-apis-data-rdb.md b/en/application-dev/reference/apis/js-apis-data-rdb.md
index bcebd097f34c1337e5826e866302af9626696a32..8938704647ca8ba7b72770da67da996fd1b2ad5e 100644
--- a/en/application-dev/reference/apis/js-apis-data-rdb.md
+++ b/en/application-dev/reference/apis/js-apis-data-rdb.md
@@ -1,6 +1,6 @@
-# @ohos.data.rdb (RDB)
+# @ohos.data.rdb
-The relational database (RDB) manages data based on relational models. With the underlying SQLite database, the RDB provides a complete mechanism for managing local databases. To satisfy different needs in complicated scenarios, the RDB offers a series of methods for performing operations such as adding, deleting, modifying, and querying data, and supports direct execution of SQL statements.
+The relational database (RDB) manages data based on relational models. With the underlying SQLite database, the RDB provides a complete mechanism for managing local databases. To satisfy different needs in complicated scenarios, the RDB offers a series of methods for performing operations such as adding, deleting, modifying, and querying data, and supports direct execution of SQL statements. After an application is deleted, the related RDB store will be automatically deleted.
This module provides the following RDB-related functions:
@@ -13,256 +13,2666 @@ This module provides the following RDB-related functions:
>
> The APIs of this module are no longer maintained since API version 9. You are advised to use [@ohos.data.relationalStore](js-apis-data-relationalStore.md).
-
## Modules to Import
```js
import data_rdb from '@ohos.data.rdb';
```
+
+## data_rdb.getRdbStoreV99+
+
+getRdbStoreV9(context: Context, config: StoreConfigV9, version: number, callback: AsyncCallback<RdbStoreV9>): void
+
+Obtains an **RdbStoreV9** instance. This API uses an asynchronous callback to return the result. You can set parameters for the RDB store based on service requirements and call APIs to perform data operations.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| config | [StoreConfigV9](#storeconfigv99) | Yes | Configuration of the RDB store. |
+| version | number | Yes | RDB store version.
Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. |
+| callback | AsyncCallback<[RdbStoreV9](#rdbstorev99)> | Yes | Callback invoked to return the **RdbStoreV9** instance obtained. |
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ----------------------- |
+| 14800010 | Invalid database name. |
+| 14800011 | Database corrupted. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call getRdbStoreV9 after obtaining the context.
+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 model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call getRdbStoreV9 after obtaining the context.
+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.getRdbStoreV99+
+
+getRdbStoreV9(context: Context, config: StoreConfigV9, version: number): Promise<RdbStoreV9>
+
+Obtains an **RdbStoreV9** instance. This API uses a promise to return the result. You can set parameters for the RDB store based on service requirements and call APIs to perform data operations.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | -------------------------------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| config | [StoreConfigV9](#storeconfigv99) | Yes | Configuration of the RDB store. |
+| version | number | Yes | RDB store version.
Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. |
+
+**Return value**
+
+| Type | Description |
+| ----------------------------------------- | --------------------------------- |
+| Promise<[RdbStoreV9](#rdbstorev999)> | Promise used to return the **RdbStoreV9** instance obtained.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ----------------------- |
+| 14800010 | Invalid database name. |
+| 14800011 | Database corrupted. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call getRdbStoreV9 after obtaining the context.
+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 model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call getRdbStoreV9 after obtaining the context.
+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.deleteRdbStoreV99+
+
+deleteRdbStoreV9(context: Context, name: string, callback: AsyncCallback<void>): void
+
+Deletes an RDB store. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| name | string | Yes | Name of the RDB store to delete. |
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ----------------------- |
+| 14800010 | Invalid database name. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call deleteRdbStoreV9 after obtaining the context.
+data_rdb.deleteRdbStoreV9(context, "RdbTest.db", function (err) {
+ if (err) {
+ console.info("Delete RdbStorev9 failed, err: " + err)
+ return
+ }
+ console.log("Delete RdbStorev9 successfully.")
+})
+```
+
+Stage model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call deleteRdbStoreV9 after obtaining the context.
+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.deleteRdbStoreV99+
+
+deleteRdbStoreV9(context: Context, name: string): Promise<void>
+
+Deletes an RDB store. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | ------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| name | string | Yes | Name of the RDB store to delete. |
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ----------------------- |
+| 14800010 | Invalid database name. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call deleteRdbStoreV9 after obtaining the context.
+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 model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call deleteRdbStoreV9 after obtaining the context.
+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
+
+getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void
+
+Obtains an RDB store. This API uses an asynchronous callback to return the result. You can set parameters for the RDB store based on service requirements and call APIs to perform data operations.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. |
+| version | number | Yes | RDB store version.
Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. |
+| callback | AsyncCallback<[RdbStore](#rdbstore)> | Yes | Callback invoked to return the RDB store obtained. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call getRdbStore.
+const STORE_CONFIG = { name: "RdbTest.db"}
+data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
+ if (err) {
+ console.info("Failed to get RdbStore, err: " + err)
+ return
+ }
+ console.log("Got RdbStore successfully.")
+})
+```
+
+Stage model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call getRdbStore.
+const STORE_CONFIG = { name: "RdbTest.db"}
+data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
+ if (err) {
+ console.info("Failed to get RdbStore, err: " + err)
+ return
+ }
+ console.log("Got RdbStore successfully.")
+})
+```
+
## data_rdb.getRdbStore
-getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void
+getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore>
+
+Obtains an RDB store. This API uses a promise to return the result. You can set parameters for the RDB store based on service requirements and call APIs to perform data operations.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | --------------------------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. |
+| version | number | Yes | RDB store version.
Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. |
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------------- |
+| Promise<[RdbStore](#rdbstore)> | Promise used to return the RDB store obtained.|
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call getRdbStore.
+const STORE_CONFIG = { name: "RdbTest.db" }
+let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1);
+promise.then(async (rdbStore) => {
+ console.log("Got RdbStore successfully.")
+}).catch((err) => {
+ console.log("Failed to get RdbStore, err: " + err)
+})
+```
+
+Stage model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call getRdbStore.
+const STORE_CONFIG = { name: "RdbTest.db" }
+let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1);
+promise.then(async (rdbStore) => {
+ console.log("Got RdbStore successfully.")
+}).catch((err) => {
+ console.log("Failed to get RdbStore, err: " + err)
+})
+```
+
+## data_rdb.deleteRdbStore
+
+deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void
+
+Deletes an RDB store. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| name | string | Yes | Name of the RDB store to delete. |
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call deleteRdbStore.
+data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
+ if (err) {
+ console.info("Failed to delete RdbStore, err: " + err)
+ return
+ }
+ console.log("Deleted RdbStore successfully.")
+})
+```
+
+Stage model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call deleteRdbStore.
+data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
+ if (err) {
+ console.info("Failed to delete RdbStore, err: " + err)
+ return
+ }
+ console.log("Deleted RdbStore successfully.")
+})
+```
+
+## data_rdb.deleteRdbStore
+
+deleteRdbStore(context: Context, name: string): Promise<void>
+
+Deletes an RDB store. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | ------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| name | string | Yes | Name of the RDB store to delete. |
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call deleteRdbStore.
+let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
+promise.then(() => {
+ console.log("Deleted RdbStore successfully.")
+}).catch((err) => {
+ console.info("Failed to delete RdbStore, err: " + err)
+})
+```
+
+Stage model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call deleteRdbStore.
+let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
+promise.then(()=>{
+ console.log("Deleted RdbStore successfully.")
+}).catch((err) => {
+ console.info("Failed to delete RdbStore, err: " + err)
+})
+```
+
+## RdbPredicatesV99+
+
+Defines predicates for an RDB store. This class determines whether the conditional expression for the RDB store is true or false.
+
+
+### constructor9+
+
+constructor(name: string)
+
+
+A constructor used to create an **RdbPredicates** object.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------ |
+| name | string | Yes | Database table name.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+```
+
+### inDevices9+
+
+inDevices(devices: Array<string>): RdbPredicatesV9
+
+
+Sets an **RdbPredicatesV9** to specify the remote devices to connect on the network during distributed database synchronization.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | ------------------- | ---- | -------------------------- |
+| devices | Array<string> | Yes | IDs of the remote devices in the same network.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.inDevices(['12345678abcde'])
+```
+
+### inAllDevices9+
+
+inAllDevices(): RdbPredicatesV9
+
+
+Sets an **RdbPredicatesV9** to specify all remote devices on the network to connect during distributed database synchronization.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesv9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.inAllDevices()
+```
+
+### equalTo9+
+
+equalTo(field: string, value: ValueType): RdbPredicatesV9
+
+
+Sets an **RdbPredicatesV9** to match the field with data type **ValueType** and value equal to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "lisi")
+```
+
+
+### notEqualTo9+
+
+notEqualTo(field: string, value: ValueType): RdbPredicatesV9
+
+
+Sets an **RdbPredicatesV9** to match the field with data type **ValueType** and value not equal to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.notEqualTo("NAME", "lisi")
+```
+
+
+### beginWrap9+
+
+beginWrap(): RdbPredicatesV9
+
+
+Adds a left parenthesis to the **RdbPredicatesV9**.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** with a left parenthesis.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "lisi")
+ .beginWrap()
+ .equalTo("AGE", 18)
+ .or()
+ .equalTo("SALARY", 200.5)
+ .endWrap()
+```
+
+### endWrap9+
+
+endWrap(): RdbPredicatesV9
+
+Adds a right parenthesis to the **RdbPredicatesV9**.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** with a right parenthesis.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "lisi")
+ .beginWrap()
+ .equalTo("AGE", 18)
+ .or()
+ .equalTo("SALARY", 200.5)
+ .endWrap()
+```
+
+### or9+
+
+or(): RdbPredicatesV9
+
+Adds the OR condition to the **RdbPredicatesV9**.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** with the OR condition.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "Lisa")
+ .or()
+ .equalTo("NAME", "Rose")
+```
+
+### and9+
+
+and(): RdbPredicatesV9
+
+Adds the AND condition to the **RdbPredicatesV9**.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** with the AND condition.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "Lisa")
+ .and()
+ .equalTo("SALARY", 200.5)
+```
+
+### contains9+
+
+contains(field: string, value: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match a string containing the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.contains("NAME", "os")
+```
+
+### beginsWith9+
+
+beginsWith(field: string, value: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match a string that starts with the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.beginsWith("NAME", "os")
+```
+
+### endsWith9+
+
+endsWith(field: string, value: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match a string that ends with the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.endsWith("NAME", "se")
+```
+
+### isNull9+
+
+isNull(field: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field whose value is null.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------ |
+| field | string | Yes | Column name in the database table.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.isNull("NAME")
+```
+
+### isNotNull9+
+
+isNotNull(field: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field whose value is not null.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------ |
+| field | string | Yes | Column name in the database table.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.isNotNull("NAME")
+```
+
+### like9+
+
+like(field: string, value: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match a string that is similar to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.like("NAME", "%os%")
+```
+
+### glob9+
+
+glob(field: string, value: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the specified string.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------------------------------------------------ |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicatesV9**.
Wildcards are supported. * indicates zero, one, or multiple digits or characters. **?** indicates a single digit or character.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.glob("NAME", "?h*g")
+```
+
+### between9+
+
+between(field: string, low: ValueType, high: ValueType): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field with data type **ValueType** and value within the specified range.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | -------------------------- |
+| field | string | Yes | Column name in the database table. |
+| low | [ValueType](#valuetype) | Yes | Minimum value to match the **RdbPredicatesV9**. |
+| high | [ValueType](#valuetype) | Yes | Maximum value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.between("AGE", 10, 50)
+```
+
+### notBetween9+
+
+notBetween(field: string, low: ValueType, high: ValueType): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field with data type **ValueType** and value out of the specified range.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | -------------------------- |
+| field | string | Yes | Column name in the database table. |
+| low | [ValueType](#valuetype) | Yes | Minimum value to match the **RdbPredicatesV9**. |
+| high | [ValueType](#valuetype) | Yes | Maximum value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.notBetween("AGE", 10, 50)
+```
+
+### greaterThan9+
+
+greaterThan(field: string, value: ValueType): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field with data type **ValueType** and value greater than the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.greaterThan("AGE", 18)
+```
+
+### lessThan9+
+
+lessThan(field: string, value: ValueType): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field with data type **ValueType** and value less than the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.lessThan("AGE", 20)
+```
+
+### greaterThanOrEqualTo9+
+
+greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field with data type **ValueType** and value greater than or equal to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.greaterThanOrEqualTo("AGE", 18)
+```
+
+### lessThanOrEqualTo9+
+
+lessThanOrEqualTo(field: string, value: ValueType): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field with data type **ValueType** and value less than or equal to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicatesV9**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.lessThanOrEqualTo("AGE", 20)
+```
+
+### orderByAsc9+
+
+orderByAsc(field: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the column with values sorted in ascending order.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------ |
+| field | string | Yes | Column name in the database table.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.orderByAsc("NAME")
+```
+
+### orderByDesc9+
+
+orderByDesc(field: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the column with values sorted in descending order.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------ |
+| field | string | Yes | Column name in the database table.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.orderByDesc("AGE")
+```
+
+### distinct9+
+
+distinct(): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to filter out duplicate records.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------------ |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object that can filter out duplicate records.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "Rose").distinct()
+```
+
+### limitAs9+
+
+limitAs(value: number): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to specify the maximum number of records.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------- |
+| value | number | Yes | Maximum number of records.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------------------ |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object that specifies the maximum number of records.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "Rose").limitAs(3)
+```
+
+### offsetAs9+
+
+offsetAs(rowOffset: number): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to specify the start position of the returned result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| --------- | ------ | ---- | ---------------------------------- |
+| rowOffset | number | Yes | Number of rows to offset from the beginning. The value is a positive integer.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------------------ |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object that specifies the start position of the returned result.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "Rose").offsetAs(3)
+```
+
+### groupBy9+
+
+groupBy(fields: Array<string>): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to group rows that have the same value into summary rows.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------- | ---- | -------------------- |
+| fields | Array<string> | Yes | Names of columns to group.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ---------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object that groups rows with the same value.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.groupBy(["AGE", "NAME"])
+```
+
+### indexedBy9+
+
+indexedBy(field: string): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to specify the index column.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | -------------- |
+| field | string | Yes | Name of the index column.|
+
+**Return value**
+
+
+| Type | Description |
+| ------------------------------------ | ------------------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object that specifies the index column.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.indexedBy("SALARY_INDEX")
+```
+
+### in9+
+
+in(field: string, value: Array<ValueType>): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field with data type **Array<ValueType>** and value within the specified range.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------------------------ | ---- | --------------------------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | Array<[ValueType](#valuetype)> | Yes | Array of **ValueType**s to match.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.in("AGE", [18, 20])
+```
+
+### notIn9+
+
+notIn(field: string, value: Array<ValueType>): RdbPredicatesV9
+
+Sets an **RdbPredicatesV9** to match the field with data type **Array<ValueType>** and value out of the specified range.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------------------------ | ---- | ------------------------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | Array<[ValueType](#valuetype)> | Yes | Array of **ValueType**s to match.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicatesV9](#rdbpredicatesv99) | **RdbPredicatesV9** object created.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.notIn("NAME", ["Lisa", "Rose"])
+```
+
+## RdbStoreV99+
+
+Provides methods to manage an RDB store.
+
+Before using the following APIs, use [executeSql](#executesql) to initialize the database table structure and related data. For details, see [RDB Development](../../database/database-relational-guidelines.md).
+
+### insert9+
+
+insert(table: string, values: ValuesBucket, callback: AsyncCallback<number>):void
+
+Inserts a row of data into a table. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ----------------------------- | ---- | ---------------------------------------------------------- |
+| table | string | Yes | Name of the target table. |
+| values | [ValuesBucket](#valuesbucket) | Yes | Row of data to insert. |
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the result. If the operation is successful, the row ID will be returned. Otherwise, **-1** will be returned.|
+
+**Example**
+
+```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("Failed to insert data");
+ return;
+ }
+ console.log("Inserted data successfully, rowId = " + rowId);
+})
+```
+
+### insert9+
+
+insert(table: string, values: ValuesBucket):Promise<number>
+
+Inserts a row of data into a table. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------------- | ---- | -------------------------- |
+| table | string | Yes | Name of the target table. |
+| values | [ValuesBucket](#valuesbucket) | Yes | Row of data to insert.|
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ------------------------------------------------- |
+| Promise<number> | Promise used to return the result. If the operation is successful, the row ID will be returned. Otherwise, **-1** will be returned.|
+
+**Example**
+
+```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("Inserted data successfully, rowId = " + rowId);
+}).catch((status) => {
+ console.log("Failed to insert data");
+})
+```
+
+### batchInsert9+
+
+batchInsert(table: string, values: Array<ValuesBucket>, callback: AsyncCallback<number>):void
+
+Batch inserts data into a table. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ |
+| table | string | Yes | Name of the target table. |
+| values | Array<[ValuesBucket](#valuesbucket)> | Yes | An array of data to insert. |
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the result. If the operation is successful, the number of inserted data records is returned. Otherwise, **-1** is returned.|
+
+**Example**
+
+```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);
+})
+```
+
+### batchInsert9+
+
+batchInsert(table: string, values: Array<ValuesBucket>):Promise<number>
+
+Batch inserts data into a table. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------------------------------ | ---- | ---------------------------- |
+| table | string | Yes | Name of the target table. |
+| values | Array<[ValuesBucket](#valuesbucket)> | Yes | An array of data to insert.|
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ----------------------------------------------------------- |
+| Promise<number> | Promise used to return the result. If the operation is successful, the number of inserted data records is returned. Otherwise, **-1** is returned.|
+
+**Example**
+
+```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);
+})
+```
+
+### update9+
+
+update(values: ValuesBucket, predicates: RdbPredicatesV9, callback: AsyncCallback<number>):void
+
+Updates data based on the specified **RdbPredicatesV9** object. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
+| values | [ValuesBucket](#valuesbucket) | Yes | Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | Update conditions specified by the **RdbPredicatesV9** object. |
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the number of rows updated. |
+
+**Example**
+
+```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("Failed to update data, err: " + err)
+ return
+ }
+ console.log("Updated row count: " + ret)
+})
+```
+
+### update9+
+
+update(values: ValuesBucket, predicates: RdbPredicatesV9):Promise<number>
+
+Updates data based on the specified **RdbPredicatesV9** object. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------------ | ------------------------------------ | ---- | ------------------------------------------------------------ |
+| values | [ValuesBucket](#valuesbucket) | Yes | Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| predicatesV9 | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | Update conditions specified by the **RdbPredicatesV9** object. |
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ----------------------------------------- |
+| Promise<number> | Promise used to return the number of rows updated.|
+
+**Example**
+
+```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("Failed to update data, err: " + err)
+})
+```
+
+### update9+
+
+update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>):void
+
+Updates data based on the specified **DataSharePredicates** object. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
+| table | string | Yes | Name of the target table. |
+| values | [ValuesBucket](#valuesbucket) | Yes | Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Update conditions specified by the **DataSharePredicates** object. |
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the number of rows updated. |
+
+**Example**
+
+```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("Failed to update data, err: " + err)
+ return
+ }
+ console.log("Updated row count: " + ret)
+})
+```
+
+### update9+
+
+update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates):Promise<number>
+
+Updates data based on the specified **DataSharePredicates** object. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
+| table | string | Yes | Name of the target table. |
+| values | [ValuesBucket](#valuesbucket) | Yes | Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Update conditions specified by the **DataSharePredicates** object. |
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ----------------------------------------- |
+| Promise<number> | Promise used to return the number of rows updated.|
+
+**Example**
+
+```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("Failed to update data, err: " + err)
+})
+```
+
+### delete9+
+
+delete(predicates: RdbPredicatesV9, callback: AsyncCallback<number>):void
+
+Deletes data from the RDB store based on the specified **RdbPredicatesV9** object. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ----------------------------------------- |
+| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | Conditions specified by the **RdbPredicatesV9** object for deleting data.|
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the number of rows deleted. |
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "Lisa")
+rdbStoreV9.delete(predicatesV9, function (err, rows) {
+ if (err) {
+ console.info("Failed to delete data, err: " + err)
+ return
+ }
+ console.log("Deleted rows: " + rows)
+})
+```
+
+### delete9+
+
+delete(predicates: RdbPredicatesV9):Promise<number>
+
+Deletes data from the RDB store based on the specified **RdbPredicatesV9** object. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ----------------------------------------- |
+| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | Conditions specified by the **RdbPredicatesV9** object for deleting data.|
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ------------------------------- |
+| Promise<number> | Promise used to return the number of rows deleted.|
+
+**Example**
+
+```js
+let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
+predicatesV9.equalTo("NAME", "Lisa")
+let promise = rdbStoreV9.delete(predicatesV9)
+promise.then((rows) => {
+ console.log("Deleted rows: " + rows)
+}).catch((err) => {
+ console.info("Failed to delete data, err: " + err)
+})
+```
+
+### delete9+
+
+delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>):void
+
+Deletes data from the RDB store based on the specified **DataSharePredicates** object. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
+| table | string | Yes | Name of the target table. |
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Conditions specified by the **DataSharePredicates** object for deleting data.|
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the number of rows deleted. |
+
+**Example**
+
+```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("Failed to delete data, err: " + err)
+ return
+ }
+ console.log("Deleted rows: " + rows)
+})
+```
+
+### delete9+
+
+delete(table: string, predicates: dataSharePredicates.DataSharePredicates):Promise<number>
+
+Deletes data from the RDB store based on the specified **DataSharePredicates** object. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
+| table | string | Yes | Name of the target table. |
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Conditions specified by the **DataSharePredicates** object for deleting data.|
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ------------------------------- |
+| Promise<number> | Promise used to return the number of rows deleted.|
+
+**Example**
+
+```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("Deleted rows: " + rows)
+}).catch((err) => {
+ console.info("Failed to delete data, err: " + err)
+})
+```
+
+### query9+
+
+query(predicates: RdbPredicatesV9, columns: Array<string>, callback: AsyncCallback<ResultSetV9>):void
+
+Queries data from the RDB store based on specified conditions. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
+| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | Query conditions specified by the **RdbPredicatesV9** object. |
+| columns | Array<string> | Yes | Columns to query. If this parameter is not specified, the query applies to all columns. |
+| callback | AsyncCallback<[ResultSetV9](js-apis-data-resultset.md)> | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSetV9** object will be returned.|
+
+**Example**
+
+```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("Failed to query data, err: " + err)
+ return
+ }
+ console.log("ResultSet column names: " + resultSetV9.columnNames)
+ console.log("ResultSet column count: " + resultSetV9.columnCount)
+})
+```
+
+### query9+
+
+query(predicates: RdbPredicatesV9, columns?: Array<string>):Promise<ResultSetV9>
+
+Queries data from the RDB store based on specified conditions. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ------------------------------------------------ |
+| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | Query conditions specified by the **RdbPredicatesV9** object. |
+| columns | Array<string> | No | Columns to query. If this parameter is not specified, the query applies to all columns.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------------------------- | -------------------------------------------------- |
+| Promise<[ResultSetV9](js-apis-data-resultset.md)> | Promise used to return the result. If the operation is successful, a **ResultSetV9** object will be returned.|
+
+**Example**
+
+ ```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("Failed to query data, err: " + err)
+})
+ ```
+
+### query9+
+
+query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: AsyncCallback<ResultSetV9>):void
+
+Queries data from the RDB store based on specified conditions. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
+| table | string | Yes | Name of the target table. |
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Query conditions specified by the **DataSharePredicates** object. |
+| columns | Array<string> | Yes | Columns to query. If this parameter is not specified, the query applies to all columns. |
+| callback | AsyncCallback<[ResultSetV9](js-apis-data-resultset.md)> | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSetV9** object will be returned.|
+
+**Example**
+
+```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("Failed to query data, err: " + err)
+ return
+ }
+ console.log("ResultSet column names: " + resultSetV9.columnNames)
+ console.log("ResultSet column count: " + resultSetV9.columnCount)
+})
+```
+
+### query9+
+
+query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns?: Array<string>):Promise<ResultSetV9>
+
+Queries data from the RDB store based on specified conditions. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ |
+| table | string | Yes | Name of the target table. |
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Query conditions specified by the **DataSharePredicates** object. |
+| columns | Array<string> | No | Columns to query. If this parameter is not specified, the query applies to all columns.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------------------------- | -------------------------------------------------- |
+| Promise<[ResultSetV9](js-apis-data-resultset.md)> | Promise used to return the result. If the operation is successful, a **ResultSetV9** object will be returned.|
+
+**Example**
+
+```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("Failed to query data, err: " + err)
+})
+```
+
+### remoteQuery9+
+
+remoteQuery(device: string, table: string, predicates: RdbPredicatesV9, columns: Array<string> , callback: AsyncCallback<ResultSetV9>): void
+
+Queries data from the RDB store of a remote device based on specified conditions. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
+| device | string | Yes | Network ID of the remote device. |
+| table | string | Yes | Name of the target table. |
+| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | Query conditions specified by the **RdbPredicatesV9** object. |
+| columns | Array<string> | Yes | Columns to query. If this parameter is not specified, the query applies to all columns. |
+| callback | AsyncCallback<[ResultSetV9](js-apis-data-resultset.md#resultset)> | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSetV9** object will be returned.|
+
+**Example**
+
+```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)
+})
+```
+
+### remoteQuery9+
+
+remoteQuery(device: string, table: string, predicates: RdbPredicatesV9, columns: Array<string>): Promise<ResultSetV9>
+
+Queries data from the RDB store of a remote device based on specified conditions. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ------------------------------------------------ |
+| device | string | Yes | Network ID of the remote device. |
+| table | string | Yes | Name of the target table. |
+| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | Query conditions specified by the **RdbPredicatesV9** object. |
+| columns | Array<string> | Yes | Columns to query. If this parameter is not specified, the query applies to all columns.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------------------------------ | -------------------------------------------------- |
+| Promise<[ResultSetV9](js-apis-data-resultset.md#resultset)> | Promise used to return the result. If the operation is successful, a **ResultSetV9** object will be returned.|
+
+**Example**
+
+```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)
+})
+```
+
+### querySql9+
+
+querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<ResultSetV9>):void
+
+Queries data using the specified SQL statement. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
+| sql | string | Yes | SQL statement to run. |
+| bindArgs | Array<[ValueType](#valuetype)> | Yes | Arguments in the SQL statement. |
+| callback | AsyncCallback<[ResultSetV9](js-apis-data-resultset.md)> | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSetV9** object will be returned.|
+
+**Example**
+
+```js
+rdbStoreV9.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSetV9) {
+ if (err) {
+ console.info("Failed to query data, err: " + err)
+ return
+ }
+ console.log("ResultSet column names: " + resultSetV9.columnNames)
+ console.log("ResultSet column count: " + resultSetV9.columnCount)
+})
+```
+
+### querySql9+
+
+querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSetV9>
+
+Queries data using the specified SQL statement. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------ | ---- | --------------------- |
+| sql | string | Yes | SQL statement to run.|
+| bindArgs | Array<[ValueType](#valuetype)> | No | Arguments in the SQL statement. |
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------------------------- | -------------------------------------------------- |
+| Promise<[ResultSetV9](js-apis-data-resultset.md)> | Promise used to return the result. If the operation is successful, a **ResultSetV9** object will be returned.|
+
+**Example**
+
+```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("Failed to query data, err: " + err)
+})
+```
+
+### executeSql9+
+
+executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<void>):void
+
+Executes an SQL statement that contains specified arguments but returns no value. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------ | ---- | ---------------------- |
+| sql | string | Yes | SQL statement to run. |
+| bindArgs | Array<[ValueType](#valuetype)> | Yes | Arguments in the SQL statement. |
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result.|
+
+**Example**
+
+```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("Failed to execute SQL, err: " + err)
+ return
+ }
+ console.info('Created table successfully.')
+})
+```
+
+### executeSql9+
+
+executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void>
+
+Executes an SQL statement that contains specified arguments but returns no value. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------ | ---- | --------------------- |
+| sql | string | Yes | SQL statement to run.|
+| bindArgs | Array<[ValueType](#valuetype)> | No | Arguments in the SQL statement. |
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+```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('Created table successfully.')
+}).catch((err) => {
+ console.info("Failed to execute SQL, err: " + err)
+})
+```
+
+### beginTransaction9+
+
+beginTransaction():void
+
+Starts the transaction before executing an SQL statement.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Example**
+
+```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()
+})
+```
+
+### commit9+
+
+commit():void
+
+Commits the executed SQL statements.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Example**
+
+```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()
+})
+```
+
+### rollBack9+
+
+rollBack():void
+
+Rolls back the SQL statements that have been executed.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Example**
+
+```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()
+ }
+})
+```
+
+### backup9+
+
+backup(destName:string, callback: AsyncCallback<void>):void
+
+Backs up an RDB store. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ------------------------ |
+| destName | string | Yes | Name of the RDB store backup file.|
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
+
+**Example**
+
+```js
+rdbStoreV9.backup("dbBackup.db", function(err) {
+ if (err) {
+ console.info('Backup failed, err: ' + err)
+ return
+ }
+ console.info('Backup success.')
+})
+```
+
+### backup9+
+
+backup(destName:string): Promise<void>
+
+Backs up an RDB store. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------ | ---- | ------------------------ |
+| destName | string | Yes | Name of the RDB store backup file.|
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+```js
+let promiseBackup = rdbStoreV9.backup("dbBackup.db")
+promiseBackup.then(()=>{
+ console.info('Backup success.')
+}).catch((err)=>{
+ console.info('Backup failed, err: ' + err)
+})
+```
+
+### restore9+
+
+restore(srcName:string, callback: AsyncCallback<void>):void
+
+Restores an RDB store from a backup file. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ------------------------ |
+| srcName | string | Yes | Name of the RDB store backup file.|
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
+
+**Example**
+
+```js
+rdbStoreV9.restore("dbBackup.db", function(err) {
+ if (err) {
+ console.info('Restore failed, err: ' + err)
+ return
+ }
+ console.info('Restore success.')
+})
+```
+
+### restore9+
+
+restore(srcName:string): Promise<void>
+
+Restores an RDB store from a backup file. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | ------ | ---- | ------------------------ |
+| srcName | string | Yes | Name of the RDB store backup file.|
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+```js
+let promiseRestore = rdbStoreV9.restore("dbBackup.db")
+promiseRestore.then(()=>{
+ console.info('Restore success.')
+}).catch((err)=>{
+ console.info('Restore failed, err: ' + err)
+})
+```
+
+### setDistributedTables9+
+
+setDistributedTables(tables: Array<string>, callback: AsyncCallback<void>): void
+
+Sets distributed tables. This API uses an asynchronous callback to return the result.
+
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ---------------------- |
+| tables | Array<string> | Yes | Names of the distributed tables to set.|
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result.|
+
+**Example**
+
+```js
+rdbStoreV9.setDistributedTables(["EMPLOYEE"], function (err) {
+ if (err) {
+ console.info('Failed to set distributed tables, err: ' + err)
+ return
+ }
+ console.info('Set distributed tables successfully.')
+})
+```
+
+### setDistributedTables9+
+
+ setDistributedTables(tables: Array<string>): Promise<void>
+
+Sets distributed tables. This API uses a promise to return the result.
+
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------- | ---- | ------------------------ |
+| tables | Array<string> | Yes | Names of the distributed tables to set.|
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+```js
+let promise = rdbStoreV9.setDistributedTables(["EMPLOYEE"])
+promise.then(() => {
+ console.info("Set distributed tables successfully.")
+}).catch((err) => {
+ console.info("Failed to set distributed tables, err: " + err)
+})
+```
+
+### obtainDistributedTableName9+
+
+obtainDistributedTableName(device: string, table: string, callback: AsyncCallback<string>): void
+
+Obtains the distributed table name for a remote device based on the local table name. This API uses an asynchronous callback to return the result. The distributed table name is required when the RDB store of a remote device is queried.
-Obtains an RDB store. This API uses an asynchronous callback to return the result. You can set parameters for the RDB store based on service requirements and call APIs to perform data operations.
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ |
-| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
-| config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. |
-| version | number | Yes | RDB store version.
Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. |
-| callback | AsyncCallback<[RdbStore](#rdbstore)> | Yes | Callback invoked to return the RDB store obtained. |
+| Name | Type | Mandatory| Description |
+| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
+| device | string | Yes | Remote device. |
+| table | string | Yes | Local table name. |
+| callback | AsyncCallback<string> | Yes | Callback invoked to return the result. If the operation succeeds, the distributed table name of the remote device is returned.|
**Example**
-FA model:
-
```js
-// Obtain the context.
-import featureAbility from '@ohos.ability.featureAbility'
-let context = featureAbility.getContext()
-
-// Call getRdbStore.
-const STORE_CONFIG = { name: "RdbTest.db"}
-data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
+rdbStoreV9.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {
if (err) {
- console.info("Failed to get RdbStore, err: " + err)
+ console.info('Failed to obtain DistributedTableName, err: ' + err)
return
}
- console.log("Got RdbStore successfully.")
+ console.info('Obtained distributed table name successfully, tableName=.' + tableName)
})
```
-Stage model:
-
-```ts
-// Obtain the context.
-import UIAbility from '@ohos.app.ability.UIAbility';
-
-let context;
-class EntryAbility extends UIAbility {
- onWindowStageCreate(windowStage){
- context = this.context
- }
-}
-
-// Call getRdbStore.
-const STORE_CONFIG = { name: "RdbTest.db"}
-data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
- if (err) {
- console.info("Failed to get RdbStore, err: " + err)
- return
- }
- console.log("Got RdbStore successfully.")
-})
-```
+### obtainDistributedTableName9+
-## data_rdb.getRdbStore
+ obtainDistributedTableName(device: string, table: string): Promise<string>
-getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore>
+Obtains the distributed table name for a remote device based on the local table name. This API uses a promise to return the result. The distributed table name is required when the RDB store of a remote device is queried.
-Obtains an RDB store. This API uses a promise to return the result. You can set parameters for the RDB store based on service requirements and call APIs to perform data operations.
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
**Parameters**
-| Name | Type | Mandatory| Description |
-| ------- | --------------------------- | ---- | ------------------------------------------------------------ |
-| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
-| config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. |
-| version | number | Yes | RDB store version.
Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. |
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------- |
+| device | string | Yes | Remote device.|
+| table | string | Yes | Local table name.|
**Return value**
-| Type | Description |
-| ------------------------------------ | ------------------------------- |
-| Promise<[RdbStore](#rdbstore)> | Promise used to return the RDB store obtained.|
+| Type | Description |
+| --------------------- | ----------------------------------------------------- |
+| Promise<string> | Promise used to return the result. If the operation succeeds, the distributed table name of the remote device is returned.|
**Example**
-FA model:
-
```js
-// Obtain the context.
-import featureAbility from '@ohos.ability.featureAbility'
-let context = featureAbility.getContext()
-
-// Call getRdbStore.
-const STORE_CONFIG = { name: "RdbTest.db" }
-let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1);
-promise.then(async (rdbStore) => {
- console.log("Got RdbStore successfully.")
+let promise = rdbStoreV9.obtainDistributedTableName("12345678abcde", "EMPLOYEE")
+promise.then((tableName) => {
+ console.info('Obtained distributed table name successfully, tableName= ' + tableName)
}).catch((err) => {
- console.log("Failed to get RdbStore, err: " + err)
+ console.info('Failed to obtain DistributedTableName, err: ' + err)
})
```
-Stage model:
-
-```ts
-// Obtain the context.
-import UIAbility from '@ohos.app.ability.UIAbility';
-
-let context;
-class EntryAbility extends UIAbility {
- onWindowStageCreate(windowStage){
- context = this.context
- }
-}
-
-// Call getRdbStore.
-const STORE_CONFIG = { name: "RdbTest.db" }
-let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1);
-promise.then(async (rdbStore) => {
- console.log("Got RdbStore successfully.")
-}).catch((err) => {
- console.log("Failed to get RdbStore, err: " + err)
-})
-```
+### sync9+
-## data_rdb.deleteRdbStore
+sync(mode: SyncMode, predicates: RdbPredicatesV9, callback: AsyncCallback<Array<[string, number]>>): void
-deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void
+Synchronizes data between devices. This API uses an asynchronous callback to return the result.
-Deletes an RDB store. This API uses an asynchronous callback to return the result.
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
-| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
-| name | string | Yes | Name of the RDB store to delete. |
-| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
+| Name | Type | Mandatory| Description |
+| ---------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ |
+| mode | [SyncMode](#syncmode8) | Yes | Data synchronization mode. The value can be **push** or **pull**. |
+| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | **RdbPredicates** object that specifies the data and devices to synchronize. |
+| callback | AsyncCallback<Array<[string, number]>> | Yes | Callback invoked to send the synchronization result to the caller.
**string** indicates the device ID.
**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. |
**Example**
-FA model:
-
```js
-// Obtain the context.
-import featureAbility from '@ohos.ability.featureAbility'
-let context = featureAbility.getContext()
-
-// Call deleteRdbStore.
-data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
+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.info("Failed to delete RdbStore, err: " + err)
+ console.log('Sync failed, err: ' + err)
return
}
- console.log("Deleted RdbStore successfully.")
+ console.log('Sync done.')
+ for (let i = 0; i < result.length; i++) {
+ console.log('device=' + result[i][0] + ' status=' + result[i][1])
+ }
})
```
-Stage model:
+### sync9+
-```ts
-// Obtain the context.
-import UIAbility from '@ohos.app.ability.UIAbility';
+ sync(mode: SyncMode, predicates: RdbPredicatesV9): Promise<Array<[string, number]>>
-let context;
-class EntryAbility extends UIAbility {
- onWindowStageCreate(windowStage){
- context = this.context
- }
-}
+Synchronizes data between devices. This API uses a promise to return the result.
-// Call deleteRdbStore.
-data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
- if (err) {
- console.info("Failed to delete RdbStore, err: " + err)
- return
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ------------------------------ |
+| mode | [SyncMode](#syncmode8) | Yes | Data synchronization mode. The value can be **push** or **pull**.|
+| predicates | [RdbPredicatesV9](#rdbpredicatesv99) | Yes | **RdbPredicates** object that specifies the data and devices to synchronize. |
+
+**Return value**
+
+| Type | Description |
+| -------------------------------------------- | ------------------------------------------------------------ |
+| Promise<Array<[string, number]>> | Promise used to send the synchronization result.
**string** indicates the device ID.
**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. |
+
+**Example**
+
+```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])
}
- console.log("Deleted RdbStore successfully.")
+}).catch((err) => {
+ console.log('Sync failed')
})
```
-## data_rdb.deleteRdbStore
+### on('dataChange')9+
-deleteRdbStore(context: Context, name: string): Promise<void>
+on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void
-Deletes an RDB store. This API uses a promise to return the result.
+Registers an observer for this RDB store. When the data in the RDB store changes, a callback is invoked to return the data changes.
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
**Parameters**
-| Name | Type | Mandatory| Description |
-| ------- | ------- | ---- | ------------------------------------------------------------ |
-| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
-| name | string | Yes | Name of the RDB store to delete. |
+| Name | Type | Mandatory| Description |
+| -------- | ----------------------------------- | ---- | ------------------------------------------- |
+| event | string | Yes | The value is'dataChange', which indicates a data change event. |
+| type | [SubscribeType](#subscribetype8) | Yes| Subscription type to register.|
+| observer | Callback<Array<string>> | Yes | Observer that listens for the data changes in the RDB store. |
-**Return value**
+**Example**
-| Type | Description |
-| ------------------- | ------------------------- |
-| Promise<void> | Promise that returns no value.|
+```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('Failed to register observer')
+}
+```
-**Example**
+### off('dataChange')9+
-FA model:
+off(event:'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void
-```js
-// Obtain the context.
-import featureAbility from '@ohos.ability.featureAbility'
-let context = featureAbility.getContext()
+Unregisters the observer of the specified type from the RDB store. This API uses a callback to return the result.
-// Call deleteRdbStore.
-let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
-promise.then(() => {
- console.log("Deleted RdbStore successfully.")
-}).catch((err) => {
- console.info("Failed to delete RdbStore, err: " + err)
-})
-```
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
-Stage model:
+**Parameters**
-```ts
-// Obtain the context.
-import UIAbility from '@ohos.app.ability.UIAbility';
+| Name | Type | Mandatory| Description |
+| -------- | ----------------------------------- | ---- | ------------------------------------------- |
+| event | string | Yes | The value is'dataChange', which indicates a data change event. |
+| type | [SubscribeType](#subscribetype8) | Yes| Subscription type to unregister.|
+| observer | Callback<Array<string>> | Yes | Data change observer registered. |
-let context;
-class EntryAbility extends UIAbility {
- onWindowStageCreate(windowStage){
- context = this.context
+**Example**
+
+```js
+function storeObserver(devices) {
+ for (let i = 0; i < devices.length; i++) {
+ console.log('device=' + devices[i] + ' data changed')
}
}
-
-// Call deleteRdbStore.
-let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
-promise.then(()=>{
- console.log("Deleted RdbStore successfully.")
-}).catch((err) => {
- console.info("Failed to delete RdbStore, err: " + err)
-})
+try {
+ rdbStoreV9.off('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
+} catch (err) {
+ console.log('Failed to unregister observer')
+}
```
+## StoreConfigV99+
+
+Defines the RDB store configuration.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Name | Type | Mandatory| Description |
+| ------------- | ------------- | ---- | --------------------------------------------------------- |
+| name | string | Yes | Database file name. |
+| securityLevel | SecurityLevel | Yes | Security level of the RDB store. |
+| encrypt | boolean | No | Whether to encrypt the RDB store.
The value **true** means to encrypt the RDB store;
the value **false** means the opposite.|
+
+## SecurityLevel9+
+
+Enumerates the RDB store security levels.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Name| Value | Description |
+| ---- | ---- | ------------------------------------------------------------ |
+| S1 | 1 | The RDB store security level is low. If data leakage occurs, minor impact will be caused on the database. For example, an RDB store that contains system data such as wallpapers.|
+| S2 | 2 | The RDB store security level is medium. If data leakage occurs, moderate impact will be caused on the database. For example, an RDB store that contains information created by users or call records, such as audio or video clips.|
+| S3 | 3 | The RDB store security level is high. If data leakage occurs, major impact will be caused on the database. For example, an RDB store that contains information such as user fitness, health, and location data.|
+| S4 | 4 | The RDB store security level is critical. If data leakage occurs, severe impact will be caused on the database. For example, an RDB store that contains information such as authentication credentials and financial data.|
+
## ValueType
Defines the data types allowed.
@@ -301,24 +2711,12 @@ Defines the database synchronization mode.
Defines the subscription type.
-**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
-
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
| Name | Value | Description |
| --------------------- | ---- | ------------------ |
| SUBSCRIBE_TYPE_REMOTE | 0 | Subscribe to remote data changes.|
-## StoreConfig
-
-Defines the RDB store configuration.
-
-**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
-
-| Name| Type| Mandatory| Description|
-| -------- | -------- | -------- | -------- |
-| name | string | Yes| Database file name.|
-
## RdbPredicates
Defines predicates for an RDB store. This class determines whether the conditional expression for the RDB store is true or false.
@@ -1154,7 +3552,7 @@ predicates.notIn("NAME", ["Lisa", "Rose"])
Provides methods to manage an RDB store.
-Before using the following APIs, use [executeSql](#executesql8) to initialize the database table structure and related data. For details, see [RDB Development](../../database/database-relational-guidelines.md).
+Before using the following APIs, use [executeSql](#executesql) to initialize the database table structure and related data. For details, see [RDB Development](../../database/database-relational-guidelines.md).
### insert
@@ -1269,10 +3667,10 @@ const valueBucket3 = {
let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
rdbStore.batchInsert("EMPLOYEE", valueBuckets, function(status, insertNum) {
if (status) {
- console.log("Failed to batch insert data, status = " + status);
+ console.log("batchInsert is failed, status = " + status);
return;
}
- console.log("Batch inserted data successfully. The number of values that were inserted = " + insertNum);
+ console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
})
```
@@ -1322,9 +3720,9 @@ const valueBucket3 = {
let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
let promise = rdbStore.batchInsert("EMPLOYEE", valueBuckets);
promise.then((insertNum) => {
- console.log("Batch inserted data successfully. The number of values that were inserted = " + insertNum);
+ console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
}).catch((status) => {
- console.log("Failed to batch insert data, status = " + status);
+ console.log("batchInsert is failed, status = " + status);
})
```
@@ -1340,7 +3738,7 @@ Updates data in the RDB store based on the specified **RdbPredicates** object. T
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| values | [ValuesBucket](#valuesbucket) | Yes| Data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| values | [ValuesBucket](#valuesbucket) | Yes| Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
| predicates | [RdbPredicates](#rdbpredicates) | Yes| Update conditions specified by the **RdbPredicates** object.|
| callback | AsyncCallback<number> | Yes| Callback invoked to return the number of rows updated.|
@@ -1355,12 +3753,12 @@ const valueBucket = {
}
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
-rdbStore.update(valueBucket, predicates, function (err, rows) {
+rdbStore.update(valueBucket, predicates, function (err, ret) {
if (err) {
console.info("Failed to update data, err: " + err)
return
}
- console.log("Updated row count: " + rows)
+ console.log("Updated row count: " + ret)
})
```
@@ -1376,7 +3774,7 @@ Updates data based on the specified **RdbPredicates** object. This API uses a pr
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| values | [ValuesBucket](#valuesbucket) | Yes| Data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| values | [ValuesBucket](#valuesbucket) | Yes| Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
| predicates | [RdbPredicates](#rdbpredicates) | Yes| Update conditions specified by the **RdbPredicates** object.|
**Return value**
@@ -1397,8 +3795,8 @@ const valueBucket = {
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)
+promise.then(async (ret) => {
+ console.log("Updated row count: " + ret)
}).catch((err) => {
console.info("Failed to update data, err: " + err)
})
@@ -1417,7 +3815,7 @@ Deletes data from the RDB store based on the specified **RdbPredicates** object.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| predicates | [RdbPredicates](#rdbpredicates) | Yes| Conditions specified by the **RdbPredicates** object for deleting data.|
-| callback | AsyncCallback<number> | Yes| Callback invoked to return the number of rows updated.|
+| callback | AsyncCallback<number> | Yes| Callback invoked to return the number of rows deleted.|
**Example**
@@ -1451,7 +3849,7 @@ Deletes data from the RDB store based on the specified **RdbPredicates** object.
| Type| Description|
| -------- | -------- |
-| Promise<number> | Promise used to return the number of rows updated.|
+| Promise<number> | Promise used to return the number of rows deleted.|
**Example**
@@ -1536,7 +3934,7 @@ Queries data from the RDB store based on specified conditions. This API uses a p
querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<ResultSet>):void
-Queries data in the RDB store using the specified SQL statement. This API uses an asynchronous callback to return the result.
+Queries data using the specified SQL statement. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
@@ -1565,7 +3963,7 @@ rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?",
querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet>
-Queries data in the RDB store using the specified SQL statement. This API uses a promise to return the result.
+Queries data using the specified SQL statement. This API uses a promise to return the result.
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
@@ -1619,7 +4017,7 @@ rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) {
console.info("Failed to execute SQL, err: " + err)
return
}
- console.info('Created table successfully.')
+ console.info('Create table done.')
})
```
@@ -1650,7 +4048,7 @@ Executes an SQL statement that contains specified arguments but returns no value
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('Created table successfully.')
+ console.info('Create table done.')
}).catch((err) => {
console.info("Failed to execute SQL, err: " + err)
})
@@ -1924,7 +4322,7 @@ Synchronizes data between devices. This API uses a promise to return the result.
| Type| Description|
| -------- | -------- |
-| Promise<Array<[string, number]>> | Promise used to return the synchronization result to the caller.
**string** indicates the device ID.
**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. |
+| Promise<Array<[string, number]>> | Promise used to send the synchronization result.
**string** indicates the device ID.
**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. |
**Example**
@@ -1954,8 +4352,8 @@ Registers an observer for this RDB store. When the data in the RDB store changes
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| event | string | Yes| The value is'dataChange', which indicates a data change event.|
-| type | [SubscribeType](#subscribetype8) | Yes| Subscription type to register.|
+| event | string | Yes| The value is **dataChange**, which indicates a data change event.|
+| type | [SubscribeType](#subscribetype8) | Yes| Type defined in **SubscribeType**.|
| observer | Callback<Array<string>> | Yes| Observer that listens for the data changes in the RDB store.|
**Example**
@@ -1977,7 +4375,7 @@ try {
off(event:'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void
-Unregisters the observer of the specified type from the RDB store. This API uses a callback to return the result.
+Unregisters the observer of the specified type from the RDB store. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
@@ -1986,7 +4384,7 @@ Unregisters the observer of the specified type from the RDB store. This API uses
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| event | string | Yes| The value is'dataChange', which indicates a data change event.|
-| type | [SubscribeType](#subscribetype8) | Yes| Subscription type to unregister.|
+| type | [SubscribeType](#subscribetype8) | Yes| Type defined in **SubscribeType**.|
| observer | Callback<Array<string>> | Yes| Data change observer registered.|
**Example**
@@ -2003,3 +4401,13 @@ try {
console.log('Failed to unregister observer')
}
```
+
+## StoreConfig
+
+Defines the RDB store configuration.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+| name | string | Yes| Database file name.|
diff --git a/en/application-dev/reference/apis/js-apis-data-relationalStore.md b/en/application-dev/reference/apis/js-apis-data-relationalStore.md
new file mode 100644
index 0000000000000000000000000000000000000000..e832a479eb802d914d1ff0e818e09a61f2c5b58a
--- /dev/null
+++ b/en/application-dev/reference/apis/js-apis-data-relationalStore.md
@@ -0,0 +1,3009 @@
+# @ohos.data.relationalStore (RDB Store)
+
+The relational database (RDB) store manages data based on relational models. With the underlying SQLite database, the RDB store provides a complete mechanism for managing local databases. To satisfy different needs in complicated scenarios, the RDB store offers a series of APIs for performing operations such as adding, deleting, modifying, and querying data, and supports direct execution of SQL statements.
+
+The **relationalStore** module provides the following functions:
+
+- [RdbPredicates](#rdbpredicates): provides predicates indicating the nature, feature, or relationship of a data entity in an RDB store. It is used to define the operation conditions for an RDB store.
+- [RdbStore](#rdbstore): provides APIs for managing data in an RDB store.
+- [Resultset](#resultset): provides APIs for accessing the result set obtained from the RDB store.
+
+> **NOTE**
+>
+> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
+
+## Modules to Import
+
+```js
+import data_rdb from '@ohos.data.relationalStore';
+```
+
+## data_rdb.getRdbStore
+
+getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback<RdbStore>): void
+
+Obtains an RDB store. This API uses an asynchronous callback to return the result. You can set parameters for the RDB store based on service requirements and call APIs to perform data operations.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. |
+| callback | AsyncCallback<[RdbStore](#rdbstore)> | Yes | Callback invoked to return the RDB store obtained. |
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ----------------------- |
+| 14800010 | If failed delete database by invalid database name. |
+| 14800011 | If failed open database by database corrupted. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call 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("Failed to get RdbStore, err: " + err)
+ return
+ }
+ console.log("Got RdbStore successfully.")
+})
+```
+
+Stage model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call 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("Failed to get RdbStore, err: " + err)
+ return
+ }
+ console.log("Got RdbStore successfully.")
+})
+```
+
+## data_rdb.getRdbStore
+
+getRdbStore(context: Context, config: StoreConfig): Promise<RdbStore>
+
+Obtains an RDB store. This API uses a promise to return the result. You can set parameters for the RDB store based on service requirements and call APIs to perform data operations.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | -------------------------------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. |
+
+**Return value**
+
+| Type | Description |
+| ----------------------------------------- | --------------------------------- |
+| Promise<[RdbStore](#rdbstore)> | Promise used to return the **RdbStore** object.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ----------------------- |
+| 14800010 | If failed delete database by invalid database name. |
+| 14800011 | If failed open database by database corrupted. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call getRdbStore.
+const STORE_CONFIG = {
+ name: "RdbTest.db",
+ securityLevel: data_rdb.SecurityLevel.S1
+}
+let promise = data_rdb.getRdbStore(context, STORE_CONFIG);
+promise.then(async (rdbStore) => {
+ console.log("Got RdbStore successfully.")
+}).catch((err) => {
+ console.log("Failed to get RdbStore, err: " + err)
+})
+```
+
+Stage model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call getRdbStore.
+const STORE_CONFIG = {
+ name: "RdbTest.db",
+ securityLevel: data_rdb.SecurityLevel.S1
+}
+let promise = data_rdb.getRdbStore(context, STORE_CONFIG);
+promise.then(async (rdbStore) => {
+ console.log("Got RdbStore successfully.")
+}).catch((err) => {
+ console.log("Failed to get RdbStore, err: " + err)
+})
+```
+
+## data_rdb.deleteRdbStore
+
+deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void
+
+Deletes an RDB store. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| name | string | Yes | Name of the RDB store to delete. |
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ----------------------- |
+| 14800010 | If failed delete database by invalid database name. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call deleteRdbStore.
+data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
+ if (err) {
+ console.info("Failed to delete RdbStore, err: " + err)
+ return
+ }
+ console.log("Deleted RdbStore successfully.")
+})
+```
+
+Stage model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call deleteRdbStore.
+data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
+ if (err) {
+ console.info("Failed to delete RdbStore, err: " + err)
+ return
+ }
+ console.log("Deleted RdbStore successfully.")
+})
+```
+
+## data_rdb.deleteRdbStore
+
+deleteRdbStore(context: Context, name: string): Promise<void>
+
+Deletes an RDB store. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | ------- | ---- | ------------------------------------------------------------ |
+| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).|
+| name | string | Yes | Name of the RDB store to delete. |
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ----------------------- |
+| 14800010 | If failed delete database by invalid database name. |
+
+**Example**
+
+FA model:
+
+```js
+// Obtain the context.
+import featureAbility from '@ohos.ability.featureAbility'
+let context = featureAbility.getContext()
+
+// Call deleteRdbStore.
+let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
+promise.then(()=>{
+ console.log("Deleted RdbStore successfully.")
+}).catch((err) => {
+ console.info("Failed to delete RdbStore, err: " + err)
+})
+```
+
+Stage model:
+
+```ts
+// Obtain the context.
+import Ability from '@ohos.application.Ability'
+let context
+class MainAbility extends Ability{
+ onWindowStageCreate(windowStage){
+ context = this.context
+ }
+}
+
+// Call deleteRdbStore.
+let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
+promise.then(()=>{
+ console.log("Deleted RdbStore successfully.")
+}).catch((err) => {
+ console.info("Failed to delete RdbStore, err: " + err)
+})
+```
+
+## StoreConfig
+
+Defines the RDB store configuration.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Name | Type | Mandatory| Description |
+| ------------- | ------------- | ---- | --------------------------------------------------------- |
+| name | string | Yes | Database file name. |
+| securityLevel | [SecurityLevel](#securitylevel) | Yes | Security level of the RDB store. |
+| encrypt | boolean | No | Whether to encrypt the RDB store.
The value **true** means to encrypt the RDB store;
the value **false** means the opposite.|
+
+## SecurityLevel
+
+Enumerates the RDB store security levels.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Name| Value | Description |
+| ---- | ---- | ------------------------------------------------------------ |
+| S1 | 1 | The RDB store security level is low. If data leakage occurs, minor impact will be caused on the database. For example, an RDB store that contains system data such as wallpapers.|
+| S2 | 2 | The RDB store security level is medium. If data leakage occurs, moderate impact will be caused on the database. For example, an RDB store that contains information created by users or call records, such as audio or video clips.|
+| S3 | 3 | The RDB store security level is high. If data leakage occurs, major impact will be caused on the database. For example, an RDB store that contains information such as user fitness, health, and location data.|
+| S4 | 4 | The RDB store security level is critical. If data leakage occurs, severe impact will be caused on the database. For example, an RDB store that contains information such as authentication credentials and financial data.|
+
+## ValueType
+
+Defines the data types allowed.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Type | Description |
+| ------- | -------------------- |
+| number | Number. |
+| string | String. |
+| boolean | Boolean.|
+
+## ValuesBucket
+
+Defines the types of the key and value in a KV pair.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Key Type| Value Type |
+| ------ | ----------------------------------------------------------- |
+| string | [ValueType](#valuetype)\| Uint8Array \| null |
+
+## SyncMode
+
+Defines the database synchronization mode.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Name | Value | Description |
+| -------------- | ---- | ---------------------------------- |
+| SYNC_MODE_PUSH | 0 | Data is pushed from a local device to a remote device.|
+| SYNC_MODE_PULL | 1 | Data is pulled from a remote device to a local device. |
+
+## SubscribeType
+
+Defines the subscription type.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Name | Value | Description |
+| --------------------- | ---- | ------------------ |
+| SUBSCRIBE_TYPE_REMOTE | 0 | Subscribe to remote data changes.|
+
+## RdbPredicates
+
+Defines the predicates for an RDB store. This class determines whether the conditional expression for the RDB store is true or false.
+
+### constructor
+
+constructor(name: string)
+
+A constructor used to create an **RdbPredicates** object.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------ |
+| name | string | Yes | Database table name.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+```
+
+### inDevices
+
+inDevices(devices: Array<string>): RdbPredicates
+
+
+Sets an **RdbPredicates** to specify the remote devices to connect on the network during distributed database synchronization.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | ------------------- | ---- | -------------------------- |
+| devices | Array<string> | Yes | IDs of the remote devices in the same network.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.inDevices(['12345678abcde'])
+```
+
+### inAllDevices
+
+inAllDevices(): RdbPredicates
+
+
+Sets an **RdbPredicates** to specify all remote devices on the network to connect during distributed database synchronization.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.inAllDevices()
+```
+
+### equalTo
+
+equalTo(field: string, value: ValueType): RdbPredicates
+
+
+Sets an **RdbPredicates** to match the field with data type **ValueType** and value equal to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.equalTo("NAME", "lisi")
+```
+
+
+### notEqualTo
+
+notEqualTo(field: string, value: ValueType): RdbPredicates
+
+
+Sets an **RdbPredicates** to match the field with data type **ValueType** and value not equal to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.notEqualTo("NAME", "lisi")
+```
+
+
+### beginWrap
+
+beginWrap(): RdbPredicates
+
+
+Adds a left parenthesis to the **RdbPredicates**.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** with a left parenthesis.|
+
+**Example**
+
+```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
+
+Adds a right parenthesis to the **RdbPredicates**.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** with a right parenthesis.|
+
+**Example**
+
+```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
+
+Adds the OR condition to the **RdbPredicates**.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** with the OR condition.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.equalTo("NAME", "Lisa")
+ .or()
+ .equalTo("NAME", "Rose")
+```
+
+### and
+
+and(): RdbPredicates
+
+Adds the AND condition to the **RdbPredicates**.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** with the AND condition.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.equalTo("NAME", "Lisa")
+ .and()
+ .equalTo("SALARY", 200.5)
+```
+
+### contains
+
+contains(field: string, value: string): RdbPredicates
+
+Sets an **RdbPredicates** to match a string containing the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.contains("NAME", "os")
+```
+
+### beginsWith
+
+beginsWith(field: string, value: string): RdbPredicates
+
+Sets an **RdbPredicates** to match a string that starts with the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.beginsWith("NAME", "os")
+```
+
+### endsWith
+
+endsWith(field: string, value: string): RdbPredicates
+
+Sets an **RdbPredicates** to match a string that ends with the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.endsWith("NAME", "se")
+```
+
+### isNull
+
+isNull(field: string): RdbPredicates
+
+Sets an **RdbPredicates** to match the field whose value is null.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------ |
+| field | string | Yes | Column name in the database table.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.isNull("NAME")
+```
+
+### isNotNull
+
+isNotNull(field: string): RdbPredicates
+
+Sets an **RdbPredicates** to match the field whose value is not null.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------ |
+| field | string | Yes | Column name in the database table.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.isNotNull("NAME")
+```
+
+### like
+
+like(field: string, value: string): RdbPredicates
+
+Sets an **RdbPredicates** to match a string that is similar to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.like("NAME", "%os%")
+```
+
+### glob
+
+glob(field: string, value: string): RdbPredicates
+
+Sets an **RdbPredicates** to match the specified string.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------------------------------------------------ |
+| field | string | Yes | Column name in the database table. |
+| value | string | Yes | Value to match the **RdbPredicates**.
Wildcards are supported. * indicates zero, one, or multiple digits or characters. **?** indicates a single digit or character.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.glob("NAME", "?h*g")
+```
+
+### between
+
+between(field: string, low: ValueType, high: ValueType): RdbPredicates
+
+Sets an **RdbPredicates** to match the field with data type **ValueType** and value within the specified range.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | -------------------------- |
+| field | string | Yes | Column name in the database table. |
+| low | [ValueType](#valuetype) | Yes | Minimum value to match the **RdbPredicates**. |
+| high | [ValueType](#valuetype) | Yes | Maximum value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.between("AGE", 10, 50)
+```
+
+### notBetween
+
+notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates
+
+Sets an **RdbPredicates** to match the field with data type **ValueType** and value out of the specified range.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | -------------------------- |
+| field | string | Yes | Column name in the database table. |
+| low | [ValueType](#valuetype) | Yes | Minimum value to match the **RdbPredicates**. |
+| high | [ValueType](#valuetype) | Yes | Maximum value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.notBetween("AGE", 10, 50)
+```
+
+### greaterThan
+
+greaterThan(field: string, value: ValueType): RdbPredicates
+
+Sets an **RdbPredicates** to match the field with data type **ValueType** and value greater than the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.greaterThan("AGE", 18)
+```
+
+### lessThan
+
+lessThan(field: string, value: ValueType): RdbPredicates
+
+Sets an **RdbPredicates** to match the field with data type **ValueType** and value less than the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.lessThan("AGE", 20)
+```
+
+### greaterThanOrEqualTo
+
+greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates
+
+Sets an **RdbPredicates** to match the field with data type **ValueType** and value greater than or equal to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.greaterThanOrEqualTo("AGE", 18)
+```
+
+### lessThanOrEqualTo
+
+lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates
+
+Sets an **RdbPredicates** to match the field with data type **ValueType** and value less than or equal to the specified value.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------- | ---- | ---------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | [ValueType](#valuetype) | Yes | Value to match the **RdbPredicates**.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.lessThanOrEqualTo("AGE", 20)
+```
+
+### orderByAsc
+
+orderByAsc(field: string): RdbPredicates
+
+Sets an **RdbPredicates** to match the column with values sorted in ascending order.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------ |
+| field | string | Yes | Column name in the database table.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.orderByAsc("NAME")
+```
+
+### orderByDesc
+
+orderByDesc(field: string): RdbPredicates
+
+Sets an **RdbPredicates** to match the column with values sorted in descending order.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ------------------ |
+| field | string | Yes | Column name in the database table.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.orderByDesc("AGE")
+```
+
+### distinct
+
+distinct(): RdbPredicates
+
+Sets an **RdbPredicates** to filter out duplicate records.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------------ |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that can filter out duplicate records.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.equalTo("NAME", "Rose").distinct()
+```
+
+### limitAs
+
+limitAs(value: number): RdbPredicates
+
+Sets an **RdbPredicates** to specify the maximum number of records.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------- |
+| value | number | Yes | Maximum number of records.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------------------ |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that specifies the maximum number of records.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.equalTo("NAME", "Rose").limitAs(3)
+```
+
+### offsetAs
+
+offsetAs(rowOffset: number): RdbPredicates
+
+Sets an **RdbPredicates** to specify the start position of the returned result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| --------- | ------ | ---- | ---------------------------------- |
+| rowOffset | number | Yes | Number of rows to offset from the beginning. The value is a positive integer.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ------------------------------------ |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that specifies the start position of the returned result.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.equalTo("NAME", "Rose").offsetAs(3)
+```
+
+### groupBy
+
+groupBy(fields: Array<string>): RdbPredicates
+
+Sets an **RdbPredicates** to group rows that have the same value into summary rows.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------- | ---- | -------------------- |
+| fields | Array<string> | Yes | Names of columns to group.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | ---------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that groups rows with the same value.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.groupBy(["AGE", "NAME"])
+```
+
+### indexedBy
+
+indexedBy(field: string): RdbPredicates
+
+Sets an **RdbPredicates** object to specify the index column.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | -------------- |
+| field | string | Yes | Name of the index column.|
+
+**Return value**
+
+
+| Type | Description |
+| ------------------------------------ | ------------------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that specifies the index column.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.indexedBy("SALARY_INDEX")
+```
+
+### in
+
+in(field: string, value: Array<ValueType>): RdbPredicates
+
+Sets an **RdbPredicates** to match the field with data type **Array<ValueType>** and value within the specified range.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------------------------ | ---- | --------------------------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | Array<[ValueType](#valuetype)> | Yes | Array of **ValueType**s to match.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.in("AGE", [18, 20])
+```
+
+### notIn
+
+notIn(field: string, value: Array<ValueType>): RdbPredicates
+
+Sets an **RdbPredicates** to match the field with data type **Array<ValueType>** and value out of the specified range.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------------------------ | ---- | ------------------------------------- |
+| field | string | Yes | Column name in the database table. |
+| value | Array<[ValueType](#valuetype)> | Yes | Array of **ValueType**s to match.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------ | -------------------------- |
+| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.|
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.notIn("NAME", ["Lisa", "Rose"])
+```
+
+## RdbStore
+
+Provides methods to manage an RDB store.
+
+Before using the following APIs, use [executeSql](#executesql) to initialize the database table structure and related data. For details, see [RDB Development](../../database/database-relational-guidelines.md).
+
+### insert
+
+insert(table: string, values: ValuesBucket, callback: AsyncCallback<number>):void
+
+Inserts a row of data into a table. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ----------------------------- | ---- | ---------------------------------------------------------- |
+| table | string | Yes | Name of the target table. |
+| values | [ValuesBucket](#valuesbucket) | Yes | Row of data to insert. |
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the result. If the operation is successful, the row ID will be returned. Otherwise, **-1** will be returned.|
+
+**Example**
+
+```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("Failed to insert data");
+ return;
+ }
+ console.log("Inserted data successfully, rowId = " + rowId);
+})
+```
+### insert
+
+insert(table: string, values: ValuesBucket):Promise<number>
+
+Inserts a row of data into a table. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------------- | ---- | -------------------------- |
+| table | string | Yes | Name of the target table. |
+| values | [ValuesBucket](#valuesbucket) | Yes | Row of data to insert.|
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ------------------------------------------------- |
+| Promise<number> | Promise used to return the result. If the operation is successful, the row ID will be returned. Otherwise, **-1** will be returned.|
+
+**Example**
+
+```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("Inserted data successfully, rowId = " + rowId);
+}).catch((status) => {
+ console.log("Failed to insert data");
+})
+```
+
+### batchInsert
+
+batchInsert(table: string, values: Array<ValuesBucket>, callback: AsyncCallback<number>):void
+
+Batch inserts data into a table. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ |
+| table | string | Yes | Name of the target table. |
+| values | Array<[ValuesBucket](#valuesbucket)> | Yes | An array of data to insert. |
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the result. If the operation is successful, the number of inserted data records is returned. Otherwise, **-1** is returned.|
+
+**Example**
+
+```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<ValuesBucket>):Promise<number>
+
+Batch inserts data into a table. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------------------------------ | ---- | ---------------------------- |
+| table | string | Yes | Name of the target table. |
+| values | Array<[ValuesBucket](#valuesbucket)> | Yes | An array of data to insert.|
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ----------------------------------------------------------- |
+| Promise<number> | Promise used to return the result. If the operation is successful, the number of inserted data records is returned. Otherwise, **-1** is returned.|
+
+**Example**
+
+```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<number>):void
+
+Updates data in the RDB store based on the specified **RdbPredicates** object. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
+| values | [ValuesBucket](#valuesbucket) | Yes | Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | Update conditions specified by the **RdbPredicates** object. |
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the number of rows updated. |
+
+**Example**
+
+```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("Failed to update data, err: " + err)
+ return
+ }
+ console.log("Updated row count: " + rows)
+})
+```
+
+### update
+
+update(values: ValuesBucket, predicates: RdbPredicates):Promise<number>
+
+Updates data based on the specified **RdbPredicates** object. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------------ | ------------------------------------ | ---- | ------------------------------------------------------------ |
+| values | [ValuesBucket](#valuesbucket) | Yes | Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | Update conditions specified by the **RdbPredicates** object. |
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ----------------------------------------- |
+| Promise<number> | Promise used to return the number of rows updated.|
+
+**Example**
+
+```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("Failed to update data, err: " + err)
+})
+```
+
+### update
+
+update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>):void
+
+Updates data based on the specified **DataSharePredicates** object. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
+| table | string | Yes | Name of the target table. |
+| values | [ValuesBucket](#valuesbucket) | Yes | Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Update conditions specified by the **DataSharePredicates** object. |
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the number of rows updated. |
+
+**Example**
+
+```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("Failed to update data, err: " + err)
+ return
+ }
+ console.log("Updated row count: " + rows)
+})
+```
+
+### update
+
+update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates):Promise<number>
+
+Updates data based on the specified **DataSharePredicates** object. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
+| table | string | Yes | Name of the target table. |
+| values | [ValuesBucket](#valuesbucket) | Yes | Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Update conditions specified by the **DataSharePredicates** object. |
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ----------------------------------------- |
+| Promise<number> | Promise used to return the number of rows updated.|
+
+**Example**
+
+```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("Failed to update data, err: " + err)
+})
+```
+
+### delete
+
+delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void
+
+Deletes data from the RDB store based on the specified **RdbPredicates** object. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ----------------------------------------- |
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | Conditions specified by the **RdbPredicates** object for deleting data.|
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the number of rows deleted. |
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.equalTo("NAME", "Lisa")
+rdbStore.delete(predicates, function (err, rows) {
+ if (err) {
+ console.info("Failed to delete data, err: " + err)
+ return
+ }
+ console.log("Deleted rows: " + rows)
+})
+```
+
+### delete
+
+delete(predicates: RdbPredicates):Promise<number>
+
+Deletes data from the RDB store based on the specified **RdbPredicates** object. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ----------------------------------------- |
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | Conditions specified by the **RdbPredicates** object for deleting data.|
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ------------------------------- |
+| Promise<number> | Promise used to return the number of rows deleted. |
+
+**Example**
+
+```js
+let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
+predicates.equalTo("NAME", "Lisa")
+let promise = rdbStore.delete(predicates)
+promise.then((rows) => {
+ console.log("Deleted rows: " + rows)
+}).catch((err) => {
+ console.info("Failed to delete data, err: " + err)
+})
+```
+
+### delete
+
+delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>):void
+
+Deletes data from the RDB store based on the specified **DataSharePredicates** object. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
+| table | string | Yes | Name of the target table. |
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Conditions specified by the **DataSharePredicates** object for deleting data.|
+| callback | AsyncCallback<number> | Yes | Callback invoked to return the number of rows deleted. |
+
+**Example**
+
+```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("Failed to delete data, err: " + err)
+ return
+ }
+ console.log("Deleted rows: " + rows)
+})
+```
+
+### delete
+
+delete(table: string, predicates: dataSharePredicates.DataSharePredicates):Promise<number>
+
+Deletes data from the RDB store based on the specified **DataSharePredicates** object. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
+| table | string | Yes | Name of the target table. |
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Conditions specified by the **DataSharePredicates** object for deleting data.|
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ------------------------------- |
+| Promise<number> | Promise used to return the number of rows deleted.|
+
+**Example**
+
+```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("Deleted rows: " + rows)
+}).catch((err) => {
+ console.info("Failed to delete data, err: " + err)
+})
+```
+
+### query
+
+query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>):void
+
+Queries data from the RDB store based on specified conditions. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | Query conditions specified by the **RdbPredicates** object. |
+| columns | Array<string> | Yes | Columns to query. If this parameter is not specified, the query applies to all columns. |
+| callback | AsyncCallback<[ResultSet](#resultset)> | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSet** object will be returned.|
+
+**Example**
+
+```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("Failed to query data, err: " + err)
+ return
+ }
+ console.log("ResultSet column names: " + resultSet.columnNames)
+ console.log("ResultSet column count: " + resultSet.columnCount)
+})
+```
+
+### query
+
+query(predicates: RdbPredicates, columns?: Array<string>):Promise<ResultSet>
+
+Queries data from the RDB store based on specified conditions. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ------------------------------------------------ |
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | Query conditions specified by the **RdbPredicates** object. |
+| columns | Array<string> | No | Columns to query. If this parameter is not specified, the query applies to all columns.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------------------------- | -------------------------------------------------- |
+| Promise<[ResultSet](#resultset)> | Promise used to return the result. If the operation is successful, a **ResultSet** object will be returned.|
+
+**Example**
+
+ ```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("Failed to query data, err: " + err)
+})
+ ```
+
+### query
+
+query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>):void
+
+Queries data from the RDB store based on specified conditions. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
+| table | string | Yes | Name of the target table. |
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Query conditions specified by the **DataSharePredicates** object. |
+| columns | Array<string> | Yes | Columns to query. If this parameter is not specified, the query applies to all columns. |
+| callback | AsyncCallback<[ResultSet](#resultset)> | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSet** object will be returned.|
+
+**Example**
+
+```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("Failed to query data, 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<string>):Promise<ResultSet>
+
+Queries data from the RDB store based on specified conditions. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ |
+| table | string | Yes | Name of the target table. |
+| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes | Query conditions specified by the **DataSharePredicates** object. |
+| columns | Array<string> | No | Columns to query. If this parameter is not specified, the query applies to all columns.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------------------------- | -------------------------------------------------- |
+| Promise<[ResultSet](#resultset)> | Promise used to return the result. If the operation is successful, a **ResultSet** object will be returned.|
+
+**Example**
+
+```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("Failed to query data, err: " + err)
+})
+```
+
+### remoteQuery
+
+remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array<string> , callback: AsyncCallback<ResultSet>): void
+
+Queries data from the RDB store of a remote device based on specified conditions. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
+| device | string | Yes | Network ID of the remote device. |
+| table | string | Yes | Name of the target table. |
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | Query conditions specified by the **RdbPredicates** object. |
+| columns | Array<string> | Yes | Columns to query. If this parameter is not specified, the query applies to all columns. |
+| callback | AsyncCallback<[ResultSet](#resultset)> | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSet** object will be returned.|
+
+**Example**
+
+```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<string>): Promise<ResultSet>
+
+Queries data from the RDB store of a remote device based on specified conditions. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ------------------------------------------------ |
+| device | string | Yes | Network ID of the remote device. |
+| table | string | Yes | Name of the target table. |
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | Query conditions specified by the **RdbPredicates** object. |
+| columns | Array<string> | Yes | Columns to query. If this parameter is not specified, the query applies to all columns.|
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------------------------------ | -------------------------------------------------- |
+| Promise<[ResultSet](#resultset)> | Promise used to return the result. If the operation is successful, a **ResultSet** object will be returned.|
+
+**Example**
+
+```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<ValueType>, callback: AsyncCallback<ResultSet>):void
+
+Queries data using the specified SQL statement. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
+| sql | string | Yes | SQL statement to run. |
+| bindArgs | Array<[ValueType](#valuetype)> | Yes | Arguments in the SQL statement. |
+| callback | AsyncCallback<[ResultSet](#resultset)> | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSet** object will be returned.|
+
+**Example**
+
+```js
+rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) {
+ if (err) {
+ console.info("Failed to query data, err: " + err)
+ return
+ }
+ console.log("ResultSet column names: " + resultSet.columnNames)
+ console.log("ResultSet column count: " + resultSet.columnCount)
+})
+```
+
+### querySql
+
+querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet>
+
+Queries data using the specified SQL statement. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------ | ---- | --------------------- |
+| sql | string | Yes | SQL statement to run.|
+| bindArgs | Array<[ValueType](#valuetype)> | No | Arguments in the SQL statement. |
+
+**Return value**
+
+| Type | Description |
+| ------------------------------------------------------- | -------------------------------------------------- |
+| Promise<[ResultSet](#resultset)> | Promise used to return the result. If the operation is successful, a **ResultSet** object will be returned.|
+
+**Example**
+
+```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("Failed to query data, err: " + err)
+})
+```
+
+### executeSql
+
+executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<void>):void
+
+Executes an SQL statement that contains specified arguments but returns no value. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------ | ---- | ---------------------- |
+| sql | string | Yes | SQL statement to run. |
+| bindArgs | Array<[ValueType](#valuetype)> | Yes | Arguments in the SQL statement. |
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result.|
+
+**Example**
+
+```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("Failed to execute SQL, err: " + err)
+ return
+ }
+ console.info('Create table done.')
+})
+```
+
+### executeSql
+
+executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void>
+
+Executes an SQL statement that contains specified arguments but returns no value. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------------ | ---- | --------------------- |
+| sql | string | Yes | SQL statement to run.|
+| bindArgs | Array<[ValueType](#valuetype)> | No | Arguments in the SQL statement. |
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+```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("Failed to execute SQL, err: " + err)
+})
+```
+
+### beginTransaction
+
+beginTransaction():void
+
+Starts the transaction before executing an SQL statement.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Example**
+
+```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
+
+Commits the executed SQL statements.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Example**
+
+```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
+
+Rolls back the SQL statements that have been executed.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Example**
+
+```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<void>):void
+
+Backs up an RDB store. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ------------------------ |
+| destName | string | Yes | Name of the RDB store backup file.|
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
+
+**Example**
+
+```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<void>
+
+Backs up an RDB store. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------ | ---- | ------------------------ |
+| destName | string | Yes | Name of the RDB store backup file.|
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+```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<void>):void
+
+Restores an RDB store from a backup file. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ------------------------ |
+| srcName | string | Yes | Name of the RDB store backup file.|
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. |
+
+**Example**
+
+```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<void>
+
+Restores an RDB store from a backup file. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | ------ | ---- | ------------------------ |
+| srcName | string | Yes | Name of the RDB store backup file.|
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+```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<string>, callback: AsyncCallback<void>): void
+
+Sets distributed tables. This API uses an asynchronous callback to return the result.
+
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ---------------------- |
+| tables | Array<string> | Yes | Names of the distributed tables to set.|
+| callback | AsyncCallback<void> | Yes | Callback invoked to return the result.|
+
+**Example**
+
+```js
+rdbStore.setDistributedTables(["EMPLOYEE"], function (err) {
+ if (err) {
+ console.info('Failed to set distributed tables, err: ' + err)
+ return
+ }
+ console.info('Set distributed tables successfully.')
+})
+```
+
+### setDistributedTables
+
+ setDistributedTables(tables: Array<string>): Promise<void>
+
+Sets distributed tables. This API uses a promise to return the result.
+
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------------------- | ---- | ------------------------ |
+| tables | Array<string> | Yes | Names of the distributed tables to set.|
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+```js
+let promise = rdbStore.setDistributedTables(["EMPLOYEE"])
+promise.then(() => {
+ console.info("Set distributed tables successfully.")
+}).catch((err) => {
+ console.info("Failed to set distributed tables, err: " + err)
+})
+```
+
+### obtainDistributedTableName
+
+obtainDistributedTableName(device: string, table: string, callback: AsyncCallback<string>): void
+
+Obtains the distributed table name for a remote device based on the local table name. This API uses an asynchronous callback to return the result. The distributed table name is required when the RDB store of a remote device is queried.
+
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
+| device | string | Yes | Remote device. |
+| table | string | Yes | Local table name. |
+| callback | AsyncCallback<string> | Yes | Callback invoked to return the result. If the operation succeeds, the distributed table name of the remote device is returned.|
+
+**Example**
+
+```js
+rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {
+ if (err) {
+ console.info('Failed to obtain DistributedTableName, err: ' + err)
+ return
+ }
+ console.info('Obtained distributed table name successfully, tableName=.' + tableName)
+})
+```
+
+### obtainDistributedTableName
+
+ obtainDistributedTableName(device: string, table: string): Promise<string>
+
+Obtains the distributed table name for a remote device based on the local table name. This API uses a promise to return the result. The distributed table name is required when the RDB store of a remote device is queried.
+
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------- |
+| device | string | Yes | Remote device.|
+| table | string | Yes | Local table name.|
+
+**Return value**
+
+| Type | Description |
+| --------------------- | ----------------------------------------------------- |
+| Promise<string> | Promise used to return the result. If the operation succeeds, the distributed table name of the remote device is returned.|
+
+**Example**
+
+```js
+let promise = rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE")
+promise.then((tableName) => {
+ console.info('Obtained distributed table name successfully, tableName= ' + tableName)
+}).catch((err) => {
+ console.info('Failed to obtain DistributedTableName, err: ' + err)
+})
+```
+
+### sync
+
+sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array<[string, number]>>): void
+
+Synchronizes data between devices. This API uses an asynchronous callback to return the result.
+
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ |
+| mode | [SyncMode](#syncmode) | Yes | Data synchronization mode. The value can be **push** or **pull**. |
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | **RdbPredicates** object that specifies the data and devices to synchronize. |
+| callback | AsyncCallback<Array<[string, number]>> | Yes | Callback invoked to send the synchronization result to the caller.
**string** indicates the device ID.
**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. |
+
+**Example**
+
+```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<Array<[string, number]>>
+
+Synchronizes data between devices. This API uses a promise to return the result.
+
+**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------------------ | ---- | ------------------------------ |
+| mode | [SyncMode](#syncmode) | Yes | Data synchronization mode. The value can be **push** or **pull**.|
+| predicates | [RdbPredicates](#rdbpredicates) | Yes | **RdbPredicates** object that specifies the data and devices to synchronize. |
+
+**Return value**
+
+| Type | Description |
+| -------------------------------------------- | ------------------------------------------------------------ |
+| Promise<Array<[string, number]>> | Promise used to send the synchronization result.
**string** indicates the device ID.
**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. |
+
+**Example**
+
+```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<Array<string>>): void
+
+Registers an observer for this RDB store. When the data in the RDB store changes, a callback is invoked to return the data changes.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ----------------------------------- | ---- | ------------------------------------------- |
+| event | string | Yes | The value is'dataChange', which indicates a data change event. |
+| type | [SubscribeType](#subscribetype) | Yes | Subscription type to register.|
+| observer | Callback<Array<string>> | Yes | Observer that listens for the data changes in the RDB store. |
+
+**Example**
+
+```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('Failed to register observer')
+}
+```
+
+### off('dataChange')
+
+off(event:'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void
+
+Unregisters the observer of the specified type from the RDB store. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ---------------------------------- | ---- | ------------------------------------------ |
+| event | string | Yes | The value is'dataChange', which indicates a data change event. |
+| type | [SubscribeType](#subscribetype) | Yes | Subscription type to register. |
+| observer | Callback<Array<string>> | Yes | Data change observer registered. |
+
+**Example**
+
+```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('Failed to unregister observer')
+}
+```
+
+## ResultSet
+
+Provides APIs to access the result set obtained by querying the RDB store. A result set is a set of results returned after **query()** is called.
+
+### Usage
+
+Obtain the **resultSet** object by [RdbStore.query()](#query).
+
+```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);
+});
+```
+
+### Attributes
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Name | Type | Mandatory| Description |
+| ------------ | ------------------- | ---- | -------------------------------- |
+| columnNames | Array<string> | Yes | Names of all columns in the result set. |
+| columnCount | number | Yes | Number of columns in the result set. |
+| rowCount | number | Yes | Number of rows in the result set. |
+| rowIndex | number | Yes | Index of the current row in the result set. |
+| isAtFirstRow | boolean | Yes | Whether the cursor is in the first row of the result set. |
+| isAtLastRow | boolean | Yes | Whether the cursor is in the last row of the result set. |
+| isEnded | boolean | Yes | Whether the cursor is after the last row of the result set.|
+| isStarted | boolean | Yes | Whether the cursor has been moved. |
+| isClosed | boolean | Yes | Whether the result set is closed. |
+
+### getColumnIndex
+
+getColumnIndex(columnName: string): number
+
+Obtains the column index based on the column name.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------ | ---- | -------------------------- |
+| columnName | string | Yes | Column name.|
+
+**Return value**
+
+| Type | Description |
+| ------ | ------------------ |
+| number | Column index obtained.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```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
+
+Obtains the column name based on the specified column index.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | -------------------------- |
+| columnIndex | number | Yes | Column index.|
+
+**Return value**
+
+| Type | Description |
+| ------ | ------------------ |
+| string | Column name obtained.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const id = resultSet.getColumnName(0);
+const name = resultSet.getColumnName(1);
+const age = resultSet.getColumnName(2);
+ ```
+
+### goTo
+
+goTo(offset:number): boolean
+
+Moves the cursor to the row based on the specified offset.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------------- |
+| offset | number | Yes | Offset relative to the current position.|
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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
+
+Moves to the specified row in the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------ | ---- | ------------------------ |
+| position | number | Yes | Destination position to move to.|
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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
+
+
+Moves to the first row of the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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
+
+Moves to the last row of the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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
+
+Moves to the next row in the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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
+
+Moves to the previous row in the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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
+
+Obtains the value in the form of a byte array based on the specified column and the current row.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the target column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ---------- | -------------------------------- |
+| Uint8Array | Value obtained.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const codes = resultSet.getBlob(resultSet.getColumnIndex("CODES"));
+ ```
+
+### getString
+
+getString(columnIndex: number): string
+
+Obtains the value in the form of a string based on the specified column and the current row.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the target column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ------ | ---------------------------- |
+| string | String obtained.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const name = resultSet.getString(resultSet.getColumnIndex("NAME"));
+ ```
+
+### getLong
+
+getLong(columnIndex: number): number
+
+Obtains the value of the Long type based on the specified column and the current row.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the target column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ------ | -------------------------- |
+| number | Value obtained.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const age = resultSet.getLong(resultSet.getColumnIndex("AGE"));
+ ```
+
+### getDouble
+
+getDouble(columnIndex: number): number
+
+Obtains the value of the double type based on the specified column and the current row.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the target column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ------ | ---------------------------- |
+| number | Value obtained.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"));
+ ```
+
+### isColumnNull
+
+isColumnNull(columnIndex: number): boolean
+
+Checks whether the value in the specified column is null.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the target column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------------------- |
+| boolean | Returns **true** if the value is null; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const isColumnNull = resultSet.isColumnNull(resultSet.getColumnIndex("CODES"));
+ ```
+
+### close
+
+close(): void
+
+Closes this result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Example**
+
+ ```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');
+});
+ ```
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
diff --git a/en/application-dev/reference/apis/js-apis-data-resultset.md b/en/application-dev/reference/apis/js-apis-data-resultset.md
index 8cdecd1134a270075b3d4dd86a7e4e7a07fc7390..12a6b4af059ad689d7b782b3cbca27bf86d674d5 100644
--- a/en/application-dev/reference/apis/js-apis-data-resultset.md
+++ b/en/application-dev/reference/apis/js-apis-data-resultset.md
@@ -8,6 +8,536 @@ A result set is a set of results returned after the relational database (RDB) qu
>
> The APIs of this module are no longer maintained since API version 9. You are advised to use [@ohos.data.relationalStore#ResultSet](js-apis-data-relationalStore.md#resultset).
+## ResultSetV99+
+
+Provides APIs to access the result set, which is obtained by querying the RDB store.
+
+### Usage
+
+Use [RdbStoreV9.query()](js-apis-data-rdb.md#query) to obtain the **resultSetV9** instance.
+
+```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);
+});
+```
+
+### Attributes9+
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+| Name | Type | Mandatory| Description |
+| ------------ | ------------------- | ---- | -------------------------------- |
+| columnNames | Array<string> | Yes | Names of all columns in the result set. |
+| columnCount | number | Yes | Number of columns in the result set. |
+| rowCount | number | Yes | Number of rows in the result set. |
+| rowIndex | number | Yes | Index of the current row in the result set. |
+| isAtFirstRow | boolean | Yes | Whether the cursor is in the first row of the result set. |
+| isAtLastRow | boolean | Yes | Whether the cursor is in the last row of the result set. |
+| isEnded | boolean | Yes | Whether the cursor is after the last row of the result set.|
+| isStarted | boolean | Yes | Whether the cursor has been moved. |
+| isClosed | boolean | Yes | Whether the result set is closed. |
+
+### getColumnIndex9+
+
+getColumnIndex(columnName: string): number
+
+Obtains the column index based on the column name.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ---------- | ------ | ---- | -------------------------- |
+| columnName | string | Yes | Column name specified.|
+
+**Return value**
+
+| Type | Description |
+| ------ | ------------------ |
+| number | Index of the column obtained.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```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"));
+ ```
+
+### getColumnName9+
+
+getColumnName(columnIndex: number): string
+
+Obtains the column name based on the column index.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | -------------------------- |
+| columnIndex | number | Yes | Column index specified.|
+
+**Return value**
+
+| Type | Description |
+| ------ | ------------------ |
+| string | Column name obtained.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const id = resultSetV9.getColumnName(0);
+const name = resultSetV9.getColumnName(1);
+const age = resultSetV9.getColumnName(2);
+ ```
+
+### goTo9+
+
+goTo(offset:number): boolean
+
+Moves the cursor to the row based on the specified offset.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------------------------- |
+| offset | number | Yes | Offset relative to the current position.|
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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');
+});
+ ```
+
+### goToRow9+
+
+goToRow(position: number): boolean
+
+Moves the cursor to the specified row in the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------ | ---- | ------------------------ |
+| position | number | Yes | Position to which the cursor is to be moved.|
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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');
+});
+ ```
+
+### goToFirstRow9+
+
+goToFirstRow(): boolean
+
+
+Moves the cursor to the first row of the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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');
+});
+ ```
+
+### goToLastRow9+
+
+goToLastRow(): boolean
+
+Moves the cursor to the last row of the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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');
+});
+ ```
+
+### goToNextRow9+
+
+goToNextRow(): boolean
+
+Moves the cursor to the next row in the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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');
+});
+ ```
+
+### goToPreviousRow9+
+
+goToPreviousRow(): boolean
+
+Moves the cursor to the previous row in the result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
+**Example**
+
+ ```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');
+});
+ ```
+
+### getBlob9+
+
+getBlob(columnIndex: number): Uint8Array
+
+Obtains the value in the specified column in the current row as a byte array.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the specified column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ---------- | -------------------------------- |
+| Uint8Array | Value in the specified column as a byte array.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const codes = resultSetV9.getBlob(resultSetV9.getColumnIndex("CODES"));
+ ```
+
+### getString9+
+
+getString(columnIndex: number): string
+
+Obtains the value in the specified column in the current row as a string.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the specified column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ------ | ---------------------------- |
+| string | Value in the specified column as a string.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const name = resultSetV9.getString(resultSetV9.getColumnIndex("NAME"));
+ ```
+
+### getLong9+
+
+getLong(columnIndex: number): number
+
+Obtains the value in the specified column in the current row as a Long.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the specified column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ------ | -------------------------- |
+| number | Value in the specified column as a Long.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const age = resultSetV9.getLong(resultSetV9.getColumnIndex("AGE"));
+ ```
+
+### getDouble9+
+
+getDouble(columnIndex: number): number
+
+Obtains the value in the specified column in the current row as a double.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the specified column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ------ | ---------------------------- |
+| number | Value in the specified column as a double.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const salary = resultSetV9.getDouble(resultSetV9.getColumnIndex("SALARY"));
+ ```
+
+### isColumnNull9+
+
+isColumnNull(columnIndex: number): boolean
+
+Checks whether the value in the specified column of the current row is null.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------ | ---- | ----------------------- |
+| columnIndex | number | Yes | Index of the specified column, starting from 0.|
+
+**Return value**
+
+| Type | Description |
+| ------- | --------------------------------------------------------- |
+| boolean | Returns **true** if the value is null; returns **false** otherwise.|
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800013 | The column value is null or the column type is incompatible. |
+
+**Example**
+
+ ```js
+const isColumnNull = resultSetV9.isColumnNull(resultSetV9.getColumnIndex("CODES"));
+ ```
+
+### close9+
+
+close(): void
+
+Closes this result set.
+
+**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
+
+**Example**
+
+ ```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');
+});
+ ```
+
+**Error codes**
+
+For details about the error codes, see [RDB Error Codes](../errorcodes/errorcode-data-rdb.md).
+
+| **ID**| **Error Message** |
+| ------------ | ------------------------------------------------------------ |
+| 14800012 | The result set is empty or the specified location is invalid. |
+
## ResultSet
Provides methods to access the result set, which is obtained by querying the RDB store.