tickscript.selectWindow() function

tickscript.selectWindow() changes a column’s name, windows rows by time, and then applies an aggregate or selector function the specified column for each window of time.

TICKscript helper function

tickscript.selectWindow is a helper function meant to replicate TICKscript operations like the following:

// Rename, window, and aggregate
query("SELECT f(x) AS y")
  .groupBy(time(t), ...)

Function type signature

(
    <-tables: stream[D],
    as: string,
    defaultValue: A,
    every: duration,
    fn: (<-: stream[B], column: string) => stream[C],
    ?column: string,
) => stream[E] where B: Record, C: Record, D: Record, E: Record

Parameters

column

Column to operate on. Default is _value.

fn

(Required) Aggregate or selector function to apply.

as

(Required) New column name.

every

(Required) Duration of windows.

defaultValue

(Required) Default fill value for null values in column. Must be the same data type as column.

tables

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

Examples

Change the name of, window, and then aggregate the value column

import "contrib/bonitoo-io/tickscript"

data
    |> tickscript.selectWindow(fn: sum, as: "example-name", every: 1h, defaultValue: 0)