Documentation

Query fields and tags

This page documents an earlier version of InfluxDB. InfluxDB v2 is the latest stable version. See the equivalent InfluxDB v2 documentation: Query fields and tags.

Use the filter() function to query data based on fields, tags, or any other column value. filter() performs operations similar to the SELECT statement and the WHERE clause in InfluxQL and other SQL-like query languages.

The filter() function

filter() has an fn parameter that expects a predicate function, an anonymous function comprised of one or more predicate expressions. The predicate function evaluates each input row. Rows that evaluate to true are included in the output data. Rows that evaluate to false are excluded from the output data.

// ...
  |> filter(fn: (r) => r._measurement == "example-measurement" )

The fn predicate function requires an r argument, which represents each row as filter() iterates over input data. Key-value pairs in the row record represent columns and their values. Use dot notation or bracket notation to reference specific column values in the predicate function. Use logical operators to chain multiple predicate expressions together.

// Row record
r = {foo: "bar", baz: "quz"}

// Example predicate function
(r) => r.foo == "bar" and r["baz"] == "quz"

// Evaluation results
(r) => true and true

Filter by fields and tags

The combination of from(), range(), and filter() represent the most basic Flux query:

  1. Use from() to define your bucket.
  2. Use range() to limit query results by time.
  3. Use filter() to identify what rows of data to output.
from(bucket: "db/rp")
  |> range(start: -1h)
  |> filter(fn: (r) =>
      r._measurement == "example-measurement" and
      r._field == "example-field" and
      r.tag == "example-tag"
  )

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.

Read more