DISPLAY and PUNCH Syntax › DISPLAY/PUNCH INDEX

DISPLAY/PUNCH INDEX

The DISPLAY/PUNCH INDEX statement displays or punches an index from the dictionary.

Authorization

To issue a DISPLAY/PUNCH INDEX statement, you must either own or have the DISPLAY privilege on the table on which the index is defined.

Syntax

►►─┬─ DISplay ─┬── INDex index-name ── ON ─┬─────────────┬─ table-name ───────►
   └─ PUNch ───┘                           └─schema-name.┘

 ►─┬─────────────────────────────────────────────────────────────────────┬────►
   └──┬─ WITh ─────────┬──┬─ ALL ───────────────┬─── AS ─┬─COMments ◄──┬─┘
      ├─ ALSo WITh ────┤  ├─ NONe ──────────────┤        └─ SYNtax ────┘
      ├─ WITHOut ──────┤  ├─ DETails ───────────┤
      └─ ALSo WITHOut ─┘  ├─ HIStory ───────────┤
                          └─ TABles ────────────┘

 ►─┬───────────────────────┬──────────────────────────────────────────────────►
   └─ VERB ─┬─ CREate ◄──┬─┘
            ├─ DISplay ──┤
            ├─ DROp ─────┤
            └─ PUNch ────┘

 ►─┬───────────────────────┬──────────────────────────────────────────────────►◄
   └─ FULl ─┬─────────────┬┘
            └─ PHYsical ──┘

Parameters

index-name

Specifies the name of an index to display or punch. Index-name must be the name of an index in the dictionary.

ON table-name

Specifies the table on which the named index is defined.

schema-name.

Identifies the schema associated with the named table.

If you do not specify schema-name, it defaults to the current schema associated with your SQL session, if the statement is entered through the command facility or executed dynamically.

WITh

Lists the requested information, in addition to the information that is always included, such as the entity occurrence name.

WITHOut

Does not list the specified options. Other options in effect through the WITH or ALSO WITH clauses in the current DISPLAY statement are displayed.

ALSo WITh

Lists the requested information, in addition to the information requested in previously issued DISPLAY WITH and DISPLAY ALSO WITH statements for the named entity.

ALSo WITHOut

Does not list the specified options.

ALL

Specifies the display of all the information associated with the requested index.

NONe

Specifies the display of the name of the requested index. NONE is meaningful only when the WITH clause is specified.

DETails

Specifies the display of index-specific descriptions.

HIStory

Specifies the display of the date the index was created.

AS COMments

Outputs index syntax as comments with the characters *+ preceding the text of the statement. AS COMMENTS is the default.

AS SYNtax

Outputs index syntax which can be edited and resubmitted to the command facility.

VERB CREate/DISplay/DROp/PUNch

Specifies the verb with which the entity statement is to be displayed or punched. For example, if VERB CREATE is specified, the output of the DISPLAY/PUNCH statement is a CREATE statement; if VERB ALTER is specified, the output is an ALTER statement; and so on. The default is VERB CREATE.

FULl

Directs CA IDMS to display all attributes of the function except physical attributes.

PHYsical

Directs CA IDMS to display all attributes of the function including its physical attributes. This includes the function's synchronization timestamp.