Configura SQLite per KMP

La libreria androidx.sqlite contiene interfacce astratte e implementazioni di base che possono essere utilizzate per creare librerie personalizzate che accedono a SQLite. Potresti prendere in considerazione l'utilizzo della libreria Room, che fornisce un livello di astrazione su SQLite per consentire un accesso al database più solido sfruttando al contempo tutta la potenza di SQLite.

Configurare le dipendenze

Per configurare SQLite nel tuo progetto KMP, aggiungi le dipendenze per gli artefatti nel file build.gradle.kts per il tuo modulo:

[versions]
sqlite = "2.6.2"

[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 del driver SQLite

I gruppi di librerie androidx.sqlite offrono API di basso livello per la comunicazione con la libreria SQLite inclusa nella libreria quando si utilizza androidx.sqlite:sqlite-bundled o nella piattaforma host, come Android o iOS quando si utilizza androidx.sqlite:sqlite-framework. Le API seguono da vicino la funzionalità principale dell'API C di SQLite.

Esistono tre interfacce principali:

• SQLiteDriver : è il punto di ingresso per utilizzare SQLite ed è responsabile dell'apertura delle connessioni al database.
• SQLiteConnection : è la rappresentazione dell'oggetto sqlite3.
• SQLiteStatement : è la rappresentazione dell'oggetto sqlite3_stmt.

L'esempio seguente mostra le API principali:

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

Analogamente alle API C di SQLite, l'utilizzo comune è:

• Aprire una connessione al database utilizzando l'implementazione SQLiteDriver di cui è stata creata un'istanza.
• Preparare un'istruzione SQL utilizzando SQLiteConnection.prepare()
• Eseguire un SQLiteStatement nel seguente modo:
  1. (Facoltativo) Associare gli argomenti utilizzando le funzioni bind*().
  2. Iterare sul set di risultati utilizzando la funzione step().
  3. Leggere le colonne dal set di risultati utilizzando le funzioni get*().

Implementazioni del driver

La seguente tabella riassume le implementazioni del driver disponibili:

L'implementazione consigliata da utilizzare è BundledSQLiteDriver, disponibile in androidx.sqlite:sqlite-bundled. Include la libreria SQLite compilata dal codice sorgente, che offre la versione più aggiornata e la coerenza su tutte le piattaforme KMP supportate.

Driver SQLite e Room

Le API del driver sono utili per le interazioni di basso livello con un database SQLite. Per una libreria ricca di funzionalità che fornisce un accesso più solido a SQLite, è consigliabile utilizzare Room.

Un RoomDatabase si basa su un SQLiteDriver per eseguire le operazioni del database e deve essere configurata un'implementazione utilizzando RoomDatabase.Builder.setDriver(). Room provides RoomDatabase.useReaderConnection and RoomDatabase.useWriterConnection for more direct access to the managed database connections.

Eseguire la migrazione alla multipiattaforma Kotlin

Qualsiasi utilizzo di componenti dell'API SQLite di supporto di basso livello (come l'interfaccia SupportSQLiteDatabase) deve essere migrato ai componenti equivalenti del driver SQLite.

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 { s>tatement -
  while (statement.step()) {
    // read columns
    statement.getInt(0)
    statement.getText(1)
  }
}

connection.prepare("SELECT * FROM Pet WHERE id = ?").use { s>tatement -
  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 (cusor.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
  }
}