sqlx4k-sqlite/io.github.smyrgeorge.sqlx4k.sqlite/SQLite

SQLite

class SQLite(url: String, options: <Error class: unknown class> = Driver.Pool.Options())

A database driver for SQLite, implemented with connection pooling and transactional support. This class provides mechanisms to execute SQL queries, manage database connections, and handle transactions in a coroutine-based environment.

sqlite::memory: | Open an in-memory database. sqlite:data.db | Open the file data.db in the current directory. sqlite://data.db | Open the file data.db in the current directory. sqlite:///data.db | Open the file data.db from the root (/) directory. sqlite://data.db?mode=ro | Open the file data.db for read-only access.

Parameters

url

The URL string for connecting to the SQLite database.

options

Configuration options for the connection pool, such as minimum and maximum connections, timeout durations, etc.

Constructors

SQLite

constructor(url: String, options: <Error class: unknown class> = Driver.Pool.Options())

Types

Companion

object Companion

class Tx(tx: <Error class: unknown class><out <Error class: unknown class>>)

Represents a specific implementation of the Transaction interface. This class facilitates the management of database transactions, including methods to commit, roll back, execute queries, and fetch results.

Functions

begin

open suspend fun begin(): Result<<Error class: unknown class>>

open suspend fun close(): Result<Unit>

execute

open suspend fun execute(statement: <Error class: unknown class>): Result<Long>

open suspend fun execute(sql: String): Result<Long>

fetchAll

open suspend fun fetchAll(statement: <Error class: unknown class>): Result<<Error class: unknown class>>

open suspend fun fetchAll(sql: String): Result<<Error class: unknown class>>

open suspend fun <T> fetchAll(statement: <Error class: unknown class>, rowMapper: <Error class: unknown class><T>): Result<List<T>>

migrate

open suspend fun migrate(path: String): Result<Unit>

poolIdleSize

open fun poolIdleSize(): Int

poolSize

open fun poolSize(): Int