Stay organized with collections
Save and categorize content based on your preferences.
added in
version 1.1.0
belongs to Maven artifact android.arch.persistence.room:runtime:1.1.0-beta2
RoomDatabase.MigrationContainer
public
static
class
RoomDatabase.MigrationContainer
extends Object
| java.lang.Object
|
| ↳ |
android.arch.persistence.room.RoomDatabase.MigrationContainer
|
A container to hold migrations. It also allows querying its contents to find migrations
between two versions.
Summary
Public methods |
|---|
void
|
addMigrations(Migration... migrations)
Adds the given migrations to the list of available migrations.
|
List<Migration>
|
findMigrationPath(int start, int end)
Finds the list of migrations that should be run to move from start version to
end version.
|
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
|
Public constructors
RoomDatabase.MigrationContainer
RoomDatabase.MigrationContainer ()
Public methods
addMigrations
void addMigrations (Migration... migrations)
Adds the given migrations to the list of available migrations. If 2 migrations have the
same start-end versions, the latter migration overrides the previous one.
| Parameters |
|---|
migrations |
Migration: List of available migrations.
|
findMigrationPath
List<Migration> findMigrationPath (int start,
int end)
Finds the list of migrations that should be run to move from start version to
end version.
| Parameters |
|---|
start |
int: The current database version |
end |
int: The target database version |
| Returns |
|---|
List<Migration> |
An ordered list of Migration objects that should be run to migrate
between the given versions. If a migration path cannot be found, returns null.
|
Annotations
Classes
Enums
Exceptions
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# RoomDatabase.MigrationContainer\n\nadded in [version 1.1.0](/topic/libraries/support-library/revisions) \nbelongs to Maven artifact android.arch.persistence.room:runtime:1.1.0-beta2 \nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nRoomDatabase.MigrationContainer\n===============================\n\n| The `android.arch` Architecture Components packages are no longer maintained. They have been superseded by the corresponding [androidx.\\*](/jetpack/androidx/migrate) packages. See [androidx.room.RoomDatabase.MigrationContainer](/reference/androidx/room/RoomDatabase.MigrationContainer) instead.\n\n\n`\npublic\nstatic\n\n\nclass\nRoomDatabase.MigrationContainer\n`\n\n\n`\n\nextends Object\n\n\n`\n\n`\n\n\n`\n\n|---|---------------------------------------------------------------|\n| java.lang.Object ||\n| ↳ | android.arch.persistence.room.RoomDatabase.MigrationContainer |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA container to hold migrations. It also allows querying its contents to find migrations\nbetween two versions.\n\nSummary\n-------\n\n| ### Public constructors ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ` `[RoomDatabase.MigrationContainer](/reference/android/arch/persistence/room/RoomDatabase.MigrationContainer#RoomDatabase.MigrationContainer())`() ` |\n\n| ### Public methods ||\n|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` void` | ` `[addMigrations](/reference/android/arch/persistence/room/RoomDatabase.MigrationContainer#addMigrations(android.arch.persistence.room.migration.Migration...))`(`[Migration...](/reference/android/arch/persistence/room/migration/Migration)` migrations) ` Adds the given migrations to the list of available migrations. |\n| ` List\u003c`[Migration](/reference/android/arch/persistence/room/migration/Migration)`\u003e` | ` `[findMigrationPath](/reference/android/arch/persistence/room/RoomDatabase.MigrationContainer#findMigrationPath(int, int))`(int start, int end) ` Finds the list of migrations that should be run to move from `start` version to `end` version. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class\u003c?\u003e` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||\n\nPublic constructors\n-------------------\n\n### RoomDatabase.MigrationContainer\n\nadded in [version 1.1.0](/topic/libraries/support-library/revisions) \n\n```\nRoomDatabase.MigrationContainer ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nPublic methods\n--------------\n\n### addMigrations\n\nadded in [version 1.1.0](/topic/libraries/support-library/revisions) \n\n```\nvoid addMigrations (Migration... migrations)\n```\n\nAdds the given migrations to the list of available migrations. If 2 migrations have the\nsame start-end versions, the latter migration overrides the previous one.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|---------------------------------------------------|\n| `migrations` | `Migration`: List of available migrations. \u003cbr /\u003e |\n\n### findMigrationPath\n\nadded in [version 1.1.0](/topic/libraries/support-library/revisions) \n\n```\nList\u003cMigration\u003e findMigrationPath (int start, \n int end)\n```\n\nFinds the list of migrations that should be run to move from `start` version to\n`end` version.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------|--------------------------------------------|\n| `start` | `int`: The current database version \u003cbr /\u003e |\n| `end` | `int`: The target database version \u003cbr /\u003e |\n\n| Returns ||\n|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `List\u003c`[Migration](/reference/android/arch/persistence/room/migration/Migration)`\u003e` | An ordered list of [Migration](/reference/android/arch/persistence/room/migration/Migration) objects that should be run to migrate between the given versions. If a migration path cannot be found, returns `null`. \u003cbr /\u003e |\n\n-\n\n Annotations\n -----------\n\n - [ColumnInfo](/reference/android/arch/persistence/room/ColumnInfo)\n - [ColumnInfo.Collate](/reference/android/arch/persistence/room/ColumnInfo.Collate)\n - [ColumnInfo.SQLiteTypeAffinity](/reference/android/arch/persistence/room/ColumnInfo.SQLiteTypeAffinity)\n - [Dao](/reference/android/arch/persistence/room/Dao)\n - [Database](/reference/android/arch/persistence/room/Database)\n - [Delete](/reference/android/arch/persistence/room/Delete)\n - [Embedded](/reference/android/arch/persistence/room/Embedded)\n - [Entity](/reference/android/arch/persistence/room/Entity)\n - [ForeignKey](/reference/android/arch/persistence/room/ForeignKey)\n - [ForeignKey.Action](/reference/android/arch/persistence/room/ForeignKey.Action)\n - [Ignore](/reference/android/arch/persistence/room/Ignore)\n - [Index](/reference/android/arch/persistence/room)\n - [Insert](/reference/android/arch/persistence/room/Insert)\n - [OnConflictStrategy](/reference/android/arch/persistence/room/OnConflictStrategy)\n - [PrimaryKey](/reference/android/arch/persistence/room/PrimaryKey)\n - [Query](/reference/android/arch/persistence/room/Query)\n - [RawQuery](/reference/android/arch/persistence/room/RawQuery)\n - [Relation](/reference/android/arch/persistence/room/Relation)\n - [SkipQueryVerification](/reference/android/arch/persistence/room/SkipQueryVerification)\n - [Transaction](/reference/android/arch/persistence/room/Transaction)\n - [TypeConverter](/reference/android/arch/persistence/room/TypeConverter)\n - [TypeConverters](/reference/android/arch/persistence/room/TypeConverters)\n - [Update](/reference/android/arch/persistence/room/Update)\n-\n\n Classes\n -------\n\n - [DatabaseConfiguration](/reference/android/arch/persistence/room/DatabaseConfiguration)\n - [InvalidationTracker](/reference/android/arch/persistence/room/InvalidationTracker)\n - [InvalidationTracker.Observer](/reference/android/arch/persistence/room/InvalidationTracker.Observer)\n - [Room](/reference/android/arch/persistence/room/Room)\n - [RoomDatabase](/reference/android/arch/persistence/room/RoomDatabase)\n - [RoomDatabase.Builder](/reference/android/arch/persistence/room/RoomDatabase.Builder)\n - [RoomDatabase.Callback](/reference/android/arch/persistence/room/RoomDatabase.Callback)\n - [RoomDatabase.MigrationContainer](/reference/android/arch/persistence/room/RoomDatabase.MigrationContainer)\n - [RoomWarnings](/reference/android/arch/persistence/room/RoomWarnings)\n - [RxRoom](/reference/android/arch/persistence/room/RxRoom)\n-\n\n Enums\n -----\n\n - [RoomDatabase.JournalMode](/reference/android/arch/persistence/room/RoomDatabase.JournalMode)\n-\n\n Exceptions\n ----------\n\n - [EmptyResultSetException](/reference/android/arch/persistence/room/EmptyResultSetException)"]]
