LIST BACKUP CONFIGURATIONS (beta)

Lists existing backup configurations.

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.

Lists details on existing backup configurations.

Synopsis

LIST BACKUP CONFIGURATIONS ;
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.
Table 2. Backup configuration details
Column name Description Type
name Backup configuration name. Text
target_keyspace List of keyspaces targeted for backup. Set of text values
stores List of backup stores to which the keyspaces are assigned. List of text values
frequency Standard cron expression determining when the backup is performed. Text
enabled If true, the backup will run automatically as specified by frequency. If false, the backup can only be run manually. Boolean
next_execution time The time at which the next backup will take place. Timestamp or null if the backup is unscheduled.

Examples

List backup configurations:

LIST BACKUP CONFIGURATIONS;

 name           | target_keyspace | stores              | frequency | enabled  | next_execution_time
----------------+-----------------+---------------------+-----------+----------+---------------------
 my_config_name |       keyspace_1|       ['s3_store']  | * * * * * |   False  |                null