概要

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 (Browser)
JavaScript (Node)
Multiplatform

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を含む）は、Sonatypeのsnapshotsリポジトリで利用可能です。2.0.0以上のSNAPSHOTでは、すべての座標がcom.squareup.sqldelightではなくapp.cash.sqldelightになることに注意してください。

最新のスナップショットバージョンのドキュメントページはこちらで確認できます。

Kotlin

// settings.gradle.kts
pluginManagement {
    repositories {
        gradlePluginPortal()
        maven(url = "https://oss.sonatype.org/content/repositories/snapshots")
    }
}

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

repositories {
    maven(url = "https://oss.sonatype.org/content/repositories/snapshots")
}

Groovy

// settings.gradle
pluginManagement {
    repositories {
        gradlePluginPortal()
        maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
    }
}

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

repositories {
    maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
}

アルファ版IDEプラグインも、IntelliJのアルファチャネル:https://plugins.jetbrains.com/plugins/alpha/com.squareup.sqldelightを使用して利用できます。 スナップショットはEAPチャネル:https://plugins.jetbrains.com/plugins/eap/com.squareup.sqldelightでも利用可能です。