Restore Data from a Backup

This page describes the Backups page and how to restore your data.

The backups that Cockroach Labs runs for you can be viewed on the Backups page.

Cockroach Labs runs full cluster backups hourly for every CockroachDB Serverless (beta) cluster. The full backups are retained for 30 days.

Cockroach Labs runs full backups daily and incremental backups hourly for every CockroachDB Cloud cluster. The full backups are retained for 30 days, while incremental backups are retained for 7 days.

Note:

Currently, you can only restore databases and tables to the same cluster that the backup was taken from.

In the meantime, you can back up and restore data manually or back up from a self-hosted CockroachDB cluster and restore into a CockroachDB Cloud cluster. Note that you cannot restore a backup of a multi-region database into a single-region database.

Backups page

A list of your full cluster backups displays on your cluster's Backups page.

For each backup, the following details display:

  • The date and time the backup was taken (Data From)
  • The Status of the backup
  • The Type of backup
  • The Size of the backup
  • The remaining number of days the backup will be retained (Expires In)
  • The number of Databases included in the backup

    To view the databases included in the backup, click the number in the Databases column.

  • The date and time the backup was taken (Data From)
  • The Status of the backup
  • The remaining number of days the backup will be retained (Expires In)

Databases

To view the databases included in the backup, click the number in the Databases column on the cluster view of the Backups page.

For each database in the backup, the following details display:

  • The Name of the database
  • The Size of the database data captured in the backup

    Note:

    If the Size listed for a database in an incremental backup is 0 B, it means no changes were made in the database since the last full backup.

  • The number of Tables in the database

    To view the tables in the database, click the number in the Tables column.

To restore a database, click Restore in the corresponding row.

Note:

If a database does not contain tables, it will not display in the Databases view.

Tables

To view the tables in a database, click the number in the Tables column on the Databases page.

For each table in the database, the following details display:

  • The Name of the table
  • The Size of the table data captured in the backup

    Note:

    If the Size listed for a table in an incremental backup is 0.00 B, it means no changes were made in the table since the last full backup.

  • The number of Rows captured in the backup

Ways to restore data

Console Admin can perform the following from the Console:

Additional ways to restore data:

Restore a database

To restore a database:

  1. Find the cluster backup containing the database you want to restore, and click the number in the corresponding Databases column.
  2. In the Databases view, click Restore for the database you want to restore.

    The Restore database module displays with backup details.

  3. In the Restore to field, enter the name of the destination database.

    Note:

    Resolve any naming conflicts by using DROP or RENAME on the existing database. If you enter a unique name in the Restore to field, a new database will be created.

  4. Select any of the Dependency options to skip. You can:

    • Skip missing foreign keys, which will remove missing foreign key constraints (i.e., when the referenced table is not in the backup or is not being restored) before restoring.
    • Skip missing sequences, which will ignore sequence dependencies (i.e., the DEFAULT expression that uses the sequence).
    • Skip missing views, which will skip restoring views that cannot be restored because their dependencies are not being restored at the same time.
  5. Click Continue

  6. Once you have reviewed the restore details, click Restore.

When the restore job has been created successfully, you will be taken to the Restore Jobs tab, which will show you the status of your restore.

When the restore is complete, be sure to set any database-specific zone configurations and, if applicable, grant privileges.

Restore a table

To restore a table:

  1. Find the cluster backup containing the table you want to restore, and click the number in the corresponding Databases column.
  2. In the Databases view, find the database containing the table you want to restore, and click the number in the corresponding Tables column.

    The Tables view displays.

  3. Click Restore for the table you want to restore.

    The Restore table module displays with backup details.

  4. In the Restore to field, enter the name of the destination database.

    Note:

    If you enter the name of an existing database, the table will be restored into that existing database. To use the name of an existing database, first resolve any naming conflicts by using DROP or RENAME on the existing database. If you enter a unique name in the Restore to field, a new database will be created.

  5. Select any of the Dependency options to skip. You can:

    • Skip missing foreign keys, which will remove missing foreign key constraints (i.e., when the referenced table is not in the backup or is not being restored) before restoring.
    • Skip missing sequences, which will ignore sequence dependencies (i.e., the DEFAULT expression that uses the sequence).
    • Skip missing views, which will skip restoring views that cannot be restored because their dependencies are not being restored at the same time.
  6. Click Continue

  7. Once you have reviewed the restore details, click Restore.

When the restore job has been created successfully, you will be taken to the Restore Jobs tab, which will show you the status of your restore.

Back up a self-hosted CockroachDB cluster and restore into a CockroachDB Cloud cluster

