在 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 { // 这将是生成的数据库类的名称。
      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。如果需要，迁移也可以手动执行。更多信息请参阅 Code Migrations。

定义类型安全查询

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