Firebird Documentation IndexFirebird 2.5 SprachreferenzStatements der Data Definition (DDL) → COMMENTS
Firebird Home Firebird Home Zurück: ROLEFirebird Documentation IndexNach oben: Statements der Data Definition (DDL)Weiter: Statements der Data Manipulation Language (DML)

COMMENTS

Inhaltsverzeichnis

COMMENT ON

Datenbankobjekte und eine Datenbank selbst können Kommentare enthalten. Es ist ein bequemer Mechanismus zur Dokumentation der Entwicklung und Pflege einer Datenbank. Kommentare, die mit COMMENT ON erstellt wurden, überstehen eine gbak-Sicherung und -Wiederherstellung.

COMMENT ON

Benutzt für:  Documentation von Metadaten

Verfügbar in: DSQL

Syntax: 

COMMENT ON <object> IS {'sometext' | NULL}

<object> ::=
    DATABASE
  | <basic-type> objectname
  | COLUMN relationname.fieldname
  | PARAMETER procname.paramname

<basic-type> ::=
  CHARACTER SET |
  COLLATION |
  DOMAIN |
  EXCEPTION |
  EXTERNAL FUNCTION |
  FILTER |
  GENERATOR |
  INDEX |
  PROCEDURE |
  ROLE |
  SEQUENCE |
  TABLE |
  TRIGGER |
  VIEW
        

Tabelle 5.46. COMMENT ON Statement-Parameter

Parameter Beschreibung
sometext Kommentartext
basic-type Metadatenobjekttyp
objectname Name des Metadatenobjekts
relationname Name der Tabelle oder View
procname Name der Stored Procedure
paramname Name des Stored Procedure Parameters


Die Anweisung COMMENT ON fügt Kommentare zu Datenbankobjekten (Metadaten) hinzu. Kommentare werden in Textfeldern des Typs BLOB in der Spalte RDB$DESCRIPTION der entsprechenden Systemtabellen gespeichert. Clientanwendungen können Kommentare aus diesen Feldern anzeigen.

Anmerkung

Wenn Sie einen leeren Kommentar ('') hinzufügen, wird dieser als NULL in der Datenbank gespeichert.

Der Eigentümer der Tabelle oder Prozedur und Administratoren haben die notwendigen Berechtigungen die Anweisung COMMENT ON zu verwenden.

Beispiele zur Verwendung von COMMENT ON: 

  1. Einen Kommentar für die aktuelle Datenbank hinzufügen
    COMMENT ON DATABASE IS 'It is a test (''my.fdb'') database';
                
  2. Einen Kommentar für die METALS-Tabelle hinzufügen
    COMMENT ON TABLE METALS IS 'Metal directory';
                
  3. Hinzufügen eines Kommentars zum Feld ISALLOY in der METALS-Tabelle
    COMMENT ON COLUMN METALS.ISALLOY IS '0 = fine metal, 1 = alloy';
                
  4. Einen Kommentar für einen Parameter hinzufügen
    COMMENT ON PARAMETER ADD_EMP_PROJ. EMP_NO IS 'Employee ID';
                
Zurück: ROLEFirebird Documentation IndexNach oben: Statements der Data Definition (DDL)Weiter: Statements der Data Manipulation Language (DML)
Firebird Documentation IndexFirebird 2.5 SprachreferenzStatements der Data Definition (DDL) → COMMENTS