SQLiteDatabase

CONFLICT_ABORT

static val CONFLICT_ABORT: Int

When a constraint violation occurs,no ROLLBACK is executed so changes from prior commands within the same transaction are preserved. This is the default behavior.

Value: 2

CONFLICT_FAIL

static val CONFLICT_FAIL: Int

When a constraint violation occurs, the command aborts with a return code SQLITE_CONSTRAINT. But any changes to the database that the command made prior to encountering the constraint violation are preserved and are not backed out.

Value: 3

CONFLICT_IGNORE

static val CONFLICT_IGNORE: Int

When a constraint violation occurs, the one row that contains the constraint violation is not inserted or changed. But the command continues executing normally. Other rows before and after the row that contained the constraint violation continue to be inserted or updated normally. No error is returned.

Value: 4

CONFLICT_NONE

static val CONFLICT_NONE: Int

Use the following when no conflict action is specified.

Value: 0

CONFLICT_REPLACE

static val CONFLICT_REPLACE: Int

When a UNIQUE constraint violation occurs, the pre-existing rows that are causing the constraint violation are removed prior to inserting or updating the current row. Thus the insert or update always occurs. The command continues executing normally. No error is returned. If a NOT NULL constraint violation occurs, the NULL value is replaced by the default value for that column. If the column has no default value, then the ABORT algorithm is used. If a CHECK constraint violation occurs then the IGNORE algorithm is used. When this conflict resolution strategy deletes rows in order to satisfy a constraint, it does not invoke delete triggers on those rows. This behavior might change in a future release.

Value: 5

CONFLICT_ROLLBACK

static val CONFLICT_ROLLBACK: Int

When a constraint violation occurs, an immediate ROLLBACK occurs, thus ending the current transaction, and the command aborts with a return code of SQLITE_CONSTRAINT. If no transaction is active (other than the implied transaction that is created on every command) then this algorithm works the same as ABORT.

Value: 1

CREATE_IF_NECESSARY

static val CREATE_IF_NECESSARY: Int

Open flag: Flag for #openDatabase to create the database file if it does not already exist.

Value: 268435456

ENABLE_WRITE_AHEAD_LOGGING

static val ENABLE_WRITE_AHEAD_LOGGING: Int

Open flag: Flag for #openDatabase to open the database file with write-ahead logging enabled by default. Using this flag is more efficient than calling enableWriteAheadLogging. Write-ahead logging cannot be used with read-only databases so the value of this flag is ignored if the database is opened read-only.

Value: 536870912

JOURNAL_MODE_DELETE

static val JOURNAL_MODE_DELETE: String

The DELETE journaling mode is the normal behavior. In the DELETE mode, the rollback journal is deleted at the conclusion of each transaction.

See here for more details.

Value: "DELETE"

JOURNAL_MODE_MEMORY

static val JOURNAL_MODE_MEMORY: String

The MEMORY journaling mode stores the rollback journal in volatile RAM. This saves disk I/O but at the expense of database safety and integrity. If the application using SQLite crashes in the middle of a transaction when the MEMORY journaling mode is set, then the database file will very likely go corrupt.

See here for more details.

Value: "MEMORY"

JOURNAL_MODE_OFF

static val JOURNAL_MODE_OFF: String

The OFF journaling mode disables the rollback journal completely. No rollback journal is ever created and hence there is never a rollback journal to delete. The OFF journaling mode disables the atomic commit and rollback capabilities of SQLite. The ROLLBACK command behaves in an undefined way thus applications must avoid using the ROLLBACK command. If the application crashes in the middle of a transaction, then the database file will very likely go corrupt.

See here for more details.

Value: "OFF"

JOURNAL_MODE_PERSIST

static val JOURNAL_MODE_PERSIST: String

The PERSIST journaling mode prevents the rollback journal from being deleted at the end of each transaction. Instead, the header of the journal is overwritten with zeros. This will prevent other database connections from rolling the journal back. This mode is useful as an optimization on platforms where deleting or truncating a file is much more expensive than overwriting the first block of a file with zeros.

See here for more details.

Value: "PERSIST"

JOURNAL_MODE_TRUNCATE

static val JOURNAL_MODE_TRUNCATE: String

The TRUNCATE journaling mode commits transactions by truncating the rollback journal to zero-length instead of deleting it. On many systems, truncating a file is much faster than deleting the file since the containing directory does not need to be changed.

See here for more details.

Value: "TRUNCATE"

JOURNAL_MODE_WAL

static val JOURNAL_MODE_WAL: String

