diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-cloudData.md b/zh-cn/application-dev/reference/apis/js-apis-data-cloudData.md index 66cbb1a816f5839d0bb9f13c5433d15a2f860aad..6cbc38300f79b9bad1e98aa7bbd56fafd80f0b1f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-cloudData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-cloudData.md @@ -16,7 +16,7 @@ import cloudData from '@ohos.data.cloudData'; ``` -## Action +## ClearAction 清除本地下载的云端数据的行为枚举。 @@ -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异步回调。 @@ -361,26 +361,26 @@ static clean(accountId: string, appActions: {[bundleName: string]: Action}, cal **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ----------------------------------------- | ---- | -------------------------------- | -| accountId | string | 是 | 具体打开的云帐号ID。 | -| appActions | {[bundleName: string]: [Action](#action)} | 是 | 要清除数据的应用信息及清除规则。 | -| callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------------------------------------------------- | ---- | -------------------------------- | +| accountId | string | 是 | 具体打开的云帐号ID。 | +| appActions | {[bundleName: string]: [ClearAction](#clearaction)} | 是 | 要清除数据的应用信息及清除规则。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | **示例：** ```js -let action = cloudData.Action; +let action = cloudData.ClearAction; let account = "test_id"; let bundleName1 = "test_bundleName1"; let bundleName2 = "test_bundleName2"; let appActions = { [bundleName1]: action.CLEAR_CLOUD_INFO, [bundleName2]: action.CLEAR_CLOUD_DATA_AND_INFO }; try { - cloudData.Config.clean(account, appActions, function (err) { + cloudData.Config.clear(account, appActions, function (err) { if (err === undefined) { - console.info('Succeeding in cleaning cloud data'); + console.info('Succeeding in clearing cloud data'); } 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) { @@ -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异步回调。 @@ -402,10 +402,10 @@ static clean(accountId: string, appActions: {[bundleName: string]: Action}): Pro **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ----------------------------------------- | ---- | -------------------------------- | -| accountId | string | 是 | 具体打开的云帐号ID。 | -| appActions | {[bundleName: string]: [Action](#action)} | 是 | 要清除数据的应用信息及清除规则。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------------------------------------------------- | ---- | -------------------------------- | +| accountId | string | 是 | 具体打开的云帐号ID。 | +| appActions | {[bundleName: string]: [ClearAction](#clearaction)} | 是 | 要清除数据的应用信息及清除规则。 | **返回值：** @@ -416,16 +416,16 @@ static clean(accountId: string, appActions: {[bundleName: string]: Action}): Pro **示例：** ```js -let action = cloudData.Action; +let action = cloudData.ClearAction; let account = "test_id"; let bundleName1 = "test_bundleName1"; let bundleName2 = "test_bundleName2"; let appActions = { [bundleName1]: action.CLEAR_CLOUD_INFO, [bundleName2]: action.CLEAR_CLOUD_DATA_AND_INFO }; try { - cloudData.Config.clean(account, appActions).then(() => { - console.info('Succeeding in cleaning cloud data'); + cloudData.Config.clear(account, appActions).then(() => { + console.info('Succeeding in clearing cloud data'); }).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) { console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`); diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-relationalStore.md b/zh-cn/application-dev/reference/apis/js-apis-data-relationalStore.md index 2e0ffc029d508118b7e64e8da8e29da87febb585..0a87ddb6133bd4a7e7d1a1561d045aa23708a4a5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-relationalStore.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-relationalStore.md @@ -704,12 +704,12 @@ class EntryAbility extends UIAbility { **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core -| 名称 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ---------------------------------------- | -| total | number | 是 | 表示数据库表中需要端云同步的总行数。 | -| success | number | 是 | 表示数据库表中端云同步成功的行数。 | -| failed | number | 是 | 表示数据库表中端云同步失败的行数。 | -| remained | number | 是 | 表示数据库表中端云同步剩余未执行的行数。 | +| 名称 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | ---------------------------------------- | +| total | number | 是 | 表示数据库表中需要端云同步的总行数。 | +| successful | number | 是 | 表示数据库表中端云同步成功的行数。 | +| failed | number | 是 | 表示数据库表中端云同步失败的行数。 | +| remained | number | 是 | 表示数据库表中端云同步剩余未执行的行数。 | ## TableDetails10+ @@ -3533,7 +3533,48 @@ promise.then(() => { ### setDistributedTables10+ -setDistributedTables(tables: Array<string>, type: number, config: DistributedConfig, callback: AsyncCallback<void>): void +setDistributedTables(tables: Array<string>, type: DistributedType, callback: AsyncCallback<void>): void + +设置分布式数据库表，使用callback异步回调。 + +**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC + +**系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------- | ---- | ---------------------------- | +| tables | Array<string> | 是 | 要设置的分布式数据库表表名。 | +| type | [DistributedType](#distributedtype10) | 是 | 表的分布式类型。 | +| callback | AsyncCallback<void> | 是 | 指定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.`); +}) +``` + +### + +### setDistributedTables10+ + +setDistributedTables(tables: Array<string>, type: DistributedType, config: DistributedConfig, callback: AsyncCallback<void>): void 设置分布式数据库表，使用callback异步回调。 @@ -3546,10 +3587,19 @@ setDistributedTables(tables: Array<string>, type: number, config: Distribu | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | --- | --------------- | | tables | Array<string> | 是 | 要设置的分布式数据库表表名。 | -| type | number | 是 | 表的分布式类型。目前支持的入参值为: relationalStore.DistributedType.DISTRIBUTED_DEVICE、relationalStore.DistributedType.DISTRIBUTED_CLOUD。
当type为relationalStore.DistributedType.DISTRIBUTED_DEVICE时，表示表在不同设备之间分布式。
当type为relationalStore.DistributedType.DISTRIBUTED_CLOUD时，表示表在设备和云端之间分布式。 | +| type | [DistributedType](#distributedtype10) | 是 | 表的分布式类型。 | | config | [DistributedConfig](#distributedconfig10) | 是 | 表的分布式配置信息。 | | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。 + +| **错误码ID** | **错误信息** | +| ------------ | ------------------------------------------------- | +| 14800000 | Inner error. | +| 14800051 | The type of the distributed table does not match. | + **示例：** ```js @@ -3566,7 +3616,7 @@ store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIB ### setDistributedTables10+ - setDistributedTables(tables: Array<string>, type?: number, config?: DistributedConfig): Promise<void> + setDistributedTables(tables: Array<string>, type?: DistributedType, config?: DistributedConfig): Promise<void> 设置分布式数据库表，使用Promise异步回调。 @@ -3578,8 +3628,8 @@ store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIB | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------------------------- | ---- | ------------------------------------------------------------ | -| tables | Array<string> | 是 | 要设置的分布式数据库表表名。 | -| type | number | 否 | 表的分布式类型。默认值是relationalStore.DistributedType.DISTRIBUTED_DEVICE。
目前支持的入参值为: relationalStore.DistributedType.DISTRIBUTED_DEVICE、relationalStore.DistributedType.DISTRIBUTED_CLOUD。
当type为relationalStore.DistributedType.DISTRIBUTED_DEVICE时，表示表在不同设备之间分布式。
当type为relationalStore.DistributedType.DISTRIBUTED_CLOUD时，表示表在设备和云端之间分布式。 | +| tables | Array<string> | 是 | 要设置的分布式数据库表表名。 | +| type | [DistributedType](#distributedtype10) | 否 | 表的分布式类型。默认值是relationalStore.DistributedType.DISTRIBUTED_DEVICE。 | | config | [DistributedConfig](#distributedconfig10) | 否 | 表的分布式配置信息。不传入时默认autoSync为false，即只支持手动同步。 | **返回值**： @@ -3588,6 +3638,15 @@ store.setDistributedTables(["EMPLOYEE"], relationalStore.DistributedType.DISTRIB | ------------------- | ------------------------- | | Promise<void> | 无返回结果的Promise对象。 | +**错误码：** + +以下错误码的详细介绍请参见[关系型数据库错误码](../errorcodes/errorcode-data-rdb.md)。 + +| **错误码ID** | **错误信息** | +| ------------ | ------------------------------------------------- | +| 14800000 | Inner error. | +| 14800051 | The type of the distributed table does not match. | + **示例：** ```js diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-data-rdb.md b/zh-cn/application-dev/reference/errorcodes/errorcode-data-rdb.md index 57bf0bdcd26a16dcb19c3823121a1ea019c682f3..7f0eb4b2e11eb508e284a06cfd85f0c9f06130e5 100644 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-data-rdb.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-data-rdb.md @@ -174,3 +174,20 @@ The data group id is not valid. 从应用市场申请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