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()
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!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Flux and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.