LIST BACKUPS FROM KEYSPACE (beta)

Lists existing backups for a particular keyspace.

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 backups for a particular keyspace.

Synopsis

LIST BACKUPS FROM KEYSPACE keyspace_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.
keyspace_name

Name of the keyspace to backup.

Table 2. Backup details
Column name Description Type
id Backup ID. Text
backup_time The time at which the backup started. Timestamp
store The store where the backup is located. Text
keyspace Keyspace name. Text
tables Names of the tables in the backup. Text set
nodes Names of the nodes that performed the backup. UUID set
status The status of the backup:
  • FULL_BACKUP: all nodes successfully performed the backup.
  • QUORUM_BACKUP: a quorum of nodes, according the keyspace replication factor, sucessfully performed the backup.
  • INCOMPLETE_BACKUP: too many nodes failed the backup. An incomplete backup cannot be restored.
  • CLEANING: the backup is being cleaned. See CLEAN BACKUPS (beta).
 Text
schema_versions Status of the schema agreement between nodes:
  • IN AGREEMENT: the schema for all nodes is in agreement.
  • MISMATCH: there is a schema mismatch within the nodes. The resulting backup cannot be restored.
 Text
details Information on the backup status. Text

Examples

List backups

List the existing backup for a particular keyspace:

LIST BACKUPS FROM KEYSPACE keyspace_1;

 id                  | backup_time                     | store         | keyspace   | tables         | nodes                                  | schema_versions | status         | details
---------------------+---------------------------------+---------------+------------+----------------+----------------------------------------+-----------------+----------------+------------------
 my_config_name-UUID | 2020-03-10 18:19:03.036000+0000 |      s3_store | keyspace_1 |   {'table_1'}  | {43236af1-3f83-405c-b138-3c6cc5446037} |    IN AGREEMENT |   FULL BACKUP  | All the token ring nodes were successfully backed up