Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 978 Bytes

functions.md

File metadata and controls

32 lines (19 loc) · 978 Bytes

Functions

VGI exposes four function patterns. Pick the one that matches how your data flows:

Pattern Shape Base class
Scalar 1 row in → 1 row out ScalarFunction / ScalarFunctionGenerator
Table no input → rows out TableFunctionGenerator
Table-in-out rows in → rows out (streaming) TableInOutFunction / TableInOutGenerator
Aggregate grouped rows → one row per group AggregateFunction

All four ultimately derive from the shared Function base.

Scalar functions

::: vgi.scalar_function

Table functions

::: vgi.table_function

Table-in-out functions

::: vgi.table_in_out_function

Aggregate functions

::: vgi.aggregate_function

Function base

::: vgi.function