多平台 SQLite 快速入門

首先在您的專案中應用 Gradle 外掛。

Kotlin

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

repositories {
  google()
  mavenCentral()
}

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

Groovy

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

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    Database { // This will be the name of the generated database class.
      packageName = "com.example"
    }
  }
}

您可以在 src/main/sqldelight 目錄下的 .sq 檔案中撰寫您的 SQL 語句。通常 .sq 檔案中的第一個語句會建立一個資料表，但您也可以建立索引或設定預設內容。

CREATE TABLE hockeyPlayer (
  player_number INTEGER PRIMARY KEY NOT NULL,
  full_name TEXT NOT NULL
);

CREATE INDEX hockeyPlayer_full_name ON hockeyPlayer(full_name);

INSERT INTO hockeyPlayer (player_number, full_name)
VALUES (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)
}

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