型

MySQLの型

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

CREATE TABLE some_types (
  some_tiny_int TINYINT,                           -- Byteとして取得
  some_small_int SMALLINT,                         -- Shortとして取得
  some_integer INTEGER,                            -- Intとして取得
  some_int INT,                                    -- Intとして取得
  some_big_int BIGINT,                             -- Longとして取得
  some_decimal DECIMAL(6,5),                       -- Intとして取得
  some_dec DEC(6,5),                               -- Intとして取得
  some_numeric NUMERIC(6,5),                       -- Intとして取得
  some_float FLOAT(6),                             -- Doubleとして取得
  some_real REAL,                                  -- Doubleとして取得
  some_double DOUBLE,                              -- Doubleとして取得
  some_double_precision DOUBLE PRECISION,          -- Doubleとして取得
  some_boolean BOOLEAN,                            -- Booleanとして取得
  some_date DATE,                                  -- Stringとして取得
  some_time TIME,                                  -- Stringとして取得
  some_timestamp2 TIMESTAMP(6),                    -- Stringとして取得
  some_char CHAR,                                  -- Stringとして取得
  some_character CHARACTER(6),                     -- Stringとして取得
  some_char_varying CHAR VARYING(6),               -- Stringとして取得
  some_longvarchar LONGVARCHAR,                    -- Stringとして取得
  some_character_varying CHARACTER VARYING(6),     -- Stringとして取得
  some_varchar VARCHAR(16),                        -- Stringとして取得
  some_clo CHARACTER LARGE OBJECT(16),             -- Stringとして取得
  some_clob clob(16 M CHARACTERS),                 -- Stringとして取得
  some_binary BINARY,                              -- ByteArrayとして取得
  some_binary2 BINARY(6),                          -- ByteArrayとして取得
  some_longvarbinary LONGVARBINARY,                -- ByteArrayとして取得
  some_longvarbinary2 LONGVARBINARY(6),            -- ByteArrayとして取得
  some_binary_varying BINARY VARYING(6),           -- ByteArrayとして取得
  some_varbinary VARBINARY(8),                     -- ByteArrayとして取得
  some_uuid UUID,                                  -- ByteArrayとして取得
  some_blob BLOB,                                  -- ByteArrayとして取得
  some_blo BINARY LARGE OBJECT(6),                 -- ByteArrayとして取得
  some_bit BIT,                                    -- ByteArrayとして取得
  some_bit2 BIT(6),                                -- ByteArrayとして取得
  some_bit_varying BIT VARYING(6),                 -- ByteArrayとして取得
  some_interval INTERVAL YEAR TO MONTH,            -- ByteArrayとして取得
  some_interval2 INTERVAL YEAR(3),                 -- ByteArrayとして取得
  some_interval3 INTERVAL DAY(4) TO HOUR,          -- ByteArrayとして取得
  some_interval4 INTERVAL MINUTE(4) TO SECOND(6),  -- ByteArrayとして取得
  some_interval5 INTERVAL SECOND(4,6)              -- ByteArrayとして取得
);

カスタムカラム型

カラムをカスタム型として取得したい場合は、次のように 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>;