runtime/app.cash.sqldelight.db/SqlDriver

SqlDriver

interface SqlDriver : Closeable

Maintains connections to an underlying SQL database and provides APIs for managing transactions and executing SQL statements.

Functions

abstract fun addListener(listener: Query.Listener, queryKeys: Array<String>)

expect abstract fun close()

Close any resources backed by this object.

currentTransaction

abstract fun currentTransaction(): Transacter.Transaction?

The currently open Transacter.Transaction on the database.

abstract fun execute(identifier: Int?, sql: String, parameters: Int, binders: SqlPreparedStatement.() -> Unit? = null): QueryResult<Long>

Execute a SQL statement.

abstract fun <R> executeQuery(identifier: Int?, sql: String, mapper: (SqlCursor) -> R, parameters: Int, binders: SqlPreparedStatement.() -> Unit? = null): QueryResult<R>

Execute a SQL statement and evaluate its result set using the given block.

abstract fun newTransaction(): QueryResult<Transacter.Transaction>

Start a new Transacter.Transaction on the database.

notifyListeners

abstract fun notifyListeners(queryKeys: Array<String>)

abstract fun removeListener(listener: Query.Listener, queryKeys: Array<String>)

Inheritors

LogSqliteDriver