Documentation

experimental.group() function

experimental.group() is subject to change at any time.

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

Function type signature
(<-tables: stream[A], columns: [string], mode: string) => stream[A] where A: Record

For more information, see Function type signatures.

Parameters

columns

(Required) List of columns to use in the grouping operation. Default is [].

mode

(Required) Grouping mode. extend is the only mode available to experimental.group().

Grouping modes

  • extend: Appends columns defined in the columns parameter to group keys.

tables

Input data. Default is piped-forward data (<-).

Examples

Add a column to the group key

import "experimental"

data
    |> experimental.group(columns: ["region"], mode: "extend")

View example input and output


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