Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
f551c800
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
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看板
体验新版 GitCode,发现更多精彩内容 >>
提交
f551c800
编写于
6月 22, 2022
作者:
W
wuyongning
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
增加模块说明/修复示例代码问题
Signed-off-by:
N
wuyongning
<
wuyongning@huawei.com
>
上级
729ada92
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
14 addition
and
121 deletion
+14
-121
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
+14
-121
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
浏览文件 @
f551c800
# 关系型数据库
# 关系型数据库
关系型数据库(Relational Database,RDB)是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制,对外提供了一系列的增、删、改、查等接口,也可以直接运行用户输入的SQL语句来满足复杂的场景需要。
该模块提供以下关系型数据库相关的常用功能:
-
[
RdbPredicates
](
#rdbpredicates
)
: 数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项,主要用来定义数据库的操作条件。
-
[
RdbStore
](
#rdbstore
)
:提供管理关系数据库(RDB)方法的接口。
> **说明:**
> **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
@@ -11,68 +18,6 @@ import data_rdb from '@ohos.data.rdb';
...
@@ -11,68 +18,6 @@ import data_rdb from '@ohos.data.rdb';
## data_rdb.getRdbStore
## data_rdb.getRdbStore
getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback
<
RdbStore
>
): void
获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以callback形式返回。
**系统能力:**
SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config |
[
StoreConfig
](
#storeconfig
)
| 是 | 与此RDB存储相关的数据库配置。 |
| version | number | 是 | 数据库版本。 |
| callback | AsyncCallback
<
[RdbStore](#rdbstore)
>
| 是 | 指定callback回调函数,返回一个RdbStore。 |
**示例:**
```
js
const
STORE_CONFIG
=
{
name
:
"
RdbTest.db
"
}
data_rdb
.
getRdbStore
(
STORE_CONFIG
,
1
,
function
(
err
,
rdbStore
)
{
if
(
err
)
{
console
.
info
(
"
Get RdbStore failed, err:
"
+
err
)
return
}
console
.
log
(
"
Get RdbStore successfully.
"
)
})
```
## data_rdb.getRdbStore
getRdbStore(config: StoreConfig, version: number): Promise
<
RdbStore
>
获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以Promise形式返回。
**系统能力:**
SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config |
[
StoreConfig
](
#storeconfig
)
| 是 | 与此RDB存储相关的数据库配置。 |
| version | number | 是 | 数据库版本。 |
**返回值**
:
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[RdbStore](#rdbstore)
>
| 指定Promise回调函数。返回一个RdbStore。 |
**示例:**
```
js
const
STORE_CONFIG
=
{
name
:
"
RdbTest.db
"
}
let
promise
=
data_rdb
.
getRdbStore
(
STORE_CONFIG
,
1
);
promise
.
then
(
async
(
rdbStore
)
=>
{
console
.
log
(
"
Get RdbStore successfully.
"
)
}).
catch
((
err
)
=>
{
console
.
log
(
"
Get RdbStore failed, err:
"
+
err
)
})
```
## data_rdb.getRdbStore<sup>8+</sup>
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形式返回。
获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以callback形式返回。
...
@@ -101,7 +46,7 @@ data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) {
...
@@ -101,7 +46,7 @@ data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) {
})
})
```
```
## data_rdb.getRdbStore
<sup>8+</sup>
## data_rdb.getRdbStore
getRdbStore(context: Context, config: StoreConfig, version: number): Promise
<
RdbStore
>
getRdbStore(context: Context, config: StoreConfig, version: number): Promise
<
RdbStore
>
...
@@ -137,58 +82,6 @@ promise.then(async (rdbStore) => {
...
@@ -137,58 +82,6 @@ promise.then(async (rdbStore) => {
## data_rdb.deleteRdbStore
## data_rdb.deleteRdbStore
deleteRdbStore(name: string, callback: AsyncCallback
<
void
>
): void
删除数据库,结果以callback形式返回。
**系统能力:**
SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库名称。 |
| callback | AsyncCallback
<
void
>
| 是 | 指定callback回调函数。 |
**示例:**
```
js
data_rdb
.
deleteRdbStore
(
"
RdbTest.db
"
,
function
(
err
,
rdbStore
)
{
if
(
err
)
{
console
.
info
(
"
Delete RdbStore failed, err:
"
+
err
)
return
}
console
.
log
(
"
Delete RdbStore successfully.
"
)
})
```
## data_rdb.deleteRdbStore
deleteRdbStore(name: string): Promise
<
void
>
使用指定的数据库文件配置删除数据库,结果以Promise形式返回。
**系统能力:**
SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库名称。 |
**返回值**
:
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 指定Promise回调函数。 |
**示例:**
```
js
let
promise
=
data_rdb
.
deleteRdbStore
(
"
RdbTest.db
"
)
promise
.
then
(()
=>
{
console
.
log
(
"
Delete RdbStore successfully.
"
)
}).
catch
((
err
)
=>
{
console
.
info
(
"
Delete RdbStore failed, err:
"
+
err
)
})
```
## data_rdb.deleteRdbStore<sup>8+</sup>
deleteRdbStore(context: Context, name: string, callback: AsyncCallback
<
void
>
): void
deleteRdbStore(context: Context, name: string, callback: AsyncCallback
<
void
>
): void
删除数据库,结果以callback形式返回。
删除数据库,结果以callback形式返回。
...
@@ -213,7 +106,7 @@ data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) {
...
@@ -213,7 +106,7 @@ data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) {
})
})
```
```
## data_rdb.deleteRdbStore
<sup>8+</sup>
## data_rdb.deleteRdbStore
deleteRdbStore(context: Context, name: string): Promise
<
void
>
deleteRdbStore(context: Context, name: string): Promise
<
void
>
...
@@ -234,7 +127,7 @@ deleteRdbStore(context: Context, name: string): Promise<void>
...
@@ -234,7 +127,7 @@ deleteRdbStore(context: Context, name: string): Promise<void>
**示例:**
**示例:**
```
js
```
js
let
promise
=
data_rdb
.
deleteRdbStore
(
"
RdbTest.db
"
)
let
promise
=
data_rdb
.
deleteRdbStore
(
this
.
context
,
"
RdbTest.db
"
)
promise
.
then
(()
=>
{
promise
.
then
(()
=>
{
console
.
log
(
"
Delete RdbStore successfully.
"
)
console
.
log
(
"
Delete RdbStore successfully.
"
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -1605,7 +1498,7 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac
...
@@ -1605,7 +1498,7 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac
**示例:**
**示例:**
```
js
```
js
rdbStore
.
obtainDistributedTableName
(
deviceId
,
"
EMPLOYEE
"
,
function
(
err
,
tableName
)
{
rdbStore
.
obtainDistributedTableName
(
"
12345678abcde
"
,
"
EMPLOYEE
"
,
function
(
err
,
tableName
)
{
if
(
err
)
{
if
(
err
)
{
console
.
info
(
'
obtainDistributedTableName failed, err:
'
+
err
)
console
.
info
(
'
obtainDistributedTableName failed, err:
'
+
err
)
return
return
...
@@ -1636,7 +1529,7 @@ rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE", function (err, tableNa
...
@@ -1636,7 +1529,7 @@ rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE", function (err, tableNa
**示例:**
**示例:**
```
js
```
js
let
promise
=
rdbStore
.
obtainDistributedTableName
(
deviceId
,
"
EMPLOYEE
"
)
let
promise
=
rdbStore
.
obtainDistributedTableName
(
"
12345678abcde
"
,
"
EMPLOYEE
"
)
promise
.
then
((
tableName
)
=>
{
promise
.
then
((
tableName
)
=>
{
console
.
info
(
'
obtainDistributedTableName successfully, tableName=
'
+
tableName
)
console
.
info
(
'
obtainDistributedTableName successfully, tableName=
'
+
tableName
)
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
...
@@ -1661,9 +1554,9 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array
...
@@ -1661,9 +1554,9 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array
**示例:**
**示例:**
```
js
```
js
let
predicates
=
new
rdb
.
RdbPredicates
(
'
EMPLOYEE
'
)
let
predicates
=
new
data_
rdb
.
RdbPredicates
(
'
EMPLOYEE
'
)
predicates
.
inDevices
([
'
12345678abcde
'
])
predicates
.
inDevices
([
'
12345678abcde
'
])
rdbStore
.
sync
(
rdb
.
SyncMode
.
SYNC_MODE_PUSH
,
predicates
,
function
(
err
,
result
)
{
rdbStore
.
sync
(
data_
rdb
.
SyncMode
.
SYNC_MODE_PUSH
,
predicates
,
function
(
err
,
result
)
{
if
(
err
)
{
if
(
err
)
{
console
.
log
(
'
sync failed, err:
'
+
err
)
console
.
log
(
'
sync failed, err:
'
+
err
)
return
return
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录