Documentation

experimental.window() function

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

experimental.window() groups records based on time.

_start and _stop columns are updated to reflect the bounds of the window the row’s time value is in. Input tables must have _start, _stop, and _time columns.

A single input record can be placed into zero or more output tables depending on the specific windowing function.

By default the start boundary of a window will align with the Unix epoch modified by the offset of the location option.

Calendar months and years

every, period, and offset support all valid duration units, including calendar months (1mo) and years (1y).

Function type signature
(
    <-tables: stream[{A with _time: time, _stop: time, _start: time}],
    ?createEmpty: bool,
    ?every: duration,
    ?location: {zone: string, offset: duration},
    ?offset: duration,
    ?period: duration,
) => stream[{A with _time: time, _stop: time, _start: time}]
For more information, see Function type signatures.

Parameters

every

Duration of time between windows. Default is the 0s.

period

Duration of the window. Default is 0s.

Period is the length of each interval. It can be negative, indicating the start and stop boundaries are reversed.

offset

Duration to shift the window boundaries by. Default is 0s.

offset can be negative, indicating that the offset goes backwards in time.

location

Location used to determine timezone. Default is the location option.

createEmpty

Create empty tables for empty windows. Default is false.

tables

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

Examples

Window data into thirty second intervals

import "experimental"

data
    |> experimental.window(every: 30s)

View example input and output

Window by calendar month

import "experimental"

data
    |> experimental.window(every: 1mo)

View example input and output


Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

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.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following:

State of the InfluxDB Cloud Serverless documentation

InfluxDB Cloud Serverless documentation is a work in progress.

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.