Die androidx.sqlite-Bibliothek enthält abstrakte Schnittstellen sowie grundlegende Implementierungen, mit denen Sie eigene Bibliotheken für den Zugriff auf SQLite erstellen können. Du kannst die Room-Bibliothek verwenden, die eine Abstraktionsebene über SQLite bietet, um einen robusteren Datenbankzugriff zu ermöglichen und gleichzeitig die volle Leistung von SQLite zu nutzen.
Abhängigkeiten einrichten
Wenn Sie SQLite in Ihrem KMP-Projekt einrichten möchten, fügen Sie die Abhängigkeiten für die Artefakte in der Datei build.gradle.kts für Ihr Modul hinzu:
[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-Treiber-APIs
Die Bibliotheksgruppen androidx.sqlite bieten Low-Level-APIs für die Kommunikation mit der SQLite-Bibliothek, die entweder in der Bibliothek enthalten ist, wenn Sie androidx.sqlite:sqlite-bundled verwenden, oder auf der Hostplattform, z. B. Android oder iOS, wenn Sie androidx.sqlite:sqlite-framework verwenden. Die APIs orientieren sich eng an der Hauptfunktion der SQLite C API.
Es gibt drei Hauptschnittstellen:
SQLiteDriver: Der Einstiegspunkt für SQLite, der zum Öffnen von Datenbankverbindungen verwendet wird.SQLiteConnection: Stellt dassqlite3-Objekt dar.SQLiteStatement: Stellt dassqlite3_stmt-Objekt dar.
Im folgenden Beispiel werden die wichtigsten APIs vorgestellt:
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() }
Ähnlich wie bei den SQLite-C-APIs besteht das gängige Nutzungsmuster aus den folgenden Schritten:
- Öffnen Sie eine Datenbankverbindung mit der instanziierten
SQLiteDriver-Implementierung. - Bereiten Sie eine SQL-Anweisung mit
SQLiteConnection.preparevor. - Führen Sie einen
SQLiteStatementaus. Gehen Sie dazu so vor:- Optional: Binden Sie Argumente mit den
bind*-Funktionen. - Iterieren Sie mit der Funktion
stepüber die Ergebnismenge. - Lesen Sie Spalten aus dem Ergebnissatz mit den
get*-Funktionen.
- Optional: Binden Sie Argumente mit den
Treiberimplementierungen
In der folgenden Tabelle sind die verfügbaren Treiberimplementierungen zusammengefasst:
Klassenname |
Artefakt |
Unterstützte Plattformen |
AndroidSQLiteDriver |
androidx.sqlite:sqlite-framework |
Android |
NativeSQLiteDriver |
androidx.sqlite:sqlite-framework |
iOS, Mac und Linux |
BundledSQLiteDriver |
androidx.sqlite:sqlite-bundled |
Android, iOS, Mac, Linux und JVM (Desktop) |
WebWorkerSQLiteDriver |
androidx.sqlite:sqlite-web |
JavaScript und WebAssembly (WasmJS) |
Die empfohlene Implementierung ist BundledSQLiteDriver, verfügbar in androidx.sqlite:sqlite-bundled. Sie enthält die aus der Quelle kompilierte SQLite-Bibliothek und bietet die aktuellste Version und Konsistenz auf allen unterstützten KMP-Plattformen.
SQLite-Treiber und Room
Die Treiber-APIs sind nützlich für Low-Level-Interaktionen mit einer SQLite-Datenbank. Wenn Sie eine funktionsreiche Bibliothek benötigen, die einen robusteren Zugriff auf SQLite bietet, empfehlen wir Room.
Ein RoomDatabase benötigt einen SQLiteDriver, um Datenbankvorgänge auszuführen. Sie müssen eine Implementierung mit RoomDatabase.Builder.setDriver konfigurieren. Room bietet RoomDatabase.useReaderConnection und RoomDatabase.useWriterConnection für einen direkteren Zugriff auf die verwalteten Datenbankverbindungen.
Zu Kotlin Multiplatform migrieren
Sie müssen alle Verwendungen von Low-Level-Support-SQLite-API-Komponenten, z. B. der SupportSQLiteDatabase-Schnittstelle, zu den entsprechenden SQLite-Treiberkomponenten migrieren.
Kotlin Multiplatform
Transaktion mit Low-Level-SQLiteConnection ausführen
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") }
Abfrage ohne Ergebnis ausführen
val connection: SQLiteConnection = BundledSQLiteDriver().open("todos.db") connection.execSQL("ALTER TABLE ...")
Abfrage mit Ergebnis, aber ohne Argumente ausführen
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) } }
Abfrage mit Ergebnis und Argumenten ausführen
connection.prepare("SELECT * FROM Pet WHERE id = ?").use { statement -> statement.bindInt(1, id) if (statement.step()) { // row found, read columns. } else { // row not found. } }
Nur für Android
Transaktion mit SupportSQLiteDatabase ausführen
val database: SupportSQLiteDatabase = ...
database.beginTransaction()
try {
// perform database operations in transaction
database.setTransactionSuccessful()
} finally {
database.endTransaction()
}
Abfrage ohne Ergebnis ausführen
val database: SupportSQLiteDatabase = ...
database.execSQL("ALTER TABLE ...")
Abfrage mit Ergebnis, aber ohne Argumente ausführen
val database: SupportSQLiteDatabase = ...
database.query("SELECT * FROM Pet").use { cursor ->
while (cursor.moveToNext()) {
// read columns
cursor.getInt(0)
cursor.getString(1)
}
}
Abfrage mit Ergebnis und Argumenten ausführen
database.query("SELECT * FROM Pet WHERE id = ?", id).use { cursor ->
if (cursor.moveToNext()) {
// row found, read columns
} else {
// row not found
}
}