Skip to main content

Dump

Dumps a tenant to a file

Examples

Basic usage:

octo-cli -c Dump -tid "mytenant" -f "./backup.tar.gz"

Include CrateDB archive data (produces a larger '*.octobak.zip' artifact):

octo-cli -c Dump `
-tid "mytenant" `
-f "./backup.octobak.zip" `
-iad

Options

ShortLongRequiredDescription
-tid--tenantIdyesId of tenant
-f--fileyesFile of backup (*.tar.gz)
-iad--include-archive-datanoInclude CrateDB archive data in the dump. The produced backup is a larger '*.octobak.zip' artifact

Notes

Without --include-archive-data the backup is a plain '*.tar.gz' (MongoDB data only).

With --include-archive-data the produced artifact is a larger '*.octobak.zip' that also carries the CrateDB archive rows; pick a matching file name with -f.