JVM 版 PostgreSQL 快速入门

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

elight 需要了解数据库的架构。通常有两种设置数据库架构的方法。“Fresh Schema”方法假设您从一个空数据库开始，并且将一次性应用所有必要的语句以将其置于所需状态。另一方面，“Migration Schema”方法假设您已经设置了数据库和架构（例如现有的生产数据库），并且您将随着时间的推移逐步应用迁移来更新数据库的架构。

LDelight 中，这些方法对应于在 `.sq` 文件中编写表定义以使用“[Fresh Schema](#fresh-schema)”，或者在 `.sqm` 文件中编写迁移语句以使用“[Migration Schema](#migration-schema)”。在这两种情况下，您的 SQL 查询都将编写在 `.sq` 文件中（[如这里所示](#typesafe-sql)）。

resh Schema

rc/main/sqldelight` 文件夹下的 `.sq` 文件中编写您的 SQL 语句。
.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');

 `.sq` 文件中，您可以开始放置要在[运行时](#typesafe-sql)执行的 SQL 语句。

igration Schema

置 Gradle 使用迁移来组装架构：

"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 来创建架构。在这些文件中放置常规的 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()

无论您是通过全新的创建表语句还是通过迁移来指定架构，运行时的 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)
}

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