influxdb3 show retention
The influxdb3 show retention command displays effective retention periods for tables in your InfluxDB 3 Enterprise server.
Usage
influxdb3 show retention [OPTIONS]Options
| Option | Description | |
|---|---|---|
-H | --host | Host URL of the running InfluxDB 3 Enterprise server (default is http://127.0.0.1:8181) |
--token | (Required) Authentication token | |
--database | Filter retention information by database name | |
--format | Output format (pretty (default), json, jsonl, csv, or parquet) | |
--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 to set command options:
| Environment Variable | Option |
|---|---|
INFLUXDB3_HOST_URL | --host |
INFLUXDB3_DATABASE_NAME | --database |
INFLUXDB3_AUTH_TOKEN | --token |
Examples
Show retention for all tables
influxdb3 show retention \
--host http://localhost:8181 \
--token YOUR_AUTH_TOKENShow retention for a specific database
influxdb3 show retention \
--host http://localhost:8181 \
--token YOUR_AUTH_TOKEN \
--database mydbShow retention in JSON format
influxdb3 show retention \
--host http://localhost:8181 \
--token YOUR_AUTH_TOKEN \
--format jsonOutput
The command displays the following information for each table:
- Database: The database name
- Table: The table name
- Retention: The effective retention period in human-readable format (for example, “7d” for 7 days, “24h” for 24 hours, “infinite” for no retention)
- Source: Where the retention is defined (
table,database, orinfinite)
Example output
Database | Table | Retention | Source
---------|-------------|-----------|----------
mydb | cpu | 7d | database
mydb | mem | 24h | table
mydb | disk | infinite | infiniteTables with table-level retention policies override the database-level retention. Tables without explicit retention policies inherit the database retention or have infinite retention if none is set.
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.