From e685989545c4dd9ead746a00f4f26137dc6e9128 Mon Sep 17 00:00:00 2001 From: wuyongning Date: Thu, 12 May 2022 09:43:01 +0800 Subject: [PATCH] update js-apis-data-rdb.md Signed-off-by: wuyongning --- .../reference/apis/js-apis-data-rdb.md | 184 ++++++------------ 1 file changed, 58 insertions(+), 126 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 cdffc89e36..cb4914c087 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 @@ -33,59 +33,11 @@ getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback<Rdb 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, funtion() { + rdbStore.executeSql(SQL_CREATE_TABLE, null, function() { console.info('create table done.') }) }) ``` - - -## data_rdb.getRdbStore8+ - -getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void - -获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。 - -**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - -**参数**： - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| context8+ | Context | 是 | 应用程序或功能的上下文
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-service-extension-context.md)。| -| config | [StoreConfig](#storeconfig) | 是 | 与此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(this.context, STORE_CONFIG, 1, function (err, rdbStore) { - rdbStore.executeSql(SQL_CREATE_TABLE, null, funtion() { - console.info('create table done.') - }) -}) -``` - -<<<<<<< HEAD -======= -API 9的示例请参考如下代码： - -```ts -export default class MainAbility extends Ability { - 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, funtion() { - console.info('create table done.') - }) - }) -} -``` - ->>>>>>> 07c8f8b4 (modify js-apis-data-rdb.md) ## data_rdb.getRdbStore getRdbStore(config: StoreConfig, version: number): Promise<RdbStore> @@ -125,8 +77,36 @@ promisegetRdb.then(async (rdbStore) => { }) ``` -<<<<<<< HEAD -======= + +## data_rdb.getRdbStore8+ + +getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void + +获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。 + +**系统能力**：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)。| +| config | [StoreConfig](#storeconfig) | 是 | 与此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(this.context, STORE_CONFIG, 1, function (err, rdbStore) { + rdbStore.executeSql(SQL_CREATE_TABLE, null, function() { + console.info('create table done.') + }) +}) +``` + ## data_rdb.getRdbStore8+ getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> @@ -139,7 +119,7 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise< | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context8+ | Context | 是 | 应用程序或功能的上下文
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-service-extension-context.md)。 | +| context8+ | Context | 是 | 应用程序或功能的上下文
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-ability-context.md)。 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | version | number | 是 | 数据库版本。 | @@ -167,26 +147,6 @@ promisegetRdb.then(async (rdbStore) => { }) ``` -API 9的示例请参考如下代码： - -```ts -export default class MainAbility extends Ability { - 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.") - }) - }).catch((err) => { - console.log("getRdbStore err.") - }) -} -``` ->>>>>>> 07c8f8b4 (modify js-apis-data-rdb.md) ## data_rdb.deleteRdbStore deleteRdbStore(name: string, callback: AsyncCallback<void>): void @@ -207,66 +167,53 @@ deleteRdbStore(name: string, callback: AsyncCallback<void>): void console.info('delete store done.') }) ``` + ## data_rdb.deleteRdbStore -## data_rdb.deleteRdbStore8+ - -deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void +deleteRdbStore(name: string): Promise<void> -删除数据库，结果以callback形式返回。 +使用指定的数据库文件配置删除数据库，结果以Promise形式返回。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 -**参数**： +**参数** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context8+ | Context | 是 | 应用程序或功能的上下文
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-service-extension-context.md)。| | name | string | 是 | 数据库名称。 | -| callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | + +**返回值**： +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 指定Promise回调函数。 | **示例**： ```js - data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) { + let promisedeleteRdb = data_rdb.deleteRdbStore("RdbTest.db") + promisedeleteRdb.then(()=>{ console.info('delete store done.') + }).catch((err) => { + console.log("deleteRdbStore err.") }) ``` -<<<<<<< HEAD -======= -API 9的示例请参考如下代码： - -```ts -export default class MainAbility extends Ability { - data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) { - console.info('delete store done.') - }) -} -``` ->>>>>>> 07c8f8b4 (modify js-apis-data-rdb.md) -## data_rdb.deleteRdbStore +## data_rdb.deleteRdbStore8+ -deleteRdbStore(name: string): Promise<void> +deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void -使用指定的数据库文件配置删除数据库，结果以Promise形式返回。 +删除数据库，结果以callback形式返回。 **系统能力**：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 | 是 | 数据库名称。 | - -**返回值**： -| 类型 | 说明 | -| -------- | -------- | -| Promise<void> | 指定Promise回调函数。 | +| callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例**： ```js - let promisedeleteRdb = data_rdb.deleteRdbStore("RdbTest.db") - promisedeleteRdb.then(()=>{ + data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) { console.info('delete store done.') - }).catch((err) => { - console.log("deleteRdbStore err.") }) ``` @@ -281,7 +228,7 @@ deleteRdbStore(context: Context, name: string): Promise<void> **参数** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context8+ | Context | 是 | 应用程序或功能的上下文
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-service-extension-context.md)。| +| context8+ | Context | 是 | 应用程序或功能的上下文
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-ability-context.md)。| | name | string | 是 | 数据库名称。 | **返回值**： @@ -299,22 +246,7 @@ deleteRdbStore(context: Context, name: string): Promise<void> }) ``` -<<<<<<< HEAD -======= -API 9的示例请参考如下代码： -```ts -export default class MainAbility extends Ability { - let promisedeleteRdb = data_rdb.deleteRdbStore(this.context, "RdbTest.db") - promisedeleteRdb.then(()=>{ - console.info('delete store done.') - }).catch((err) => { - console.log("deleteRdbStore err.") - }) -} -``` - ->>>>>>> 07c8f8b4 (modify js-apis-data-rdb.md) ## RdbPredicates 表示关系型数据库（RDB）的谓词。该类确定RDB中条件表达式的值是true还是false。 @@ -361,7 +293,7 @@ inDevices(devices: Array<string>): RdbPredicates **示例**： ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") - predicate.inDevices(['12345678abcde']) + predicates.inDevices(['12345678abcde']) ``` ### inAllDevices8+ @@ -1225,7 +1157,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") rdbStore.update(valueBucket, predicates, function (err, ret) { - console.log("updated row count: " + changedRows)}) + console.log("updated row count: " + ret)}) ``` @@ -1260,7 +1192,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise<number> predicates.equalTo("NAME", "Lisa") let promiseupdate = rdbStore.update(valueBucket, predicates) promiseupdate.then(async (ret) => { - console.log("updated row count: " + changedRows) + console.log("updated row count: " + ret) }).catch((err) => { console.log("update err.") }) @@ -1764,7 +1696,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<stri ```js function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { - console.log('device=' + device[i] + ' data changed') + console.log('device=' + devices[i] + ' data changed') } } try { @@ -1795,7 +1727,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback<Array<stri ```js function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { - console.log('device=' + device[i] + ' data changed') + console.log('device=' + devices[i] + ' data changed') } } try { -- GitLab