COMMENT - Define or Change the Comment of an Object

<refentry id="sql-comment"> <indexterm zone="sql-comment"> <primary>COMMENT</primary> </indexterm> <refmeta> <refentrytitle>COMMENT</refentrytitle> <manvolnum>7</manvolnum> <refmiscinfo>SQL - Language Statements</refmiscinfo> </refmeta> <refnamediv> <refname>COMMENT</refname> <refpurpose>define or change the comment of an object</refpurpose> </refnamediv> <refsynopsisdiv> <synopsis> COMMENT ON { ACCESS METHOD <replaceable class="parameter">object_name</replaceable> | AGGREGATE <replaceable class="parameter">aggregate_name</replaceable> ( <replaceable>aggregate_signature</replaceable> ) | CAST (<replaceable>source_type</replaceable> AS <replaceable>target_type</replaceable>) | COLLATION <replaceable class="parameter">object_name</replaceable> | COLUMN <replaceable class="parameter">relation_name</replaceable>.<replaceable class="parameter">column_name</replaceable> | CONSTRAINT <replaceable class="parameter">constraint_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> | CONSTRAINT <replaceable class="parameter">constraint_name</replaceable> ON DOMAIN <replaceable class="parameter">domain_name</replaceable> | CONVERSION <replaceable class="parameter">object_name</replaceable> | DATABASE <replaceable class="parameter">object_name</replaceable> | DOMAIN <replaceable class="parameter">object_name</replaceable> | EXTENSION <replaceable class="parameter">object_name</replaceable> | EVENT TRIGGER <replaceable class="parameter">object_name</replaceable> | FOREIGN DATA WRAPPER <replaceable class="parameter">object_name</replaceable> | FOREIGN TABLE <replaceable class="parameter">object_name</replaceable> | FUNCTION <replaceable class="parameter">function_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] | INDEX <replaceable class="parameter">object_name</replaceable> | LARGE OBJECT <replaceable class="parameter">large_object_oid</replaceable> | MATERIALIZED VIEW <replaceable class="parameter">object_name</replaceable> | OPERATOR <replaceable class="parameter">operator_name</replaceable> (<replaceable class="parameter">left_type</replaceable>, <replaceable class="parameter">right_type</replaceable>) | OPERATOR CLASS <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> | OPERATOR FAMILY <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> | POLICY <replaceable class="parameter">policy_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> | [ PROCEDURAL ] LANGUAGE <replaceable class="parameter">object_name</replaceable> | PROCEDURE <replaceable class="parameter">procedure_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] | PUBLICATION <replaceable class="parameter">object_name</replaceable> | ROLE <replaceable class="parameter">object_name</replaceable> | ROUTINE <replaceable class="parameter">routine_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] | RULE <replaceable class="parameter">rule_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> | SCHEMA <replaceable class="parameter">object_name</replaceable> | SEQUENCE <replaceable class="parameter">object_name</replaceable> | SERVER <replaceable class="parameter">object_name</replaceable> | STATISTICS <replaceable class="parameter">object_name</replaceable> | SUBSCRIPTION

This section of the PostgreSQL documentation defines the COMMENT SQL command, which is used to define or change the comment of a database object. It provides the syntax for using the command with various object types, such as ACCESS METHOD, AGGREGATE, CAST, COLLATION, COLUMN, CONSTRAINT, CONVERSION, DATABASE, DOMAIN, EXTENSION, EVENT TRIGGER, FOREIGN DATA WRAPPER, FOREIGN TABLE, FUNCTION, INDEX, LARGE OBJECT, MATERIALIZED VIEW, OPERATOR, OPERATOR CLASS, OPERATOR FAMILY, POLICY, LANGUAGE, PROCEDURE, PUBLICATION, ROLE, ROUTINE, RULE, SCHEMA, SEQUENCE, SERVER, STATISTICS, and SUBSCRIPTION.