在 Android 上開始使用 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"
    }
  }
}

tip
Android Studio 切換為使用「Project」檢視，而非檔案的「Android」檢視，以便更輕鬆地尋找與編輯 SQLDelight 檔案。


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

ql title="src/main/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 Android 驅動程式相依性新增至專案中。

"Kotlin"

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

Groovy

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

如下所示，可以建構驅動程式的執行個體，且需要參照產生的 Schema 物件。

val driver: SqlDriver = AndroidSqliteDriver(Database.Schema, context, "test.db")

INFO

當驅動程式建構時，AndroidSqliteDriver 會自動建立或遷移您的架構。如有需要，也可以手動執行遷移。請參閱 程式碼遷移 以進一步了解。

定義型別安全查詢

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

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

SQLite 版本

對於 Android 專案，SQLDelight Gradle 外掛程式會根據您專案的 minSdkVersion 設定，自動選取 SQLite 方言版本。點擊此處 以查看各個 Android SDK 層級支援的 SQLite 版本列表。