sqlx4k-sqlite-cipher/io.github.smyrgeorge.sqlx4k.sqlite.cipher/ISQLiteCipher

ISQLiteCipher

interface ISQLiteCipher : Driver, Migrator.Driver(source)

Driver contract for the encrypted (SQLCipher) SQLite backend.

Identical surface to the plain SQLite driver, but every target — native (FFI/cinterop) and JVM/Android (JNI) — is backed by the same Rust sqlx + SQLCipher core, so behavior is uniform across platforms. The encryption key is supplied as a password to the sqliteCipher factory and applied as PRAGMA key when the connection pool is opened.

Inheritors

SQLiteCipher

Properties

encoders

abstract val encoders: ValueEncoderRegistry

Functions

acquire

abstract suspend fun acquire(): Result<Connection>

begin

abstract suspend fun begin(): Result<Transaction>

abstract suspend fun close(): Result<Unit>

execute

abstract suspend fun execute(statement: Statement): Result<Long>

abstract suspend fun execute(@Language(value = "SQL") sql: String): Result<Long>

executeWithResult

open suspend fun executeWithResult(statement: Statement): Result<ExecuteResult>

open suspend fun executeWithResult(@Language(value = "SQL") sql: String): Result<ExecuteResult>

fetch

abstract fun fetch(statement: Statement, fetchSize: Int): Flow<ResultSet.Row>

abstract fun fetch(@Language(value = "SQL") sql: String, fetchSize: Int): Flow<ResultSet.Row>

open fun <T> fetch(statement: Statement, rowMapper: RowMapper<T>, fetchSize: Int): Flow<T>

open fun <T> fetch(@Language(value = "SQL") sql: String, rowMapper: RowMapper<T>, fetchSize: Int): Flow<T>

fetchAll

abstract suspend fun fetchAll(statement: Statement): Result<ResultSet>

abstract suspend fun fetchAll(@Language(value = "SQL") sql: String): Result<ResultSet>

open suspend fun <T> fetchAll(statement: Statement, rowMapper: RowMapper<T>): Result<List<T>>

open suspend fun <T> fetchAll(@Language(value = "SQL") sql: String, rowMapper: RowMapper<T>): Result<List<T>>

migrate

abstract suspend fun migrate(supplier: () -> List<MigrationFile>, table: String, schema: String?, createSchema: Boolean, afterStatementExecution: suspend (Statement, Duration) -> Unit, afterFileMigration: suspend (Migration, Duration) -> Unit): Result<Migrator.Results>

abstract suspend fun migrate(path: String, table: String, schema: String?, createSchema: Boolean, afterStatementExecution: suspend (Statement, Duration) -> Unit, afterFileMigration: suspend (Migration, Duration) -> Unit): Result<Migrator.Results>

abstract suspend fun migrate(files: List<MigrationFile>, table: String, schema: String?, createSchema: Boolean, afterStatementExecution: suspend (Statement, Duration) -> Unit, afterFileMigration: suspend (Migration, Duration) -> Unit): Result<Migrator.Results>

poolIdleSize

abstract fun poolIdleSize(): Int

poolSize

abstract fun poolSize(): Int

transaction

open suspend fun <T> transaction(f: suspend Transaction.() -> T): T

transactionCatching

open suspend fun <T> transactionCatching(f: suspend Transaction.() -> T): Result<T>