DELETE BACKUP POLICY

You can execute the ADD DELETE BACKUP POLICY statement to set a cleanup strategy and the DROP DELETE BACKUP POLICY statement to drop a cleanup strategy.

If you want to enable the automatic cleanup feature for a user, you can use the ADD DELETE BACKUP POLICY statement to set a cleanup strategy for the tenant. A tenant with a cleanup strategy in effect will trigger an automatic cleanup task every hour.

While an automatic cleanup task is being executed, you can use the CANCEL DELETE BACKUP statement to cancel the task. For more information, see CANCEL DELETE BACKUP. If you want to stop a scheduled automatic cleanup task from being executed, you must first use the DROP DELETE BACKUP POLICY statement to drop the automatic cleanup strategy, and then use the CANCEL DELETE BACKUP statement to cancel the task.

Limitations and considerations

• When you use the ADD DELETE BACKUP POLICY statement to set a cleanup strategy, you can set only a tenant-level cleanup strategy, not a cluster-level one.

• You can set or delete a cleanup strategy for only one tenant per command.

• If you use the DROP DELETE BACKUP POLICY statement to delete a cleanup strategy for a tenant, and all cleanup strategies of the tenant are deleted, the automatic cleanup feature of the tenant is disabled.

• Deleting a cleanup strategy does not affect ongoing cleanup tasks. It only means that the deleted cleanup strategy will not generate new cleanup tasks during the next automatic cleanup scheduling.

Privilege requirements

You must use the root user of the sys tenant (root@sys) or the administrator of each tenant to perform the operation. By default:

• In MySQL mode, the default administrator is the root user.
• In Oracle mode, the default administrator is the SYS user.

Syntax

ALTER SYSTEM delete_backup_action [ TENANT [=] tenant_name ];

delete_backup_action:
      ADD DELETE BACKUP POLICY [=] policy_name [RECOVERY_WINDOW [=] recovery_window]
    | DROP DELETE BACKUP POLICY [=] policy_name

Parameters

Examples

• System tenant

  • Set the cleanup strategy of the mysql_tenant tenant to default, which specifies to retain backup data for 7 days.

    obclient [oceanbase]> ALTER SYSTEM ADD DELETE BACKUP POLICY = 'default' RECOVERY_WINDOW ='7d' TENANT = mysql_tenant;
    

    After the setting is successful, you can execute the following statement to view the cleanup strategy that has been set for the tenant.

    obclient [oceanbase]> SELECT * FROM oceanbase.CDB_OB_BACKUP_DELETE_POLICY WHERE TENANT_ID=1002;
    

    The query result is as follows:

    +-----------+-------------+-----------------+
    | TENANT_ID | POLICY_NAME | RECOVERY_WINDOW |
    +-----------+-------------+-----------------+
    |      1002 | default     | 7d              |
    +-----------+-------------+-----------------+
    1 row in set
    

  • Delete the default cleanup strategy from the mysql_tenant tenant.

    obclient [oceanbase]> ALTER SYSTEM DROP DELETE BACKUP POLICY 'default' TENANT mysql_tenant;
    

• User tenant

  • Set the cleanup strategy of the oracle_tenant tenant to default, which specifies to retain backup data for 7 days.

    obclient [SYS]> ALTER SYSTEM ADD DELETE BACKUP POLICY 'default' RECOVERY_WINDOW '7d';
    

    After the setting is successful, you can execute the following statement to view the cleanup strategy that has been set for the tenant.

    obclient [SYS]> SELECT * FROM SYS.DBA_OB_BACKUP_DELETE_POLICY;
    

    The query result is as follows:

    +-------------+-----------------+
    | POLICY_NAME | RECOVERY_WINDOW |
    +-------------+-----------------+
    | default     | 7d              |
    +-------------+-----------------+
    1 row in set
    

  • Delete the cleanup strategy from the oracle_tenant tenant.

    obclient [SYS]> ALTER SYSTEM DROP DELETE BACKUP POLICY 'default';
    

References

• CANCEL DELETE BACKUP

• Automatically clear expired backups

• Stop clearing backups