COMMENT

PostgreSQL: Das Offizielle Handbuch
Zurück	Schnell zurück		Schnell nach vorne	Nach vorne

Synopsis

COMMENT ON
{
  TABLE objektname |
  COLUMN tabellenname.spaltenname |
  AGGREGATE aggname (aggtyp) |
  CONSTRAINT constraintname ON tabellenname |
  DATABASE objektname |
  DOMAIN objektname |
  FUNCTION funktionsname (arg1_typ, arg2_typ, ...) |
  INDEX objektname |
  OPERATOR op (linker_operandentyp, rechter_operandentyp) |
  RULE regelname ON tabellenname |
  SCHEMA objektname |
  SEQUENCE objektname |
  TRIGGER triggername ON tabellename |
  TYPE objektname |
  VIEW objektname
} IS 'text'

Beschreibung

COMMENT speichert einen Kommentar über ein Datenbankobjekt. Kommentare können leicht mit den psql-Befehlen \dd, \d+ und \l+ eingesehen werden. Andere Programme können Kommentare mit den selben eingebauten Funktionen abrufen, die auch psql verwendet, nämlich obj_description und col_description.

Um einen Kommentar zu ändern, führen Sie einen neuen COMMENT-Befehl für das selbe Objekt aus. Pro Objekt wird nur eine Kommentar gespeichert. Um einen Kommentar zu entfernen schreiben Sie NULL anstelle des Textes. Kommentare werden automatisch gelöscht, wenn das Objekt gelöscht wird.

Parameter

objektname tabellenname.spaltenname aggname constraintname funktionsname op regelname triggername: Der Name des Objekts, für den der Kommentar ist. Die Namen von Tabellen, Aggregatfunktionen, Domänen, Funktionen, Indexen, Operatoren, Sequenzen, Typen und Sichten können eine Schemaqualifikation haben.
text: Der Kommentar.

Meldungen

COMMENT: Meldung, wenn der Kommentar erfolgreich geändert wurde.

Hinweise

Es gibt gegenwärtig keinen Sicherheitsmechanismus für Kommentare: Jeder mit einer Datenbank verbundene Benutzer kann alle Kommentare für Objekte in dieser Datenbank sehen (aber nur Superuser können Kommentare von Objekten, die sie nicht besitzen, ändern). Lassen Sie also keine sicherheitsrelevanten Informationen in den Kommentaren.

Beispiele

Erzeuge einen Kommentar für die Tabelle meine_tabelle:

COMMENT ON TABLE meine_tabelle IS 'Das ist meine Tabelle.';

Lösche ihn wieder:

COMMENT ON TABLE meine_tabelle IS NULL;

Einige weitere Beispiele:

COMMENT ON AGGREGATE meine_aggregatfunktion (double precision) IS 'Berechnet Standardabweichung';
COMMENT ON COLUMN meine_tabelle.meine_spalte IS 'Angestelltennummer';
COMMENT ON DATABASE meine_datenbank IS 'Entwicklungsdatenbank';
COMMENT ON DOMAIN meine_domäne IS 'Domäne für Email-Adressen';
COMMENT ON FUNCTION meine_funktion (timestamp) IS 'Gibt römische Zahl zurück';
COMMENT ON INDEX mein_index IS 'Sorgt für die Eindeutigkeit der Angestelltennummer';
COMMENT ON OPERATOR ^ (text, text) IS 'Schnittmenge zwischen zwei Texten';
COMMENT ON OPERATOR ^ (NONE, text) IS 'Ein Präfixoperator für Text';
COMMENT ON RULE meine_regel ON meine_table IS 'Zeichnet Aktualisierungen von Angestelltendaten auf';
COMMENT ON SCHEMA mein_schema IS 'Abteilungsdaten';
COMMENT ON SEQUENCE meine_sequenz IS 'Wird zur Erzeugung von Primärschlüsseln verwendet';
COMMENT ON TABLE mein_schema.meine_tabelle IS 'Angestellteninformationen';
COMMENT ON TRIGGER mein_trigger ON meine_table IS 'Für referentielle Integrität';
COMMENT ON TYPE complex IS 'Datentyp für komplexe Zahlen';
COMMENT ON VIEW meine_sicht IS 'Sicht der Abteilungskosten';

Zurück	Zum Anfang	Nach vorne
CLUSTER	Nach oben	COMMIT