类型
PostgreSQL 类型
SQLDelight 列定义与常规 PostgreSQL 列定义相同,但支持一个额外的列约束,该约束指定了在生成的接口中列的 Kotlin 类型。
sql
CREATE TABLE some_types (
some_smallint SMALLINT, -- Retrieved as Short
some_int2 INT2, -- Retrieved as Short
some_integer INTEGER, -- Retrieved as Int
some_int INT, -- Retrieved as Int
some_int4 INT4, -- Retrieved as Int
some_bigint BIGINT, -- Retrieved as Long
some_int8 INT8, -- Retrieved as Long
some_numeric NUMERIC, -- Retrieved as BigDecimal
some_decimal DECIMAL, -- Retrieved as Double
some_real REAL, -- Retrieved as Double
some_float4 FLOAT4, -- Retrieved as Double
some_double_prec DOUBLE PRECISION, -- Retrieved as Double
some_float8 FLOAT8, -- Retrieved as Double
some_smallserial SMALLSERIAL, -- Retrieved as Short
some_serial2 SERIAL2, -- Retrieved as Short
some_serial SERIAL, -- Retrieved as Int
some_serial4 SERIAL4, -- Retrieved as Int
some_bigserial BIGSERIAL, -- Retrieved as Long
some_serial8 SERIAL8, -- Retrieved as Long
some_character CHARACTER, -- Retrieved as String
some_char CHAR, -- Retrieved as String
some_char_var CHARACTER VARYING(16), -- Retrieved as String
some_varchar VARCHAR(16), -- Retrieved as String
some_text TEXT, -- Retrieved as String
some_date DATE, -- Retrieved as LocalDate
some_time TIME, -- Retrieved as LocalTime
some_timestamp TIMESTAMP, -- Retrieved as LocalDateTime
some_timestamp TIMESTAMPTZ, -- Retrieved as OffsetDateTime
some_json JSON, -- Retrieved as String
some_jsonb JSONB, -- Retrieved as String
some_interval INTERVAL, -- Retrieved as String
some_uuid UUID -- Retrieved as UUID
some_bool BOOL, -- Retrieved as Boolean
some_boolean BOOLEAN, -- Retrieved as Boolean
some_bytea BYTEA -- Retrieved as 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)
);
-- This will fail (and the IDE plugin will suggest rewriting to the below)
updateName:
UPDATE hockeyPlayer
SET name = ?;
-- This will pass compilation
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>;