Ksqlite Kotlin API/ksqlite.kapi.config/ConfigurationScope

ConfigurationScope

interface ConfigurationScope : AnyTimeConfiguration(source)

The full set of SQLite's configuration options, available only inside the configure block passed to ksqlite.kapi.SQLite.initialize, before SQLite is initialized. AnyTimeConfiguration exposes the smaller subset still changeable afterward.

Properties

isRowidInViewActivated

abstract var isRowidInViewActivated: Boolean

Whether views may have a ROWID.

pageCacheHeaderSize

abstract val pageCacheHeaderSize: Int

Number of extra bytes SQLite reserves per page for the page cache the application supplies.

Functions

setCoveringIndexScanEnabled

abstract fun setCoveringIndexScanEnabled(enabled: Boolean)

Enables or disables the use of covering indices for full table scans in the query optimizer.

setInMemoryDatabaseMaxSize

abstract fun setInMemoryDatabaseMaxSize(maxSize: Long)

Sets the default maximum size for an in-memory database created by deserializing a previously serialized one.

setLogger

abstract fun setLogger(logger: Logger?)

Sets the Logger that receives SQLite's internal log messages, or null to stop logging.

setLookasideConfig

abstract fun setLookasideConfig(sz: Int, cnt: Int)

Sets the default lookaside size.

setMemStatusEnabled

abstract fun setMemStatusEnabled(enabled: Boolean)

Enables or disables the collection of memory allocation statistics.

setMmapSize

abstract fun setMmapSize(sz: Long, mx: Long)

Sets the default mmap size limit, sz, and the maximum allowed mmap size limit, mx, for every connection opened from now on.

setMultiThread

abstract fun setMultiThread()

Sets the threading mode to Multi-thread.

setPackedMemoryArraySize

abstract fun setPackedMemoryArraySize(szPma: UInt)

Sets the "Minimum PMA Size" for the multithreaded sorter to szPma.

setSerialized

abstract fun setSerialized()

Sets the threading mode to Serialized.

setSingleThread

abstract fun setSingleThread()

Sets the threading mode to Single-thread.

setSmallMallocEnabled

abstract fun setSmallMallocEnabled(enabled: Boolean)

Sets whether SQLite should avoid large memory allocations if possible.

setSqlLogger

abstract fun setSqlLogger(logger: SqlLogger?)

Sets the SqlLogger that receives every connection's open, statement execution and close events for the rest of the SQLite session, or null to stop logging.

setStatementJournalSpillThreshold

abstract fun setStatementJournalSpillThreshold(nByte: Int)

Sets the statement journal spill-to-disk threshold.

setUriEnabled

abstract fun setUriEnabled(enabled: Boolean)

Enables or disables global URI handling.