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
| 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) |
Also see influxd-ctl global flags.
Examples
- Perform an incremental backup
- Perform a full backup
- Estimate the size of a backup
- Backup data from a specific time range
- Backup a specific shard
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!
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.