在 JVM 上開始使用 SQLite

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

KotlinGroovy

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

repositories {
  google()
  mavenCentral()
}

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

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

repositories {
  google()
  mavenCentral()
}

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

將您的 SQL 陳述式撰寫在 src/main/sqldelight 下的 .sq 檔案中。 通常 .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 SQLite 驅動程式相依性新增至您的專案。

KotlinGroovy

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

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

驅動程式的執行個體可以依照下方所示進行建構。該建構函式接受一個 JDBC 連線字串，用來指定資料庫檔案的位置。IN_MEMORY 常數也可以傳遞給建構函式，以建立記憶體內資料庫。

磁碟上記憶體內

val driver: SqlDriver = JdbcSqliteDriver("jdbc:sqlite:test.db", Properties(), Database.Schema)

val driver: SqlDriver = JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY, Properties(), Database.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)
}

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