RoomDatabase

Kotlin |Java

abstract class RoomDatabase

kotlin.Any
↳	androidx.room.RoomDatabase

Base class for all Room databases. All classes that are annotated with Database must extend this class.

RoomDatabase provides direct access to the underlying database implementation but you should prefer using Dao classes.

Summary

Nested classes
open	`Builder` Builder for RoomDatabase.
abstract	`Callback` Callback for `RoomDatabase`.
	`JournalMode` Journal modes for SQLite database.
open	`MigrationContainer` A container to hold migrations.
abstract	`PrepackagedDatabaseCallback` Callback for `Builder#createFromAsset(String)`, `Builder#createFromFile(File)` and `Builder#createFromInputStream(Callable)`
abstract	`QueryCallback` Callback interface for when SQLite queries are executed.

Public constructors
`<init>()` Creates a RoomDatabase.

Public methods
open Unit	`beginTransaction()` Wrapper for `SupportSQLiteDatabase#beginTransaction()`.
abstract Unit	`clearAllTables()` Deletes all rows from all the tables that are registered to this database as `Database#entities()`.
open Unit	`close()` Closes the database if it is already open.
open SupportSQLiteStatement!	`compileStatement(@NonNull sql: String)` Wrapper for `SupportSQLiteDatabase#compileStatement(String)`.
open Unit	`endTransaction()` Wrapper for `SupportSQLiteDatabase#endTransaction()`.
open InvalidationTracker	`getInvalidationTracker()` Returns the invalidation tracker for this database.
open SupportSQLiteOpenHelper	`getOpenHelper()` Returns the SQLite open helper used by this database.
open Executor	`getQueryExecutor()`
open Executor	`getTransactionExecutor()`
open T?	`getTypeConverter(@NonNull klass: Class<T>)` Gets the instance of the given Type Converter.
open Boolean	`inTransaction()` Returns true if current thread is in a transaction.
open Unit	`init(@NonNull configuration: DatabaseConfiguration)` Called by `Room` when it is initialized.
open Boolean	`isOpen()` Returns true if database connection is open and initialized.
open Cursor	`query(@NonNull query: String, @Nullable args: Array<Any!>?)` Convenience method to query the database with arguments.
open Cursor	`query(@NonNull query: SupportSQLiteQuery)` Wrapper for `SupportSQLiteDatabase#query(SupportSQLiteQuery)`.
open Cursor	`query(@NonNull query: SupportSQLiteQuery, @Nullable signal: CancellationSignal?)` Wrapper for `SupportSQLiteDatabase#query(SupportSQLiteQuery)`.
open Unit	`runInTransaction(@NonNull body: Runnable)` Executes the specified `Runnable` in a database transaction.
open V	`runInTransaction(@NonNull body: Callable<V>)` Executes the specified `Callable` in a database transaction.
open Unit	`setTransactionSuccessful()` Wrapper for `SupportSQLiteDatabase#setTransactionSuccessful()`.

Protected methods
abstract InvalidationTracker	`createInvalidationTracker()` Called when the RoomDatabase is created.
abstract SupportSQLiteOpenHelper	`createOpenHelper(config: DatabaseConfiguration!)` Creates the open helper to access the database.
open MutableMap<Class<>!, MutableList<Class<>!>!>	`getRequiredTypeConverters()` Returns a Map of String -> List<Class> where each entry has the `key` as the DAO name and `value` as the list of type converter classes that are necessary for the database to function.
open Unit	`internalInitInvalidationTracker(@NonNull db: SupportSQLiteDatabase)` Called by the generated code when database is open.

Extension functions

From androidx.room

suspend R

RoomDatabase.withTransaction(block: suspend () -> R)

Calls the specified suspending block in a database transaction.

Properties
SupportSQLiteDatabase!	`mDatabase` Set by the generated open helper.

Public constructors

<init>

RoomDatabase()