Ksqlite Kotlin API/ksqlite.kapi.statement/PreparedStatementParameters

PreparedStatementParameters

interface PreparedStatementParameters(source)

Exposes the API to deal with PreparedStatement's parameters.

Binding Values To Prepared Statements. Binding Parameters and Reusing Prepared Statements

Properties

count

abstract val count: Int

Number of parameter that can be potentially bound to.

Functions

bind

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

Sets the 64-bit floating point value as the value for the parameter at index. This function maps to sqlite3_bind_double().

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

Sets the 32-bit signed integer value as the value for the parameter at index. This function maps to sqlite3_bind_int().

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

Sets the 64-bit signed integer value as the value for the parameter at index. This function maps to sqlite3_bind_int64().

abstract fun bind(index: Int, value: Nothing?)

Sets null as the value for the parameter at index. This function maps to sqlite3_bind_null().

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

Sets the text value as the UTF-8 encoded value for the parameter at index. This function maps to sqlite3_bind_text().

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

Sets value as the value for the parameter at index. This function maps to sqlite3_bind_value().

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

Sets value as the value for the parameter at index. This function maps to sqlite3_bind_pointer().

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

Sets the bytes buffer value as the value for the parameter at index. This function maps to sqlite3_bind_blob().

abstract fun bind(index: Int, value: Nothing?, size: Int)

Sets the value for the parameter at index to be a buffer of the given size with all bytes set to zero. This function maps to sqlite3_bind_zeroblob().

abstract fun bind(index: Int, value: Nothing?, size: ULong)

Sets the value for the parameter at index to be a buffer of the given size with all bytes set to zero. This function maps to sqlite3_bind_zeroblob64().

abstract fun bind(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. This function maps to sqlite3_bind_blob64().

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

Sets the text buffer value as the value for the parameter at index. This function maps to sqlite3_bind_text64().

bind

fun PreparedStatementParameters.bind(index: Int, value: ByteArray?)

Sets the bytes buffer value as the value for the parameter at index or sets null as the value for the parameter at index if value is null.

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

Sets the 64-bit floating point value as the value for the parameter at index or sets null as the value for the parameter at index if value is null.

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

Sets the 32-bit signed integer value as the value for the parameter at index or sets null as the value for the parameter at index if value is null.

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

Sets the 64-bit signed integer value as the value for the parameter at index or sets null as the value for the parameter at index if value is null.

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

Sets the text value as the UTF-8 encoded value for the parameter at index or sets null as the value for the parameter at index if value is null.

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

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

Sets value as the value for the parameter at index or sets null as the value for the parameter at index if value is null.

clear

abstract fun clear()

Resets all host parameters to null.

getIndex

abstract fun getIndex(name: String): Int

Returns the index of an SQL parameter given its name.

getName

abstract fun getName(index: Int): String?

Returns the name of the SQL parameter at index.