ContextQMD
Back to Influxdb

Update

content/shared/influxdb-v2/reference/cli/influx/bucket/update.md

latest3.4 KB
Original Source

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

Usage

influx bucket update [flags]

Flags

FlagDescriptionInput type{{< cli/mapped >}}
-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({{< req >}}) 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

{{% note %}}

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. {{% /note %}}

Examples

{{< cli/influx-creds-note >}}

Update the name of a bucket
sh
influx bucket update \
  --id 06c86c40a9f36000 \
  --name new-bucket-name
Update the retention period of a bucket
sh
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.

sh
influx bucket update \
  --id 06c86c40a9f36000 \
  --shard-group-duration 2d