Skip to main content

Restore

Restore a tenant from a dump file

Examples

Basic usage:

octo-cli -c Restore `
-tid "mytenant" `
-db "mytenant_db" `
-f "./backup.tar.gz" `
-w

Restore CrateDB archive data from an '*.octobak.zip' backup:

octo-cli -c Restore `
-tid "mytenant" `
-db "mytenant_db" `
-f "./backup.octobak.zip" `
-rad `
-w

Options

ShortLongRequiredDescription
-tid--tenantIdyesId of tenant
-db--databaseyesName of database
-f--fileyesFile of backup (*.tar.gz)
-oldDb--oldDatabaseNamenoName of the old database (if different to new database name)
-rad--restore-archive-datanoRestore CrateDB archive data contained in an '.octobak.zip' backup (no-op on a plain '.tar.gz')
-w--waitnoWait for a import job to complete

Notes

--restore-archive-data restores archives to their backed-up state; it is a no-op on a plain '*.tar.gz' backup.

The target tenant's archive schemas must match those in the backup; mismatched archives are skipped and reported.