group() function

Warning! This page documents an earlier version of Flux, which is no longer actively developed. Flux v0.50 is the most recent stable version of Flux.

The group() function groups records based on their values for specific columns. It produces tables with new group keys based on provided properties.

Function type: Transformation

group(columns: ["host", "_measurement"], mode:"by")

// OR

group(columns: ["_time"], mode:"except")

// OR

group()

Parameters

columns

List of columns to use in the grouping operation. Defaults to [].

Data type: Array of strings

mode

The mode used to group columns.

Data type: String

The following options are available:

  • by
  • except

Defaults to "by".

by

Groups records by columns defined in the columns parameter.

except

Groups records by all columns except those defined in the columns parameter.

Examples

Group by host and measurement
from(bucket: "telegraf/autogen")
  |> range(start: -30m)
  |> group(columns: ["host", "_measurement"])
Group by everything except time
from(bucket: "telegraf/autogen")
  |> range(start: -30m)
  |> group(columns: ["_time"], mode: "except")
Remove all grouping
from(bucket: "telegraf/autogen")
  |> range(start: -30m)
  |> group()

GROUP BY (similar but different)