在 Kotlin/Native 上开始使用 SQLDelight

Kotlin/Native 内存管理器

从 SQLDelight 2.0 开始，SQLDelight Native 驱动只支持 Kotlin/Native 的新内存管理器。

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

Kotlin

plugins {
  id("app.cash.sqldelight") version "2.1.0"
}
 
repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    create("Database") {
      packageName.set("com.example")
    }
  }
}

Groovy

plugins {
  id "app.cash.sqldelight" version "2.1.0"
}

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    Database { // 这将是生成的数据库类的名称。
      packageName = "com.example"
    }
  }
}

在 src/main/sqldelight 目录下的 .sq 文件中编写你的 SQL 语句。 通常 .sq 文件中的第一条语句会创建一个表，但你也可以创建索引或设置默认内容。

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 Native 驱动依赖添加到您的项目中。

Kotlin

kotlin {
  // or iosMain, windowsMain, etc.
  sourceSets.nativeMain.dependencies {
    implementation("app.cash.sqldelight:native-driver:2.1.0")
  }
}

Groovy

kotlin {
  // or iosMain, windowsMain, etc.
  sourceSets.nativeMain.dependencies {
    implementation "app.cash.sqldelight:native-driver:2.1.0"
  }
}

驱动实例可以按如下方式构建，并且需要引用生成的 Schema 对象。

val driver: SqlDriver = NativeSqliteDriver(Database.Schema, "test.db")

定义类型安全查询

SQLDelight 将为 .sq 文件中的任何带标签的 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 语句。

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

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

读连接池

磁盘数据库可以（可选地）拥有多个读连接。要配置读连接池，请将 maxReaderConnections 参数传递给 NativeSqliteDriver 的各种构造函数：

val driver: SqlDriver = NativeSqliteDriver(
    Database.Schema, 
    "test.db", 
    maxReaderConnections = 4
)

读连接仅用于在事务之外运行查询。任何写入调用以及事务中的任何操作都使用一个专用于事务的单一连接。