selekt-api/com.bloomberg.selekt/DatabaseConfiguration

DatabaseConfiguration

data class DatabaseConfiguration(val borrowWaitTimeoutMillis: Long = -1L, val busyTimeoutMillis: Int = 0, val evictionDelayMillis: Long, val maxConnectionPoolSize: Int, val maxSqlCacheSize: Int, val name: String = "main", val secureDelete: SQLiteSecureDelete = SQLiteSecureDelete.FAST, val timeBetweenEvictionRunsMillis: Long, val trace: SQLiteTraceEventMode? = null, val useNativeTransactionListeners: Boolean = false, val cursorWindowSize: Int = PLATFORM_DEFAULT_CURSOR_WINDOW_SIZE, val cursorWindowByteSize: Int = PLATFORM_DEFAULT_CURSOR_WINDOW_BYTE_SIZE, val pageCacheSizeKiB: Int? = null)(source)

Since

0.12.1

Constructors

constructor(borrowWaitTimeoutMillis: Long = -1L, busyTimeoutMillis: Int = 0, evictionDelayMillis: Long, maxConnectionPoolSize: Int, maxSqlCacheSize: Int, name: String = "main", secureDelete: SQLiteSecureDelete = SQLiteSecureDelete.FAST, timeBetweenEvictionRunsMillis: Long, trace: SQLiteTraceEventMode? = null, useNativeTransactionListeners: Boolean = false, cursorWindowSize: Int = PLATFORM_DEFAULT_CURSOR_WINDOW_SIZE, cursorWindowByteSize: Int = PLATFORM_DEFAULT_CURSOR_WINDOW_BYTE_SIZE, pageCacheSizeKiB: Int? = null)

Types

Companion

object Companion

Properties

borrowWaitTimeoutMillis

val borrowWaitTimeoutMillis: Long

Maximum time to wait for the single primary connection, in milliseconds, or -1 to wait indefinitely.

busyTimeoutMillis

val busyTimeoutMillis: Int

cursorWindowByteSize

val cursorWindowByteSize: Int

Maximum estimated bytes retained by a scrollable cursor window, or PLATFORM_DEFAULT_CURSOR_WINDOW_BYTE_SIZE to use the platform default.

cursorWindowSize

val cursorWindowSize: Int

Maximum rows retained by a scrollable cursor at once, or PLATFORM_DEFAULT_CURSOR_WINDOW_SIZE to use the platform default.

evictionDelayMillis

val evictionDelayMillis: Long

maxConnectionPoolSize

val maxConnectionPoolSize: Int

maxSqlCacheSize

val maxSqlCacheSize: Int

Maximum size of the prepared statement cache.

name

val name: String

pageCacheSizeKiB

val pageCacheSizeKiB: Int?

Approximate maximum KiB retained by SQLite's page cache on each physical connection. Selekt applies this as a negative SQLite PRAGMA cache_size value, which SQLite interprets as KiB rather than a number of pages. null preserves SQLite's compiled default.

secureDelete

val secureDelete: SQLiteSecureDelete

timeBetweenEvictionRunsMillis

val timeBetweenEvictionRunsMillis: Long

Time between idle connection eviction runs in milliseconds, -1L for never.

trace

val trace: SQLiteTraceEventMode?

useNativeTransactionListeners

val useNativeTransactionListeners: Boolean

Whether to use native SQLite commit/rollback hooks for transaction listeners.

Functions

withCursorWindowLimits

fun withCursorWindowLimits(cursorWindowSize: Int, cursorWindowByteSize: Int): DatabaseConfiguration

Returns a copy with explicit scrollable-cursor row and byte limits.