Documentation

schema.measurementFieldKeys() function

The schema.measurementFieldKeys() function returns a list of fields in a measurement. The return value is always a single table with a single column, _value.

import "influxdata/influxdb/schema"

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

Deleted fields

Fields explicitly deleted from InfluxDB Cloud do not appear in results.

Expired fields

  • InfluxDB Cloud: field keys associated with points outside of the bucket’s retention policy may appear in results up to an hour after expiring.
  • InfluxDB OSS: field keys associated with points outside of the bucket’s retention policy may appear in results. For more information, see Data retention in InfluxDB OSS.

Parameters

bucket

Bucket to retrieve field keys from.

measurement

Measurement to list field keys from.

start

Earliest time to include in results. Defaults to -30d.

Relative start times are defined using negative durations. Negative durations are relative to now. Absolute start times are defined using time values.

stop

Latest time to include in results. Default is now().

The stop time is exclusive, meaning values with a time equal to stop time are excluded from results. Relative start times are defined using negative durations. Negative durations are relative to now(). Absolute start times are defined using time values.

Examples

Return all field keys in a measurement

import "influxdata/influxdb/schema"

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

Return all field keys in a measurement from a non-default time range

import "influxdata/influxdb/schema"

schema.measurementFieldKeys(bucket: "example-bucket",  measurement: "example-measurement", start: -90d, stop: -60d)

Not supported in the Flux REPL

schema functions can retrieve schema information when executed within the context of InfluxDB, but not from the Flux REPL.


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.