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
-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 dataduration
--shard-group-durationCustom shard group duration for the bucket (OSS only)string
--skip-verifySkip TLS certificate verification
-t--tokenAuthentication tokenstringINFLUX_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

Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.