Ksqlite Kotlin API/ksqlite.kapi.statement/PreparedStatementParameters

PreparedStatementParameters

interface PreparedStatementParameters(source)

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

Binding Values To Prepared Statements

Properties

count

abstract val count: Int

Number of parameters that can be bound to.

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

abstract fun bindBuffer(index: Int, value: Buffer, size: Long = value.byteSize, cleanup: (Buffer) -> Unit? = null)

Sets the bytes buffer value as the value for the parameter at index.

bindBuffer

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

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

bindByteArray

abstract fun bindByteArray(index: Int, value: ByteArray, size: Int = value.size)

Sets the bytes buffer value as the value for the parameter at index.

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

abstract fun bindDouble(index: Int, value: Double)

Sets the 64-bit floating point value as the value for the parameter at index.

bindDouble

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

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

bindInt

abstract fun bindInt(index: Int, value: Int)

Sets the 32-bit signed integer value as the value for the parameter at index.

bindInt

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

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

bindLong

abstract fun bindLong(index: Int, value: Long)

Sets the 64-bit signed integer value as the value for the parameter at index.

bindLong

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

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

bindNull

abstract fun bindNull(index: Int)

Sets null as the value for the parameter at index.

bindPointer

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

Sets value as the value for the parameter at index.

bindPointer

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

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

bindString

abstract fun bindString(index: Int, value: String)

Sets the text value as the UTF-8 encoded value for the parameter at index.

bindString

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

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

bindText

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

Sets the text buffer value, interpreted using encoding, as the value for the parameter at index.

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

abstract fun bindValue(index: Int, value: Value)

Sets value as the value for the parameter at index. value can be a protected or unprotected SQLite value.

bindValue

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

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

bindZeroBlob

abstract fun bindZeroBlob(index: Int, size: Int)

Sets the value for the parameter at index to be a buffer of size bytes, all set to zero.

abstract fun bindZeroBlob(index: Int, size: Long)

Overload of bindZeroBlob for sizes larger than Int.MAX_VALUE.

clear

abstract fun clear()

Resets all parameters to null.

getIndex

abstract fun getIndex(name: String): Int

Returns the index of the parameter named name, or 0 if there is no matching parameter.

getName

abstract fun getName(index: Int): String?

Returns the name of the parameter at index, or null if it is unnamed or index is out of range.