ALTER BACKUP STORE

Alters an existing backup store using the properties specified in settings.

Synopsis

ALTER BACKUP STORE  WITH <settings> ;

Legend
Syntax conventions	Description
UPPERCASE	Literal keyword.
Lowercase	Not literal.
`< >`	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.
`<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.

store_name

Name of the backup store. Store names can use alphanumeric characters and underscores only. They are case insensitive.

settings

A key/value list of settings particular to the store class. For example, for an FSBlobStore class:

settings = {'path':'/path/to/data', 'retention_time':'1w'}

Common settings for all store classes

The following settings can be used with any store class.

Setting Description Type Required

Setting	Description	Type	Required
`transfer_rate_limit_mbs`	Maximum upload rate per node in MB per second.	int	false
`retention_time`	Time duration for which a snapshot is retained.	duration	false
`retention_number`	Number of snapshots retained.	int	false

transfer_rate_limit_mbs

Maximum upload rate per node in MB per second.

int

false

retention_time

Time duration for which a snapshot is retained.

duration

false

retention_number

Number of snapshots retained.

int

false

The parameters retention_time and retention_number can be used individually or in combination. Setting either to 0 ignores the respective parameter.

The transfer_rate_limit_mbs setting is not supported for Composite backup stores.

Examples

Retain backup younger than one week:

'retention_time':'1w'

Retain a minimum of 3 full backup at any point in time:

'retention_number':3

Any non-full backup with a status of INCOMPLETE or QUORUM that occurs between the full snapshots is retained as well.

Retain a mininum of 3 full backups even if older than one week:

'retention_time':'1w','retention_number':3

If, for example, there happen to be four full backups within the retention_time window, all four are retained. If there are only two backups, however, the last backup older than the retention_time window will also be retained. In addition, any non-full backup with a status of INCOMPLETE or QUORUM that occurs between the full backups is retained as well.

FSBlobStore class settings

The following settings are applicable only to the FSBlobStore class.

Setting Description Type Required

Setting	Description	Type	Required
`path`	Path where snapshots are stored. The directory must exist.	text	true

path

Path where snapshots are stored. The directory must exist.

text

true

AzureBlobStore class settings

The following settings are applicable only to the AzureBlobStore class.

Setting Description Type Required

Setting	Description	Type	Required
`container`	Azure container in which snapshots are stored.	text	true
`endpoint`	Azure endpoint. May be replaced with the Azure account name.	text	true
`sas_token`	The Azure sas_token.	text	true unless Azure Managed Identity authentication mechanism is in use.

container

Azure container in which snapshots are stored.

text

true

endpoint

Azure endpoint. May be replaced with the Azure account name.

text

true

sas_token

The Azure sas_token.

text

true unless Azure Managed Identity authentication mechanism is in use.

GoogleCloudBlobStore class settings

The following settings are applicable only to the GoogleCloudBlobStore class.

Setting Description Type Required

Setting	Description	Type	Required
`bucket`	Google Cloud bucket in which snaphots are stored.	text	true
`client_email`	Email address associated with the Google Cloud account.	text	false unless `private_key` is set
`client_id`	Client ID associated with the Google Cloud account.	text	false
`private_key`	Private key associated with the Google Cloud account.	text	false unless `client_email` is set
`private_key_id`	Private key ID of the <private_key> associated with the Google Cloud account.	text	false
`project_id`	Project ID associated with the Google Cloud bucket.	text	false
`endpoint`	Google Cloud Endpoint. See https://cloud.google.com/endpoints/docs/quickstart-endpoints.	text	false

bucket

Google Cloud bucket in which snaphots are stored.

text

true

client_email

Email address associated with the Google Cloud account.

text

false unless private_key is set

client_id

Client ID associated with the Google Cloud account.

text

false

private_key

Private key associated with the Google Cloud account.

text

false unless client_email is set

private_key_id

Private key ID of the <private_key> associated with the Google Cloud account.

text

false

project_id

Project ID associated with the Google Cloud bucket.

text

false

endpoint

Google Cloud Endpoint. See https://cloud.google.com/endpoints/docs/quickstart-endpoints.

text

false

Authentication details

If no credentials are set in the GoogleCloudBlobStore settings, Application Default Credentials (ADC) are used. Credentials are checked in the following order:

ADC checks the environment variable, GOOGLE_APPLICATION_CREDENTIALS, and, if set, uses the referenced service account file.
If GOOGLE_APPLICATION_CREDENTIALS is not set, ADC uses the default service account provided by the Compute Engine, Kubernetes Engine, App Engine, or Cloud Functions depending on the environment on which the application is running.
If no credentials are found, an error occurs. See: https://cloud.google.com/docs/authentication/production.

S3BlobStore class settings

The following settings are applicable to only the S3BlobStore class.

Setting Description Type Required

Setting	Description	Type	Required
`bucket`	AWS bucket in which snapshots are stored.	text	true
`region`	AWS region, an alternative to the <endpoint> setting.	text	true if `endpoint` is not set
`access_key`	Access key used for authentication.	text	false
`secret_key`	Secret key used for authentication.	text	false
`default_socket_timeout`	Socket timeout in ms.Default: 50,000	int	false
`max_error_retry`	Maximum retries when an error occurs.Default: 3	int	false
`default_throttle_retries`	Enables retry throttling.Default: true	int	false
`server_side_encryption`	Enable server-side encryption (AES256).Default: true	boolean	false
`accelerated_mode_enabled`	Enable AWS transfer acceleration. Only applicable to AWS S3. See https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html.Default: true	boolean	false
`storage_class`	Storage class in which Binary Large Objects (BLOBS) are stored. See https://aws.amazon.com/s3/storage-classes/.	text	false
`canned_acl`	Access Control List (ACL) for buckets and objects.	text	false
`endpoint`	Endpoint for the AWS S3 server, an alternative to the <region> setting.	text	true if `region` is not set.

bucket

AWS bucket in which snapshots are stored.

text

true

region

AWS region, an alternative to the <endpoint> setting.

text

true if endpoint is not set

access_key

Access key used for authentication.

text

false

secret_key

Secret key used for authentication.

text

false

default_socket_timeout

Socket timeout in ms.Default: 50,000

int

false

max_error_retry

Maximum retries when an error occurs.Default: 3

int

false

default_throttle_retries

Enables retry throttling.Default: true

int

false

server_side_encryption

Enable server-side encryption (AES256).Default: true

boolean

false

accelerated_mode_enabled

Enable AWS transfer acceleration. Only applicable to AWS S3. See https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html.Default: true

boolean

false

storage_class

Storage class in which Binary Large Objects (BLOBS) are stored. See https://aws.amazon.com/s3/storage-classes/.

text

false

canned_acl

Access Control List (ACL) for buckets and objects.

text

false

endpoint

Endpoint for the AWS S3 server, an alternative to the <region> setting.

text

true if region is not set.

Authentication details

If no details are specified in the S3BlobStore settings, the DefaultAWSCredentialsProviderChain is used. The DefaultAWSCredentialsProviderChain searches for credentials in the following order:

The environment variables, AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
The Java system properties, aws.accessKeyId and aws.secretKey.
A credential profile located at ~/.aws/credentials.
Credentials provided through the Amazon EC2 container service if the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set and the security manager has permission to access that variable.

Instance profile credentials delivered using the Amazon EC2 metadata service.

CompositeStore class settings

The following setting is applicable to only the CompositeStore class.

Setting Description Type Required

Setting	Description	Type	Required
`data-center-name`	The key must be a valid DSE datacenter name.	text	The value must be an existing configured backup store: `FSBlobStore` `AzureBlobStore` `GoogleCloudBlobStore` `S3BlobStore`

data-center-name

The key must be a valid DSE datacenter name.

text

The value must be an existing configured backup store:

FSBlobStore
AzureBlobStore
GoogleCloudBlobStore
S3BlobStore

Examples

Alter an Amazon S3 backup store

Change the settings for an Amazon S3 backup store:

ALTER BACKUP STORE s3_store WITH settings={'bucket': 'my-bucket-name',
                                           'access_key': '<my_access_key\>',
                                           'secret_key': '<my_secret_key\>',
                                           'region': 'us-east-1'};

Alter a file system backup store

Change the settings for a file system backup store:

ALTER BACKUP STORE fs_store WITH settings={'path': '/my/new/path/'};

ALTER BACKUP STORE

Synopsis

Examples

Alter an Amazon S3 backup store

Alter a file system backup store

Was this helpful?

Give Feedback