型

PostgreSQL の型

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

CREATE TABLE some_types (
  some_smallint SMALLINT,               -- Short として取得されます
  some_int2 INT2,                       -- Short として取得されます
  some_integer INTEGER,                 -- Int として取得されます
  some_int INT,                         -- Int として取得されます
  some_int4 INT4,                       -- Int として取得されます
  some_bigint BIGINT,                   -- Long として取得されます
  some_int8 INT8,                       -- Long として取得されます
  some_numeric NUMERIC,                 -- BigDecimal として取得されます
  some_decimal DECIMAL,                 -- Double として取得されます
  some_real REAL,                       -- Double として取得されます
  some_float4 FLOAT4,                   -- Double として取得されます
  some_double_prec DOUBLE PRECISION,    -- Double として取得されます
  some_float8 FLOAT8,                   -- Double として取得されます
  some_smallserial SMALLSERIAL,         -- Short として取得されます
  some_serial2 SERIAL2,                 -- Short として取得されます
  some_serial SERIAL,                   -- Int として取得されます
  some_serial4 SERIAL4,                 -- Int として取得されます
  some_bigserial BIGSERIAL,             -- Long として取得されます
  some_serial8 SERIAL8,                 -- Long として取得されます
  some_character CHARACTER,             -- String として取得されます
  some_char CHAR,                       -- String として取得されます
  some_char_var CHARACTER VARYING(16),  -- String として取得されます
  some_varchar VARCHAR(16),             -- String として取得されます
  some_text TEXT,                       -- String として取得されます
  some_date DATE,                       -- LocalDate として取得されます
  some_time TIME,                       -- LocalTime として取得されます
  some_timestamp TIMESTAMP,             -- LocalDateTime として取得されます
  some_timestamp TIMESTAMPTZ,           -- OffsetDateTime として取得されます
  some_json JSON,                       -- String として取得されます
  some_jsonb JSONB,                     -- String として取得されます
  some_interval INTERVAL,               -- String として取得されます
  some_uuid UUID                        -- UUID として取得されます
  some_bool BOOL,                       -- Boolean として取得されます
  some_boolean BOOLEAN,                 -- Boolean として取得されます
  some_bytea BYTEA                      -- 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>;