tickscript.selectWindow() function

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

import "contrib/bonitoo-io/tickscript"

tickscript.selectWindow(
  column: "_value",
  fn: sum,
  as: "example-name",
  every: 1m,
  defaultValue: 0.0,
)

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), ...)

Parameters

column

Column to operate on. Default is _value.

Data type: String

fn

(Required) Aggregate or selector function to apply.

Data type: Function

as

(Required) New column name.

Data type: String

every

(Required) Duration of windows.

Data type: Duration

defaultValue

(Required) Default fill value for null values in column.

Must be the same data type as column.

Data type: String | Boolean | Float | Integer | Uinteger | Bytes

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.0
  )