To back up a self-hosted CockroachDB cluster into a CockroachDB Cloud cluster:

  1. While connected to your self-hosted CockroachDB cluster, back up your databases and/or tables to an external location:

    icon/buttons/copy
    BACKUP DATABASE example_database INTO 'gs://{bucket name}/{path/to/backup}?AUTH=specified&CREDENTIALS={encoded key}';
    
    Warning:

    If you are backing up the data to AWS or GCP, use the specified option for the AUTH parameter, as CockroachDB Cloud will need the specified credentials upon RESTORE. For more information on authentication parameters to cloud storage providers, see Use Cloud Storage for Bulk Operations.

  2. Connect to your CockroachDB Cloud cluster:

    icon/buttons/copy

    cockroach sql --url 'postgresql://<user>@<cluster-name>-<short-id>.<region>.cockroachlabs.cloud:26257/<database>?sslmode=verify-full&sslrootcert='$HOME'/Library/CockroachCloud/certs/<cluster-name>-ca.crt'
    

    icon/buttons/copy
    cockroach sql --url 'postgresql://<user>@<cluster-name>-<short-id>.<region>.cockroachlabs.cloud:26257/<database>?sslmode=verify-full&sslrootcert='$HOME'/Library/CockroachCloud/certs/<cluster-name>-ca.crt'
    
    icon/buttons/copy
    cockroach sql --url "postgresql://<user>@<cluster-name>-<short-id>.<region>.cockroachlabs.cloud:26257/<database>?sslmode=verify-full&sslrootcert=$env:appdata\CockroachCloud\certs\$<cluster-name>-ca.crt"
    

    Where:

    • <user> is the SQL user. By default, this is your CockroachDB Cloud account username.
    • <cluster-name>-<short-id> is the short name of your cluster plus the short ID. For example, funny-skunk-3ab.
    • <cluster-id> is a unique string used to identify your cluster when downloading the CA certificate. For example, 12a3bcde-4fa5-6789-1234-56bc7890d123.
    • <region> is the region in which your cluster is running. If you have a multi-region cluster, you can choose any of the regions in which your cluster is running. For example, aws-us-east-1.
    • <database> is the name for your database. For example, defaultdb.

    You can find these settings in the Connection parameters tab of the Connection info dialog.

  3. Restore to your CockroachDB Cloud cluster.

    Use SHOW BACKUPS with your external location to find the backup's subdirectory:

    icon/buttons/copy
    SHOW BACKUPS IN 'gs://{bucket name}/{path/to/backup}?AUTH=specified&CREDENTIALS={encoded key}';
    
            path
    ------------------------
    2021/03/23-213101.37
    2021/03/24-172553.85
    2021/03/24-210532.53
    (3 rows)
    

    Use the subdirectory to specify the backup to restore:

    icon/buttons/copy
    RESTORE DATABASE example_database FROM '2021/03/23-213101.37' IN 'gs://{bucket name}/{path/to/backup}?AUTH=specified&CREDENTIALS={encoded key}';
    

Troubleshooting

Resolve a database naming conflict

The databases you want to restore cannot have the same name as an existing database in the target cluster. Before you restore a database, verify that the database name is not already in use. To do this, connect to the target cluster with the CockroachDB SQL client and run the following:

icon/buttons/copy
> SHOW DATABASES;

If the database's name is already in use, either drop the existing database:

icon/buttons/copy
> DROP DATABASE example_database;

Or change the existing database's name:

icon/buttons/copy
> ALTER DATABASE example_database RENAME TO archived_example_database;

Resolve a table naming conflict

The table you want to restore cannot have the same name as an existing table in the target database. Before you restore a table, verify that the table name is not already in use. To do this, connect to the target cluster with the CockroachDB SQL client and run the following:

icon/buttons/copy
> SHOW TABLES FROM database_name;

If the table's name is already in use, either drop the existing table:

icon/buttons/copy
> DROP TABLE target_database.example_table;

Or change the existing table's name:

icon/buttons/copy
> ALTER TABLE target_database.example_table RENAME TO target_database.archived_example_table;

Restore a cluster

Find the cluster backup you want to restore, and click Restore.

Performing a restore will cause your cluster to be unavailable for the duration of the restore. All current data is deleted, and the cluster will be restored to the state it was in at the time of the backup. There are no automatic incremental backups, and no automatic database or table level backups.

You can manage your own backups, including incremental, database, and table level backups. To perform manual backups, you must configure either a userfile location or a cloud storage location, which requires billing information for your organization even if you don't set a spend limit.

YesYes NoNo