influxd-ctl restore
The influxd-ctl restore command restores data backed up from an InfluxDB
Enterprise cluster.
influxd-ctl restore supports full, incremental, and metadata-only backups.
To restore from a full backup, include the -full flag and provide the path to
the backup manifest (/path/to/backups/backup.manifest).
To restore from an incremental or metadata backup, provide the path to
the directory that contains the backup files (/path/to/backups).
Destination database must be empty
The database data is restored to must be empty.
influxd-ctl restore will fail if the destination database contains data.
Usage
influxd-ctl restore [flags] <backup-location>
Arguments
backup-location: Location of backup-related files. They type of backup you’re restoring from determines the type and location of backup files:
- Restore from a full backup: Provide the path to the backup manifest file
- Restore from an incremental backup: Provide the directory path of the backup
- Restore from a metadata-only backup: Provide the directory path of the backup
Flags
| Flag | Description |
|---|---|
-db | Database to restore (if the backup contains more than one) |
-full | Restore data from a full backup |
-list | List the contents of the backup |
-meta-only-overwrite-force | Restore only metadata from a backup Danger: see below |
-newdb | Change database name when restoring (requires -db flag) |
-newduration | Change retention policy duration (shard expiry) when restoring (requires -rp flag, use 0s for infinite) |
-newrf | New replication factor to use during restore (limited by cluster size) |
-newrp | Change retention policy name when restoring (requires -rp flag) |
-newshard | Shard ID to restore into (if different from the shard ID in the backup) |
-rp | Retention policy to restore (if the backup contains more than one) |
-shard | Shard ID to restore |
Also see influxd-ctl global flags.
Only use the -meta-only-overwrite-force flag to restore from backups of the
destination cluster. Metadata includes shard assignments to data nodes, so if
you use this flag with metadata from a different cluster, you will lose data.
See Back up and restore for instructions on using this flag.
Examples
Restore from a full backup
influxd-ctl restore -full /path/to/full-backup/20230101T00000Z.manifest
Restore from an incremental backup
In this example, the restore command restores an incremental backup stored in the my-incremental-backup/ directory.
influxd-ctl restore /path/to/incremental-backup/
Restore from a metadata backup
In this example, the restore command restores an metadata backup stored
in the metadata-backup/ directory.
influxd-ctl restore /path/to/metadata-backup/
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB Enterprise and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.