The WAL journaling mode uses a write-ahead log instead of a rollback journal to implement transactions. The WAL journaling mode is persistent; after being set it stays in effect across multiple database connections and after closing and reopening the database. Performance Considerations: This mode is recommended when the goal is to improve write performance or parallel read/write performance. However, it is important to note that WAL introduces checkpoints which commit all transactions that have not been synced to the database thus to maximize read performance and lower checkpointing cost a small journal size is recommended. However, other modes such as DELETE will not perform checkpoints, so it is a trade off that needs to be considered as part of the decision of which journal mode to use.

See here for more details.

Value: "WAL"

MAX_SQL_CACHE_SIZE

static val MAX_SQL_CACHE_SIZE: Int

Absolute max value that can be set by setMaxSqlCacheSize(int). Each prepared-statement is between 1K - 6K, depending on the complexity of the SQL statement & schema. A large SQL cache may use a significant amount of memory.

Value: 100

NO_LOCALIZED_COLLATORS

static val NO_LOCALIZED_COLLATORS: Int

Open flag: Flag for #openDatabase to open the database without support for localized collators. {@more} This causes the collator LOCALIZED not to be created. You must be consistent when using this flag to use the setting the database was created with. If this is set, setLocale will do nothing.

Value: 16

OPEN_READONLY

static val OPEN_READONLY: Int

Open flag: Flag for #openDatabase to open the database for reading only. This is the only reliable way to open a database if the disk may be full.

Value: 1

OPEN_READWRITE

static val OPEN_READWRITE: Int

Open flag: Flag for #openDatabase to open the database for reading and writing. If the disk is full, this may fail even before you actually write anything. {@more} Note that the value of this flag is 0, so it is the default.

Value: 0

SQLITE_MAX_LIKE_PATTERN_LENGTH

static val SQLITE_MAX_LIKE_PATTERN_LENGTH: Int

Maximum Length Of A LIKE Or GLOB Pattern The pattern matching algorithm used in the default LIKE and GLOB implementation of SQLite can exhibit O(N^2) performance (where N is the number of characters in the pattern) for certain pathological cases. To avoid denial-of-service attacks the length of the LIKE or GLOB pattern is limited to SQLITE_MAX_LIKE_PATTERN_LENGTH bytes. The default value of this limit is 50000. A modern workstation can evaluate even a pathological LIKE or GLOB pattern of 50000 bytes relatively quickly. The denial of service problem only comes into play when the pattern length gets into millions of bytes. Nevertheless, since most useful LIKE or GLOB patterns are at most a few dozen bytes in length, cautious application developers may want to reduce this parameter to something in the range of a few hundred if they know that external users are able to generate arbitrary patterns.

Value: 50000

SYNC_MODE_EXTRA

static val SYNC_MODE_EXTRA: String

The EXTRA sync mode is like FULL sync mode with the addition that the directory containing a rollback journal is synced after that journal is unlinked to commit a transaction in DELETE journal mode. EXTRA provides additional durability if the commit is followed closely by a power loss.

See here for more details.

Value: "EXTRA"

SYNC_MODE_FULL

static val SYNC_MODE_FULL: String

In FULL sync mode the SQLite database engine will use the xSync method of the VFS to ensure that all content is safely written to the disk surface prior to continuing. This ensures that an operating system crash or power failure will not corrupt the database. FULL is very safe, but it is also slower. FULL is the most commonly used synchronous setting when not in WAL mode.

See here for more details.

Value: "FULL"

SYNC_MODE_NORMAL

static val SYNC_MODE_NORMAL: String

The NORMAL sync mode, the SQLite database engine will still sync at the most critical moments, but less often than in FULL mode. There is a very small chance that a power failure at the wrong time could corrupt the database in DELETE journal mode on an older filesystem. WAL journal mode is safe from corruption with NORMAL sync mode, and probably DELETE sync mode is safe too on modern filesystems. WAL mode is always consistent with NORMAL sync mode, but WAL mode does lose durability. A transaction committed in WAL mode with NORMAL might roll back following a power loss or system crash. Transactions are durable across application crashes regardless of the synchronous setting or journal mode. The NORMAL sync mode is a good choice for most applications running in WAL mode.

Caveat: Even though this sync mode is safe Be careful when using NORMAL sync mode when dealing with data dependencies between multiple databases, unless those databases use the same durability or are somehow synced, there could be corruption.

See here for more details.

Value: "NORMAL"

SYNC_MODE_OFF

static val SYNC_MODE_OFF: String

In OFF sync mode SQLite continues without syncing as soon as it has handed data off to the operating system. If the application running SQLite crashes, the data will be safe, but the database might become corrupted if the operating system crashes or the computer loses power before that data has been written to the disk surface. On the other hand, commits can be orders of magnitude faster with synchronous OFF.

See here for more details.

Value: "OFF"

beginTransaction

fun beginTransaction(): Unit

Begins a transaction in EXCLUSIVE mode.

Transactions can be nested. When the outer transaction is ended all of the work done in that transaction and all of the nested transactions will be committed or rolled back. The changes will be rolled back if any transaction is ended without being marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed.

Here is the standard idiom for transactions:

db.beginTransaction();
    try {
      ...
      db.setTransactionSuccessful();
    } finally {
      db.endTransaction();
    }
  

beginTransactionNonExclusive

fun beginTransactionNonExclusive(): Unit

Begins a transaction in IMMEDIATE mode. Transactions can be nested. When the outer transaction is ended all of the work done in that transaction and all of the nested transactions will be committed or rolled back. The changes will be rolled back if any transaction is ended without being marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed.

Here is the standard idiom for transactions:

db.beginTransactionNonExclusive();
    try {
      ...
      db.setTransactionSuccessful();
    } finally {
      db.endTransaction();
    }
  

beginTransactionReadOnly

fun beginTransactionReadOnly(): Unit

Begins a transaction in DEFERRED mode, with the android-specific constraint that the transaction is read-only. The database may not be modified inside a read-only transaction.

Read-only transactions may run concurrently with other read-only transactions, and if the database is in WAL mode, they may also run concurrently with IMMEDIATE or EXCLUSIVE transactions. The temp schema may be modified during a read-only transaction; if the transaction is setTransactionSuccessful, modifications to temp tables may be visible to some subsequent transactions.

Transactions can be nested. However, the behavior of the transaction is not altered by nested transactions. A nested transaction may be any of the three transaction types but if the outermost type is read-only then nested transactions remain read-only, regardless of how they are started.

Here is the standard idiom for read-only transactions:

db.beginTransactionReadOnly();
    try {
      ...
    } finally {
      db.endTransaction();
    }
  

beginTransactionWithListener

fun beginTransactionWithListener(transactionListener: SQLiteTransactionListener?): Unit

Begins a transaction in EXCLUSIVE mode.

Transactions can be nested. When the outer transaction is ended all of the work done in that transaction and all of the nested transactions will be committed or rolled back. The changes will be rolled back if any transaction is ended without being marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed.

Here is the standard idiom for transactions:

db.beginTransactionWithListener(listener);
    try {
      ...
      db.setTransactionSuccessful();
    } finally {
      db.endTransaction();
    }
  

beginTransactionWithListenerNonExclusive

fun beginTransactionWithListenerNonExclusive(transactionListener: SQLiteTransactionListener?): Unit

Begins a transaction in IMMEDIATE mode. Transactions can be nested. When the outer transaction is ended all of the work done in that transaction and all of the nested transactions will be committed or rolled back. The changes will be rolled back if any transaction is ended without being marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed.

Here is the standard idiom for transactions:

db.beginTransactionWithListenerNonExclusive(listener);
    try {
      ...
      db.setTransactionSuccessful();
    } finally {
      db.endTransaction();
    }
  

beginTransactionWithListenerReadOnly

fun beginTransactionWithListenerReadOnly(transactionListener: SQLiteTransactionListener?): Unit

Begins a transaction in read-only mode with a SQLiteTransactionListener listener. The database may not be updated inside a read-only transaction.

Transactions can be nested. However, the behavior of the transaction is not altered by nested transactions. A nested transaction may be any of the three transaction types but if the outermost type is read-only then nested transactions remain read-only, regardless of how they are started.

Here is the standard idiom for read-only transactions:

db.beginTransactionWightListenerReadOnly(listener);
    try {
      ...
    } finally {
      db.endTransaction();
    }
  

compileStatement

fun compileStatement(sql: String!): SQLiteStatement!

Compiles an SQL statement into a reusable pre-compiled statement object. The parameters are identical to execSQL(java.lang.String). You may put ?s in the statement and fill in those values with SQLiteProgram#bindString and SQLiteProgram#bindLong each time you want to run the statement. Statements may not return result sets larger than 1x1.

No two threads should be using the same SQLiteStatement at the same time.

create

static fun create(factory: SQLiteDatabase.CursorFactory?): SQLiteDatabase

Create a memory backed SQLite database. Its contents will be destroyed when the database is closed.

Sets the locale of the database to the system's current locale. Call setLocale if you would like something else.

createInMemory

static fun createInMemory(openParams: SQLiteDatabase.OpenParams): SQLiteDatabase

Create a memory backed SQLite database. Its contents will be destroyed when the database is closed.

Sets the locale of the database to the system's current locale. Call setLocale if you would like something else.

createRawStatement

fun createRawStatement(sql: String): SQLiteRawStatement

Return a SQLiteRawStatement connected to the database. A transaction must be in progress or an exception will be thrown. The resulting object will be closed automatically when the current transaction closes.

delete

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

Convenience method for deleting rows in the database.

deleteDatabase

static fun deleteDatabase(file: File): Boolean

Deletes a database including its journal file and other auxiliary files that may have been created by the database engine.

disableWriteAheadLogging

fun disableWriteAheadLogging(): Unit

This method disables the features enabled by enableWriteAheadLogging().

enableWriteAheadLogging

fun enableWriteAheadLogging(): Boolean

This method enables parallel execution of queries from multiple threads on the same database. It does this by opening multiple connections to the database and using a different database connection for each query. The database journal mode is also changed to enable writes to proceed concurrently with reads.

When write-ahead logging is not enabled (the default), it is not possible for reads and writes to occur on the database at the same time. Before modifying the database, the writer implicitly acquires an exclusive lock on the database which prevents readers from accessing the database until the write is completed.

In contrast, when write-ahead logging is enabled (by calling this method), write operations occur in a separate log file which allows reads to proceed concurrently. While a write is in progress, readers on other threads will perceive the state of the database as it was before the write began. When the write completes, readers on other threads will then perceive the new state of the database.

It is a good idea to enable write-ahead logging whenever a database will be concurrently accessed and modified by multiple threads at the same time. However, write-ahead logging uses significantly more memory than ordinary journaling because there are multiple connections to the same database. So if a database will only be used by a single thread, or if optimizing concurrency is not very important, then write-ahead logging should be disabled.

After calling this method, execution of queries in parallel is enabled as long as the database remains open. To disable execution of queries in parallel, either call disableWriteAheadLogging or close the database and reopen it.

The maximum number of connections used to execute queries in parallel is dependent upon the device memory and possibly other properties.

If a query is part of a transaction, then it is executed on the same database handle the transaction was begun.

Writers should use beginTransactionNonExclusive() or beginTransactionWithListenerNonExclusive(android.database.sqlite.SQLiteTransactionListener) to start a transaction. Non-exclusive mode allows database file to be in readable by other threads executing queries.

If the database has any attached databases, then execution of queries in parallel is NOT possible. Likewise, write-ahead logging is not supported for read-only databases or memory databases. In such cases, enableWriteAheadLogging returns false.

The best way to enable write-ahead logging is to pass the ENABLE_WRITE_AHEAD_LOGGING flag to #openDatabase. This is more efficient than calling enableWriteAheadLogging.

<code>
      SQLiteDatabase db = SQLiteDatabase.openDatabase("db_filename", cursorFactory,
              SQLiteDatabase.CREATE_IF_NECESSARY | SQLiteDatabase.ENABLE_WRITE_AHEAD_LOGGING,
              myDatabaseErrorHandler);
  </code>

Another way to enable write-ahead logging is to call enableWriteAheadLogging after opening the database.

<code>
      SQLiteDatabase db = SQLiteDatabase.openDatabase("db_filename", cursorFactory,
              SQLiteDatabase.CREATE_IF_NECESSARY, myDatabaseErrorHandler);
      db.enableWriteAheadLogging();
  </code>

See also SQLite Write-Ahead Logging for more details about how write-ahead logging works.

endTransaction

fun endTransaction(): Unit

End a transaction. See beginTransaction for notes about how to use this and when transactions are committed and rolled back.

execPerConnectionSQL

fun execPerConnectionSQL(
    sql: String, 
    bindArgs: Array<Any!>?
): Unit

Execute the given SQL statement on all connections to this database.

This statement will be immediately executed on all existing connections, and will be automatically executed on all future connections.

Some example usages are changes like PRAGMA trusted_schema=OFF or functions like SELECT icu_load_collation(). If you execute these statements using #execSQL then they will only apply to a single database connection; using this method will ensure that they are uniformly applied to all current and future connections.

execSQL

fun execSQL(sql: String!): Unit

Execute a single SQL statement that is NOT a SELECT or any other SQL statement that returns data.

It has no means to return any data (such as the number of affected rows). Instead, you're encouraged to use insert(java.lang.String,java.lang.String,android.content.ContentValues), update(java.lang.String,android.content.ContentValues,java.lang.String,java.lang.String[]), et al, when possible.

When using enableWriteAheadLogging(), journal_mode is automatically managed by this class. So, do not set journal_mode using "PRAGMA journal_mode'" statement if your app is using enableWriteAheadLogging()

Note that PRAGMA values which apply on a per-connection basis should not be configured using this method; you should instead use execPerConnectionSQL to ensure that they are uniformly applied to all current and future connections.

execSQL

fun execSQL(
    sql: String, 
    bindArgs: Array<Any!>
): Unit

Execute a single SQL statement that is NOT a SELECT/INSERT/UPDATE/DELETE.

For INSERT statements, use any of the following instead.

• insert(java.lang.String,java.lang.String,android.content.ContentValues)
• insertOrThrow(java.lang.String,java.lang.String,android.content.ContentValues)
• insertWithOnConflict(java.lang.String,java.lang.String,android.content.ContentValues,int)

For UPDATE statements, use any of the following instead.

• update(java.lang.String,android.content.ContentValues,java.lang.String,java.lang.String[])
• updateWithOnConflict(java.lang.String,android.content.ContentValues,java.lang.String,java.lang.String[],int)

For DELETE statements, use any of the following instead.

• delete(java.lang.String,java.lang.String,java.lang.String[])

For example, the following are good candidates for using this method:

• ALTER TABLE
• CREATE or DROP table / trigger / view / index / virtual table
• REINDEX
• RELEASE
• SAVEPOINT
• PRAGMA that returns no data

When using enableWriteAheadLogging(), journal_mode is automatically managed by this class. So, do not set journal_mode using "PRAGMA journal_mode'" statement if your app is using enableWriteAheadLogging()

Note that PRAGMA values which apply on a per-connection basis should not be configured using this method; you should instead use execPerConnectionSQL to ensure that they are uniformly applied to all current and future connections.

findEditTable

static fun findEditTable(tables: String!): String!

Finds the name of the first table, which is editable.

getAttachedDbs

fun getAttachedDbs(): MutableList<Pair<String!, String!>!>!

Returns list of full pathnames of all attached databases including the main database by executing 'pragma database_list' on the database.

getLastChangedRowCount

fun getLastChangedRowCount(): Long

Return the number of database rows that were inserted, updated, or deleted by the most recent SQL statement within the current transaction.

getLastInsertRowId

fun getLastInsertRowId(): Long

Return the "rowid" of the last row to be inserted on the current connection. This method must only be called when inside a transaction. IllegalStateException is thrown if the method is called outside a transaction. If the function is called before any inserts in the current transaction, the value returned will be from a previous transaction, which may be from a different thread. If no inserts have occurred on the current connection, the function returns 0. See the SQLite documentation for the specific details.

getMaximumSize

fun getMaximumSize(): Long

Returns the maximum size the database may grow to.

getPageSize

fun getPageSize(): Long

Returns the current database page size, in bytes.

getPath

fun getPath(): String!

Gets the path to the database file.

getSyncedTables

fun getSyncedTables(): MutableMap<String!, String!>!

Deprecated: This method no longer serves any useful purpose and has been deprecated.

Deprecated.

getTotalChangedRowCount

fun getTotalChangedRowCount(): Long

Return the total number of database rows that have been inserted, updated, or deleted on the current connection since it was created. Due to Android's internal management of SQLite connections, the value may, or may not, include changes made in earlier transactions. Best practice is to compare values returned within a single transaction.

database.beginTransaction();
     try {
         long initialValue = database.getTotalChangedRowCount();
         // Execute SQL statements
         long changedRows = database.getTotalChangedRowCount() - initialValue;
         // changedRows counts the total number of rows updated in the transaction.
     } finally {
         database.endTransaction();
     }
  

getVersion

fun getVersion(): Int

Gets the database version.

inTransaction

fun inTransaction(): Boolean

Returns true if the current thread has a transaction pending.

insert

fun insert(
    table: String, 
    nullColumnHack: String?, 
    values: ContentValues?
): Long

Convenience method for inserting a row into the database.

insertOrThrow

fun insertOrThrow(
    table: String, 
    nullColumnHack: String?, 
    values: ContentValues?
): Long

Convenience method for inserting a row into the database.

insertWithOnConflict

