CANCEL BACKUP

Purpose

The ALTER SYSTEM CANCEL BACKUP statement is used to stop a running backup task.

Limitations and considerations

After using the ALTER SYSTEM CANCEL BACKUP statement to stop a running backup task in a tenant, the system generates some incomplete backup data. It is recommended to enable the automatic cleanup feature for the corresponding tenant in advance to clean up the incomplete backups in a timely manner and avoid resource occupation. For more information about the statement to enable the automatic cleanup feature, see DELETE BACKUP.

Privilege requirements

The root user of the sys tenant (root@sys) or the administrator user of each tenant must execute this statement. Specifically:

• The default administrator user in MySQL mode is the root user.
• The default administrator user in Oracle mode is the SYS user.

Syntax

ALTER SYSTEM CANCEL BACKUP [TENANT [=] {tenant_name[, tenant_name]...}];

Parameters

Examples

Assume that the current cluster has three tenants: sys, mysql_tenant, and oracle_tenant. Both mysql_tenant and oracle_tenant are performing data backup tasks.

• The system tenant stops the data backup tasks of all tenants in the cluster.

  obclient [oceanbase]> ALTER SYSTEM CANCEL BACKUP;
  

  In this example, after the statement is executed, the system stops the data backup tasks of the mysql_tenant and oracle_tenant tenants in the cluster.

• The system tenant stops the data backup task of the mysql_tenant tenant in the cluster.

  obclient [oceanbase]> ALTER SYSTEM CANCEL BACKUP TENANT = mysql_tenant;
  

• The oracle_tenant tenant stops its own data backup task.

  obclient [SYS]> ALTER SYSTEM CANCEL BACKUP;
  

References

• DELETE BACKUP

• Automatic cleanup of expired backups