Documentation

Explore your data schema with Flux

This page documents an earlier version of InfluxDB. InfluxDB v2.4 is the latest stable version. View this page in the v2.4 documentation.

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!


Set your InfluxDB URL

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.