FirebirdSQL logo
 CHARACTER SETData Manipulation-Statements (DML) 

COMMENT ON

Verwendet für

Metadaten dokumentieren

Verfügbar in

DSQL

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

<object> ::=
    {DATABASE | SCHEMA}
  | <basic-type> objectname
  | USER username [USING PLUGIN pluginname]
  | COLUMN relationname.fieldname
  | [{PROCEDURE | FUNCTION}] PARAMETER
      [packagename.]routinename.paramname
  | {PROCEDURE | [EXTERNAL] FUNCTION}
      [package_name.]routinename

<basic-type> ::=
    CHARACTER SET | COLLATION | DOMAIN
  | EXCEPTION     | FILTER    | GENERATOR
  | INDEX         | PACKAGE   | ROLE
  | SEQUENCE      | TABLE     | TRIGGER
  | VIEW
Table 1. COMMENT ON-Anweisungsparameter
Parameter Beschreibung

sometext

Kommentartext

basic-type

Metadaten-Objekttyp

objectname

Name des Metadatenobjekts

username

Benutzername

pluginname

Name des User-Manager-Plugins

relationname

Name der Tabelle oder Ansicht

fieldname

Name der Spalte

package_name

Name des Pakets

routinename

Name der gespeicherten Prozedur oder Funktion

paramname

Name einer gespeicherten Prozedur oder eines Funktionsparameters

Die Anweisung COMMENT ON fügt Kommentare für Datenbankobjekte (Metadaten) hinzu.Kommentare werden in der Spalte RDB$DESCRIPTION der entsprechenden Systemtabellen gespeichert.Clientanwendungen können Kommentare aus diesen Feldern anzeigen.

Note

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

  2. Standardmäßig erstellt die COMMENT ON USER-Anweisung Kommentare zu Benutzern, die vom Standardbenutzermanager verwaltet werden (das erste Plugin, das in der Konfigurationsoption UserManager aufgeführt ist).Das USING PLUGIN kann verwendet werden, um einen Benutzer zu kommentieren, der von einem anderen Benutzermanager verwaltet wird.

  3. Kommentare zu Benutzern werden für den Legacy_UserManager nicht gespeichert.

  4. Kommentare zu Benutzern werden in der Sicherheitsdatenbank gespeichert.

  5. SCHEMA ist derzeit ein Synonym für DATABASE;dies kann sich in einer zukünftigen Version ändern, daher empfehlen wir immer DATABASE zu verwenden
Warning

Kommentare zu Benutzern sind für diesen Benutzer über die virtuelle Tabelle SEC$USERS sichtbar.

Wer kann einen Kommentar hinzufügen

Die COMMENT ON-Anweisung kann ausgeführt werden durch:

  • Administratoren

  • Der Besitzer des Objekts, das kommentiert wird

  • Benutzer mit der Berechtigung ALTER ANY object_type, wobei object_type der Typ des kommentierten Objekts ist (z. B. PROCEDURE)

docnext count = 1

Beispiele mit COMMENT ON

  1. Kommentar zur aktuellen Datenbank hinzufügen

    COMMENT ON DATABASE IS 'It is a test (''my.fdb'') database';

  2. Kommentar für die Tabelle METALS hinzufügen

    COMMENT ON TABLE METALS IS 'Metal directory';

  3. Hinzufügen eines Kommentars für das Feld ISALLOY in der Tabelle METALS

    COMMENT ON COLUMN METALS.ISALLOY IS '0 = fine metal, 1 = alloy';

  4. Kommentar zu einem Parameter hinzufügen

    COMMENT ON PARAMETER ADD_EMP_PROJ.EMP_NO IS 'Employee ID';

  5. Hinzufügen eines Kommentars für ein Paket, seine Prozeduren und Funktionen sowie deren Parameter

    COMMENT ON PACKAGE APP_VAR IS 'Application Variables';

COMMENT ON FUNCTION APP_VAR.GET_DATEBEGIN
IS 'Returns the start date of the period';

COMMENT ON PROCEDURE APP_VAR.SET_DATERANGE
IS 'Set date range';

COMMENT ON
PROCEDURE PARAMETER APP_VAR.SET_DATERANGE.ADATEBEGIN
IS 'Start Date';