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 17e52943c575e27b926dc167780a3cfe86534bd6..d05356f6b88de18d41f2794dbedeb6e2a3a45f2f 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,10 +10,6 @@ import dataAbility from '@ohos.data.dataAbility' ``` -## 系统能力 -SystemCapability.DistributedDataManager.DataShare.Core - - ## dataAbility.createRdbPredicates @@ -23,6 +19,7 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): 从DataAabilityPredicates对象创建RdbPredicates对象。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -56,6 +53,7 @@ equalTo(field: string, value: ValueType): DataAbilityPredicates 配置谓词以匹配数据类型为ValueType且值等于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -83,6 +81,7 @@ notEqualTo(field: string, value: ValueType): DataAbilityPredicates 配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -110,6 +109,7 @@ beginWrap(): DataAbilityPredicates 向谓词添加左括号。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 返回值： | 类型 | 说明 | @@ -136,6 +136,7 @@ endWrap(): DataAbilityPredicates 向谓词添加右括号。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 返回值： | 类型 | 说明 | @@ -162,6 +163,7 @@ or(): DataAbilityPredicates 将或条件添加到谓词中。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 返回值： | 类型 | 说明 | @@ -185,6 +187,7 @@ and(): DataAbilityPredicates 向谓词添加和条件。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 返回值： | 类型 | 说明 | @@ -208,6 +211,7 @@ contains(field: string, value: string): DataAbilityPredicates 配置谓词以匹配数据类型为String且value包含指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -235,6 +239,7 @@ beginsWith(field: string, value: string): DataAbilityPredicates 配置谓词以匹配数据类型为String且值以指定字符串开头的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -262,6 +267,7 @@ endsWith(field: string, value: string): DataAbilityPredicates 配置谓词以匹配数据类型为String且值以指定字符串结尾的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -289,6 +295,7 @@ isNull(field: string): DataAbilityPredicates 配置谓词以匹配值为null的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -315,6 +322,7 @@ isNotNull(field: string): DataAbilityPredicates 配置谓词以匹配值不为null的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -341,6 +349,7 @@ like(field: string, value: string): DataAbilityPredicates 配置谓词以匹配数据类型为string且值类似于指定字符串的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -368,6 +377,7 @@ glob(field: string, value: string): DataAbilityPredicates 配置谓词匹配数据类型为string的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -395,6 +405,7 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates 将谓词配置为匹配数据类型为ValueType且value在指定范围内的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -423,6 +434,7 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate 配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -451,6 +463,7 @@ greaterThan(field: string, value: ValueType): DataAbilityPredicates 配置谓词以匹配数据类型为ValueType且值大于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -478,6 +491,7 @@ lessThan(field: string, value: ValueType): DataAbilityPredicates 配置谓词以匹配数据类型为valueType且value小于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -505,6 +519,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates 配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -532,6 +547,7 @@ lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates 配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -559,6 +575,7 @@ orderByAsc(field: string): DataAbilityPredicates 配置谓词以匹配其值按升序排序的列。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -585,6 +602,7 @@ orderByDesc(field: string): DataAbilityPredicates 配置谓词以匹配其值按降序排序的列。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -611,6 +629,7 @@ distinct(): DataAbilityPredicates 配置谓词以过滤重复记录并仅保留其中一个。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 返回值： | 类型 | 说明 | @@ -621,7 +640,12 @@ distinct(): DataAbilityPredicates ``` let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").distinct("NAME") - let resultSet = await rdbStore.query(predicates, ["NAME"]) + let promiseDistinct = rdbStore.query(predicates, ["NAME"]) + promiseDistinct.then((resultSet) => { + console.log("distinct") + }).catch((err) => { + expect(null).assertFail(); + }) ``` @@ -633,6 +657,7 @@ limitAs(value: number): DataAbilityPredicates 设置最大数据记录数的谓词。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -659,6 +684,7 @@ offsetAs(rowOffset: number): DataAbilityPredicates 配置谓词以指定返回结果的起始位置。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -685,6 +711,7 @@ groupBy(fields: Array<string>): DataAbilityPredicates 配置谓词按指定列分组查询结果。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -703,30 +730,6 @@ groupBy(fields: Array<string>): DataAbilityPredicates ``` -### indexedBy - - -indexedBy(indexName: string): DataAbilityPredicates - - -配置谓词以指定索引列。 - - -- 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | indexName | string | 是 | 索引列的名称。 | - -- 返回值： - | 类型 | 说明 | - | -------- | -------- | - | [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定索引列的谓词。 | - -- 示例： - ``` - let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE") - predicates.indexedBy("SALARY_INDEX") - ``` ### in @@ -737,6 +740,7 @@ in(field: string, value: Array<ValueType>): DataAbilityPredicates 配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -765,6 +769,7 @@ notIn(field: string, value: Array<ValueType>): DataAbilityPredicates 配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md b/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md index 594e5ec6a7ce5be75e851aa7625caf22cd9ae196..ca56d4628427510f2e023bfac5c8d1b63928d09e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md @@ -11,10 +11,6 @@ import distributedObject from '@ohos.data.distributedDataObject' ``` -## 系统能力 - -SystemCapability.DistributedDataManager.DataObject.DistributedObject - ## distributedDataObject.createDistributedObject @@ -22,6 +18,9 @@ createDistributedObject(source: object): DistributedObject 创建一个分布式对象distributedObject，用户可以通过source指定分布式对象中的属性，属性支持基本类型以及复杂类型，返回值是创建好的分布式对象。 + +**系统能力**：SystemCapability.DistributedDataManager.DataObject.DistributedObject。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -42,6 +41,7 @@ genSessionId(): string 随机创建一个sessionId，返回值是随机创建的sessionId。 +**系统能力**：SystemCapability.DistributedDataManager.DataObject.DistributedObject。 - 返回值： | 类型 | 说明 | @@ -64,10 +64,12 @@ setSessionId(sessionId?: string): boolean 设置同步的sessionId,当可信组网中有多个设备时，多个设备间的对象如果设置为同一个sessionId,就能自动同步。sessionId是指定的sessionId,如果要退出分布式组网，设置为""或不设置均可。结果以boolean形式返回，true标识设置sessionId成功 +**系统能力**：SystemCapability.DistributedDataManager.DataObject.DistributedObject。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | sessionId | string | 是 | 分布式对象在可信组网中的标识ID。 | + | sessionId | string | 否 | 分布式对象在可信组网中的标识ID。 | - 示例： ```js @@ -87,6 +89,7 @@ on(type: 'change', callback: Callback<{ sessionId: string, fields: Array<stri 监听分布式对象的变更，type需固定为'change'，callback是变更时触发的回调，回调参数sessionId标识变更对象的sessionId,fields标识对象变更的属性名 +**系统能力**：SystemCapability.DistributedDataManager.DataObject.DistributedObject。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -99,16 +102,14 @@ on(type: 'change', callback: Callback<{ sessionId: string, fields: Array<stri import distributedObject from '@ohos.data.distributedDataObject' var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}}); - changeCallback : function (sessionId, changeData) { - console.info("change" + sessionId); - - if (changeData != null && changeData != undefined) { - changeData.forEach(element => { - console.info("changed !" + element + " " + g_object[element]); - }); - } - } - g_object.on("change", this.changeCallback); + g_object.on("change", function (sessionId, changeData) { + console.info("change" + sessionId); + if (changeData != null && changeData != undefined) { + changeData.forEach(element => { + console.info("changed !" + element + " " + g_object[element]); + }); + } + }); ``` ### off('change') @@ -117,6 +118,8 @@ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<st 当不再进行数据变更监听时，使用此接口删除对象的变更监听，type固定为'change'，callback为可选参数，若不设置则表示删除该对象所有的变更监听 +**系统能力**：SystemCapability.DistributedDataManager.DataObject.DistributedObject。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -129,13 +132,13 @@ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<st import distributedObject from '@ohos.data.distributedDataObject' var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}}); - changeCallback : function (sessionId, changeData) { - console.info("change" + sessionId); - } - - g_object.on("change", this.changeCallback); + g_object.on("change", function (sessionId, changeData) { + console.info("change" + sessionId); + }); //删除变更回调changeCallback - g_object.off("change", changeCallback); + g_object.off("change", function (sessionId, changeData) { + console.info("change" + sessionId); + }); //删除所有的变更回调 g_object.off("change"); ``` @@ -146,6 +149,8 @@ on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, st 监听分布式对象的上下线，type需固定为'status'，callback是分布式对象上下线时触发的回调，回调参数sessionId标识变更对象的sessionId,networkId标识对象设备的networkId，status标识对象为'online'(上线)或'offline'(下线)的状态 +**系统能力**：SystemCapability.DistributedDataManager.DataObject.DistributedObject。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -157,11 +162,9 @@ on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, st import distributedObject from '@ohos.data.distributedDataObject' var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}}); - statusCallback : function (sessionId, networkid, status) { + g_object.on("status", function (sessionId, networkid, status) { this.response += "status changed " + sessionId + " " + status + " " + networkId; - } - - g_object.on("status", this.changeCallback); + }); ``` ### off('status') @@ -171,6 +174,7 @@ off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, s 当不再进行对象上下线监听时，使用此接口删除对象的上下线监听，type固定为'status'，callback为可选参数，若不设置则表示删除该对象所有的上下线监听 +**系统能力**：SystemCapability.DistributedDataManager.DataObject.DistributedObject。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -181,14 +185,14 @@ off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, s - 示例： ```js - import distributedObject from '@ohos.data.distributedDataObject' - statusCallback : function (sessionId, networkId, status) { + import distributedObject from '@ohos.data.distributedDataObject' + g_object.on("status", function (sessionId, networkId, status) { this.response += "status changed " + sessionId + " " + status + " " + networkId; - } - - g_object.on("status", this.changeCallback); + }); //删除上下线回调changeCallback - g_object.off("status", changeCallback); + g_object.off("status", function (sessionId, networkId, status) { + this.response += "status changed " + sessionId + " " + status + " " + networkId; + }); //删除所有的上下线回调 g_object.off("status"); ``` 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 a9cae3a9fcbdbe15657420e851386937e7438b23..5fc7302b31b47f2858c45e110147c770b1639dd1 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,20 +11,19 @@ import data_rdb from '@ohos.data.rdb' ``` -## 系统能力 -SystemCapability.DistributedDataManager.RelationalStore.Core - ## data_rdb.getRdbStore -getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void +getRdbStore(context?: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | Context | 是 | 应用程序或功能的上下文 | + | context8+ | Context | 否 | 应用程序或功能的上下文 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | version | number | 是 | 数据库版本。 | | callback | AsyncCallback<[RdbStore](#rdbstore)> | 是 | 指定callback回调函数。返回一个RdbStore。 | @@ -38,21 +37,23 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As 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.') + console.info('create table done.') }) } ``` ## data_rdb.getRdbStore -getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> +getRdbStore(context?: Context, config: StoreConfig, version: number): Promise<RdbStore> 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | Context | 是 | 应用程序或功能的上下文 | + | context8+ | Context | 否 | 应用程序或功能的上下文 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | version | number | 是 | 数据库版本。 | @@ -68,25 +69,32 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise< 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) + 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) => { - expect(null).assertFail(); + console.log("getRdbStore err.") }) } ``` ## data_rdb.deleteRdbStore -deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void +deleteRdbStore(context?: Context, name: string, callback: AsyncCallback<void>): void 删除数据库，结果以callback形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | Context | 是 | 应用程序或功能的上下文 | + | context8+ | Context | 否 | 应用程序或功能的上下文 | | name | string | 是 | 数据库名称。 | | callback | AsyncCallback<void> | 是 | 指定callback回调函数。如果数据库已删除，则为true；否则返回false。 | @@ -96,20 +104,23 @@ deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void&g 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.')}) + console.info('delete store done.') + }) } ``` ## data_rdb.deleteRdbStore -deleteRdbStore(context: Context, name: string): Promise<void> +deleteRdbStore(context?: Context, name: string): Promise<void> 使用指定的数据库文件配置删除数据库，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | context | Context | 是 | 应用程序或功能的上下文 | + | context8+ | Context | 否 | 应用程序或功能的上下文 | | name | string | 是 | 数据库名称。 | - 返回值： @@ -122,9 +133,11 @@ 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.') + let promisedeleteRdb = data_rdb.deleteRdbStore(this.context, "RdbTest.db") + promisedeleteRdb.then(()=>{ + console.info('delete store done.') + }).catch((err) => { + console.log("deleteRdbStore err.") }) } ``` @@ -141,6 +154,7 @@ constructor(name: string) 构造函数。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -154,16 +168,17 @@ constructor(name: string) ### inDevices -inDevices(devices: Array): RdbPredicates; +inDevices(devices: Array<string>): RdbPredicates 同步分布式数据库时指定组网内的远程设备。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | devices | Array | 是 | 指定的组网内的远程设备ID。 | + | devices | Array<string> | 是 | 指定的组网内的远程设备ID。 | - 返回值： | 类型 | 说明 | @@ -176,13 +191,14 @@ inDevices(devices: Array): RdbPredicates; predicate.inDevices(['12345678abcde']) ``` -### inAllDevices +### inAllDevices8+ -inAllDevices(): RdbPredicates; +inAllDevices(): RdbPredicates 同步分布式数据库时连接到组网内的所有远程设备。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 返回值： | 类型 | 说明 | @@ -202,6 +218,7 @@ equalTo(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -228,6 +245,7 @@ notEqualTo(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -254,6 +272,7 @@ beginWrap(): RdbPredicates 向谓词添加左括号。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 返回值： | 类型 | 说明 | @@ -279,6 +298,7 @@ endWrap(): RdbPredicates 向谓词添加右括号。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 返回值： | 类型 | 说明 | @@ -304,6 +324,7 @@ or(): RdbPredicates 将或条件添加到谓词中。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 返回值： | 类型 | 说明 | @@ -326,6 +347,7 @@ and(): RdbPredicates 向谓词添加和条件。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 返回值： | 类型 | 说明 | @@ -343,11 +365,11 @@ and(): RdbPredicates ### contains -contains(field: string, value: string): RdbPredicat - +contains(field: string, value: string): RdbPredicates 配置谓词以匹配数据字段为String且value包含指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -374,6 +396,7 @@ beginsWith(field: string, value: string): RdbPredicates 配置谓词以匹配数据字段为String且值以指定字符串开头的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -400,6 +423,7 @@ endsWith(field: string, value: string): RdbPredicates 配置谓词以匹配数据字段为String且值以指定字符串结尾的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -426,6 +450,7 @@ isNull(field: string): RdbPredicates 配置谓词以匹配值为null的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -451,6 +476,7 @@ isNotNull(field: string): RdbPredicates 配置谓词以匹配值不为null的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -476,6 +502,7 @@ like(field: string, value: string): RdbPredicates 配置谓词以匹配数据字段为String且值类似于指定字符串的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -502,6 +529,7 @@ glob(field: string, value: string): RdbPredicates 配置RdbPredicates匹配数据字段为String的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -528,6 +556,7 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates 将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -555,6 +584,7 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates 配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -577,11 +607,11 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates ### greaterThan -greaterThan(field: string, value: ValueType): RdbPredicatesgr - +greaterThan(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为ValueType且值大于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -608,6 +638,7 @@ lessThan(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为valueType且value小于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -635,6 +666,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -662,6 +694,7 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -689,6 +722,7 @@ orderByAsc(field: string): RdbPredicates 配置谓词以匹配其值按升序排序的列。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -715,6 +749,7 @@ orderByDesc(field: string): RdbPredicates 配置谓词以匹配其值按降序排序的列。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -740,6 +775,7 @@ distinct(): RdbPredicates 配置谓词以过滤重复记录并仅保留其中一个。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 返回值： | 类型 | 说明 | @@ -750,7 +786,13 @@ distinct(): RdbPredicates ``` let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").distinct("NAME") - let resultSet = await rdbStore.query(predicates, ["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.") + }) ``` @@ -761,6 +803,7 @@ limitAs(value: number): RdbPredicates 设置最大数据记录数的谓词。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -786,6 +829,7 @@ offsetAs(rowOffset: number): RdbPredicates 配置RdbPredicates以指定返回结果的起始位置。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -811,6 +855,7 @@ groupBy(fields: Array<string>): RdbPredicates 配置RdbPredicates按指定列分组查询结果。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -833,9 +878,9 @@ groupBy(fields: Array<string>): RdbPredicates indexedBy(indexName: string): RdbPredicates - 配置RdbPredicates以指定索引列。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -861,6 +906,7 @@ in(field: string, value: Array<ValueType>): RdbPredicates 配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -888,6 +934,7 @@ notIn(field: string, value: Array<ValueType>): RdbPredicates 将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -919,6 +966,8 @@ insert(name: string, values: ValuesBucket, callback: AsyncCallback<number> 向目标表中插入一行数据，结果以callback形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -935,8 +984,8 @@ insert(name: string, values: ValuesBucket, callback: AsyncCallback<number> "CODES": new Uint8Array([1, 2, 3, 4, 5]), } rdbStore.insert("EMPLOYEE", valueBucket, function (err, ret) { - expect(1).assertEqual(ret) - console.log(TAG + "insert first done: " + ret)}) + console.log("insert first done: " + ret) + }) ``` @@ -946,6 +995,8 @@ insert(name: string, values: ValuesBucket):Promise<number> 向目标表中插入一行数据，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -965,10 +1016,12 @@ insert(name: string, values: ValuesBucket):Promise<number> "SALARY": 100.5, "CODES": new Uint8Array([1, 2, 3, 4, 5]), } - let promise = rdbStore.insert("EMPLOYEE", valueBucket) - promise.then(async (ret) => { - await console.log(TAG + "insert first done: " + ret) - }).catch((err) => {}) + let promiseinsert = rdbStore.insert("EMPLOYEE", valueBucket) + promiseinsert.then(async (ret) => { + console.log("insert first done: " + ret) + }).catch((err) => { + console.log("insert err.") + }) ``` @@ -978,6 +1031,8 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以callback形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -996,7 +1051,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(TAG + "updated row count: " + changedRows)}) + console.log("updated row count: " + changedRows)}) ``` @@ -1006,6 +1061,8 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise<number> 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1027,10 +1084,12 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise<number> } let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") - let promise = rdbStore.update(valueBucket, predicates) - promise.then(async (ret) => { - await console.log(TAG + "updated row count: " + changedRows) - }).catch((err) => {}) + let promiseupdate = rdbStore.update(valueBucket, predicates) + promiseupdate.then(async (ret) => { + console.log("updated row count: " + changedRows) + }).catch((err) => { + console.log("update err.") + }) ``` @@ -1041,6 +1100,7 @@ delete(rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void 根据rdbPredicates的指定实例对象从数据库中删除数据，结果以callback形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -1053,7 +1113,8 @@ delete(rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") rdbStore.delete(predicates, function (err, rows) { - console.log(TAG + "delete rows: " + rows)}) + console.log("delete rows: " + rows) + }) ``` @@ -1063,6 +1124,8 @@ delete(rdbPredicates: RdbPredicates):Promise<number> 根据rdbPredicates的指定实例对象从数据库中删除数据，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1075,12 +1138,14 @@ delete(rdbPredicates: RdbPredicates):Promise<number> - 示例： ``` - let predicates = new data_rdb.RdbPredicates("EMPLOYEE") - predicates.equalTo("NAME", "Lisa") - let promise = rdbStore.delete(predicates) - promise.then((rows) => { - console.log(TAG + "delete rows: " + rows) - }).catch((err) => {}) + 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.") + }) ``` @@ -1090,6 +1155,8 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>, callback: Asyn 根据指定条件查询数据库中的数据，结果以callback形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1102,8 +1169,9 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>, callback: Asyn 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) - console.log(TAG + "resultSet column count:" + resultSet.columnCount)}) + console.log("resultSet column names:" + resultSet.columnNames) + console.log("resultSet column count:" + resultSet.columnCount) + }) ``` @@ -1113,6 +1181,8 @@ query(rdbPredicates: RdbPredicates, columns?: Array<string>):Promise<Re 根据指定条件查询数据库中的数据，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1128,10 +1198,13 @@ query(rdbPredicates: RdbPredicates, columns?: Array<string>):Promise<Re ``` let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") - let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) - promise.then((resultSet) => { - console.log(TAG + "resultSet column names:" + resultSet.columnNames) - console.log(TAG + "resultSet column count:" + resultSet.columnCount)}) + let promisequery = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) + promisequery.then((resultSet) => { + console.log("resultSet column names:" + resultSet.columnNames) + console.log("resultSet column count:" + resultSet.columnCount) + }).catch((err) => { + console.log("query err.") + }) ``` @@ -1141,6 +1214,8 @@ querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback& 根据指定SQL语句查询数据库中的数据，结果以callback形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1151,8 +1226,9 @@ querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback& - 示例： ``` rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) { - console.log(TAG + "resultSet column names:" + resultSet.columnNames) - console.log(TAG + "resultSet column count:" + resultSet.columnCount)}) + console.log("resultSet column names:" + resultSet.columnNames) + console.log("resultSet column count:" + resultSet.columnCount) + }) ``` @@ -1162,6 +1238,8 @@ querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> 根据指定SQL语句查询数据库中的数据，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1175,10 +1253,13 @@ querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> - 示例： ``` - let promise = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo']) - promise.then((resultSet) => { - console.log(TAG + "resultSet column names:" + resultSet.columnNames) - console.log(TAG + "resultSet column count:" + resultSet.columnCount)}) + 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.") + }) ``` @@ -1188,6 +1269,8 @@ executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallbac 执行包含指定参数但不返回值的SQL语句，结果以callbck形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1198,7 +1281,8 @@ executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallbac - 示例： ``` rdbStore.executeSql("DELETE FROM EMPLOYEE", null, function () { - console.info(TAG + 'delete done.')}) + console.info('delete done.') + }) ``` @@ -1208,6 +1292,8 @@ executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void> 执行包含指定参数但不返回值的SQL语句，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1221,21 +1307,104 @@ executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void> - 示例： ``` - let promise = rdbStore.executeSql("DELETE FROM EMPLOYEE") - promise.then(() => { - console.info(TAG + 'delete done.')}) + let promiseexecuteSql = rdbStore.executeSql("DELETE FROM EMPLOYEE") + promiseexecuteSql.then(() => { + console.info('delete done.') + }).catch((err) => { + console.log("executeSql err.") + }) ``` +### beginTransaction8+ + +beginTransaction():void + +在开始执行SQL语句之前，开始事务。 + +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + +- 示例： +``` + 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() +``` + + +### commit8+ + +commit():void + +提交已执行的SQL语句。 + +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + +- 示例： +``` + 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() +``` + + +### rollBack8+ + +rollBack():void; + +回滚已经执行的SQL语句。 + +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + +- 示例： +``` + 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() + } +``` + + ### setDistributedTables -setDistributedTables(tables: Array, callback: AsyncCallback): void; +setDistributedTables(tables: Array<string>, callback: AsyncCallback<void>): void 设置分布式列表，结果以callbck形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | tables | Array | 是 | 要设置的分布式列表表名 | + | tables | Array<string> | 是 | 要设置的分布式列表表名 | | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | - 示例： @@ -1252,14 +1421,16 @@ setDistributedTables(tables: Array, callback: AsyncCallback): void ### setDistributedTables - setDistributedTables(tables: Array): Promise; + setDistributedTables(tables: Array<string>): Promise<void> 设置分布式列表，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | tables | Array | 是 | 要设置的分布式列表表名。 | + | tables | Array<string> | 是 | 要设置的分布式列表表名。 | - 返回值： | 类型 | 说明 | @@ -1268,20 +1439,22 @@ setDistributedTables(tables: Array, callback: AsyncCallback): void - 示例： ``` - let promise = rdbStore.setDistributedTables(["EMPLOYEE"]) - promise.then(() => { + let promiseset = rdbStore.setDistributedTables(["EMPLOYEE"]) + promiseset.then(() => { console.info("setDistributedTables success.") }).catch((err) => { - console.info("setDistributedTables failed."") + console.info("setDistributedTables failed.") }) ``` ### obtainDistributedTableName -obtainDistributedTableName(device: string, table: string, callback: AsyncCallback): void; +obtainDistributedTableName(device: string, table: string, callback: AsyncCallback<string>): void 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 结果以callbck形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1303,10 +1476,12 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac ### obtainDistributedTableName - obtainDistributedTableName(device: string, table: string): Promise; + obtainDistributedTableName(device: string, table: string): Promise<string> 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1320,26 +1495,28 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac - 示例： ``` - let promise = rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE") - promise.then((tableName) => { + let promiseDistr = rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE") + promiseDistr.then((tableName) => { console.info('obtainDistributedTableName success, tableName=' + tableName) }).catch((err) => { console.info('obtainDistributedTableName failed.') }) ``` -### sync +### sync8+ -sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback>): void; +sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array<[string, number]>>): void 在设备之间同步数据, 结果以callbck形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | mode | SyncMode | 是 | 指同步模式。该值可以是推、拉。 | | predicates | RdbPredicates | 是 | 约束同步数据和设备。 | - | callback | AsyncCallback<Array<[string, number]>> | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。| + | callback | AsyncCallback<Array<[string, number]>> | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。| - 示例： ``` @@ -1358,12 +1535,14 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback8+ - sync(mode: SyncMode, predicates: RdbPredicates): Promise>; + sync(mode: SyncMode, predicates: RdbPredicates): Promise<Array<[string, number]>> 在设备之间同步数据，结果以Promise形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -1373,60 +1552,64 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback> | 指定Promise回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | + | Promise<Array<[string, number]>> | 指定Promise回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | - 示例： ``` - let predicate = new rdb.RdbPredicates('EMPLOYEE') - predicate.inDevices(['12345678abcde']) - let promise = rdbStore.sync(rdb.SyncMode.SYNC_MODE_PUSH, predicate) - promise.then(result) { + let predicatesync = new rdb.RdbPredicates('EMPLOYEE') + predicatesync.inDevices(['12345678abcde']) + let promisesync = rdbStore.sync(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') - }) + }).catch((err) => { + console.log('sync failed') + }) ``` ### on -on(event: 'dataChange', type: SubscribeType, observer: Callback>): void; +on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | SubscribeType | 是 | 指在{@code SubscribeType}中定义的订阅类型。 | - | observer | Callback> | 是 | 指分布式数据库中数据更改事件的观察者。 | + | observer | Callback<Array<string>> | 是 | 指分布式数据库中数据更改事件的观察者。 | - 示例： ``` function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { console.log('device=' + device[i] + ' data changed') - } - } - try { - rdbStore.on('dataChange', rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver) - } catch (err) { - console.log('register observer failed') - } + } + } + try { + rdbStore.on('dataChange', rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver) + } catch (err) { + console.log('register observer failed') + } ``` ### off -off(event:'dataChange', type: SubscribeType, observer: Callback>): void; +off(event:'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void 从数据库中删除指定类型的指定观察者, 结果以callbck形式返回。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | SubscribeType | 是 | 指在{@code SubscribeType}中定义的订阅类型。 | - | observer | Callback> | 是 | 指已注册的数据更改观察者。| + | observer | Callback<Array<string>> | 是 | 指已注册的数据更改观察者。| - 示例： ``` @@ -1447,6 +1630,8 @@ off(event:'dataChange', type: SubscribeType, observer: Callback>): 管理关系数据库配置。 +**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | name | string | 是 | 数据库文件名。 | @@ -1456,6 +1641,8 @@ off(event:'dataChange', type: SubscribeType, observer: Callback>): 用于表示允许的数据字段类型。 +**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 + | 名称 | 说明 | | -------- | -------- | | number | 表示值类型为数字。 | @@ -1467,25 +1654,30 @@ off(event:'dataChange', type: SubscribeType, observer: Callback>): 用于存储键值对。 +**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | [key: string] | [ValueType](#valuetype)\| Uint8Array \| null | 是 | 用于存储键值对。 | -## SyncMode +## SyncMode8+ 指数据库同步模式。 -| 名称 | 说明 | -| -------- | -------- | -| SYNC_MODE_PUSH | 表示数据从本地设备推送到远程设备。 | -| SYNC_MODE_PULL | 表示数据从远程设备拉至本地设备。 | +**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 + +| 名称 | 默认值 | 说明 | +| -------- | ----- |----- | +| SYNC_MODE_PUSH | 0 | 表示数据从本地设备推送到远程设备。 | +| SYNC_MODE_PULL | 1 | 表示数据从远程设备拉至本地设备。 | -## SubscribeType +## SubscribeType8+ 描述订阅类型。 -| 名称 | 说明 | -| -------- | -------- | -| SUBSCRIBE_TYPE_REMOTE | 订阅远程数据更改。 | +**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 + +| 名称 | 默认值 | 说明 | +| -------- | ----- |---- | +| SUBSCRIBE_TYPE_REMOTE | 0 | 订阅远程数据更改。 | 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 57cbfd4bdbf0e4d5be2b2a9cb90b6637f1f8cbe7..08dfbda473b6e3d47d1ed9d4de8bcc6ba2281c8b 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,8 +3,6 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 系统能力 -SystemCapability.DistributedDataManager.RelationalStore.Core ## 使用说明 @@ -16,8 +14,8 @@ let predicates = new dataRdb.RdbPredicates("EMPLOYEE") predicates.equalTo("AGE", 18) let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) promise.then((resultSet) => { - await console.log(TAG + "resultSet columnNames:" + resultSet.columnNames); - await console.log(TAG + "resultSet columnCount:" + resultSet.columnCount);}) + console.log(TAG + "resultSet columnNames:" + resultSet.columnNames); + console.log(TAG + "resultSet columnCount:" + resultSet.columnCount);}) ``` @@ -31,6 +29,7 @@ promise.then((resultSet) => { ### 属性 +**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -51,6 +50,8 @@ getColumnIndex(columnName: string): number 根据指定的列名获取列索引。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -77,6 +78,8 @@ getColumnName(columnIndex: number): string 根据指定的列索引获取列名。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -101,6 +104,8 @@ goTo(offset:number): boolean 向前或向后转至结果集的指定行，相对于其当前位置偏移。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -113,11 +118,14 @@ goTo(offset:number): boolean - 示例： ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") - let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) - resultSet.goTo(1) - resultSet.close() - resultSet = null + let predicatesgoto = new dataRdb.RdbPredicates("EMPLOYEE") + let promisequerygoto = rdbStore.query(predicatesgoto, ["ID", "NAME", "AGE", "SALARY", "CODES"]) + promisequerygoto.then((resultSet) { + resultSet.goTo(1) + resultSet.close() + }).catch((err) => { + console.log('query failed') + }) ``` @@ -127,6 +135,8 @@ goToRow(position: number): boolean 转到结果集的指定行。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -139,11 +149,14 @@ goToRow(position: number): boolean - 示例： ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") - let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) - resultSet.goToRow(1) - resultSet.close() - resultSet = null + let predicatesgotorow = new dataRdb.RdbPredicates("EMPLOYEE") + let promisequerygotorow = rdbStore.query(predicatesgotorow, ["ID", "NAME", "AGE", "SALARY", "CODES"]) + promisequerygotorow.then((resultSet) { + resultSet.goToRow(5) + resultSet.close() + }).catch((err) => { + console.log('query failed') + }) ``` @@ -154,6 +167,7 @@ goToFirstRow(): boolean 转到结果集的第一行。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 返回值： | 类型 | 说明 | @@ -162,11 +176,14 @@ goToFirstRow(): boolean - 示例： ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") - let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) - resultSet.goToFirstRow() - resultSet.close() - resultSet = null; + let predicatesgoFirst = new dataRdb.RdbPredicates("EMPLOYEE") + let promisequerygoFirst = rdbStore.query(predicatesgoFirst, ["ID", "NAME", "AGE", "SALARY", "CODES"]) + promisequerygoFirst.then((resultSet) { + resultSet.goToFirstRow() + resultSet.close() + }).catch((err) => { + console.log('query failed') + }) ``` @@ -176,6 +193,8 @@ goToLastRow(): boolean 转到结果集的最后一行。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 返回值： | 类型 | 说明 | | -------- | -------- | @@ -183,11 +202,14 @@ goToLastRow(): boolean - 示例： ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") - let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) - resultSet.goToLastRow() - resultSet.close() - resultSet = null; + let predicatesgoLast = new dataRdb.RdbPredicates("EMPLOYEE") + let promisequerygoLast = rdbStore.query(predicatesgoLast, ["ID", "NAME", "AGE", "SALARY", "CODES"]) + promisequerygoLast.then((resultSet) { + resultSet.goToLastRow() + resultSet.close() + }).catch((err) => { + console.log('query failed') + }) ``` @@ -197,6 +219,8 @@ goToNextRow(): boolean 转到结果集的下一行。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 返回值： | 类型 | 说明 | | -------- | -------- | @@ -204,11 +228,14 @@ goToNextRow(): boolean - 示例： ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") - let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) - resultSet.goToNextRow() - resultSet.close() - resultSet = null; + let predicatesgoNext = new dataRdb.RdbPredicates("EMPLOYEE") + let promisequerygoNext = rdbStore.query(predicatesgoNext, ["ID", "NAME", "AGE", "SALARY", "CODES"]) + promisequerygoNext.then((resultSet) { + resultSet.goToNextRow() + resultSet.close() + }).catch((err) => { + console.log('query failed') + }) ``` @@ -218,6 +245,8 @@ goToPreviousRow(): boolean 转到结果集的上一行。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 返回值： | 类型 | 说明 | | -------- | -------- | @@ -225,11 +254,14 @@ goToPreviousRow(): boolean - 示例： ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") - let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) - resultSet.goToPreviousRow() - resultSet.close() - resultSet = null + let predicatesgoPrev = new dataRdb.RdbPredicates("EMPLOYEE") + let promisequerygoPrev = rdbStore.query(predicatesgoPrev, ["ID", "NAME", "AGE", "SALARY", "CODES"]) + promisequerygoPrev.then((resultSet) { + resultSet.goToPreviousRow() + resultSet.close() + }).catch((err) => { + console.log('query failed') + }) ``` @@ -239,6 +271,8 @@ getBlob(columnIndex: number): Uint8Array 以字节数组的形式获取当前行中指定列的值。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -261,6 +295,8 @@ getString(columnIndex: number): string 以字符串形式获取当前行中指定列的值。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -283,6 +319,8 @@ getLong(columnIndex: number): number 以Long形式获取当前行中指定列的值。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -305,6 +343,8 @@ getDouble(columnIndex: number): number 以double形式获取当前行中指定列的值。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -327,6 +367,8 @@ isColumnNull(columnIndex: number): boolean 检查当前行中指定列的值是否为null。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -349,11 +391,15 @@ close(): void 关闭结果集。 +**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 - 示例： ``` - let predicates = new dataRdb.RdbPredicates("EMPLOYEE") - let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) - resultSet.close() - resultSet = null + let predicatesclose = new dataRdb.RdbPredicates("EMPLOYEE") + let predicatesclose = rdbStore.query(predicatesclose, ["ID", "NAME", "AGE", "SALARY", "CODES"]) + promisequerygoPrev.then((resultSet) { + resultSet.close() + }).catch((err) => { + console.log('query failed') + }) ```