geo.groupByArea() function

geo.groupByArea() is experimental and subject to change at any time. By using this function, you accept the risks of experimental functions.

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.



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


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


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


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


Group geotemporal data by geographic area

import "experimental/geo"

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

View example input and ouput

Was this page helpful?

Thank you for your feedback!

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.