Outdated Version

You are viewing an older version of this section. View current production version.

list-backups

Info

SingleStore Managed Service does not support this command.

List backups.

Usage

List full, split and incremental backups
The output is human readable, with JSON and quiet as an alternative format
By default, this command will list all the latest full backups per database.
By default, we use the information available in the cache. To change this behavior use --no-cache flag.

Examples:

sdb-admin list-backups --repository "s3://foo/bar?region=eu-central-1"

sdb-admin list-backups -r azure://foo/bar --no-cache

sdb-admin list-backups -r "s3://foo/bar?region=eu-central-1" --database database_1 --database database_2

Usage:
  sdb-admin list-backups [flags]

Flags:
      --after TIME            Select backups created after the specified TIME. TIME should be in the ISO 8601 format or a duration relative to the current time ('2006-01-02T15:04:05-0700', '2006-01-02', '-3h30m'). Time zone is optional but recommended. If TIME is specified without the time zone, a local time zone will be used
      --all                   Select all backups, not compatible with other selection flags
      --backup-name VALUES    Select backup by a name. Can be provided multiple times
      --before TIME           Select backups created before the specified TIME. TIME should be in the ISO 8601 format or a duration relative to the current time ('2006-01-02T15:04:05-0700', '2006-01-02', '-3h30m'). Time zone is optional but recommended. If TIME is specified without the time zone, a local time zone will be used
      --cluster-id VALUES     Select backups with the specified cluster id. This flag can be provided multiple times
      --cluster-name VALUES   Select backups with the specified cluster name. This flag can be provided multiple times
      --database VALUES       Select backups for the specified database(s). This flag can be provided multiple times
  -h, --help                  Help for list-backups
  -l, --latest                Select only the latest backups for each <cluster id>, <database name>
      --no-cache              Forces reads directly from the repositories, bypassing the cache. The cache will be updated
  -q, --quiet                 Only display backup names
  -r, --repository STRING     Path to the repository in the URL format. See https://docs.singlestore.com/toolbox-redir/memsql-backup-repository for examples

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 the --yes or --json flags to override interactive behavior.