Ksqlite Kotlin API/ksqlite.kapi/SQLite

SQLite

interface SQLite : AutoCloseable(source)

SQLite entry point.

Types

object Companion : SQLiteStatic

Provides access to SQLite APIs that do not require SQLite initialization.

Properties

abstract val config: AnyTimeConfiguration

Configuration exposing options that can be accessed at anytime.

abstract var hardHeapLimit: Long

Hard limit on the amount of heap memory that may be allocated by SQLite.

memoryHighwater

abstract val memoryHighwater: Long

Maximum value of memoryUsed since the high-water mark was last reset.

abstract val memoryUsed: Long

Number of bytes of memory currently outstanding.

abstract var softHeapLimit: Long

Soft limit on the amount of heap memory that may be allocated by SQLite.

Functions

addAutoExtension

abstract fun addAutoExtension(autoExtension: AutoExtension)

Registers the autoExtension callback. This method has no effect if the autoExtension is already registered.

clearAutoExtensions

abstract fun clearAutoExtensions()

Unregisters all the AutoExtension previously registered.

abstract override fun close()

Shutdowns SQLite and resets global SQLite state.

generateRandomBytes

abstract fun generateRandomBytes(output: Buffer, size: Int)

Stores size bytes of randomness into output.

generateRandomBytes

fun SQLite.generateRandomBytes(size: Int): ByteArray

Returns a ByteArray of given size filled with random bytes.

getMemoryStatus

abstract fun getMemoryStatus(reset: Boolean): Status

Returns the number of bytes of memory currently outstanding and the highwater mark.

abstract fun getStatus(option: SqliteStatusOption, reset: Boolean = false): Status

Returns the status for the given option.

abstract fun open(fileName: String, flags: SqliteOpenFlag.Db = SqliteOpenFlag.READWRITE or SqliteOpenFlag.CREATE, vfs: String? = null): DatabaseConnection

Opens an SQLite database file as specified by fileName and returns a DatabaseConnection.

abstract fun releaseMemory(size: Int): Int

Attempts to free size bytes of heap memory by deallocating non-essential memory allocations held by the database library.

removeAutoExtension

abstract fun removeAutoExtension(autoExtension: AutoExtension)

Unregisters the autoExtension callback. This method has no effect if the autoExtension is not registered.