Menu

Typy enum w PostgreSQL: CREATE TYPE AS ENUM

Typ enum to stała, uporządkowana lista dozwolonych wartości tworzona przez CREATE TYPE ... AS ENUM. Omawia dodawanie i zmianę nazw wartości, ich listowanie, sortowanie i to, kiedy lepszy jest CHECK.

Na tej stronie są działające edytory: edytuj, uruchamiaj i od razu zobacz wynik.

Enum to typ danych, którego wartości pochodzą z zadeklarowanej przez ciebie stałej listy: CREATE TYPE name AS ENUM ('a', 'b', 'c'). Kolumna tego typu przyjmuje tylko te etykiety i sortuje je w zadeklarowanej kolejności, a nie alfabetycznie.

Wiersze wracają w kolejności new, paid, shipped, delivered. Wstawienie etykiety spoza listy, na przykład 'lost', kończy się błędem invalid input value for enum order_status: "lost".

Porównywanie i filtrowanie po pozycji

Ponieważ wartości są uporządkowane, <, > i BETWEEN porównują pozycje na liście. „Opłacone albo dowolny późniejszy status” to jeden warunek:

Pasują zamówienia 1, 3 i 4. min(status) i max(status) też trzymają się zadeklarowanej kolejności.

Lista wartości enum

enum_range(NULL::type) zwraca wszystkie etykiety jako tablicę, a unnest zamienia ją na wiersze:

enum_first(NULL::mood) i enum_last(NULL::mood) zwracają pierwszą i ostatnią etykietę. W psql \dT+ mood pokazuje typ razem z wartościami.

Dodawanie wartości i zmiana nazwy

ALTER TYPE ... ADD VALUE dopisuje etykietę na końcu albo umieszcza ją przez BEFORE lub AFTER. RENAME VALUE zmienia etykietę, a każdy wiersz, który jej używa, podąża za zmianą, bo wiersze przechowują odwołanie do etykiety, a nie jej tekst.

Lista to teraz pending, paid, packed, shipped, delivered. IF NOT EXISTS sprawia, że dodanie istniejącej już etykiety nic nie robi.

PostgreSQL nie umie usunąć wartości ani zmienić kolejności istniejących. Zamiast tego utwórz nowy typ, przekonwertuj na niego kolumnę i usuń stary:

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;

Wartość domyślna jest usuwana najpierw, bo ma typ starego enum. Ustaw ją ponownie na końcu.

Enum czy ograniczenie CHECK

Kolumna text z ograniczeniem CHECK daje tę samą ochronę, a jej listę można zmienić zwykłym ALTER TABLE:

Tutaj sortowanie jest alfabetyczne: najpierw new, potem paid.

Enumtext + CHECK
Kolejność sortowaniaZadeklarowana kolejnośćAlfabetyczna
Miejsce4 bajtyDługość tekstu
Usunięcie wartościNowy typ i konwersja kolumnyWymiana ograniczenia
Użycie w kilku tabelachJeden typPowtórzenie ograniczenia

Wybierz enum dla krótkiej, stabilnej listy, której kolejność coś znaczy, na przykład statusów albo rozmiarów. Wybierz CHECK albo tabelę słownikową z kluczem obcym, gdy lista często się zmienia albo wartości są usuwane. Rozdział o enum w dokumentacji omawia pozostałe szczegóły.

Najczęściej zadawane pytania

Jak usunąć wartość z enum w PostgreSQL?

Nie ma ALTER TYPE ... DROP VALUE. Utwórz nowy enum bez tej wartości, zaktualizuj wiersze, które jej używają, przekonwertuj kolumnę przez ALTER TABLE ... ALTER COLUMN ... TYPE new_type USING col::text::new_type, a potem usuń stary typ.

Ile miejsca zajmuje wartość enum?

4 bajty na wartość na dysku, niezależnie od długości etykiety. Etykiety rozróżniają wielkość liter i mogą mieć do 63 bajtów.

Czy ALTER TYPE ADD VALUE działa wewnątrz transakcji?

Tak, od PostgreSQL 12. Nowej wartości nie można jednak użyć, dopóki ta transakcja nie zostanie zatwierdzona.

Jak porównać kolumnę enum z tekstem?

Literał tekstowy jest automatycznie zamieniany na enum, więc WHERE status = 'paid' działa. Kolumna tekstowa albo parametr wymagają rzutowania, status = $1::order_status, albo porównaj jako tekst przez status::text = $1.

Ilustracja języków programowania w Coddy

Ucz się programowania z Coddy

Zacznij