Ksqlite Kotlin API/ksqlite.kapi.function/WindowFunction

WindowFunction

interface WindowFunction : AggregateFunction(source)

Functions

open override fun close()

Called when the function is finalized by SQLite. Finalization can also happen when the function registration fails.

abstract fun AggregateFunctionFinalScope.final()

This method is invoked to return the current value of the aggregate (determined by the contents of the current window), and to free any resources allocated by earlier calls to step.

inverse

abstract fun WindowFunctionInverseScope.inverse(arguments: Array<ProtectedValue>)

This method is invoked to remove the oldest presently aggregated result of step from the current window. The function arguments, if any, are those passed to step for the row being removed.

step

abstract fun AggregateFunctionStepScope.step(arguments: Array<ProtectedValue>)

This method is invoked to add a row to the current window. The function arguments, if any, corresponds to the row being added.

value

abstract fun AggregateFunctionFinalScope.value()

This method is invoked to return the current value of the aggregate. Unlike final, the implementation should not delete any context.