docs-v2/content/flux/v0/stdlib/influxdata/influxdb/v1/databases.md

title	description	menu	weight	flux/v0/tags
v1.databases() function	`v1.databases()` returns a list of databases in an InfluxDB 1.x (1.7+) instance.	flux_v0_ref name parent identifier v1.databases influxdata/influxdb/v1 influxdata/influxdb/v1/databases	301	metadata

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

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

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()