在 Android 上快速入門 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"
    }
  }
}

TIP

建議將 Android Studio 切換為使用「專案 (Project)」檢視而非「Android」檔案檢視，以便更容易找到和編輯 SQLDelight 檔案。

您可以在 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 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 在驅動程式建構時將自動建立或遷移您的結構描述 (schema)。如果需要，遷移也可以手動執行。詳情請參閱 程式碼遷移。

定義型別安全的查詢

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 版本列表。