COMMENT |
Commentaire |
|---|---|
| PostgreSQL | |
Syntaxe
|
COMMENT ON { ACCESS METHOD object_name | AGGREGATE aggregate_name ( aggregate_signature ) | CAST (source_type AS target_type) | COLLATION object_name | COLUMN relation_name.column_name | CONSTRAINT constraint_name ON table_name | CONSTRAINT constraint_name ON DOMAIN domain_name | CONVERSION object_name | DATABASE object_name | DOMAIN object_name | EXTENSION object_name | EVENT TRIGGER object_name | FOREIGN DATA WRAPPER object_name | FOREIGN TABLE object_name | FUNCTION function_name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] | INDEX object_name | LARGE OBJECT large_object_oid | MATERIALIZED VIEW object_name | OPERATOR operator_name (left_type, right_type) | OPERATOR CLASS object_name USING index_method | OPERATOR FAMILY object_name USING index_method | POLICY policy_name ON table_name | [ PROCEDURAL ] LANGUAGE object_name | PUBLICATION object_name | ROLE object_name | RULE rule_name ON table_name | SCHEMA object_name | SEQUENCE object_name | SERVER object_name | STATISTICS object_name | SUBSCRIPTION object_name | TABLE object_name | TABLESPACE object_name | TEXT SEARCH CONFIGURATION object_name | TEXT SEARCH DICTIONARY object_name | TEXT SEARCH PARSER object_name | TEXT SEARCH TEMPLATE object_name | TRANSFORM FOR type_name LANGUAGE lang_name | TRIGGER trigger_name ON table_name | TYPE object_name | VIEW object_name } IS 'text' où aggregate_signature est : * | [ argmode ] [ argname ] argtype [ , ... ] | [ [ argmode ] [ argname ] argtype [ , ... ] ] ORDER BY [ argmode ] [ argname ] argtype [ , ... ] |
Paramètres
| Nom | Description |
|---|---|
| object_name relation_name.column_name aggregate_nameconstraint_name function_name operator_name policy_name rule_name trigger_name |
Ces paramètres permettent d'indiquer le nom de l'objet à commenter. Les noms de tables, d'agrégats, de classements, de conversions, de domaines, de tables étrangères, de fonctions, d'index, d'opérateurs, de classes d'opérateurs, de familles d'opérateurs, de séquences, de statistiques, d'objets de recherche de texte, de types et de vues peuvent être qualifiés de schéma. Lorsque vous commentez une colonne, relation_name doit faire référence à une table, une vue, un type composite ou une table étrangère. |
| table_name | Ce paramètre permet d'indiquer le nom de la table. Lors de la création d'un commentaire sur une contrainte, un déclencheur, une règle ou une politique, ces paramètres spécifient le nom de la table sur lequel cet objet est défini. |
| domain_name | Ce paramètre permet d'indiquer le nom du domaine. Lors de la création d'un commentaire sur une contrainte, un déclencheur, une règle ou une politique, ces paramètres spécifient le nom du domaine sur lequel cet objet est défini. |
| source_type | Ce paramètre permet d'indiquer un nom du type de données source de la distribution. |
| target_type | Ce paramètre permet d'indiquer un nom du type de données cible de la distribution. |
| argmode | Ce paramètre permet d'indiquer le mode d'une fonction ou d'un paramètre d'agrégat : IN, OUT, INOUT ou VARIADIC. S'il est omis, la valeur par défaut est IN. Notez que COMMENT ne prête aucune attention aux paramètres OUT, puisque seuls les paramètres d'entrée sont nécessaires pour déterminer l'identité de la fonction. Il suffit donc de lister les paramètres IN, INOUT et VARIADIC. |
| argname | Ce paramètre permet d'indiquer le nom d'une fonction ou d'un paramètre d'agrégat. Notez que COMMENT ne prête aucune attention aux noms de paramètres, puisque seuls les types de données de paramètres sont nécessaires pour déterminer l'identité de la fonction. |
| argtype | Ce paramètre permet d'indiquer le type de données d'une fonction ou d'un paramètre d'agrégat. |
| large_object_oid | Ce paramètre permet d'indiquer l'OID du grand objet. |
| left_type right_type |
Ce paramètre permet d'indiquer le(s) type(s) de données des paramètres de l'opérateur (éventuellement qualifié par le schéma). Écrivez NONE pour le paramètre manquant d'un opérateur préfixe ou suffixe. |
| PROCEDURAL | Ce paramètre est un mot de bruit. |
| type_name | Ce paramètre permet d'indiquer un nom du type de données de la transformation. |
| lang_name | Ce paramètre permet d'indiquer le nom de la langue de la transformation. |
| text | Ce paramètre permet d'indiquer le nouveau commentaire, écrit sous forme de chaîne de caractères littérale ; ou NULL pour supprimer le commentaire. |
Description
Cette instruction permet de définir ou modifier le commentaire d'un objet.
Dernière mise à jour : Jeudi, le 14 Octobre 2021