Android Room Version Migration

🔥 Android Room 에서 version Migration 이 필요할 때와 사용법을 알아보자.

이번에 google play 에 업로드한 어플리케이션을 업데이트하게 되었는데, 코드 수정 중, DataBase 의 구조가 변경되는 일이 발생하였다.

개발 중이었다면, 아래 글에서 작성했던 것처럼 캐시 파일을 삭제하던가 앱 자체를 삭제하고, google 드라이브 캐시에 값이 저장되지 않도록 설정하였을 것이다.
https://velog.io/@pass/Android-Room-cannot-verify-the-data-integrity

하지만, Google Play 에서 이미 다운로드 받은 사용자가 업데이트 후에 바로 사용이 가능해야 하므로 Database 의 version 을 올리기로 하였다.
아래는 예시코드이며, version 을 2에서 3으로 migration 한 예제이다.
onOff 속성 타입만 변경되었으며, 새로운 테이블을 생성하여 대체하는 방법으로 수행하였다.

@Database(entities = [Alarm::class], version = 3)
abstract class AlarmDataBase : RoomDatabase() {
    abstract fun alarmDao(): AlarmDao

    companion object {
        @Volatile
        private var INSTANCE: AlarmDataBase? = null

        fun getInstance(context: Context): AlarmDataBase =
            INSTANCE ?: synchronized(this) {
                INSTANCE ?: buildDatabase(context).also { INSTANCE = it }
            }

        private fun buildDatabase(context: Context) =
            Room.databaseBuilder(
                context.applicationContext,
                AlarmDataBase::class.java, Constants.ALARM_DB
            )
            .addMigrations(MIGRATION_2_3)
            .build()

        private val MIGRATION_2_3: Migration = object : Migration(2, 3) {
            override fun migrate(database: SupportSQLiteDatabase) {
                // Create the new table
                database.execSQL("""
            CREATE TABLE Alarm_new (
                id INTEGER PRIMARY KEY AUTOINCREMENT,
                alarmHour TEXT NOT NULL,
                alarmMinute TEXT NOT NULL,
                onOff INTEGER NOT NULL DEFAULT 0,
                playlistId INTEGER NOT NULL,
                playlistName TEXT NOT NULL
            )
        """)

                // Copy the data
                database.execSQL("""
            INSERT INTO Alarm_new (id, alarmHour, alarmMinute, onOff, playlistId, playlistName)
            SELECT id, alarmHour, alarmMinute,CASE WHEN onOff > 0 THEN 1 ELSE 0 END AS onOff ,playlistId ,playlistName FROM Alarm
        """)

                // Remove the old table
                database.execSQL("DROP TABLE Alarm")

                // Change the table name to the correct one
                database.execSQL("ALTER TABLE Alarm_new RENAME TO Alarm")
            }
        }
    }
}