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>
  • Copy
  • Fill window

Arguments

  • backup-dir: Directory to store backup files in

Flags

Flag Description
-db Database to backup
-end End date for backup (RFC3339 timestamp)
-estimate Estimate the size of the requested backup
-from Data node TCP address to prefer when backing up
-full Perform an full backup (deprecated in favour of -strategy full)
-rp Retention policy to backup
-shard Shard ID to backup
-start Start date for backup (RFC3339 timestamp)
-strategy Backup strategy to use (only-meta, full, or incremental)

Examples

Perform an incremental backup

influxd-ctl backup /path/to/backup-dir
  • Copy
  • Fill window

Perform a full backup

influxd-ctl backup -full /path/to/backup-dir
  • Copy
  • Fill window

Estimate the size of a backup

influxd-ctl backup -estimate
  • Copy
  • Fill window

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
  • Copy
  • Fill window

Backup a specific shard

influxd-ctl backup -shard 00 /path/to/backup-dir
  • Copy
  • Fill window

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 3 Open Source Now in Public Alpha

InfluxDB 3 Open Source is now available for alpha testing, licensed under MIT or Apache 2 licensing.

We are releasing two products as part of the alpha.

InfluxDB 3 Core, is our new open source product. It is a recent-data engine for time series and event data. InfluxDB 3 Enterprise is a commercial version that builds on Core’s foundation, adding historical query capability, read replicas, high availability, scalability, and fine-grained security.

For more information on how to get started, check out: