在多平台中使用 SQLite 入门

首先在项目中应用 Gradle 插件。

KotlinGroovy

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"
    }
  }
}

将 SQL 语句写入 src/commonMain/sqldelight 目录下的 .sq 文件中。通常，.sq 文件中的第一条语句用于创建表，但您也可以创建索引或设置默认内容。

sql

CREATE TABLE hockeyPlayer (
  player_number INTEGER PRIMARY KEY NOT NULL,
  full_name TEXT NOT NULL
);

CREATE INDEX hockeyPlayer_full_name ON hockeyPlayer(full_name);

INSERT INTO hockeyPlayer (player_number, full_name)
VALUES (15, 'Ryan Getzlaf');

根据这些语句，SQLDelight 将生成一个 `Database` 类以及关联的 `Schema` 对象，可用于创建数据库并对其执行语句。`Database` 类由 `generateSqlDelightInterface` Gradle 任务生成，当您编辑 `.sq` 文件时，SQLDelight IDE 插件会自动运行该任务，该任务也是常规 Gradle 构建的一部分。

要在代码中使用生成的数据库，必须向项目中添加 SQLDelight 驱动程序依赖项。
每个目标平台都有其自己的驱动程序实现。

=== "Kotlin"
    ```kotlin
    kotlin {
      sourceSets.androidMain.dependencies {
        implementation("app.cash.sqldelight:android-driver:2.1.0")
      }

      // 或是 iosMain、windowsMain 等。
      sourceSets.nativeMain.dependencies {
        implementation("app.cash.sqldelight:native-driver:2.1.0")
      }

      sourceSets.jvmMain.dependencies {
        implementation("app.cash.sqldelight:sqlite-driver:2.1.0")
      }
    }
    ```
=== "Groovy"
    ```groovy
    kotlin {
      sourceSets.androidMain.dependencies {
        implementation "app.cash.sqldelight:android-driver:2.1.0"
      }

      // 或是 iosMain、windowsMain 等。
      sourceSets.nativeMain.dependencies {
        implementation "app.cash.sqldelight:native-driver:2.1.0"
      }

      sourceSets.jvmMain.dependencies {
        implementation "app.cash.sqldelight:sqlite-driver:2.1.0"
      }
    }
    ```

## 构造驱动程序实例 {id="constructing-driver-instances"}

创建一个通用的工厂类或方法来获取 `SqlDriver` 实例。

```kotlin title="src/commonMain/kotlin"
import com.example.Database

expect class DriverFactory {
  fun createDriver(): SqlDriver
}

fun createDatabase(driverFactory: DriverFactory): Database {
  val driver = driverFactory.createDriver()
  val database = Database(driver)

  // 进一步处理数据库（见下文）。
}

然后为每个目标平台实现它：

=== "src/androidMain/kotlin" kotlin actual class DriverFactory(private val context: Context) { actual fun createDriver(): SqlDriver { return AndroidSqliteDriver(Database.Schema, context, "test.db") } } === "src/nativeMain/kotlin" kotlin actual class DriverFactory { actual fun createDriver(): SqlDriver { return NativeSqliteDriver(Database.Schema, "test.db") } } === "src/jvmMain/kotlin" kotlin actual class DriverFactory { actual fun createDriver(): SqlDriver { val driver: SqlDriver = JdbcSqliteDriver("jdbc:sqlite:test.db", Properties(), Database.Schema) return driver } }

对于 Kotlin/JS 的用法，请参阅此处。

定义类型安全查询

SQLDelight 会为 .sq 文件中任何带有标签的 SQL 语句生成一个类型安全函数。

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 语句。

kotlin

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)
}

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

在多平台中使用 SQLite 入门 ​

定义类型安全查询 ​

在多平台中使用 SQLite 入门

定义类型安全查询