create-backup
Warning
SingleStore 9.0 gives you the opportunity to preview, evaluate, and provide feedback on new and upcoming features prior to their general availability. In the interim, SingleStore 8.9 is recommended for production workloads, which can later be upgraded to SingleStore 9.0.
On this page
Description
Create full or split partitions backup for one or more databases to a specified repository.
This command runs BACKUP DATABASE on the Master Aggregator with automatically configured options based on the specified backup repository.
All of the sdb-admin backup
-related commands take the --repository
option which is a concise pointer to a location storing all of the backups.
{protocol}://{path}[?{options}]
The protocol determines which options are supported and how the path is interpreted.file
, s3
, and azure
.
Split backup can be created only if all nodes in the cluster run SingleStore 7.
Warning
On account of how logs are now captured in SingleStore versions 8.
-
Downgrading from SingleStore versions 8.
9. 19 and later to SingleStore versions 8. 9. 18 and earlier -
Restoring backups from SingleStore versions 8.
9. 19 and later to SingleStore versions 8. 9. 18 and earlier
Examples
sdb-admin create-backup --repository "s3://foo/bar?region=eu-central-1" database_1 database_2
sdb-admin create-backup database_1 -r azure://foo/bar database_2
sdb-admin create-backup -r file:///nfs db1
sdb-admin create-backup -r "s3://foo/bar?region=eu-central-1" database_1
sdb-admin create-backup -r "s3://foo/bar?region=eu-central-1" database_1 --miltipart-chunk-size-mb 500
sdb-admin create-backup -r "s3://foo/bar?region=eu-central-1" database_1 --backup-type split
Create initial incremental backup database_
:
sdb-admin create-backup -r "s3://foo/bar?region=eu-central-1" database_1 --backup-type init --backup-suffix week_1
Create differential backup database_
:
sdb-admin create-backup -r "s3://foo/bar?region=eu-central-1" database_1 --backup-type differential --backup-suffix week_1
Create a backup with tags:
sdb-admin create-backup database_1 -r file:///tmp/foo.backup --tags production,no-prune
Usage
Usage:
sdb-admin create-backup DATABASE_NAME... [flags]
For flags that can accept multiple values (indicated by VALUES after the name of the flag),
separate each value with a comma.
Flags:
--backup-suffix string Suffix of incremental backup names. The suffix identifies each logical incremental backup and should be the same for the initial and the differential versions of an incremental backup
--backup-type {full, split, init, differential} Type of the backup (default full)
-h, --help Help for create-backup
--include GLOB Backup all databases matching GLOB (e.g. "*", "foo*", "*bar")
--multipart-chunk-size-mb uint Multipart chunk size in MB. This option is only applicable for S3-compatible repositories
--no-region Do not use region-specific endpoints for S3-compatible repositories
-r, --repository STRING Path to the repository in the URL format. See https://docs.singlestore.com/toolbox-redir/memsql-backup-repository for examples
--tags strings Comma-separated list of tags to add to the backup
--timeout duration Maximum time to wait for backup to be created (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: May 21, 2025