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

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

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.

Read more

InfluxDB v3 enhancements and InfluxDB Clustered is now generally available

New capabilities, including faster query performance and management tooling advance the InfluxDB v3 product line. InfluxDB Clustered is now generally available.

InfluxDB v3 performance and features

The InfluxDB v3 product line has seen significant enhancements in query performance and has made new management tooling available. These enhancements include an operational dashboard to monitor the health of your InfluxDB cluster, single sign-on (SSO) support in InfluxDB Cloud Dedicated, and new management APIs for tokens and databases.

Learn about the new v3 enhancements


InfluxDB Clustered general availability

InfluxDB Clustered is now generally available and gives you the power of InfluxDB v3 in your self-managed stack.

Talk to us about InfluxDB Clustered