fun insertWithOnConflict(
    table: String, 
    nullColumnHack: String?, 
    initialValues: ContentValues?, 
    conflictAlgorithm: Int
): Long

General method for inserting a row into the database.

isDatabaseIntegrityOk

fun isDatabaseIntegrityOk(): Boolean

Runs 'pragma integrity_check' on the given database (and all the attached databases) and returns true if the given database (and all its attached databases) pass integrity_check, false otherwise.

If the result is false, then this method logs the errors reported by the integrity_check command execution.

Note that 'pragma integrity_check' on a database can take a long time.

isDbLockedByCurrentThread

fun isDbLockedByCurrentThread(): Boolean

Returns true if the current thread is holding an active connection to the database.

The name of this method comes from a time when having an active connection to the database meant that the thread was holding an actual lock on the database. Nowadays, there is no longer a true "database lock" although threads may block if they cannot acquire a database connection to perform a particular operation.

isDbLockedByOtherThreads

fun isDbLockedByOtherThreads(): Boolean

Deprecated: Always returns false. Do not use this method.

Always returns false.

There is no longer the concept of a database lock, so this method always returns false.

isOpen

fun isOpen(): Boolean

Returns true if the database is currently open.

isReadOnly

fun isReadOnly(): Boolean

Returns true if the database is opened as read only.

isWriteAheadLoggingEnabled

fun isWriteAheadLoggingEnabled(): Boolean

Returns true if write-ahead logging has been enabled for this database.

markTableSyncable

fun markTableSyncable(
    table: String!, 
    deletedTable: String!
): Unit

Deprecated: This method no longer serves any useful purpose and has been deprecated.

Mark this table as syncable. When an update occurs in this table the _sync_dirty field will be set to ensure proper syncing operation.

markTableSyncable

fun markTableSyncable(
    table: String!, 
    foreignKey: String!, 
    updateTable: String!
): Unit

Deprecated: This method no longer serves any useful purpose and has been deprecated.

Mark this table as syncable, with the _sync_dirty residing in another table. When an update occurs in this table the _sync_dirty field of the row in updateTable with the _id in foreignKey will be set to ensure proper syncing operation.

needUpgrade

fun needUpgrade(newVersion: Int): Boolean

Returns true if the new version code is greater than the current database version.

openDatabase

static fun openDatabase(
    path: String, 
    factory: SQLiteDatabase.CursorFactory?, 
    flags: Int
): SQLiteDatabase!

Open the database according to the flags OPEN_READWRITE OPEN_READONLY CREATE_IF_NECESSARY and/or NO_LOCALIZED_COLLATORS.

Sets the locale of the database to the system's current locale. Call setLocale if you would like something else.

openDatabase

static fun openDatabase(
    path: File, 
    openParams: SQLiteDatabase.OpenParams
): SQLiteDatabase!

Open the database according to the specified parameters

openDatabase

static fun openDatabase(
    path: String, 
    factory: SQLiteDatabase.CursorFactory?, 
    flags: Int, 
    errorHandler: DatabaseErrorHandler?
): SQLiteDatabase!

Open the database according to the flags OPEN_READWRITEOPEN_READONLYCREATE_IF_NECESSARY and/or NO_LOCALIZED_COLLATORS.

Sets the locale of the database to the system's current locale. Call setLocale if you would like something else.

Accepts input param: a concrete instance of DatabaseErrorHandler to be used to handle corruption when sqlite reports database corruption.

openOrCreateDatabase

static fun openOrCreateDatabase(
    file: File, 
    factory: SQLiteDatabase.CursorFactory?
): SQLiteDatabase!

Equivalent to openDatabase(file.getPath(), factory, CREATE_IF_NECESSARY).

openOrCreateDatabase

static fun openOrCreateDatabase(
    path: String, 
    factory: SQLiteDatabase.CursorFactory?
): SQLiteDatabase!

Equivalent to openDatabase(path, factory, CREATE_IF_NECESSARY).

openOrCreateDatabase

static fun openOrCreateDatabase(
    path: String, 
    factory: SQLiteDatabase.CursorFactory?, 
    errorHandler: DatabaseErrorHandler?
): SQLiteDatabase!

Equivalent to openDatabase(path, factory, CREATE_IF_NECESSARY, errorHandler).

query

fun query(
    distinct: Boolean, 
    table: String, 
    columns: Array<String!>?, 
    selection: String?, 
    selectionArgs: Array<String!>?, 
    groupBy: String?, 
    having: String?, 
    orderBy: String?, 
    limit: String?
): Cursor

Query the given URL, returning a Cursor over the result set.

