docs-v2/content/v2.0/reference/flux/functions/built-in/transformations/group.md

1.8 KiB

title description aliases menu weight
group() function The `group()` function groups records based on their values for specific columns.
/v2.0/reference/flux/functions/transformations/group
v2_0_ref
name parent
group built-in-transformations
401

The group() function groups records based on their values for specific columns. It produces tables with new group keys based on provided properties. Specify an empty array of columns to ungroup data or merge all input tables into a single output table.

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")
Ungroup data
// Merge all tables into a single table
from(bucket: "telegraf/autogen")
  |> range(start: -30m)
  |> group()

GROUP BY (similar but different)