数据清理归档工单主要用于删除历史数据。本文介绍如何在数据库工作台 DBW 创建数据清理归档工单。 ## 前提条件 * 已创建云数据库 MySQL 版实例。详细操作，请参见[创建实例](https://www.volcengine.com/docs/6313/75366)。 * 已开启实例的安全管控。详细操作，请参见[开启安全管控](https://www.volcengine.com/docs/6956/1111481)。 * 已添加为 DBW 角色的用户。详细操作，请参见[添加用户](https://www.volcengine.com/docs/6956/1332797)。 * 已授予添加为 DBW 角色用户相关权限。详细操作，请参见[权限管理](https://www.volcengine.com/docs/6956/1111488)。 ## 注意事项 * 功能概述：数据清理归档工单主要用于定时、分批地删除历史数据，以保障数据库性能与空间。 * 创建限制与权限要求： * 实例管控：仅支持针对已纳入安全管控的实例创建工单。若搜索不到目标实例，请联系管理员将其加入安全管控列表。详细操作，请参见[开启安全管控](https://www.volcengine.com/docs/6956/1111481?_vtm_=a106466.b106468.0_0.0_0.0.1678_7610615829733918244&lang=zh)。 * 权限校验：仅允许对具备 SQL 变更权限的数据库对象发起归档工单。 * 索引要求：所选择的目标表必须包含非空唯一索引或主键，否则无法通过校验。 * 执行机制与注意事项： * 时间基准：偏移时间以任务实际执行时间为准（时区为 UTC+8）。单次手动触发执行时，归档的时间处理以单击执行时的当前时间为准。 * 调度误差：受系统调度影响，任务的实际开始时间与配置的计划时间可能存在 1~2 分钟的误差。 * 数据量建议：为避免删除失败或引发锁表风险，建议单次删除的数据量控制在千万级以内。 * 当目标表存在运行中的清理归档任务时，不支持重复提交新的数据清理归档工单，需待当前任务结束后再操作。 * 关于数据清理归档的详细工作原理与完整规范，请参见[数据清理归档简介](https://www.volcengine.com/docs/6956/1356508)。 ## 操作步骤 1. 登录 [DBW 控制台](https://console.volcengine.com/dbw)。 2. 在顶部菜单栏，选择目标地域。 3. 在左侧导航栏，选择**数据管理** \> **工单列表**。 4. 在**工单列表**页面，单击**数据清理归档**。 5. 在**数据清理归档**页签，单击**创建清理归档工单**。 6. 在**创建清理归档工单**控制面板，配置以下参数信息。 |**类别** |**参数** |**说明** | |---|---|---| |**基本信息** |**创建人** |默认为当前登录的账号，且不支持修改。 | ||**工单标题** |（可选）自定义工单标题。工单标题的长度不能超过 200 个字符。 | ||**工单备注** |（可选）自定义您的工单备注，建议和您的业务相关，详实的备注信息方便后续维护。工单备注的长度不能超过 200 个字符。 | |

库表选择

|**数据库类型** |选择**云数据库 MySQL 版**。 | ||**实例** |从下拉列表中选择需要进行数据清理归档且已开启安全管控的实例。 | ||**数据库** |从下拉列表中选择需要进行数据清理归档的数据库。 | ||**归档表** |从下拉列表中选择需要进行数据清理归档的表。 | |**清理配置** |**过滤条件** |（可选）如果仅清理符合条件的数据，您也可以在过滤条件输入框中输入表内数据的过滤条件。

例如某数据库的目标清理归档表中有 `id` 字段，现需要清理 id 值小于 10 的数据，则配置过滤条件 `id < 10`。 | ||**变量配置** |配置该变量可以在配置归档过滤条件时使用。最多可添加 10 个变量，多个变量会以 AND 的方式同时拼入 where 条件中。

例如表格中包含 `CreateTime` 和 `ModifyTime` 两个时间字段，且字段时间格式为 `yyyy-mm-dd`，您需要清理 10 天前新增并在 5 天前修改的数据，那么您需要添加 2 个变量，且变量的配置信息如下所示：

* 变量 1：变量名为 `CreateTime`，时间格式为 `yyyy-mm-dd`，时间运算为 \-、10、日，如果当前日期为 2024\-12\-03，那么生成的 where 语句为 `CreateTime < '2024-11-24'`；如果当前日期为 2024\-12\-04，那么生成的 where 语句为 `CreateTime < '2024-11-25'`。

* 变量 2：变量名为 `ModifyTime`，时间格式为 `yyyy-mm-dd`，时间运算为 \-、5、日，如果当前日期为 2024\-12\-03，那么生成的 where 语句为 `ModifyTime < '2024-11-24'`，如果当前日期为 2024\-12\-04，那么生成的 where 语句为 `ModifyTime < '2024-11-30'`。

