DatabaseConfiguration

public final class DatabaseConfiguration

Configuration class for a RoomDatabase.

Summary

Public fields
final boolean
final boolean
final boolean
final @NonNull List<@NonNull AutoMigrationSpec>
final List<@NonNull RoomDatabase.Callback>
final @NonNull Context
final @NonNull RoomDatabase.JournalMode
final @NonNull RoomDatabase.MigrationContainer
final boolean

If true, table invalidation in an instance of RoomDatabase is broadcast and synchronized with other instances of the same RoomDatabase file, including those in a separate process.
final String
final RoomDatabase.PrepackagedDatabaseCallback
final @NonNull CoroutineContext
final boolean
final @NonNull SQLiteDriver
final @NonNull List<@NonNull Object>

Public methods
boolean
isMigrationRequired(int fromVersion, int toVersion)

Returns whether a migration is required between two versions.

Public fields

allowDestructiveMigrationForAllTables

Added in 3.0.0-alpha01
public final boolean allowDestructiveMigrationForAllTables

allowDestructiveMigrationOnDowngrade

Added in 3.0.0-alpha01
public final boolean allowDestructiveMigrationOnDowngrade

allowMainThreadQueries

Added in 3.0.0-alpha01
public final boolean allowMainThreadQueries

autoMigrationSpecs

Added in 3.0.0-alpha01
public final @NonNull List<@NonNull AutoMigrationSpec> autoMigrationSpecs

callbacks

Added in 3.0.0-alpha01
public final List<@NonNull RoomDatabase.Callback> callbacks

context

Added in 3.0.0-alpha01
public final @NonNull Context context

journalMode

Added in 3.0.0-alpha01
public final @NonNull RoomDatabase.JournalMode journalMode

migrationContainer

Added in 3.0.0-alpha01
public final @NonNull RoomDatabase.MigrationContainer migrationContainer

multiInstanceInvalidation

Added in 3.0.0-alpha01
public final boolean multiInstanceInvalidation

If true, table invalidation in an instance of RoomDatabase is broadcast and synchronized with other instances of the same RoomDatabase file, including those in a separate process.

name

Added in 3.0.0-alpha01
public final String name

prepackagedDatabaseCallback

Added in 3.0.0-alpha01
public final RoomDatabase.PrepackagedDatabaseCallback prepackagedDatabaseCallback

queryCoroutineContext

Added in 3.0.0-alpha01
public final @NonNull CoroutineContext queryCoroutineContext

requireMigration

Added in 3.0.0-alpha01
public final boolean requireMigration

sqliteDriver

Added in 3.0.0-alpha01
public final @NonNull SQLiteDriver sqliteDriver

typeConverters

Added in 3.0.0-alpha01
public final @NonNull List<@NonNull Object> typeConverters

Public methods

isMigrationRequired

Added in 3.0.0-alpha01
public boolean isMigrationRequired(int fromVersion, int toVersion)

Returns whether a migration is required between two versions.

Parameters
int fromVersion

The old schema version.
int toVersion

The new schema version.
Returns
boolean

True if a valid migration is required, false otherwise.