Documentation

schema.tagKeys() function

The schema.tagKeys() function returns a list of tag keys for all series that match the predicate. The return value is always a single table with a single column, _value.

import "influxdata/influxdb/schema"

schema.tagKeys(
  bucket: "example-bucket",
  predicate: (r) => true,
  start: -30d
)

Parameters

bucket

Bucket to return tag keys from.

Data type: String

predicate

Predicate function that filters tag keys. Defaults to (r) => true.

Data type: Function

start

Oldest 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.

Data type: Duration

Examples

import "influxdata/influxdb/schema"

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

Function definition

package schema

tagKeys = (bucket, predicate=(r) => true, start=-30d) =>
  from(bucket: bucket)
    |> range(start: start)
    |> filter(fn: predicate)
    |> keys()
    |> keep(columns: ["_value"])
    |> distinct()

Used functions: from, range, filter, keys, keep, distinct

Supported in the InfluxDB Cloud UI

The schema package can retrieve schema information from the InfluxDB Cloud user interface (UI), but not from the Flux REPL.


Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.