Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 0ce5ef7f 编写于 作者: P PaDaBoo
浏览文件
操作

update rdb.md doc files 

Signed-off-by: NPaDaBoo <xuejianwu@huawei.com>
上级 6943b6e3
隐藏空白更改
内联 并排
Showing with 646 addition and 610 deletion
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
浏览文件 @ 0ce5ef7f
...@@ -17,9 +17,9 @@ getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback&lt;Rdb ...@@ -17,9 +17,9 @@ getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback&lt;Rdb
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -27,15 +27,16 @@ getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback&lt;Rdb ...@@ -27,15 +27,16 @@ getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback&lt;Rdb
| version | number | 是 | 数据库版本。 | | version | number | 是 | 数据库版本。 |
| callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | 是 | 指定callback回调函数，返回一个RdbStore。 | | callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | 是 | 指定callback回调函数，返回一个RdbStore。 |
**示例**： **示例：**
```js ```js
const STORE_CONFIG = { name: "RdbTest.db"} const STORE_CONFIG = { name: "RdbTest.db"}
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)"
data_rdb.getRdbStore(STORE_CONFIG, 1, function (err, rdbStore) { data_rdb.getRdbStore(STORE_CONFIG, 1, function (err, rdbStore) {
rdbStore.executeSql(SQL_CREATE_TABLE, null, function() { if (err) {
console.info('create table done.') console.info("Get RdbStore failed, err: " + err)
}) return
}
console.log("Get RdbStore successfully.")
}) })
``` ```
## data_rdb.getRdbStore ## data_rdb.getRdbStore
...@@ -44,9 +45,9 @@ getRdbStore(config: StoreConfig, version: number): Promise&lt;RdbStore&gt; ...@@ -44,9 +45,9 @@ getRdbStore(config: StoreConfig, version: number): Promise&lt;RdbStore&gt;
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -59,21 +60,15 @@ getRdbStore(config: StoreConfig, version: number): Promise&lt;RdbStore&gt; ...@@ -59,21 +60,15 @@ getRdbStore(config: StoreConfig, version: number): Promise&lt;RdbStore&gt;
| -------- | -------- | | -------- | -------- |
| Promise&lt;[RdbStore](#rdbstore)&gt; | 指定Promise回调函数。返回一个RdbStore。 | | Promise&lt;[RdbStore](#rdbstore)&gt; | 指定Promise回调函数。返回一个RdbStore。 |
**示例**： **示例：**
```js ```js
const STORE_CONFIG = { name: "RdbTest.db" } const STORE_CONFIG = { name: "RdbTest.db" }
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 = data_rdb.getRdbStore(STORE_CONFIG, 1);
let promisegetRdb = data_rdb.getRdbStore(STORE_CONFIG, 1); promise.then(async (rdbStore) => {
promisegetRdb.then(async (rdbStore) => { console.log("Get RdbStore successfully.")
let promiseExecSql = rdbStore.executeSql(SQL_CREATE_TABLE, null)
promiseExecSql.then(() => {
console.info('executeSql creat done.')
}).catch((err) => {
console.log("executeSql creat err.")
})
}).catch((err) => { }).catch((err) => {
console.log("getRdbStore err.") console.log("Get RdbStore failed, err: " + err)
}) })
``` ```
...@@ -84,9 +79,9 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As ...@@ -84,9 +79,9 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -95,15 +90,16 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As ...@@ -95,15 +90,16 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As
| version | number | 是 | 数据库版本。 | | version | number | 是 | 数据库版本。 |
| callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | 是 | 指定callback回调函数，返回一个RdbStore。 | | callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | 是 | 指定callback回调函数，返回一个RdbStore。 |
**示例**： **示例：**
```js ```js
const STORE_CONFIG = { name: "RdbTest.db"} const STORE_CONFIG = { name: "RdbTest.db"}
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)"
data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) { data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) {
rdbStore.executeSql(SQL_CREATE_TABLE, null, function() { if (err) {
console.info('create table done.') console.info("Get RdbStore failed, err: " + err)
}) return
}
console.log("Get RdbStore successfully.")
}) })
``` ```
...@@ -113,9 +109,9 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt; ...@@ -113,9 +109,9 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt;
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -129,21 +125,15 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt; ...@@ -129,21 +125,15 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt;
| -------- | -------- | | -------- | -------- |
| Promise&lt;[RdbStore](#rdbstore)&gt; | 指定Promise回调函数。返回一个RdbStore。 | | Promise&lt;[RdbStore](#rdbstore)&gt; | 指定Promise回调函数。返回一个RdbStore。 |
**示例**： **示例：**
```js ```js
const STORE_CONFIG = { name: "RdbTest.db" } const STORE_CONFIG = { name: "RdbTest.db" }
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 = data_rdb.getRdbStore(this.context, STORE_CONFIG, 1);
let promisegetRdb = data_rdb.getRdbStore(this.context, STORE_CONFIG, 1); promise.then(async (rdbStore) => {
promisegetRdb.then(async (rdbStore) => { console.log("Get RdbStore successfully.")
let promiseExecSql = rdbStore.executeSql(SQL_CREATE_TABLE, null)
promiseExecSql.then(() => {
console.info('executeSql creat done.')
}).catch((err) => {
console.log("executeSql creat err.")
})
}).catch((err) => { }).catch((err) => {
console.log("getRdbStore err.") console.log("Get RdbStore failed, err: " + err)
}) })
``` ```
...@@ -153,27 +143,31 @@ deleteRdbStore(name: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -153,27 +143,31 @@ deleteRdbStore(name: string, callback: AsyncCallback&lt;void&gt;): void
删除数据库，结果以callback形式返回。 删除数据库，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库名称。 | | name | string | 是 | 数据库名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例**： **示例：**
```js ```js
data_rdb.deleteRdbStore("RdbTest.db", function (err, rdbStore) { data_rdb.deleteRdbStore("RdbTest.db", function (err, rdbStore) {
console.info('delete store done.') if (err) {
}) console.info("Delete RdbStore failed, err: " + err)
``` return
}
console.log("Delete RdbStore successfully.")
})
```
## data_rdb.deleteRdbStore ## data_rdb.deleteRdbStore
deleteRdbStore(name: string): Promise&lt;void&gt; deleteRdbStore(name: string): Promise&lt;void&gt;
使用指定的数据库文件配置删除数据库，结果以Promise形式返回。 使用指定的数据库文件配置删除数据库，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -185,15 +179,15 @@ deleteRdbStore(name: string): Promise&lt;void&gt; ...@@ -185,15 +179,15 @@ deleteRdbStore(name: string): Promise&lt;void&gt;
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 指定Promise回调函数。 | | Promise&lt;void&gt; | 指定Promise回调函数。 |
**示例**： **示例：**
```js ```js
let promisedeleteRdb = data_rdb.deleteRdbStore("RdbTest.db") let promise = data_rdb.deleteRdbStore("RdbTest.db")
promisedeleteRdb.then(()=>{ promise.then(()=>{
console.info('delete store done.') console.log("Delete RdbStore successfully.")
}).catch((err) => { }).catch((err) => {
console.log("deleteRdbStore err.") console.info("Delete RdbStore failed, err: " + err)
}) })
``` ```
## data_rdb.deleteRdbStore<sup>8+</sup> ## data_rdb.deleteRdbStore<sup>8+</sup>
...@@ -201,21 +195,25 @@ deleteRdbStore(context: Context, name: string, callback: AsyncCallback&lt;void&g ...@@ -201,21 +195,25 @@ deleteRdbStore(context: Context, name: string, callback: AsyncCallback&lt;void&g
删除数据库，结果以callback形式返回。 删除数据库，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-ability-context.md)。| | context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-ability-context.md)。|
| name | string | 是 | 数据库名称。 | | name | string | 是 | 数据库名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例**： **示例：**
```js ```js
data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) { data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) {
console.info('delete store done.') if (err) {
}) console.info("Delete RdbStore failed, err: " + err)
``` return
}
console.log("Delete RdbStore successfully.")
})
```
## data_rdb.deleteRdbStore<sup>8+</sup> ## data_rdb.deleteRdbStore<sup>8+</sup>
...@@ -223,7 +221,7 @@ deleteRdbStore(context: Context, name: string): Promise&lt;void&gt; ...@@ -223,7 +221,7 @@ deleteRdbStore(context: Context, name: string): Promise&lt;void&gt;
使用指定的数据库文件配置删除数据库，结果以Promise形式返回。 使用指定的数据库文件配置删除数据库，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -236,15 +234,15 @@ deleteRdbStore(context: Context, name: string): Promise&lt;void&gt; ...@@ -236,15 +234,15 @@ deleteRdbStore(context: Context, name: string): Promise&lt;void&gt;
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 指定Promise回调函数。 | | Promise&lt;void&gt; | 指定Promise回调函数。 |
**示例**： **示例：**
```js ```js
let promisedeleteRdb = data_rdb.deleteRdbStore("RdbTest.db") let promise = data_rdb.deleteRdbStore("RdbTest.db")
promisedeleteRdb.then(()=>{ promise.then(()=>{
console.info('delete store done.') console.log("Delete RdbStore successfully.")
}).catch((err) => { }).catch((err) => {
console.log("deleteRdbStore err.") console.info("Delete RdbStore failed, err: " + err)
}) })
``` ```
## RdbPredicates ## RdbPredicates
...@@ -259,17 +257,17 @@ constructor(name: string) ...@@ -259,17 +257,17 @@ constructor(name: string)
构造函数。 构造函数。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库表名。 | | name | string | 是 | 数据库表名。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
``` ```
### inDevices<sup>8+</sup> ### inDevices<sup>8+</sup>
...@@ -278,9 +276,9 @@ inDevices(devices: Array&lt;string&gt;): RdbPredicates ...@@ -278,9 +276,9 @@ inDevices(devices: Array&lt;string&gt;): RdbPredicates
同步分布式数据库时指定组网内的远程设备。 同步分布式数据库时指定组网内的远程设备。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| devices | Array&lt;string&gt; | 是 | 指定的组网内的远程设备ID。 | | devices | Array&lt;string&gt; | 是 | 指定的组网内的远程设备ID。 |
...@@ -290,11 +288,11 @@ inDevices(devices: Array&lt;string&gt;): RdbPredicates ...@@ -290,11 +288,11 @@ inDevices(devices: Array&lt;string&gt;): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inDevices(['12345678abcde']) predicates.inDevices(['12345678abcde'])
``` ```
### inAllDevices<sup>8+</sup> ### inAllDevices<sup>8+</sup>
...@@ -303,18 +301,18 @@ inAllDevices(): RdbPredicates ...@@ -303,18 +301,18 @@ inAllDevices(): RdbPredicates
同步分布式数据库时连接到组网内的所有远程设备。 同步分布式数据库时连接到组网内的所有远程设备。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值**： **返回值**：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inAllDevices() predicates.inAllDevices()
``` ```
### equalTo ### equalTo
...@@ -323,9 +321,9 @@ equalTo(field: string, value: ValueType): RdbPredicates ...@@ -323,9 +321,9 @@ equalTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且值等于指定值的字段。 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -336,11 +334,11 @@ equalTo(field: string, value: ValueType): RdbPredicates ...@@ -336,11 +334,11 @@ equalTo(field: string, value: ValueType): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi") predicates.equalTo("NAME", "lisi")
``` ```
### notEqualTo ### notEqualTo
...@@ -350,9 +348,9 @@ notEqualTo(field: string, value: ValueType): RdbPredicates ...@@ -350,9 +348,9 @@ notEqualTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -363,11 +361,11 @@ notEqualTo(field: string, value: ValueType): RdbPredicates ...@@ -363,11 +361,11 @@ notEqualTo(field: string, value: ValueType): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notEqualTo("NAME", "lisi") predicates.notEqualTo("NAME", "lisi")
``` ```
### beginWrap ### beginWrap
...@@ -377,23 +375,23 @@ beginWrap(): RdbPredicates ...@@ -377,23 +375,23 @@ beginWrap(): RdbPredicates
向谓词添加左括号。 向谓词添加左括号。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值**： **返回值**：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回带有左括号的Rdb谓词。 | | [RdbPredicates](#rdbpredicates) | 返回带有左括号的Rdb谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi") predicates.equalTo("NAME", "lisi")
.beginWrap() .beginWrap()
.equalTo("AGE", 18) .equalTo("AGE", 18)
.or() .or()
.equalTo("SALARY", 200.5) .equalTo("SALARY", 200.5)
.endWrap() .endWrap()
``` ```
### endWrap ### endWrap
...@@ -403,23 +401,23 @@ endWrap(): RdbPredicates ...@@ -403,23 +401,23 @@ endWrap(): RdbPredicates
向谓词添加右括号。 向谓词添加右括号。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值**： **返回值**：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回带有右括号的Rdb谓词。 | | [RdbPredicates](#rdbpredicates) | 返回带有右括号的Rdb谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi") predicates.equalTo("NAME", "lisi")
.beginWrap() .beginWrap()
.equalTo("AGE", 18) .equalTo("AGE", 18)
.or() .or()
.equalTo("SALARY", 200.5) .equalTo("SALARY", 200.5)
.endWrap() .endWrap()
``` ```
### or ### or
...@@ -429,20 +427,20 @@ or(): RdbPredicates ...@@ -429,20 +427,20 @@ or(): RdbPredicates
将或条件添加到谓词中。 将或条件添加到谓词中。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值**： **返回值**：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回带有或条件的Rdb谓词。 | | [RdbPredicates](#rdbpredicates) | 返回带有或条件的Rdb谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa") predicates.equalTo("NAME", "Lisa")
.or() .or()
.equalTo("NAME", "Rose") .equalTo("NAME", "Rose")
``` ```
### and ### and
...@@ -452,20 +450,20 @@ and(): RdbPredicates ...@@ -452,20 +450,20 @@ and(): RdbPredicates
向谓词添加和条件。 向谓词添加和条件。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值**： **返回值**：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回带有和条件的Rdb谓词。 | | [RdbPredicates](#rdbpredicates) | 返回带有和条件的Rdb谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa") predicates.equalTo("NAME", "Lisa")
.and() .and()
.equalTo("SALARY", 200.5) .equalTo("SALARY", 200.5)
``` ```
### contains ### contains
...@@ -474,9 +472,9 @@ contains(field: string, value: string): RdbPredicates ...@@ -474,9 +472,9 @@ contains(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且value包含指定值的字段。 配置谓词以匹配数据字段为string且value包含指定值的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -487,11 +485,11 @@ contains(field: string, value: string): RdbPredicates ...@@ -487,11 +485,11 @@ contains(field: string, value: string): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.contains("NAME", "os") predicates.contains("NAME", "os")
``` ```
### beginsWith ### beginsWith
...@@ -501,9 +499,9 @@ beginsWith(field: string, value: string): RdbPredicates ...@@ -501,9 +499,9 @@ beginsWith(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且值以指定字符串开头的字段。 配置谓词以匹配数据字段为string且值以指定字符串开头的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -514,11 +512,11 @@ beginsWith(field: string, value: string): RdbPredicates ...@@ -514,11 +512,11 @@ beginsWith(field: string, value: string): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.beginsWith("NAME", "os") predicates.beginsWith("NAME", "os")
``` ```
### endsWith ### endsWith
...@@ -528,9 +526,9 @@ endsWith(field: string, value: string): RdbPredicates ...@@ -528,9 +526,9 @@ endsWith(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。 配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -541,11 +539,11 @@ endsWith(field: string, value: string): RdbPredicates ...@@ -541,11 +539,11 @@ endsWith(field: string, value: string): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.endsWith("NAME", "se") predicates.endsWith("NAME", "se")
``` ```
### isNull ### isNull
...@@ -555,9 +553,9 @@ isNull(field: string): RdbPredicates ...@@ -555,9 +553,9 @@ isNull(field: string): RdbPredicates
配置谓词以匹配值为null的字段。 配置谓词以匹配值为null的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -568,10 +566,10 @@ isNull(field: string): RdbPredicates ...@@ -568,10 +566,10 @@ isNull(field: string): RdbPredicates
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
- 示例 - 示例
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNull("NAME") predicates.isNull("NAME")
``` ```
### isNotNull ### isNotNull
...@@ -581,9 +579,9 @@ isNotNull(field: string): RdbPredicates ...@@ -581,9 +579,9 @@ isNotNull(field: string): RdbPredicates
配置谓词以匹配值不为null的指定字段。 配置谓词以匹配值不为null的指定字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -593,11 +591,11 @@ isNotNull(field: string): RdbPredicates ...@@ -593,11 +591,11 @@ isNotNull(field: string): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNotNull("NAME") predicates.isNotNull("NAME")
``` ```
### like ### like
...@@ -607,9 +605,9 @@ like(field: string, value: string): RdbPredicates ...@@ -607,9 +605,9 @@ like(field: string, value: string): RdbPredicates
配置谓词以匹配数据字段为string且值类似于指定字符串的字段。 配置谓词以匹配数据字段为string且值类似于指定字符串的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -620,11 +618,11 @@ like(field: string, value: string): RdbPredicates ...@@ -620,11 +618,11 @@ like(field: string, value: string): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.like("NAME", "%os%") predicates.like("NAME", "%os%")
``` ```
### glob ### glob
...@@ -634,9 +632,9 @@ glob(field: string, value: string): RdbPredicates ...@@ -634,9 +632,9 @@ glob(field: string, value: string): RdbPredicates
配置RdbPredicates匹配数据字段为string的指定字段。 配置RdbPredicates匹配数据字段为string的指定字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -647,11 +645,11 @@ glob(field: string, value: string): RdbPredicates ...@@ -647,11 +645,11 @@ glob(field: string, value: string): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.glob("NAME", "?h*g") predicates.glob("NAME", "?h*g")
``` ```
### between ### between
...@@ -661,9 +659,9 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates ...@@ -661,9 +659,9 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates
将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。 将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -675,11 +673,11 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates ...@@ -675,11 +673,11 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.between("AGE", 10, 50) predicates.between("AGE", 10, 50)
``` ```
### notBetween ### notBetween
...@@ -689,9 +687,9 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates ...@@ -689,9 +687,9 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates
配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。 配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -703,11 +701,11 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates ...@@ -703,11 +701,11 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notBetween("AGE", 10, 50) predicates.notBetween("AGE", 10, 50)
``` ```
### greaterThan ### greaterThan
...@@ -716,9 +714,9 @@ greaterThan(field: string, value: ValueType): RdbPredicates ...@@ -716,9 +714,9 @@ greaterThan(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且值大于指定值的字段。 配置谓词以匹配数据字段为ValueType且值大于指定值的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -729,11 +727,11 @@ greaterThan(field: string, value: ValueType): RdbPredicates ...@@ -729,11 +727,11 @@ greaterThan(field: string, value: ValueType): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThan("AGE", 18) predicates.greaterThan("AGE", 18)
``` ```
### lessThan ### lessThan
...@@ -743,9 +741,9 @@ lessThan(field: string, value: ValueType): RdbPredicates ...@@ -743,9 +741,9 @@ lessThan(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为valueType且value小于指定值的字段。 配置谓词以匹配数据字段为valueType且value小于指定值的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -756,11 +754,11 @@ lessThan(field: string, value: ValueType): RdbPredicates ...@@ -756,11 +754,11 @@ lessThan(field: string, value: ValueType): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThan("AGE", 20) predicates.lessThan("AGE", 20)
``` ```
### greaterThanOrEqualTo ### greaterThanOrEqualTo
...@@ -771,9 +769,9 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates ...@@ -771,9 +769,9 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。 配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -784,11 +782,11 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates ...@@ -784,11 +782,11 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThanOrEqualTo("AGE", 18) predicates.greaterThanOrEqualTo("AGE", 18)
``` ```
### lessThanOrEqualTo ### lessThanOrEqualTo
...@@ -799,9 +797,9 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates ...@@ -799,9 +797,9 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates
配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。 配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -812,11 +810,11 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates ...@@ -812,11 +810,11 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThanOrEqualTo("AGE", 20) predicates.lessThanOrEqualTo("AGE", 20)
``` ```
### orderByAsc ### orderByAsc
...@@ -827,9 +825,9 @@ orderByAsc(field: string): RdbPredicates ...@@ -827,9 +825,9 @@ orderByAsc(field: string): RdbPredicates
配置谓词以匹配其值按升序排序的列。 配置谓词以匹配其值按升序排序的列。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -839,11 +837,11 @@ orderByAsc(field: string): RdbPredicates ...@@ -839,11 +837,11 @@ orderByAsc(field: string): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByAsc("NAME") predicates.orderByAsc("NAME")
``` ```
### orderByDesc ### orderByDesc
...@@ -854,9 +852,9 @@ orderByDesc(field: string): RdbPredicates ...@@ -854,9 +852,9 @@ orderByDesc(field: string): RdbPredicates
配置谓词以匹配其值按降序排序的列。 配置谓词以匹配其值按降序排序的列。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -866,11 +864,11 @@ orderByDesc(field: string): RdbPredicates ...@@ -866,11 +864,11 @@ orderByDesc(field: string): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByDesc("AGE") predicates.orderByDesc("AGE")
``` ```
### distinct ### distinct
...@@ -880,25 +878,25 @@ distinct(): RdbPredicates ...@@ -880,25 +878,25 @@ distinct(): RdbPredicates
配置谓词以过滤重复记录并仅保留其中一个。 配置谓词以过滤重复记录并仅保留其中一个。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值**： **返回值**：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回可用于过滤重复记录的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回可用于过滤重复记录的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").distinct("NAME") predicates.equalTo("NAME", "Rose").distinct("NAME")
let promisequery = rdbStore.query(predicates, ["NAME"]) let promise = rdbStore.query(predicates, ["NAME"])
promisequery.then((resultSet) => { promise.then((resultSet) => {
console.log("resultSet column names:" + resultSet.columnNames) console.log("resultSet column names:" + resultSet.columnNames)
console.log("resultSet column count:" + resultSet.columnCount) console.log("resultSet column count:" + resultSet.columnCount)
}).catch((err) => { }).catch((err) => {
console.log("query err.") console.log("query err.")
}) })
``` ```
### limitAs ### limitAs
...@@ -908,9 +906,9 @@ limitAs(value: number): RdbPredicates ...@@ -908,9 +906,9 @@ limitAs(value: number): RdbPredicates
设置最大数据记录数的谓词。 设置最大数据记录数的谓词。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | number | 是 | 最大数据记录数。 | | value | number | 是 | 最大数据记录数。 |
...@@ -920,11 +918,11 @@ limitAs(value: number): RdbPredicates ...@@ -920,11 +918,11 @@ limitAs(value: number): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回可用于设置最大数据记录数的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回可用于设置最大数据记录数的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").limitAs(3) predicates.equalTo("NAME", "Rose").limitAs(3)
``` ```
### offsetAs ### offsetAs
...@@ -934,9 +932,9 @@ offsetAs(rowOffset: number): RdbPredicates ...@@ -934,9 +932,9 @@ offsetAs(rowOffset: number): RdbPredicates
配置RdbPredicates以指定返回结果的起始位置。 配置RdbPredicates以指定返回结果的起始位置。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 | | rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 |
...@@ -946,11 +944,11 @@ offsetAs(rowOffset: number): RdbPredicates ...@@ -946,11 +944,11 @@ offsetAs(rowOffset: number): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回具有指定返回结果起始位置的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回具有指定返回结果起始位置的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").offsetAs(3) predicates.equalTo("NAME", "Rose").offsetAs(3)
``` ```
### groupBy ### groupBy
...@@ -960,9 +958,9 @@ groupBy(fields: Array&lt;string&gt;): RdbPredicates ...@@ -960,9 +958,9 @@ groupBy(fields: Array&lt;string&gt;): RdbPredicates
配置RdbPredicates按指定列分组查询结果。 配置RdbPredicates按指定列分组查询结果。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| fields | Array&lt;string&gt; | 是 | 指定分组依赖的列名。 | | fields | Array&lt;string&gt; | 是 | 指定分组依赖的列名。 |
...@@ -972,11 +970,11 @@ groupBy(fields: Array&lt;string&gt;): RdbPredicates ...@@ -972,11 +970,11 @@ groupBy(fields: Array&lt;string&gt;): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回分组查询列的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回分组查询列的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.groupBy(["AGE", "NAME"]) predicates.groupBy(["AGE", "NAME"])
``` ```
### indexedBy ### indexedBy
...@@ -985,9 +983,9 @@ indexedBy(field: string): RdbPredicates ...@@ -985,9 +983,9 @@ indexedBy(field: string): RdbPredicates
配置RdbPredicates以指定索引列。 配置RdbPredicates以指定索引列。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 索引列的名称。 | | field | string | 是 | 索引列的名称。 |
...@@ -998,11 +996,11 @@ indexedBy(field: string): RdbPredicates ...@@ -998,11 +996,11 @@ indexedBy(field: string): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回具有指定索引列的RdbPredicates。 | | [RdbPredicates](#rdbpredicates) | 返回具有指定索引列的RdbPredicates。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.indexedBy("SALARY_INDEX") predicates.indexedBy("SALARY_INDEX")
``` ```
### in ### in
...@@ -1012,9 +1010,9 @@ in(field: string, value: Array&lt;ValueType&gt;): RdbPredicates ...@@ -1012,9 +1010,9 @@ in(field: string, value: Array&lt;ValueType&gt;): RdbPredicates
配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。 配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -1026,11 +1024,11 @@ in(field: string, value: Array&lt;ValueType&gt;): RdbPredicates ...@@ -1026,11 +1024,11 @@ in(field: string, value: Array&lt;ValueType&gt;): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.in("AGE", [18, 20]) predicates.in("AGE", [18, 20])
``` ```
### notIn ### notIn
...@@ -1040,9 +1038,9 @@ notIn(field: string, value: Array&lt;ValueType&gt;): RdbPredicates ...@@ -1040,9 +1038,9 @@ notIn(field: string, value: Array&lt;ValueType&gt;): RdbPredicates
将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。 将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 | | field | string | 是 | 数据库表中的列名。 |
...@@ -1054,11 +1052,11 @@ notIn(field: string, value: Array&lt;ValueType&gt;): RdbPredicates ...@@ -1054,11 +1052,11 @@ notIn(field: string, value: Array&lt;ValueType&gt;): RdbPredicates
| -------- | -------- | | -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notIn("NAME", ["Lisa", "Rose"]) predicates.notIn("NAME", ["Lisa", "Rose"])
``` ```
## RdbStore ## RdbStore
...@@ -1072,27 +1070,31 @@ insert(name: string, values: ValuesBucket, callback: AsyncCallback&lt;number&gt; ...@@ -1072,27 +1070,31 @@ insert(name: string, values: ValuesBucket, callback: AsyncCallback&lt;number&gt;
向目标表中插入一行数据，结果以callback形式返回。 向目标表中插入一行数据，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| name | string | 是 | 指定的目标表名。 | | name | string | 是 | 指定的目标表名。 |
| values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 | | values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。如果操作成功，返回行ID；否则返回-1。 | | callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。如果操作成功，返回行ID；否则返回-1。 |
**示例**： **示例：**
```js ```js
const valueBucket = { const valueBucket = {
"NAME": "Lisa", "NAME": "Lisa",
"AGE": 18, "AGE": 18,
"SALARY": 100.5, "SALARY": 100.5,
"CODES": new Uint8Array([1, 2, 3, 4, 5]), "CODES": new Uint8Array([1, 2, 3, 4, 5]),
} }
rdbStore.insert("EMPLOYEE", valueBucket, function (err, ret) { rdbStore.insert("EMPLOYEE", valueBucket, function (err, ret) {
console.log("insert first done: " + ret) if (err) {
}) console.info("Insert failed, err: " + err)
``` return
}
console.log("Insert first done: " + ret)
})
```
### insert ### insert
...@@ -1101,9 +1103,9 @@ insert(name: string, values: ValuesBucket):Promise&lt;number&gt; ...@@ -1101,9 +1103,9 @@ insert(name: string, values: ValuesBucket):Promise&lt;number&gt;
向目标表中插入一行数据，结果以Promise形式返回。 向目标表中插入一行数据，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| name | string | 是 | 指定的目标表名。 | | name | string | 是 | 指定的目标表名。 |
...@@ -1114,21 +1116,21 @@ insert(name: string, values: ValuesBucket):Promise&lt;number&gt; ...@@ -1114,21 +1116,21 @@ insert(name: string, values: ValuesBucket):Promise&lt;number&gt;
| -------- | -------- | | -------- | -------- |
| Promise&lt;number&gt; | 指定Promise回调函数。如果操作成功，返回行ID；否则返回-1。 | | Promise&lt;number&gt; | 指定Promise回调函数。如果操作成功，返回行ID；否则返回-1。 |
**示例**： **示例：**
```js ```js
const valueBucket = { const valueBucket = {
"NAME": "Lisa", "NAME": "Lisa",
"AGE": 18, "AGE": 18,
"SALARY": 100.5, "SALARY": 100.5,
"CODES": new Uint8Array([1, 2, 3, 4, 5]), "CODES": new Uint8Array([1, 2, 3, 4, 5]),
} }
let promiseinsert = rdbStore.insert("EMPLOYEE", valueBucket) let promise = rdbStore.insert("EMPLOYEE", valueBucket)
promiseinsert.then(async (ret) => { promise.then(async (ret) => {
console.log("insert first done: " + ret) console.log("Insert first done: " + ret)
}).catch((err) => { }).catch((err) => {
console.log("insert err.") console.log("Insert failed, err: " + err)
}) })
``` ```
### update ### update
...@@ -1137,28 +1139,33 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba ...@@ -1137,28 +1139,33 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba
根据RdbPredicates的指定实例对象更新数据库中的数据，结果以callback形式返回。 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 | | values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 |
| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示要插入到表中的数据行。 | | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示要插入到表中的数据行。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定的callback回调方法。返回受影响的行数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 指定的callback回调方法。返回受影响的行数。 |
**示例**： **示例：**
```js ```js
const valueBucket = { const valueBucket = {
"NAME": "Rose", "NAME": "Rose",
"AGE": 22, "AGE": 22,
"SALARY": 200.5, "SALARY": 200.5,
"CODES": new Uint8Array([1, 2, 3, 4, 5]), "CODES": new Uint8Array([1, 2, 3, 4, 5]),
} }
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa") predicates.equalTo("NAME", "Lisa")
rdbStore.update(valueBucket, predicates, function (err, ret) { rdbStore.update(valueBucket, predicates, function (err, ret) {
console.log("updated row count: " + ret)}) if (err) {
``` console.info("Updated failed, err: " + err)
return
}
console.log("Updated row count: " + ret)
})
```
### update ### update
...@@ -1167,9 +1174,9 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise&lt;number&gt; ...@@ -1167,9 +1174,9 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise&lt;number&gt;
根据RdbPredicates的指定实例对象更新数据库中的数据，结果以Promise形式返回。 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 | | values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 |
...@@ -1180,23 +1187,23 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise&lt;number&gt; ...@@ -1180,23 +1187,23 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise&lt;number&gt;
| -------- | -------- | | -------- | -------- |
| Promise&lt;number&gt; | 指定的Promise回调方法。返回受影响的行数。 | | Promise&lt;number&gt; | 指定的Promise回调方法。返回受影响的行数。 |
**示例**： **示例：**
```js ```js
const valueBucket = { const valueBucket = {
"NAME": "Rose", "NAME": "Rose",
"AGE": 22, "AGE": 22,
"SALARY": 200.5, "SALARY": 200.5,
"CODES": new Uint8Array([1, 2, 3, 4, 5]), "CODES": new Uint8Array([1, 2, 3, 4, 5]),
} }
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa") predicates.equalTo("NAME", "Lisa")
let promiseupdate = rdbStore.update(valueBucket, predicates) let promise = rdbStore.update(valueBucket, predicates)
promiseupdate.then(async (ret) => { promise.then(async (ret) => {
console.log("updated row count: " + ret) console.log("Updated row count: " + ret)
}).catch((err) => { }).catch((err) => {
console.log("update err.") console.info("Updated failed, err: " + err)
}) })
``` ```
### delete ### delete
...@@ -1206,22 +1213,26 @@ delete(rdbPredicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void ...@@ -1206,22 +1213,26 @@ delete(rdbPredicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void
根据rdbPredicates的指定实例对象从数据库中删除数据，结果以callback形式返回。 根据rdbPredicates的指定实例对象从数据库中删除数据，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 | | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。返回受影响的行数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 指定callback回调函数。返回受影响的行数。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa") predicates.equalTo("NAME", "Lisa")
rdbStore.delete(predicates, function (err, rows) { rdbStore.delete(predicates, function (err, rows) {
console.log("delete rows: " + rows) if (err) {
}) console.info("Delete failed, err: " + err)
``` return
}
console.log("Delete rows: " + rows)
})
```
### delete ### delete
...@@ -1230,9 +1241,9 @@ delete(rdbPredicates: RdbPredicates):Promise&lt;number&gt; ...@@ -1230,9 +1241,9 @@ delete(rdbPredicates: RdbPredicates):Promise&lt;number&gt;
根据rdbPredicates的指定实例对象从数据库中删除数据，结果以Promise形式返回。 根据rdbPredicates的指定实例对象从数据库中删除数据，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 | | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 |
...@@ -1242,17 +1253,17 @@ delete(rdbPredicates: RdbPredicates):Promise&lt;number&gt; ...@@ -1242,17 +1253,17 @@ delete(rdbPredicates: RdbPredicates):Promise&lt;number&gt;
| -------- | -------- | | -------- | -------- |
| Promise&lt;number&gt; | 指定Promise回调函数。返回受影响的行数。 | | Promise&lt;number&gt; | 指定Promise回调函数。返回受影响的行数。 |
**示例**： **示例：**
```js ```js
let predicatesdelete = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicatesdelete.equalTo("NAME", "Lisa") predicates.equalTo("NAME", "Lisa")
let promisedelete = rdbStore.delete(predicates) let promise = rdbStore.delete(predicates)
promisedelete.then((rows) => { promise.then((rows) => {
console.log("delete rows: " + rows) console.log("Delete rows: " + rows)
}).catch((err) => { }).catch((err) => {
console.log("delete err.") console.info("Delete failed, err: " + err)
}) })
``` ```
### query ### query
...@@ -1261,24 +1272,28 @@ query(rdbPredicates: RdbPredicates, columns: Array&lt;string&gt;, callback: Asyn ...@@ -1261,24 +1272,28 @@ query(rdbPredicates: RdbPredicates, columns: Array&lt;string&gt;, callback: Asyn
根据指定条件查询数据库中的数据，结果以callback形式返回。 根据指定条件查询数据库中的数据，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 | | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 |
| columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 | | columns | Array&lt;string&gt; | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
| callback | AsyncCallback&lt;[ResultSet](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | | callback | AsyncCallback&lt;[ResultSet](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose") predicates.equalTo("NAME", "Rose")
rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) { rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) {
console.log("resultSet column names:" + resultSet.columnNames) if (err) {
console.log("resultSet column count:" + resultSet.columnCount) console.info("Query failed, err: " + err)
}) return
``` }
console.log("resultSet column names:" + resultSet.columnNames)
console.log("resultSet column count:" + resultSet.columnCount)
})
```
### query ### query
...@@ -1287,9 +1302,9 @@ query(rdbPredicates: RdbPredicates, columns?: Array&lt;string&gt;):Promise&lt;Re ...@@ -1287,9 +1302,9 @@ query(rdbPredicates: RdbPredicates, columns?: Array&lt;string&gt;):Promise&lt;Re
根据指定条件查询数据库中的数据，结果以Promise形式返回。 根据指定条件查询数据库中的数据，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 | | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 |
...@@ -1300,16 +1315,16 @@ query(rdbPredicates: RdbPredicates, columns?: Array&lt;string&gt;):Promise&lt;Re ...@@ -1300,16 +1315,16 @@ query(rdbPredicates: RdbPredicates, columns?: Array&lt;string&gt;):Promise&lt;Re
| -------- | -------- | | -------- | -------- |
| Promise&lt;[ResultSet](../apis/js-apis-data-resultset.md)&gt; | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | | Promise&lt;[ResultSet](../apis/js-apis-data-resultset.md)&gt; | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 |
**示例**： **示例：**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose") predicates.equalTo("NAME", "Rose")
let promisequery = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promisequery.then((resultSet) => { promise.then((resultSet) => {
console.log("resultSet column names:" + resultSet.columnNames) console.log("resultSet column names:" + resultSet.columnNames)
console.log("resultSet column count:" + resultSet.columnCount) console.log("resultSet column count:" + resultSet.columnCount)
}).catch((err) => { }).catch((err) => {
console.log("query err.") console.info("Query failed, err: " + err)
}) })
``` ```
...@@ -1320,22 +1335,26 @@ querySql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback& ...@@ -1320,22 +1335,26 @@ querySql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&
根据指定SQL语句查询数据库中的数据，结果以callback形式返回。 根据指定SQL语句查询数据库中的数据，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 | | sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 | | bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 |
| callback | AsyncCallback&lt;[ResultSet](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | | callback | AsyncCallback&lt;[ResultSet](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
**示例**： **示例：**
```js ```js
rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) { rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) {
console.log("resultSet column names:" + resultSet.columnNames) if (err) {
console.log("resultSet column count:" + resultSet.columnCount) console.info("Query failed, err: " + err)
}) return
``` }
console.log("resultSet column names:" + resultSet.columnNames)
console.log("resultSet column count:" + resultSet.columnCount)
})
```
### querySql<sup>8+</sup> ### querySql<sup>8+</sup>
...@@ -1344,9 +1363,9 @@ querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt ...@@ -1344,9 +1363,9 @@ querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt
根据指定SQL语句查询数据库中的数据，结果以Promise形式返回。 根据指定SQL语句查询数据库中的数据，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 | | sql | string | 是 | 指定要执行的SQL语句。 |
...@@ -1357,16 +1376,16 @@ querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt ...@@ -1357,16 +1376,16 @@ querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt
| -------- | -------- | | -------- | -------- |
| Promise&lt;[ResultSet](../apis/js-apis-data-resultset.md)&gt; | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | | Promise&lt;[ResultSet](../apis/js-apis-data-resultset.md)&gt; | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 |
**示例**： **示例：**
```js ```js
let promisequerySql = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo']) let promise = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'])
promisequerySql.then((resultSet) => { promise.then((resultSet) => {
console.log("resultSet column names:" + resultSet.columnNames) console.log("resultSet column names:" + resultSet.columnNames)
console.log("resultSet column count:" + resultSet.columnCount) console.log("resultSet column count:" + resultSet.columnCount)
}).catch((err) => { }).catch((err) => {
console.log("querySql err.") console.info("Query failed, err: " + err)
}) })
``` ```
### executeSql ### executeSql
...@@ -1375,21 +1394,26 @@ executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallbac ...@@ -1375,21 +1394,26 @@ executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallbac
执行包含指定参数但不返回值的SQL语句，结果以callbck形式返回。 执行包含指定参数但不返回值的SQL语句，结果以callbck形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 | | sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 | | bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例**： **示例：**
```js ```js
rdbStore.executeSql("DELETE FROM EMPLOYEE", null, function () { 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)"
console.info('delete done.') rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) {
}) if (err) {
``` console.info("executeSql failed, err: " + err)
return
}
console.info('create table done.')
})
```
### executeSql ### executeSql
...@@ -1398,9 +1422,9 @@ executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt; ...@@ -1398,9 +1422,9 @@ executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt;
执行包含指定参数但不返回值的SQL语句，结果以Promise形式返回。 执行包含指定参数但不返回值的SQL语句，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 | | sql | string | 是 | 指定要执行的SQL语句。 |
...@@ -1411,15 +1435,16 @@ executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt; ...@@ -1411,15 +1435,16 @@ executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt;
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 指定Promise回调函数。 | | Promise&lt;void&gt; | 指定Promise回调函数。 |
**示例**： **示例：**
```js ```js
let promiseexecuteSql = rdbStore.executeSql("DELETE FROM EMPLOYEE") 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)"
promiseexecuteSql.then(() => { let promise = rdbStore.executeSql(SQL_CREATE_TABLE)
console.info('delete done.') promise.then(() => {
}).catch((err) => { console.info('create table done.')
console.log("executeSql err.") }).catch((err) => {
}) console.info("ExecuteSql failed, err: " + err)
``` })
```
### beginTransaction<sup>8+</sup> ### beginTransaction<sup>8+</sup>
...@@ -1427,21 +1452,25 @@ beginTransaction():void ...@@ -1427,21 +1452,25 @@ beginTransaction():void
在开始执行SQL语句之前，开始事务。 在开始执行SQL语句之前，开始事务。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**示例**： **示例：**
```js ```js
rdbStore.beginTransaction() rdbStore.beginTransaction()
const valueBucket = { const valueBucket = {
"name": "lisi", "name": "lisi",
"age": 18, "age": 18,
"salary": 100.5, "salary": 100.5,
"blobType": new Uint8Array([1, 2, 3]), "blobType": new Uint8Array([1, 2, 3]),
} }
rdbStore.insert("test", valueBucket, function (err, ret) { rdbStore.insert("test", valueBucket, function (err, ret) {
console.log("insert done: " + ret) if (err) {
}) console.info("Insert failed, err: " + err)
rdbStore.commit() return
}
console.log("Insert successfully: " + ret)
})
rdbStore.commit()
``` ```
...@@ -1451,22 +1480,26 @@ commit():void ...@@ -1451,22 +1480,26 @@ commit():void
提交已执行的SQL语句。 提交已执行的SQL语句。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**示例**： **示例：**
```js ```js
rdbStore.beginTransaction() rdbStore.beginTransaction()
const valueBucket = { const valueBucket = {
"name": "lisi", "name": "lisi",
"age": 18, "age": 18,
"salary": 100.5, "salary": 100.5,
"blobType": new Uint8Array([1, 2, 3]), "blobType": new Uint8Array([1, 2, 3]),
} }
rdbStore.insert("test", valueBucket, function (err, ret) { rdbStore.insert("test", valueBucket, function (err, ret) {
console.log("insert done: " + ret) if (err) {
}) console.info("Insert failed, err: " + err)
rdbStore.commit() return
}
console.log("Insert successfully: " + ret)
})
rdbStore.commit()
``` ```
...@@ -1476,26 +1509,30 @@ rollBack():void; ...@@ -1476,26 +1509,30 @@ rollBack():void;
回滚已经执行的SQL语句。 回滚已经执行的SQL语句。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**示例**： **示例：**
```js ```js
try { try {
rdbStore.beginTransaction() rdbStore.beginTransaction()
const valueBucket = { const valueBucket = {
"id": 1, "id": 1,
"name": "lisi", "name": "lisi",
"age": 18, "age": 18,
"salary": 100.5, "salary": 100.5,
"blobType": new Uint8Array([1, 2, 3]), "blobType": new Uint8Array([1, 2, 3]),
} }
rdbStore.insert("test", valueBucket, function (err, ret) { rdbStore.insert("test", valueBucket, function (err, ret) {
console.log("insert done: " + ret) if (err) {
}) console.info("Insert failed, err: " + err)
rdbStore.commit() return
} catch (e) { }
rdbStore.rollBack() console.log("Insert successfully: " + ret)
} })
rdbStore.commit()
} catch (e) {
rdbStore.rollBack()
}
``` ```
...@@ -1505,23 +1542,23 @@ setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;voi ...@@ -1505,23 +1542,23 @@ setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;voi
设置分布式列表，结果以callbck形式返回。 设置分布式列表，结果以callbck形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名 | | tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**示例**： **示例：**
```js ```js
rdbStore.setDistributedTables(["EMPLOYEE"], function (err) { rdbStore.setDistributedTables(["EMPLOYEE"], function (err) {
if (err) { if (err) {
console.info('setDistributedTables failed.') console.info('setDistributedTables failed, err: ' + err)
return return
} }
console.info('setDistributedTables success.') console.info('setDistributedTables successfully.')
}) })
``` ```
...@@ -1531,9 +1568,9 @@ setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;voi ...@@ -1531,9 +1568,9 @@ setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;voi
设置分布式列表，结果以Promise形式返回。 设置分布式列表，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名。 | | tables | Array&lt;string&gt; | 是 | 要设置的分布式列表表名。 |
...@@ -1543,15 +1580,15 @@ setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;voi ...@@ -1543,15 +1580,15 @@ setDistributedTables(tables: Array&lt;string&gt;, callback: AsyncCallback&lt;voi
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 指定Promise回调函数。 | | Promise&lt;void&gt; | 指定Promise回调函数。 |
**示例**： **示例：**
```js ```js
let promiseset = rdbStore.setDistributedTables(["EMPLOYEE"]) let promise = rdbStore.setDistributedTables(["EMPLOYEE"])
promiseset.then(() => { promise.then(() => {
console.info("setDistributedTables success.") console.info("setDistributedTables successfully.")
}).catch((err) => { }).catch((err) => {
console.info("setDistributedTables failed.") console.info("setDistributedTables failed, err: " + err)
}) })
``` ```
### obtainDistributedTableName<sup>8+</sup> ### obtainDistributedTableName<sup>8+</sup>
...@@ -1559,25 +1596,25 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac ...@@ -1559,25 +1596,25 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 结果以callbck形式返回。 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 结果以callbck形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| device | string | 是 | 远程设备 。| | device | string | 是 | 远程设备 。|
| table | string | 是 | 本地表名。 | | table | string | 是 | 本地表名。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。 | | callback | AsyncCallback&lt;string&gt; | 是 | 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。 |
**示例**： **示例：**
```js ```js
rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE", function (err, tableName) { rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE", function (err, tableName) {
if (err) { if (err) {
console.info('obtainDistributedTableName failed.') console.info('obtainDistributedTableName failed, err: ' + err)
return return
} }
console.info('obtainDistributedTableName success, tableName=.' + tableName) console.info('obtainDistributedTableName successfully, tableName=.' + tableName)
}) })
``` ```
### obtainDistributedTableName<sup>8+</sup> ### obtainDistributedTableName<sup>8+</sup>
...@@ -1586,9 +1623,9 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac ...@@ -1586,9 +1623,9 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，结果以Promise形式返回。 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| device | string | 是 | 远程设备。 | | device | string | 是 | 远程设备。 |
...@@ -1599,15 +1636,15 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac ...@@ -1599,15 +1636,15 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac
| -------- | -------- | | -------- | -------- |
| Promise&lt;string&gt; | 指定Promise回调函数。如果操作成功，返回远程设备的分布式表名。 | | Promise&lt;string&gt; | 指定Promise回调函数。如果操作成功，返回远程设备的分布式表名。 |
**示例**： **示例：**
```js ```js
let promiseDistr = rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE") let promise = rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE")
promiseDistr.then((tableName) => { promise.then((tableName) => {
console.info('obtainDistributedTableName success, tableName=' + tableName) console.info('obtainDistributedTableName successfully, tableName=' + tableName)
}).catch((err) => { }).catch((err) => {
console.info('obtainDistributedTableName failed.') console.info('obtainDistributedTableName failed, err: ' + err)
}) })
``` ```
### sync<sup>8+</sup> ### sync<sup>8+</sup>
...@@ -1615,30 +1652,30 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback&lt;Array ...@@ -1615,30 +1652,30 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback&lt;Array
在设备之间同步数据, 结果以callbck形式返回。 在设备之间同步数据, 结果以callbck形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 | | mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 |
| predicates | [RdbPredicates](#rdbpredicates) | 是 | 约束同步数据和设备。 | | predicates | [RdbPredicates](#rdbpredicates) | 是 | 约束同步数据和设备。 |
| callback | AsyncCallback&lt;Array&lt;[string, number]&gt;&gt; | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。| | callback | AsyncCallback&lt;Array&lt;[string, number]&gt;&gt; | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。|
**示例**： **示例：**
```js ```js
let predicate = new rdb.RdbPredicates('EMPLOYEE') let predicates = new rdb.RdbPredicates('EMPLOYEE')
predicate.inDevices(['12345678abcde']) predicates.inDevices(['12345678abcde'])
rdbStore.sync(rdb.SyncMode.SYNC_MODE_PUSH, predicate, function (err, result) { rdbStore.sync(rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) {
if (err) { if (err) {
console.log('sync failed') console.log('sync failed, err: ' + err)
return return
} }
console.log('sync done.') console.log('sync done.')
for (let i = 0; i < result.length; i++) { for (let i = 0; i < result.length; i++) {
console.log('device=' + result[i][0] + ' status=' + result[i][1]) console.log('device=' + result[i][0] + ' status=' + result[i][1])
} }
}) })
``` ```
### sync<sup>8+</sup> ### sync<sup>8+</sup>
...@@ -1647,9 +1684,9 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback&lt;Array ...@@ -1647,9 +1684,9 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback&lt;Array
在设备之间同步数据，结果以Promise形式返回。 在设备之间同步数据，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 | | mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 |
...@@ -1661,20 +1698,20 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback&lt;Array ...@@ -1661,20 +1698,20 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback&lt;Array
| -------- | -------- | | -------- | -------- |
| Promise&lt;Array&lt;[string, number]&gt;&gt; | 指定Promise回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | | Promise&lt;Array&lt;[string, number]&gt;&gt; | 指定Promise回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
**示例**： **示例：**
```js ```js
let predicatesync = new data_rdb.RdbPredicates('EMPLOYEE') let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicatesync.inDevices(['12345678abcde']) predicates.inDevices(['12345678abcde'])
let promisesync = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicatesync) let promise = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates)
promisesync.then((result) =>{ promise.then((result) =>{
console.log('sync done.') console.log('sync done.')
for (let i = 0; i < result.length; i++) { for (let i = 0; i < result.length; i++) {
console.log('device=' + result[i][0] + ' status=' + result[i][1]) console.log('device=' + result[i][0] + ' status=' + result[i][1])
} }
}).catch((err) => { }).catch((err) => {
console.log('sync failed') console.log('sync failed')
}) })
``` ```
### on('dataChange')<sup>8+</sup> ### on('dataChange')<sup>8+</sup>
...@@ -1682,9 +1719,9 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1682,9 +1719,9 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -1692,19 +1729,19 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1692,19 +1729,19 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
| type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 | | type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指分布式数据库中数据更改事件的观察者。 | | observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指分布式数据库中数据更改事件的观察者。 |
**示例**： **示例：**
```js ```js
function storeObserver(devices) { function storeObserver(devices) {
for (let i = 0; i < devices.length; i++) { for (let i = 0; i < devices.length; i++) {
console.log('device=' + devices[i] + ' data changed') console.log('device=' + devices[i] + ' data changed')
} }
} }
try { try {
rdbStore.on('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver) rdbStore.on('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) { } catch (err) {
console.log('register observer failed') console.log('register observer failed')
} }
``` ```
### off('dataChange')<sup>8+</sup> ### off('dataChange')<sup>8+</sup>
...@@ -1712,9 +1749,9 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1712,9 +1749,9 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
从数据库中删除指定类型的指定观察者, 结果以callbck形式返回。 从数据库中删除指定类型的指定观察者, 结果以callbck形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -1722,26 +1759,25 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1722,26 +1759,25 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
| type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 | | type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
| observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指已注册的数据更改观察者。| | observer | Callback&lt;Array&lt;string&gt;&gt; | 是 | 指已注册的数据更改观察者。|
**示例**： **示例：**
```js
```js function storeObserver(devices) {
function storeObserver(devices) { for (let i = 0; i < devices.length; i++) {
for (let i = 0; i < devices.length; i++) { console.log('device=' + devices[i] + ' data changed')
console.log('device=' + devices[i] + ' data changed') }
} }
} try {
try { rdbStore.off('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
rdbStore.off('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver) } catch (err) {
} catch (err) { console.log('unregister observer failed')
console.log('unregister observer failed') }
} ```
```
## StoreConfig ## StoreConfig
管理关系数据库配置。 管理关系数据库配置。
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -1752,7 +1788,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1752,7 +1788,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
用于表示允许的数据字段类型。 用于表示允许的数据字段类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。
| 名称 | 说明 | | 名称 | 说明 |
| -------- | -------- | | -------- | -------- |
...@@ -1765,7 +1801,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1765,7 +1801,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
用于存储键值对。 用于存储键值对。
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -1776,7 +1812,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1776,7 +1812,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
指数据库同步模式。 指数据库同步模式。
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | ----- |----- | | -------- | ----- |----- |
...@@ -1787,7 +1823,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1787,7 +1823,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
描述订阅类型。 描述订阅类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | ----- |---- | | -------- | ----- |---- |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或