docs-v2/content/v2.0/reference/flux/stdlib/experimental/group.md

title	description	menu	weight	related
experimental.group() function	The `experimental.group()` function introduces an `extend` mode to the existing `group()` function.	v2_0_ref name parent experimental.group Experimental	201	/v2.0/reference/flux/stdlib/built-in/transformations/group/

The experimental.group() function introduces an extend mode to the existing group() function.

Function type: Transformation

{{% warn %}} The experimental.group() function is subject to change at any time. By using this function, you accept the risks of experimental functions.

This specific function will be removed once the proposed extend mode is sufficiently vetted. {{% /warn %}}

import "experimental"

experimental.group(columns: ["host", "_measurement"], mode:"extend")

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

{{% note %}} extend is the only mode available to experimental.group(). {{% /note %}}

extend

Appends columns defined in the columns parameter to all existing group keys.

Examples

Include the value column in each groups' group key

from(bucket: "example-bucket")
  |> range(start: -1m)
  |> group(columns: ["_value"], mode: "extend")