Skip to content

类型

SQLite 类型

SQLDelight 列定义与常规 SQLite 列定义相同,但支持一个额外的列约束,该约束指定了生成接口中列的 Kotlin 类型。

sql
CREATE TABLE some_types (
  some_long INTEGER,           -- 在数据库中存储为 INTEGER,检索时为 Long
  some_double REAL,            -- 在数据库中存储为 REAL,检索时为 Double
  some_string TEXT,            -- 在数据库中存储为 TEXT,检索时为 String
  some_blob BLOB               -- 在数据库中存储为 BLOB,检索时为 ByteArray
);

基本类型

一个兄弟模块,用于适配基本类型以方便您使用。

kotlin
dependencies {
  implementation("app.cash.sqldelight:primitive-adapters:2.1.0")
}
groovy
dependencies {
  implementation "app.cash.sqldelight:primitive-adapters:2.1.0"
}

存在以下适配器:

  • FloatColumnAdapter — 为一个隐式存储为 kotlin.Double 的 SQL 类型检索 kotlin.Float
  • IntColumnAdapter — 为一个隐式存储为 kotlin.Long 的 SQL 类型检索 kotlin.Int
  • ShortColumnAdapter — 为一个隐式存储为 kotlin.Long 的 SQL 类型检索 kotlin.Short

自定义列类型

如果你想将列作为自定义类型检索,可以指定一个 Kotlin 类型:

sql
import kotlin.String;
import kotlin.collections.List;

CREATE TABLE hockeyPlayer (
  cup_wins TEXT AS List<String> NOT NULL
);

然而,创建 Database 需要你提供一个 ColumnAdapter,它知道如何在数据库类型和你的自定义类型之间进行映射:

kotlin
val listOfStringsAdapter = object : ColumnAdapter<List<String>, String> {
  override fun decode(databaseValue: String) =
    if (databaseValue.isEmpty()) {
      listOf()
    } else {
      databaseValue.split(",")
    }
  override fun encode(value: List<String>) = value.joinToString(separator = ",")
}

val queryWrapper: Database = Database(
  driver = driver,
  hockeyPlayerAdapter = hockeyPlayer.Adapter(
    cup_winsAdapter = listOfStringsAdapter
  )
)

枚举

为了方便,SQLDelight 运行时包含一个 ColumnAdapter,用于将枚举存储为字符串数据。

sql
import com.example.hockey.HockeyPlayer;

CREATE TABLE hockeyPlayer (
  position TEXT AS HockeyPlayer.Position
)
kotlin
val queryWrapper: Database = Database(
  driver = driver,
  hockeyPlayerAdapter = HockeyPlayer.Adapter(
    positionAdapter = EnumColumnAdapter()
  )
)

值类型

如果需要,SQLDelight 可以为列生成一个值类型,该值类型会包装底层数据库类型:

sql
CREATE TABLE hockeyPlayer (
  id INT AS VALUE
);