androidx.sqlite

---

Kotlin |Java

Common/AllAndroid/JVMNative/C/iOSJavaScript

Interfaces

SQLiteConnection	SQLite connection definition.	Cmn android JS
SQLiteDriver	An interface to open database connections.	Cmn android JS
SQLiteStatement	SQLite statement definition.	Cmn android JS

Exceptions

SQLiteException

An exception that indicates that something has gone wrong and a error code was produced.

Cmn android N JS

Type aliases

SQLiteException

An exception that indicates that something has gone wrong and a error code was produced.

android

Constants summary

const Int	SQLITE_DATA_BLOB = 4 The data type for a BLOB value, i.e. binary data.	Cmn
const Int	SQLITE_DATA_FLOAT = 2 The data type for a 64-bit IEEE floating point number.	Cmn
const Int	SQLITE_DATA_INTEGER = 1 The data type for a 64-bit signed integer.	Cmn
const Int	SQLITE_DATA_NULL = 5 The data type for a NULL value.	Cmn
const Int	SQLITE_DATA_TEXT = 3 The data type for a String.	Cmn

Top-level functions summary

Nothing

throwSQLiteException(errorCode: Int, errorMsg: String?) Throws a SQLiteException with its message formed by the given errorCode amd errorMsg.

Cmn

Extension functions summary

Unit	SQLiteConnection.execSQL(sql: String) Executes a single SQL statement that returns no values.	android
suspend Unit	SQLiteConnection.executeSQL(sql: String) Executes a single SQL statement asynchronously that returns no values.	Cmn android JS
suspend SQLiteConnection	SQLiteDriver.open(fileName: String) Opens a new database connection.	Cmn android JS
suspend SQLiteStatement	SQLiteConnection.prepare(sql: String) Prepares a new SQL statement asynchronously.	Cmn android JS
suspend Boolean	SQLiteStatement.step() Executes the statement asynchronously and evaluates the next result row if available.	Cmn android JS

Constants

SQLITE_DATA_BLOB

Cmn

Artifact: androidx.sqlite:sqlite

View Source

Added in 2.5.0

const val SQLITE_DATA_BLOB = 4: Int

The data type for a BLOB value, i.e. binary data.

SQLITE_DATA_FLOAT

Cmn

Artifact: androidx.sqlite:sqlite

View Source

Added in 2.5.0

const val SQLITE_DATA_FLOAT = 2: Int

The data type for a 64-bit IEEE floating point number.

SQLITE_DATA_INTEGER

Cmn

Artifact: androidx.sqlite:sqlite

View Source

Added in 2.5.0

const val SQLITE_DATA_INTEGER = 1: Int

The data type for a 64-bit signed integer.

SQLITE_DATA_NULL

Cmn

Artifact: androidx.sqlite:sqlite

View Source

Added in 2.5.0

const val SQLITE_DATA_NULL = 5: Int

The data type for a NULL value.

SQLITE_DATA_TEXT

Cmn

Artifact: androidx.sqlite:sqlite

View Source

Added in 2.5.0

const val SQLITE_DATA_TEXT = 3: Int

The data type for a String.

Top-level functions

throwSQLiteException

Cmn

Artifact: androidx.sqlite:sqlite

View Source

Added in 2.5.0

fun throwSQLiteException(errorCode: Int, errorMsg: String?): Nothing

Throws a SQLiteException with its message formed by the given errorCode amd errorMsg.

Extension functions

execSQL

android

Artifact: androidx.sqlite:sqlite

View Source

Added in 2.5.0

fun SQLiteConnection.execSQL(sql: String): Unit

Executes a single SQL statement that returns no values.

executeSQL

Cmn android JS

Artifact: androidx.sqlite:sqlite

View Source

Added in 2.7.0-alpha01

suspend fun SQLiteConnection.executeSQL(sql: String): Unit

Executes a single SQL statement asynchronously that returns no values.

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

open

Cmn android JS

Artifact: androidx.sqlite:sqlite

View Source

suspend fun SQLiteDriver.open(fileName: String): SQLiteConnection

Opens a new database connection.

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

prepare

Cmn android JS

Artifact: androidx.sqlite:sqlite

View Source

suspend fun SQLiteConnection.prepare(sql: String): SQLiteStatement

Prepares a new SQL statement asynchronously.

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

step

Cmn android JS

Artifact: androidx.sqlite:sqlite

View Source

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.