SQLiteStatement

Kotlin |Java

class SQLiteStatement : SQLiteProgram

kotlin.Any
↳	android.database.sqlite.SQLiteClosable
	↳	android.database.sqlite.SQLiteProgram
		↳	android.database.sqlite.SQLiteStatement

Represents a statement that can be executed against a database. The statement cannot return multiple rows or columns, but single value (1 x 1) result sets are supported.

This class is not thread-safe.

Summary

Public methods
Unit	`execute()` Execute this SQL statement, if it is not a SELECT / INSERT / DELETE / UPDATE, for example CREATE / DROP table, view, trigger, index etc.
Long	`executeInsert()` Execute this SQL statement and return the ID of the row inserted due to this call.
Int	`executeUpdateDelete()` Execute this SQL statement, if the number of rows affected by execution of this SQL statement is of any importance to the caller - for example, UPDATE / DELETE SQL statements.
ParcelFileDescriptor!	`simpleQueryForBlobFileDescriptor()` Executes a statement that returns a 1 by 1 table with a blob value.
Long	`simpleQueryForLong()` Execute a statement that returns a 1 by 1 table with a numeric value.
String!	`simpleQueryForString()` Execute a statement that returns a 1 by 1 table with a text value.
String	`toString()`

Inherited functions

From class SQLiteClosable

`Unit`	`acquireReference()` Acquires a reference to the object.
`Unit`	`close()` Releases a reference to the object, closing the object if the last reference was released. Calling this method is equivalent to calling `releaseReference`.
`Unit`	`onAllReferencesReleasedFromContainer()` Called when the last reference to the object was released by a call to `releaseReferenceFromContainer()`.
`Unit`	`releaseReference()` Releases a reference to the object, closing the object if the last reference was released.
`Unit`	`releaseReferenceFromContainer()` Releases a reference to the object that was owned by the container of the object, closing the object if the last reference was released.

From class SQLiteProgram

`Unit`	`bindAllArgsAsStrings(bindArgs: Array<String!>!)` Given an array of String bindArgs, this method binds all of them in one single call.
`Unit`	`bindBlob(index: Int, value: ByteArray!)` Bind a byte array value to this statement. The value remains bound until `clearBindings` is called.
`Unit`	`bindDouble(index: Int, value: Double)` Bind a double value to this statement. The value remains bound until `clearBindings` is called.
`Unit`	`bindLong(index: Int, value: Long)` Bind a long value to this statement. The value remains bound until `clearBindings` is called. addToBindArgs
`Unit`	`bindNull(index: Int)` Bind a NULL value to this statement. The value remains bound until `clearBindings` is called.
`Unit`	`bindString(index: Int, value: String!)` Bind a String value to this statement. The value remains bound until `clearBindings` is called.
`Unit`	`clearBindings()` Clears all existing bindings. Unset bindings are treated as NULL.
`Int`	`getUniqueId()` Unimplemented.
`Unit`	`onAllReferencesReleased()`

Public methods

execute

Added in API level 1

fun execute(): Unit

Execute this SQL statement, if it is not a SELECT / INSERT / DELETE / UPDATE, for example CREATE / DROP table, view, trigger, index etc.

Exceptions
`android.database.SQLException`	If the SQL string is invalid for some reason

executeInsert

Added in API level 1

fun executeInsert(): Long

Execute this SQL statement and return the ID of the row inserted due to this call. The SQL statement should be an INSERT for this to be a useful call.

Return
`Long`	the row ID of the last row inserted, if this insert is successful. -1 otherwise.

Exceptions
`android.database.SQLException`	If the SQL string is invalid for some reason

executeUpdateDelete

Added in API level 11

fun executeUpdateDelete(): Int

Execute this SQL statement, if the number of rows affected by execution of this SQL statement is of any importance to the caller - for example, UPDATE / DELETE SQL statements.

Return
`Int`	the number of rows affected by this SQL statement execution.

Exceptions
`android.database.SQLException`	If the SQL string is invalid for some reason

simpleQueryForBlobFileDescriptor

Added in API level 11

fun simpleQueryForBlobFileDescriptor(): ParcelFileDescriptor!

Executes a statement that returns a 1 by 1 table with a blob value.

Return
`ParcelFileDescriptor!`	A read-only file descriptor for a copy of the blob value, or `null` if the value is null or could not be read for some reason.

Exceptions
`android.database.sqlite.SQLiteDoneException`	if the query returns zero rows

simpleQueryForLong

Added in API level 1

fun simpleQueryForLong(): Long

Execute a statement that returns a 1 by 1 table with a numeric value. For example, SELECT COUNT(*) FROM table;

Return
`Long`	The result of the query.

Exceptions
`android.database.sqlite.SQLiteDoneException`	if the query returns zero rows

simpleQueryForString

Added in API level 1

fun simpleQueryForString(): String!

Execute a statement that returns a 1 by 1 table with a text value. For example, SELECT COUNT(*) FROM table;

Return
`String!`	The result of the query.

Exceptions
`android.database.sqlite.SQLiteDoneException`	if the query returns zero rows

toString

Added in API level 1

fun toString(): String

Return
`String`	a string representation of the object.