Skip to content

类型

MySQL 类型

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

sql
CREATE TABLE some_types (
  some_bit BIT,                      -- 获取为 Boolean
  some_tiny_int TINYINT,             -- 获取为 Byte 
  some_small_int SMALLINT,           -- 获取为 Short
  some_medium_int MEDIUMINT,         -- 获取为 Int
  some_integer INTEGER,              -- 获取为 Int
  some_int INT,                      -- 获取为 Int
  some_big_int BIGINT,               -- 获取为 Long
  some_decimal DECIMAL,              -- 获取为 Double
  some_dec DEC,                      -- 获取为 Double
  some_fixed FIXED,                  -- 获取为 Double
  some_numeric NUMERIC,              -- 获取为 BigDecimal
  some_float FLOAT,                  -- 获取为 Double
  some_real REAL,                    -- 获取为 Double
  some_double_prec DOUBLE PRECISION, -- 获取为 Double
  some_double DOUBLE,                -- 获取为 Double
  some_date DATE,                    -- 获取为 LocalDate
  some_time TIME,                    -- 获取为 LocalTime
  some_datetime DATETIME,            -- 获取为 LocalDateTime
  some_timestamp TIMESTAMP,          -- 获取为 OffsetDateTime
  some_year YEAR,                    -- 获取为 String
  some_char CHAR,                    -- 获取为 String
  some_varchar VARCHAR(16),          -- 获取为 String
  some_tiny_text TINYTEXT,           -- 获取为 String
  some_text TEXT,                    -- 获取为 String
  some_medium_text MEDIUMTEXT,       -- 获取为 String
  some_long_text LONGTEXT,           -- 获取为 String
  some_enum ENUM,                    -- 获取为 String
  some_set SET,                      -- 获取为 String
  some_varbinary VARBINARY(8),       -- 获取为 ByteArray
  some_blob BLOB(8, 8),              -- 获取为 ByteArray
  some_binary BINARY,                -- 获取为 ByteArray
  some_json JSON,                    -- 获取为 String
  some_boolean BOOLEAN,              -- 获取为 Boolean
);

自定义列类型

如果您希望以自定义类型检索列,可以指定一个 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
);

## 乐观锁

如果你将某一列指定为 `LOCK`,系统将为其生成一个值类型,并且还要求 `UPDATE` 语句正确使用该锁来执行更新。

```sql
CREATE TABLE hockeyPlayer(
  id INT AS VALUE,
  version_number INT AS LOCK,
  name VARCHAR(8)
);

-- 这将失败(IDE 插件会建议重写为如下内容)
updateName:
UPDATE hockeyPlayer
SET name = ?;

-- 这将通过编译
updateNamePassing:
UPDATE hockeyPlayer
SET name = ?
    version_number = :version_number + 1
WHERE version_number = :version_number;

迁移中的自定义类型

如果迁移是架构的单一事实来源,你还可以在修改表时指定公开的 Kotlin 类型:

sql
import kotlin.String;
import kotlin.collection.List;

ALTER TABLE my_table
  ADD COLUMN new_column VARCHAR(8) AS List<String>;