List tables

Use the influxdb3 query command or the HTTP API to list tables in a specified database in InfluxDB 3 Enterprise.

With InfluxDB 3 Enterprise, tables and measurements are synonymous. This guide shows how to retrieve a list of all tables (measurements) in a database.

• List tables using the influxdb3 CLI
• List tables using the HTTP API

List tables using the influxdb3 CLI

1. If you haven’t already, download and install the influxdb3 CLI.

2. Use the influxdb3 query command with the SHOW TABLES SQL statement:

influxdb3 query \
  --database 
DATABASE_NAME
 \
  --token 
AUTH_TOKEN
 \
  "SHOW TABLES"

Replace the following:

• DATABASE_NAME: the name of the database to list tables from
• AUTH_TOKEN: your admin token

Example output

+---------------+---------------+------------+------------+
| table_catalog | table_schema  | table_name | table_type |
+---------------+---------------+------------+------------+
| public        | iox           | home       | BASE TABLE |
| public        | iox           | sensors    | BASE TABLE |
+---------------+---------------+------------+------------+

Alternative: List tables using InfluxQL

You can also use InfluxQL syntax to list measurements (tables):

influxdb3 query \
  --language influxql \
  --database 
DATABASE_NAME
 \
  --token 
AUTH_TOKEN
 \
  "SHOW MEASUREMENTS"

List tables using the HTTP API

To list tables using the HTTP API, send a GET request to the /api/v3/query_sql endpoint with a SHOW TABLES query:

GET localhost:8181/api/v3/query_sql

Include the following in your request:

• Query parameters:
  • db: Database name
  • q: The SQL query (SHOW TABLES)
  • format: Response format (optional, defaults to json)
• Headers:
  • Authorization: Bearer with your authentication token

curl --get "localhost:8181/api/v3/query_sql" \
  --header "Authorization: Bearer 
AUTH_TOKEN
" \
  --data-urlencode "db=
DATABASE_NAME
" \
  --data-urlencode "q=SHOW TABLES" \
  --data-urlencode "format=json"

Replace the following:

• DATABASE_NAME: the name of the database to list tables from
• AUTH_TOKEN: your admin token

Example response

{
  "results": [
    {
      "series": [
        {
          "name": "tables",
          "columns": ["table_catalog", "table_schema", "table_name", "table_type"],
          "values": [
            ["public", "iox", "home", "BASE TABLE"],
            ["public", "iox", "sensors", "BASE TABLE"]
          ]
        }
      ]
    }
  ]
}

Get response in CSV format

To get the response in CSV format, set the format parameter to csv:

curl --get "localhost:8181/api/v3/query_sql" \
  --header "Authorization: Bearer 
AUTH_TOKEN
" \
  --data-urlencode "db=
DATABASE_NAME
" \
  --data-urlencode "q=SHOW TABLES" \
  --data-urlencode "format=csv"