Documentation

group() function

group() regroups input data by modifying group key of input tables.

Note: Group does not guarantee sort order. To ensure data is sorted correctly, use sort() after group().

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

For more information, see Function type signatures.

Parameters

columns

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

Note: When columns is set to an empty array, group() ungroups all data merges it into a single output table.

mode

Grouping mode. Default is by.

Available modes:

  • by: Group by columns defined in the columns parameter.
  • except: Group by all columns except those in defined in the columns parameter.

tables

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

Examples

Group by specific columns

import "sampledata"

sampledata.int()
    |> group(columns: ["_time", "tag"])
  • Copy
  • Fill window

View example input and output

Group by everything except time

import "sampledata"

sampledata.int()
    |> group(columns: ["_time"], mode: "except")
  • Copy
  • Fill window

View example input and output

Ungroup data

import "sampledata"

// Merge all tables into a single table
sampledata.int()
    |> group()
  • Copy
  • Fill window

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

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out: