influx bucket update
This page documents an earlier version of InfluxDB OSS. InfluxDB 3 Core is the latest stable version.
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. For detail, see Retention periods. | 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 |
Retention periods
The minimum retention period is one hour. Valid --retention units:
- nanoseconds (
ns) - microseconds (
usorµs) - milliseconds (
ms) - seconds (
s) - minutes (
m) - hours (
h) - days (
d) - weeks (
w)
For an infinite retention period, set the number to 0. For example, 0s.
Examples
Authentication credentials
The examples below assume your InfluxDB host, organization, and token are
provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST, INFLUX_ORG, and INFLUX_TOKEN).
If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:
--host: InfluxDB host-o, --orgor--org-id: InfluxDB organization name or ID-t, --token: InfluxDB API token
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:
Customers with an annual or support contract can contact InfluxData Support. Customers using a trial license can email trial@influxdata.com for assistance.