SQLiteRawStatement

Kotlin |Java

class SQLiteRawStatement : Closeable

kotlin.Any
↳	android.database.sqlite.SQLiteRawStatement

A 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.

<code>
  // 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();
  }
  </code>

Note that SQLiteRawStatement is unrelated to SQLiteStatement.

Summary

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

Public methods
Unit	`bindBlob(parameterIndex: Int, value: ByteArray)` Bind a blob to a parameter.
Unit	`bindBlob(parameterIndex: Int, value: ByteArray, offset: Int, length: Int)` Bind a blob to a parameter.
Unit	`bindDouble(parameterIndex: Int, value: Double)` Bind a double to a parameter.
Unit	`bindInt(parameterIndex: Int, value: Int)` Bind an int to a parameter.
Unit	`bindLong(parameterIndex: Int, value: Long)` Bind a long to the parameter.
Unit	`bindNull(parameterIndex: Int)` Bind a null to the parameter.
Unit	`bindText(parameterIndex: Int, value: String)` Bind a string to the parameter.
Unit	`clearBindings()` Clear all parameter bindings.
Unit	`close()` Close the object and release any native resources.
ByteArray?	`getColumnBlob(columnIndex: Int)` Return the column value of the result row as a blob.
Double	`getColumnDouble(columnIndex: Int)` Return the column value as a double.
Int	`getColumnInt(columnIndex: Int)` Return the column value as a int.
Int	`getColumnLength(columnIndex: Int)` Return the length of the column value in the result row.
Long	`getColumnLong(columnIndex: Int)` Return the column value as a long.
String	`getColumnName(columnIndex: Int)` Return the name of the column in the result row.
String	`getColumnText(columnIndex: Int)` Return the column value as a text.
Int	`getColumnType(columnIndex: Int)` Return the type of the column in the result row.
Int	`getParameterCount()` Return the number of parameters in the statement.
Int	`getParameterIndex(name: String)` Return the index of the parameter with specified name.
String?	`getParameterName(parameterIndex: Int)` 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(columnIndex: Int, buffer: ByteArray, offset: Int, length: Int, srcOffset: Int)` Copy the column value of the result row, interpreted as a blob, into the buffer.
Unit	`reset()` Reset the statement.
Boolean	`step()` Step to the next result row.
String	`toString()`

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

Exceptions
`java.lang.IllegalStateException`	if the statement is closed or this is a foreign thread.
`android.database.sqlite.SQLiteBindOrColumnIndexOutOfRangeException`	if the parameter is out of range.
`android.database.sqlite.SQLiteException`	if a native error occurs.

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

Exceptions
`java.lang.Exception`	if this resource cannot be closed
`java.io.IOException`	if an I/O error occurs

Parameters
`columnIndex`	Int: The index of a column in the result row. It is zero-based.
`buffer`	ByteArray: 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.

Exceptions
`java.lang.IllegalStateException`	if the statement is closed or this is a foreign thread.
`android.database.sqlite.SQLiteDatabaseLockedException`	if the database is locked or busy.
`android.database.sqlite.SQLiteException`	if a native error occurs.

SQLiteRawStatement

Summary

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