Ksqlite Kotlin API/ksqlite.kapi.connection

Package-level declarations

Types

fun interface Authorizer

Callback to use with DatabaseConnection.setAuthorizer.

fun interface AutoExtension

Callback to use with SQLite.addAutoExtension and SQLite.removeAutoExtension.

AutovacuumPages

fun interface AutovacuumPages : AutoCloseable

Callback to use with DatabaseConnection.setAutovacuumPages.

fun interface BusyHandler

Callback to use with DatabaseConnection.setBusyHandler.

fun interface Collation : AutoCloseable

Callback to use with DatabaseConnection.createCollation.

CollationNeeded

fun interface CollationNeeded

Callback to use with DatabaseConnection.setCollationNeeded.

fun interface CommitHook

Callback to use with DatabaseConnection.setCommitHook.

DatabaseConnection

sealed interface DatabaseConnection : AutoCloseable

A database connection, opened through ksqlite.kapi.SQLite.open.

DatabaseConnectionConfiguration

interface DatabaseConnectionConfiguration

Exposes the database connection configuration API.

fun interface Exec

Callback to use with DatabaseConnection.execute.

interface FileControl

Exposes the file control APIs.

interface LastError

Provides access to the most recent database error information.

fun interface PreupdateHook

Callback to use with DatabaseConnection.setPreupdateHook.

PreupdateHookScope

interface PreupdateHookScope

Scope for use with PreupdateHook.apply.

ProgressHandler

fun interface ProgressHandler

Callback to use with DatabaseConnection.setProgressHandler.

interface Registration : AutoCloseable

Handle for a collation/function/module registered through ksqlite.kapi.connection.DatabaseConnection.createCollation/ ksqlite.kapi.connection.DatabaseConnection.createFunction/ ksqlite.kapi.connection.DatabaseConnection.createModule.

fun interface RollbackHook

Callback to use with DatabaseConnection.setRollbackHook.

SerializeResult

sealed interface SerializeResult

Result for DatabaseConnection.serialize.

TableColumnMetadata

interface TableColumnMetadata

Result of DatabaseConnection.tableColumnMetadata. Member fields are all already resolved.

fun interface Trace

Callback to use with DatabaseConnection.setTrace.

sealed interface TraceEvent

Event passed as parameter to Trace.

fun interface UpdateHook

Callback to use with DatabaseConnection.setUpdateHook.

interface WriteAheadLog

Exposes the Write-Ahead Log APIs of a database connection.

WriteAheadLogCheckpointResult

interface WriteAheadLogCheckpointResult

Result of a Write-Ahead Log checkpoint.

WriteAheadLogHook

fun interface WriteAheadLogHook

Callback to use with WriteAheadLog.setHook.

Properties

val FileControl.dataVersion: Int

Shorthand for FileControl.getDataVersion on the main database.

val FileControl.hasMoved: Boolean?

Shorthand for hasMoved on the main database.

var FileControl.isPersistWal: Boolean?

Shorthand for isPersistWal and FileControl.setPersistWal on the main database.

isPowerSafeOverwrite

var FileControl.isPowerSafeOverwrite: Boolean?

Shorthand for isPowerSafeOverwrite and FileControl.setPowerSafeOverwrite on the main database.

var FileControl.mmapSize: Long?

Shorthand for FileControl.getMmapSize and FileControl.setMmapSize on the main database.

var FileControl.sizeLimit: Long?

Shorthand for FileControl.getSizeLimit and FileControl.setSizeLimit on the main database.

val FileControl.systemError: Int?

Shorthand for FileControl.getSystemError on the main database.

val FileControl.tempFileName: String?

Shorthand for FileControl.getTempFileName on the main database.

val FileControl.vfsName: String?

Shorthand for FileControl.getVfsName on the main database.

Functions

createCollation

@IgnorableReturnValue

fun DatabaseConnection.createCollation(name: String, collation: Collation): Registration

Convenience overload of createCollation using UTF-8 encoding, the only one currently supported.

@IgnorableReturnValue

fun DatabaseConnection.createFunction(name: String, argumentCount: Int, function: AggregateFunction): Registration

@IgnorableReturnValue

fun DatabaseConnection.createFunction(name: String, argumentCount: Int, function: ScalarFunction): Registration

@IgnorableReturnValue

fun DatabaseConnection.createFunction(name: String, argumentCount: Int, function: WindowFunction): Registration

Convenience overload of createFunction using UTF-8 encoding, the only one currently supported.

fun FileControl.reserveBytes(bytes: Int)

Shorthand for reserveBytes on the main database.

fun FileControl.resetCache()

Shorthand for resetCache on the main database.

fun DatabaseConnection.setBusyTimeout(duration: Duration)

Sets a BusyHandler that sleeps for a specified amount of time when a table is locked. Any BusyHandler previously passed to DatabaseConnection.setBusyHandler is replaced.

fun FileControl.setChunkSize(size: Int)

Shorthand for setChunkSize on the main database.

fun FileControl.setLockTimeout(millis: Int)

Shorthand for setLockTimeout on the main database.

fun FileControl.setOverwrite(value: Long)

Shorthand for setOverwrite on the main database.

fun FileControl.setSizeHint(size: Long)

Shorthand for setSizeHint on the main database.