Skip to content

SQLite の型

SQLDelight の列定義は通常の SQLite の列定義と同じですが、生成されるインターフェースにおける列の Kotlin 型を指定する追加の列制約をサポートしています。

sql
CREATE TABLE some_types (
  some_long INTEGER,           -- DB 内では INTEGER として保存され、Long として取得される
  some_double REAL,            -- DB 内では REAL として保存され、Double として取得される
  some_string TEXT,            -- DB 内では TEXT として保存され、String として取得される
  some_blob BLOB               -- DB 内では 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
  )
)

Enum

利便性のために、SQLDelight のランタイムには Enum を String データとして保存するための 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()
  )
)

Value types

SQLDelight は、リクエストに応じて、基になるデータベースの型をラップする Value type(値型)をカラムに対して生成できます:

sql
CREATE TABLE hockeyPlayer (
  id INT AS VALUE
);