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 d0414628341efd0be5eb8772fc11720930afdbda..cb4914c087972a8e0ddfb6dcc2a400dcc8ae8826 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 @@ -11,9 +11,75 @@ import data_rdb from '@ohos.data.rdb'; ``` +## data_rdb.getRdbStore + +getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void + +获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。 + +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| 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(STORE_CONFIG, 1, function (err, rdbStore) { + rdbStore.executeSql(SQL_CREATE_TABLE, null, function() { + console.info('create table done.') + }) +}) +``` ## data_rdb.getRdbStore +getRdbStore(config: StoreConfig, version: number): Promise<RdbStore> + +获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。 + +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | +| version | number | 是 | 数据库版本。 | + +**返回值**： + +| 类型 | 说明 | +| -------- | -------- | +| 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.") + }) +}).catch((err) => { + console.log("getRdbStore err.") +}) +``` + + +## data_rdb.getRdbStore8+ + getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。 @@ -24,7 +90,7 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context8+ | Context | 是 | 应用程序或功能的上下文 | +| 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。 | @@ -32,16 +98,16 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As **示例**： ```js -import data_rdb from '@ohos.data.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) - console.info('create table done.') +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.getRdbStore +## data_rdb.getRdbStore8+ getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> @@ -53,7 +119,7 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise< | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context8+ | Context | 是 | 应用程序或功能的上下文 | +| 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 | 是 | 数据库版本。 | @@ -66,10 +132,9 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise< **示例**： ```js -import data_rdb from '@ohos.data.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)" -let promisegetRdb = data_rdb.getRdbStore(STORE_CONFIG, 1); +let promisegetRdb = data_rdb.getRdbStore(this.context, STORE_CONFIG, 1); promisegetRdb.then(async (rdbStore) => { let promiseExecSql = rdbStore.executeSql(SQL_CREATE_TABLE, null) promiseExecSql.then(() => { @@ -84,7 +149,7 @@ promisegetRdb.then(async (rdbStore) => { ## data_rdb.deleteRdbStore -deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void +deleteRdbStore(name: string, callback: AsyncCallback<void>): void 删除数据库，结果以callback形式返回。 @@ -93,19 +158,66 @@ deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void&g **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context8+ | Context | 是 | 应用程序或功能的上下文 | | name | string | 是 | 数据库名称。 | | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例**： ```js - import data_rdb from '@ohos.data.rdb' data_rdb.deleteRdbStore("RdbTest.db", function (err, rdbStore) { console.info('delete store done.') }) ``` + ## data_rdb.deleteRdbStore -## data_rdb.deleteRdbStore +deleteRdbStore(name: string): Promise<void> + +使用指定的数据库文件配置删除数据库，结果以Promise形式返回。 + +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + +**参数** +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| name | string | 是 | 数据库名称。 | + +**返回值**： +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 指定Promise回调函数。 | + +**示例**： + ```js + let promisedeleteRdb = data_rdb.deleteRdbStore("RdbTest.db") + promisedeleteRdb.then(()=>{ + console.info('delete store done.') + }).catch((err) => { + console.log("deleteRdbStore err.") + }) + ``` + +## data_rdb.deleteRdbStore8+ + +deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void + +删除数据库，结果以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 | 是 | 数据库名称。 | +| callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | + +**示例**： + ```js + data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) { + console.info('delete store done.') + }) + ``` + +## data_rdb.deleteRdbStore8+ deleteRdbStore(context: Context, name: string): Promise<void> @@ -116,7 +228,7 @@ deleteRdbStore(context: Context, name: string): Promise<void> **参数** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| context8+ | Context | 是 | 应用程序或功能的上下文 | +| context8+ | Context | 是 | 应用程序或功能的上下文
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-ability-context.md)。| | name | string | 是 | 数据库名称。 | **返回值**： @@ -126,7 +238,6 @@ deleteRdbStore(context: Context, name: string): Promise<void> **示例**： ```js - import data_rdb from '@ohos.data.rdb' let promisedeleteRdb = data_rdb.deleteRdbStore("RdbTest.db") promisedeleteRdb.then(()=>{ console.info('delete store done.') @@ -135,6 +246,7 @@ deleteRdbStore(context: Context, name: string): Promise<void> }) ``` + ## RdbPredicates 表示关系型数据库（RDB）的谓词。该类确定RDB中条件表达式的值是true还是false。 @@ -181,7 +293,7 @@ inDevices(devices: Array<string>): RdbPredicates **示例**： ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") - predicate.inDevices(['12345678abcde']) + predicates.inDevices(['12345678abcde']) ``` ### inAllDevices8+ @@ -1045,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)}) ``` @@ -1080,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.") }) @@ -1584,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 { @@ -1615,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 {