Documentation

schema.tagKeys() function

schema.tagKeys() returns a list of tag keys for all series that match the predicate.

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

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 return tag keys from.

predicate

Predicate function that filters tag 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 tag keys in an InfluxDB bucket

import "influxdata/influxdb/schema"

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


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.