型別
PostgreSQL 型別
SQLDelight 的欄位定義與常規 PostgreSQL 欄位定義相同,但支援一個額外欄位約束,用來指定產生的介面中欄位的 Kotlin 型別。
sql
CREATE TABLE some_types (
some_smallint SMALLINT, -- 以 Short 形式取得
some_int2 INT2, -- 以 Short 形式取得
some_integer INTEGER, -- 以 Int 形式取得
some_int INT, -- 以 Int 形式取得
some_int4 INT4, -- 以 Int 形式取得
some_bigint BIGINT, -- 以 Long 形式取得
some_int8 INT8, -- 以 Long 形式取得
some_numeric NUMERIC, -- 以 BigDecimal 形式取得
some_decimal DECIMAL, -- 以 Double 形式取得
some_real REAL, -- 以 Double 形式取得
some_float4 FLOAT4, -- 以 Double 形式取得
some_double_prec DOUBLE PRECISION, -- 以 Double 形式取得
some_float8 FLOAT8, -- 以 Double 形式取得
some_smallserial SMALLSERIAL, -- 以 Short 形式取得
some_serial2 SERIAL2, -- 以 Short 形式取得
some_serial SERIAL, -- 以 Int 形式取得
some_serial4 SERIAL4, -- 以 Int 形式取得
some_bigserial BIGSERIAL, -- 以 Long 形式取得
some_serial8 SERIAL8, -- 以 Long 形式取得
some_character CHARACTER, -- 以 String 形式取得
some_char CHAR, -- 以 String 形式取得
some_char_var CHARACTER VARYING(16), -- 以 String 形式取得
some_varchar VARCHAR(16), -- 以 String 形式取得
some_text TEXT, -- 以 String 形式取得
some_date DATE, -- 以 LocalDate 形式取得
some_time TIME, -- 以 LocalTime 形式取得
some_timestamp TIMESTAMP, -- 以 LocalDateTime 形式取得
some_timestamp TIMESTAMPTZ, -- 以 OffsetDateTime 形式取得
some_json JSON, -- 以 String 形式取得
some_jsonb JSONB, -- 以 String 形式取得
some_interval INTERVAL, -- 以 String 形式取得
some_uuid UUID -- 以 UUID 形式取得
some_bool BOOL, -- 以 Boolean 形式取得
some_boolean BOOLEAN, -- 以 Boolean 形式取得
some_bytea BYTEA -- 以 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,用於將列舉儲存為 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
);
## 樂觀鎖 (Optimistic Locking)
如果你將某個欄位指定為 `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;遷移中的自訂型別 (Custom Types in Migrations)
如果遷移是架構的唯一事實來源,你也可以在修改資料表時指定公開的 Kotlin 型別:
sql
import kotlin.String;
import kotlin.collection.List;
ALTER TABLE my_table
ADD COLUMN new_column VARCHAR(8) AS List<String>;