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(): Result

Returns the current value of the aggregate, determined by the contents of the current window, and frees any resources allocated by earlier calls to step. The returned Result must come from calling one of the receiver's result methods.

inverse

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

Removes from the current window the oldest row previously aggregated by step. arguments, if any, are those that were passed to step for that row.

step

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

Adds a row to the current window. arguments, if any, correspond to the row being added.

value

abstract fun AggregateFunctionFinalScope.value(): Result

Returns the current value of the aggregate without freeing the context, unlike final. The returned Result must come from calling one of the receiver's result methods.