Documentation

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

FlagDescription
-dbDatabase to restore (if the backup contains more than one)
-fullRestore data from a full backup
-listList the contents of the backup
-meta-only-overwrite-forceRestore only metadata from a backup Danger: see below
-newdbChange database name when restoring (requires -db flag)
-newdurationChange retention policy duration (shard expiry) when restoring (requires -rp flag, use 0s for infinite)
-newrfNew replication factor to use during restore (limited by cluster size)
-newrpChange retention policy name when restoring (requires -rp flag)
-newshardShard ID to restore into (if different from the shard ID in the backup)
-rpRetention policy to restore (if the backup contains more than one)
-shardShard ID to restore

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

View example output

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/

View example output

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/

View example output


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: