Documentation

Explore your data schema with Flux

Flux provides functions that let you explore the structure and schema of your data stored in InfluxDB.

Functions in the schema package are not supported in the Flux REPL.

List buckets

Use buckets() to list buckets in your organization.

buckets()

View example buckets() output

List measurements

Use schema.measurements() to list measurements in a bucket. By default, this function returns results from the last 30 days.

import "influxdata/influxdb/schema"

schema.measurements(bucket: "example-bucket")

View example schema.measurements() output

List field keys

Use schema.fieldKeys to list field keys in a bucket. By default, this function returns results from the last 30 days.

import "influxdata/influxdb/schema"

schema.fieldKeys(bucket: "example-bucket")

View example schema.fieldKeys() output

List fields in a measurement

Use schema.measurementFieldKeys to list field keys in a measurement. By default, this function returns results from the last 30 days.

import "influxdata/influxdb/schema"

schema.measurementFieldKeys(
    bucket: "example-bucket",
    measurement: "example-measurement",
)

View example schema.measurementFieldKeys() output

List tag keys

Use schema.tagKeys() to list tag keys in a bucket. By default, this function returns results from the last 30 days.

import "influxdata/influxdb/schema"

schema.tagKeys(bucket: "example-bucket")

View example schema.tagKeys() output

List tag keys in a measurement

Use schema.measurementTagKeys to list tag keys in a measurement. By default, this function returns results from the last 30 days.

import "influxdata/influxdb/schema"

schema.measurementTagKeys(
    bucket: "example-bucket",
    measurement: "example-measurement",
)

View example schema.measurementTagKeys() output

List tag values

Use schema.tagValues() to list tag values for a given tag in a bucket. By default, this function returns results from the last 30 days.

import "influxdata/influxdb/schema"

schema.tagValues(bucket: "example-bucket", tag: "example-tag")

View example schema.tagValues() output

List tag values in a measurement

Use schema.measurementTagValues to list tag values for a given tag in a measurement. By default, this function returns results from the last 30 days.

import "influxdata/influxdb/schema"

schema.measurementTagValues(
    bucket: "example-bucket",
    tag: "example-tag",
    measurement: "example-measurement",
)

View example schema.measurementTagValues() output


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.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: