selekt-android/com.bloomberg.selekt.android/SQLiteDatabase

SQLiteDatabase

@ThreadSafe

class SQLiteDatabase : Closeable(source)

Mirrors the Android SDK APIs.

Since

0.1.0.

Types

Companion

object Companion

Properties

autoVacuum

var autoVacuum: SQLiteAutoVacuumMode

Auto-vacuuming is only possible if the database stores some additional information that allows each database page to be traced backwards to its referrer. Therefore, auto-vacuuming must be turned on before any tables are created. It is not possible to enable or disable auto-vacuum after a table has been created.

isConnectionHeldByCurrentThread

val isConnectionHeldByCurrentThread: Boolean

Get whether this thread currently holds a connection to the database.

isInterrupted

val isInterrupted: Boolean

Returns true if any database connection managed by this database has been interrupted and has not yet completed. This method is safe to call from any thread.

isOpen

val isOpen: Boolean

isTransactionOpenedByCurrentThread

val isTransactionOpenedByCurrentThread: Boolean

Get whether the current thread has an open transaction.

journalMode

val journalMode: SQLiteJournalMode

maximumSize

val maximumSize: Long

maxPageCount

val maxPageCount: Long

val pageCount: Int

var pageSize: Long

val path: String

var version: Int

Functions

batch

fun batch(sql: String, bindArgs: Stream<Array<out Any?>>): Int

fun batch(sql: String, bindArgs: Iterable<Array<out Any?>>): Int

fun batch(sql: String, bindArgs: Sequence<Array<out Any?>>): Int

Transacts to the database in exclusive mode a batch of queries with the same underlying SQL statement. The prototypical use case is for database modifications inside a tight loop to which this is optimised.

beginExclusiveTransaction

@DelicateApi

fun beginExclusiveTransaction()

Begins a transaction in exclusive mode. Prefer transact whenever possible.

beginExclusiveTransactionWithListener

@DelicateApi

fun beginExclusiveTransactionWithListener(listener: SQLTransactionListener)

beginImmediateTransaction

@DelicateApi

fun beginImmediateTransaction()

Begins a transaction in immediate mode. Prefer transact whenever possible.

beginImmediateTransactionWithListener

@DelicateApi

fun beginImmediateTransactionWithListener(listener: SQLTransactionListener)

open override fun close()

compileStatement

fun compileStatement(sql: String): ISQLStatement

databaseConfig

fun databaseConfig(op: Int, value: Int)

Configures a database connection using sqlite3_db_config. This is intended for boolean-style configuration options such as SQLITE_DBCONFIG_DEFENSIVE (1010).

delete

fun delete(table: String, whereClause: String?, whereArgs: Array<out Any?>?): Int

endTransaction

@DelicateApi

fun endTransaction()

exec

fun exec(sql: String)

fun exec(sql: String, @Size(min = 1) bindArgs: Array<out Any?>)

incrementalVacuum

fun incrementalVacuum()

The incremental vacuum pragma causes pages to be removed from the freelist. The database file is truncated by the same number of pages. The incremental vacuum pragma has no effect if the database is not already in incremental vacuum mode or if there are no pages on the freelist.

fun incrementalVacuum(pages: Int)

The incremental vacuum pragma causes up to N pages to be removed from the freelist. The database file is truncated by the same amount. The incremental vacuum pragma has no effect if the database is not already in incremental mode or if there are no pages on the freelist. If there are fewer on the freelist, or if pages is less than 1, then the entire freelist is cleared.

insert

fun insert(table: String, values: ContentValues, conflictAlgorithm: ConflictAlgorithm): Long

integrityCheck

fun integrityCheck(name: String = "main"): Boolean

interrupt

fun interrupt()

Interrupts all database connections managed by this database. This causes any pending database operations on those connections to abort and return at the earliest opportunity. This method is safe to call from any thread.

query

fun query(query: ISQLQuery): Cursor

fun query(sql: String, selectionArgs: Array<out Any?>?): Cursor

fun query(distinct: Boolean, table: String, columns: Array<out String>?, selection: String?, selectionArgs: Array<out Any?>?, groupBy: String? = null, having: String? = null, limit: Int? = null, orderBy: String? = null): Cursor

fun query(query: ISQLQuery, cancellationSignal: CancellationSignal): Cursor

fun query(sql: String, selectionArgs: Array<out Any?>?, cancellationSignal: CancellationSignal): Cursor

Executes a cancellable query. If the cancellationSignal is cancelled from another thread, the query will be aborted at the earliest opportunity and an OperationCancelledException will be thrown.

readFromBlob

fun readFromBlob(table: String, column: String, row: Long, offset: Int, limit: Int, stream: OutputStream)

fun readFromBlob(name: String, table: String, column: String, row: Long, offset: Int, limit: Int, stream: OutputStream)

setForeignKeyConstraintsEnabled

fun setForeignKeyConstraintsEnabled(enabled: Boolean)

Setting foreign key constraints is not possible within a transaction; foreign key constraint enforcement may only be enabled or disabled when there are no pending transactions.

setMaximumSize

fun setMaximumSize(bytes: Long): Long

setProgressHandler

fun setProgressHandler(instructionCount: Int, handler: SQLProgressHandler?)

Registers a progress handler that is invoked periodically during long-running SQL statements on all database connections managed by this database. If the handler returns non-zero, the operation is interrupted.

setTransactionSuccessful

@DelicateApi

fun setTransactionSuccessful()

sizeOfBlob

fun sizeOfBlob(table: String, column: String, row: Long): Int

fun sizeOfBlob(name: String, table: String, column: String, row: Long): Int

transact

fun <T> transact(transactionMode: SQLiteTransactionMode = SQLiteTransactionMode.EXCLUSIVE, block: SQLiteDatabase.() -> T): T

Execute a block inside either an exclusive or an immediate database transaction. These transaction modes are the same in WAL-journal mode; in other journal modes, exclusive transaction mode prevents other connections from reading the database while the transaction is underway.

update

fun update(table: String, values: ContentValues, whereClause: String?, whereArgs: Array<out Any?>?, conflictAlgorithm: ConflictAlgorithm): Int

upsert

fun upsert(table: String, values: ContentValues, columns: Array<out String>, update: String): Long

vacuum

fun vacuum()

The vacuum command rebuilds the database file, repacking it into a minimal amount of disk space.

writeToBlob

fun writeToBlob(table: String, column: String, row: Long, offset: Int, stream: InputStream)

fun writeToBlob(name: String, table: String, column: String, row: Long, offset: Int, stream: InputStream)

Modifies the contents of a blob; it is not possible to increase the size of a blob using this method.

yieldTransaction

@JvmOverloads

fun yieldTransaction(@IntRange(from = 0) pauseMillis: Long = 0): Boolean

Temporarily end the transaction to allow other threads to make progress. The transaction is assumed to be successful thus far and committed, do not call setTransactionSuccessful. When this method returns a new transaction will have been created but not yet marked as successful.