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,
}]
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()


Was this page helpful?

Thank you for your feedback!


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.