sqlx4k-mysql/io.github.smyrgeorge.sqlx4k.mysql

Package-level declarations

Types

interface IMySQL : Driver, Migrator.Driver

class MySQL(url: String, username: String, password: String, options: ConnectionPool.Options = ConnectionPool.Options(), val encoders: ValueEncoderRegistry = ValueEncoderRegistry()) : IMySQL

The MySQL class provides a driver implementation for interacting with a MySQL database. It supports connection pooling, transactional operations, and executing SQL queries.

class MySQL(url: String, username: String, password: String, options: ConnectionPool.Options = ConnectionPool.Options(), val encoders: ValueEncoderRegistry = ValueEncoderRegistry()) : IMySQL

The MySQL class provides a driver implementation for interacting with a MySQL database. It supports connection pooling, transactional operations, and executing SQL queries.

Properties

val fn: CPointer<CFunction<(CValue<Sqlx4kMysqlPtr>, CPointer<Sqlx4kMysqlResult>?) -> Unit>>

Functions

executeResultOrError

fun CPointer<Sqlx4kMysqlResult>?.executeResultOrError(): ExecuteResult

mySQL

expect fun mySQL(url: String, username: String, password: String, options: ConnectionPool.Options = ConnectionPool.Options(), encoders: ValueEncoderRegistry = ValueEncoderRegistry()): IMySQL

actual fun mySQL(url: String, username: String, password: String, options: ConnectionPool.Options, encoders: ValueEncoderRegistry): IMySQL

rtOrError

fun CPointer<Sqlx4kMysqlResult>?.rtOrError(): CPointer<out CPointed>

sqlx

inline suspend fun sqlx(crossinline operation: (continuationPtr: CPointer<out CPointed>) -> Unit): CPointer<Sqlx4kMysqlResult>?

throwIfError

fun CPointer<Sqlx4kMysqlResult>?.throwIfError()

fun Sqlx4kMysqlResult.throwIfError()

toExecuteResult

fun Sqlx4kMysqlResult.toExecuteResult(): ExecuteResult

MySQL reports LAST_INSERT_ID() as 0 when the statement generated no id.

toResultSet

fun Sqlx4kMysqlResult.toResultSet(): ResultSet

use

inline fun <T> CPointer<Sqlx4kMysqlResult>?.use(block: (Sqlx4kMysqlResult) -> T): T

withSingleConnection

suspend fun <T> QueryExecutor.withSingleConnection(block: suspend (QueryExecutor) -> Result<T>): Result<T>

Runs block on a single database connection: this executor itself when it already is one (a connection or a transaction), or a connection borrowed from it for the duration of block when it is a pool.