ALTER BACKUP CONFIGURATION

Alters an existing backup configuration.

Synopsis

ALTER BACKUP CONFIGURATION <configuration_name>
  ( ADD STORE = <store_name> | DROP STORE = <store_name> | WITH <frequency> ) ;

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.

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.

frequency

Standard cron timing expression defining the frequency at which the backup should be run, using Universal Time Coordinated (UTC). Cron timing expressions consist of the following five elements separated by spaces:

MM: Two digit minute, 0-60
HH: Two digit hour, 0-24
DD: Two digit day of the month, 1-31
MM: Two digit month, 1-12 (January to December)
D: Single digit day of the week, 0-6 (Sunday to Saturday), or three letter abbreviation (SUN, MON, TUE, WED, THU, FRI, or SAT).

You can use an asterisk (*) in any position to match all possible values for that field.

+ For example, to run a backup on the first minute of midnight every day, use 0 0 * * *.

+ Shortcuts, such as */30 * * * * for every 30 minutes, aren’t supported.

Examples

Add a backup store

Add a backup store to an existing configuration:

ALTER BACKUP CONFIGURATION backup_configuration_1 ADD STORE filesystem_store_1;

Drop a backup store

Drop a backup store from an existing configuration:

ALTER BACKUP CONFIGURATION backup_configuration_1 DROP STORE filesystem_store_1;

Change the backup frequency

Set a backup frequency that runs on the first minute of midnight every day:

ALTER BACKUP CONFIGURATION my_conf WITH frequency = ‘0 0 * * *’;