3.4 KiB
3.4 KiB
The influxdb3 update database command updates an existing database in your {{< product-name >}} instance.
Use this command to update a database's retention period.
Usage
influxdb3 update database [OPTIONS] --database <DATABASE_NAME>
Arguments
DATABASE_NAME: (Required) The name of the database to update.
You can also set the database name using the INFLUXDB3_DATABASE_NAME environment variable.
Options
| Option | Description | |
|---|---|---|
-H |
--host |
Host URL of the running {{< product-name >}} server (default is http://127.0.0.1:8181) |
-d |
--database |
The name of the database to update |
--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 database.
In your commands replace the following:
- {{% code-placeholder-key %}}
DATABASE_NAME{{% /code-placeholder-key %}}: Database name - {{% code-placeholder-key %}}
AUTH_TOKEN{{% /code-placeholder-key %}}: Authentication token
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}
Update a database retention period
Updates a database retention period to 30 days.
influxdb3 update database --retention-period 30d DATABASE_NAME
Clear a database retention period
Removes the retention period from a database by setting it to none.
influxdb3 update database --retention-period none DATABASE_NAME
Update a database with authentication
Updates a database using an authentication token.
influxdb3 update database --token AUTH_TOKEN --retention-period 7d DATABASE_NAME
{{% /code-placeholders %}}