Ksqlite Kotlin API/ksqlite.kapi.vtab/VirtualTableModule

VirtualTableModule

sealed class VirtualTableModule : AutoCloseable(source)

This interface is not directly implementable, one of Regular, Eponymous or EponymousOnly must be implemented depending on the virtual table kind.

Note that a VirtualTableModule cannot be a singleton nor a reusable instance — a new instance must always be passed to DatabaseConnection.createModule.

Inheritors

Regular

Eponymous

EponymousOnly

Types

Eponymous

abstract class Eponymous : VirtualTableModule

Eponymous Virtual Table. The same callback reference is passed to SQLite for both create and connect.

EponymousOnly

abstract class EponymousOnly : VirtualTableModule

Eponymous Only Virtual Table. A callback is passed to SQLite for connect but not for create.

Regular

abstract class Regular : VirtualTableModule

Regular Virtual Table. Distinct callbacks are passed to SQLite for create and connect.

Functions

open override fun close()

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

connect

abstract fun VirtualTableCreateOrConnectScope.connect(connection: DatabaseConnection, arguments: Array<String>): VirtualTable

Connects to an already created virtual table and returns the VirtualTable instance. If an error is detected, an SQLiteException is thrown and is returned to SQLite.

optionalFunctions

fun optionalFunctions(): Set<VirtualTableOptionalFunction>

Returns the optional virtual table functions supported by the module. Only the functions that are returned are invoked by SQLite.