Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
210f6ceb
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
210f6ceb
编写于
8月 12, 2022
作者:
O
openharmony_ci
提交者:
Gitee
8月 12, 2022
浏览文件
操作
浏览文件
下载
差异文件
!8065 【轻量级 PR】:update zh-cn/application-dev/database/database-relational-guidelines.md.
Merge pull request !8065 from 葛亚芳/N/A
上级
e539e44e
30b0fc65
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
31 addition
and
68 deletion
+31
-68
zh-cn/application-dev/database/database-relational-guidelines.md
...pplication-dev/database/database-relational-guidelines.md
+31
-68
未找到文件。
zh-cn/application-dev/database/database-relational-guidelines.md
浏览文件 @
210f6ceb
...
@@ -6,7 +6,7 @@
...
@@ -6,7 +6,7 @@
## 接口说明
## 接口说明
具体关系型数据库相关功能接口
请见
[
关系型数据库
](
../reference/apis/js-apis-data-rdb.md
)
。
以下是关系型数据库的常用接口说明,大部分为异步接口。异步接口均有callback和Promise两种返回形式,下表均以Promise形式为例,更多接口及使用方式
请见
[
关系型数据库
](
../reference/apis/js-apis-data-rdb.md
)
。
### 数据库的创建和删除
### 数据库的创建和删除
...
@@ -16,10 +16,8 @@
...
@@ -16,10 +16,8 @@
| 接口名 | 描述 |
| 接口名 | 描述 |
| -------- | -------- |
| -------- | -------- |
|getRdbStore(config:
StoreConfig,
version:
number,
callback:
AsyncCallback
<
RdbStore
>
):
void | 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以callback形式返回。
<br/>
-
config:与此RDB存储相关的数据库配置。
<br/>
-
version:数据库版本。
<br/>
-
callback:指定callback回调函数。返回一个RdbStore。 |
|getRdbStore(config:StoreConfig,version:number):Promise
<
RdbStore
>
| 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,使用Promise异步回调。
<br/>
-config:与此RDB存储相关的数据库配置。
<br/>
-version:数据库版本。 |
|getRdbStore(config:
StoreConfig,
version:
number):
Promise
<
RdbStore
>
| 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以Promise形式返回。
<br/>
-
config:与此RDB存储相关的数据库配置。
<br/>
-
version:数据库版本。 |
| deleteRdbStore(name:string):Promise
<
void
>
| 使用指定的数据库文件配置删除数据库,使用Promise异步回调。
<br/>
-name:数据库名称。 |
|deleteRdbStore(name:
string,
callback:
AsyncCallback
<
void
>
):
void | 删除数据库,结果以callback形式返回。
<br/>
-
name:数据库名称。
<br/>
-
callback:指定callback回调函数。 |
| deleteRdbStore(name:
string):
Promise
<
void
>
| 使用指定的数据库文件配置删除数据库,结果以Promise形式返回。
<br/>
-
name:数据库名称。 |
### 数据库的增删改查
### 数据库的增删改查
...
@@ -33,8 +31,7 @@
...
@@ -33,8 +31,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbStore | insert(name:
string,
values:
ValuesBucket,
callback:
AsyncCallback
<
number
>
):void | 向目标表中插入一行数据,结果以callback形式返回。
<br/>
-
name:指定的目标表名。
<br/>
-
values:表示要插入到表中的数据行。
<br/>
-
callback:指定callback回调函数。如果操作成功,返回行ID;否则返回-1。 |
| RdbStore | insert(name:string,values:ValuesBucket):Promise
<
number
>
| 向目标表中插入一行数据,使用Promise异步回调。
<br>
如果操作成功,返回行ID;否则返回-1。
<br/>
-name:指定的目标表名。
<br/>
-values:表示要插入到表中的数据行。 |
| RdbStore | insert(name:
string,
values:
ValuesBucket):
Promise
<
number
>
| 向目标表中插入一行数据,结果以Promise形式返回。
<br/>
-
name:指定的目标表名。
<br/>
-
values:表示要插入到表中的数据行。 |
-
**更新**
-
**更新**
...
@@ -44,8 +41,7 @@
...
@@ -44,8 +41,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbStore | update(values:
ValuesBucket,
rdbPredicates:
RdbPredicates,
callback:
AsyncCallback
<
number
>
):void | 根据RdbPredicates的指定实例对象更新数据库中的数据,结果以callback形式返回。
<br/>
-
values:以ValuesBucket存储的要更新的数据。
<br/>
-
rdbPredicates:表示RdbPredicates的实例对象指定的更新条件。
<br/>
-
callback:指定的callback回调方法。返回受影响的行数。 |
| RdbStore | update(values:ValuesBucket,rdbPredicates:RdbPredicates):Promise
\<
number> | 根据RdbPredicates的指定实例对象更新数据库中的数据,使用Promise异步回调。
<br>
返回受影响的行数。
<br/>
-values:以ValuesBucket存储的要更新的数据。
<br/>
-rdbPredicates:表示RdbPredicates的实例对象指定的更新条件。 |
| RdbStore | update(values:
ValuesBucket,
rdbPredicates:
RdbPredicates):
Promise
\<
number> | 根据RdbPredicates的指定实例对象更新数据库中的数据,结果以Promise形式返回。
<br/>
-
values:以ValuesBucket存储的要更新的数据。
<br/>
-
rdbPredicates:表示RdbPredicates的实例对象指定的更新条件。 |
-
**删除**
-
**删除**
...
@@ -55,8 +51,7 @@
...
@@ -55,8 +51,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbStore | delete(rdbPredicates:
RdbPredicates,
callback:
AsyncCallback
<
number
>
):void | 根据rdbPredicates的指定实例对象从数据库中删除数据,结果以callback形式返回。
<br/>
-
rdbPredicates:RdbPredicates的实例对象指定的删除条件。
<br/>
-
callback:指定callback回调函数。返回受影响的行数。 |
| RdbStore | delete(rdbPredicates:RdbPredicates):Promise
\<
number> | 根据rdbPredicates的指定实例对象从数据库中删除数据,使用Promise异步回调。
<br>
返回受影响的行数。
<br/>
-rdbPredicates:RdbPredicates的实例对象指定的删除条件。 |
| RdbStore | delete(rdbPredicates:
RdbPredicates):
Promise
\<
number> | 根据rdbPredicates的指定实例对象从数据库中删除数据,结果以Promise形式返回。
<br/>
-
rdbPredicates:RdbPredicates的实例对象指定的删除条件。 |
-
**查询**
-
**查询**
...
@@ -69,74 +64,45 @@
...
@@ -69,74 +64,45 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbStore | query(rdbPredicates:
RdbPredicates,
columns:
Array,
callback:
AsyncCallback
<
ResultSet
>
):
void | 根据指定条件查询数据库中的数据,结果以callback形式返回。
<br/>
-
rdbPredicates:表示RdbPredicates的实例对象指定的查询条件。
<br/>
-
columns:表示要查询的列。如果值为空,则查询应用于所有列。
<br/>
-
callback:指定callback回调函数。如果操作成功,则返回ResultSet对象。 |
| RdbStore | query(rdbPredicates:RdbPredicates,columns:Array):Promise
<
ResultSet
>
| 根据指定条件查询数据库中的数据,使用Promise异步回调。
<br/>
-rdbPredicates:表示RdbPredicates的实例对象指定的查询条件。
<br/>
-columns:表示要查询的列。如果值为空,则查询应用于所有列。 |
| RdbStore | query(rdbPredicates:
RdbPredicates,
columns:
Array):
Promise
<
ResultSet
>
| 根据指定条件查询数据库中的数据,结果以Promise形式返回。
<br/>
-
rdbPredicates:表示RdbPredicates的实例对象指定的查询条件。
<br/>
-
columns:表示要查询的列。如果值为空,则查询应用于所有列。 |
| RdbStore | querySql(sql:string,bindArgs?:Array
<
ValueType
>
):Promise
<
ResultSet
>
| 根据指定SQL语句查询数据库中的数据,使用Promise异步回调。
<br/>
-sql:指定要查询的SQL语句。
<br/>
-bindArgs:SQL语句中参数的值。 |
| RdbStore | querySql(sql:
string,
bindArgs:
Array
<
ValueType
>
,
callback:
AsyncCallback
<
ResultSet
>
):void | 根据指定SQL语句查询数据库中的数据,结果以callback形式返回。
<br/>
-
sql:指定要查询的SQL语句。
<br/>
-
bindArgs:SQL语句中参数的值。
<br/>
-
callback:指定callback回调函数。如果操作成功,则返回ResultSet对象。 |
| RdbStore | querySql(sql:
string,
bindArgs?:
Array
<
ValueType
>
):Promise
<
ResultSet
>
| 根据指定SQL语句查询数据库中的数据,结果以Promise形式返回。
<br/>
-
sql:指定要查询的SQL语句。
<br/>
-
bindArgs:SQL语句中参数的值。 |
### 数据库谓词的使用
### 数据库谓词的使用
关系型数据库提供了用于设置数据库操作条件的谓词RdbPredicates,该类确定RDB中条件表达式的值是true还是false。
关系型数据库提供了用于设置数据库操作条件的谓词RdbPredicates,该类确定RDB中条件表达式的值是true还是false。
以下列举几个常用谓词,更多谓词的使用请见
[
关系型数据库谓词
](
../reference/apis/js-apis-data-rdb.md#rdbpredicates
)
。
**表6**
数据库谓词API
**表6**
数据库谓词API
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbPredicates |inDevices(devices: Array
\<
string>): RdbPredicates | 同步分布式数据库时指定组网内的远程设备。
<br/>
-
devices:组网内指定的远程设备ID。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | equalTo(field:string,value:ValueType):RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
<br/>
-field:数据库表中的列名。
<br/>
-value:指示要与谓词匹配的值。
<br/>
-RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates |inAllDevices(): RdbPredicates | 同步分布式数据库时连接到组网内的所有远程设备。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | notEqualTo(field:string,value:ValueType):RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
<br/>
-field:数据库表中的列名。
<br/>
-value:指示要与谓词匹配的值。
<br/>
-RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | equalTo(field:
string,
value:
ValueType):
RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | or():RdbPredicates | 将或条件添加到谓词中。
<br/>
-RdbPredicates:返回带有或条件的谓词。 |
| RdbPredicates | notEqualTo(field:
string,
value:
ValueType):
RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | and():RdbPredicates | 向谓词添加和条件。
<br/>
-RdbPredicates:返回带有和条件的谓词。 |
| RdbPredicates | beginWrap():
RdbPredicates | 向谓词添加左括号。
<br/>
-
RdbPredicates:返回带有左括号的谓词。 |
| RdbPredicates | contains(field:string,value:string):RdbPredicats | 配置谓词以匹配数据字段为String且value包含指定值的字段。
<br/>
-field:数据库表中的列名。
<br/>
-value:指示要与谓词匹配的值。
<br/>
-RdbPredicates:返回带有包含条件的谓词。 |
| RdbPredicates | endWrap():
RdbPredicates | 向谓词添加右括号。
<br/>
-
RdbPredicates:返回带有右括号的谓词。 |
| RdbPredicates | or():
RdbPredicates | 将或条件添加到谓词中。
<br/>
-
RdbPredicates:返回带有或条件的谓词。 |
| RdbPredicates | and():
RdbPredicates | 向谓词添加和条件。
<br/>
-
RdbPredicates:返回带有和条件的谓词。 |
| RdbPredicates | contains(field:
string,
value:
string):
RdbPredicats | 配置谓词以匹配数据字段为String且value包含指定值的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回带有包含条件的谓词。 |
| RdbPredicates | beginsWith(field:
string,
value:
string):
RdbPredicates | 配置谓词以匹配数据字段为String且值以指定字符串开头的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | endsWith(field:
string,
value:
string):
RdbPredicates | 配置谓词以匹配数据字段为String且值以指定字符串结尾的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | isNull(field:
string):
RdbPredicates | 配置谓词以匹配值为null的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | isNotNull(field:
string):
RdbPredicates | 配置谓词以匹配值不为null的指定字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | like(field:
string,
value:
string):
RdbPredicates | 配置谓词以匹配数据字段为String且值类似于指定字符串的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | glob(field:
string,
value:
string):
RdbPredicates | 配置RdbPredicates匹配数据字段为String的指定字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | between(field:
string,
low:
ValueType,
high:
ValueType):
RdbPredicates | 将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
low:指示与谓词匹配的最小值。
<br/>
-
high:指示与谓词匹配的最大值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | notBetween(field:
string,
low:
ValueType,
high:
ValueType):
RdbPredicates | 配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
low:指示与谓词匹配的最小值。
<br/>
-
high:指示与谓词匹配的最大值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | greaterThan(field:
string,
value:
ValueType):
RdbPredicatesgr | 配置谓词以匹配数据字段为ValueType且值大于指定值的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | lessThan(field:
string,
value:
ValueType):
RdbPredicates | 配置谓词以匹配数据字段为valueType且value小于指定值的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | greaterThanOrEqualTo(field:
string,
value:
ValueType):
RdbPredicates | 配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | lessThanOrEqualTo(field:
string,
value:
ValueType):
RdbPredicates | 配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | orderByAsc(field:
string):
RdbPredicates | 配置谓词以匹配其值按升序排序的列。
<br/>
-
field:数据库表中的列名。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | orderByDesc(field:
string):
RdbPredicates | 配置谓词以匹配其值按降序排序的列。
<br/>
-
field:数据库表中的列名。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | distinct():
RdbPredicates | 配置谓词以过滤重复记录并仅保留其中一个。
<br/>
-
RdbPredicates:返回可用于过滤重复记录的谓词。 |
| RdbPredicates | limitAs(value:
number):
RdbPredicates | 设置最大数据记录数的谓词。
<br/>
-
value:最大数据记录数。
<br/>
-
RdbPredicates:返回可用于设置最大数据记录数的谓词。 |
| RdbPredicates | offsetAs(rowOffset:
number):
RdbPredicates | 配置RdbPredicates以指定返回结果的起始位置。
<br/>
-
rowOffset:返回结果的起始位置,取值为正整数。
<br/>
-
RdbPredicates:返回具有指定返回结果起始位置的谓词。 |
| RdbPredicates | groupBy(fields:
Array
<
string
>
):
RdbPredicates | 配置RdbPredicates按指定列分组查询结果。
<br/>
-
fields:指定分组依赖的列名。
<br/>
-
RdbPredicates:返回分组查询列的谓词。 |
| RdbPredicates | indexedBy(indexName:
string):
RdbPredicates | 配置RdbPredicates以指定索引列。
<br/>
-
indexName:索引列的名称。
<br/>
-
RdbPredicates:返回具有指定索引列的RdbPredicates。 |
| RdbPredicates | in(field:
string,
value:
Array
<
ValueType
>
):
RdbPredicates | 配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:以ValueType型数组形式指定的要匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | notIn(field:
string,
value:
Array
<
ValueType
>
):
RdbPredicates | 将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:以ValueType型数组形式指定的要匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
### 查询结果集的使用
### 查询结果集的使用
关系型数据库提供了查询返回的结果集ResultSet,其指向查询结果中的一行数据,供用户对查询结果进行遍历和访问。ResultSet对外API如下所示。
关系型数据库提供了查询返回的结果集ResultSet,其指向查询结果中的一行数据,供用户对查询结果进行遍历和访问。
更多结果集的接口使用,请见
[
结果集
](
../reference/apis/js-apis-data-resultset.md
)
。
>

