Summary: Constants | Methods | Inherited Methods

SQLiteRawStatement

Kotlin |Java

public final class SQLiteRawStatement
extends Object implements Closeable

java.lang.Object
↳	android.database.sqlite.SQLiteRawStatement

A SQLiteRawStatement represents a SQLite prepared statement. The methods correspond very closely to SQLite APIs that operate on a sqlite_stmt object. In general, each API in this class corresponds to a single SQLite API.

A SQLiteRawStatement must be created through a database, and there must be a transaction open at the time. Statements are implicitly closed when the outermost transaction ends, or if the current transaction is marked successful. Statements may be explicitly closed at any time with close(). The close() operation is idempotent and may be called multiple times without harm.

Multiple SQLiteRawStatements may be open simultaneously. They are independent of each other. Closing one statement does not affect any other statement nor does it have any effect on the enclosing transaction.

Once a SQLiteRawStatement has been closed, no further database operations are permitted on that statement. An IllegalStateException will be thrown if a database operation is attempted on a closed statement.

All operations on a SQLiteRawStatement must be invoked from the thread that created it. A IllegalStateException will be thrown if cross-thread use is detected.

A common pattern for statements is try-with-resources.

 // Begin a transaction.
 database.beginTransaction();
 try (SQLiteRawStatement statement = database.createRawStatement("SELECT * FROM ...")) {
     while (statement.step()) {
         // Fetch columns from the result rows.
     }
     database.setTransactionSuccessful();
 } finally {
     database.endTransaction();
 }

Note that SQLiteRawStatement is unrelated to SQLiteStatement.

See also:

sqlite3_stmt

Summary

Constants
`int`	`SQLITE_DATA_TYPE_BLOB` The constant returned by `getColumnType(int)` when the column value is SQLITE_BLOB.
`int`	`SQLITE_DATA_TYPE_FLOAT` The constant returned by `getColumnType(int)` when the column value is SQLITE_FLOAT.
`int`	`SQLITE_DATA_TYPE_INTEGER` The constant returned by `getColumnType(int)` when the column value is SQLITE_INTEGER.
`int`	`SQLITE_DATA_TYPE_NULL` The constant returned by `getColumnType(int)` when the column value is SQLITE_NULL.
`int`	`SQLITE_DATA_TYPE_TEXT` The constant returned by `getColumnType(int)` when the column value is SQLITE_TEXT.

Public methods
`void`	`bindBlob(int parameterIndex, byte[] value)` Bind a blob to a parameter.
`void`	`bindBlob(int parameterIndex, byte[] value, int offset, int length)` Bind a blob to a parameter.
`void`	`bindDouble(int parameterIndex, double value)` Bind a double to a parameter.
`void`	`bindInt(int parameterIndex, int value)` Bind an int to a parameter.
`void`	`bindLong(int parameterIndex, long value)` Bind a long to the parameter.
`void`	`bindNull(int parameterIndex)` Bind a null to the parameter.
`void`	`bindText(int parameterIndex, String value)` Bind a string to the parameter.
`void`	`clearBindings()` Clear all parameter bindings.
`void`	`close()` Close the object and release any native resources.
`byte[]`	`getColumnBlob(int columnIndex)` Return the column value of the result row as a blob.
`double`	`getColumnDouble(int columnIndex)` Return the column value as a double.
`int`	`getColumnInt(int columnIndex)` Return the column value as a int.
`int`	`getColumnLength(int columnIndex)` Return the length of the column value in the result row.
`long`	`getColumnLong(int columnIndex)` Return the column value as a long.
`String`	`getColumnName(int columnIndex)` Return the name of the column in the result row.
`String`	`getColumnText(int columnIndex)` Return the column value as a text.
`int`	`getColumnType(int columnIndex)` Return the type of the column in the result row.
`int`	`getParameterCount()` Return the number of parameters in the statement.
`int`	`getParameterIndex(String name)` Return the index of the parameter with specified name.
`String`	`getParameterName(int parameterIndex)` Return the name of the parameter at the specified index.
`int`	`getResultColumnCount()` Return the number of columns in the current result row.
`boolean`	`isOpen()` Return true if the statement is still open and false otherwise.
`int`	`readColumnBlob(int columnIndex, byte[] buffer, int offset, int length, int srcOffset)` Copy the column value of the result row, interpreted as a blob, into the buffer.
`void`	`reset()` Reset the statement.
`boolean`	`step()` Step to the next result row.
`String`	`toString()` Returns a string representation of the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.io.Closeable


      close()

Closes this stream and releases any system resources associated with it.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Parameters
`parameterIndex`	`int`: The index of the parameter in the query. It is one-based.
`value`	`byte`: The value to be bound to the parameter. This value cannot be `null`.

Throws
`IllegalStateException`	if the statement is closed or this is a foreign thread.
`SQLiteBindOrColumnIndexOutOfRangeException`	if the parameter is out of range.
`SQLiteException`	if a native error occurs.

Throws
`IllegalStateException`	if the statement is closed or this is a foreign thread.
`IllegalArgumentException`	if the sub-array exceeds the bounds of the value array.
`SQLiteBindOrColumnIndexOutOfRangeException`	if the parameter is out of range.
`SQLiteException`	if a native error occurs.

Parameters
`columnIndex`	`int`: The index of a column in the result row. It is zero-based.
`buffer`	`byte`: A pre-allocated array to be filled with the value of the column. This value cannot be `null`.
`offset`	`int`: An offset into the buffer: copying starts here.
`length`	`int`: The number of bytes to copy.
`srcOffset`	`int`: The offset into the blob from which to start copying.

Throws
`IllegalStateException`	if the statement is closed or this is a foreign thread.
`SQLiteDatabaseLockedException`	if the database is locked or busy.
`SQLiteException`	if a native error occurs.

SQLiteRawStatement

Summary

Constants

Public methods

Inherited methods

Constants

SQLITE_DATA_TYPE_BLOB

SQLITE_DATA_TYPE_FLOAT

SQLITE_DATA_TYPE_INTEGER

SQLITE_DATA_TYPE_NULL

SQLITE_DATA_TYPE_TEXT

Public methods

bindBlob

bindBlob

bindDouble

bindInt

bindLong

bindNull

bindText

clearBindings

close

getColumnBlob

getColumnDouble

getColumnInt

getColumnLength

getColumnLong

getColumnName

getColumnText

getColumnType

getParameterCount

getParameterIndex

getParameterName

getResultColumnCount

isOpen

readColumnBlob

reset

step

toString