COMMENT [ON] object_kind object_reference
INTO [:] host_variable_name
[ [ INDICATOR ] :host_indicator_name ]
Syntax Elements
- object_kind
- One of these objects:
- COLUMN
- DATABASE
- FUNCTION
- MACRO
- PROCEDURE
- PROFILE
- ROLE
- TABLE
- TRIGGER
- USER
- VIEW
- object_reference
- One of these object references:
- Column name
- Database name
- Macro name
- Procedure name
- Profile name
- Role name
- Table name
- Trigger name
- User name
- User-defined function name
- View name
- host_variable_name
- The name of the host variable into which the comment is to be placed.
- The preceding COLON is optional; however, its use is strongly recommended.
- Blanks before and after the colon are optional.
- The rules for the name follow the client programming language conventions.
- host_indicator_name
- The name of the host indicator variable.