Skip to main content

AggregateTransform

The aggregate member of the PipelineTransform union.

versionVersion (integer)
Constant value: 1
Default value: 1
opOp (string)required
Constant value: aggregate
config objectrequired

Config for the aggregate op: group-by + allowlisted aggregate functions. An empty group_by aggregates the whole input to a single row. input is a port key.

inputInput (string)required

Input port key

group_bystring[]

Grouping columns (empty = whole-input aggregate)

aggregations object[]required

Aggregations (non-empty)

  • Array [
    • functionFunction (string)required

    Allowlisted aggregate function

    Possible values: [sum, count, avg, min, max]

    column object

    Aggregated column (omit only for count)

    anyOf
    string
    aliasAlias (string)required

    Output column name

  • ]
    • AggregateTransform
    {
      "version": 1,
      "op": "aggregate",
      "config": {
        "input": "string",
        "group_by": [
          "string"
        ],
        "aggregations": [
          {
            "function": "sum",
            "column": "string",
            "alias": "string"
          }
        ]
      }
    }