在多平台上開始使用 SQLite

首先在您的專案中套用 gradle 外掛程式。

Kotlin

plugins {
  id("app.cash.sqldelight") version "2.1.0"
}
 
repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") {
      packageName.set("com.example")
    }
  }
}

Groovy

plugins {
  id "app.cash.sqldelight" version "2.1.0"
}

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") { // 這將是產生的資料庫類別名稱。
      packageName = "com.example"
    }
  }
}

SQL 陳述式編寫在 `src/commonMain/sqldelight` 下的 `.sq` 檔案中。
.sq` 檔案中的第一個陳述式會建立一個資料表，但您也可以建立索引或設定預設內容。

ql title="src/commonMain/sqldelight/com/example/sqldelight/hockey/data/Player.sq"
TE TABLE hockeyPlayer (
ayer_number INTEGER PRIMARY KEY NOT NULL,
ll_name TEXT NOT NULL


TE INDEX hockeyPlayer_full_name ON hockeyPlayer(full_name);

RT INTO hockeyPlayer (player_number, full_name)
ES (15, 'Ryan Getzlaf');

陳述式，SQLDelight 會產生一個 `Database` 類別與關聯的 `Schema` 物件，可用於建立您的資料庫並對其執行陳述式。`Database` 類別是由 `generateSqlDelightInterface` Gradle 任務產生的，當您編輯 `.sq` 檔案時，SQLDelight IDE 外掛程式會自動執行該任務，同時它也是一般 Gradle 組建的一部分。

碼中使用產生的資料庫，您必須將 SQLDelight 驅動程式相依性新增至您的專案。
平台都有自己的驅動程式實作。

"Kotlin"

kotlin {
  sourceSets.androidMain.dependencies {
    implementation("app.cash.sqldelight:android-driver:2.1.0")
  }

  // 或 iosMain、windowsMain 等。
  sourceSets.nativeMain.dependencies {
    implementation("app.cash.sqldelight:native-driver:2.1.0")
  }

  sourceSets.jvmMain.dependencies {
    implementation("app.cash.sqldelight:sqlite-driver:2.1.0")
  }
}
```

Groovy

kotlin {
  sourceSets.androidMain.dependencies {
    implementation "app.cash.sqldelight:android-driver:2.1.0"
  }

  // 或 iosMain、windowsMain 等。
  sourceSets.nativeMain.dependencies {
    implementation "app.cash.sqldelight:native-driver:2.1.0"
  }

  sourceSets.jvmMain.dependencies {
    implementation "app.cash.sqldelight:sqlite-driver:2.1.0"
  }
}

建立驅動程式執行個體

建立一個共用的工廠類別或方法來取得 SqlDriver 執行個體。

import com.example.Database

expect class DriverFactory {
  fun createDriver(): SqlDriver
}

fun createDatabase(driverFactory: DriverFactory): Database {
  val driver = driverFactory.createDriver()
  val database = Database(driver)

  // 對資料庫進行更多操作（見下文）。
}

接著為每個目標平台實作此內容：

src/androidMain/kotlin

actual class DriverFactory(private val context: Context) {
  actual fun createDriver(): SqlDriver {
    return AndroidSqliteDriver(Database.Schema, context, "test.db")
  }
}

src/nativeMain/kotlin

actual class DriverFactory {
  actual fun createDriver(): SqlDriver {
    return NativeSqliteDriver(Database.Schema, "test.db")
  }
}

src/jvmMain/kotlin

actual class DriverFactory {
  actual fun createDriver(): SqlDriver {
    val driver: SqlDriver = JdbcSqliteDriver("jdbc:sqlite:test.db", Properties(), Database.Schema)
    return driver
  }
}

關於 Kotlin/JS 的用法，請參閱此處。

定義型別安全查詢

SQLDelight 會為 .sq 檔案中任何帶有標籤的 SQL 陳述式產生型別安全函式。

selectAll:
SELECT *
FROM hockeyPlayer;

insert:
INSERT INTO hockeyPlayer(player_number, full_name)
VALUES (?, ?);

insertFullPlayerObject:
INSERT INTO hockeyPlayer(player_number, full_name)
VALUES ?;

系統會為每個包含標籤陳述式的 .sq 檔案產生一個「Queries」物件。 例如，系統會為上方所示的 Player.sq 檔案產生一個 PlayerQueries 物件。 此物件可用於呼叫產生的型別安全函式，這些函式將執行實際的 SQL 陳述式。

fun doDatabaseThings(driver: SqlDriver) {
  val database = Database(driver)
  val playerQueries: PlayerQueries = database.playerQueries

  println(playerQueries.selectAll().AsList()) 
  // [HockeyPlayer(15, "Ryan Getzlaf")]

  playerQueries.insert(player_number = 10, full_name = "Corey Perry")
  println(playerQueries.selectAll().AsList()) 
  // [HockeyPlayer(15, "Ryan Getzlaf"), HockeyPlayer(10, "Corey Perry")]

  val player = HockeyPlayer(10, "Ronald McDonald")
  playerQueries.insertFullPlayerObject(player)
}

就是這樣！請查看側邊欄中的其他頁面以了解其他功能。