**须知:**
> **须知:**
> **结果集使用完后,请一定要调用close方法显式关闭。**
> **结果集使用完后,请一定要调用close方法显式关闭。**
**表7**
结果集API
**表7**
结果集API
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| ResultSet | goTo(offset:number):
boolean | 从结果集当前位置移动指定偏移量。 |
| ResultSet | goToFirstRow():boolean | 将结果集移动到第一行。 |
| ResultSet | goToRow(position:
number):
boolean | 将结果集移动到指定位置。 |
| ResultSet | getString(columnIndex:number):string | 获取当前行指定列的值,以String类型返回。 |
| ResultSet | goToNextRow():
boolean | 将结果集向后移动一行。 |
| ResultSet | getBlob(columnIndex:number):Uint8Array | 获取当前行指定列的值,以字节数组形式返回。 |
| ResultSet | goToPreviousRow():
boolean | 将结果集向前移动一行。 |
| ResultSet | getDouble(columnIndex:number):number | 获取当前行指定列的值,以double型返回。 |
| ResultSet | getColumnIndex(columnName:
string):
number | 根据指定的列名获取列索引。 |
| ResultSet | getLong(columnIndex:number):number | 获取当前行指定列的值,以Long形式返回。 |
| ResultSet | getColumnName(columnIndex:
number):
string | 根据指定的列索引获取列名。 |
| ResultSet | close():void | 关闭结果集。 |
| 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 | 关闭结果集。 |
...
@@ -148,8 +114,7 @@
...
@@ -148,8 +114,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbStore | setDistributedTables(tables: Array
\<
string>, callback: AsyncCallback
\<
void>): void; | 设置分布式列表,结果以callback形式返回。
<br/>
-
tables:要设置的分布式列表表名。
<br/>
-
callback:指定callback回调函数。 |
| RdbStore | setDistributedTables(tables: Array
\<
string>): Promise
\<
void>; | 设置分布式列表,使用Promise异步回调。
<br/>
-tables:要设置的分布式列表表名。 |
| RdbStore | setDistributedTables(tables: Array
\<
string>): Promise
\<
void>; | 设置分布式列表,结果以Promise形式返回。
<br/>
-
tables:要设置的分布式列表表名。 |
**根据本地表名获取指定远程设备的分布式表名**
**根据本地表名获取指定远程设备的分布式表名**
...
@@ -159,8 +124,7 @@
...
@@ -159,8 +124,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbStore | obtainDistributedTableName(device: string, table: string, callback: AsyncCallback
\<
string>): void; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名, 结果以callback形式返回。
<br/>
-
device:远程设备。
<br/>
-
table:本地表名。
<br/>
-
callback:指定的callback回调函数,如果操作成功,返回远程设备的分布式表名。 |
| RdbStore | obtainDistributedTableName(device: string, table: string): Promise
\<
string>; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,使用Promise异步回调。
<br/>
-device:远程设备。
<br/>
-table:本地表名。 |
| RdbStore | obtainDistributedTableName(device: string, table: string): Promise
\<
string>; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,结果以Promise形式返回。
<br/>
-
device:远程设备。
<br/>
-
table:本地表名。 |
**在设备之间同步数据**
**在设备之间同步数据**
...
@@ -168,8 +132,7 @@
...
@@ -168,8 +132,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback
<Array
<[
string
,
number
]
>
>): void;| 在设备之间同步数据,结果以callback形式返回。
<br/>
-
mode:指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备;SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
<br/>
-
predicates:约束同步数据和设备。
<br/>
-
callback:指定的callback回调函数,string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。 |
| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise
<Array
<[
string
,
number
]
>
>;| 在设备之间同步数据,使用Promise异步回调。
<br/>
-mode:指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备;SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
<br/>
-predicates:约束同步数据和设备。
<br>
-string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。 |
| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise
<Array
<[
string
,
number
]
>
>;| 在设备之间同步数据,结果以Promise形式返回。
<br/>
-
mode:指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备;SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
<br/>
-
predicates:约束同步数据和设备。 |
**注册数据库的观察者**
**注册数据库的观察者**
...
@@ -177,7 +140,7 @@
...
@@ -177,7 +140,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbStore |on(event: 'dataChange', type: SubscribeType, observer: Callback
<Array
\<
string
>
>): void;| 注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。
<br/>
-
type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
<br/>
-
observer:指分布式数据库中数据更改事件的观察者。 |
| RdbStore |on(event: 'dataChange', type: SubscribeType, observer: Callback
<Array
\<
string
>
>): void;| 注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。
<br/>
-
type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
<br/>
-
observer:指分布式数据库中数据更改事件的观察者。 |
**从数据库中删除指定类型的指定观察者**
**从数据库中删除指定类型的指定观察者**
...
@@ -185,7 +148,7 @@
...
@@ -185,7 +148,7 @@
| 类名 | 接口名 | 描述 |
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| RdbStore |off(event:'dataChange', type: SubscribeType, observer: Callback
<Array
\<
string
>
>): void;| 从数据库中删除指定类型的指定观察者,结果以callback形式返回。
<br/>
-
type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
<br/>
-
observer:指已注册的数据更改观察者。 |
| RdbStore |off(event:'dataChange', type: SubscribeType, observer: Callback
<Array
\<
string
>
>): void;| 从数据库中删除指定类型的指定观察者,结果以callback形式返回。
<br/>
-
type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
<br/>
-
observer:指已注册的数据更改观察者。 |
## 开发步骤
## 开发步骤
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录