Explore your data schema with Flux

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

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

• List buckets
• List measurements
• List field keys
• List tag keys
• List tag values

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

buckets() returns a single table with the following columns:

• organizationID: Organization ID
• name: Bucket name
• id: Bucket ID
• retentionPolicy: Retention policy associated with the bucket
• retentionPeriod: Retention period in nanoseconds

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

schema.measurements() returns a single table with a _value column. Each row contains the name of a measurement.

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

schema.fieldKeys() returns a single table with a _value column. Each row contains a unique field key from the specified bucket.

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

schema.measurementFieldKeys() returns a single table with a _value column. Each row contains the name of a unique field key in the specified bucket and measurement.

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

schema.tagKeys() returns a single table with a _value column. Each row contains the a unique tag key from the specified bucket.

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

schema.measurementTagKeys() returns a single table with a _value column. Each row contains a unique tag key from the specified bucket and measurement.

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

schema.tagValues() returns a single table with a _value column. Each row contains a unique tag value from the specified bucket and tag key.

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

schema.measurementTagValues() returns a single table with a _value column. Each row contains a unique tag value from the specified bucket, measurement, and tag key.

Related

schema