Component used: Room Version used: 2.4.0-alpha04 Devices/Android versions reproduced on: Android Pixel 4A

I have an entity where I only added a new column "newColumn" between database version 1 to database version 2

@Entity(
    tableName = "SubMain",
    foreignKeys = [
        ForeignKey(
            entity = MainEntity::class,
            parentColumns = ["id"],
            childColumns = ["subId"],
            onDelete = ForeignKey.CASCADE
        ),
        ForeignKey(
            entity = SideEntity::class,
            parentColumns = ["id"],
            childColumns = ["sideId"],
            onDelete = ForeignKey.NO_ACTION
        )
    ],
    indices = [
        Index("subId"),
        Index("sideId")
    ]
)
open class SubMainEntity {

    @PrimaryKey
    @ColumnInfo(name = "id")
    var id = "random id generation goes here"

    @ColumnInfo(name = "subId")
    var subId: String? = ""

    @ColumnInfo(name = "sideId")
    var sideId: Int? = null

    @ColumnInfo(name = "text")
    var text: String? = ""

    @ColumnInfo(name = "newColumn", defaultValue = "0")
    var newColumn = false <- this is the new column I added

}

I have configured the database as such

@Database(
    version = 2,
    entities = [
        SubMainEntity::class
    ],
    autoMigrations = [
        AutoMigration(from = 1, to = 2)
    ]
)
@TypeConverters(Converters::class)
abstract class AppVolatileDatabase : RoomDatabase() { ... }

And when I run the app after the new schema files have already been generated, the app crashes and this is the error snippet that shows in the console (formatted for easier reading)

Expected:
TableInfo{name='SubMain', columns={
newColumn=Column{name='newColumn', type='INTEGER', affinity='3', notNull=true, primaryKeyPosition=0, defaultValue='0'},
subId=Column{name='subId', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'},
sideId=Column{name='sideId', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'},
id=Column{name='id', type='TEXT', affinity='2', notNull=true, primaryKeyPosition=1, defaultValue='null'},
text=Column{name='text', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'},
foreignKeys=[
ForeignKey{referenceTable='Side', onDelete='NO ACTION', onUpdate='NO ACTION', columnNames=[sideId], referenceColumnNames=[id]},
ForeignKey{referenceTable='Sub', onDelete='CASCADE', onUpdate='NO ACTION', columnNames=[subId], referenceColumnNames=[id]}
],
indices=[
Index{name='index_SubMain_subId', unique=false, columns=[subId]},
Index{name='index_SubMain_sideId', unique=false, columns=[sideId]}
]}

Found:
TableInfo{name='SubMain', columns={
subId=Column{name='subId', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'},
sideId=Column{name='sideId', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'},
id=Column{name='id', type='TEXT', affinity='2', notNull=true, primaryKeyPosition=1, defaultValue='null'},
text=Column{name='text', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'},
foreignKeys=[
ForeignKey{referenceTable='Sub', onDelete='CASCADE', onUpdate='NO ACTION', columnNames=[subId], referenceColumnNames=[id]},
ForeignKey{referenceTable='Side', onDelete='NO ACTION', onUpdate='NO ACTION', columnNames=[sideId], referenceColumnNames=[id]}
],
indices=[
Index{name='index_SubMain_subId', unique=false, columns=[subId]},
Index{name='index_SubMain_sideId', unique=false, columns=[sideId]}
]}

When I attach a debug point to TableInfo it stops at

        if (columns != null ? !columns.equals(tableInfo.columns) : tableInfo.columns != null) {
            return false;
        }

because the table count is different, which makes sense to be different since I have added a new column to the existing table, but for some reason the migration logic is not account for that even though it is very suggested that auto migrations should work straight away when we just add a new column to an existing table: https://developer.android.com/training/data-storage/room/migrating-db-versions

And the blog as well also discusses straight automigration logic for just adding a new column to exiting tables: https://medium.com/androiddevelopers/room-auto-migrations-d5370b0ca6eb

What am I doing wrong here, or is this a bug? I cannot find anything in the documentation to solve this for myself.

Issue 200818663

Links (5)

Issue metadata