類型
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
)
)
列舉 (Enums)
為方便起見,SQLDelight 執行時 (runtime) 包含一個 ColumnAdapter
,用於將列舉 (enum) 儲存為字串資料。
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 可以為欄位生成一個值型別,該型別會包裝底層 (underlying) 資料庫型別:
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;
遷移中的自訂型別
如果遷移是綱要 (schema) 的事實來源,您也可以在修改表格時指定公開的 Kotlin 型別:
sql
import kotlin.String;
import kotlin.collection.List;
ALTER TABLE my_table
ADD COLUMN new_column VARCHAR(8) AS List<String>;