diff --git a/zh-cn/application-dev/database/database-relational-guidelines.md b/zh-cn/application-dev/database/database-relational-guidelines.md index 149df7f17853aa74a3ba452c924dd039f00b2c21..e5e351c0e9d51a6680578aed8d221ffd9898444e 100644 --- a/zh-cn/application-dev/database/database-relational-guidelines.md +++ b/zh-cn/application-dev/database/database-relational-guidelines.md @@ -44,7 +44,7 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | | RdbStore | update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void | 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以callback形式返回。
- values：以ValuesBucket存储的要更新的数据。
- rdbPredicates：表示RdbPredicates的实例对象指定的更新条件。
- callback：指定的callback回调方法。返回受影响的行数。 | - | RdbStore | update(values: ValuesBucket, rdbPredicates: RdbPredicates): Promise | 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以Promise形式返回。
- values：以ValuesBucket存储的要更新的数据。
- rdbPredicates：表示RdbPredicates的实例对象指定的更新条件。 | + | RdbStore | update(values: ValuesBucket, rdbPredicates: RdbPredicates): Promise\ | 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以Promise形式返回。
- values：以ValuesBucket存储的要更新的数据。
- rdbPredicates：表示RdbPredicates的实例对象指定的更新条件。 | - **删除** @@ -81,7 +81,7 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| RdbPredicates |inDevices(devices: Array): RdbPredicates | 同步分布式数据库时指定组网内的远程设备。
- devices：组网内指定的远程设备ID。
- RdbPredicates：返回与指定字段匹配的谓词。 | +| 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：返回与指定字段匹配的谓词。 | @@ -116,7 +116,7 @@ 关系型数据库提供了查询返回的结果集ResultSet，其指向查询结果中的一行数据，供用户对查询结果进行遍历和访问。ResultSet对外API如下所示。 -> ![icon-notice.gif](public_sys-resources/icon-notice.gif) **须知：** +> **须知：** > **结果集使用完后，请一定要调用close方法显式关闭。** **表7** 结果集API @@ -149,8 +149,8 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| RdbStore | setDistributedTables(tables: Array, callback: AsyncCallback): void;| 设置分布式列表，结果以callback形式返回。
- tables：要设置的分布式列表表名。
- callback：指定callback回调函数。 | -| RdbStore | setDistributedTables(tables: Array): Promise; | 设置分布式列表，结果以Promise形式返回。
- tables：要设置的分布式列表表名。 | +| RdbStore | setDistributedTables(tables: Array\, callback: AsyncCallback\): void | 设置分布式列表，结果以callback形式返回。
- tables：要设置的分布式列表表名。
- callback：指定callback回调函数。 | +| RdbStore | setDistributedTables(tables: Array\): Promise\ | 设置分布式列表，结果以Promise形式返回。
- tables：要设置的分布式列表表名。 | **根据本地表名获取指定远程设备的分布式表名** @@ -160,8 +160,8 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| 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, callback: AsyncCallback\): void | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 结果以callback形式返回。
- device：远程设备。
- table：本地表名。
- callback：指定的callback回调函数，如果操作成功，返回远程设备的分布式表名。 | +| RdbStore | obtainDistributedTableName(device: string, table: string): Promise\ | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，结果以Promise形式返回。
- device：远程设备。
- table：本地表名。 | **在设备之间同步数据** @@ -169,8 +169,8 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| 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, 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：约束同步数据和设备。 | **注册数据库的观察者** @@ -186,7 +186,7 @@ | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | -| 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：指已注册的数据更改观察者。 | ## 开发步骤 @@ -269,7 +269,8 @@ }).catch((err) => { console.info("setDistributedTables failed.") }) - + ``` + 5. 分布式数据同步。 1. 构造用于同步分布式表的谓词对象，指定组网内的远程设备。 2. 调用同步数据的接口 。