Menu

Type enum PostgreSQL : CREATE TYPE AS ENUM

Un type enum est une liste fixe et ordonnée de valeurs autorisées, créée avec CREATE TYPE ... AS ENUM. Ajouter et renommer des valeurs, les lister, les trier, et quand une contrainte CHECK est un meilleur choix.

Cette page contient des éditeurs exécutables. Modifiez, exécutez et voyez la sortie instantanément.

Un enum est un type de données dont les valeurs viennent d'une liste fixe que vous déclarez : CREATE TYPE name AS ENUM ('a', 'b', 'c'). Une colonne de ce type n'accepte que ces libellés et les trie dans l'ordre de déclaration, pas par ordre alphabétique.

Les lignes reviennent dans l'ordre new, paid, shipped, delivered. Insérer un libellé absent de la liste, comme 'lost', échoue avec invalid input value for enum order_status: "lost".

Comparer et filtrer selon la position

Comme les valeurs sont ordonnées, <, > et BETWEEN comparent des positions dans la liste. « Payée ou n'importe quel statut suivant » tient en une seule condition :

Les commandes 1, 3 et 4 correspondent. min(status) et max(status) suivent aussi l'ordre de déclaration.

Lister les valeurs d'un enum

enum_range(NULL::type) renvoie tous les libellés sous forme de tableau, et unnest le transforme en lignes :

enum_first(NULL::mood) et enum_last(NULL::mood) renvoient le premier et le dernier libellé. Dans psql, \dT+ mood affiche le type avec ses valeurs.

Ajouter ou renommer une valeur

ALTER TYPE ... ADD VALUE ajoute un libellé à la fin, ou le place avec BEFORE ou AFTER. RENAME VALUE change un libellé, et toutes les lignes qui l'utilisent suivent, car les lignes stockent une référence au libellé plutôt que son texte.

La liste est maintenant pending, paid, packed, shipped, delivered. Avec IF NOT EXISTS, ajouter un libellé déjà présent ne fait rien.

PostgreSQL ne peut ni supprimer une valeur ni réordonner les valeurs existantes. À la place, créez un nouveau type, convertissez la colonne vers ce type et supprimez l'ancien :

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;

La valeur par défaut est supprimée d'abord, car elle est typée avec l'ancien enum. Redéfinissez-la ensuite.

Enum ou contrainte CHECK

Une colonne text avec une contrainte CHECK offre la même protection, et sa liste se modifie avec un simple ALTER TABLE :

Ici, le tri est alphabétique : new, puis paid.

Enumtext + CHECK
Ordre de triOrdre de déclarationAlphabétique
Stockage4 octetsLongueur du texte
Supprimer une valeurNouveau type et conversion de la colonneRemplacer la contrainte
Réutiliser dans plusieurs tablesUn seul typeRépéter la contrainte

Choisissez un enum pour une liste courte et stable dont l'ordre a un sens, comme des statuts ou des tailles. Choisissez CHECK, ou une table de référence avec une clé étrangère, quand la liste change souvent ou que des valeurs disparaissent. Le chapitre sur les enums du manuel couvre les autres détails.

Questions fréquentes

Comment supprimer une valeur d'un enum PostgreSQL ?

Il n'existe pas de ALTER TYPE ... DROP VALUE. Créez un nouvel enum sans la valeur, convertissez la colonne avec ALTER TABLE ... ALTER COLUMN ... TYPE new_type USING col::text::new_type après avoir mis à jour les lignes qui l'utilisent, puis supprimez l'ancien type.

Combien de place prend une valeur enum ?

4 octets par valeur sur le disque, quelle que soit la longueur de son libellé. Les libellés sont sensibles à la casse et peuvent faire jusqu'à 63 octets.

Peut-on utiliser ALTER TYPE ADD VALUE dans une transaction ?

Oui, depuis PostgreSQL 12. La nouvelle valeur ne peut pas être utilisée tant que cette transaction n'a pas été validée.

Comment comparer une colonne enum avec du texte ?

Un littéral de chaîne est converti automatiquement en enum, donc WHERE status = 'paid' fonctionne. Une colonne ou un paramètre de type texte demande une conversion, status = $1::order_status, ou comparez en texte avec status::text = $1.

Illustration des langages de programmation de Coddy

Apprendre à coder avec Coddy

Commencer