Skip to content

入门

!!! info "SQLDelight 2.0"

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

SQLDelight 从您的 SQL 语句生成类型安全的 Kotlin API。它在编译时验证您的模式、语句和迁移,并提供自动补全和重构等 IDE 功能,使编写和维护 SQL 变得简单。

SQLDelight 获取您现有的 SQL 模式,

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

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

intro.gif


支持的变体和平台

SQLDelight 支持多种 SQL 变体和平台。

第三方变体

CockroachDB


JVM

DB2


JVM

Oracle DB


JVM

快照

开发版本(包括 IDE 插件压缩包)的快照可在 Central Portal 快照仓库中获取。请注意,对于 2.0.0+ SNAPSHOT,所有坐标均为 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" }
}

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

IntelliJ_alpha_channel