Documentation

influxdb.select() function

Flux 0.77.0+

The influxdb.select() function is a user-contributed function maintained by the package author and can be updated or removed at any time.

The influxdb.select() function is an alternate implementation of from(), range(), filter() and pivot() that returns pivoted query results and masks the _measurement, _start, and _stop columns. Results are similar to those returned by InfluxQL SELECT statements.

import "contrib/jsternberg/influxdb"

influxdb.select(
  from: "example-bucket",
  start: -1d,
  stop: now(),
  m: "example-measurement",
  fields: [],
  where: (r) => true,
  host: "https://example.com",
  org: "example-org",
  token: "MySuP3rSecr3Tt0k3n"
)

Parameters

host, org, and token parameters are only required when querying data from a different organization or a remote InfluxDB instance.

from

(Required) Name of the bucket to query.

start

(Required) Earliest time to include in results. Results include points that match the specified start time. Use a relative duration, absolute time, or integer (Unix timestamp in seconds). For example, -1h, 2019-08-28T22:00:00Z, or 1567029600. Durations are relative to now().

stop

Latest time to include in results. Results exclude points that match the specified stop time. Use a relative duration, absolute time, or integer (Unix timestamp in seconds). For example, -1h, 2019-08-28T22:00:00Z, or 1567029600. Durations are relative to now().

Defaults to now().

m

(Required) Name of the measurement to query.

fields

List of fields to query. Returns all fields when list is empty or unspecified. Defaults to [].

where

A single argument predicate function that evaluates true or false and filters results based on tag values. Records are passed to the function before fields are pivoted into columns. Records that evaluate to true are included in the output tables. Records that evaluate to null or false are not included in the output tables. Defaults to (r) => true.

Records evaluated in fn functions are represented by r, short for “record” or “row”.

host

URL of the InfluxDB instance to query. See InfluxDB URLs or InfluxDB Cloud regions.

org

Organization name.

token

InfluxDB API token.

Examples

Query a single field
import "contrib/jsternberg/influxdb"

influxdb.select(
  from: "example-bucket",
  start: -1d,
  m: "example-measurement",
  fields: ["field1"]
)
Query multiple fields
import "contrib/jsternberg/influxdb"

influxdb.select(
  from: "example-bucket",
  start: -1d,
  m: "example-measurement",
  fields: ["field1", "field2", "field3"]
)
Query all fields and filter by tags
import "contrib/jsternberg/influxdb"

influxdb.select(
  from: "example-bucket",
  start: -1d,
  m: "example-measurement",
  where: (r) => r.host == "host1" and r.region == "us-west"
)
Query data from a remote InfluxDB Cloud instance
import "contrib/jsternberg/influxdb"
import "influxdata/influxdb/secrets"

token = secrets.get(key: "INFLUXDB_CLOUD_TOKEN")

influxdb.select(
  from: "example-bucket",
  start: -1d,
  m: "example-measurement",
  fields: ["field1", "field2"],
  host: "https://cloud2.influxdata.com",
  org: "example-org",
  token: token
)

Package author and maintainer

Github: @jsternberg
InfluxDB Slack: @Jonathan Sternberg


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.