SQL$HELP72.HLB  —  COMMENT_ON, Arguments

1  –  CATALOG 

    Names the catalog for which you want to create a comment. If
    the catalog is not in the default schema, you must qualify the
    catalog name in the COMMENT ON statement with an alias name.

2  –  COLLATING_SEQUENCE 

    Names the collating sequence for which you want to create a
    comment. If the collating sequence is not in the default schema,
    you must qualify the collating sequence name in the COMMENT ON
    statement with an alias name.

3  –  COLUMN 

    Names the column for which you want to create a comment. You must
    qualify the column name with a table name. If the column is not
    in a table in the default schema, you must qualify the column
    name in the COMMENT ON statement with both a table name and an
    alias name.

4  –  CONSTRAINT constraint-name 

    Names the constraint for which you want to create a comment. If
    the constraint is not in the default schema, you must qualify the
    constraint name in the COMMENT ON statement with an alias name.

5  –  DATABASE 

    This statement writes the new comment to the database. If the
    ALIAS clause is omitted, the default database is used. The alias-
    name must be an alias specified by an ATTACH or CONNECT statement
    during this session.

6  –  DOMAIN 

    Names the domain for which you want to create a comment. If the
    domain is not in the default schema, you must qualify the domain
    name in the COMMENT ON statement with an alias name.

7  –  FUNCTION 

    Names the function for which you want to create a comment. If
    the function is not in the default schema, you must qualify the
    function name in the COMMENT ON statement with an alias name.

8  –  INDEX 

    Syntax options:

    INDEX index-name

    PARTITION partition-name

    Names the index and, optionally, a partition in the named index,
    for which you want to create a comment. If the index is not
    in the default schema, you must qualify the index name in the
    COMMENT ON statement with an alias name.

9  –  IS string 

    Specifies the comment. SQL displays the text when it executes
    a SHOW statement in interactive SQL. Enclose the comment within
    single quotation marks (')  and separate multiple lines in a
    comment with a slash mark (/).

10  –  MODULE 

    Names the module for which you want to create a comment. If the
    module is not in the default schema, you must qualify the module
    name in the COMMENT ON statement with an alias name.

11  –  PROCEDURE 

    Names the procedure for which you want to create a comment. If
    the procedure is not in the default schema, you must qualify the
    procedure name in the COMMENT ON statement with an alias name.

12  –  PROFILE 

    Names the profile for which you want to create a comment. If
    the profile is not in the default schema, you must qualify the
    profile name in the COMMENT ON statement with an alias name.

13  –  ROLE 

    Names the role for which you want to create a comment. If the
    role is not in the default schema, you must qualify the role name
    in the COMMENT ON statement with an alias name.

14  –  SCHEMA 

    Names the schema for which you want to create a comment. You must
    create the schema first. If the schema is not in the default
    schema, you must qualify the schema name in the COMMENT ON
    statement with an alias name.

15  –  SEQUENCE 

    Names the sequence for which you want to create a comment. If
    the sequence is not in the default schema, you must qualify the
    sequence name in the COMMENT ON statement with an alias name.

16  –  STORAGE_MAP 

    Syntax options:

    STORAGE MAP map-name

    PARTITION partition-name

    Names the storage map and, optionally, a vertical or horizontal
    partition within that storage map, for which you want to create
    a comment. If the storage map is not in the default schema, you
    must qualify the storage map name in the COMMENT ON statement
    with an alias name.

17  –  SYNONYM 

    This performs the same function as the ALTER SYNONYM . . . COMMENT
    IS syntax. The synonym-name must be the name of an existing
    synonym. A database alias can be used to select a database other
    than the default database alias.

18  –  TABLE 

    Names the table for which you want to create a comment. If the
    table is not in the default schema, you must qualify the table
    name in the COMMENT ON statement with an alias name.

19  –  table-name_col-name 

    Names the table and the column or columns in that table for which
    you want to create a comment.

20  –  TRIGGER 

    Names the trigger for which you want to create a comment. If
    the trigger is not in the default schema, you must qualify the
    trigger name in the COMMENT ON statement with an alias name.

21  –  USER 

    Names the user (created with the CREATE USER statement) for
    which you want to create a comment. If the user is not in the
    default schema, you must qualify the user name in the COMMENT ON
    statement with an alias name.

22  –  VIEW 

    Names the view for which you want to create a comment. If the
    view is not in the default schema, you must qualify the view name
    in the COMMENT ON statement with an alias name.
Close Help