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,用於將列舉儲存為 String 資料。

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