Using Storage Repositories with Backups
On this page
For those Toolbox commands that support backup operations, the
--repository option can be used to specify the data storage location where Toolbox reads data from and writes data to.
sdb-admin create-backup command can write a database backup to the specified repository, whereas the
sdb-admin list-backups command can read data from the specified repository to display the list of available backups.
SingleStore supports Amazon S3, Azure Blob Storage, Google Cloud Storage" (GCS) and Network File System (NFS) for backup storage options.
--repository option can specify a location in an S3 bucket, Azure container, GCS or NFS mount.
sdb-report calibrate-blob-storage command also supports the
--repository option, using Amazon S3-compatible blob storage exclusively.
--repository option takes the following components as input:
protocoldetermines how the path to the storage location is interpreted, and which options are supported.
Backup commands support
fileprotocols for Amazon S3, Azure Blob Storage, GCS and NFS, respectively.
sdb-report calibrate-blob-storagecommand only supports
pathdefines the path to the storage location and restricts the scope to access specific resources within the specified storage.
For example, when a backup command is run against
s3://bucket-name/path/inside/bucket?region=us-east-1, only the backup files located under
bucket-nameS3 bucket will be accessed.
In this example, the
s3://bucket-name/path/insiderepository is different from, let’s say,
s3://bucket-name/path/inside/bucket, which is another repository in the same S3 bucket.
optionsspecify additional configuration settings.
For example, when using S3 for storage, you may specify all of the options in the BACKUP DATABASE command, including region, endpoint URL, and
Note that the
--repository option takes values in a URL format that corresponds to the storage protocol used.
--repository value for different storage options:
Azure Blob Storage:
Last modified: July 6, 2022