Update a bucket
Use the influx
command line interface (CLI) or the InfluxDB user interface (UI) to update a bucket.
Note that updating an bucket’s name will affect any assets that reference the bucket by name, including the following:
- Queries
- Dashboards
- Tasks
- Telegraf configurations
- Templates
If you change a bucket name, be sure to update the bucket in the above places as well.
Update a bucket’s name in the InfluxDB UI
In the navigation menu on the left, select Data (Load Data) > Buckets.
Click Settings under the bucket you want to rename.
Click Rename.
Review the information in the window that appears and click I understand, let’s rename my bucket.
Update the bucket’s name and click Change Bucket Name.
For information about permitted bucket names, see bucket naming restrictions.
Update a bucket’s retention period in the InfluxDB UI
In the navigation menu on the left, select Data (Load Data) > Buckets.
Click Settings next to the bucket you want to update.
In the window that appears, edit the bucket’s retention period.
Click Save Changes.
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
) - The name or ID of the organization the bucket belongs to.
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
For information about permitted bucket names, see bucket naming restrictions.
# 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
)
The minimum retention period is one hour.
# Syntax
influx bucket update -i <bucket-id> -r <retention period with units>
# Example
influx bucket update -i 034ad714fdd6f000 -r 1209600000000000ns
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.