Documentation

schema.fieldKeys() function

schema.fieldKeys() returns field keys in a bucket.

Results include a single table with a single column, _value.

Note: FieldKeys is a special application of tagValues() that returns field keys in a given bucket.

Function type signature
(
    bucket: string,
    ?predicate: (
        r: {
            A with
            _value: B,
            _time: time,
            _stop: time,
            _start: time,
            _measurement: string,
            _field: string,
        },
    ) => bool,
    ?start: C,
    ?stop: D,
) => stream[E] where E: Record
For more information, see Function type signatures.

Parameters

bucket

(Required) Bucket to list field keys from.

predicate

Predicate function that filters field keys. Default is (r) => true.

start

Oldest time to include in results. Default is -30d.

stop

Newest time include in results. The stop time is exclusive, meaning values with a time equal to stop time are excluded from the results. Default is now().

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

Examples

Query field keys from an InfluxDB bucket

import "influxdata/influxdb/schema"

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

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.


Was this page helpful?

Thank you for your feedback!


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.