SQLDelight 安装与配置指南

SQLDelight 安装与配置指南

sqldelight SQLDelight - Generates typesafe Kotlin APIs from SQL 项目地址: https://gitcode.com/gh_mirrors/sq/sqldelight

1. 项目基础介绍

SQLDelight 是一个由 Cash App 开发的开源项目，它能够将 SQL 语句转换为类型安全的 Kotlin API。这个项目可以在编译时验证你的数据库模式、语句和迁移，并为 IDE 提供自动完成和重构等特性，从而简化 SQL 的编写和维护工作。

主要编程语言：Kotlin

2. 关键技术和框架

• Kotlin：SQLDelight 使用 Kotlin 语言来生成类型安全的 API。
• SQLite：项目支持将 SQL 语句转换为可以在 SQLite 数据库上运行的 API。
• 多平台支持：SQLDelight 支持跨平台，包括 Android、iOS、macOS、Windows、JVM 和 JavaScript。
• 数据库方言支持：除了 SQLite，还支持 JVM 上的 MySQL、PostgreSQL 和 HSQL/H2 等数据库方言。

3. 安装和配置准备工作

在开始安装 SQLDelight 之前，请确保你的开发环境已经满足了以下要求：

• JDK：安装 JDK 1.8 或更高版本。
• Gradle：安装 Gradle，版本至少为 4.6。
• IDE：推荐使用支持 Kotlin 的 IDE，如 IntelliJ IDEA。

4. 安装步骤

以下是 SQLDelight 的详细安装步骤：

步骤 1：克隆项目

首先，你需要从 GitHub 上克隆 SQLDelight 项目到本地：

git clone https://github.com/cashapp/sqldelight.git

步骤 2：配置项目

进入项目目录，然后使用 Gradle wrapper 来构建项目：

cd sqldelight
./gradlew clean build

步骤 3：添加依赖

在你的 Kotlin 或 Android 项目中，添加以下依赖项到你的 build.gradle 文件：

dependencies {
    implementation "com.squareup.sqldelight:runtime:1.5.3"
    ksp "com.squareup.sqldelight:compiler:1.5.3"
}

确保将版本号替换为当前 SQLDelight 的最新版本。

步骤 4：创建 SQL 文件

在你的项目中创建一个新的 SQL 文件（例如 database.sq），并定义你的数据库模式和查询。

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

步骤 5：生成 Kotlin 代码

在 SQL 文件旁边创建一个 Kotlin 文件（例如 Database.kt），然后使用 SQLDelight 注解处理器生成类型安全的 API：

import com.squareup.sqldelight.db.SqlDatabase
import com.squareup.sqldelight.runtime.Provider
import com.squareup.sqldelight.runtime.RxQuery

class HockeyPlayerDatabase(private val database: SqlDatabase) {
    val hockeyPlayers: Provider<RxQuery<HockeyPlayer>> = query(
        databases = database,
        sqlQuery = """
            SELECT id, name, number FROM hockey_player
        """,
        mapper = { id, name, number -> HockeyPlayer(id, name, number) }
    )
}

步骤 6：编译项目

使用 Gradle 构建 your 项目，确保 SQLDelight 代码已经生成并且没有错误。

./gradlew build

完成以上步骤后，你的项目应该已经成功集成了 SQLDelight，并且可以开始使用了。

sqldelight SQLDelight - Generates typesafe Kotlin APIs from SQL 项目地址: https://gitcode.com/gh_mirrors/sq/sqldelight