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 44c6e7089da9a60bd84c70afd3d4278222343a43..225abf901842e29a4657c3d6462040c9d4729f66 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 @@ -7,7 +7,7 @@ ## 导入模块 ``` -import dataRdb from '@ohos.data.rdb' +import data_rdb from '@ohos.data.rdb' ``` @@ -16,40 +16,44 @@ import dataRdb from '@ohos.data.rdb' 无 -## dataRdb.getRdbStore +## data_rdb.getRdbStore -getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void +getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以callback形式返回。 - 参数: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | + | context | Context | 是 | 应用程序或功能的上下文 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | version | number | 是 | 数据库版本。 | | callback | AsyncCallback<[RdbStore](#rdbstore)> | 是 | 指定callback回调函数。返回一个RdbStore。 | - 示例: ``` - import dataRdb 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)" - dataRdb.getRdbStore(STORE_CONFIG, 1, function (err, rdbStore) { - rdbStore.executeSql(SQL_CREATE_TABLE) - console.info(TAG + 'create table done.') - }) + import Ability from '@ohos.application.Ability' + import data_rdb from '@ohos.data.rdb' + 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) + console.info(TAG + 'create table done.') + }) + } ``` +## data_rdb.getRdbStore -## dataRdb.getRdbStore - -getRdbStore(config: StoreConfig, version: number): Promise<RdbStore> +getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以Promise形式返回。 - 参数: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | + | context | Context | 是 | 应用程序或功能的上下文 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | version | number | 是 | 数据库版本。 | @@ -60,47 +64,53 @@ getRdbStore(config: StoreConfig, version: number): Promise<RdbStore> - 示例: ``` - import dataRdb 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 promise = dataRdb.getRdbStore(STORE_CONFIG, 1); - promise.then(async (rdbStore) => { - await rdbStore.executeSql(SQL_CREATE_TABLE, null) - }).catch((err) => { - expect(null).assertFail(); - }) + import Ability from '@ohos.application.Ability' + import data_rdb from '@ohos.data.rdb' + 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 promise = data_rdb.getRdbStore(this.context, STORE_CONFIG, 1); + promise.then(async (rdbStore) => { + await rdbStore.executeSql(SQL_CREATE_TABLE, null) + }).catch((err) => { + expect(null).assertFail(); + }) + } ``` +## data_rdb.deleteRdbStore -## dataRdb.deleteRdbStore - -deleteRdbStore(name: string, callback: AsyncCallback<void>): void +deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void 删除数据库,结果以callback形式返回。 - 参数: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | + | context | Context | 是 | 应用程序或功能的上下文 | | name | string | 是 | 数据库名称。 | | callback | AsyncCallback<void> | 是 | 指定callback回调函数。如果数据库已删除,则为true;否则返回false。 | - 示例: ``` - import dataRdb from '@ohos.data.rdb' - dataRdb.deleteRdbStore("RdbTest.db", function (err, rdbStore) { - console.info(TAG + 'delete store done.')}) + import Ability from '@ohos.application.Ability' + import data_rdb from '@ohos.data.rdb' + export default class MainAbility extends Ability { + data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) { + console.info(TAG + 'delete store done.')}) + } ``` +## data_rdb.deleteRdbStore -## dataRdb.deleteRdbStore - -deleteRdbStore(name: string): Promise<void> +deleteRdbStore(context: Context, name: string): Promise<void> 使用指定的数据库文件配置删除数据库,结果以Promise形式返回。 - 参数: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | + | context | Context | 是 | 应用程序或功能的上下文 | | name | string | 是 | 数据库名称。 | - 返回值: @@ -110,14 +120,16 @@ deleteRdbStore(name: string): Promise<void> - 示例: ``` - import dataRdb from '@ohos.data.rdb' - let promise = dataRdb.deleteRdbStore("RdbTest.db") - promise.then(()=>{ - console.info(TAG + 'delete store done.') - }) + import Ability from '@ohos.application.Ability' + import data_rdb from '@ohos.data.rdb' + export default class MainAbility extends Ability { + let promise = data_rdb.deleteRdbStore(this.context, "RdbTest.db") + promise.then(()=>{ + console.info(TAG + 'delete store done.') + }) + } ``` - ## RdbPredicates 表示关系型数据库(RDB)的谓词。该类确定RDB中条件表达式的值是true还是false。 @@ -138,8 +150,7 @@ constructor(name: string) - 示例: ``` - import dataRdb from '@ohos.data.rdb' - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") ``` @@ -164,7 +175,7 @@ equalTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") ``` @@ -190,7 +201,7 @@ notEqualTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notEqualTo("NAME", "lisi") ``` @@ -210,7 +221,7 @@ beginWrap(): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") .beginWrap() .equalTo("AGE", 18) @@ -235,7 +246,7 @@ endWrap(): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") .beginWrap() .equalTo("AGE", 18) @@ -260,7 +271,7 @@ or(): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") .or() .equalTo("NAME", "Rose") @@ -282,7 +293,7 @@ and(): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") .and() .equalTo("SALARY", 200.5) @@ -310,7 +321,7 @@ contains(field: string, value: string): RdbPredicat - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.contains("NAME", "os") ``` @@ -336,7 +347,7 @@ beginsWith(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.beginsWith("NAME", "os") ``` @@ -362,7 +373,7 @@ endsWith(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.endsWith("NAME", "se") ``` @@ -387,7 +398,7 @@ isNull(field: string): RdbPredicates - 示例 ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNull("NAME") ``` @@ -412,7 +423,7 @@ isNotNull(field: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNotNull("NAME") ``` @@ -438,7 +449,7 @@ like(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.like("NAME", "%os%") ``` @@ -464,7 +475,7 @@ glob(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.glob("NAME", "?h*g") ``` @@ -491,7 +502,7 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.between("AGE", 10, 50) ``` @@ -518,7 +529,7 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notBetween("AGE", 10, 50) ``` @@ -544,7 +555,7 @@ greaterThan(field: string, value: ValueType): RdbPredicatesgr - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThan("AGE", 18) ``` @@ -570,7 +581,7 @@ lessThan(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThan("AGE", 20) ``` @@ -597,7 +608,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThanOrEqualTo("AGE", 18) ``` @@ -624,7 +635,7 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThanOrEqualTo("AGE", 20) ``` @@ -650,7 +661,7 @@ orderByAsc(field: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByAsc("NAME") ``` @@ -676,7 +687,7 @@ orderByDesc(field: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByDesc("AGE") ``` @@ -696,7 +707,7 @@ distinct(): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").distinct("NAME") let resultSet = await rdbStore.query(predicates, ["NAME"]) ``` @@ -722,7 +733,7 @@ limitAs(value: number): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").limitAs(3) ``` @@ -747,7 +758,7 @@ offsetAs(rowOffset: number): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").offsetAs(3) ``` @@ -772,7 +783,7 @@ groupBy(fields: Array<string>): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.groupBy(["AGE", "NAME"]) ``` @@ -797,7 +808,7 @@ indexedBy(indexName: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.indexedBy("SALARY_INDEX") ``` @@ -824,7 +835,7 @@ in(field: string, value: Array<ValueType>): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.in("AGE", [18, 20]) ``` @@ -851,7 +862,7 @@ notIn(field: string, value: Array<ValueType>): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notIn("NAME", ["Lisa", "Rose"]) ``` @@ -941,7 +952,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba "SALARY": 200.5, "CODES": new Uint8Array([1, 2, 3, 4, 5]), } - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") rdbStore.update(valueBucket, predicates, function (err, ret) { console.log(TAG + "updated row count: " + changedRows)}) @@ -973,7 +984,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise<number> "SALARY": 200.5, "CODES": new Uint8Array([1, 2, 3, 4, 5]), } - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") let promise = rdbStore.update(valueBucket, predicates) promise.then(async (ret) => { @@ -998,7 +1009,7 @@ delete(rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") rdbStore.delete(predicates, function (err, rows) { console.log(TAG + "delete rows: " + rows)}) @@ -1023,7 +1034,7 @@ delete(rdbPredicates: RdbPredicates):Promise<number> - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") let promise = rdbStore.delete(predicates) promise.then((rows) => { @@ -1047,7 +1058,7 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>, callback: Asyn - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) { console.log(TAG + "resultSet column names:" + resultSet.columnNames) @@ -1074,7 +1085,7 @@ query(rdbPredicates: RdbPredicates, columns?: Array<string>):Promise<Re - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) promise.then((resultSet) => {