Ksqlite Kotlin API/ksqlite.kapi.function/AggregateFunctionStepScope

AggregateFunctionStepScope

class AggregateFunctionStepScope : FunctionScope, AuxDataScope(source)

Scope for use with AggregateFunction.step and WindowFunction.step.

Properties

open override val connection: DatabaseConnection

Returns the database connection associated with the hook.

Functions

getAuxDataOrNull

inline fun <Data : Any> getAuxDataOrNull(index: Int): Data?

Returns the auxiliary data for the argument at index as Data, or null if there is no associated auxiliary or they have been discarded by SQLite.

getOrCreateAggregateContext

inline fun <C : Any> getOrCreateAggregateContext(noinline compute: () -> C): C

Returns the aggregate context as C.

getOrCreateAuxData

inline fun <Data : Any> getOrCreateAuxData(index: Int, noinline compute: () -> Data): Data

Returns the auxiliary data for the argument at index as Data.

fun setAuxData(index: Int, data: Any)

Sets data as the auxiliary data for the argument at index.

open override fun setResultError(message: String, result: SqliteResultCode.Failure = SqliteResultCode.ERROR): Nothing

Causes SQLite to throw an exception with message. The default error code is SqliteResultCode.ERROR but can be overriden by supplying the appropriate error code

setResultErrorNoMem

open override fun setResultErrorNoMem(): Nothing

Causes SQLite to throw an error indicating that a memory allocation failed.

setResultErrorTooBig

open override fun setResultErrorTooBig(): Nothing

Causes SQLite to throw an error indicating that a string or BLOB is too long to represent.