Ksqlite Kotlin API/ksqlite.kapi.function/FunctionScope

FunctionScope

Supplies the necessary APIs during the invocation of a function hook.

If an error is detected, an SQLiteException can be thrown. The error is then returned to SQLite. Only SQLiteException are recognized as normal error and other exceptions types are not caught. It is also possible to use any of setResultError, setResultErrorNoMem or setResultErrorTooBig.

Inheritors

AggregateFunctionFinalScope

AggregateFunctionStepScope

ScalarFunctionFuncScope

WindowFunctionInverseScope

Properties

connection

abstract val connection: DatabaseConnection

Returns the database connection associated with the hook.

Functions

setResultError

abstract 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

abstract fun setResultErrorNoMem(): Nothing

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

setResultErrorTooBig

abstract fun setResultErrorTooBig(): Nothing

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