Sybase Adaptive Server Anywhere - COMMENT Statement

COMMENT statement
418
COMMENT statement
Use this statement to store a comment in the system tables for a database
object.
COMMENT ON
{
COLUMN [
owner .] table-name . column-name
| EVENT event-name
| FOREIGN KEY [ owner .] table-name . role-name
| INDEX [ owner .] index-name
| JAVA CLASS java-class-name
| JAVA JAR java-jar-name
| LOGIN integrated_login_id
| PROCEDURE [ owner .] procedure-name
| TABLE [ owner .] table-name
| TRIGGER [ owner .] trigger-name
| USER userid
| VIEW [ owner .] view-name
}
IS
comment
comment:
{ string | NULL }
Must either be the owner of the database object being commented, or have
DBA authority.
Automatic commit.
Several system tables have a column named Remarks that allows you to
associate a comment with a database item (SYSUSERPERM, SYSTABLE,
SYSCOLUMN, SYSINDEX, SYSLOGIN, SYSFOREIGNKEY,
SYSPROCEDURE, SYSTRIGGER). The COMMENT ON statement allows
you to set the Remarks column in these system tables. A comment can be
removed by setting it to NULL.
For a comment on an index or trigger, the owner of the comment is the
owner of the table on which the index or trigger is defined.
♦
SQL/92 Vendor extension.
♦
Sybase Not supported by Adaptive Server Enterprise.
The following examples show how to add and remove a comment.
♦ Add a comment to the employee table.
COMMENT
ON TABLE employee
IS ’Employee information’
Function
Syntax
Permissions
Side effects
Description
Standards and
compatibility
Examples