Skip to content

类型

MySQL 类型

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

sql
CREATE TABLE some_types (
  some_tiny_int TINYINT,                           -- 检索为 Byte
  some_small_int SMALLINT,                         -- 检索为 Short
  some_integer INTEGER,                            -- 检索为 Int
  some_int INT,                                    -- 检索为 Int
  some_big_int BIGINT,                             -- 检索为 Long
  some_decimal DECIMAL(6,5),                       -- 检索为 Int
  some_dec DEC(6,5),                               -- 检索为 Int
  some_numeric NUMERIC(6,5),                       -- 检索为 Int
  some_float FLOAT(6),                             -- 检索为 Double
  some_real REAL,                                  -- 检索为 Double
  some_double DOUBLE,                              -- 检索为 Double
  some_double_precision DOUBLE PRECISION,          -- 检索为 Double
  some_boolean BOOLEAN,                            -- 检索为 Boolean
  some_date DATE,                                  -- 检索为 String
  some_time TIME,                                  -- 检索为 String
  some_timestamp2 TIMESTAMP(6),                    -- 检索为 String
  some_char CHAR,                                  -- 检索为 String
  some_character CHARACTER(6),                     -- 检索为 String
  some_char_varying CHAR VARYING(6),               -- 检索为 String
  some_longvarchar LONGVARCHAR,                    -- 检索为 String
  some_character_varying CHARACTER VARYING(6),     -- 检索为 String
  some_varchar VARCHAR(16),                        -- 检索为 String
  some_clo CHARACTER LARGE OBJECT(16),             -- 检索为 String
  some_clob clob(16 M CHARACTERS),                 -- 检索为 String
  some_binary BINARY,                              -- 检索为 ByteArray
  some_binary2 BINARY(6),                          -- 检索为 ByteArray
  some_longvarbinary LONGVARBINARY,                -- 检索为 ByteArray
  some_longvarbinary2 LONGVARBINARY(6),            -- 检索为 ByteArray
  some_binary_varying BINARY VARYING(6),           -- 检索为 ByteArray
  some_varbinary VARBINARY(8),                     -- 检索为 ByteArray
  some_uuid UUID,                                  -- 检索为 ByteArray
  some_blob BLOB,                                  -- 检索为 ByteArray
  some_blo BINARY LARGE OBJECT(6),                 -- 检索为 ByteArray
  some_bit BIT,                                    -- 检索为 ByteArray
  some_bit2 BIT(6),                                -- 检索为 ByteArray
  some_bit_varying BIT VARYING(6),                 -- 检索为 ByteArray
  some_interval INTERVAL YEAR TO MONTH,            -- 检索为 ByteArray
  some_interval2 INTERVAL YEAR(3),                 -- 检索为 ByteArray
  some_interval3 INTERVAL DAY(4) TO HOUR,          -- 检索为 ByteArray
  some_interval4 INTERVAL MINUTE(4) TO SECOND(6),  -- 检索为 ByteArray
  some_interval5 INTERVAL SECOND(4,6)              -- 检索为 ByteArray
);

自定义列类型

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