Documentation

v1.tagValues() function

v1.tagValues() returns a list of unique values for a given tag.

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

Function type signature
(
    bucket: string,
    tag: 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 unique tag values from.

tag

(Required) Tag to return unique values from.

predicate

Predicate function that filters tag values. 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 unique tag values from an InfluxDB bucket

import "influxdata/influxdb/v1"

v1.tagValues(bucket: "example-bucket", tag: "host")

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: