Documentation

influx bucket update

The influx bucket update command updates information associated with buckets in InfluxDB.

Usage

influx bucket update [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c--active-configCLI configuration to use for commandstring
--configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-d--descriptionBucket descriptionstring
-h--helpHelp for the update command
--hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
--hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
--http-debugInspect communication with InfluxDB servers.string
-i--id(Required) Bucket IDstring
--jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
-n--nameNew bucket namestringINFLUX_BUCKET_NAME
-r--retentionNew duration bucket will retain data. For detail, see Retention periods.duration
--shard-group-durationCustom shard group duration for the bucket (OSS only)string
--skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t--tokenAPI tokenstringINFLUX_TOKEN

Retention periods

The minimum retention period is one hour. Valid --retention units:

  • nanoseconds (ns)
  • microseconds (us or µ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, --org or --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!


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:

InfluxDB Cloud powered by TSM