Migrate Kotlin Multiplatform SQLite and Room snippets by erikrodriguez-se · Pull Request #1141 · android/snippets

erikrodriguez-se · 2026-09-29T03:23:25Z

Code snippets are for:

List of modifications:

Sqlite page: In android_kmp_sqlite_transaction, android_kmp_sqlite_query_no_result, and android_kmp_sqlite_query_result_no_args, the page's placeholder val connection: SQLiteConnection = ... is replaced with the visible binding val connection: SQLiteConnection = BundledSQLiteDriver().open("todos.db") (per review).
Sqlite page: In android_kmp_sqlite_transaction, android_kmp_sqlite_query_result_no_args, and android_kmp_sqlite_query_result_with_args, added trailing periods to inline comments per D29.
Room page: In android_kmp_room_migration, android_kmp_room_auto_migration_spec, and android_kmp_room_callback, added the suspend modifier required by androidx.room3:room3-runtime:3.0.1 (D17) and normalized Unicode horizontal ellipses (// …) to ASCII // ... (D22).
Room page: In android_kmp_room_suspend_transaction, normalized { … } to multi-line // ... per D22 and Spotless formatting.
Room page: In android_kmp_room_write_transaction and android_kmp_room_read_transaction, the page's placeholder val database: RoomDatabase = … is replaced with the visible binding val database: RoomDatabase = getRoomDatabase(builder) (per review), and added trailing periods to inline comments per D29.

Build configuration:

kmp/shared/build.gradle.kts: added the KSP and Room 3 plugins, room3-runtime and sqlite-bundled dependencies, the Room compiler for the Android and iOS KSP targets, and the room3 schema directory. Also added the missing newline at end of file (per review).
kmp/shared/lint.xml (new): ignores RestrictedApi only under build/generated/**. This fixes the failing build check: :kmp:shared:lintAndroidMain reported 77 RestrictedApi errors, all in Room's KSP-generated AppDatabase_Impl (63) and TodoDao_Impl (14), which override androidx.room3 APIs annotated @RestrictTo(LIBRARY_GROUP_PREFIX). None were in the snippet sources, and hand-written code is still checked.
- Why :room doesn't need this: the KMP Android library plugin (com.android.kotlin.multiplatform.library) lists the KSP output directory as a regular source directory in the lint model, so lint analyzes the generated code. :room uses com.android.library, where lint skips generated sources by default.
- This follows the existing lint.xml path-ignore pattern in wear/lint.xml and compose/snippets/lint.xml.
- Alternative for the reviewer to decide: disable the check for the whole module in kmp/shared/build.gradle.kts (kotlin { android { lint { disable += "RestrictedApi" } } }), similar to disable += "UseKtx" in xr/build.gradle.kts. That's a smaller diff with no new file, but it also hides RestrictedApi in any future hand-written :kmp:shared snippet. I went with the narrower lint.xml approach; happy to switch if you prefer.

Snippets not migrated:

Sqlite page, Lines 24-37 because it is a Gradle version catalog (libs.versions.toml) block using DevSite template variable {{androidx_sqlite_stable}} (D27)
Sqlite page, Lines 208-217, 221-224, 228-237, and 241-249 because they are legacy Android-only SupportSQLiteDatabase blocks written for an earlier version of an API as part of migration guidance
Room page, Lines 24-41, 50-55, 59-69, 79-87, 92-96, and 285-302 because they are Gradle build and version catalog configuration blocks (D27)
Room page, Lines 132-134 because it is a non-code compiler diagnostic warning text block
Room page, Lines 231-240 because JVM desktop (jvmMain) target snippets are out of scope for :kmp:shared
Room page, Lines 322-324 because it is a ProGuard / R8 tool configuration rule
Room page, Lines 396-402, 406-412, 438-452, 491-497, 501-509, 545-548, 552-555, 578-581, and 604-609 because they are legacy Android-only (SupportSQLiteDatabase, blocking DAO, LiveData, and withTransaction) blocks written for an earlier version of an API as part of migration guidance

snippet-bot · 2026-09-29T04:03:56Z

Here is the summary of changes.

You are about to add 21 region tags.

kmp/shared/src/androidMain/kotlin/com/example/kmp/snippets/room/Database.android.kt:23, tag android_kmp_room_builder_android
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/Database.kt:34, tag android_kmp_room_database
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/Database.kt:50, tag android_kmp_room_instantiate
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/Database.kt:63, tag android_kmp_room_migration
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/Database.kt:71, tag android_kmp_room_auto_migration_spec
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/Database.kt:79, tag android_kmp_room_callback
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/Database.kt:96, tag android_kmp_room_write_transaction
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/Database.kt:107, tag android_kmp_room_read_transaction
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/TodoDao.kt:30, tag android_kmp_room_dao
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/TodoDao.kt:47, tag android_kmp_room_raw_query_dao
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/TodoDao.kt:59, tag android_kmp_room_raw_query_exec
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/TodoDao.kt:81, tag android_kmp_room_suspend_query
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/TodoDao.kt:86, tag android_kmp_room_suspend_transaction
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/TodoDao.kt:93, tag android_kmp_room_reactive_flow
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/room/TodoEntity.kt:22, tag android_kmp_room_entity
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/sqlite/Sqlite.kt:23, tag android_kmp_sqlite_driver
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/sqlite/Sqlite.kt:46, tag android_kmp_sqlite_transaction
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/sqlite/Sqlite.kt:59, tag android_kmp_sqlite_query_no_result
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/sqlite/Sqlite.kt:66, tag android_kmp_sqlite_query_result_no_args
kmp/shared/src/commonMain/kotlin/com/example/kmp/snippets/sqlite/Sqlite.kt:79, tag android_kmp_sqlite_query_result_with_args
kmp/shared/src/iosMain/kotlin/com/example/kmp/snippets/room/Database.ios.kt:26, tag android_kmp_room_builder_ios

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

kkuan2011

Looks like build is failing too, can you look into the error?

kkuan2011 · 2026-10-01T23:26:32Z

+    // [END_EXCLUDE]
+    val database: RoomDatabase = ...
+    // [START_EXCLUDE silent]
+     */


instead of leaving line 100 as a comment, can we use line 103 as the visible code and then call out the visible code different int/ he PR description?

Done in 837b7d0. The write transaction snippet now shows val database: RoomDatabase = getRoomDatabase(builder) as visible code, and the PR description lists it under the rendered differences.

kkuan2011 · 2026-10-01T23:26:39Z

+    // [START_EXCLUDE silent]
+    /*
+    // [END_EXCLUDE]
+    val database: RoomDatabase = ...


Same fix for the read transaction snippet in 837b7d0.

kkuan2011 · 2026-10-01T23:27:05Z

+    // [START_EXCLUDE silent]
+    /*
+    // [END_EXCLUDE]
+    val connection: SQLiteConnection = ...


Done in 837b7d0. android_kmp_sqlite_transaction now shows val connection: SQLiteConnection = BundledSQLiteDriver().open("todos.db").

kkuan2011 · 2026-10-01T23:27:14Z

+    // [START_EXCLUDE silent]
+    /*
+    // [END_EXCLUDE]
+    val connection: SQLiteConnection = ...


same here and everywhere else in the code

Done everywhere in 837b7d0: the 3 SQLite snippets and the 2 Room transaction snippets show the real binding, and no commented-out placeholders are left. Each one is listed in the PR description.

kkuan2011 · 2026-10-01T23:48:06Z

+}
+
+room3 {
+    schemaDirectory(project.layout.buildDirectory.dir("schemas"))


add newline at bottom of file - I think spotless may need it?

Added the trailing newline in 837b7d0.

- Replace D23 block-comment twins with the visible compiling binding in the Room transaction and SQLite snippets. - Add kmp/shared/lint.xml to ignore RestrictedApi in KSP-generated Room *_Impl code (build/generated/**), which failed :kmp:shared:lintAndroidMain. - Add trailing newline to kmp/shared/build.gradle.kts.

hamen · 2026-10-19T17:04:17Z

All review comments are addressed in 837b7d0, replies inline. I ran ./gradlew :kmp:shared:build locally: Android compile and lint pass. CI hasn't run yet because the branch is on our fork. This PR and #1144 touch the same dependencies block in kmp/shared/build.gradle.kts, so I'll rebase this one after #1144 merges.

The opt-in was file-level, outside the snippet region, so the code shown on the page doesn't compile when copied.

The page defines AppDatabase.getDao() earlier, so todoDao() in the raw query example pointed at a function readers never see.

erikrodriguez-se marked this pull request as ready for review September 29, 2026 04:03

Add code snippets for KMP SQLite and Room

f6d8553

erikrodriguez-se force-pushed the erikro/kmp-datastore-sqlite-room branch from f0f34d7 to f6d8553 Compare September 30, 2026 03:41

erikrodriguez-se changed the title ~~Migrate Kotlin Multiplatform DataStore, SQLite, and Room snippets~~ Migrate Kotlin Multiplatform SQLite and Room snippets Sep 30, 2026

kkuan2011 reviewed Oct 1, 2026

View reviewed changes

hamen mentioned this pull request Oct 19, 2026

Migrate Kotlin Multiplatform DataStore snippets #1144

Open

hamen and others added 4 commits October 20, 2026 08:41

Show the ExperimentalForeignApi opt-in in the iOS Room builder snippet

94911d9

The opt-in was file-level, outside the snippet region, so the code shown on the page doesn't compile when copied.

Use getDao() in the raw query snippet to match AppDatabase

565d604

The page defines AppDatabase.getDao() earlier, so todoDao() in the raw query example pointed at a function readers never see.

Merge branch 'main' into erikro/kmp-datastore-sqlite-room

a72d84b

Merge branch 'main' into erikro/kmp-datastore-sqlite-room

2f23645

Conversation

erikrodriguez-se commented Sep 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snippet-bot Bot commented Sep 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kkuan2011 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hamen commented Oct 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

erikrodriguez-se commented Sep 29, 2026 •

edited

Loading

snippet-bot Bot commented Sep 29, 2026 •

edited

Loading

hamen commented Oct 19, 2026 •

edited

Loading