Menu

PostgreSQL の enum 型: CREATE TYPE AS ENUM の使い方

enum 型は、許可する値を順序付きで固定したリストで、CREATE TYPE ... AS ENUM で作ります。値の追加と名前変更、一覧の表示、並べ替え、CHECK 制約のほうが向いている場面を扱います。

このページのコードはエディタで実行できます。編集してすぐに結果を確認できます。

enum は、宣言した固定のリストから値を取るデータ型です: CREATE TYPE name AS ENUM ('a', 'b', 'c')。この型の列はそのラベルだけを受け付け、アルファベット順ではなく宣言した順に並べます。

行は new、paid、shipped、delivered の順に返ります。'lost' のようにリストにないラベルを挿入すると、invalid input value for enum order_status: "lost" というエラーで失敗します。

位置で比較して絞り込む

値には順序があるので、<、>、BETWEEN はリスト内の位置を比較します。「paid かそれ以降のステータス」が 1 つの条件で書けます。

注文 1、3、4 が一致します。min(status) と max(status) も宣言した順に従います。

enum の値の一覧を表示する

enum_range(NULL::type) はすべてのラベルを配列で返し、unnest でそれを行に展開します。

enum_first(NULL::mood) と enum_last(NULL::mood) は最初と最後のラベルを返します。psql では \dT+ mood で型とその値を表示できます。

値を追加する、名前を変える

ALTER TYPE ... ADD VALUE はラベルを末尾に追加します。BEFORE や AFTER で位置も指定できます。RENAME VALUE はラベルを変更し、そのラベルを使っている行もすべて追従します。行はラベルのテキストではなく、ラベルへの参照を保存しているためです。

リストは pending、paid、packed、shipped、delivered になります。IF NOT EXISTS を付けると、すでにあるラベルの追加は何もしません。

PostgreSQL では値を削除したり、既存の値を並べ替えたりできません。代わりに新しい型を作り、列をその型に変換し、古い型を削除します。

CREATE TYPE order_status_new AS ENUM ('pending', 'paid', 'shipped');
UPDATE orders SET status = 'shipped' WHERE status = 'delivered';
ALTER TABLE orders
    ALTER COLUMN status DROP DEFAULT,
    ALTER COLUMN status TYPE order_status_new USING status::text::order_status_new;
DROP TYPE order_status;
ALTER TYPE order_status_new RENAME TO order_status;

デフォルト値は古い enum の型を持っているので、先に削除します。変換のあとで設定し直してください。

enum と CHECK 制約の比較

CHECK 制約付きの text 列でも同じように守れます。リストの変更も普通の ALTER TABLE でできます。

この場合の並びはアルファベット順で、new、paid の順になります。

enumtext + CHECK
並び順宣言した順アルファベット順
容量4 バイトテキストの長さ
値の削除新しい型と列の変換制約を置き換える
複数のテーブルで再利用1 つの型で済む制約を繰り返し書く

ステータスやサイズのように、短くて変わらず、順序に意味があるリストには enum を選んでください。リストが頻繁に変わったり値が削除されたりするなら、CHECK か、外部キー で参照するマスターテーブルを選んでください。そのほかの詳細はマニュアルの enum の章 にあります。

よくある質問

PostgreSQL の enum から値を削除するには?

ALTER TYPE ... DROP VALUE はありません。その値を除いた新しい enum を作り、その値を使っている行を更新してから、ALTER TABLE ... ALTER COLUMN ... TYPE new_type USING col::text::new_type で列を変換し、古い型を削除します。

enum の値はどれくらいの容量を使いますか?

ラベルの長さに関係なく、ディスク上で 1 値あたり 4 バイトです。ラベルは大文字と小文字を区別し、最大 63 バイトまでです。

ALTER TYPE ADD VALUE はトランザクション内で使えますか?

PostgreSQL 12 から使えます。追加した値は、そのトランザクションがコミットされるまで使えません。

enum の列をテキストと比較するには?

文字列リテラルは自動で enum に変換されるので、WHERE status = 'paid' は動きます。テキストの列やパラメーターはキャストが必要で、status = $1::order_status と書くか、status::text = $1 のようにテキストとして比較します。

Coddyのプログラミング言語のイラスト

Coddyでコードを学ぼう

始める