COMMENT

Documentation PostgreSQL 8.0.25
Pr�c�dent	Arri�re rapide		Avance rapide	Suivant

Synopsis

COMMENT ON
{
  TABLE nom_objet |
  COLUMN nom_table.nom_colonne |
  AGGREGATE nom_agr�gat
(type_agr�gat) |
  CAST (typesource AS
typecible) |
  CONSTRAINT nom_contrainte ON
nom_table |
  CONVERSION nom_objet |
  DATABASE nom_objet |
  DOMAIN nom_objet |
  FUNCTION nom_fonction
(type_arg1, type_arg2, ...) |
  INDEX nom_objet |
  LARGE OBJECT oid_large_objet |
  OPERATOR op (type_operande1, type_operande2) |
  OPERATOR CLASS nom_objet USING
m�thode_indexage |
  RULE nom_role ON nom_table |
  SCHEMA nom_objet |
  SEQUENCE nom_objet |
  TRIGGER nom_declencheur ON
nom_table |
  TYPE nom_objet |
  VIEW nom_objet
} IS 'texte'

Description

COMMENT stocke un commentaire sur un objet de base de donn�es.

Pour modifier un commentaire, lancez une nouvelle commande COMMENT pour le m�me objet. Seule une cha�ne de commentaire est stock�e pour chaque objet. Pour supprimer un commentaire, �crivez NULL � la place de la cha�ne de texte. Les commentaires sont automatiquement supprim�s lorsque l'objet est supprim�.

Les commentaires peuvent �tre facilement r�cup�r�s avec les commandes de psql \dd, \d+ et \l+. Les autres interfaces utilisateur permettant de r�cup�rer les commentaires peuvent �tre construites au-dessus des m�me fonctions int�gr�es que celles utilis�es par psql, nomm�ment obj_description et col_description. (Voir Tableau 9-43.)

Param�tres

nom_objet nom_table.nom_colonne nom_agregat nom_contrainte nom_fonction op nom_regle nom_declencheur: Le nom de l'objet � commenter. Les noms des tables, agr�gats, domaines, fonctions, index, op�rateurs, classes d'op�rateurs, s�quences, types et vues pourraient �tre qualifi�s du nom du sch�ma.
type_agregat: Le type de donn�es de l'argument de la fonction d'agr�gat ou * si la fonction accepte tout type de donn�es.
large_object_oid: L'OID de l'objet large.
PROCEDURAL: Ceci est du bruit.
sourcetype: Le nom du type de donn�es source de la conversion.
targettype: Le nom du type de donn�es cible de la conversion.
texte: Le nouveau commentaire, �crit comme une cha�ne litt�rale ; ou NULL pour supprimer le commentaire.

Notes

Un commentaire pour une base de donn�es peut seulement �tre cr�� dans cette base de donn�es et ne sera visible que de cette base de donn�es, pas des autres.

Il n'existe pas de m�canisme de s�curit� pour les commentaires : tout utilisateur connect� � une base de donn�es peut voir tous les commentaires des objets dans la base de donn�es (bien que seuls les superutilisateurs peuvent modifier les commentaires sur des objets qu'ils ne poss�dent pas). Du coup, ne placez pas d'informations critiques en terme de s�curit� dans vos commentaires.

Exemples

Attacher un commentaire sur la table matable :

COMMENT ON TABLE matable IS 'Ceci est ma table.';

Supprimez-le de nouveau :

COMMENT ON TABLE matable IS NULL;

Quelques exemples suppl�mentaires :

COMMENT ON AGGREGATE mon_agregat (double precision) IS 'Calcule une variance type';
COMMENT ON CAST (text AS int4) IS 'Autorise les conversions de text vers int4';
COMMENT ON COLUMN ma_table.ma_colonne IS 'Num�ro employ�';
COMMENT ON CONVERSION ma_conv IS 'Conversion vers Unicode';
COMMENT ON DATABASE ma_database IS 'Base de donn�es de d�veloppement';
COMMENT ON DOMAIN mon_domaine IS 'Domaine des adresses email';
COMMENT ON FUNCTION ma_fonction (timestamp) IS 'Renvoie en chiffres romain';
COMMENT ON INDEX mon_index IS 'Renforce l'unicit� de l'ID de l'employ�';
COMMENT ON LANGUAGE plpython IS 'Support de Python pour les procedures
stock�es';
COMMENT ON LARGE OBJECT 346344 IS 'Document de planification';
COMMENT ON OPERATOR ^ (text, text) IS 'Traite l\'intersection de deux textes';
COMMENT ON OPERATOR ^ (NONE, text) IS 'Op�rateur de pr�fix sur un texte';
COMMENT ON OPERATOR CLASS int4ops USING btree IS 'Op�rateurs d'entiers sur
quatre octets pour les index btrees';
COMMENT ON RULE ma_regle ON my_table IS 'Trace les mises � jour des
enregistrements d\'employ�';
COMMENT ON SCHEMA mon_schema IS 'Donn�es du d�partement';
COMMENT ON SEQUENCE ma_sequence IS 'Utilis� pour g�n�rer des cl�s primaires';
COMMENT ON TABLE mon_schema.ma_table IS 'Informations sur les employ�s';
COMMENT ON TRIGGER mon_declencheur ON my_table IS 'Utilis� pour RI';
COMMENT ON TYPE complex IS 'Type de donn�es pour les nombres complexes';
COMMENT ON VIEW ma_vue IS 'Vue des co�ts d�partementaux';

Pr�c�dent	Sommaire	Suivant
CLUSTER	Niveau sup�rieur	COMMIT