diff --git a/zh-cn/application-dev/database/database-relational-guidelines.md b/zh-cn/application-dev/database/database-relational-guidelines.md
index d44e12560542bbb81f96672ec57dd1a604f494e0..7ef06c7614e761e938a69ad4a6742932aaab3fda 100644
--- a/zh-cn/application-dev/database/database-relational-guidelines.md
+++ b/zh-cn/application-dev/database/database-relational-guidelines.md
@@ -7,7 +7,7 @@
## 接口说明
-具体关系型数据库相关功能接口请见[关系型数据库](../reference/apis/js-apis-data-rdb.md)。
+以下是关系型数据库的常用接口说明,大部分为异步接口。异步接口均有callback和Promise两种返回形式,下表均以Promise形式为例,更多接口及使用方式请见[关系型数据库](../reference/apis/js-apis-data-rdb.md)。
### 数据库的创建和删除
@@ -15,12 +15,10 @@
**表1** 数据库创建和删除API
-| 接口名 | 描述 |
-| -------- | -------- |
-|getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void| 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以callback形式返回。
- context:应用程序或功能的上下文。
- config:与此RDB存储相关的数据库配置。
- version:数据库版本。
- callback:指定callback回调函数。返回一个RdbStore。 |
-|getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> | 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以Promise形式返回。
- context:应用程序或功能的上下文。
- config:与此RDB存储相关的数据库配置。
- version:数据库版本。 |
-|deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void> ): void | 删除数据库,结果以callback形式返回。
- context:应用程序或功能的上下文。
- name:数据库名称。
- callback:指定callback回调函数。 |
-| deleteRdbStore(context: Context, name: string): Promise<void> | 使用指定的数据库文件配置删除数据库,结果以Promise形式返回。
- context:应用程序或功能的上下文。
- name:数据库名称。 |
+| 接口名 | 描述 |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> | 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,使用Promise异步回调。
-context:应用程序或功能的上下文。
-config:与此RDB存储相关的数据库配置。
-version:数据库版本。 |
+| deleteRdbStore(context: Context, name: string): Promise<void> | 使用指定的数据库文件配置删除数据库,使用Promise异步回调。
-context:应用程序或功能的上下文。
-name:数据库名称。 |
### 数据库的增删改查
@@ -32,10 +30,9 @@
**表2** 数据库插入API
- | 类名 | 接口名 | 描述 |
- | -------- | -------- | -------- |
- | RdbStore | insert(table: string, values: ValuesBucket, callback: AsyncCallback<number>):void | 向目标表中插入一行数据,结果以callback形式返回。
- table:指定的目标表名。
- values:表示要插入到表中的数据行。
- callback:指定callback回调函数。如果操作成功,返回行ID;否则返回-1。 |
- | RdbStore | insert(table: string, values: ValuesBucket): Promise<number> | 向目标表中插入一行数据,结果以Promise形式返回。
- table:指定的目标表名。
- values:表示要插入到表中的数据行。 |
+ | 类名 | 接口名 | 描述 |
+ | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+ | RdbStore | insert(table:string,values:ValuesBucket):Promise<number> | 向目标表中插入一行数据,使用Promise异步回调。
如果操作成功,返回行ID;否则返回-1。
-table:指定的目标表名。
-values:表示要插入到表中的数据行。 |
- **更新**
@@ -43,10 +40,9 @@
**表3** 数据库更新API
- | 类名 | 接口名 | 描述 |
- | -------- | -------- | -------- |
- | RdbStore | update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback<number>):void | 根据RdbPredicates的指定实例对象更新数据库中的数据,结果以callback形式返回。
- values:以ValuesBucket存储的要更新的数据。
- predicates:表示RdbPredicates的实例对象指定的更新条件。
- callback:指定的callback回调方法。返回受影响的行数。 |
- | RdbStore | update(values: ValuesBucket, predicates: RdbPredicates): Promise<number> | 根据RdbPredicates的指定实例对象更新数据库中的数据,结果以Promise形式返回。
- values:以ValuesBucket存储的要更新的数据。
- predicates:表示RdbPredicates的实例对象指定的更新条件。 |
+ | 类名 | 接口名 | 描述 |
+ | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+ | RdbStore | update(values:ValuesBucket,predicates:RdbPredicates):Promise<number> | 根据RdbPredicates的指定实例对象更新数据库中的数据,使用Promise异步回调。
返回受影响的行数。
-values:以ValuesBucket存储的要更新的数据。
-predicates:表示RdbPredicates的实例对象指定的更新条件。 |
- **删除**
@@ -54,10 +50,9 @@
**表4** 数据库删除API
- | 类名 | 接口名 | 描述 |
- | -------- | -------- | -------- |
- | RdbStore | delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void | 根据RdbPredicates的指定实例对象从数据库中删除数据,结果以callback形式返回。
- predicates:RdbPredicates的实例对象指定的删除条件。
- callback:指定callback回调函数。返回受影响的行数。 |
- | RdbStore | delete(predicates: RdbPredicates): Promise<number> | 根据RdbPredicates的指定实例对象从数据库中删除数据,结果以Promise形式返回。
- predicates:RdbPredicates的实例对象指定的删除条件。 |
+ | 类名 | 接口名 | 描述 |
+ | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+ | RdbStore | delete(predicates:RdbPredicates):Promise<number> | 根据RdbPredicates的指定实例对象从数据库中删除数据,使用Promise异步回调。
返回受影响的行数。
-predicates:RdbPredicates的实例对象指定的删除条件。 |
- **查询**
@@ -68,78 +63,48 @@
**表5** 数据库查询API
- | 类名 | 接口名 | 描述 |
- | -------- | -------- | -------- |
- | RdbStore | query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>): void | 根据指定条件查询数据库中的数据,结果以callback形式返回。
- predicates:表示RdbPredicates的实例对象指定的查询条件。
- columns:表示要查询的列。如果值为空,则查询应用于所有列。
- callback:指定callback回调函数。如果操作成功,则返回ResultSet对象。 |
- | RdbStore | query(predicates: RdbPredicates, columns?: Array<string>): Promise<ResultSet> | 根据指定条件查询数据库中的数据,结果以Promise形式返回。
- predicates:表示RdbPredicates的实例对象指定的查询条件。
- columns:表示要查询的列。如果值为空,则查询应用于所有列。 |
- | RdbStore | querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<ResultSet>):void | 根据指定SQL语句查询数据库中的数据,结果以callback形式返回。
- sql:指定要查询的SQL语句。
- bindArgs:SQL语句中参数的值。
- callback:指定callback回调函数。如果操作成功,则返回ResultSet对象。 |
- | RdbStore | querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> | 根据指定SQL语句查询数据库中的数据,结果以Promise形式返回。
- sql:指定要查询的SQL语句。
- bindArgs:SQL语句中参数的值。 |
- | RdbStore | remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>): void |根据指定条件查询指定远程设备数据库中的数据。使用callback异步回调。
- device:指定远程查询的设备networkId。
- table:指定远程查询的表名。
- predicates:表示RdbPredicates的实例对象,指定查询的条件。
- columns:表示要查询的列。如果值为空,则查询应用于所有列。
- callback:指定callback回调函数。如果操作成功,则返回ResultSet对象。 |
- | RdbStore | remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array<string>): Promise<ResultSet> | 根据指定条件查询指定远程设备数据库中的数据。使用Promise异步回调。
- device:指定远程查询的设备networkId。
- table:指定远程查询的表名。
- predicates:表示RdbPredicates的实例对象,指定查询的条件。
- columns:表示要查询的列。如果值为空,则查询应用于所有列。 |
+ | 类名 | 接口名 | 描述 |
+ | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+ | RdbStore | query(predicates:RdbPredicates,columns?:Array<string>):Promise<ResultSet> | 根据指定条件查询数据库中的数据,使用Promise异步回调。
-predicates:表示RdbPredicates的实例对象指定的查询条件。
-columns:表示要查询的列。如果值为空,则查询应用于所有列。 |
+ | RdbStore | querySql(sql:string,bindArgs?:Array<ValueType>):Promise<ResultSet> | 根据指定SQL语句查询数据库中的数据,使用Promise异步回调。
-sql:指定要查询的SQL语句。
-bindArgs:SQL语句中参数的值。 |
+ | RdbStore | remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array<string>): Promise<ResultSet> | 根据指定条件查询指定远程设备数据库中的数据。使用Promise异步回调。
-device:指定远程查询的设备networkId。
-table:指定远程查询的表名。
-predicates:表示RdbPredicates的实例对象,指定查询的条件。
-columns:表示要查询的列。如果值为空,则查询应用于所有列。 |
### 数据库谓词的使用
关系型数据库提供了用于设置数据库操作条件的谓词RdbPredicates,该类确定RDB中条件表达式的值是true还是false。
+以下列举几个常用谓词,更多谓词的使用请见[关系型数据库谓词](../reference/apis/js-apis-data-rdb.md#rdbpredicates)。
+
**表6** 数据库谓词API
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| RdbPredicates |inDevices(devices: Array\): RdbPredicates | 同步分布式数据库时指定组网内的远程设备。
- devices:组网内指定的远程设备ID。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates |inAllDevices(): RdbPredicates | 同步分布式数据库时连接到组网内的所有远程设备。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | equalTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | notEqualTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | beginWrap(): RdbPredicates | 向谓词添加左括号。
- RdbPredicates:返回带有左括号的谓词。 |
-| RdbPredicates | endWrap(): RdbPredicates | 向谓词添加右括号。
- RdbPredicates:返回带有右括号的谓词。 |
-| RdbPredicates | or(): RdbPredicates | 将或条件添加到谓词中。
- RdbPredicates:返回带有或条件的谓词。 |
-| RdbPredicates | and(): RdbPredicates | 向谓词添加和条件。
- RdbPredicates:返回带有和条件的谓词。 |
-| RdbPredicates | contains(field: string, value: string): RdbPredicates | 配置谓词以匹配数据字段为String且value包含指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回带有包含条件的谓词。 |
-| RdbPredicates | beginsWith(field: string, value: string): RdbPredicates | 配置谓词以匹配数据字段为String且值以指定字符串开头的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | endsWith(field: string, value: string): RdbPredicates | 配置谓词以匹配数据字段为String且值以指定字符串结尾的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | isNull(field: string): RdbPredicates | 配置谓词以匹配值为null的字段。
- field:数据库表中的列名。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | isNotNull(field: string): RdbPredicates | 配置谓词以匹配值不为null的指定字段。
- field:数据库表中的列名。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | like(field: string, value: string): RdbPredicates | 配置谓词以匹配数据字段为String且值类似于指定字符串的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | glob(field: string, value: string): RdbPredicates | 配置RdbPredicates匹配数据字段为String的指定字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | between(field: string, low: ValueType, high: ValueType): RdbPredicates | 将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。
- field:数据库表中的列名。
- low:指示与谓词匹配的最小值。
- high:指示与谓词匹配的最大值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates | 配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。
- field:数据库表中的列名。
- low:指示与谓词匹配的最小值。
- high:指示与谓词匹配的最大值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | greaterThan(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且值大于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | lessThan(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为valueType且value小于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | orderByAsc(field: string): RdbPredicates | 配置谓词以匹配其值按升序排序的列。
- field:数据库表中的列名。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | orderByDesc(field: string): RdbPredicates | 配置谓词以匹配其值按降序排序的列。
- field:数据库表中的列名。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | distinct(): RdbPredicates | 配置谓词以过滤重复记录并仅保留其中一个。
- RdbPredicates:返回可用于过滤重复记录的谓词。 |
-| RdbPredicates | limitAs(value: number): RdbPredicates | 设置最大数据记录数的谓词。
- value:最大数据记录数。
- RdbPredicates:返回可用于设置最大数据记录数的谓词。 |
-| RdbPredicates | offsetAs(rowOffset: number): RdbPredicates | 配置RdbPredicates以指定返回结果的起始位置。
- rowOffset:返回结果的起始位置,取值为正整数。
- RdbPredicates:返回具有指定返回结果起始位置的谓词。 |
-| RdbPredicates | groupBy(fields: Array<string>): RdbPredicates | 配置RdbPredicates按指定列分组查询结果。
- fields:指定分组依赖的列名。
- RdbPredicates:返回分组查询列的谓词。 |
-| RdbPredicates | indexedBy(indexName: string): RdbPredicates | 配置RdbPredicates以指定索引列。
- indexName:索引列的名称。
- RdbPredicates:返回具有指定索引列的RdbPredicates。 |
-| RdbPredicates | in(field: string, value: Array<ValueType>): RdbPredicates | 配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。
- field:数据库表中的列名。
- value:以ValueType型数组形式指定的要匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
-| RdbPredicates | notIn(field: string, value: Array<ValueType>): RdbPredicates | 将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。
- field:数据库表中的列名。
- value:以ValueType型数组形式指定的要匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。 |
+| 类名 | 接口名 | 描述 |
+| ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| RdbPredicates | equalTo(field:string,value:ValueType):RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
-field:数据库表中的列名。
-value:指示要与谓词匹配的值。
-RdbPredicates:返回与指定字段匹配的谓词。 |
+| RdbPredicates | notEqualTo(field:string,value:ValueType):RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
-field:数据库表中的列名。
-value:指示要与谓词匹配的值。
-RdbPredicates:返回与指定字段匹配的谓词。 |
+| RdbPredicates | or():RdbPredicates | 将或条件添加到谓词中。
-RdbPredicates:返回带有或条件的谓词。 |
+| RdbPredicates | and():RdbPredicates | 向谓词添加和条件。
-RdbPredicates:返回带有和条件的谓词。 |
+| RdbPredicates | contains(field:string,value:string):RdbPredicates | 配置谓词以匹配数据字段为String且value包含指定值的字段。
-field:数据库表中的列名。
-value:指示要与谓词匹配的值。
-RdbPredicates:返回带有包含条件的谓词。 |
+
### 查询结果集的使用
-关系型数据库提供了查询返回的结果集ResultSet,其指向查询结果中的一行数据,供用户对查询结果进行遍历和访问。ResultSet对外API如下所示。
+关系型数据库提供了查询返回的结果集ResultSet,其指向查询结果中的一行数据,供用户对查询结果进行遍历和访问。
+
+更多结果集的接口使用,请见[结果集](../reference/apis/js-apis-data-resultset.md)。
> **须知:**
> **结果集使用完后,请一定要调用close方法显式关闭。**
**表7** 结果集API
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| ResultSet | goTo(offset:number): boolean | 从结果集当前位置移动指定偏移量。 |
-| ResultSet | goToRow(position: number): boolean | 将结果集移动到指定位置。 |
-| ResultSet | goToNextRow(): boolean | 将结果集向后移动一行。 |
-| ResultSet | goToPreviousRow(): boolean | 将结果集向前移动一行。 |
-| ResultSet | getColumnIndex(columnName: string): number | 根据指定的列名获取列索引。 |
-| ResultSet | getColumnName(columnIndex: number): string | 根据指定的列索引获取列名。 |
-| ResultSet | goToFirstRow(): boolean | 将结果集移动到第一行。 |
-| ResultSet | goToLastRow(): boolean | 将结果集移动到最后一行。 |
-| ResultSet | getString(columnIndex: number): string | 获取当前行指定列的值,以String类型返回。 |
-| ResultSet | getBlob(columnIndex: number): Uint8Array | 获取当前行指定列的值,以字节数组形式返回。 |
-| ResultSet | getDouble(columnIndex: number): number | 获取当前行指定列的值,以double型返回。 |
-| ResultSet | isColumnNull(columnIndex: number): boolean | 检查当前行中指定列的值是否为null。 |
-| ResultSet | close(): void | 关闭结果集。 |
+| 类名 | 接口名 | 描述 |
+| --------- | ---------------------------------------------------- | ------------------------------------------ |
+| ResultSet | goToFirstRow():boolean | 将结果集移动到第一行。 |
+| ResultSet | getString(columnIndex:number):string | 获取当前行指定列的值,以String类型返回。 |
+| ResultSet | getBlob(columnIndex:number):Uint8Array | 获取当前行指定列的值,以字节数组形式返回。 |
+| ResultSet | getDouble(columnIndex:number):number | 获取当前行指定列的值,以double型返回。 |
+| ResultSet | getLong(columnIndex:number):number | 获取当前行指定列的值,以Long形式返回。 |
+| ResultSet | close():void | 关闭结果集。 |
@@ -151,10 +116,9 @@
**表8** 设置分布式列表
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| RdbStore | setDistributedTables(tables: Array\, callback: AsyncCallback\): void | 设置分布式列表,结果以callback形式返回。
- tables:要设置的分布式列表表名。
- callback:指定callback回调函数。 |
-| RdbStore | setDistributedTables(tables: Array\): Promise\ | 设置分布式列表,结果以Promise形式返回。
- tables:要设置的分布式列表表名。 |
+| 类名 | 接口名 | 描述 |
+| -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| RdbStore | setDistributedTables(tables: Array\): Promise\ | 设置分布式列表,使用Promise异步回调。
-tables:要设置的分布式列表表名。 |
**根据本地表名获取指定远程设备的分布式表名**
@@ -162,35 +126,33 @@
**表9** 根据本地表名获取指定远程设备的分布式表名
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| RdbStore | obtainDistributedTableName(device: string, table: string, callback: AsyncCallback\): void | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名, 结果以callback形式返回。
- device:远程设备。
- table:本地表名。
- callback:指定的callback回调函数,如果操作成功,返回远程设备的分布式表名。 |
-| RdbStore | obtainDistributedTableName(device: string, table: string): Promise\ | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,结果以Promise形式返回。
- device:远程设备。
- table:本地表名。 |
+| 类名 | 接口名 | 描述 |
+| -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| RdbStore | obtainDistributedTableName(device: string, table: string): Promise\ | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,使用Promise异步回调。
-device:远程设备。
-table:本地表名。 |
**在设备之间同步数据**
**表10** 在设备之间同步数据
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback\>): void | 在设备之间同步数据,结果以callback形式返回。
- mode:指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备;SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates:约束同步数据和设备。
- callback:指定的callback回调函数,string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。 |
-| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise\> | 在设备之间同步数据,结果以Promise形式返回。
- mode:指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备;SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates:约束同步数据和设备。 |
+| 类名 | 接口名 | 描述 |
+| -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise\> | 在设备之间同步数据,使用Promise异步回调。
-mode:指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备;SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
-predicates:约束同步数据和设备。
-string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。 |
**注册数据库的观察者**
**表11** 注册数据库的观察者
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| RdbStore |on(event: 'dataChange', type: SubscribeType, observer: Callback\>): void| 注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。
- type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
- observer:指分布式数据库中数据更改事件的观察者。 |
+| 类名 | 接口名 | 描述 |
+| -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| RdbStore | on(event: 'dataChange', type: SubscribeType, observer: Callback\>): void | 注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。
-type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
-observer:指分布式数据库中数据更改事件的观察者。 |
**从数据库中删除指定类型的指定观察者**
**表12** 从数据库中删除指定类型的指定观察者
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| RdbStore |off(event:'dataChange', type: SubscribeType, observer: Callback\>): void;| 从数据库中删除指定类型的指定观察者,结果以callback形式返回。
- type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
- observer:指已注册的数据更改观察者。 |
+| 类名 | 接口名 | 描述 |
+| -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| RdbStore | off(event:'dataChange', type: SubscribeType, observer: Callback\>): void; | 从数据库中删除指定类型的指定观察者,使用callback异步回调。
-type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
-observer:指已注册的数据更改观察者。 |
### 数据库的备份和恢复
@@ -198,29 +160,27 @@
**表13** 备份数据库
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| RdbStore |backup(destName:string, callback: AsyncCallback<void>):void| 以指定名称备份数据库,结果以callback形式返回。
- destName:指定数据库的备份文件名。
- callback:指定callback回调函数。 |
-| RdbStore |backup(destName:string): Promise<void>| 以指定名称备份数据库,结果以promise形式返回。
- destName:指定数据库的备份文件名。 |
+| 类名 | 接口名 | 描述 |
+| -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| RdbStore | backup(destName:string): Promise<void> | 以指定名称备份数据库,使用Promise异步回调。
-destName:指定数据库的备份文件名。 |
**恢复**
**表14** 恢复数据库
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| RdbStore |restore(srcName:string, callback: AsyncCallback<void>):void| 从指定的数据库备份文件恢复数据库,结果以callback形式返回。
- srcName:指定数据库的备份文件名。
- callback:指定callback回调函数。 |
-| RdbStore |restore(srcName:string): Promise<void>| 从指定的数据库备份文件恢复数据库,结果以promise形式返回。
- srcName:指定数据库的备份文件名。 |
+| 类名 | 接口名 | 描述 |
+| -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| RdbStore | restore(srcName:string): Promise<void> | 从指定的数据库备份文件恢复数据库,使用Promise异步回调。
-srcName:指定数据库的备份文件名。 |
**事务**
**表15** 事务
-| 类名 | 接口名 | 描述 |
-| -------- | -------- | -------- |
-| RdbStore |beginTransaction():void| 在开始执行SQL语句之前,开始事务。 |
-| RdbStore |commit():void| 提交已执行的SQL语句。 |
-| RdbStore |rollBack():void| 回滚已经执行的SQL语句。 |
+| 类名 | 接口名 | 描述 |
+| -------- | ----------------------- | --------------------------------- |
+| RdbStore | beginTransaction():void | 在开始执行SQL语句之前,开始事务。 |
+| RdbStore | commit():void | 提交已执行的SQL语句。 |
+| RdbStore | rollBack():void | 回滚已经执行的SQL语句。 |
## 开发步骤
@@ -429,4 +389,4 @@
针对关系型数据库开发,有以下相关实例可供参考:
- [`Rdb`:关系型数据库(eTS)(API8)](https://gitee.com/openharmony/app_samples/tree/master/data/Rdb)
- [`DistributedRdb`:分布式关系型数据库(eTS)(API8)](https://gitee.com/openharmony/app_samples/tree/master/data/DistributedRdb)
-- [关系型数据库(JS)(API8)](https://gitee.com/openharmony/codelabs/tree/master/Data/JSRelationshipData)
+- [关系型数据库(JS)(API8)](https://gitee.com/openharmony/codelabs/tree/master/Data/JSRelationshipData)
\ No newline at end of file