4.5 KiB
title | seotitle | description | menu | weight | aliases | alt_links | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update a bucket | Update a bucket in InfluxDB | Update a bucket's name or retention period in InfluxDB using the InfluxDB UI or the influx CLI. |
|
202 |
|
|
Use the InfluxDB user interface (UI), the influx
command line interface (CLI),
or the InfluxDB HTTP API to update a bucket.
{{% note %}} If you change a bucket name, be sure to update the bucket connection credential in clients that connect to your bucket. {{% /note %}}
Update a bucket's name in the InfluxDB UI
-
In the navigation menu on the left, select Load Data > Buckets.
{{< nav-icon "data" >}}
-
Click {{< caps >}}Settings{{< /caps >}} to the right of the bucket you want to rename.
-
Click {{< caps >}}Rename{{< /caps >}}.
-
Review the information in the window that appears and click {{< caps >}}I understand, let's rename my bucket{{< /caps >}}.
-
Update the bucket's name and click Change Bucket Name.
Update a bucket's retention period in the InfluxDB UI
-
In the navigation menu on the left, select Load Data > Buckets.
{{< nav-icon "data" >}}
-
Click {{< caps >}}Settings{{< /caps >}} next to the bucket you want to update.
-
In the window that appears, under Delete data, select a retention period:
- {{< caps >}}Never{{< /caps >}}: data in the bucket is retained indefinitely.
- {{< caps >}}Older Than{{< /caps >}}: select a predefined retention period from the dropdown menu.
{{% note %}} Use the
influx bucket update
command or the InfluxDB HTTP APIPATCH /api/v2/buckets
endpoint to set a custom retention period. {{% /note %}} -
Click {{< caps >}}Save Changes{{< /caps >}}.
Update a bucket using the influx CLI
Use the influx bucket update
command
to update a bucket.
Updating a bucket requires the following:
- The bucket ID (provided in the output of
influx bucket list
)
{{< cli/influx-creds-note >}}
Update the name of a bucket
# Syntax
influx bucket update -i <bucket-id> -n <new-bucket-name>
# Example
influx bucket update -i 034ad714fdd6f000 -n my-new-bucket
Update a bucket's retention period
Valid retention period duration units:
- nanoseconds (
ns
) - microseconds (
us
orµs
) - milliseconds (
ms
) - seconds (
s
) - minutes (
m
) - hours (
h
) - days (
d
) - weeks (
w
)
{{% note %}} The minimum retention period is one hour. {{% /note %}}
# Syntax
influx bucket update -i <bucket-id> -r <retention period with units>
# Example
influx bucket update -i 034ad714fdd6f000 -r 1209600000000000ns
Update a bucket using the HTTP API
Use the InfluxDB HTTP API PATCH /api/v2/buckets
endpoint
to update a bucket.
Updating a bucket requires the following:
- The bucket ID (provided in the output of the
GET /api/v2/buckets/
endpoint)
You can update the following bucket properties:
- name
- description
- retention rules
-
To find the bucket ID, send a request to the HTTP API
GET /api/v2/buckets/
endpoint to retrieve the list of buckets.{{< api-endpoint method="get" endpoint="https://{{< influxdb/host >}}/api/v2/buckets" api-ref="/influxdb3/cloud-serverless/api/#operation/GetBuckets" >}}
-
Send a request to the HTTP API PATCH
/api/v2/buckets/{BUCKET_ID}
endpoint.In the URL path, specify the ID of the bucket from the previous step that you want to update. In the request body, set the properties that you want to update--for example:
{{< api-endpoint method="patch" endpoint="https://{{< influxdb/host >}}/api/v2/buckets/{BUCKET_ID}" api-ref="/influxdb3/cloud-serverless/api/#operation/PatchBucketsID" >}}
{ "name": "air_sensor", "description": "bucket holding air sensor data", "retentionRules": [ { "type": "expire", "everySeconds": 2592000 } ] }