COMMENT ON

The COMMENT ON statement adds a comment to the definition of a resource or object in the IMS catalog. You can alter a comment by reissuing the COMMENT ON statement.

Invocation

This statement can be submitted from a Java™ application program with an establish connection to IMS through the IMS Universal JDBC drivers. It is an executable statement that cannot be dynamically prepared.

COMMENT ON syntax

Read syntax diagramSkip visual syntax diagram COMMENT ON comment_optionISstring_constant

comment_option syntax

Read syntax diagramSkip visual syntax diagramDATABASEdatabase_namePROGRAMVIEWpsb_namecomment_suboptionINresource_name

comment_suboption syntax

Read syntax diagramSkip visual syntax diagramCOLUMNtable_name.column_nameCOLUMNtable_name.map_name.case_name.column_nameTABLEtable_nameTABLESPACEts_nameLCHILDtable_name.lchild_table_nameXDFLDtable_name.lchild_table_name.xdfld_nameMAPtable_.map_nameCASEtable_name.map_name.case_nameSCHEMApcb_nameSENSEGVIEWpcb_name.senseg_nameSENFLDpcb_name.senseg_name.senfld_name

Description

The following keyword parameters are defined for the COMMENT ON statement:
IS string_constant
Optional user comments. A 1 to 256 character string enclosed in single quotation marks. The value cannot contain the following characters:
  • Single quotation marks, except when they are used to enclose the full comment string. The following examples show correct and incorrect usages of single quotation marks:
        CORRECT
        IS 'These remarks apply to the XYZ application'
    INCORRECT
        IS 'These remarks apply to the 'XYZ' application'
  • Double quotation marks
  • Less than (< ) symbols
  • Greater than ( >) symbols
  • Ampersands (&)
IN resource_name
Specifies the resource that the comment applies to. The resource can be a database (DBD) or a program view (PSB). The name can be from 1 to 8 alphanumeric characters.
Omit the IN resource_name keyword for the following:
  • COMMENT ON DATABASE database_name
  • COMMENT ON PROGRAMVIEW psb_name
DATABASE database_name
Identifies the database. The name can be from 1 to 8 alphanumeric characters. Database resource must be previously defined.
PROGRAMVIEW psb_name
Identifies the PROGRAMVIEW or PSB. The name can be from 1 to 8 alphanumeric characters. PROGRAMVIEW must be previously defined.
COLUMN table_name.column_name
Identifies the column and table the column belongs to. The names can be from 1 to 128 alphanumeric characters. Column and table must be previously defined.
COLUMN table_name.map_name.case_name.column_name
Identifies the alternative column mapping and map case the column belongs to. The names can be from 1 to 128 alphanumeric characters. The table, map, case, and column must be previously defined.
TABLE table_name
Identifies the table. The name can be from 1 to 128 alphanumeric characters. Table must be previously defined.
TABLESPACE ts_name
Identifies the TABLESPACE. The name can be from 1 to 8 alphanumeric characters. TABLESPACE must be previously defined.
LCHILD table_name.lchild_table_name
Identifies the logical child table name specified on a LCHILD statement. The name can be from 1 to 128 alphanumeric characters. LCHILD table name and the table it belongs to must be previously defined.
XDFLD table_name.child_table_name.xdfld_name
Identifies the indexed data field specified on a XDFLD statement. The name can be from 1 to 26 alphanumeric characters. XDFLD name and the table it belongs to must be previously defined.
MAP table_name.map_name
Identifies the map. The name can be from 1 to 128 alphanumeric characters. The map and table names must be previously defined.
CASE table_name.map_name.case_name
Identifies the case. The name can be from 1 to 128 alphanumeric characters. The case, map, and table names must be previously defined.
SCHEMA pcb_name
Identifies the PCB. The name can be from 1 to 8 alphanumeric characters. The PCB name must be previously defined.
SENSEGVIEW pcb_name.senseg_name
Identifies the SENSEG. The name can be from 1 to 8 alphanumeric characters. The SENSEG and PCB names must be previously defined.
SENFLD pcb_name.senseg_name.senfld_name
Identifies the SENFLD. The name can be from 1 to 8 alphanumeric characters. The SENFLD, SENSEG, and PCB names must be previously defined.

Usage notes

Text that is submitted with this statement is stored in a REMARKS segment in the IMS catalog definition for the resource. The REMARKS segment that pertains to a resource or object is a direct child of that resource or object in the catalog.

Example

Example for specifying a comment on the database: 

COMMENT ON DATABASE dhvntz02 IS 'This describes database DHVNTZ02.'

Example for specifying a comment on a table: 

COMMENT ON TABLE root IN dhvntz02 IS 'This describes the root table.'

Example for specifying a comment on a tablespace: 

COMMENT ON TABLESPACE hidam IN dhvntz02 IS 'Dataset Group 1'