入门

SQLDelight 2.0

如果你目前正在使用 SQLDelight 1.x，请查阅文档了解如何升级到 SQLDelight 2.0！

SQLDelight 根据你的 SQL 语句生成类型安全的 Kotlin API。它在编译时验证你的架构、语句和迁移，并提供自动补全和重构等 IDE 功能，让 SQL 的编写与维护变得简单。

SQLDelight 获取你现有的 SQL 架构，

CREATE TABLE hockey_player (
  id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
  name TEXT NOT NULL,
  number INTEGER NOT NULL
);

并生成类型安全的代码来运行你的 SQL 语句和查询。

---

支持的方言与平台

SQLDelight 支持多种 SQL 方言和平台。

SQLite

---

Android
Native (iOS, macOS, Linux, Windows)
JVM
JavaScript (浏览器)
JavaScript (Node)
多平台

MySQL

---

JVM (JDBC)
JVM (R2DBC)

PostgresSQL

---

JVM (JDBC)
JVM (R2DBC)
Native (macOS, Linux)

HSQL / H2
(实验性)

---

JVM (JDBC)
JVM (R2DBC)

第三方方言

CockroachDB

---

JVM

DB2

---

JVM

Oracle DB

---

JVM

快照

开发版本的快照（包括 IDE 插件 zip 文件）可在 Central Portal Snapshots 仓库中获取。请注意，对于 2.0.0+ 的快照，所有坐标均为 app.cash.sqldelight 而非 com.squareup.sqldelight。

最新快照版本的文档页面可以在此处找到。

Kotlin

// settings.gradle.kts
pluginManagement {
    repositories {
        gradlePluginPortal()
        maven(url = "https://central.sonatype.com/repository/maven-snapshots")
    }
}

// build.gradle.kts
plugins {
    id("app.cash.sqldelight") version "SNAPSHOT-VERSION"
}

repositories {
    maven(url = "https://central.sonatype.com/repository/maven-snapshots")
}

Groovy

// settings.gradle
pluginManagement {
    repositories {
        gradlePluginPortal()
        maven { url "https://central.sonatype.com/repository/maven-snapshots" }
    }
}

// build.gradle
plugins {
    id "app.cash.sqldelight" version "SNAPSHOT-VERSION"
}

repositories {
    maven { url "https://central.sonatype.com/repository/maven-snapshots" }
}

通过在 IntelliJ 中使用 alpha 频道，也可以获取 Alpha IDE 插件：https://plugins.jetbrains.com/plugins/alpha/com.squareup.sqldelight。 快照在 EAP 频道中也可用：https://plugins.jetbrains.com/plugins/eap/com.squareup.sqldelight