SQLiteStatement

abstract void bindBlob(@IntRange(from = 1) int index, @NonNull byte[] value)

Binds a ByteArray value to this statement at an index.

default void bindBoolean(@IntRange(from = 1) int index, boolean value)

Binds a Boolean value to this statement at an index.

abstract void bindDouble(@IntRange(from = 1) int index, double value)

Binds a Double value to this statement at an index.

default void bindFloat(@IntRange(from = 1) int index, float value)

Binds a Float value to this statement at an index.

default void bindInt(@IntRange(from = 1) int index, int value)

Binds a Int value to this statement at an index.

abstract void bindLong(@IntRange(from = 1) int index, long value)

Binds a Long value to this statement at an index.

abstract void bindNull(@IntRange(from = 1) int index)

Binds a NULL value to this statement at an index.

abstract void bindText(@IntRange(from = 1) int index, @NonNull String value)

Binds a String value to this statement at an index.

abstract void clearBindings()

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

abstract void close()

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.

abstract @NonNull byte[] getBlob(@IntRange(from = 0) int index)

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

default boolean getBoolean(@IntRange(from = 0) int index)

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

abstract int getColumnCount()

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

abstract @NonNull String getColumnName(@IntRange(from = 0) int index)

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

default @NonNull List<@NonNull String> getColumnNames()

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

abstract int getColumnType(@IntRange(from = 0) int index)

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.

abstract double getDouble(@IntRange(from = 0) int index)

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

default float getFloat(@IntRange(from = 0) int index)

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

default int getInt(@IntRange(from = 0) int index)

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

abstract long getLong(@IntRange(from = 0) int index)

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

abstract @NonNull String getText(@IntRange(from = 0) int index)

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

abstract boolean isNull(@IntRange(from = 0) int index)

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

abstract void reset()

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.

abstract boolean step()

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.

default final @NonNull R <R extends Object> SQLite.use(
    @NonNull SQLiteStatement receiver,
    @NonNull Function1<@NonNull SQLiteStatement, @NonNull R> block
)

Use the receiver statement within the block and closes it once it is done.