型別
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,用於將列舉儲存為 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>;