Documentation

v1.databases() function

v1.databases() returns a list of databases in an InfluxDB 1.x (1.7+) instance.

Output includes the following columns:

  • databaseName: Database name (string)
  • retentionPolicy: Retention policy name (string)
  • retentionPeriod: Retention period in nanoseconds (integer)
  • default: Default retention policy for the database (boolean)
Function type signature
(
    ?host: string,
    ?org: string,
    ?orgID: string,
    ?token: string,
) => stream[{
    retentionPolicy: string,
    retentionPeriod: int,
    organizationID: string,
    default: bool,
    databaseName: string,
    bucketID: string,
}]
  • Copy
  • Fill window

For more information, see Function type signatures.

Parameters

org

Organization name.

orgID

Organization ID.

host

InfluxDB URL. Default is http://localhost:8086.

token

InfluxDB API token.

Examples

List databases from an InfluxDB instance

import "influxdata/influxdb/v1"

v1.databases()
  • Copy
  • Fill window

Not supported in the Flux REPL

v1 functions can retrieve schema information when executed within the context of InfluxDB, but not from the Flux REPL.


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: