influxdb3 update table
The influxdb3 update table command updates an existing table in a database in your InfluxDB 3 Enterprise instance.
Use this command to update a table’s retention period.
Usage
influxdb3 update table [OPTIONS] --database <DATABASE_NAME> <TABLE_NAME>
Arguments
TABLE_NAME: (Required) The name of the table to update
Options
| Option | Description | |
|---|---|---|
-H | --host | Host URL of the running InfluxDB 3 Enterprise server (default is http://127.0.0.1:8181) |
-d | --database | The name of the database containing the table |
--token | Authentication token | |
-r | --retention-period | The retention period as a duration value (for example: 30d, 24h) or none to clear |
--tls-ca | Path to a custom TLS certificate authority (for testing or self-signed certificates) | |
-h | --help | Print help information |
--help-all | Print detailed help information |
Option environment variables
You can use the following environment variables instead of providing CLI options directly:
| Environment Variable | Option |
|---|---|
INFLUXDB3_HOST_URL | --host |
INFLUXDB3_DATABASE_NAME | --database |
INFLUXDB3_AUTH_TOKEN | --token |
INFLUXDB3_TLS_CA | --tls-ca |
Examples
The following examples show how to update a table.
In your commands replace the following:
DATABASE_NAME: Database nameTABLE_NAME: Table nameAUTH_TOKEN: Authentication token
Update a table retention period
Updates a table retention period to 30 days.
influxdb3 update table --database DATABASE_NAME --token AUTH_TOKEN --retention-period 30d TABLE_NAME
Clear a table retention period
Removes the retention period from a table by setting it to none.
influxdb3 update table --database DATABASE_NAME --retention-period none TABLE_NAME
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 3 Enterprise and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support. Customers using a trial license can email trial@influxdata.com for assistance.