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 gunakan library Room, yang memberikan lapisan abstraksi di atas SQLite untuk memungkinkan akses database yang lebih andal sekaligus memanfaatkan seluruh kapabilitas 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.1"

[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" }

SQLite Driver API

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 sangat mirip dengan fungsi inti SQLite C API.

Ada tiga antarmuka utama:

Contoh berikut menampilkan 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. Lakukan iterasi pada set hasil menggunakan fungsi step.
    3. Baca kolom dari set hasil menggunakan fungsi get*.

Implementasi driver

Tabel berikut merangkum implementasi driver yang tersedia:

Nama Kelas

Artefak

Platform yang Didukung

AndroidSQLiteDriver androidx.sqlite:sqlite-framework

Android

NativeSQLiteDriver androidx.sqlite:sqlite-framework

iOS, Mac, dan Linux

BundledSQLiteDriver androidx.sqlite:sqlite-bundled

Android, iOS, Mac, Linux, dan JVM (Desktop)

WebWorkerSQLiteDriver androidx.sqlite:sqlite-web

JavaScript dan WebAssembly (WasmJS)

Implementasi yang direkomendasikan untuk digunakan adalah BundledSQLiteDriver yang tersedia di androidx.sqlite:sqlite-bundled. Driver ini menyertakan library SQLite yang dikompilasi dari source, 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.

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 terkelola.

Bermigrasi ke Multiplatform Kotlin

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

Multiplatform Kotlin

Melakukan transaksi menggunakan SQLiteConnection level rendah

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

Menjalankan kueri tanpa hasil

val connection: SQLiteConnection = BundledSQLiteDriver().open("todos.db")
connection.execSQL("ALTER TABLE ...")

Menjalankan kueri dengan hasil, tetapi tanpa argumen

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

Menjalankan kueri dengan hasil dan argumen

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

Khusus Android

Melakukan transaksi menggunakan SupportSQLiteDatabase

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

Menjalankan kueri tanpa hasil

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

Menjalankan kueri dengan hasil, tetapi tanpa argumen

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

Menjalankan kueri dengan hasil dan argumen

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