配置时间变量的更多信息，请参见[配置变量](https://www.volcengine.com/docs/6956/1347823)。

注意

设置的变量名是目标归档表中存在的，同时时间格式也是目标归档表中存在的字段格式。

时间偏移 -为向前偏移，+ 为向后偏移，+、- 均为小于时间判断。

| ||**数据备份** |勾选**删除的数据保留备份**，表示将本次删除的数据进行备份。

去勾选**删除的数据保留备份**，表示将直接删除数据，并且不对清理的数据进行备份。 | ||**备份类型** |勾选**删除的数据保留备份**，您还需要配置以下备份类型。

* **备份到内置 TOS**：将删除的数据保留到内置 TOS 中，保留时间为 30 天。

注意

备份到内置 TOS 中的数据保留时间是 30 天，过期将被自动删除。内置 TOS 的下载地址可以通过工单详情页面中的查看日志获取，如有需求请及时提交工单下载数据。

* **备份到原库**：暂不支持。 | |

策略配置

|**归档类型**

|* **重复归档**：当前支持按**每天**、**每周**、**每月**或 **Cron 表达式**进行周期性清理归档数据。详细信息，请参见[周期配置](https://www.volcengine.com/docs/6956/1356570#.5ZGo5pyf6YWN572u)。

* **不重复**：如果选择**不重复**，那么数据清理归档则在工单审批结束后按照配置的**执行方式**执行单次执行清理归档任务。 | ||**执行时长** |* **不指定执行时长**：让任务自然运行，直至任务执行结束。

* **指定执行时长**：指定任务执行多久后自动结束，单位是小时。如果任务执行时间超过当前配置的指定执行时长，任务自动结束。指定任务的执行时长，避免了任务长时间运行，在业务高峰期影响业正常业务的运行。 | ||**执行方式** |如果归档类型选择**不重复**，则需要配置以下信息。

* **审批后自动执行**：当前工单审批通过后，自动执行当前工单的清理归档任务。

* **审批后定时执行**：当前工单审批通过后，在指定的时间点执行当前工单的清理归档任务。需配置任务开始执行时间。 | ||**执行开始时间** |如果归档类型选择**不重复**，且执行方式选择**审批后定时执行**，则需要任务启动时间。

单击时间图标，选择任务执行的时间点。 | ||**分批执行** |当数据量较大时，支持分批次执行清理归档数据，及是否开启主备延迟检查。

* **按需设置每批次的执行行数**，**及每批次间的 sleep 时间**。默认每批执行 1000 行，每批次 sleep 时间为 0.5 秒。

* **是否开启主备延迟检查**。当开启主备延迟检查时，需要设置当主备延迟大于多少秒时，中断执行任务。默认不开启主备延迟检查。

说明

默认按照主键从小到大的顺序分批次执行清理归档任务，直到完成任务。

关闭主备延迟检查，可能导致主备延迟过大，影响主备切换。

| ||**审批流程** |审批流程当前包含一级审批、二级审批和三级审批，同数据变更审批流程一致，分别为在开启实例安全管控时设置的 Owner、DBA 和 Admin。 | |**语句预览** |**SQL 语句** |DBW 根据上面配置的信息，如**数据库**、**归档表**、**过滤条件**和**变量配置**等信息，自动生成待执行的 SQL 语句。如果确认 SQL 语句有误，需修改上面的配置信息，直至生成的 SQL 语句无误。 | 7. 单击**提交工单**。本文参数示例生成的的 SQL 语句如下所示： * 当前时间为 `2024-12-03`时，生成的语句如下所示： ```sql delete from `test_db`.`common_types_table` where (id < 10) AND `createtime` < '2024-11-24' AND `modifytime` < '2024-11-29' ``` * 当前时间为 `2024-12-04`时，生成的语句如下所示： ```sql delete from `test_db`.`common_types_table` where (id < 10) AND `createtime` < '2024-11-25' AND `modifytime` < '2024-11-30' ``` ## 周期配置 |**参数** |||**说明** | |---|---|---|---| |**间隔周期** |**每天** |**开始归档时间** |以天为周期，设置每日执行一次任务的具体时间。 | ||**每周** |**指定时间** |以周为周期，按需勾选星期几执行任务，支持多选。 | |||**开始归档时间** |设置每次执行任务的具体时间。

例如指定时间设置在星期一、星期三、星期五，具体时间设置在 02:30，那么将在每周的周一、周三和周五的凌晨两点半执行任务。 | ||**每月** |**指定时间** |以月为周期，按需勾选每月几号执行任务，支持多选。

说明

由于月份的天数不一样，支持选择每月最后一天执行任务。

| |||**开始归档时间** |设置每次执行任务的具体时间。

例如指定时间设置在每月 1 号、每月 15 号和每月最后一天，具体时间设置在 05:00，那么将在每个月的 1 号、15 号和每月的最后一天执行任务。 | ||**Cron 表达式** |**Cron 表达式** |支持通过 Cron 表达式配置任务执行周期，如 `0 0 1 * * ?`，表示每天凌晨 1 点执行一次清理归档任务。 |