CLEAN BACKUPS (beta)

Removes stale backups based on the backup retention policy.

Important: The DSE Backup and Restore Service is currently in beta and is intended to be used by users provisioning DSE via the DataStax Cass Operator in a Kubernetes cluster.

Removes stale backups based upon backup retention policy and an optional backup configuration name and store name.

The DSE Backup Service runs a scheduled task every two hours to get rid of backups for all configurations and stores based upon the configured retention policy. All backup files are removed, including metadata and SSTables. The CLEAN BACKUPS statement lets you run the cleaning process manually if desired. For details on configuring backup retention policies, see Customize backup retention policy.
Note: During the cleaning process, backups that are in the process of being deleted will show in the LIST BACKUP STORES (beta) output with the status CLEANING until the cleaning is complete.

Synopsis

CLEAN BACKUPS 
    [ FOR CONFIGURATION configuration_name ]
    [ ON STORE store_name ] ;
Table 1. Legend
Syntax conventions Description
UPPERCASE Literal keyword.
Lowercase Not literal.
Italics Variable value. Replace with a user-defined value.
[] Optional. Square brackets ( [] ) surround optional command arguments. Do not type the square brackets.
( ) Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.
| Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
... Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.
'Literal string' Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
{ key : value } Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.
<datatype1,datatype2> Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
cql_statement; End CQL statement. A semicolon ( ; ) terminates all CQL statements.
[--] Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.
' <schema> ... </schema> ' Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.
@xml_entity='xml_entity_type' Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrConfig files.
configuration_name

The backup configuration name. Configuration names can use alphanumeric characters and underscores only. They are case insensitive.

store_name

Name of the backup store. Store names can use alphanumeric characters and underscores only. They are case insensitive.

Examples

Clean backups for all configurations and stores

Delete all backup information for all configurations and backup stores:
CLEAN BACKUPS;

Clean backups for a particular data store

Delete all backup information for all configurations associated with a particular backup store:
CLEAN BACKUPS ON STORE filesystem_store1;

Clean backups for a particular configuration of a particular data store

Delete all backup information for a configuration associated with a particular backup store:
CLEAN BACKUPS FOR CONFIGURATION backup_configuration_1 ON STORE filesystem_store_1;