KMP için SQLite'ı ayarlama

androidx.sqlite kitaplığı, SQLite'a erişen kendi kitaplıklarınızı oluşturmak için kullanılabilecek temel uygulamalarla birlikte soyut arayüzler içerir. SQLite'ın tüm gücünden yararlanırken daha sağlam veritabanı erişimi sağlamak için SQLite üzerinde bir soyutlama katmanı sağlayan Room kitaplığını kullanabilirsiniz.

Bağımlılıkları ayarlama

KMP projenizde SQLite'ı ayarlamak için modülünüzün build.gradle.kts dosyasına yapıların bağımlılıklarını ekleyin:

[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 Sürücü API'leri

androidx.sqlite kitaplık grupları, androidx.sqlite:sqlite-bundled kullanırken kitaplığa dahil edilen veya androidx.sqlite:sqlite-framework kullanırken Android ya da iOS gibi ana makine platformunda bulunan SQLite kitaplığıyla iletişim kurmak için alt düzey API'ler sunar. API'ler, SQLite C API'nin temel işlevlerini yakından takip eder.

Üç ana arayüz vardır:

Aşağıdaki örnekte temel API'ler gösterilmektedir:

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()
}

SQLite C API'lerine benzer şekilde, yaygın kullanım kalıbı aşağıdaki adımlardan oluşur:

  1. Örneklendirilmiş SQLiteDriver uygulamasını kullanarak bir veritabanı bağlantısı açın.
  2. SQLiteConnection.prepare kullanarak bir SQL ifadesi hazırlayın.
  3. Aşağıdakileri yaparak bir SQLiteStatement yürütün:
    1. İsteğe bağlı: bind* işlevlerini kullanarak bağımsız değişkenleri bağlayın.
    2. step işlevini kullanarak sonuç kümesi üzerinde iterasyon yapın.
    3. get* işlevlerini kullanarak sonuç kümesindeki sütunları okuyun.

Sürücü uygulamaları

Aşağıdaki tabloda, kullanılabilir sürücü uygulamaları özetlenmiştir:

Sınıf adı

Yapı

Desteklenen Platformlar

AndroidSQLiteDriver androidx.sqlite:sqlite-framework

Android

NativeSQLiteDriver androidx.sqlite:sqlite-framework

iOS, Mac ve Linux

BundledSQLiteDriver androidx.sqlite:sqlite-bundled

Android, iOS, Mac, Linux ve JVM (Masaüstü)

WebWorkerSQLiteDriver androidx.sqlite:sqlite-web

JavaScript ve WebAssembly (WasmJS)

Önerilen uygulama, androidx.sqlite:sqlite-bundled içinde bulunan BundledSQLiteDriver yöntemidir. Kaynaktan derlenen SQLite kitaplığını içerir. Bu kitaplık, desteklenen tüm KMP platformlarında en güncel sürümü ve tutarlılığı sunar.

SQLite Sürücüsü ve Room

Sürücü API'leri, SQLite veritabanıyla alt düzey etkileşimler için kullanışlıdır. SQLite'a daha sağlam erişim sağlayan, özellik açısından zengin bir kitaplık için Room'u öneririz.

RoomDatabase, veritabanı işlemlerini gerçekleştirmek için SQLiteDriver kullanır. RoomDatabase.Builder.setDriver kullanarak bir uygulama yapılandırmanız gerekir. Room, yönetilen veritabanı bağlantılarına daha doğrudan erişim için RoomDatabase.useReaderConnection ve RoomDatabase.useWriterConnection sağlar.

Kotlin Multiplatform'a geçiş

SupportSQLiteDatabase arayüzü gibi alt düzey destek SQLite API bileşenlerinin tüm kullanımlarını eşdeğer SQLite sürücü bileşenlerine taşımanız gerekir.

Kotlin Multiplatform

Düşük seviyeli SQLiteConnection kullanarak işlem yapma

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

Sonuçsuz bir sorgu yürütme

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

Sonuç içeren ancak bağımsız değişken içermeyen bir sorgu yürütme

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)
    }
}

Sonuç ve bağımsız değişkenlerle bir sorgu yürütme

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

Yalnızca Android

SupportSQLiteDatabase kullanarak işlem yapma

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

Sonuçsuz bir sorgu yürütme

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

Sonuç içeren ancak bağımsız değişken içermeyen bir sorgu yürütme

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

Sonuç ve bağımsız değişkenlerle bir sorgu yürütme

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