CANCEL BACKUP

Cancels a backup in progress using the backup task ID.

Synopsis

CANCEL BACKUP <backup_id> ;

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.

backup_id: The backup operation UUID.

Example

Cancel a running backup process:

CANCEL BACKUP backup_configuration_1-c0dfeb5b-323e-4e3d-8ebc-6948050e3e70;

CANCEL BACKUP

Synopsis

Example

Was this helpful?

Give Feedback