com.bloomberg.selekt.DatabaseConfiguration.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 Bloomberg Finance L.P.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.bloomberg.selekt

data class DatabaseConfiguration(
    val borrowWaitTimeoutMillis: Long = -1L,
    val busyTimeoutMillis: Int = 0,
    val evictionDelayMillis: Long,
    val maxConnectionPoolSize: Int,
    /**
     * Maximum size of the prepared statement cache.
     *
     * Each prepared statement is between 1KB and 6KB, depending on the complexity of the SQL statement and schema. A large
     * cache may use a significant amount of memory.
     */
    val maxSqlCacheSize: Int,
    val name: String = "main",
    val secureDelete: SQLiteSecureDelete = SQLiteSecureDelete.FAST,
    /**
     * Time between idle connection eviction runs in milliseconds, -1L for never.
     */
    val timeBetweenEvictionRunsMillis: Long,
    val trace: SQLiteTraceEventMode? = null
) {
    init {
        require(maxConnectionPoolSize > 0)
    }

    companion object {
        /**
         * When using WAL, a timeout could occur if one connection is busy performing an auto-checkpoint operation. The
         * busy timeout needs to be long enough to tolerate slow I/O write operations but not so long as to cause the
         * application to hang indefinitely if there is a problem acquiring a database lock.
         *
         * @see SQLite's busy_timeout
         */
        const val COMMON_BUSY_TIMEOUT_MILLIS = 2_500
    }
}

private object TraceCodes {
    const val STATEMENT = 0x01
    const val PROFILE = 0x02
    const val ROW = 0x04
    const val CLOSE = 0x08
}

enum class SQLTraceEventCode(private val value: Int) {
    STATEMENT(TraceCodes.STATEMENT),
    PROFILE(TraceCodes.PROFILE),
    ROW(TraceCodes.ROW),
    CLOSE(TraceCodes.CLOSE);

    operator fun invoke() = value
}