SQLiteStatement

fun bindBlob(index: @IntRange(from = 1) Int, value: ByteArray): Unit

Binds a ByteArray value to this statement at an index.

fun bindBoolean(index: @IntRange(from = 1) Int, value: Boolean): Unit

Binds a Boolean value to this statement at an index.

fun bindDouble(index: @IntRange(from = 1) Int, value: Double): Unit

Binds a Double value to this statement at an index.

fun bindFloat(index: @IntRange(from = 1) Int, value: Float): Unit

Binds a Float value to this statement at an index.

fun bindInt(index: @IntRange(from = 1) Int, value: Int): Unit

Binds a Int value to this statement at an index.

fun bindLong(index: @IntRange(from = 1) Int, value: Long): Unit

Binds a Long value to this statement at an index.

fun bindNull(index: @IntRange(from = 1) Int): Unit

Binds a NULL value to this statement at an index.

fun bindText(index: @IntRange(from = 1) Int, value: String): Unit

Binds a String value to this statement at an index.

fun clearBindings(): Unit

Clears all parameter bindings. Unset bindings are treated as NULL.

fun close(): Unit

Closes the statement.

Once a statement is closed it should no longer be used. Calling this function on an already closed statement is a no-op.

fun getBlob(index: @IntRange(from = 0) Int): ByteArray

Returns the value of the column at index as a ByteArray.

fun getBoolean(index: @IntRange(from = 0) Int): Boolean

Returns the value of the column at index as a Boolean.

fun getColumnCount(): Int

Returns the number of columns in the result of the statement.

fun getColumnName(index: @IntRange(from = 0) Int): String

Returns the name of a column at index in the result of the statement.

fun getColumnNames(): List<String>

Returns the name of the columns in the result of the statement ordered by their index.

fun getColumnType(index: @IntRange(from = 0) Int): Int

Returns the data type of a column at index in the result of the statement.

The data type can be used to determine the preferred get*() function to be used for the column but other getters may perform data type conversion.

fun getDouble(index: @IntRange(from = 0) Int): Double

Returns the value of the column at index as a Double.

fun getFloat(index: @IntRange(from = 0) Int): Float

Returns the value of the column at index as a Float.

fun getInt(index: @IntRange(from = 0) Int): Int

Returns the value of the column at index as a Int.

fun getLong(index: @IntRange(from = 0) Int): Long

Returns the value of the column at index as a Long.

fun getText(index: @IntRange(from = 0) Int): String

Returns the value of the column at index as a String.

fun isNull(index: @IntRange(from = 0) Int): Boolean

Returns true if the value of the column at index is NULL.

fun reset(): Unit

Resets the prepared statement back to initial state so that it can be re-executed via step. Any parameter bound via the bind*() APIs will retain their value.

fun step(): Boolean

Executes the statement and evaluates the next result row if available.

A statement is initially prepared and compiled but is not executed until one or more calls to this function. If the statement execution produces result rows then this function will return true indicating there is a new row of data ready to be read.

suspend fun stepAsync(): Boolean

Executes the statement asynchronously and evaluates the next result row if available.

A statement is initially prepared and compiled but is not executed until one or more calls to this function. If the statement execution produces result rows then this function will return true indicating there is a new row of data ready to be read.

suspend fun SQLiteStatement.step(): Boolean

Executes the statement asynchronously and evaluates the next result row if available.

On web targets this function is asynchronous while for non-web it is synchronous.