COMMENT

Tip

Find a more recent version at Firebird 5.0 Language Reference: Comments

Available in: DSQL

Added in: 2.0

Description: Allows you to enter comments for metadata objects. The comments will be stored in the various RDB$DESCRIPTION text BLOB fields in the system tables, from where client applications can pick them up.

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

Note

If you enter an empty comment (''), it will end up as NULL in the database.

Examples:

comment on database is 'Here''s where we keep all our customer records.'

comment on table Metals is 'Also for alloys'

comment on column Metals.IsAlloy is '0 = pure metal, 1 = alloy'

comment on index ix_sales is 'Set inactive during bulk inserts!'