LIST BACKUPS FROM KEYSPACE

Lists details on existing backups for a particular keyspace.

Synopsis

LIST BACKUPS FROM KEYSPACE <keyspace_name> ;

Syntax legend

Syntax conventions Description

Syntax conventions	Description
UPPERCASE	Literal keyword, unless bold. If bold, it is a variable. For example, `DESCRIBE KEYSPACE KEYSPACE_NAME;` includes the CQL keywords `DESCRIBE KEYSPACE` and the variable `KEYSPACE_NAME`. If you ran this command, you would replace `KEYSPACE_NAME` with the name of the keyspace you want to describe, such as `DESCRIBE KEYSPACE customers;`.
Lowercase	Not literal
`< >` or bold	Often represents a variable placeholder that you must replace with a user-defined value. However, angle brackets are also required to surround data types in a set, list, map, or tuple.
`[]`	Optional command arguments. Do not type the square brackets.
`( )`	A group of options you can choose from. Do not type the parentheses.
`\|`	Separates alternative elements when you can choose one of several elements. Type any one of the elements. Do not type the vertical bar.
`...`	A repeatable syntax element. Can be reused as often as required.
`'`	Single quotation marks must surround literal strings in CQL statements, such as `'example_string'`. Use single quotation marks to preserve upper case. Additionally, single quotation marks are used in Search CQL to surround an entire XML schema declaration. For example: `' <schema> ... </schema> '`
`{ <key> : <value> }`	Curly braces enclose map collections or key value pairs. A colon separates the key and the value.
`<datatype2`	Angle brackets enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
`;`	Marks the end of a CQL statement.
`[--]`	Separate command line options from command arguments with two hyphens. This syntax is useful when arguments might be mistaken for command line options.
`@<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.

UPPERCASE

Literal keyword, unless bold. If bold, it is a variable. For example, DESCRIBE KEYSPACE KEYSPACE_NAME; includes the CQL keywords DESCRIBE KEYSPACE and the variable KEYSPACE_NAME. If you ran this command, you would replace KEYSPACE_NAME with the name of the keyspace you want to describe, such as DESCRIBE KEYSPACE customers;.

Lowercase

Not literal

< > or bold

Often represents a variable placeholder that you must replace with a user-defined value. However, angle brackets are also required to surround data types in a set, list, map, or tuple.

[]

Optional command arguments. Do not type the square brackets.

( )

A group of options you can choose from. Do not type the parentheses.

|

Separates alternative elements when you can choose one of several elements. Type any one of the elements. Do not type the vertical bar.

...

A repeatable syntax element. Can be reused as often as required.

'

Single quotation marks must surround literal strings in CQL statements, such as 'example_string'. Use single quotation marks to preserve upper case.

Additionally, single quotation marks are used in Search CQL to surround an entire XML schema declaration. For example: ' <schema> ... </schema> '

{ <key> : <value> }

Curly braces enclose map collections or key value pairs. A colon separates the key and the value.

<datatype2

Angle brackets enclose data types in a set, list, map, or tuple. Separate the data types with a comma.

;

Marks the end of a CQL statement.

[--]

Separate command line options from command arguments with two hyphens. This syntax is useful when arguments might be mistaken for command line options.

@<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.

Backup details
Column	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 to the keyspace replication factor, successfully 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.	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 the existing backup for a particular keyspace:

LIST BACKUPS FROM KEYSPACE keyspace_1;

Result

 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

LIST BACKUPS FROM KEYSPACE

Synopsis

Examples

Was this helpful?

Give Feedback