ContextQMD
Back to Influxdb

Show

content/shared/influxdb3-admin/distinct-value-cache/show.md

latest3.6 KB
Original Source

Use the influxdb3 show system table command to query and output Distinct Value Cache information from the distinct_caches system table.

{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}

<!-- pytest.mark.skip -->
bash
influxdb3 show system \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  table distinct_caches

{{% /code-placeholders %}}

This returns a table similar to the following:

tablenamecolumn_idscolumn_namesmax_cardinalitymax_age_seconds
wind_datawind_distinct[0, 1, 2][country, county, city]10000086400
weatherweather_distinct[0][location]100604800
bitcoinbitcoin_dis[0, 1][code, crypto]500086400
homehome_distinct[0, 1][room, wall]1200015770000

Query specific columns from the distinct_caches system table

Use the --select option to query specific columns from the distinct_caches system table. Provide a comma-delimited list of columns to return:

{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}

<!-- pytest.mark.skip -->
bash
influxdb3 show system \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  table distinct_caches \
  --select name,column_names,max_age_seconds

{{% /code-placeholders %}}

Sort distinct_caches system table output

Use the --order-by option to sort data from the distinct_caches system table by specific columns. Provide a comma-delimited list of columns to sort by:

{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}

<!-- pytest.mark.skip -->
bash
influxdb3 show system \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  table distinct_caches \
  --order-by max_cardinality,max_age_seconds

{{% /code-placeholders %}}

[!Note] Results are sorted in ascending order based on the provided columns.

In the examples above, replace the following:

  • {{% code-placeholder-key %}}DATABASE_NAME{{% /code-placeholder-key %}}: the name of the database to query system data from
  • {{% code-placeholder-key %}}AUTH_TOKEN{{% /code-placeholder-key %}}: your {{< product-name >}} {{% show-in "enterprise" %}}admin {{% /show-in %}} authentication token

Use the HTTP API

To use the HTTP API to query and output cache information from the system table, send a GET or POST request to the /api/v3/query_sql endpoint.

{{% api-endpoint method="GET" endpoint="/api/v3/query_sql" api-ref="/influxdb3/version/api/v3/#operation/GetExecuteQuerySQL" %}}

{{% api-endpoint method="POST" endpoint="/api/v3/query_sql" api-ref="/influxdb3/version/api/v3/#operation/PostExecuteQuerySQL" %}}

Query all caches

{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}

bash
curl -X POST "https://localhost:8181/api/v3/query_sql" \
  --header "Authorization: Bearer AUTH_TOKEN" \
  --json '{
    "db": "DATABASE_NAME",
    "q": "SELECT * FROM system.distinct_caches",
    "format": "json"
  }'

{{% /code-placeholders %}}

Query specific cache details

{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN|CACHE_NAME" %}}

bash
curl -X POST "https://localhost:8181/api/v3/query_sql" \
  --header "Authorization: Bearer AUTH_TOKEN" \
  --json '{
    "db": "DATABASE_NAME",
    "q": "SELECT * FROM system.distinct_caches WHERE name = '\''CACHE_NAME'\''",
    "format": "json"
  }'

{{% /code-placeholders %}}