[AutoMigration] Migrating table with column "index" [197133152]

Fixed

Bug

Status Update

No update yet.

Description

ne...@gmail.com

created issue #1

Aug 19, 2021 07:30AM

Component

Component used:
- room-compiler
Version used:
- 2.4.0-alpha04
Devices/Android versions reproduced on:
- Runtime migration issue on every device / Emulator Android 12, Pixel 5

Description

Adding column name with SQL keyword makes the compiler fail to escape the keyword and thereafter fail to migrate the database.

I seem to be unable to escape this even with the RenameColumn and DeleteColumn as they seek the exact names and therefore will skip escaping with `.

Proposed Solution

Have the compiler escape SQL keywords in column and table names.

Code sample

Before:

@Entity(tableName = "foobar")
data class FooBar(
  // ...
  @ColumnInfo(name = "index") val position: Int
)

After:

@Entity(tableName = "foobar")
data class FooBar(
  // ...
  @ColumnInfo(name = "position") val position: Int
)

@RenameColumn.Entries(
  value = [
    RenameColumn(
      tableName = "foobar",
      fromColumnName = "index",
      toColumnName = "position"
    )
  ]
)
class MyMigrationSpec : AutoMigrationSpec

Comments

da...@google.com <da...@google.com> Aug 19, 2021 11:58AM

Reassigned to el...@google.com.

el...@google.com <el...@google.com> Oct 27, 2021 05:33PM

Marked as fixed.

ap...@google.com <ap...@google.com> #2Oct 27, 2021 05:34PM

Project: platform/frameworks/support
Branch: androidx-main

commit 10279986f24d1648952e740ea38c72b7bc44fdc7
Author: Elif Bilgin <elifbilgin@google.com>
Date: Tue Oct 26 16:59:42 2021

Resolving auto migration issue where SQLite keywords are failed to be escaped in column names.

The issue was arising from the part of AutoMigrationWriter generating code to transfer data from the old table to the new table, preserving the order of the columns. The SQL statement used did not utilize `` to escape the column names, resulting in a compiler error in scenarios where a SQLite keyword was being used as a column name.

Issue was repro'd in the tests by using the column name "index" and confirming the escape is working as expected with the new changes.

Test: AutoMigrationTest.java
Bug: 197133152
Change-Id: Idbed488acb2027fb1c0d9c302d1cc83ed5bfba2c

M room/room-compiler/src/main/kotlin/androidx/room/writer/AutoMigrationWriter.kt
M room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/migration/AutoMigrationDb.java
M room/integration-tests/testapp/schemas/androidx.room.integration.testapp.migration.AutoMigrationDb/1.json

https://android-review.googlesource.com/1870037

Issue 197133152

Description

Component

Description

Proposed Solution

Code sample

Issue summary

Comments

da...@google.com <da...@google.com> Aug 19, 2021 11:58AM

el...@google.com <el...@google.com> Oct 27, 2021 05:33PM

ap...@google.com <ap...@google.com> #2Oct 27, 2021 05:34PM

Add comment

Issue metadata