Room

public class Room
extends Object

java.lang.Object
   ↳ androidx.room.Room


Utility class for Room.

Summary

Constants

String MASTER_TABLE_NAME

The master table where room keeps its metadata information.

Public constructors

Room()

This constructor is deprecated. This type should not be instantiated as it contains only static methods.

Public methods

static <T extends RoomDatabase> Builder<T> databaseBuilder(Context context, Class<T> klass, String name)

Creates a RoomDatabase.Builder for a persistent database.

static <T extends RoomDatabase> Builder<T> inMemoryDatabaseBuilder(Context context, Class<T> klass)

Creates a RoomDatabase.Builder for an in memory database.

Inherited methods

Constants

MASTER_TABLE_NAME

public static final String MASTER_TABLE_NAME

The master table where room keeps its metadata information.

Constant Value: "room_master_table"

Public constructors

Room

public Room ()

This constructor is deprecated.
This type should not be instantiated as it contains only static methods.

Public methods

databaseBuilder

public static Builder<T> databaseBuilder (Context context, 
                Class<T> klass, 
                String name)

Creates a RoomDatabase.Builder for a persistent database. Once a database is built, you should keep a reference to it and re-use it.

Parameters
context Context: The context for the database. This is usually the Application context.

klass Class: The abstract class which is annotated with Database and extends RoomDatabase.

name String: The name of the database file.

Returns
Builder<T> A RoomDatabaseBuilder<T> which you can use to create the database.

inMemoryDatabaseBuilder

public static Builder<T> inMemoryDatabaseBuilder (Context context, 
                Class<T> klass)

Creates a RoomDatabase.Builder for an in memory database. Information stored in an in memory database disappears when the process is killed. Once a database is built, you should keep a reference to it and re-use it.

Parameters
context Context: The context for the database. This is usually the Application context.

klass Class: The abstract class which is annotated with Database and extends RoomDatabase.

Returns
Builder<T> A RoomDatabaseBuilder<T> which you can use to create the database.