ContextQMD
Back to Influxdb

Syntax

content/shared/influxdb3-cli/show/retention.md

latest4.1 KB
Original Source

The influxdb3 show retention command displays effective retention periods for tables in your {{< product-name >}} server.

Usage

<!--pytest.mark.skip-->
bash
# Syntax
influxdb3 show retention [OPTIONS]

Options

OptionDescription
-H--hostHost URL of the running {{< product-name >}} server (default is http://127.0.0.1:8181)
--token({{< req >}}) Authentication token
--databaseFilter retention information by database name
--formatOutput format (pretty (default), json, jsonl, csv, or parquet)
--tls-caPath to a custom TLS certificate authority (for testing or self-signed certificates)
--tls-no-verifyDisable TLS certificate verification (Not recommended in production, useful for self-signed certificates)
-h--helpPrint help information
--help-allPrint detailed help information

Option environment variables

You can use the following environment variables to set command options:

Environment VariableOption
INFLUXDB3_HOST_URL--host
INFLUXDB3_DATABASE_NAME--database
INFLUXDB3_AUTH_TOKEN--token
INFLUXDB3_TLS_NO_VERIFY--tls-no-verify

Examples

In the examples below, replace {{% code-placeholder-key %}}AUTH_TOKEN{{% /code-placeholder-key %}} with your authentication token.

Show retention for all tables

<!--pytest.mark.skip-->
bash
influxdb3 show retention \
  --host http://localhost:8181 \
  --token AUTH_TOKEN

Show retention for a specific database

<!--pytest.mark.skip-->
bash
influxdb3 show retention \
  --host http://localhost:8181 \
  --token AUTH_TOKEN \
  --database mydb

Show retention in JSON format

<!--pytest.mark.skip-->
bash
influxdb3 show retention \
  --host http://localhost:8181 \
  --token AUTH_TOKEN \
  --format json

Export retention data to Parquet format

Parquet is a binary format. When using the parquet format, data is written to standard output by default. Use output redirection or the --output option to save the data to a file.

<!--pytest.mark.skip-->
bash
influxdb3 show retention \
  --host http://localhost:8181 \
  --token AUTH_TOKEN \
  --format parquet \
  --output retention-data.parquet

Output

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, or infinite)

Example output

Database | Table       | Retention | Source
---------|-------------|-----------|----------
mydb     | cpu         | 7d        | database
mydb     | mem         | 24h       | table
mydb     | disk        | infinite  | infinite

Tables 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.