COMMENT

Erstellt oder ändert einen Kommentar zu einem Datenbankobjekt.

Syntax

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

Parameter

object_name

Der Name des Datenbankobjekts, das kommentiert wird. Sie können den folgenden Objekten Kommentare hinzufügen:

• TABLE

• COLUMN (akzeptiert auch column_name).

• CONSTRAINT (akzeptiert auch constraint_name und table_name).

• DATABASE

• VIEW

• SCHEMA

IS 'text' | NULL

Der Kommentartext, den Sie für das angegebene Objekt hinzufügen oder ersetzen möchten. Die Text-Zeichenfolge hat den Datentyp TEXT. Sie müssen den Kommentar in einfache Anführungszeichen einschließen. Setzen Sie den Wert auf NULL, um den Kommentartext zu entfernen.

column_name

Der Name der Spalte, die kommentiert wird. Parameter von COLUMN. Folgt einer Tabelle, die in angegeben ist object_name.

constraint_name

Der Name der Einschränkung, die kommentiert wird. Parameter von CONSTRAINT.

table_name

Der Name einer Tabelle, die die Einschränkung enthält. Parameter von CONSTRAINT.

Nutzungshinweise

Sie müssen der Besitzer eines Datenbankobjekts sein, um einen Kommentar hinzufügen oder aktualisieren zu können.

Kommentare zu Datenbanken können nur auf die aktuelle Datenbank angewendet werden. Es wird eine Warnmeldung angezeigt, wenn Sie versuchen, eine andere Datenbank zu kommentieren. Dieselbe Warnung wird für Kommentare zu Datenbanken angezeigt, die nicht vorhanden sind.

Kommentare zu externen Tabellen, externen Spalten und Spalten von Late Binding-Ansichten werden nicht unterstützt.

Beispiele

Im folgenden Beispiel wird der SALES-Tabelle ein neuer Kommentar hinzugefügt.

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

Im folgenden Beispiel wird der Kommentar zur SALES-Tabelle angezeigt.

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

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

Im folgenden Beispiel wird aus der SALES-Tabelle ein Kommentar entfernt.

COMMENT ON TABLE sales IS NULL;

Im folgenden Beispiel wird der EVENTID-Spalte der SALES-Tabelle ein neuer Kommentar hinzugefügt.

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

Im folgenden Beispiel wird der Kommentar zur EVENTID-Spalte (Spalte 5) der SALES-Tabelle angezeigt.

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

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

Im folgenden Beispiel wird der Tabelle EVENT ein beschreibender Kommentar hinzugefügt.

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

Zum Anzeigen von Kommentaren führen Sie eine Abfrage für den PG_DESCRIPTION-Systemkatalog aus. Das folgende Beispiel gibt die Beschreibung für die EVENT-Tabelle zurück.

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.