型

MySQLのデータ型

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

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

列挙型

便宜上、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>;