Back up and Restore Data

On this page

Because CockroachDB is designed with high fault tolerance, backups are primarily needed for disaster recovery (i.e., if your cluster loses a majority of its nodes). Isolated issues (such as small-scale node outages) do not require any intervention. However, as an operational best practice, we recommend taking regular backups of your data.

Based on your license type, CockroachDB offers two methods to back up and restore your cluster's data: Enterprise and Core.

Perform Enterprise backup and restore

If you have an Enterprise license, you can use the BACKUP statement to efficiently back up your cluster's schemas and data to popular cloud services such as AWS S3, Google Cloud Storage, or NFS, and the RESTORE statement to efficiently restore schema and data as necessary.

Manual full backups

In most cases, it's recommended to use the BACKUP command to take full nightly backups of each database in your cluster:

> BACKUP DATABASE <database_name> TO '<full_backup_location>';

If it's ever necessary, you can then use the RESTORE command to restore a database:

> RESTORE DATABASE <database_name> FROM '<full_backup_location>';

Manual full and incremental backups

If a database increases to a size where it is no longer feasible to take nightly full backups, you might want to consider taking periodic full backups (e.g., weekly) with nightly incremental backups. Incremental backups are storage efficient and faster than full backups for larger databases.

Periodically run the BACKUP command to take a full backup of your database:

> BACKUP DATABASE <database_name> TO '<full_backup_location>';

Then create nightly incremental backups based off of the full backups you've already created.

> BACKUP DATABASE <database_name> TO 'incremental_backup_location'
INCREMENTAL FROM '<full_backup_location>', '<list_of_previous_incremental_backup_location>';

If it's ever necessary, you can then use the RESTORE command to restore a database:

> RESTORE <database_name> FROM '<full_backup_location>', '<list_of_previous_incremental_backup_locations>';

Automated full and incremental backups

You can automate your backups using scripts and your preferred method of automation, such as cron jobs.

For your reference, we have created this sample backup script that you can customize to automate your backups.

In the sample script, configure the day of the week for which you want to create full backups. Running the script daily will create a full backup on the configured day, and on other days, it'll create incremental backups. The script tracks the recently created backups in a separate file titled backup.txt and uses this file as a base for the subsequent incremental backups.

1. Download the sample backup script:

   $ wget -qO- https://raw.githubusercontent.com/cockroachdb/docs/master/_includes/v19.2/prod-deployment/backup.sh
   

   Alternatively, you can create the file yourself and copy the script into it:

   #!/bin/bash
   
   set -euo pipefail
   
   # This script creates full backups when run on the configured
   # day of the week and incremental backups when run on other days, and tracks
   # recently created backups in a file to pass as the base for incremental backups.
   
   full_day="<day_of_the_week>"                      # Must match (including case) the output of `LC_ALL=C date +%A`.
   what="DATABASE <database_name>"                   # The name of the database you want to back up.
   base="<storage_URL>/backups"                      # The URL where you want to store the backup.
   extra="<storage_parameters>"                      # Any additional parameters that need to be appended to the BACKUP URI (e.g., AWS key params).
   recent=recent_backups.txt                         # File in which recent backups are tracked.
   backup_parameters=<additional backup parameters>  # e.g., "WITH revision_history"
   
   # Customize the `cockroach sql` command with `--host`, `--certs-dir` or `--insecure`, and additional flags as needed to connect to the SQL client.
   runsql() { cockroach sql --insecure -e "$1"; }
   
   destination="${base}/$(date +"%Y%m%d-%H%M")${extra}"
   
   prev=
   while read -r line; do
       [[ "$prev" ]] && prev+=", "
       prev+="'$line'"
   done < "$recent"
   
   if [[ "$(LC_ALL=C date +%A)" = "$full_day" || ! "$prev" ]]; then
       runsql "BACKUP $what TO '$destination' AS OF SYSTEM TIME '-1m' $backup_parameters"
       echo "$destination" > "$recent"
   else
       destination="${base}/$(date +"%Y%m%d-%H%M")-inc${extra}"
       runsql "BACKUP $what TO '$destination' AS OF SYSTEM TIME '-1m' INCREMENTAL FROM $prev $backup_parameters"
       echo "$destination" >> "$recent"
   fi
   
   echo "backed up to ${destination}"
   

2. In the sample backup script, customize the values for the following variables:

   Variable	Description
   full_day	The day of the week on which you want to take a full backup.
   what	The name of the database you want to back up (i.e., create backups of all tables and views in the database).
   base	The URL where you want to store the backup. URL format: [scheme]://[host]/[path] For information about the components of the URL, see Backup File URLs.
   extra	The parameters required for the storage. Parameters format: ?[parameters] For information about the storage parameters, see Backup File URLs.
   backup_parameters	Additional backup parameters you might want to specify.

   Also customize the cockroach sql command with --host, --certs-dir or --insecure, and additional flags as required.

3. Change the file permissions to make the script executable:

   $ chmod +x backup.sh
   

4. Run the backup script:

   $ ./backup.sh
   

Locality-aware backup and restore

New in v19.2: You can create locality-aware backups such that each node writes files only to the backup destination that matches the node locality configured at node startup.

This is useful for:

• Reducing cloud storage data transfer costs by keeping data within cloud regions.
• Helping you comply with data domiciling requirements.

How it works

A locality-aware backup is specified by a list of URIs, each of which has a COCKROACH_LOCALITY URL parameter whose single value is either default or a single locality key-value pair such as region=us-east. At least one COCKROACH_LOCALITY must be the default. Given a list of URIs that together contain the locations of all of the files for a single locality-aware backup, RESTORE can read in that backup.

During locality-aware backups, backup file placement is determined by leaseholder placement, as each node is responsible for backing up the ranges for which it is the leaseholder. Nodes write files to the backup storage location whose locality matches their own node localities, with a preference for more specific values in the locality hierarchy. If there is no match, the default locality is used.

Usage

For example, to create a locality-aware backup where nodes with the locality region=us-west write backup files to s3://us-west-bucket, and all other nodes write to s3://us-east-bucket by default, run:

BACKUP DATABASE foo TO ('s3://us-east-bucket?COCKROACH_LOCALITY=default', 's3://us-west-bucket?COCKROACH_LOCALITY=region%3Dus-west');

To restore the backup created above, run the statement below. Note that the first URI in the list has to be the URI specified as the default URI when the backup was created. If you have moved your backups to a different location since the backup was originally taken, the first URI must be the new location of the files originally written to the default location.

RESTORE DATABASE foo FROM ('s3://us-east-bucket', 's3://us-west-bucket');

A list of multiple URIs (surrounded by parentheses) specifying a locality-aware backup can also be used in place of any incremental backup URI in RESTORE. If the original backup was an incremental backup, it can be restored using:

RESTORE DATABASE foo FROM 's3://other-full-backup-uri', ('s3://us-east-bucket', 's3://us-west-bucket');

For more detailed examples, see Create locality-aware backups and Restore from a locality-aware backup based on node locality.

Perform Core backup and restore

In case you do not have an Enterprise license, you can perform a Core backup. Run the cockroach dump command to dump all the tables in the database to a new file (backup.sql in the following example):

$ cockroach dump <database_name> <flags> > backup.sql

To restore a database from a Core backup, use the cockroach sql command to execute the statements in the backup file:

$ cockroach sql --database=[database name] < backup.sql

See also

• BACKUP
• RESTORE
• SQL DUMP
• IMPORT
• Use the Built-in SQL Client
• Other Cockroach Commands

Was this helpful?