query

fun query(
    distinct: Boolean, 
    table: String, 
    columns: Array<String!>?, 
    selection: String?, 
    selectionArgs: Array<String!>?, 
    groupBy: String?, 
    having: String?, 
    orderBy: String?, 
    limit: String?, 
    cancellationSignal: CancellationSignal?
): Cursor

Query the given URL, returning a Cursor over the result set.

query

fun query(
    table: String, 
    columns: Array<String!>?, 
    selection: String?, 
    selectionArgs: Array<String!>?, 
    groupBy: String?, 
    having: String?, 
    orderBy: String?
): Cursor

Query the given table, returning a Cursor over the result set.

query

fun query(
    table: String, 
    columns: Array<String!>?, 
    selection: String?, 
    selectionArgs: Array<String!>?, 
    groupBy: String?, 
    having: String?, 
    orderBy: String?, 
    limit: String?
): Cursor

Query the given table, returning a Cursor over the result set.

queryWithFactory

fun queryWithFactory(
    cursorFactory: SQLiteDatabase.CursorFactory?, 
    distinct: Boolean, 
    table: String, 
    columns: Array<String!>?, 
    selection: String?, 
    selectionArgs: Array<String!>?, 
    groupBy: String?, 
    having: String?, 
    orderBy: String?, 
    limit: String?
): Cursor

Query the given URL, returning a Cursor over the result set.

queryWithFactory

fun queryWithFactory(
    cursorFactory: SQLiteDatabase.CursorFactory?, 
    distinct: Boolean, 
    table: String, 
    columns: Array<String!>?, 
    selection: String?, 
    selectionArgs: Array<String!>?, 
    groupBy: String?, 
    having: String?, 
    orderBy: String?, 
    limit: String?, 
    cancellationSignal: CancellationSignal?
): Cursor

Query the given URL, returning a Cursor over the result set.

rawQuery

fun rawQuery(
    sql: String, 
    selectionArgs: Array<String!>?
): Cursor

Runs the provided SQL and returns a Cursor over the result set.

rawQuery

fun rawQuery(
    sql: String, 
    selectionArgs: Array<String!>?, 
    cancellationSignal: CancellationSignal?
): Cursor

Runs the provided SQL and returns a Cursor over the result set.

rawQueryWithFactory

fun rawQueryWithFactory(
    cursorFactory: SQLiteDatabase.CursorFactory?, 
    sql: String, 
    selectionArgs: Array<String!>?, 
    editTable: String
): Cursor

Runs the provided SQL and returns a cursor over the result set.

rawQueryWithFactory

fun rawQueryWithFactory(
    cursorFactory: SQLiteDatabase.CursorFactory?, 
    sql: String, 
    selectionArgs: Array<String!>?, 
    editTable: String, 
    cancellationSignal: CancellationSignal?
): Cursor

Runs the provided SQL and returns a cursor over the result set.

releaseMemory

static fun releaseMemory(): Int

Attempts to release memory that SQLite holds but does not require to operate properly. Typically this memory will come from the page cache.

replace

fun replace(
    table: String, 
    nullColumnHack: String?, 
    initialValues: ContentValues?
): Long

Convenience method for replacing a row in the database. Inserts a new row if a row does not already exist.

replaceOrThrow

fun replaceOrThrow(
    table: String, 
    nullColumnHack: String?, 
    initialValues: ContentValues?
): Long

Convenience method for replacing a row in the database. Inserts a new row if a row does not already exist.

setCustomAggregateFunction

fun setCustomAggregateFunction(
    functionName: String, 
    aggregateFunction: BinaryOperator<String!>
): Unit

Register a custom aggregate function that can be called from SQL expressions.

For example, registering a custom aggregation function named LONGEST could be used in a query like SELECT LONGEST(name) FROM employees.

The implementation of this method follows the reduction flow outlined in java.util.stream.Stream#reduce(BinaryOperator), and the custom aggregation function is expected to be an associative accumulation function, as defined by that class.

When attempting to register multiple functions with the same function name, SQLite will replace any previously defined functions with the latest definition, regardless of what function type they are. SQLite does not support unregistering functions.

setCustomScalarFunction

fun setCustomScalarFunction(
    functionName: String, 
    scalarFunction: UnaryOperator<String!>
): Unit

Register a custom scalar function that can be called from SQL expressions.

For example, registering a custom scalar function named REVERSE could be used in a query like SELECT REVERSE(name) FROM employees.

