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