influx bucket update
This page documents an earlier version of InfluxDB. InfluxDB v2.3 is the latest stable version. View this page in the v2.3 documentation.
The influx bucket update command updates information associated with buckets in InfluxDB.
Usage
influx bucket update [flags]
Flags
| Flag | Description | Input type | Maps to ? | |
|---|---|---|---|---|
-c | --active-config | CLI configuration to use for command | string | |
--configs-path | Path to influx CLI configurations (default ~/.influxdbv2/configs) | string | INFLUX_CONFIGS_PATH | |
-d | --description | Bucket description | string | |
-h | --help | Help for the update command | ||
--hide-headers | Hide table headers (default false) | INFLUX_HIDE_HEADERS | ||
--host | HTTP address of InfluxDB (default http://localhost:8086) | string | INFLUX_HOST | |
--http-debug | Inspect communication with InfluxDB servers. | string | ||
-i | --id | (Required) Bucket ID | string | |
--json | Output data as JSON (default false) | INFLUX_OUTPUT_JSON | ||
-n | --name | New bucket name | string | INFLUX_BUCKET_NAME |
-r | --retention | New duration bucket will retain data | duration | |
--shard-group-duration | Custom shard group duration for the bucket (OSS only) | string | ||
--skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-t | --token | API token | string | INFLUX_TOKEN |
Valid --retention units are nanoseconds (ns), microseconds (us or µs),
milliseconds (ms), seconds (s), minutes (m), hours (h), days (d), and weeks (w).
Examples
Authentication credentials
The examples below assume your InfluxDB host, organization, and token are
provided by the active influx CLI configuration.
If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.
Update the name of a bucket
influx bucket update \
--id 06c86c40a9f36000 \
--name new-bucket-name
Update the retention period of a bucket
influx bucket update \
--id 06c86c40a9f36000 \
--retention 90d
Update the shard group duration of a bucket
Custom shard group durations are only supported in InfluxDB OSS. The shard group duration must be shorter than the buckets retention period.
influx bucket update \
--id 06c86c40a9f36000 \
--shard-group-duration 2d
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 and this documentation. To find support, use the following resources:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.