restore-backup

Description

Restore one or more full and split backups to the cluster.

This command runs RESTORE DATABASEon the Master Aggregator.

Examples

sdb-admin restore-backup --repository "s3://foo/bar?region=eu-central-1" backup1 backup2
sdb-admin restore-backup -r azure://foo/bar $(sdb-admin list-backups -r azure://foo/bar -q)
sdb-admin restore-backup backup1 -r azure://foo/bar

Restore a specific version of incremental backup, for example, 'backup1' with an incremental ID '1'

sdb-admin restore-backup -r file://foo/bar backup1 --incr-backup-id 1

Restore a latest available in cache version of incremental backup, for example, 'backup1'

sdb-admin restore-backup -r file://foo/bar backup1

Usage

Usage:
sdb-admin restore-backup [flags]
For flags that can accept multiple values (indicated by VALUES after the name of the flag),
separate each value with a comma.
Flags:
--database-prefix string Add the specified prefix to each database name created during restoration
--database-suffix string Add the specified suffix to each database name created during restoration
--full-checksum Perform a full CRC32C check on each backup before restoring
-h, --help Help for restore-backup
--incr-backup-id string Restore a specific version of incremental backup
--no-region Do not use region-specific endpoints for S3-compatible repositories
--rename-to string Rename a database while it is restored. The flag is only applicable when restoring a single backup
-r, --repository STRING Path to the repository in the URL format. See https://docs.singlestore.com/toolbox-redir/memsql-backup-repository for examples
--skip-validation Skip backup validation before restoring
--timeout duration The maximum wait time for restoring a backup (e.g., 30s, 10m, 1.5h); defaults to 24 hours (default 24h0m0s)
Global Flags:
--backup-cache FILE_PATH File path for the backup cache
--cache-file FILE_PATH File path for the Toolbox node cache
-c, --config FILE_PATH File path for the Toolbox configuration
--disable-colors Disable color output in console, which some terminal sessions/environments may have difficulty with
--disable-spinner Disable the progress spinner, which some terminal sessions/environments may have issues with
-j, --json Enable JSON output
--parallelism POSITIVE_INTEGER Maximum number of operations to run in parallel
--runtime-dir DIRECTORY_PATH Where to store Toolbox runtime data
--ssh-control-persist SECONDS Enable SSH ControlPersist and set it to the specified duration in seconds
--ssh-max-sessions POSITIVE_INTEGER Maximum number of SSH sessions to open per host, must be at least 3
--ssh-strict-host-key-checking Enable strict host key checking for SSH connections
--ssh-user-known-hosts-file FILE_PATH Path to the user known_hosts file for SSH connections. If not set, /dev/null will be used
--state-file FILE_PATH Toolbox state file path
-v, --verbosity count Increase logging verbosity: valid values are 1, 2, 3. Usage -v=count or --verbosity=count
-y, --yes Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default

Remarks

This command is interactive unless you use either --yes or --json flag to override interactive behavior.

Last modified: October 6, 2023

Was this article helpful?