Documentation

geo.groupByArea() function

geo.groupByArea() is experimental and subject to change at any time.

geo.groupByArea() groups rows by geographic area.

Area sizes are determined by the specified level. Each geographic area is assigned a unique identifier (the S2 cell ID token) which is stored in the newColumn. Results are grouped by newColumn.

Function type signature
(
    <-tables: stream[{A with s2_cell_id: string, lon: float, lat: float}],
    level: int,
    newColumn: string,
    ?s2cellIDLevel: int,
) => stream[B] where B: Record

For more information, see Function type signatures.

Parameters

newColumn

(Required) Name of the new column for the unique identifier for each geographic area.

level

(Required) S2 Cell level used to determine the size of each geographic area.

s2cellIDLevel

S2 Cell level used in the s2_cell_id tag. Default is -1 (detects S2 cell level from the s2_cell_id tag).

tables

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

Examples

Group geotemporal data by geographic area

import "experimental/geo"

data
    |> geo.groupByArea(newColumn: "foo", level: 4)

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

InfluxDB v3 enhancements and InfluxDB Clustered is now generally available

New capabilities, including faster query performance and management tooling advance the InfluxDB v3 product line. InfluxDB Clustered is now generally available.

InfluxDB v3 performance and features

The InfluxDB v3 product line has seen significant enhancements in query performance and has made new management tooling available. These enhancements include an operational dashboard to monitor the health of your InfluxDB cluster, single sign-on (SSO) support in InfluxDB Cloud Dedicated, and new management APIs for tokens and databases.

Learn about the new v3 enhancements


InfluxDB Clustered general availability

InfluxDB Clustered is now generally available and gives you the power of InfluxDB v3 in your self-managed stack.

Talk to us about InfluxDB Clustered