型

MySQLの型

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

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 の型を指定できます：

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
  )
)

Enum

利便性のために、SQLDelight のランタイムには Enum を 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()
  )
)

Value types

SQLDelight は、リクエストに応じて、基になるデータベースの型をラップする Value type（値型）をカラムに対して生成できます：

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;

マイグレーションにおけるカスタム型

マイグレーションがスキーマの信頼できる唯一の情報源（source of truth）である場合、テーブルを変更する際に公開される Kotlin の型を指定することもできます。

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

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