Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/shared/influxdb3-admin/databases/list.md

5.8 KiB
Raw Permalink Blame History

Use the influxdb3 show databases command, the /api/v3/configure/database HTTP API endpoint, or InfluxDB 3 Explorer to list databases in {{< product-name >}}.

List databases using the influxdb3 CLI

Provide the following:

  • (Optional) Output format with the --format option
  • (Optional) Show deleted databases with the --show-deleted option
  • {{< product-name >}} {{% token-link "admin" "admin" %}} with the -t, --token option
influxdb3 show databases

Output formats

The influxdb3 show databases command supports output formats:

Use the --format flag to specify the output format:

influxdb3 show databases --format json

Example output

{{< expand-wrapper >}} {{% expand "View example pretty-formatted output" %}} {{% influxdb/custom-timestamps %}}

+---------------+
| iox::database |
+---------------+
| home          |
| home_actions  |
| noaa          |
+---------------+

{{% /influxdb/custom-timestamps %}} {{% /expand %}} {{% expand "View example JSON-formatted output" %}} {{% influxdb/custom-timestamps %}}

[{"iox::database":"home"},{"iox::database":"home_actions"},{"iox::database":"noaa"}]

{{% /influxdb/custom-timestamps %}} {{% /expand %}} {{% expand "View example JSON-line-formatted output" %}} {{% influxdb/custom-timestamps %}}

{"iox::database":"home"}
{"iox::database":"home_actions"}
{"iox::database":"noaa"}

{{% /influxdb/custom-timestamps %}} {{% /expand %}} {{% expand "View example CSV-formatted output" %}} {{% influxdb/custom-timestamps %}}

iox::database
home
home_actions
noaa

{{% /influxdb/custom-timestamps %}} {{% /expand %}} {{< /expand-wrapper >}}

Output to a Parquet file

Parquet is a binary format. Use the --output option to specify the file where you want to save the Parquet data.

influxdb3 show databases \
  --format parquet \
  --output databases.parquet

Alternatively, use the influxdb3 query command to query system tables:

influxdb3 query \
  --database _internal \
  --format parquet \
  --output databases.parquet \
  "SELECT * FROM system.databases"

List deleted databases

To list deleted databases, include the --show-deleted option with your influxdb3 show databases command:

influxdb3 show databases --show-deleted

List databases using the HTTP API

To list databases using the HTTP API, send a GET request to the /api/v3/configure/database endpoint.

{{% api-endpoint method="GET" endpoint="{{< influxdb/host >}}/api/v3/configure/database?format=pretty" %}}

Include the format query parameter and specify one of the following formats:

  • pretty
  • json
  • jsonl
  • csv
  • parquet

{{< tabs-wrapper >}} {{% tabs %}} Pretty output JSON output Parquet output {{% /tabs %}} {{% tab-content %}}

Include the following in your request:

  • Headers:
    • Authorization: Bearer with your {{% token-link %}}
  • Query Parameters:
    • format=pretty
curl --request GET "{{< influxdb/host >}}/api/v3/configure/database?format=pretty" \
  --header "Authorization: Bearer AUTH_TOKEN"

The response body contains a table of database names:

+---------------------+
| iox::database       |
+---------------------+
| _internal           |
| home                |
| home_actions        |
| noaa                |
+---------------------+

{{% /tab-content %}}

{{% tab-content %}}

Include the following in your request:

  • Headers:
    • Authorization: Bearer with your {{% token-link %}}
  • Query Parameters:
    • format=json
curl --request GET "{{< influxdb/host >}}/api/v3/configure/database?format=json" \
  --header "Authorization: Bearer AUTH_TOKEN"

The response body contains a JSON array of database objects whose keys are iox::database:

[
  {
    "iox::database": "home"
  },
  {
    "iox::database": "home_actions"
  },
  {
    "iox::database": "noaa"
  }
]

{{% /tab-content %}}

{{% tab-content %}}

Include the following in your request:

  • Headers:
    • Authorization: Bearer with your {{% token-link %}}
  • Query Parameters:
    • format=parquet
  • An output destination for the Parquet file
curl "{{< influxdb/host >}}/api/v3/configure/database?format=parquet" \
  -o databases.parquet \
  --header "Authorization: Bearer AUTH_TOKEN"

For Parquet responses, you must provide an output destination because the format is binary.

The response contains the databases list. {{% /tab-content %}} {{< /tabs-wrapper >}}

A successful request returns HTTP status 200.

List databases using InfluxDB 3 Explorer

You can also view all databases using the InfluxDB 3 Explorer web interface:

  1. If you haven't already, see how to get started with Explorer and connect to your {{% product-name %}} server.
  2. In Explorer, click Databases in the left navigation.
  3. The Databases page displays a list of all databases with the following information:
    • Database name
    • Retention period (if configured)
    • Number of tables in the database
    • Creation date

For more information, see Manage databases with InfluxDB 3 Explorer.