Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 3cd5b93b 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!21461 终审接口改名适配文档资料 

Merge pull request !21461 from 杨青/master
上级 dc572769 954d8429
隐藏空白更改
内联 并排
Showing with 109 addition and 33 deletion
zh-cn/application-dev/reference/apis/js-apis-data-cloudData.md
浏览文件 @ 3cd5b93b
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
import cloudData from '@ohos.data.cloudData'; import cloudData from '@ohos.data.cloudData';
``` ```
## Action ## ClearAction
清除本地下载的云端数据的行为枚举。 清除本地下载的云端数据的行为枚举。
...@@ -347,9 +347,9 @@ try { ...@@ -347,9 +347,9 @@ try {
} }
``` ```
### clean ### clear
static clean(accountId: string, appActions: {[bundleName: string]: Action}, callback: AsyncCallback<void>):void static clear(accountId: string, appActions: {[bundleName: string]: ClearAction}, callback: AsyncCallback<void>):void
清除本地下载的云端数据，使用callback异步回调。 清除本地下载的云端数据，使用callback异步回调。
...@@ -361,26 +361,26 @@ static clean(accountId: string, appActions: {[bundleName: string]: Action}, cal ...@@ -361,26 +361,26 @@ static clean(accountId: string, appActions: {[bundleName: string]: Action}, cal
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------------------------- | ---- | -------------------------------- | | ---------- | --------------------------------------------------- | ---- | -------------------------------- |
| accountId | string | 是 | 具体打开的云帐号ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
| appActions | {[bundleName: string]: [Action](#action)} | 是 | 要清除数据的应用信息及清除规则。 | | appActions | {[bundleName: string]: [ClearAction](#clearaction)} | 是 | 要清除数据的应用信息及清除规则。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 | | callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
let action = cloudData.Action; let action = cloudData.ClearAction;
let account = "test_id"; let account = "test_id";
let bundleName1 = "test_bundleName1"; let bundleName1 = "test_bundleName1";
let bundleName2 = "test_bundleName2"; let bundleName2 = "test_bundleName2";
let appActions = { [bundleName1]: action.CLEAR_CLOUD_INFO, [bundleName2]: action.CLEAR_CLOUD_DATA_AND_INFO }; let appActions = { [bundleName1]: action.CLEAR_CLOUD_INFO, [bundleName2]: action.CLEAR_CLOUD_DATA_AND_INFO };
try { try {
cloudData.Config.clean(account, appActions, function (err) { cloudData.Config.clear(account, appActions, function (err) {
if (err === undefined) { if (err === undefined) {
console.info('Succeeding in cleaning cloud data'); console.info('Succeeding in clearing cloud data');
} else { } else {
console.error(`Failed to clean cloud data. Code: ${err.code}, message: ${err.message}`); console.error(`Failed to clear cloud data. Code: ${err.code}, message: ${err.message}`);
} }
}); });
} catch (error) { } catch (error) {
...@@ -388,9 +388,9 @@ try { ...@@ -388,9 +388,9 @@ try {
} }
``` ```
### clean ### clear
static clean(accountId: string, appActions: {[bundleName: string]: Action}): Promise<void> static clear(accountId: string, appActions: {[bundleName: string]: ClearAction}): Promise<void>
清除本地下载的云端数据，使用Promise异步回调。 清除本地下载的云端数据，使用Promise异步回调。
...@@ -402,10 +402,10 @@ static clean(accountId: string, appActions: {[bundleName: string]: Action}): Pro ...@@ -402,10 +402,10 @@ static clean(accountId: string, appActions: {[bundleName: string]: Action}): Pro
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------------------------- | ---- | -------------------------------- | | ---------- | --------------------------------------------------- | ---- | -------------------------------- |
| accountId | string | 是 | 具体打开的云帐号ID。 | | accountId | string | 是 | 具体打开的云帐号ID。 |
| appActions | {[bundleName: string]: [Action](#action)} | 是 | 要清除数据的应用信息及清除规则。 | | appActions | {[bundleName: string]: [ClearAction](#clearaction)} | 是 | 要清除数据的应用信息及清除规则。 |
**返回值：** **返回值：**
...@@ -416,16 +416,16 @@ static clean(accountId: string, appActions: {[bundleName: string]: Action}): Pro ...@@ -416,16 +416,16 @@ static clean(accountId: string, appActions: {[bundleName: string]: Action}): Pro
**示例：** **示例：**
```js ```js
let action = cloudData.Action; let action = cloudData.ClearAction;
let account = "test_id"; let account = "test_id";
let bundleName1 = "test_bundleName1"; let bundleName1 = "test_bundleName1";
let bundleName2 = "test_bundleName2"; let bundleName2 = "test_bundleName2";
let appActions = { [bundleName1]: action.CLEAR_CLOUD_INFO, [bundleName2]: action.CLEAR_CLOUD_DATA_AND_INFO }; let appActions = { [bundleName1]: action.CLEAR_CLOUD_INFO, [bundleName2]: action.CLEAR_CLOUD_DATA_AND_INFO };
try { try {
cloudData.Config.clean(account, appActions).then(() => { cloudData.Config.clear(account, appActions).then(() => {
console.info('Succeeding in cleaning cloud data'); console.info('Succeeding in clearing cloud data');
}).catch((err) => { }).catch((err) => {
console.error(`Failed to clean cloud data. Code: ${err.code}, message: ${err.message}`); console.error(`Failed to clear cloud data. Code: ${err.code}, message: ${err.message}`);
}); });
} catch (error) { } catch (error) {
console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
......
zh-cn/application-dev/reference/apis/js-apis-data-relationalStore.md
浏览文件 @ 3cd5b93b
...@@ -704,12 +704,12 @@ class EntryAbility extends UIAbility { ...@@ -704,12 +704,12 @@ class EntryAbility extends UIAbility {
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------------------------- | | ---------- | ------ | ---- | ---------------------------------------- |
| total | number | 是 | 表示数据库表中需要端云同步的总行数。 | | total | number | 是 | 表示数据库表中需要端云同步的总行数。 |
| success | number | 是 | 表示数据库表中端云同步成功的行数。 | | successful | number | 是 | 表示数据库表中端云同步成功的行数。 |
| failed | number | 是 | 表示数据库表中端云同步失败的行数。 | | failed | number | 是 | 表示数据库表中端云同步失败的行数。 |
| remained | number | 是 | 表示数据库表中端云同步剩余未执行的行数。 | | remained | number | 是 | 表示数据库表中端云同步剩余未执行的行数。 |
## TableDetails<sup>10+</sup> ## TableDetails<sup>10+</sup>
...@@ -3533,7 +3533,48 @@ promise.then(() => { ...@@ -3533,7 +3533,48 @@ promise.then(() => {
### setDistributedTables<sup>10+</sup> ### setDistributedTables<sup>10+</sup>
setDistributedTables(tables: Array&lt;string&gt;, type: number, config: DistributedConfig, callback: AsyncCallback&lt;void&gt;): void setDistributedTables(tables: Array&lt;string&gt;, type: DistributedType, callback: AsyncCallback&lt;void&gt;): void
设置分布式数据库表，使用callback异步回调。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ---------------------------- |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式数据库表表名。 |
| type | [DistributedType](#distributedtype10) | 是 | 表的分布式类型。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------ |
| 14800000 | Inner error. |
| 14800051 |The type of the distributed table does not match.|
**示例：**
```js
store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIBUTED_CLOUD, function (err) {
if (err) {
console.error(`SetDistributedTables failed, code is ${err.code},message is ${err.message}`);
return;
}
console.info(`SetDistributedTables successfully.`);
})
```
###
### setDistributedTables<sup>10+</sup>
setDistributedTables(tables: Array&lt;string&gt;, type: DistributedType, config: DistributedConfig, callback: AsyncCallback&lt;void&gt;): void
设置分布式数据库表，使用callback异步回调。 设置分布式数据库表，使用callback异步回调。
...@@ -3546,10 +3587,19 @@ setDistributedTables(tables: Array&lt;string&gt;, type: number, config: Distribu ...@@ -3546,10 +3587,19 @@ setDistributedTables(tables: Array&lt;string&gt;, type: number, config: Distribu
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | --- | --------------- | | -------- | ----------------------------------- | --- | --------------- |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式数据库表表名。 | | tables | Array&lt;string&gt; | 是 | 要设置的分布式数据库表表名。 |
| type | number | 是 | 表的分布式类型。目前支持的入参值为: relationalStore.DistributedType.DISTRIBUTED_DEVICE、relationalStore.DistributedType.DISTRIBUTED_CLOUD。<br> 当type为relationalStore.DistributedType.DISTRIBUTED_DEVICE时，表示表在不同设备之间分布式。<br> 当type为relationalStore.DistributedType.DISTRIBUTED_CLOUD时，表示表在设备和云端之间分布式。 | | type | [DistributedType](#distributedtype10) | 是 | 表的分布式类型。 |
| config | [DistributedConfig](#distributedconfig10) | 是 | 表的分布式配置信息。 | | config | [DistributedConfig](#distributedconfig10) | 是 | 表的分布式配置信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------- |
| 14800000 | Inner error. |
| 14800051 | The type of the distributed table does not match. |
**示例：** **示例：**
```js ```js
...@@ -3566,7 +3616,7 @@ store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIB ...@@ -3566,7 +3616,7 @@ store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIB
### setDistributedTables<sup>10+</sup> ### setDistributedTables<sup>10+</sup>
setDistributedTables(tables: Array&lt;string>, type?: number, config?: DistributedConfig): Promise&lt;void> setDistributedTables(tables: Array&lt;string>, type?: DistributedType, config?: DistributedConfig): Promise&lt;void>
设置分布式数据库表，使用Promise异步回调。 设置分布式数据库表，使用Promise异步回调。
...@@ -3578,8 +3628,8 @@ store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIB ...@@ -3578,8 +3628,8 @@ store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIB
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------------- | ---- | ------------------------------------------------------------ | | ------ | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| tables | Array&lt;string&gt; | 是 | 要设置的分布式数据库表表名。 | | tables | Array&lt;string&gt; | 是 | 要设置的分布式数据库表表名。 |
| type | number | 否 | 表的分布式类型。默认值是relationalStore.DistributedType.DISTRIBUTED_DEVICE。<br> 目前支持的入参值为: relationalStore.DistributedType.DISTRIBUTED_DEVICE、relationalStore.DistributedType.DISTRIBUTED_CLOUD。<br/> 当type为relationalStore.DistributedType.DISTRIBUTED_DEVICE时，表示表在不同设备之间分布式。<br/> 当type为relationalStore.DistributedType.DISTRIBUTED_CLOUD时，表示表在设备和云端之间分布式。 | | type | [DistributedType](#distributedtype10) | 否 | 表的分布式类型。默认值是relationalStore.DistributedType.DISTRIBUTED_DEVICE。 |
| config | [DistributedConfig](#distributedconfig10) | 否 | 表的分布式配置信息。不传入时默认autoSync为false，即只支持手动同步。 | | config | [DistributedConfig](#distributedconfig10) | 否 | 表的分布式配置信息。不传入时默认autoSync为false，即只支持手动同步。 |
**返回值**： **返回值**：
...@@ -3588,6 +3638,15 @@ store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIB ...@@ -3588,6 +3638,15 @@ store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIB
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。
| **错误码ID** | **错误信息** |
| ------------ | ------------------------------------------------- |
| 14800000 | Inner error. |
| 14800051 | The type of the distributed table does not match. |
**示例：** **示例：**
```js ```js
......
zh-cn/application-dev/reference/errorcodes/errorcode-data-rdb.md
浏览文件 @ 3cd5b93b
...@@ -174,3 +174,20 @@ The data group id is not valid. ...@@ -174,3 +174,20 @@ The data group id is not valid.
从应用市场申请dataGroupId，并正确传入该参数。 从应用市场申请dataGroupId，并正确传入该参数。
## 14800051 分布式表类型不匹配
**错误信息**
The type of the distributed table does not match.
**错误描述**
对同一数据库表设置的分布式表类型前后不一致。
**可能原因**
对同一数据库表设置的分布式表类型前后不一致，分布式表类型可见[DistributedType](../apis/js-apis-data-relationalStore.md#distributedtype10)。
**处理步骤**
对同一数据库表设置的分布式表类型保持一致，属于端端同步的分布式表不可再设置为用于端云的同步表。
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或