Skip to content

D
Docs

OpenHarmony / Docs
接近 2 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 0c8c3bba 编写于 作者: Q qing
浏览文件
操作

KVStore-errcode 

Signed-off-by: Nqing <yangqing89@huawei.com>
上级 0c36d5b5
展开全部 隐藏空白更改
内联 并排
Showing with 6009 addition and 877 deletion
zh-cn/application-dev/database/database-mdds-guidelines.md
浏览文件 @ 0c8c3bba
......@@ -6,20 +6,20 @@
## 接口说明
分布式数据相关功能接口请见[分布式数据管理](../reference/apis/js-apis-distributed-data.md)。
分布式数据相关功能接口请见[分布式键值数据库](../reference/apis/js-apis-distributedKVStore.md)。
**表1** 分布式数据服务关键API功能介绍
| 接口名称 | 描述 |
| ------------------------------------------------------------ | ----------------------------------------------- |
| createKVManager(config: KVManagerConfig, callback: AsyncCallback&lt;KVManager&gt;): void<br/>createKVManager(config: KVManagerConfig): Promise&lt;KVManager> | 创建一个`KVManager`对象实例，用于管理数据库对象。 |
| getKVStore&lt;TextendsKVStore&gt;(storeId: string, options: Options, callback: AsyncCallback&lt;T&gt;): void<br/>getKVStore&lt;TextendsKVStore&gt;(storeId: string, options: Options): Promise&lt;T&gt; | 指定`Options`和`storeId`，创建并获取`KVStore`数据库。 |
| put(key: string, value: Uint8Array\|string\|number\|boolean, callback: AsyncCallback&lt;void&gt;): void<br/>put(key: string, value: Uint8Array\|string\|number\|boolean): Promise&lt;void> | 插入和更新数据。 |
| delete(key: string, callback: AsyncCallback&lt;void&gt;): void<br/>delete(key: string): Promise&lt;void> | 删除数据。 |
| get(key: string, callback: AsyncCallback&lt;Uint8Array\|string\|boolean\|number&gt;): void<br/>get(key: string): Promise&lt;Uint8Array\|string\|boolean\|number> | 查询数据。 |
| on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;ChangeNotification&gt;): void<br/>on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string,number]&gt;&gt;): void | 订阅数据库中数据的变化。 |
| sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void | 在手动模式下，触发数据库同步。 |
| 接口名称 | 描述 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| createKVManager(config: KVManagerConfig, callback: AsyncCallback&lt;KVManager&gt;): void<br/>createKVManager(config: KVManagerConfig): Promise&lt;KVManager> | 创建一个`KVManager`对象实例，用于管理数据库对象。 |
| getKVStore&lt;TextendsKVStore&gt;(storeId: string, options: Options, callback: AsyncCallback&lt;T&gt;): void<br/>getKVStore&lt;TextendsKVStore&gt;(storeId: string, options: Options): Promise&lt;T&gt; | 指定`Options`和`storeId`，创建并获取指定类型`KVStore`数据库。 |
| put(key: string, value: Uint8Array\|string\|number\|boolean, callback: AsyncCallback&lt;void&gt;): void<br/>put(key: string, value: Uint8Array\|string\|number\|boolean): Promise&lt;void> | 插入和更新数据。 |
| delete(key: string, callback: AsyncCallback&lt;void&gt;): void<br/>delete(key: string): Promise&lt;void> | 删除数据。 |
| get(key: string, callback: AsyncCallback&lt;Uint8Array\|string\|boolean\|number&gt;): void<br/>get(key: string): Promise&lt;Uint8Array\|string\|boolean\|number> | 查询数据。 |
| on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;ChangeNotification&gt;): void<br/>on(event: 'syncComplete', syncCallback: Callback&lt;Array&lt;[string,number]&gt;&gt;): void | 订阅数据库中数据的变化。 |
| sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void | 在手动模式下，触发数据库同步。 |
## 开发步骤
......@@ -28,23 +28,25 @@
1. 导入模块。
```js
import distributedData from '@ohos.data.distributedData';
import distributedKVStore from '@ohos.data.distributedKVStore';
```
2. 请求权限（同步操作时进行该步骤）。
需要在`config.json`文件里进行配置请求权限（FA模型），示例代码如下：
```json
{
"module": {
"reqPermissions": [
{
"name": "ohos.permission.DISTRIBUTED_DATASYNC"
}
]
}
}
{
"module": {
"reqPermissions": [
{
"name": "ohos.permission.DISTRIBUTED_DATASYNC"
}
]
}
}
```
Stage模型下的权限请求请参见[权限声明-Stage模型](../security/accesstoken-guidelines.md#stage模型)。
这个权限还需要在应用首次启动的时候弹窗获取用户授权，可以通过如下代码实现：
......@@ -52,7 +54,7 @@
```js
// FA模型
import featureAbility from '@ohos.ability.featureAbility';
function grantPermission() {
console.info('grantPermission');
let context = featureAbility.getContext();
......@@ -62,21 +64,21 @@
console.info('failed: ${error}');
})
}
grantPermission();
// Stage模型
import Ability from '@ohos.application.Ability';
let context = null;
function grantPermission() {
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let context = this.context;
}
}
let permissions = ['ohos.permission.DISTRIBUTED_DATASYNC'];
context.requestPermissionsFromUser(permissions).then((data) => {
console.log('success: ${data}');
......@@ -84,7 +86,7 @@
console.log('failed: ${error}');
});
}
grantPermission();
```
......@@ -99,7 +101,7 @@
// FA模型获取context
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
// Stage模型获取context
import AbilityStage from '@ohos.application.Ability';
let context = null;
......@@ -108,27 +110,23 @@
context = this.context;
}
}
let kvManager;
try {
const kvManagerConfig = {
bundleName: 'com.example.datamanagertest',
userInfo: {
context:context,
userId: '0',
userType: distributedData.UserType.SAME_USER_ID
}
context:context,
}
distributedData.createKVManager(kvManagerConfig, function (err, manager) {
distributedKVStore.createKVManager(kvManagerConfig, function (err, manager) {
if (err) {
console.log('createKVManager err: ${error}');
console.error(`Fail to createKVManager.code is ${err.code},message is ${err.message}`);
return;
}
console.log('createKVManager success');
console.log('Succeeded in creating KVManager');
kvManager = manager;
});
} catch (e) {
console.log('An unexpected error occurred. Error: ${e}');
console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}
```
......@@ -147,34 +145,38 @@
encrypt: false,
backup: false,
autoSync: false,
kvStoreType: distributedData.KVStoreType.SINGLE_VERSION,
securityLevel: distributedData.SecurityLevel.S0
kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION,
securityLevel: distributedKVStore.SecurityLevel.S1
};
kvManager.getKVStore('storeId', options, function (err, store) {
if (err) {
console.log('getKVStore err: ${err}');
console.error(`Fail to get KVStore: code is ${err.code},message is ${err.message}`);
return;
}
console.log('getKVStore success');
console.log('Succeeded in getting KVStore');
kvStore = store;
});
} catch (e) {
console.log('An unexpected error occurred. Error: ${e}');
console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}
```
> **说明：**
>
> 组网设备间同步数据的场景，建议在应用启动时打开分布式数据库，获取数据库的句柄。在该句柄（如示例中的`kvStore`）的生命周期内无需重复创建数据库，可直接使用句柄对数据库进行数据的插入等操作。
5. 订阅分布式数据变化。
以下为订阅单版本分布式数据库数据变化通知的代码示例:
```js
kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_ALL, function (data) {
console.log("dataChange callback call data: ${data}");
});
try{
kvStore.on('dataChange', distributedKVStore.SubscribeType.SUBSCRIBE_TYPE_ALL, function (data) {
console.log(`dataChange callback call data: ${data}`);
});
}catch(e){
console.error(`An unexpected error occured.code is ${e.code},message is ${e.message}`);
}
```
6. 将数据写入分布式数据库。
......@@ -188,15 +190,15 @@
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err, data) {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
if (err != undefined) {
console.log('put err: ${error}');
console.error(`Fail to put.code is ${err.code},message is ${err.message}`);
return;
}
console.log('put success');
console.log("Succeeded in putting");
});
} catch (e) {
console.log('An unexpected error occurred. Error: ${e}');
}catch (e) {
console.error(`An unexpected error occurred.code is ${e.code},message is ${e.message}`);
}
```
......@@ -211,18 +213,22 @@
const KEY_TEST_STRING_ELEMENT = 'key_test_string';
const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
try {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err, data) {
kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
if (err != undefined) {
console.error(`Fail to put.code is ${err.code},message is ${err.message}`);
return;
}
console.log("Succeeded in putting");
kvStore.get(KEY_TEST_STRING_ELEMENT, function (err,data) {
if (err != undefined) {
console.log('put err: ${error}');
console.error(`Fail to get.code is ${err.code},message is ${err.message}`);
return;
}
console.log('put success');
kvStore.get(KEY_TEST_STRING_ELEMENT, function (err, data) {
console.log('get success data: ${data}');
console.log(`Succeeded in getting data:${data}`);
});
});
} catch (e) {
console.log('An unexpected error occurred. Error: ${e}');
}catch (e) {
console.error(`Fail to get.code is ${e.code},message is ${e.message}`);
}
```
......@@ -233,7 +239,7 @@
> **说明**：
>
> 其中`deviceManager`模块的接口均为系统接口。
以下为单版本分布式数据库进行数据同步的代码示例：
```js
......@@ -254,20 +260,21 @@
}
try{
// 1000表示最大延迟时间为1000ms
kvStore.sync(deviceIds, distributedData.SyncMode.PUSH_ONLY, 1000);
kvStore.sync(deviceIds, distributedKVStore.SyncMode.PUSH_ONLY, 1000);
} catch (e) {
console.log('An unexpected error occurred. Error: ${e}');
console.error(`An unexpected error occurred. code is ${e.code},message is ${e.message}`);
}
}
});
```
## 相关实例
针对分布式数据开发，有以下相关实例可供参考：
- [`DistributedCalc`：分布式计算器（JS）（API8）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/common/DistributeCalc)
- [`DistributedCalc`：分布式计算器（ArkTS）（API8）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/Preset/DistributeCalc)
- [`DistributedDataGobang`：分布式五子棋（ArkTS）（API9）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/data/DistributedDataGobang)
- [`DDMQuery`：结果集与谓词（ArkTS）（API8）](https://gitee.com/openharmony/applications_app_samples/tree/master/data/DDMQuery)
- [`KvStore`：分布式数据库（ArkTS）（API8）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/data/Kvstore)
- [`DistributedCalc`：分布式计算器（eTS）（API8）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/Preset/DistributeCalc)
- [`DistributedDataGobang`：分布式五子棋（eTS）（API9）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/data/DistributedDataGobang)
- [`DDMQuery`：结果集与谓词（eTS）（API8）](https://gitee.com/openharmony/applications_app_samples/tree/master/data/DDMQuery)
- [`KvStore`：分布式数据库（eTS）（API8）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/data/Kvstore)
- [分布式数据库（JS）（API8）](https://gitee.com/openharmony/codelabs/tree/master/Data/JsDistributedData)
\ No newline at end of file
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @ 0c8c3bba
......@@ -140,8 +140,8 @@
- [@ohos.data.dataShare (数据共享)](js-apis-data-dataShare.md)
- [@ohos.data.dataSharePredicates (数据共享谓词)](js-apis-data-dataSharePredicates.md)
- [@ohos.data.dataShareResultSet (数据共享结果集)](js-apis-data-DataShareResultSet.md)
- [@ohos.data.distributedData (分布式数据管理)](js-apis-distributed-data.md)
- [@ohos.data.distributedDataObject (分布式数据对象)](js-apis-data-distributedobject.md)
- [@ohos.data.distributedKVStore (分布式键值数据库)](js-apis-distributedKVStore.md)
- [@ohos.data.preferences (首选项)](js-apis-data-preferences.md)
- [@ohos.data.rdb (关系型数据库)](js-apis-data-rdb.md)
- [@ohos.data.ValuesBucket (数据集)](js-apis-data-ValuesBucket.md)
......@@ -210,7 +210,6 @@
- [@ohos.wallpaper (壁纸)](js-apis-wallpaper.md)
- [@ohos.web.webview(Web)](js-apis-webview.md)
- [Timer (定时器)](js-apis-timer.md)
- 设备管理
- [@ohos.batteryInfo (电量信息)](js-apis-battery-info.md)
......@@ -271,6 +270,7 @@
- 已停止维护的接口
- [@ohos.bytrace (性能打点)](js-apis-bytrace.md)
- [@ohos.data.storage (轻量级存储)](js-apis-data-storage.md)
- [@ohos.data.distributedData (分布式数据管理)](js-apis-distributed-data.md)
- [@ohos.prompt (弹窗)](js-apis-prompt.md)
- [@ohos.reminderAgent (后台代理提醒)](js-apis-reminderAgent.md)
- [@system.app (应用上下文)](js-apis-system-app.md)
......
zh-cn/application-dev/reference/errorcodes/errorcode-distributedKVStore.md 0 → 100644
浏览文件 @ 0c8c3bba
# 分布式键值数据库错误码
## 15100001 超过最大订阅数量
### 错误信息
Over max subscribe limits.
### 错误描述
该错误码表示在调用数据库变化订阅on接口时，订阅数量已超过最大限制。
### 可能原因
在调用订阅数据库变化接口时，对数据库的订阅数量已超过最大限制。
### 处理步骤
取消对数据库的部分订阅后，再次尝试订阅。
## 15100002 打开已有数据库时参数配置发生变化
### 错误信息
Open existed database with changed options.
### 错误描述
该错误码表示在调用getKVStore接口打开已创建的数据库时，options配置参数发生变化。
### 可能原因
打开已创建的数据库时，options参数配置发生了变化，可能原因如下：
1. 期望新建数据库时，使用了已创建过的数据库名称storeId。
2. 期望改变已创建数据库的options参数配置。
### 处理步骤
1. 新建数据库前，请检查数据库名称storeId不与已创建数据库的storeId重名。
2. 期望改变已创建数据库的options参数配置时，当前不支持该操作，请自行删除数据库后使用新的options参数重新创建。
## 15100003 数据库损坏
### 错误信息
Database corrupted.
### 错误描述
该错误码表示在调用数据库增、删、查、数据同步等接口时，数据库已损坏。
### 可能原因
调用数据库增、删、查、数据同步等接口操作数据库时，数据库文件已损坏。
### 处理步骤
1. 如果之前备份过数据库，可尝试使用已备份的数据库文件恢复数据库。
2. 如果之前没有备份过数据库，可尝试删除数据库后重新创建。
## 15100004 未找到相关数据
### 错误信息
Not found.
### 错误描述
该错误码表示在调用数据库deleteKVStore、delete、deleteBatch、get等接口时，未找到相关数据。
### 可能原因
在调用删除数据库、数据查询、数据删除等接口时未找到相关数据，可能原因如下。
1. 删除数据库操作时，数据库不存在或已删除。
2. 数据库数据查询操作时，相关数据不存在或已删除。
3. 数据库数据删除操作时，相关数据不存在或已删除。
### 处理步骤
1. 在删除数据库操作前，请检查数据库名称是否正确或是否重复删除。
2. 在数据库数据查询操作前，请检查查询关键字是否正确。
3. 在数据库数据删除操作前，请检查删除关键字是否正确或是否重复删除。
## 15100005 不支持当前操作
### 错误信息
Not support the operation.
### 错误描述
该错误码表示在调用数据库backup、restore等接口时，当前数据库不支持该操作。
### 可能原因
在调用数据库备份、恢复等接口时，当前数据库不支持该操作。
### 处理步骤
检查当前数据库是否支持备份、恢复操作。
## 15100006 数据库或查询结果集已关闭
### 错误信息
Database or result set already closed.
### 错误描述
该错误码表示在调用数据库或查询结果集相关接口时，数据库或查询结果集为关闭状态。
### 可能原因
在数据库或查询结果集操作前，已经手动关闭了数据库或查询结果集。
### 处理步骤
1. 在数据库相关操作前，请重新打开数据库之后再重试当前操作。
2. 在查询结果集相关操作前，请重新查询获取结果集之后再重试当前操作。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或