Outdated Version
You are viewing an older version of this section. View current production version.
create-backup
Back up one or more databases to a repository.
Usage
Back up one or more databases to a repository. This command runs BACKUP DATABASE on the Master Aggregator with automatically configured options based on the specified backup repository.
All of the memsql-admin backup commands take the '--repository' flag which is a concise pointer to a location storing all of the backups. The format used in this flag is based on the URL spec and has the following components:
{protocol}://{path}[?{options}]
The protocol determines which options are supported and how the path is interpreted.
Supported protocols are: file, s3, and azure.
Examples:
memsql-admin create-backup --repository "s3://foo/bar?region=eu-central-1" database_1 database_2
memsql-admin create-backup database_1 -r azure://foo/bar database_2
memsql-admin create-backup -r file:///nfs db1
memsql-admin create-backup -r "s3://foo/bar?region=eu-central-1" database_1
Usage:
memsql-admin create-backup DATABASE_NAME... [flags]
Flags:
-h, --help Help for create-backup
--include GLOB Backup all databases matching GLOB (e.g. *, foo*, *bar)
-r, --repository STRING Path to the repository location. Must be specified in URL format, see https://docs.memsql.com/toolbox-redir/memsql-backup-repository for examples
--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 Toolbox configuration file path
--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-max-sessions POSITIVE_INTEGER Maximum number of SSH sessions to open per host, must be at least 3
--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 the --yes
or --json
flags to override interactive behavior.