Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
5a7e02f3
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看板
未验证
提交
5a7e02f3
编写于
6月 14, 2022
作者:
葛
葛亚芳
提交者:
Gitee
6月 14, 2022
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update zh-cn/application-dev/database/database-relational-guidelines.md.
Signed-off-by:
N
@ge-yafang
<
geyafang@huawei.com
>
上级
ee5e84fd
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
63 addition
and
63 deletion
+63
-63
zh-cn/application-dev/database/database-relational-guidelines.md
...pplication-dev/database/database-relational-guidelines.md
+63
-63
未找到文件。
zh-cn/application-dev/database/database-relational-guidelines.md
浏览文件 @
5a7e02f3
...
...
@@ -14,10 +14,10 @@
**表1**
数据库创建和删除API
| 接口名 | 描述 |
| --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
|
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:数据库版本。 |
|
deleteRdbStore(name:
string,
callback:
AsyncCallback
<
void
>
):
void | 删除数据库,结果以callback形式返回。
<br/>
-
name:数据库名称。
<br/>
-
callback:指定callback回调函数。 |
| --------
|
-------- |
|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:数据库版本。 |
|deleteRdbStore(name:
string,
callback:
AsyncCallback
<
void
>
):
void | 删除数据库,结果以callback形式返回。
<br/>
-
name:数据库名称。
<br/>
-
callback:指定callback回调函数。 |
| deleteRdbStore(name:
string):
Promise
<
void
>
| 使用指定的数据库文件配置删除数据库,结果以Promise形式返回。
<br/>
-
name:数据库名称。 |
### 数据库的增删改查
...
...
@@ -31,7 +31,7 @@
**表2**
数据库插入API
| 类名 | 接口名 | 描述 |
| -------- | --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
| -------- | --------
|
-------- |
| 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/>
-
name:指定的目标表名。
<br/>
-
values:表示要插入到表中的数据行。 |
...
...
@@ -42,9 +42,9 @@
**表3**
数据库更新API
| 类名 | 接口名 | 描述 |
| -------- | --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
| -------- | --------
|
-------- |
| 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/>
-
values:以ValuesBucket存储的要更新的数据。
<br/>
-
rdbPredicates:表示RdbPredicates的实例对象指定的更新条件。 |
| RdbStore | update(values:
ValuesBucket,
rdbPredicates:
RdbPredicates):
Promise | 根据RdbPredicates的指定实例对象更新数据库中的数据,结果以Promise形式返回。
<br/>
-
values:以ValuesBucket存储的要更新的数据。
<br/>
-
rdbPredicates:表示RdbPredicates的实例对象指定的更新条件。 |
-
**删除**
...
...
@@ -53,9 +53,9 @@
**表4**
数据库删除API
| 类名 | 接口名 | 描述 |
| -------- | --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
| -------- | --------
|
-------- |
| RdbStore | delete(rdbPredicates:
RdbPredicates,
callback:
AsyncCallback
<
number
>
):void | 根据rdbPredicates的指定实例对象从数据库中删除数据,结果以callback形式返回。
<br/>
-
rdbPredicates:RdbPredicates的实例对象指定的删除条件。
<br/>
-
callback:指定callback回调函数。返回受影响的行数。 |
| RdbStore | delete(rdbPredicates:
RdbPredicates):
Promise
| 根据rdbPredicates的指定实例对象从数据库中删除数据,结果以Promise形式返回。
<br/>
-
rdbPredicates:RdbPredicates的实例对象指定的删除条件。 |
| RdbStore | delete(rdbPredicates:
RdbPredicates):
Promise
\<
number>
| 根据rdbPredicates的指定实例对象从数据库中删除数据,结果以Promise形式返回。
<br/>
-
rdbPredicates:RdbPredicates的实例对象指定的删除条件。 |
-
**查询**
...
...
@@ -67,7 +67,7 @@
**表5**
数据库查询API
| 类名 | 接口名 | 描述 |
| -------- | --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
| -------- | --------
|
-------- |
| 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 | querySql(sql:
string,
bindArgs:
Array
<
ValueType
>
,
callback:
AsyncCallback
<
ResultSet
>
):void | 根据指定SQL语句查询数据库中的数据,结果以callback形式返回。
<br/>
-
sql:指定要查询的SQL语句。
<br/>
-
bindArgs:SQL语句中参数的值。
<br/>
-
callback:指定callback回调函数。如果操作成功,则返回ResultSet对象。 |
...
...
@@ -80,9 +80,9 @@
**表6**
数据库谓词API
| 类名 | 接口名 | 描述 |
| --------
----- | ------------------------------------------------------------ | ----------------------------------------------------
-------- |
| RdbPredicates |
inDevices(devices: Array
\<
string>): RdbPredicates
| 同步分布式数据库时指定组网内的远程设备。
<br/>
-
devices:组网内指定的远程设备ID。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates |
inAllDevices(): RdbPredicates
| 同步分布式数据库时连接到组网内的所有远程设备。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| --------
| -------- |
-------- |
| RdbPredicates |
inDevices(devices: Array
\<
string>): RdbPredicates
| 同步分布式数据库时指定组网内的远程设备。
<br/>
-
devices:组网内指定的远程设备ID。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates |
inAllDevices(): RdbPredicates
| 同步分布式数据库时连接到组网内的所有远程设备。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | equalTo(field:
string,
value:
ValueType):
RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | notEqualTo(field:
string,
value:
ValueType):
RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
<br/>
-
field:数据库表中的列名。
<br/>
-
value:指示要与谓词匹配的值。
<br/>
-
RdbPredicates:返回与指定字段匹配的谓词。 |
| RdbPredicates | beginWrap():
RdbPredicates | 向谓词添加左括号。
<br/>
-
RdbPredicates:返回带有左括号的谓词。 |
...
...
@@ -122,7 +122,7 @@
**表7**
结果集API
| 类名 | 接口名 | 描述 |
| --------
- | ---------------------------------------------------- | ----------------------------------
-------- |
| --------
| -------- |
-------- |
| ResultSet | goTo(offset:number):
boolean | 从结果集当前位置移动指定偏移量。 |
| ResultSet | goToRow(position:
number):
boolean | 将结果集移动到指定位置。 |
| ResultSet | goToNextRow():
boolean | 将结果集向后移动一行。 |
...
...
@@ -148,7 +148,7 @@
**表8**
设置分布式列表
| 类名 | 接口名 | 描述 |
| -------- | --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
| -------- | --------
|
-------- |
| 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:要设置的分布式列表表名。 |
...
...
@@ -159,7 +159,7 @@
**表9**
根据本地表名获取指定远程设备的分布式表名
| 类名 | 接口名 | 描述 |
| -------- | --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
| -------- | --------
|
-------- |
| 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:本地表名。 |
...
...
@@ -168,25 +168,25 @@
**表10**
在设备之间同步数据
| 类名 | 接口名 | 描述 |
| -------- | --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
| 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:约束同步数据和设备。
|
| -------- | --------
|
-------- |
| 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:约束同步数据和设备。
|
**注册数据库的观察者**
**表11**
注册数据库的观察者
| 类名 | 接口名 | 描述 |
| -------- | --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
| 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:指分布式数据库中数据更改事件的观察者。 |
**从数据库中删除指定类型的指定观察者**
**表12**
从数据库中删除指定类型的指定观察者
| 类名 | 接口名 | 描述 |
| -------- | --------
---------------------------------------------------- | ----------------------------------------------------
-------- |
| 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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录