Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
50420599
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,发现更多精彩内容 >>
提交
50420599
编写于
11月 29, 2022
作者:
Y
ylq121
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
xiugai
Signed-off-by:
N
ylq121
<
yangqing89@huawei.com
>
上级
ee3914ba
变更
3
展开全部
显示空白变更内容
内联
并排
Showing
3 changed file
with
1405 addition
and
274 deletion
+1405
-274
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
...pplication-dev/reference/apis/js-apis-distributed-data.md
+223
-66
zh-cn/application-dev/reference/apis/js-apis-distributedKVStore.md
...lication-dev/reference/apis/js-apis-distributedKVStore.md
+1181
-188
zh-cn/application-dev/reference/errorcodes/errorcode-distributedKVStore.md
...-dev/reference/errorcodes/errorcode-distributedKVStore.md
+1
-20
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
浏览文件 @
50420599
...
@@ -509,7 +509,7 @@ try {
...
@@ -509,7 +509,7 @@ try {
on(event: 'distributedDataServiceDie', deathCallback: Callback
<
void
>
): void
on(event: 'distributedDataServiceDie', deathCallback: Callback
<
void
>
): void
订阅服务状态变更通知
,此方法为同步方法
。
订阅服务状态变更通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
...
@@ -540,7 +540,7 @@ try {
...
@@ -540,7 +540,7 @@ try {
off(event: 'distributedDataServiceDie', deathCallback?: Callback
<
void
>
): void
off(event: 'distributedDataServiceDie', deathCallback?: Callback
<
void
>
): void
取消订阅服务状态变更通知
,此方法为同步方法
。
取消订阅服务状态变更通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.DistributedKVStore
...
@@ -2234,17 +2234,17 @@ try {
...
@@ -2234,17 +2234,17 @@ try {
on(event: 'dataChange', type: SubscribeType, listener: Callback
<
ChangeNotification
>
): void
on(event: 'dataChange', type: SubscribeType, listener: Callback
<
ChangeNotification
>
): void
订阅指定类型的数据变更通知
,此方法为同步方法
。
订阅指定类型的数据变更通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -----
| ------ | ---- |
----------------------- |
| -----
--- | --------------------------------------------------------- | ---- | -----------------------------
----------------------- |
| event
|string | 是 |订阅的事件名,固定为'dataChange',表示数据变更事件。
|
| event
| string | 是 | 订阅的事件名,固定为'dataChange',表示数据变更事件。
|
| type
|
[
SubscribeType
](
#subscribetype
)
| 是 |表示订阅的类型。
|
| type
|
[
SubscribeType
](
#subscribetype
)
| 是 | 表示订阅的类型。
|
| listener |
Callback
<
[ChangeNotification](#changenotification)
>
| 是 |回调函数。
|
| listener |
Callback
<
[ChangeNotification](#changenotification)
>
| 是 | 回调函数。
|
**示例:**
**示例:**
...
@@ -2259,16 +2259,16 @@ kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, fun
...
@@ -2259,16 +2259,16 @@ kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, fun
on(event: 'syncComplete', syncCallback: Callback
<
Array
<
[string, number]
>>
): void
on(event: 'syncComplete', syncCallback: Callback
<
Array
<
[string, number]
>>
): void
订阅同步完成事件回调通知
,此方法为同步方法
。
订阅同步完成事件回调通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -----
| ------ | ---- |
----------------------- |
| -----
------- | --------------------------------------------- | ---- | -------------------------------
----------------------- |
| event
|string | 是 |订阅的事件名,固定为'syncComplete',表示同步完成事件。
|
| event
| string | 是 | 订阅的事件名,固定为'syncComplete',表示同步完成事件。
|
| syncCallback
|Callback
<
Array
<
[string, number]
>>
| 是 |回调函数。
|
| syncCallback
| Callback
<
Array
<
[string, number]
>>
| 是 | 回调函数。用于向调用方发送同步结果的回调。
|
**示例:**
**示例:**
...
@@ -2283,16 +2283,18 @@ kvStore.on('syncComplete', function (data) {
...
@@ -2283,16 +2283,18 @@ kvStore.on('syncComplete', function (data) {
off(event:'dataChange', listener?: Callback
<
ChangeNotification
>
): void
off(event:'dataChange', listener?: Callback
<
ChangeNotification
>
): void
取消订阅数据变更通知
,此方法为同步方法
。
取消订阅数据变更通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| -------- | --------------------------------------------------------- | ---- | -------------------------------------------------------- |
| event |string | 是 |取消订阅的事件名,固定为'dataChange',表示数据变更事件。 |
| event | string | 是 | 取消订阅的事件名,固定为'dataChange',表示数据变更事件。 |
| listener |Callback
<
[ChangeNotification](#changenotification)
>
|否 |回调函数。 |
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 | 回调函数。 |
**示例:**
**示例:**
...
@@ -2315,6 +2317,42 @@ class KvstoreModel {
...
@@ -2315,6 +2317,42 @@ class KvstoreModel {
}
}
```
```
### off('syncComplete')<sup>8+</sup>
off(event: 'syncComplete', syncCallback?: Callback
<
Array
<
[string, number]
>>
): void
取消订阅同步完成事件回调通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 | 回调函数。用于向调用方发送同步结果的回调。 |
**示例:**
```
js
let
kvStore
;
class
KvstoreModel
{
call
(
data
)
{
console
.
log
(
"
syncComplete:
"
+
data
);
}
subscribeSyncComplete
()
{
if
(
kvStore
!=
null
)
{
kvStore
.
on
(
'
syncComplete
'
,
this
.
call
);
}
}
unsubscribeSyncComplete
()
{
if
(
kvStore
!=
null
)
{
kvStore
.
off
(
'
syncComplete
'
,
this
.
call
);
}
}
}
```
### putBatch<sup>8+</sup>
### putBatch<sup>8+</sup>
putBatch(entries: Entry[], callback: AsyncCallback
<
void
>
): void
putBatch(entries: Entry[], callback: AsyncCallback
<
void
>
): void
...
@@ -3711,21 +3749,71 @@ try {
...
@@ -3711,21 +3749,71 @@ try {
}
}
```
```
### sync
sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
在手动同步方式下,触发数据库同步。关于分布式数据服务的同步方式说明,请见
[
分布式数据服务概述
](
../../database/database-mdds-overview.md
)
。
**需要权限**
: ohos.permission.DISTRIBUTED_DATASYNC。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------- | ---- | ---------------------------------------------- |
| deviceIds | string[] | 是 | 同一组网环境下,需要同步的设备的deviceId列表。 |
| mode |
[
SyncMode
](
#syncmode
)
| 是 | 同步模式。 |
| delayMs | number | 否 | 可选参数,允许延时时间,单位:ms(毫秒)。 |
**示例:**
```
js
let
kvStore
;
kvStore
.
sync
([
'
deviceIds
'
],
distributedData
.
SyncMode
.
PULL_ONLY
,
1000
);
```
### on('dataChange')<sup>8+</sup>
on(event: 'dataChange', type: SubscribeType, listener: Callback
<
ChangeNotification
>
): void
订阅指定类型的数据变更通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ---------------------------------------------------- |
| event | string | 是 | 订阅的事件名,固定为'dataChange',表示数据变更事件。 |
| type |
[
SubscribeType
](
#subscribetype
)
| 是 | 表示订阅的类型。 |
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 是 | 回调函数。 |
**示例:**
```
js
let
kvStore
;
kvStore
.
on
(
'
dataChange
'
,
distributedData
.
SubscribeType
.
SUBSCRIBE_TYPE_LOCAL
,
function
(
data
)
{
console
.
log
(
"
dataChange callback call data:
"
+
JSON
.
stringify
(
data
));
});
```
### on('syncComplete')<sup>8+</sup>
### on('syncComplete')<sup>8+</sup>
on(event: 'syncComplete', syncCallback: Callback
<
Array
<
[string, number]
>>
): void
on(event: 'syncComplete', syncCallback: Callback
<
Array
<
[string, number]
>>
): void
订阅同步完成事件回调通知
,此方法为同步方法
。
订阅同步完成事件回调通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -----
| ------ | ---- |
----------------------- |
| -----
------- | --------------------------------------------- | ---- | -------------------------------
----------------------- |
| event
|string | 是 |订阅的事件名,固定为'syncComplete',表示同步完成事件。
|
| event
| string | 是 | 订阅的事件名,固定为'syncComplete',表示同步完成事件。
|
| syncCallback
|Callback
<
Array
<
[string, number]
>>
| 是 |回调函数。用于向调用方发送同步结果的回调。
|
| syncCallback
| Callback
<
Array
<
[string, number]
>>
| 是 | 回调函数。用于向调用方发送同步结果的回调。
|
**示例:**
**示例:**
...
@@ -3747,21 +3835,20 @@ try {
...
@@ -3747,21 +3835,20 @@ try {
}
}
```
```
### off('dataChange')<sup>8+</sup>
### off('syncComplete')<sup>8+</sup>
off(event:'dataChange', listener?: Callback
<
ChangeNotification
>
): void
off(event: 'syncComplete', syncCallback?: Callback
<
Array
<
[string, number]
>>
): void
取消订阅
同步完成事件回调通知,此方法为同步方法
。
取消订阅
数据变更通知
。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -----
| ------ | ---- |
----------------------- |
| -----
--- | --------------------------------------------------------- | ---- | ---------------------------------
----------------------- |
| event
|string | 是 |取消订阅的事件名,固定为'syncComplete',表示同步完成事件。
|
| event
| string | 是 | 取消订阅的事件名,固定为'dataChange',表示数据变更事件。
|
|
syncCallback |Callback
<
Array
<
[string, number]
>>
| 否 |回调函数。用于向调用方发送同步结果的回调。
|
|
listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 | 回调函数。
|
**示例:**
**示例:**
...
@@ -3769,45 +3856,55 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]&
...
@@ -3769,45 +3856,55 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]&
let
kvStore
;
let
kvStore
;
class
KvstoreModel
{
class
KvstoreModel
{
call
(
data
)
{
call
(
data
)
{
console
.
log
(
"
syncComplet
e:
"
+
data
);
console
.
log
(
"
dataChang
e:
"
+
data
);
}
}
subscribe
SyncComplet
e
()
{
subscribe
DataChang
e
()
{
if
(
kvStore
!=
null
)
{
if
(
kvStore
!=
null
)
{
kvStore
.
on
(
'
syncComplete
'
,
this
.
call
);
kvStore
.
on
(
'
dataChange
'
,
distributedData
.
SubscribeType
.
SUBSCRIBE_TYPE_REMOTE
,
this
.
call
);
}
}
}
}
unsubscribe
SyncComplet
e
()
{
unsubscribe
DataChang
e
()
{
if
(
kvStore
!=
null
)
{
if
(
kvStore
!=
null
)
{
kvStore
.
off
(
'
syncComplet
e
'
,
this
.
call
);
kvStore
.
off
(
'
dataChang
e
'
,
this
.
call
);
}
}
}
}
}
}
```
```
### sync<sup>7+</sup>
### off('syncComplete')<sup>8+</sup>
sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
在手动同步方式下,触发数据库同步。关于分布式数据服务的同步方式说明,请见
[
分布式数据服务概述
](
../../database/database-mdds-overview.md
)
。
off(event: 'syncComplete', syncCallback?: Callback
<
Array
<
[string, number]
>>
): void
**需要权限**
: ohos.permission.DISTRIBUTED_DATASYNC
。
取消订阅同步完成事件回调通知
。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- |
| deviceIds |string[] | 是 |同一组网环境下,需要同步的设备的deviceId列表。 |
| event | string | 是 | 取消订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| mode |
[
SyncMode
](
#syncmode
)
| 是 |同步模式。 |
| syncCallback | Callback
<
Array
<
[string, number]
>>
| 否 | 回调函数。用于向调用方发送同步结果的回调。 |
| delayMs |number | 否 |可选参数,允许延时时间,单位:ms(毫秒)。 |
**示例:**
**示例:**
```
js
```
js
let
kvStore
;
let
kvStore
;
kvStore
.
sync
(
'
deviceIds
'
,
distributedData
.
SyncMode
.
PULL_ONLY
,
1000
);
class
KvstoreModel
{
call
(
data
)
{
console
.
log
(
"
syncComplete:
"
+
data
);
}
subscribeSyncComplete
()
{
if
(
kvStore
!=
null
)
{
kvStore
.
on
(
'
syncComplete
'
,
this
.
call
);
}
}
unsubscribeSyncComplete
()
{
if
(
kvStore
!=
null
)
{
kvStore
.
off
(
'
syncComplete
'
,
this
.
call
);
}
}
}
```
```
### setSyncParam<sup>8+</sup>
### setSyncParam<sup>8+</sup>
...
@@ -5077,20 +5174,45 @@ try {
...
@@ -5077,20 +5174,45 @@ try {
}
}
```
```
### on('dataChange')<sup>8+</sup>
on(event: 'dataChange', type: SubscribeType, listener: Callback
<
ChangeNotification
>
): void
订阅指定类型的数据变更通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ---------------------------------------------------- |
| event | string | 是 | 订阅的事件名,固定为'dataChange',表示数据变更事件。 |
| type |
[
SubscribeType
](
#subscribetype
)
| 是 | 表示订阅的类型。 |
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 是 | 回调函数。 |
**示例:**
```
js
let
kvStore
;
kvStore
.
on
(
'
dataChange
'
,
distributedData
.
SubscribeType
.
SUBSCRIBE_TYPE_LOCAL
,
function
(
data
)
{
console
.
log
(
"
dataChange callback call data:
"
+
JSON
.
stringify
(
data
));
});
```
### on('syncComplete')<sup>8+</sup>
### on('syncComplete')<sup>8+</sup>
on(event: 'syncComplete', syncCallback: Callback
<
Array
<
[string, number]
>>
): void
on(event: 'syncComplete', syncCallback: Callback
<
Array
<
[string, number]
>>
): void
订阅同步完成事件回调通知
,此方法为同步方法
。
订阅同步完成事件回调通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -----
| ------ | ---- |
----------------------- |
| -----
------- | --------------------------------------------- | ---- | -------------------------------
----------------------- |
| event
|string | 是 |
订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| event
| string | 是 |
订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| syncCallback
|Callback
<Array
&
lt
;[
string
,
number
]&
gt
;
>
| 是 |回调函数。用于向调用方发送同步结果的回调。
|
| syncCallback
| Callback
<
Array
<
[string, number]
>>
| 是 | 回调函数。用于向调用方发送同步结果的回调。
|
**示例:**
**示例:**
...
@@ -5112,21 +5234,56 @@ try {
...
@@ -5112,21 +5234,56 @@ try {
}
}
```
```
### off('dataChange')<sup>8+</sup>
off(event:'dataChange', listener?: Callback
<
ChangeNotification
>
): void
取消订阅数据变更通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | -------------------------------------------------------- |
| event | string | 是 | 取消订阅的事件名,固定为'dataChange',表示数据变更事件。 |
| listener | Callback
<
[ChangeNotification](#changenotification)
>
| 否 | 回调函数。 |
**示例:**
```
js
let
kvStore
;
class
KvstoreModel
{
call
(
data
)
{
console
.
log
(
"
dataChange:
"
+
data
);
}
subscribeDataChange
()
{
if
(
kvStore
!=
null
)
{
kvStore
.
on
(
'
dataChange
'
,
distributedData
.
SubscribeType
.
SUBSCRIBE_TYPE_REMOTE
,
this
.
call
);
}
}
unsubscribeDataChange
()
{
if
(
kvStore
!=
null
)
{
kvStore
.
off
(
'
dataChange
'
,
this
.
call
);
}
}
}
```
### off('syncComplete')<sup>8+</sup>
### off('syncComplete')<sup>8+</sup>
off(event: 'syncComplete', syncCallback?: Callback
<
Array
<
[string, number]
>>
): void
off(event: 'syncComplete', syncCallback?: Callback
<
Array
<
[string, number]
>>
): void
取消订阅同步完成事件回调通知
,此方法为同步方法
。
取消订阅同步完成事件回调通知。
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**系统能力:**
SystemCapability.DistributedDataManager.KVStore.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -----
| ------ | ---- |
----------------------- |
| -----
------- | --------------------------------------------- | ---- | -----------------------------------
----------------------- |
| event
|string | 是 |
取消订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| event
| string | 是 |
取消订阅的事件名,固定为'syncComplete',表示同步完成事件。 |
| syncCallback
|Callback<Array
<
[string, number]
>>
| 否 |回调函数。用于向调用方发送同步结果的回调。
|
| syncCallback
| Callback
<
Array
<
[string, number]
>>
| 否 | 回调函数。用于向调用方发送同步结果的回调。
|
**示例:**
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-distributedKVStore.md
浏览文件 @
50420599
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/errorcodes/errorcode-distributedKVStore.md
浏览文件 @
50420599
...
@@ -81,26 +81,7 @@ Not found.
...
@@ -81,26 +81,7 @@ Not found.
2.
在数据库数据查询操作前,请检查查询关键字是否正确。
2.
在数据库数据查询操作前,请检查查询关键字是否正确。
3.
在数据库数据删除操作前,请检查删除关键字是否正确或是否重复删除。
3.
在数据库数据删除操作前,请检查删除关键字是否正确或是否重复删除。
## 15100005 数据库或查询结果集已关闭
## 15100005 不支持当前操作
**错误信息**
Not support the operation.
**错误描述**
该错误码表示在调用数据库backup、restore等接口时,当前数据库不支持该操作。
**可能原因**
在调用数据库备份、恢复等接口时,当前数据库不支持该操作。
**处理步骤**
检查当前数据库是否支持备份、恢复操作。
## 15100006 数据库或查询结果集已关闭
**错误信息**
**错误信息**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录