DatabaseConfiguration

Artifact: androidx.room:room-runtime

View Source

Added in 2.0.0

---

Kotlin |Java

Common/AllAndroid/JVMNative/C/iOSJavaScript

• Cmn

  class DatabaseConfiguration

• android

  open class DatabaseConfiguration

---

Configuration class for a RoomDatabase.

Summary

Public constructors

DatabaseConfiguration(     name: String?,     migrationContainer: RoomDatabase.MigrationContainer,     callbacks: List<RoomDatabase.Callback>?,     journalMode: RoomDatabase.JournalMode,     requireMigration: Boolean,     allowDestructiveMigrationOnDowngrade: Boolean,     migrationNotRequiredFrom: Set<Int>?,     typeConverters: List<Any>,     autoMigrationSpecs: List<AutoMigrationSpec>,     allowDestructiveMigrationForAllTables: Boolean,     sqliteDriver: SQLiteDriver?,     queryCoroutineContext: CoroutineContext? )

N

Public functions
open Boolean	isMigrationRequired(fromVersion: Int, toVersion: Int) Returns whether a migration is required between two versions.	android
open Boolean	isMigrationRequiredFrom(version: Int) This function is deprecated. Use [isMigrationRequired(int, int)] which takes [allowDestructiveMigrationOnDowngrade] into account.	android

Public properties
Boolean	allowDestructiveMigrationForAllTables	Cmn android N
Boolean	allowDestructiveMigrationOnDowngrade	Cmn android N
Boolean	allowMainThreadQueries	android
List<AutoMigrationSpec>	autoMigrationSpecs	Cmn android N
List<RoomDatabase.Callback>?	callbacks	Cmn android N
Context	context	android
String?	copyFromAssetPath	android
File?	copyFromFile	android
Callable<InputStream>?	copyFromInputStream	android
RoomDatabase.JournalMode	journalMode	Cmn android N
RoomDatabase.MigrationContainer	migrationContainer	Cmn android N
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.	android
String?	name	Cmn android N
RoomDatabase.PrepackagedDatabaseCallback?	prepackagedDatabaseCallback	android
CoroutineContext?	queryCoroutineContext	Cmn android N
Executor	queryExecutor	android
Boolean	requireMigration	Cmn android N
SQLiteDriver?	sqliteDriver	Cmn android N
SupportSQLiteOpenHelper.Factory?	sqliteOpenHelperFactory	android
Executor	transactionExecutor	android
List<Any>	typeConverters	Cmn android N

Public constructors

DatabaseConfiguration

N

DatabaseConfiguration(
    name: String?,
    migrationContainer: RoomDatabase.MigrationContainer,
    callbacks: List<RoomDatabase.Callback>?,
    journalMode: RoomDatabase.JournalMode,
    requireMigration: Boolean,
    allowDestructiveMigrationOnDowngrade: Boolean,
    migrationNotRequiredFrom: Set<Int>?,
    typeConverters: List<Any>,
    autoMigrationSpecs: List<AutoMigrationSpec>,
    allowDestructiveMigrationForAllTables: Boolean,
    sqliteDriver: SQLiteDriver?,
    queryCoroutineContext: CoroutineContext?
)

Public functions

isMigrationRequired

android

Added in 2.1.0

open fun isMigrationRequired(fromVersion: Int, toVersion: Int): Boolean

Returns whether a migration is required between two versions.

Parameters
fromVersion: Int	The old schema version.
toVersion: Int	The new schema version.

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

isMigrationRequiredFrom

android

Added in 2.0.0

Deprecated in 2.1.0

open fun isMigrationRequiredFrom(version: Int): Boolean

This function is deprecated.
Use [isMigrationRequired(int, int)] which takes [allowDestructiveMigrationOnDowngrade] into account.

Returns whether a migration is required from the specified version.

Parameters
version: Int	The schema version.

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

Public properties

allowDestructiveMigrationForAllTables

Cmn android N

Added in 2.7.0

val allowDestructiveMigrationForAllTables: Boolean

allowDestructiveMigrationOnDowngrade

Cmn android N

Added in 2.1.0

val allowDestructiveMigrationOnDowngrade: Boolean

allowMainThreadQueries

android

Added in 2.0.0

val allowMainThreadQueries: Boolean

autoMigrationSpecs

Cmn android N

Added in 2.4.0

val autoMigrationSpecs: List<AutoMigrationSpec>

callbacks

Cmn android N

Added in 2.0.0

val callbacks: List<RoomDatabase.Callback>?

context

android

Added in 2.0.0

val context: Context

copyFromAssetPath

android

Added in 2.2.0

val copyFromAssetPath: String?

copyFromFile

android

Added in 2.2.0

val copyFromFile: File?

copyFromInputStream

android

Added in 2.3.0

val copyFromInputStream: Callable<InputStream>?

journalMode

Cmn android N

Added in 2.0.0

val journalMode: RoomDatabase.JournalMode

migrationContainer

Cmn android N

Added in 2.0.0

val migrationContainer: RoomDatabase.MigrationContainer

multiInstanceInvalidation

android

Added in 2.1.0

val multiInstanceInvalidation: 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.

name

Cmn android N

Added in 2.0.0

val name: String?

prepackagedDatabaseCallback

android

Added in 2.3.0

val prepackagedDatabaseCallback: RoomDatabase.PrepackagedDatabaseCallback?

queryCoroutineContext

Cmn android N

Added in 2.7.0

val queryCoroutineContext: CoroutineContext?

queryExecutor

android

Added in 2.0.0

val queryExecutor: Executor

requireMigration

Cmn android N

Added in 2.0.0

val requireMigration: Boolean

sqliteDriver

Cmn android N

Added in 2.7.0

val sqliteDriver: SQLiteDriver?

sqliteOpenHelperFactory

android

Added in 2.0.0

val sqliteOpenHelperFactory: SupportSQLiteOpenHelper.Factory?

transactionExecutor

android

Added in 2.1.0

val transactionExecutor: Executor

typeConverters

Cmn android N

Added in 2.3.0

val typeConverters: List<Any>