COMMENT

Crée ou modifie un commentaire relatif à un objet de base de données.

Syntaxe

COMMENT ON
{
TABLE object_name |
COLUMN object_name.column_name |
CONSTRAINT constraint_name ON table_name |
DATABASE object_name |
VIEW object_name
}
IS 'text' | NULL

Paramètres

nom d’objet

Nom de l’objet de base de données auquel s’applique le commentaire. Vous pouvez ajouter un commentaire aux objets suivants :

• TABLE

• COLUMN (accepte également un nom_colonne).

• CONSTRAINT (accepte également un nom_contrainte et un nom_table).

• DATABASE

• VIEW

• SCHEMA (SCHÉMA)

IS ’text’ | NULL

Le texte du commentaire que vous souhaitez ajouter ou remplacer pour l’objet spécifié. La chaîne de texte est de type TEXT. Placez le commentaire entre guillemets simples. Spécifiez la valeur sur NULL pour supprimer le texte du commentaire.

column_name

Nom de la colonne commentée. Paramètre de COLUMN. Suit une table spécifiée dans object_name.

nom_contrainte

Nom de la contrainte commentée. Paramètre de CONSTRAINT.

table_name

Nom d’une table contenant la contrainte. Paramètre de CONSTRAINT.

Notes d’utilisation

Vous devez être un superutilisateur ou le propriétaire d’un objet de la base de données pour ajouter ou mettre à jour un commentaire.

Les commentaires sur les bases de données ne peuvent s’appliquer qu’à la base de données en cours. Un message d’avertissement s’affiche si vous essayez de faire un commentaire sur une autre base de données. Le même avertissement s’affiche pour les commentaires sur les bases de données qui n’existent pas.

Les commentaires sur les tables externes, les colonnes externes et les colonnes des vues à reliure tardive ne sont pas pris en charge.

Exemples

L’exemple suivant ajoute un commentaire à la table SALES.

COMMENT ON TABLE sales IS 'This table stores tickets sales data';

L’exemple suivant affiche le commentaire sur la table SALES.

select obj_description('public.sales'::regclass);

obj_description
-------------------------------------
This table stores tickets sales data
         

L’exemple suivant supprime un commentaire de la table SALES.

COMMENT ON TABLE sales IS NULL;

L’exemple suivant ajoute un commentaire à la colonne EVENTID de la table SALES.

COMMENT ON COLUMN sales.eventid IS 'Foreign-key reference to the EVENT table.';

L’exemple suivant affiche un commentaire sur la colonne EVENTID (colonne numéro 5) de la table SALES.

select col_description( 'public.sales'::regclass, 5::integer );

col_description
-----------------------------------------
Foreign-key reference to the EVENT table.
         

L’exemple suivant ajoute un commentaire descriptif à la table EVENT.

comment on table event is 'Contains listings of individual events.';

Pour afficher les commentaires, interrogez le catalogue système PG_DESCRIPTION. L’exemple suivant renvoie la description de la table EVENT.

select * from pg_catalog.pg_description
where objoid =
(select oid from pg_class where relname = 'event'
and relnamespace =
(select oid from pg_catalog.pg_namespace where nspname = 'public') );

objoid | classoid | objsubid | description
-------+----------+----------+----------------------------------------
116658 |     1259 |        0 | Contains listings of individual events.