提交 fe4818c7 编写于 作者: W wuyongning

add backup/restore docs

Signed-off-by: Nwuyongning <wuyongning@huawei.com>
上级 afdc4a0f
......@@ -188,6 +188,25 @@
| -------- | -------- | -------- |
| RdbStore |off(event:'dataChange', type: SubscribeType, observer: Callback\<Array\<string>>): void;| 从数据库中删除指定类型的指定观察者,结果以callback形式返回。<br/>-&nbsp;type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-&nbsp;observer:指已注册的数据更改观察者。 |
### 数据库的备份和恢复
**备份**
**表13** 备份数据库
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore |backup(destName:string, callback: AsyncCallback&lt;void&gt;):void| 以指定名称备份数据库,结果以callback形式返回。<br/>-&nbsp;destName:指定数据库的备份文件名。<br/>-&nbsp;callback:指定callback回调函数。 |
| RdbStore |backup(destName:string): Promise&lt;void&gt;| 以指定名称备份数据库,结果以promise形式返回。<br/>-&nbsp;destName:指定数据库的备份文件名。 |
**恢复**
**表13** 恢复数据库
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore |restore(srcName:string, callback: AsyncCallback&lt;void&gt;):void| 从指定的数据库备份文件恢复数据库,结果以callback形式返回。<br/>-&nbsp;srcName:指定数据库的备份文件名。<br/>-&nbsp;callback:指定callback回调函数。 |
| RdbStore |restore(srcName:string): Promise&lt;void&gt;| 从指定的数据库备份文件恢复数据库,结果以promise形式返回。<br/>-&nbsp;srcName:指定数据库的备份文件名。 |
## 开发步骤
......
......@@ -155,6 +155,30 @@
| ---- | ---- | ---- |
| RdbStore | bool UnSubscribe(const SubscribeOption& option, RdbStoreObserver *observer) | 从数据库中删除指定类型的指定观察者。<ul><li> option:订阅类型;</li><li> observer:指已注册的数据更改观察者</li></ul>
### 数据库的备份和恢复
关系型数据库提供对本地数据库文件的备份和恢复能力,相关API如下所示。
- 备份
关系型数据库提供了备份数据库文件的接口,通过databasePath指定的备份文件名(也可以是目录+文件名的形式)备份当前数据库文件。通过返回值判断是否备份成功,成功时返回0,失败时则返回相应的错误码。
表11 数据库备份API
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbStore | int Backup(const std::string databasePath, const std::vector<uint8_t> destEncryptKey) | 备份数据库文件。<ul><li>databasePath:指定的备份文件名。 </li><li> destEncryptKey:数据库的加密密钥。注意:当前只支持非加密数据库的备份。</li></ul> |
- 恢复
关系型数据库提供了恢复数据库文件的接口,通过databasePath指定的备份文件名(也可以是目录+文件名的形式)恢复当前数据库文件。通过返回值判断是否恢复成功,成功时返回0,失败时则返回相应的错误码。
表12 数据库恢复API
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbStore | int Restore(const std::string backupPath, const std::vector<uint8_t> &newKey) | 恢复数据库文件。<ul><li>backupPath:指定的备份文件名。 </li><li> newKey:数据库的加密密钥。注意:当前只支持非加密数据库的恢复。</li></ul> |
## 约束与限制
无。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册