androidx.room3

A wrapper of SQLiteConnection that belongs to a connection pool and is safe to use in a coroutine.

Defines a class that can instantiate the Room generated implementation of an 'abstract' Database annotated RoomDatabase definition.

Marker interface for Room's code generated delegate.

A PooledConnection with an active transaction capable of performing nested transactions.

A PooledConnection that can perform transactions.

The invalidation tracker keeps track of tables modified by queries and notifies its created Flows about such modifications.

A Service for remote invalidation among multiple InvalidationTracker instances.

Base class for all Room databases.

Builder for RoomDatabase.

Callback for RoomDatabase

A container to hold migrations.

Callback for Builder.createFromAsset, Builder.createFromFile and Builder.createFromInputStream

A query with an argument binding function.

Available option values that can be used with Fts3, Fts4&Fts5.

Entry point for building and initializing a RoomDatabase.

The list of warnings that are produced by Room.

Declares an automatic migration on a Database.

Control flags for built-in column type converters.

Allows specific customization about the column associated with the annotated property.

The SQLite column type constants that can be used in ColumnInfo.typeAffinity

Marks a function as a column type converter.

Registers additional ColumnTypeConverter functions for Room.

Defines the androidx.room3.RoomDatabaseConstructor that will instantiate the Room generated implementation of the annotated Database.

Marks the class as a Data Access Object.

Marks a function as a DAO function return type converter.

Specifies the classes that contain DAO return type converters that a RoomDatabase can use.

Marks a class as a androidx.room3.RoomDatabase.

Marks a class as an SQLite view.

Marks a function in a Dao annotated class as a delete function.

Repeatable annotation declaring the deleted columns in the AutoMigration.to version of an auto migration.

Container annotation for the repeatable annotation DeleteColumn.

Repeatable annotation declaring the deleted tables in the AutoMigration.to version of an auto migration.

Container annotation for the repeatable annotation DeleteTable.

Marks a property of an Entity or data object to allow nested properties (i.e. properties of the annotated property's class) to be referenced directly in the SQL queries.

Marks a class as an entity.

Marks declarations that are experimental in Room's APIs, which means that the design of the corresponding declarations may (or may not) lead to their changes in the future.

Declares a foreign key on another Entity.

Constants definition for values that can be used in onDelete and onUpdate.

Marks an Entity annotated class as a FTS3 entity.

Marks an Entity annotated class as a FTS4 entity.

Marks an Entity annotated class as a FTS5 entity.

Ignores the marked element from Room's processing logic.

Declares an index on an Entity.

Marks a function in a Dao annotated class as an insert function.

Declares a junction to be used for joining a relationship.

Declares which column is used to build a map or multimap return value in a Dao query function.

Set of conflict handling strategies for various Dao functions.

Marks a property in an Entity as the primary key.

Marks a androidx.room3.migration.AutoMigrationSpec class that will be provided to Room at runtime.

Marks a class containing ColumnTypeConverter functions provided to Room at runtime.

Marks a class containing DaoReturnTypeConverter functions that will be provided to Room at runtime.

Marks a function in a Dao annotated class as a query function.

Marks a function in a Dao annotated class as a raw query function where the query is pass as a parameter of types androidx.room3.RoomRawQuery or androidx.sqlite.db.SupportSQLiteQuery.

A convenience annotation which can be used in a data object class to automatically fetch relation entities.

Repeatable annotation declaring the renamed columns in the AutoMigration.to version of an auto migration.

Container annotation for the repeatable annotation RenameColumn.

Repeatable annotation declaring the renamed tables in the new version of an auto migration.

Container annotation for the repeatable annotation RenameTable.

When present, RewriteQueriesToDropUnusedColumns annotation will cause Room to rewrite your Query functions such that only the columns that are used in the return type are queried from the database.

Skips database verification for the annotated element.

Marks a function in a Dao class as a transaction function.

Marks a function in a Dao annotated class as an update function.

Marks a function in a Dao annotated class as an upsert (insert or update) function.

Control flags for built-in converters.

Describes the type of database operation a DaoReturnTypeConverter function supports.

The PrimaryKey auto-generate algorithms.

Journal modes for SQLite database.

Transaction types.

Performs a SQLiteTransactionType.DEFERRED within the block.

Performs a SQLiteTransactionType.EXCLUSIVE within the block.

Executes a single SQL statement that returns no values.

Performs a SQLiteTransactionType.IMMEDIATE within the block.

Acquires a READ connection, suspending while waiting if none is available and then calling the block to use the connection once it is acquired.

Acquires a WRITE connection, suspending while waiting if none is available and then calling the block to use the connection once it is acquired.

Acquire a READ connection and start a Transactor.SQLiteTransactionType.DEFERRED transaction to execute the given block within the transaction.

Acquire a WRITE connection and start a Transactor.SQLiteTransactionType.IMMEDIATE transaction to execute the given block within the transaction.