KMP के लिए SQLite सेट अप करना

androidx.sqlite लाइब्रेरी में, ऐब्स्ट्रैक्ट इंटरफ़ेस के साथ-साथ बुनियादी इंप्लिमेंटेशन शामिल होते हैं. इनका इस्तेमाल करके, SQLite को ऐक्सेस करने वाली लाइब्रेरी बनाई जा सकती हैं. आपके पास Room लाइब्रेरी का इस्तेमाल करने का विकल्प है. यह SQLite पर ऐब्स्ट्रैक्शन लेयर उपलब्ध कराती है, ताकि SQLite की पूरी क्षमता का इस्तेमाल करते हुए, डेटाबेस को ज़्यादा बेहतर तरीके से ऐक्सेस किया जा सके.

डिपेंडेंसी सेट अप करना

अपने केएमपी प्रोजेक्ट में SQLite सेट अप करने के लिए, अपने मॉड्यूल की build.gradle.kts फ़ाइल में आर्टफ़ैक्ट की डिपेंडेंसी जोड़ें:

[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

androidx.sqlite लाइब्रेरी ग्रुप, SQLite लाइब्रेरी के साथ कम्यूनिकेट करने के लिए लो-लेवल एपीआई उपलब्ध कराते हैं. ये एपीआई, androidx.sqlite:sqlite-bundled का इस्तेमाल करने पर लाइब्रेरी में शामिल होते हैं या androidx.sqlite:sqlite-framework का इस्तेमाल करने पर, Android या iOS जैसे होस्ट प्लैटफ़ॉर्म में शामिल होते हैं. ये एपीआई, SQLite C API के मुख्य फ़ंक्शन के मुताबिक काम करते हैं.

इसके तीन मुख्य इंटरफ़ेस हैं:

  • SQLiteDriver: SQLite का एंट्री पॉइंट, जिसका इस्तेमाल डेटाबेस कनेक्शन खोलने के लिए किया जाता है.
  • SQLiteConnection: यह sqlite3 ऑब्जेक्ट को दिखाता है.
  • SQLiteStatement: यह sqlite3_stmt ऑब्जेक्ट को दिखाता है.

यहां दिए गए उदाहरण में, मुख्य एपीआई दिखाए गए हैं:

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 की तरह ही, इस्तेमाल के सामान्य पैटर्न में ये चरण शामिल होते हैं:

  1. इंस्टैंशिएट किए गए SQLiteDriver इंप्लिमेंटेशन का इस्तेमाल करके, डेटाबेस कनेक्शन खोलें.
  2. SQLiteConnection.prepare का इस्तेमाल करके, एसक्यूएल स्टेटमेंट तैयार करें.
  3. SQLiteStatement को लागू करने के लिए, यह तरीका अपनाएं:
    1. ज़रूरी नहीं: bind* फ़ंक्शन का इस्तेमाल करके आर्ग्युमेंट बाइंड करें.
    2. step फ़ंक्शन का इस्तेमाल करके, नतीजों के सेट को फिर से इस्तेमाल करें.
    3. get* फ़ंक्शन का इस्तेमाल करके, नतीजों के सेट से कॉलम पढ़ें.

ड्राइवर लागू करना

यहां दी गई टेबल में, उपलब्ध ड्राइवर इंप्लिमेंटेशन के बारे में खास जानकारी दी गई है:

क्लास का नाम

सह-प्रॉडक्ट

इस्तेमाल किए जा सकने वाले प्लैटफ़ॉर्म

AndroidSQLiteDriver androidx.sqlite:sqlite-framework

Android

NativeSQLiteDriver androidx.sqlite:sqlite-framework

iOS, Mac, और Linux

BundledSQLiteDriver androidx.sqlite:sqlite-bundled

Android, iOS, Mac, Linux, और जेवीएम (डेस्कटॉप)

WebWorkerSQLiteDriver androidx.sqlite:sqlite-web

JavaScript और WebAssembly (WasmJS)

हमारा सुझाव है कि आप BundledSQLiteDriver का इस्तेमाल करें. यह androidx.sqlite:sqlite-bundled में उपलब्ध है. इसमें सोर्स से कंपाइल की गई SQLite लाइब्रेरी शामिल है. यह लाइब्रेरी, काम करने वाले सभी KMP प्लैटफ़ॉर्म पर सबसे अप-टू-डेट वर्शन और एक जैसा अनुभव देती है.

SQLite ड्राइवर और रूम

ड्राइवर एपीआई, SQLite डेटाबेस के साथ लो-लेवल इंटरैक्शन के लिए काम के होते हैं. हमारा सुझाव है कि आप Room का इस्तेमाल करें. यह एक ऐसी लाइब्रेरी है जिसमें कई सुविधाएं मौजूद हैं. इसकी मदद से, SQLite को बेहतर तरीके से ऐक्सेस किया जा सकता है.

डेटाबेस से जुड़े ऑपरेशन करने के लिए, RoomDatabase, SQLiteDriver पर निर्भर करता है. साथ ही, आपको RoomDatabase.Builder.setDriver का इस्तेमाल करके, इसे लागू करने के लिए कॉन्फ़िगर करना होगा. Room, RoomDatabase.useReaderConnection और RoomDatabase.useWriterConnection उपलब्ध कराता है, ताकि मैनेज किए जा रहे डेटाबेस कनेक्शन को ज़्यादा आसानी से ऐक्सेस किया जा सके.

Kotlin Multiplatform पर माइग्रेट करना

आपको लो-लेवल Support SQLite API कॉम्पोनेंट, जैसे कि SupportSQLiteDatabase इंटरफ़ेस के किसी भी इस्तेमाल को SQLite ड्राइवर के मिलते-जुलते कॉम्पोनेंट पर माइग्रेट करना होगा.

Kotlin Multiplatform

लो-लेवल SQLiteConnection का इस्तेमाल करके लेन-देन करना

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

बिना किसी नतीजे वाली क्वेरी को लागू करना

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

नतीजे के साथ क्वेरी एक्ज़ीक्यूट करना, लेकिन कोई तर्क नहीं देना

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

नतीजे और आर्ग्युमेंट के साथ क्वेरी एक्ज़ीक्यूट करना

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

सिर्फ़ Android के लिए

SupportSQLiteDatabase का इस्तेमाल करके लेन-देन करना

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