型

MySQLの型

SQLDelightの列定義は、通常のMySQLの列定義と同一ですが、生成されるインターフェースでの列のKotlin型を指定する追加の列制約をサポートしています。

CREATE TABLE some_types (
  some_bit BIT,                      -- Retrieved as Boolean
  some_tiny_int TINYINT,             -- Retrieved as Byte 
  some_small_int SMALLINT,           -- Retrieved as Short
  some_medium_int MEDIUMINT,         -- Retrieved as Int
  some_integer INTEGER,              -- Retrieved as Int
  some_int INT,                      -- Retrieved as Int
  some_big_int BIGINT,               -- Retrieved as Long
  some_decimal DECIMAL,              -- Retrieved as Double
  some_dec DEC,                      -- Retrieved as Double
  some_fixed FIXED,                  -- Retrieved as Double
  some_numeric NUMERIC,              -- Retrieved as BigDecimal
  some_float FLOAT,                  -- Retrieved as Double
  some_real REAL,                    -- Retrieved as Double
  some_double_prec DOUBLE PRECISION, -- Retrieved as Double
  some_double DOUBLE,                -- Retrieved as Double
  some_date DATE,                    -- Retrieved as LocalDate
  some_time TIME,                    -- Retrieved as LocalTime
  some_datetime DATETIME,            -- Retrieved as LocalDateTime
  some_timestamp TIMESTAMP,          -- Retrieved as OffsetDateTime
  some_year YEAR,                    -- Retrieved as String
  some_char CHAR,                    -- Retrieved as String
  some_varchar VARCHAR(16),          -- Retrieved as String
  some_tiny_text TINYTEXT,           -- Retrieved as String
  some_text TEXT,                    -- Retrieved as String
  some_medium_text MEDIUMTEXT,       -- Retrieved as String
  some_long_text LONGTEXT,           -- Retrieved as String
  some_enum ENUM,                    -- Retrieved as String
  some_set SET,                      -- Retrieved as String
  some_varbinary VARBINARY(8),       -- Retrieved as ByteArray
  some_blob BLOB(8, 8),              -- Retrieved as ByteArray
  some_binary BINARY,                -- Retrieved as ByteArray
  some_json JSON,                    -- Retrieved as String
  some_boolean BOOLEAN,              -- Retrieved as Boolean
);

カスタムカラム型

カスタム型としてカラムを取得したい場合は、Kotlin型を指定できます。

import kotlin.String;
import kotlin.collections.List;

CREATE TABLE hockeyPlayer (
  cup_wins TEXT AS List<String> NOT NULL
);

しかし、Database を作成するには、データベース型とカスタム型の間でマッピングする方法を知っている ColumnAdapter を提供する必要があります。

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 ランタイムには、列挙型を String データとして保存するための ColumnAdapter が含まれています。

import com.example.hockey.HockeyPlayer;

CREATE TABLE hockeyPlayer (
  position TEXT AS HockeyPlayer.Position
)

val queryWrapper: Database = Database(
  driver = driver,
  hockeyPlayerAdapter = HockeyPlayer.Adapter(
    positionAdapter = EnumColumnAdapter()
  )
)

値型

要求された場合、SQLDelight は基となるデータベース型をラップするカラムの値型を生成できます。

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型を指定することもできます。

import kotlin.String;
import kotlin.collection.List;

ALTER TABLE my_table
  ADD COLUMN new_column VARCHAR(8) AS List<String>;