Ksqlite Kotlin API/ksqlite.kapi.statement

Package-level declarations

Types

PreparedStatement

sealed interface PreparedStatement : PreparedStatementBase, AutoCloseable

Exposes the Statement API.

PreparedStatementBase

sealed interface PreparedStatementBase

Base for all prepared statement implementations.

PreparedStatementParameters

interface PreparedStatementParameters

Exposes the API to bind values to a PreparedStatement's parameters.

Row

interface Row

Exposes the API to extract values from an SQLite row.

Functions

bindBoolean

fun PreparedStatementParameters.bindBoolean(index: Int, value: Boolean)

Sets value as the value for the parameter at index, using SQLite's own convention for booleans, 1 for true and 0 for false, since SQLite has no dedicated boolean storage class.

fun PreparedStatementParameters.bindBoolean(index: Int, value: Boolean?)

Convenience overload of bindBoolean that binds null when value is null.

bindBuffer

fun PreparedStatementParameters.bindBuffer(index: Int, value: Buffer?, cleanup: (Buffer) -> Unit? = null)

Convenience overload of bindBuffer that binds null when value is null.

bindByteArray

fun PreparedStatementParameters.bindByteArray(index: Int, value: ByteArray?, size: Int = value?.size ?: 0)

Convenience overload of bindByteArray that binds null when value is null.

bindDouble

fun PreparedStatementParameters.bindDouble(index: Int, value: Double?)

Convenience overload of bindDouble that binds null when value is null.

bindInt

fun PreparedStatementParameters.bindInt(index: Int, value: Int?)

Convenience overload of bindInt that binds null when value is null.

bindLong

fun PreparedStatementParameters.bindLong(index: Int, value: Long?)

Convenience overload of bindLong that binds null when value is null.

bindPointer

fun PreparedStatementParameters.bindPointer(index: Int, value: Any?, type: String? = null)

Convenience overload of bindPointer that binds null when value is null.

bindString

fun PreparedStatementParameters.bindString(index: Int, value: String?)

Convenience overload of bindString that binds null when value is null.

bindText

fun PreparedStatementParameters.bindText(index: Int, value: Buffer?, encoding: SqliteTextEncoding.BindText, size: Long = value?.byteSize ?: 0L, cleanup: (Buffer) -> Unit? = null)

Convenience overload of bindText that binds null when value is null.

bindValue

fun PreparedStatementParameters.bindValue(index: Int, value: Value?)

Convenience overload of bindValue that binds null when value is null.

forEachRow

inline fun PreparedStatement.forEachRow(action: (Row) -> Unit)

Calls action once for every Row produced by stepping this statement, until it's exhausted. Equivalent to manually looping on step, generateSequence(::step).forEach(action) for that matter, but without the intermediate Sequence.

getBoolean

fun Row.getBoolean(index: Int): Boolean

Returns the value of the column at index as a Boolean, using SQLite's own convention for booleans, 1 for true and 0 for false, since SQLite has no dedicated boolean storage class.