Skip to content

Source Requirements

Database instance
  1. List down the CockroachDB Backup’s Subdirectory Absolute Path where the backups are available. To view a list of the available full backups subdirectories, use the following command:

    SHOW BACKUPS IN 's3://{bucket name}/{path}?AWS_ACCESS_KEY_ID={placeholder}&AWS_SECRET_ACCESS_KEY={placeholder}';
    
    Note: The CockroachDB Backup’s subdirectory path format is a date-based naming scheme (i.e. <year>/<month>/<day>-<timestamp>).

  2. Ensure to record and identify the following information before restoring the backups on staging database.

    • Storage bucket name (AWS S3) including absolute path where CockroachDB backups are located in AWS S3.
    • The account access name or key associated with object storage holding CockroachDB backups.
      • AWS_ACCESS_KEY_ID in case of backups are located in AWS S3.
    • The account secret access key associated with account name field. This is essentially the password that gives access to CockroachDB backups.
      • AWS_SECRET_ACCESS_KEY in case of backups are located in AWS S3.
    • The above information can be captured from the Backup command used to backup CockroachDB full cluster on AWS S3 storage.
      BACKUP INTO 's3://{BUCKET NAME}?AWS_ACCESS_KEY_ID={KEY ID}&AWS_SECRET_ACCESS_KEY={SECRET ACCESS KEY}' AS OF SYSTEM TIME '-10s';