Menyiapkan SQLite untuk KMP

Library androidx.sqlite berisi antarmuka abstrak beserta implementasi dasar yang dapat digunakan untuk membuat library Anda sendiri yang mengakses SQLite. Sebaiknya Anda menggunakan library Room, yang memberikan lapisan abstraksi di atas SQLite untuk memungkinkan akses database yang lebih andal sekaligus memanfaatkan kekuatan penuh SQLite.

Menyiapkan dependensi

Untuk menyiapkan SQLite di project KMP, tambahkan dependensi untuk artefak dalam file build.gradle.kts untuk modul Anda:

[versions]
sqlite = "2.7.0"

[libraries]
# The SQLite Driver interfaces
androidx-sqlite = { module = "androidx.sqlite:sqlite", version.ref = "sqlite" }

# The bundled SQLite driver implementation
androidx-sqlite-bundled = { module = "androidx.sqlite:sqlite-bundled", version.ref = "sqlite" }

[plugins]
ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }

API Driver SQLite

Grup library androidx.sqlite menawarkan API tingkat rendah untuk berkomunikasi dengan library SQLite yang disertakan dalam library saat menggunakan androidx.sqlite:sqlite-bundled atau di platform host, seperti Android atau iOS saat menggunakan androidx.sqlite:sqlite-framework. API ini mengikuti fungsi inti SQLite C API.

Ada tiga antarmuka utama:

• SQLiteDriver: Titik entri ke SQLite, yang digunakan untuk membuka koneksi database.
• SQLiteConnection: Mewakili objek sqlite3.
• SQLiteStatement: Mewakili objek sqlite3_stmt.

Contoh berikut menunjukkan API inti:

fun main() {
  val databaseConnection = BundledSQLiteDriver().open("todos.db")
  databaseConnection.execSQL(
    "CREATE TABLE IF NOT EXISTS Todo (id INTEGER PRIMARY KEY, content TEXT)"
  )
  databaseConnection.prepare(
    "INSERT OR IGNORE INTO Todo (id, content) VALUES (? ,?)"
  ).use { stmt ->
    stmt.bindInt(index = 1, value = 1)
    stmt.bindText(index = 2, value = "Try Room in the KMP project.")
    stmt.step()
  }
  databaseConnection.prepare("SELECT content FROM Todo").use { stmt ->
    while (stmt.step()) {
      println("Action item: ${stmt.getText(0)}")
    }
  }
  databaseConnection.close()
}

Mirip dengan SQLite C API, pola penggunaan umum terdiri dari langkah-langkah berikut:

1. Buka koneksi database menggunakan implementasi SQLiteDriver yang dibuat instance-nya.
2. Siapkan pernyataan SQL menggunakan SQLiteConnection.prepare.
3. Jalankan SQLiteStatement dengan melakukan hal berikut:
   1. Opsional: Ikat argumen menggunakan fungsi bind*.
   2. Ulangi kumpulan hasil menggunakan fungsi step.
   3. Baca kolom dari kumpulan hasil menggunakan fungsi get*.

Implementasi Driver

Tabel berikut merangkum implementasi driver yang tersedia:

Implementasi yang direkomendasikan untuk digunakan adalah BundledSQLiteDriver yang tersedia di androidx.sqlite:sqlite-bundled. Implementasi ini mencakup library SQLite yang dikompilasi dari sumber, yang menawarkan versi terbaru dan konsistensi di semua platform KMP yang didukung.

Driver SQLite dan Room

API driver berguna untuk interaksi tingkat rendah dengan database SQLite. Untuk library kaya fitur yang menyediakan akses lebih andal ke SQLite, sebaiknya gunakan Room.

A RoomDatabase mengandalkan SQLiteDriver untuk melakukan operasi database, dan Anda harus mengonfigurasi implementasi menggunakan RoomDatabase.Builder.setDriver. Room menyediakan RoomDatabase.useReaderConnection dan RoomDatabase.useWriterConnection untuk akses yang lebih langsung ke koneksi database yang dikelola.

Bermigrasi ke Multiplatform Kotlin

Anda harus memigrasikan penggunaan komponen Support SQLite API tingkat rendah, seperti antarmuka SupportSQLiteDatabase, ke komponen Driver SQLite yang setara.

val connection: SQLiteConnection = ...
connection.execSQL("BEGIN IMMEDIATE TRANSACTION")
try {
  // perform database operations in transaction
  connection.execSQL("END TRANSACTION")
} catch(t: Throwable) {
  connection.execSQL("ROLLBACK TRANSACTION")
}

val connection: SQLiteConnection = ...
connection.execSQL("ALTER TABLE ...")

val connection: SQLiteConnection = ...
connection.prepare("SELECT * FROM Pet").use { statement ->
  while (statement.step()) {
    // read columns
    statement.getInt(0)
    statement.getText(1)
  }
}

connection.prepare("SELECT * FROM Pet WHERE id = ?").use { statement ->
  statement.bindInt(1, id)
  if (statement.step()) {
    // row found, read columns
  } else {
    // row not found
  }
}

val database: SupportSQLiteDatabase = ...
database.beginTransaction()
try {
  // perform database operations in transaction
  database.setTransactionSuccessful()
} finally {
  database.endTransaction()
}

val database: SupportSQLiteDatabase = ...
database.execSQL("ALTER TABLE ...")

val database: SupportSQLiteDatabase = ...
database.query("SELECT * FROM Pet").use { cursor ->
  while (cursor.moveToNext()) {
    // read columns
    cursor.getInt(0)
    cursor.getString(1)
  }
}

database.query("SELECT * FROM Pet WHERE id = ?", id).use { cursor ->
  if (cursor.moveToNext()) {
    // row found, read columns
  } else {
    // row not found
  }
}