When attempting to register multiple functions with the same function name, SQLite will replace any previously defined functions with the latest definition, regardless of what function type they are. SQLite does not support unregistering functions.

setForeignKeyConstraintsEnabled

fun setForeignKeyConstraintsEnabled(enable: Boolean): Unit

Sets whether foreign key constraints are enabled for the database.

By default, foreign key constraints are not enforced by the database. This method allows an application to enable foreign key constraints. It must be called each time the database is opened to ensure that foreign key constraints are enabled for the session.

A good time to call this method is right after calling #openOrCreateDatabase or in the SQLiteOpenHelper#onConfigure callback.

When foreign key constraints are disabled, the database does not check whether changes to the database will violate foreign key constraints. Likewise, when foreign key constraints are disabled, the database will not execute cascade delete or update triggers. As a result, it is possible for the database state to become inconsistent. To perform a database integrity check, call isDatabaseIntegrityOk.

This method must not be called while a transaction is in progress.

See also SQLite Foreign Key Constraints for more details about foreign key constraint support.

setLocale

fun setLocale(locale: Locale!): Unit

Sets the locale for this database. Does nothing if this database has the NO_LOCALIZED_COLLATORS flag set or was opened read only.

setLockingEnabled

fun setLockingEnabled(lockingEnabled: Boolean): Unit

Deprecated: This method now does nothing. Do not use.

Control whether or not the SQLiteDatabase is made thread-safe by using locks around critical sections. This is pretty expensive, so if you know that your DB will only be used by a single thread then you should set this to false. The default is true.

setMaxSqlCacheSize

fun setMaxSqlCacheSize(cacheSize: Int): Unit

Sets the maximum size of the prepared-statement cache for this database. (size of the cache = number of compiled-sql-statements stored in the cache).

Maximum cache size can ONLY be increased from its current size (default = 10). If this method is called with smaller size than the current maximum value, then IllegalStateException is thrown.

This method is thread-safe.

setMaximumSize

fun setMaximumSize(numBytes: Long): Long

Sets the maximum size the database will grow to. The maximum size cannot be set below the current size.

setPageSize

fun setPageSize(numBytes: Long): Unit

Sets the database page size. The page size must be a power of two. This method does not work if any data has been written to the database file, and must be called right after the database has been created.

setTransactionSuccessful

fun setTransactionSuccessful(): Unit

Marks the current transaction as successful. Do not do any more database work between calling this and calling endTransaction. Do as little non-database work as possible in that situation too. If any errors are encountered between this and endTransaction the transaction will still be committed.

setVersion

fun setVersion(version: Int): Unit

Sets the database version.

toString

fun toString(): String

update

fun update(
    table: String, 
    values: ContentValues?, 
    whereClause: String?, 
    whereArgs: Array<String!>?
): Int

Convenience method for updating rows in the database.

updateWithOnConflict

fun updateWithOnConflict(
    table: String, 
    values: ContentValues?, 
    whereClause: String?, 
    whereArgs: Array<String!>?, 
    conflictAlgorithm: Int
): Int

Convenience method for updating rows in the database.

validateSql

fun validateSql(
    sql: String, 
    cancellationSignal: CancellationSignal?
): Unit

Verifies that a SQL SELECT statement is valid by compiling it. If the SQL statement is not valid, this method will throw a SQLiteException.

yieldIfContended

fun yieldIfContended(): Boolean

Deprecated: if the db is locked more than once (because of nested transactions) then the lock will not be yielded. Use yieldIfContendedSafely instead.

Temporarily end the transaction to let other threads run. The transaction is assumed to be successful so far. Do not call setTransactionSuccessful before calling this. When this returns a new transaction will have been created but not marked as successful.

yieldIfContendedSafely

fun yieldIfContendedSafely(): Boolean

Temporarily end the transaction to let other threads run. The transaction is assumed to be successful so far. Do not call setTransactionSuccessful before calling this. When this returns a new transaction will have been created but not marked as successful. This assumes that there are no nested transactions (beginTransaction has only been called once) and will throw an exception if that is not the case.

yieldIfContendedSafely

fun yieldIfContendedSafely(sleepAfterYieldDelay: Long): Boolean

Temporarily end the transaction to let other threads run. The transaction is assumed to be successful so far. Do not call setTransactionSuccessful before calling this. When this returns a new transaction will have been created but not marked as successful. This assumes that there are no nested transactions (beginTransaction has only been called once) and will throw an exception if that is not the case.

finalize

protected fun finalize(): Unit

onAllReferencesReleased

protected fun onAllReferencesReleased(): Unit