HSQL 在 JVM 上的快速上手

实验性

HSQL 支持尚处于孵化阶段，且变体的部分功能尚未完善。如果您遇到变体中不受支持的部分，请在 sql-psi 上报告。

首先在你的项目中应用 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"
    }
  }
}

SQLDelight 需要知道你的数据库 schema。通常有两种方法来设置你的数据库 schema。“全新 schema”方法假设你从一个空数据库开始，所有将数据库带到所需状态的语句将一次性应用。另一方面，“迁移 schema”方法假设你已经有一个数据库和 schema （例如，一个现有的生产数据库），并且你将随着时间的推移逐步应用迁移来更新数据库的 schema。

在 SQLDelight 中，这些方法转化为要么在 .sq 文件中编写你的表定义以实现“全新 schema”，要么在 .sqm 文件中编写迁移语句以实现“迁移 schema”。在这两种情况下，你的 SQL _查询_都将写入 .sq 文件（如这里所示）。

全新 Schema

在 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');

在相同的 .sq 文件中，你可以开始放置要在运行时执行的 SQL 语句。

迁移 Schema

首先，配置 Gradle 以使用迁移来组装 schema：

Kotlin

sqldelight {
  databases {
    create("Database") {
      ...
      srcDirs("sqldelight")
      deriveSchemaFromMigrations.set(true)
    }
  }
}

Groovy

sqldelight {
  databases {
    Database {
      ...
      srcDirs "sqldelight"
      deriveSchemaFromMigrations = true
    }
  }
}

迁移文件使用 .sqm 扩展名，并且文件名中必须包含一个数字，表明迁移文件的运行顺序。例如，给定此文件层级：

src
`-- main
    `-- sqldelight
        |-- v1__backend.sqm
        `-- v2__backend.sqm

SQLDelight 将通过应用 v1__backend.sqm 然后 v2__backend.sqm 来创建 schema。将你的常规 SQL CREATE/ALTER 语句放在这些文件中。如果其他服务（如 Flyway）从你的迁移文件中读取，请务必阅读有关迁移的信息以及如何输出有效的 SQL。

类型安全的 SQL

在你能够在运行时执行 SQL 语句之前，你需要创建一个 SqlDriver 来连接到你的数据库。最简单的方法是使用从 Hikari 或其他连接管理器获取的 DataSource。

Kotlin

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

Groovy

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

val driver: SqlDriver = dataSource.asJdbcDriver()

无论你将 schema 指定为全新的表创建语句还是通过迁移，运行时 SQL 都存在于 .sq 文件中。

定义类型安全查询

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

就是这样！请查看侧边栏中的其他页面，了解其他功能。