Documentation

influxd-ctl backup

The influxd-ctl backup command backs up an InfluxDB Enterprise cluster’s metastore and shard data at that point in time and stores the copy in the specified directory.

To back up only the cluster metastore, use the -strategy only-meta flag. Backups are incremental by default, meaning they create a copy of the metastore and shard data that have changed since the previous incremental backup. If there are no existing incremental backups, the system automatically performs a complete backup.

Backup strategies

InfluxDB Enterprise supports the following backup strategies:

  • only-meta: Back up metastore data only, including users, roles, databases, continuous queries, and retention policies. This strategy does not back up shards.
  • full: Back up metastore and all shard data.
  • incremental: (Default) Back up metastore and shard data that has changed since the last incremental backup. If there are no existing incremental backups, the system automatically performs a full backup.

Usage

influxd-ctl backup [flags] <backup-dir>

Arguments

  • backup-dir: Directory to store backup files in

Flags

FlagDescription
-dbDatabase to backup
-endEnd date for backup (RFC3339 timestamp)
-estimateEstimate the size of the requested backup
-fromData node TCP address to prefer when backing up
-fullPerform an full backup (deprecated in favour of -strategy full)
-rpRetention policy to backup
-shardShard ID to backup
-startStart date for backup (RFC3339 timestamp)
-strategyBackup strategy to use (only-meta, full, or incremental)

Examples

Perform an incremental backup

influxd-ctl backup /path/to/backup-dir

Perform a full backup

influxd-ctl backup -full /path/to/backup-dir

Estimate the size of a backup

influxd-ctl backup -estimate

Backup data from a specific time range

influxd-ctl backup \
  -start 2023-01-01T00:00:00Z \
  -end 2023-06-01T00:00:00Z \
  /path/to/backup-dir

Backup a specific shard

influxd-ctl backup -shard 00 /path/to/backup-dir

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: