From 24596bac0ba24648dfaec81b336ae34bb93c81c0 Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Mon, 14 Feb 2022 18:21:12 +0800 Subject: [PATCH 1/2] Signed-off-by: test <1029079951@qq.com> Changes to be committed: modified: js-apis-data-ability.md modified: js-apis-data-rdb.md modified: js-apis-data-resultset.md modified: js-apis-data-storage.md modified: js-apis-distributed-data.md --- .../reference/apis/js-apis-data-ability.md | 2 + .../reference/apis/js-apis-data-rdb.md | 160 +++++++++--------- .../reference/apis/js-apis-data-resultset.md | 2 + .../reference/apis/js-apis-data-storage.md | 3 + .../apis/js-apis-distributed-data.md | 3 + 5 files changed, 86 insertions(+), 84 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md index 7b82a0b98d1..c6aaa70183f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md @@ -10,6 +10,8 @@ import dataAbility from '@ohos.data.dataAbility' ``` +## 系统能力 +SystemCapability.DistributedDataManager.DataShare.Consumer ## 权限 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 225abf90184..a0adcbae489 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,53 +7,52 @@ ## 导入模块 ``` -import data_rdb from '@ohos.data.rdb' +import dataRdb from '@ohos.data.rdb' ``` +## 系统能力 +SystemCapability.DistributedDataManager.RelationalStore.Core + ## 权限 无 -## data_rdb.getRdbStore +## dataRdb.getRdbStore -getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void +getRdbStore(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 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.') - }) - } + 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.') + }) ``` -## data_rdb.getRdbStore -getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> +## dataRdb.getRdbStore + +getRdbStore(config: StoreConfig, version: number): Promise<RdbStore> 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以Promise形式返回。 - 参数: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | Context | 是 | 应用程序或功能的上下文 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | version | number | 是 | 数据库版本。 | @@ -64,53 +63,47 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise< - 示例: ``` - 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(); - }) - } + 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(); + }) ``` -## data_rdb.deleteRdbStore -deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void +## dataRdb.deleteRdbStore + +deleteRdbStore(name: string, callback: AsyncCallback<void>): void 删除数据库,结果以callback形式返回。 - 参数: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | Context | 是 | 应用程序或功能的上下文 | | name | string | 是 | 数据库名称。 | | callback | AsyncCallback<void> | 是 | 指定callback回调函数。如果数据库已删除,则为true;否则返回false。 | - 示例: ``` - 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.')}) - } + import dataRdb from '@ohos.data.rdb' + dataRdb.deleteRdbStore("RdbTest.db", function (err, rdbStore) { + console.info(TAG + 'delete store done.')}) ``` -## data_rdb.deleteRdbStore -deleteRdbStore(context: Context, name: string): Promise<void> +## dataRdb.deleteRdbStore + +deleteRdbStore(name: string): Promise<void> 使用指定的数据库文件配置删除数据库,结果以Promise形式返回。 - 参数: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | Context | 是 | 应用程序或功能的上下文 | | name | string | 是 | 数据库名称。 | - 返回值: @@ -120,16 +113,14 @@ deleteRdbStore(context: Context, name: string): Promise<void> - 示例: ``` - 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.') - }) - } + import dataRdb from '@ohos.data.rdb' + let promise = dataRdb.deleteRdbStore("RdbTest.db") + promise.then(()=>{ + console.info(TAG + 'delete store done.') + }) ``` + ## RdbPredicates 表示关系型数据库(RDB)的谓词。该类确定RDB中条件表达式的值是true还是false。 @@ -150,7 +141,8 @@ constructor(name: string) - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + import dataRdb from '@ohos.data.rdb' + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") ``` @@ -175,7 +167,7 @@ equalTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") ``` @@ -201,7 +193,7 @@ notEqualTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.notEqualTo("NAME", "lisi") ``` @@ -221,7 +213,7 @@ beginWrap(): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") .beginWrap() .equalTo("AGE", 18) @@ -246,7 +238,7 @@ endWrap(): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") .beginWrap() .equalTo("AGE", 18) @@ -271,7 +263,7 @@ or(): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") .or() .equalTo("NAME", "Rose") @@ -293,7 +285,7 @@ and(): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") .and() .equalTo("SALARY", 200.5) @@ -321,7 +313,7 @@ contains(field: string, value: string): RdbPredicat - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.contains("NAME", "os") ``` @@ -347,7 +339,7 @@ beginsWith(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.beginsWith("NAME", "os") ``` @@ -373,7 +365,7 @@ endsWith(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.endsWith("NAME", "se") ``` @@ -398,7 +390,7 @@ isNull(field: string): RdbPredicates - 示例 ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.isNull("NAME") ``` @@ -423,7 +415,7 @@ isNotNull(field: string): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.isNotNull("NAME") ``` @@ -449,7 +441,7 @@ like(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.like("NAME", "%os%") ``` @@ -475,7 +467,7 @@ glob(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.glob("NAME", "?h*g") ``` @@ -502,7 +494,7 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.between("AGE", 10, 50) ``` @@ -529,7 +521,7 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.notBetween("AGE", 10, 50) ``` @@ -555,7 +547,7 @@ greaterThan(field: string, value: ValueType): RdbPredicatesgr - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.greaterThan("AGE", 18) ``` @@ -581,7 +573,7 @@ lessThan(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.lessThan("AGE", 20) ``` @@ -608,7 +600,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.greaterThanOrEqualTo("AGE", 18) ``` @@ -635,7 +627,7 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.lessThanOrEqualTo("AGE", 20) ``` @@ -661,7 +653,7 @@ orderByAsc(field: string): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.orderByAsc("NAME") ``` @@ -687,7 +679,7 @@ orderByDesc(field: string): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.orderByDesc("AGE") ``` @@ -707,7 +699,7 @@ distinct(): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").distinct("NAME") let resultSet = await rdbStore.query(predicates, ["NAME"]) ``` @@ -733,7 +725,7 @@ limitAs(value: number): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").limitAs(3) ``` @@ -758,7 +750,7 @@ offsetAs(rowOffset: number): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").offsetAs(3) ``` @@ -783,7 +775,7 @@ groupBy(fields: Array<string>): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.groupBy(["AGE", "NAME"]) ``` @@ -808,7 +800,7 @@ indexedBy(indexName: string): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.indexedBy("SALARY_INDEX") ``` @@ -835,7 +827,7 @@ in(field: string, value: Array<ValueType>): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.in("AGE", [18, 20]) ``` @@ -862,7 +854,7 @@ notIn(field: string, value: Array<ValueType>): RdbPredicates - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.notIn("NAME", ["Lisa", "Rose"]) ``` @@ -952,7 +944,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba "SALARY": 200.5, "CODES": new Uint8Array([1, 2, 3, 4, 5]), } - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") rdbStore.update(valueBucket, predicates, function (err, ret) { console.log(TAG + "updated row count: " + changedRows)}) @@ -984,7 +976,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise<number> "SALARY": 200.5, "CODES": new Uint8Array([1, 2, 3, 4, 5]), } - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") let promise = rdbStore.update(valueBucket, predicates) promise.then(async (ret) => { @@ -1009,7 +1001,7 @@ delete(rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") rdbStore.delete(predicates, function (err, rows) { console.log(TAG + "delete rows: " + rows)}) @@ -1034,7 +1026,7 @@ delete(rdbPredicates: RdbPredicates):Promise<number> - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") let promise = rdbStore.delete(predicates) promise.then((rows) => { @@ -1058,7 +1050,7 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>, callback: Asyn - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.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) @@ -1085,7 +1077,7 @@ query(rdbPredicates: RdbPredicates, columns?: Array<string>):Promise<Re - 示例: ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") + let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) promise.then((resultSet) => { diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md index b2bd32db35f..d2f4faabdce 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md @@ -3,6 +3,8 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +## 系统能力 +SystemCapability.DistributedDataManager.RelationalStore.Core ## 使用说明 diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md index 37f09d0cbf1..9cb3b9343b1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md @@ -13,6 +13,9 @@ import dataStorage from '@ohos.data.storage' ``` +## 系统能力 +SystemCapability.DistributedDataManager.Preference.Core + ## 权限 diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index 8c11ab5057b..1b19878734e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -3,6 +3,9 @@ >![](../../public_sys-resources/icon-note.gif) **说明:** >本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +## 系统能力 +SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + ## 导入模块 ``` -- Gitee From 73eb346d5ccba987f8167c9530e410edeefc1a58 Mon Sep 17 00:00:00 2001 From: test <1029079951@qq.com> Date: Mon, 14 Feb 2022 18:33:07 +0800 Subject: [PATCH 2/2] Signed-off-by: test <1029079951@qq.com> Changes to be committed: modified: js-apis-data-rdb.md --- .../reference/apis/js-apis-data-rdb.md | 162 ++++++++++-------- 1 file changed, 86 insertions(+), 76 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 a0adcbae489..5cdaa16d6c1 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 @@ -3,56 +3,59 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +## 系统能力 +SystemCapability.DistributedDataManager.RelationalStore.Core ## 导入模块 ``` -import dataRdb from '@ohos.data.rdb' +import data_rdb from '@ohos.data.rdb' ``` -## 系统能力 -SystemCapability.DistributedDataManager.RelationalStore.Core - ## 权限 无 -## 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 | 是 | 数据库版本。 | @@ -63,47 +66,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 | 是 | 数据库名称。 | - 返回值: @@ -113,14 +122,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。 @@ -141,8 +152,7 @@ constructor(name: string) - 示例: ``` - import dataRdb from '@ohos.data.rdb' - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") ``` @@ -167,7 +177,7 @@ equalTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") ``` @@ -193,7 +203,7 @@ notEqualTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notEqualTo("NAME", "lisi") ``` @@ -213,7 +223,7 @@ beginWrap(): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") .beginWrap() .equalTo("AGE", 18) @@ -238,7 +248,7 @@ endWrap(): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") .beginWrap() .equalTo("AGE", 18) @@ -263,7 +273,7 @@ or(): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") .or() .equalTo("NAME", "Rose") @@ -285,7 +295,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) @@ -313,7 +323,7 @@ contains(field: string, value: string): RdbPredicat - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.contains("NAME", "os") ``` @@ -339,7 +349,7 @@ beginsWith(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.beginsWith("NAME", "os") ``` @@ -365,7 +375,7 @@ endsWith(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.endsWith("NAME", "se") ``` @@ -390,7 +400,7 @@ isNull(field: string): RdbPredicates - 示例 ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNull("NAME") ``` @@ -415,7 +425,7 @@ isNotNull(field: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNotNull("NAME") ``` @@ -441,7 +451,7 @@ like(field: string, value: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.like("NAME", "%os%") ``` @@ -467,7 +477,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") ``` @@ -494,7 +504,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) ``` @@ -521,7 +531,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) ``` @@ -547,7 +557,7 @@ greaterThan(field: string, value: ValueType): RdbPredicatesgr - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThan("AGE", 18) ``` @@ -573,7 +583,7 @@ lessThan(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThan("AGE", 20) ``` @@ -600,7 +610,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThanOrEqualTo("AGE", 18) ``` @@ -627,7 +637,7 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThanOrEqualTo("AGE", 20) ``` @@ -653,7 +663,7 @@ orderByAsc(field: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByAsc("NAME") ``` @@ -679,7 +689,7 @@ orderByDesc(field: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByDesc("AGE") ``` @@ -699,7 +709,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"]) ``` @@ -725,7 +735,7 @@ limitAs(value: number): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").limitAs(3) ``` @@ -750,7 +760,7 @@ offsetAs(rowOffset: number): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").offsetAs(3) ``` @@ -775,7 +785,7 @@ groupBy(fields: Array<string>): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.groupBy(["AGE", "NAME"]) ``` @@ -800,7 +810,7 @@ indexedBy(indexName: string): RdbPredicates - 示例: ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") + let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.indexedBy("SALARY_INDEX") ``` @@ -827,7 +837,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]) ``` @@ -854,7 +864,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"]) ``` @@ -944,7 +954,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)}) @@ -976,7 +986,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) => { @@ -1001,7 +1011,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)}) @@ -1026,7 +1036,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) => { @@ -1050,7 +1060,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) @@ -1077,7 +1087,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) => { -- Gitee