DatabaseConfiguration

Added in 2.0.0

Kotlin |Java

public final class DatabaseConfiguration

Configuration class for a RoomDatabase.

Summary

Public fields
`final boolean`	`allowDestructiveMigrationForAllTables`
`final boolean`	`allowDestructiveMigrationOnDowngrade`
`final boolean`	`allowMainThreadQueries`
`final @NonNull List<@NonNull AutoMigrationSpec>`	`autoMigrationSpecs`
`final List<@NonNull RoomDatabase.Callback>`	`callbacks`
`final @NonNull Context`	`context`
`final String`	`copyFromAssetPath`
`final File`	`copyFromFile`
`final Callable<@NonNull InputStream>`	`copyFromInputStream`
`final @NonNull RoomDatabase.JournalMode`	`journalMode`
`final @NonNull RoomDatabase.MigrationContainer`	`migrationContainer`
`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.
`final String`	`name`
`final RoomDatabase.PrepackagedDatabaseCallback`	`prepackagedDatabaseCallback`
`final CoroutineContext`	`queryCoroutineContext`
`final @NonNull Executor`	`queryExecutor`
`final boolean`	`requireMigration`
`final SQLiteDriver`	`sqliteDriver`
`final SupportSQLiteOpenHelper.Factory`	`sqliteOpenHelperFactory`
`final @NonNull Executor`	`transactionExecutor`
`final @NonNull List<@NonNull Object>`	`typeConverters`

Public methods
`boolean`	`isMigrationRequired(int fromVersion, int toVersion)` Returns whether a migration is required between two versions.
`boolean`	`isMigrationRequiredFrom(int version)` This method is deprecated. Use [isMigrationRequired(int, int)] which takes [allowDestructiveMigrationOnDowngrade] into account.

Public fields

allowDestructiveMigrationForAllTables

Added in 2.7.0

public final boolean allowDestructiveMigrationForAllTables

allowDestructiveMigrationOnDowngrade

Added in 2.1.0

public final boolean allowDestructiveMigrationOnDowngrade

allowMainThreadQueries

Added in 2.0.0

public final boolean allowMainThreadQueries

autoMigrationSpecs

Added in 2.4.0

public final @NonNull List<@NonNull AutoMigrationSpec> autoMigrationSpecs

callbacks

Added in 2.0.0

public final List<@NonNull RoomDatabase.Callback> callbacks

context

Added in 2.0.0

public final @NonNull Context context

copyFromAssetPath

Added in 2.2.0

public final String copyFromAssetPath

copyFromFile

Added in 2.2.0

public final File copyFromFile

copyFromInputStream

Added in 2.3.0

public final Callable<@NonNull InputStream> copyFromInputStream

journalMode

Added in 2.0.0

public final @NonNull RoomDatabase.JournalMode journalMode

migrationContainer

Added in 2.0.0

public final @NonNull RoomDatabase.MigrationContainer migrationContainer

multiInstanceInvalidation

Added in 2.1.0

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 2.0.0

public final String name

prepackagedDatabaseCallback

Added in 2.3.0

public final RoomDatabase.PrepackagedDatabaseCallback prepackagedDatabaseCallback

queryCoroutineContext

Added in 2.7.0

public final CoroutineContext queryCoroutineContext

queryExecutor

Added in 2.0.0

public final @NonNull Executor queryExecutor

requireMigration

Added in 2.0.0

public final boolean requireMigration

sqliteDriver

Added in 2.7.0

public final SQLiteDriver sqliteDriver

sqliteOpenHelperFactory

Added in 2.0.0

public final SupportSQLiteOpenHelper.Factory sqliteOpenHelperFactory

transactionExecutor

Added in 2.1.0

public final @NonNull Executor transactionExecutor

typeConverters

Added in 2.3.0

public final @NonNull List<@NonNull Object> typeConverters

Public methods

isMigrationRequired

Added in 2.1.0

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.

isMigrationRequiredFrom

Added in 2.0.0

Deprecated in 2.1.0

public boolean isMigrationRequiredFrom(int version)

Returns whether a migration is required from the specified version.

Parameters
`int version`	The schema version.

Returns
`boolean`	True if a valid migration is required, false otherwise.