Utility Statements › PRINT INDEX › PRINT INDEX Parameter

PRINT INDEX Parameter

set-name

Specifies the name of the system-owned index or indexed set on which the PRINT INDEX statement is to report.

When processing a system-owned index, processing begins at the first SR8 record in the SR7-SR8 set.

SEGMENT

Specifies the segment containing the index structures to be reported. When using the FULL option, or when specifying a starting member dbkey, the member area must also exist in this segment.

segment-name

Specifies the name of the segment.

DBNAME

Specifies the database containing the index structures to be reported.

db-name

Specifies the name of the database.

USING subschema-name

Specifies the name of the subschema in which the named indexed set is included.

TABLE schema.table-id

Specifies the name of a table.

REFERENCED ROWID

For the named table, directs the PRINT INDEX utility to report on the index occurrence whose owner is the referenced row identified by occurrence-key.

REFERENCING ROWID

For the named table, directs the PRINT INDEX utility to report on the index occurrence containing the row ID of the referencing row identified by occurrence-key.

X'hex-database-key'

Specifies the hexadecimal database key of an owner or member record in the specified indexed set.

page-num

Specifies the page number of an owner or member record in the specified indexed set.

line-num

Specifies the line number of an owner or member record in the specified indexed set.

SR8

Identifies the index to be processed by specifying an index of an SR8 record in the index.

page-group

Identifies the page group of the SEGMENT where the index resides.

X'database-key'

Specifies the hexadecimal database key of the SR8 record.

page-num

Specifies the page number of the SR8 record.

line-num

Specifies the line number of the SR8 record.

ONLY

Directs the PRINT INDEX utility to report only on the SR8 record used as the entry point into the index.

ONLY is the default when you do not specify a portion of the index structure to report on.

TREE

Directs the PRINT INDEX utility to report on all the SR8 records in the index, starting with the top-level SR8. SR8s are processed by following the next pointers.

FULL

Directs the PRINT INDEX utility to report on:

• All the SR8 records in the index, starting with the top-level SR8. SR8s are processed by following the next pointers.
• The database key, index pointer value, and orphan condition of each member record in the index. Member records are processed by walking the bottom level of the index.

LEG

Directs the PRINT INDEX utility to report on the SR8 records connected by up pointers, starting with the SR8 used as the entry point into the index.

For an unsorted index or for an entry SR8 that is the top-level SR8 in a sorted index, specifying LEG has the same effect as specifying ONLY.

NEXT

Directs the PRINT INDEX utility to report on the SR8 records connected by next pointers in a single level of the index, starting with the SR8 used as an entry point into the index.

PRIOR

Directs the PRINT INDEX utility to report on the SR8 records connected by prior pointers in a single level of the index, starting with the SR8 used as an entry point into the index.

LVL

Directs the PRINT INDEX utility to report on all the SR8 records in a single level of the index.

level-number

Specifies the index level to report on; an integer in the range 0 through 255.

By default, if you do not specify an index level, the PRINT INDEX utility reports on the SR8s in the level of the SR8 record used as the entry point into the index.

SUMMARY

Requests a summary report for the target index.A summary report consists of three parts:

• Part 1 (header) provides general information on the index definition.
• Part 2 (main body) provides information on index owner occurrence(s). A system-owned index contains a single index owner; a user-owned index can contain more than one index owner.
• Part 3 (index overview) provides global statistical information for a user-owned index only.

A summary report on a system-owned index contains parts 1 and 2.

A summary report on a user-owned index always contains parts 1 and 3. Part 2 is included only in a detailed summary report.

ONLY

Requests a summary report with parts 1 and 3 for the target user-owned index. This parameter is ignored for a system-owned index. ONLY is the default.

DETAILED

Requests a summary report with parts 1, 2, and 3 for the target user-owned index. This parameter is ignored for a system-owned index.

DECIMAL

Directs the PRINT INDEX utility to print both the fixed and variable portions of each SR8 record in the report. Symbolic keys in the variable portion of each SR8 are printed in decimal (display) format.

DECIMAL is the default when you do not specify the way in which the contents of the SR8s in the index are to be printed.

HEX

Directs the PRINT INDEX utility to print both the fixed and variable portions of each SR8 record in the report. Symbolic keys in the variable portion of each SR8 are printed in hexadecimal format.

TERSE

Directs the PRINT INDEX utility to print only the fixed portion of each SR8 record in the report.