CHECK INDEX options
CHECK INDEX syntax diagrams
CHECK INDEX command syntax illustrates the syntax of the CHECK INDEX command.
Below provides syntax diagram details. Each detail diagram is numbered to correspond to a preceding section of the CHECK INDEX syntax diagram or to another section of the detail.
CHECK INDEX syntax diagram detail
CHECK INDEX option descriptions
This topic describes each CHECK INDEX command option. The options are described in the order in which they appear in the CHECK INDEX syntax diagram.
CHECK INDEX
CHECK INDEX checks the consistency of one or more indexes in the below space.
Value | Description |
|---|---|
NAME | The NAME option allows you to specify one or more indexes that you want to check. If you specify more than one index name, they must belong to the same below space. Restriction |
(ALL) | For compatibility with the IBM CHECK INDEX utility command syntax, you can specify (ALL) to indicate that you want CHECK PLUS to check all indexes in the specified below space. |
TABLESPACE | The TABLESPACE option allows you to specify a below space for which you want all indexes checked. You must specify the fully qualified name of the below space. |
PART
The PART option tells CHECK PLUS the partition numbers of the partitioned index spaces to check. You can specify one, some, or all of the partitions either individually or by specifying a range of partitions. If you do not specify PART, CHECK PLUS checks all partitions of the index space.
Specifying partition numbers
Note the following information about specifying partition numbers with the PART option:
- Individual partitions in a list can be in any order (but partitions within a range must be in ascending order).
- You can specify a mixture of individual partitions and ranges of partitions.
- If you specify a partition number more than once, CHECK PLUS ignores any occurrence after the first.
- You can specify integer values from 1 through 4096.
The following example illustrates a valid PART specification for parts 1 through 5, 7, and 10:
Restriction
If you use the PART option, you cannot specify nonpartitioned indexes.
SHRLEVEL
The SHRLEVEL option specifies the level of access that concurrently operating Db2 applications and utilities have to the target spaces.
The following table describes the valid values for the SHRLEVEL option.
Value | Description |
|---|---|
REFERENCE | (Default) Enables read-only access to the target spaces during check processing. |
CHANGE | Enables read/write access to the table space. CHECK PLUS uses the snapshot-processing features of SUF (also known as XBM) to create a consistent image of the data, which CHECK PLUS uses for check processing. You must specify an appropriate SUF (also known as XBM) subsystem ID with the XBMID installation (XBMID=) or command option. For more information about using the snapshot-processing features of SUF (also known as XBM) with CHECK PLUS, see SHRLEVEL CHANGE. |
ZIIP
The ZIIP option tells CHECK PLUS whether to attempt to use IBM System z Integrated Information Processors (zIIPs). CHECK PLUS can use enclave service request blocks (SRBs) to enable zIIP processing automatically while running jobs. Using zIIP processing can reduce the overall CPU time for CHECK PLUS jobs.
Specifying the default
You can specify the default for the ZIIP command option in your installation options module by using the ZIIP installation option XBMID=). CHECK PLUS was shipped with a default value of ENABLED for this option. The ZIIP command option overrides the default that is in the installation options module.
The following table describes the valid values for the ZIIP option.
Value | Description |
|---|---|
ENABLED | CHECK PLUS attempts to offload eligible processing to an available zIIP. If the zIIP is busy or not available, normal processing continues on a general-purpose processor. To enable and use zIIP processing with CHECK PLUS, follow these steps:
|
DISABLED | CHECK PLUS does not attempt to use zIIP processing. |
Using SUF (also known as XBM)
You can specify a particular SUF (also known as XBM) subsystem to use for zIIP processing by specifying a value for the XBMID installation or command option. For more information, see XBMID=
SUF(also known as XBM) are licensed, installed, and maintained separately from CHECK PLUS. You can use either SUF (also known as XBM), depending on the license that you have obtained:
- License for the full version of the SUF (also known as XBM) product authorizes you to use all features of SUF (also known as XBM).
- License for SUF (also known as XBM) authorizes you to use only the snapshot and zIIP processing features of SUF (also known as XBM).
For more information about SUF (also known as XBM), see the
documentation.
XBMID
Specify XBMID to identify the appropriate active SUF (also known as XBM) subsystem when you use either SUF (also known as XBM) with CHECK PLUS. You must specify an SUF (also known as XBM) subsystem in either of the following cases:
- You are specifying SHRLEVEL CHANGE (which uses the snapshot-processing functionality of SUF (also known as XBM).
- You want to use a specific SUF (also known as XBM) subsystem for zIIP processing.
The variable ssid (subsystem ID) is the unique identifier that you specified when you installed SUF (also known as XBM). If you are using XBM or SUF (also known as XBM) in a Db2 data sharing environment, you can use the value of the XBMGROUP parameter in place of ssid. The XBMGROUP is the name of the cross-system coupling facility (XCF) group that is defined to the SUF (also known as XBM) subsystem, and its default value is XBMGROUP.
For more information about using the snapshot-processing feature of SUF (also known as XBM) with CHECK PLUS, see SHRLEVEL CHANGE. For detailed information about SUF (also known as XBM), see the
documentation. .
zIIP processing
If you specify an SUF (also known as XBM) subsystem and ZIIP ENABLED is in effect, CHECK PLUS attempts to use that subsystem to enable zIIP processing. If that subsystem is not available or not at the correct maintenance level, zIIP processing is not enabled.
If you do not specify an SUF (also known as XBM) subsystem (either here or with the XBMID installation option), CHECK PLUS searches for an SUF (also known as XBM) subsystem at the appropriate maintenance level to enable zIIP processing.
Specifying the default
You can specify the default for the XBMID command option in your installation options module by using the XBMID installation option XBMID=). If the XBMID is not assigned in the installation option, you must specify this command option if you specify SHRLEVEL CHANGE.
WTOMSG
The WTOMSG command option is applicable only when running SHRLEVEL CHANGE.
Specify WTOMSG SUFSTART to write message BMC50008I to the MVS system log to indicate that snapshot-processing initialization for CHECK PLUS has successfully completed. You can use the text of this message to trigger the submission of jobs that you want to run concurrently with the CHECK PLUS job.
Specify a text string of up to 50 characters enclosed in single quotation marks to indicate the message that you want CHECK PLUS to print in the MVS system log. CHECK PLUS truncates strings that are greater than 50 characters. Quotation marks cannot appear within the text string.
CHECKIXLEVEL
The CHECKIXLEVEL option specifies which checks CHECK PLUS performs on the named indexes. For detailed information about specific fields and values checked for each CHECKIXLEVEL, see Fields-and-values-checked-in-tables-and-indexes.
Value | Description |
|---|---|
2 | (Default) CHECKIXLEVEL 2 performs all CHECKIXLEVEL 1 checks plus checks on the correct relationships between index keys and below rows. KEYSONLY—Performs checks only on the correct relationships between index keys and below rows and does not perform the page structure checks of CHECKIXLEVEL 1. |
1 | CHECKIXLEVEL 1 performs checks on index header pages, space map pages, and root and leaf pages in the index. |
CHECKTSLEVEL
The CHECKTSLEVEL command option is applicable only if you specify CHECKIXLEVEL 2.
CHECKTSLEVEL specifies which table space checks, if any, CHECK PLUS performs in addition to index checking.
Value | Description |
|---|---|
1 | (Default) CHECK PLUS performs checks on all pages in the below space that is associated with the index or indexes that you are checking. CHECK PLUS performs this check as described in the CHECKTSLEVEL 1 option of the CHECK TABLESPACE command on CHECKTSLEVEL. |
2 | CHECK PLUS performs additional checks on all pages in the below space that is associated with the index or indexes you are checking. These additional checks are described in the CHECKTSLEVEL 2 option of the CHECK below SPACE command on CHECKTSLEVEL. |
0 | CHECKTSLEVEL 0 tells CHECK PLUS to perform no checks on below space pages other than those performed normally when reading rows from the below space. |
RULES
The RULES command option is applicable only if you specify CHECKTSLEVEL 2.
You can use the RULES option to specify user-defined column condition rules.
Value | Description |
|---|---|
FOR below | Specifies the below to which the user-defined column condition rules apply. Restriction
|
VERIFY | Specifies the column condition that you want CHECK PLUS to check or verify. CHECK PLUS verifies that values in specified columns are within the domain that the condition criteria establish. For a detailed description of the VERIFY option, see VERIFY. To validate Unicode data using CHECK PLUS, specify character constants as hexadecimal constants. |
VERIFYONLY
The VERIFYONLY command option is applicable only if you specify VERIFY or if the below check constraints exist.
This option allows you to check column-level conditions (below check constraints or rules specified with the RULES option) without page checking. For a detailed description of the VERIFY option, see VERIFY.
EXCEPTIONS
The EXCEPTIONS option tells CHECK PLUS to terminate processing when the specified number of constraint violations is exceeded. The default value of 0 indicates that there is no report limit on the number of errors. CHECK PLUS applies duplicate errors to this count.
SORTDEVT
Use this option to specify the device type for the sort work files that BMCSORT will allocate dynamically. This option overrides the value that was specified in the BMCSORT DYNALOC installation option.
SORTSTCLAS
The SORTSTCLAS option affects what STORCLAS AMISORT uses when dynamically allocating sort work files.
This option is meaningful only when DIRECT YES is in effect.
You can specify a valid DFSMS STORCLAS.
SORTNUM
The SORTNUM option affects the allocation of sort work files when BMCSORT is allocating your sort work files dynamically. You can specify any integer value from 0 through 255.
The following table describes the action that BMCSORT takes for each value that you can specify for this option and any additional considerations:
Value | Description | Additional considerations |
|---|---|---|
0 | BMCSORT honors the value of the third parameter of the BMCSORT DYNALOC installation option. (This parameter tells BMCSORT whether to dynamically allocate sort work files.) | For more information about this parameter, see DYNALOC-installation-option. |
1–32 | BMCSORT dynamically allocates the number of sort work files that it needs, up to 32 minus any sort work files that are allocated in your JCL. This number is per sort task. | None |
33–255 | BMCSORT dynamically allocates the number of sort work files that it needs, up to the number that you specify minus any sort work files that are allocated in your JCL. This number is per sort task. | None |
Specifying a value greater than 0 for the SORTNUM option also produces the following results:
- If the value of the third parameter in the BMCSORT DYNALOC installation option is OFF, specifying a value greater than 0 for the SORTNUM option turns BMCSORT dynamic allocation on, and BMCSORT allocates sort work files as needed.
- This option provides the information that lets CHECK PLUS run multiple concurrent sort tasks when applicable. If you do not specify a value greater than 0 for this option and BMCSORT is allocating your sort work files, CHECK PLUS uses a single sort task.
The sort work files that BMCSORT allocates dynamically might be used in one of the following circumstances:
- When you do not specify any SORTWK DD statements in your JCL.
- When BMCSORT determines that there is a need for additional data sets (in addition to any sort work data sets that you specify in your JCL).
Specifying the default
You can specify the default for the SORTNUM command option in your installation options module by using the SORTNUM installation option (SORTNUM=32). CHECK PLUS was shipped with a value of 32; however, the value might have been changed during installation. The command option overrides the default that is in the installation options module.
MAXTASKS
The MAXTASKS option specifies the maximum number of sort tasks CHECK PLUS can run concurrently. Like other BMC Software utilities for Db2, CHECK PLUS optimizes elapsed time by using all available resources. However, if you need to provide greater control over allocated resources, the MAXTASKS option allows you to restrict the number of concurrent tasks.
Restricting the number of concurrent sorting tasks is important because sorting can consume a significant amount of system resources. Sorting is performed only for CHECKIXLEVEL 2, which is the default.
Specifying the default
You can specify the default for the MAXTASKS command option in your installation options module by using the SMAX installation option. CHECK PLUS was shipped with a default value of 16 for this option; however, the value might have been changed during installation. The command option overrides the default that is in the installation options module.
DRAIN_WAIT
The DRAIN_WAIT option specifies the drain timeout value that you want CHECK PLUS to use.
Specifying the default
You can specify the default for the DRAIN_WAIT command option in your installation options module by using the DRNWAIT installation option (DRNWAIT=NONE). CHECK PLUS was shipped with a default value of NONE for this option; however, the value might have been changed during installation. The command option overrides the default that is in the installation options module.
The following table describes the valid values for the DRAIN_WAIT option:
Value | Description |
|---|---|
NONE | The drain request issued by CHECK PLUS times out immediately if the drain cannot acquire the lock. NONE prevents any application transactions from being queued during the drain process. We recommend that you specify NONE in high-transaction environments, such as SAP. |
UTIL | CHECK PLUS uses the standard Db2 utility timeout value defined in DSNZPARMS for your site (IRLMRWT multiplied by UTIMOUT). The wait time applies to each object involved in the check. |
SQL | CHECK PLUS uses the standard SQL timeout value (IRLMRWT) as the drain timeout value. The wait time applies to each object involved in the check. If it cannot drain all of the objects within the time period specified by DRAIN_WAIT, CHECK PLUS releases the drains that it has obtained so far, waits the time that you specified in RETRY_DELAY, and tries to drain the objects again for the number of times that you specified in RETRY. |
RETRY
The RETRY option specifies the maximum number of times that CHECK PLUS attempts to obtain a drain before the job terminates. The number of attempts can range from 0 through 255.
Specifying the default
You can specify the default for the RETRY command option in your installation options module by using the DRNRETRY installation option (DRNRETRY=255). CHECK PLUS was shipped with a default value of 255 for this option; however, the value might have been changed during installation. The command option overrides the default that is in the installation options module.
RETRY_DELAY
After a drain time out, the RETRY_DELAY option specifies the minimum number of seconds that CHECK PLUS waits before it tries again to obtain the drain. The number of seconds can range from 1 through 1800.
Specifying the default
You can specify the default for the RETRY_DELAY command option in your installation options module by using the DRNDELAY installation option (DRNDELAY=1). CHECK PLUS was shipped with a default value of 1 for this option; however, the value might have been changed during installation. The command option overrides the default that is in the installation options module.
DSPLOCKS
The DSPLOCKS option tells CHECK PLUS what action to take regarding displaying claims and locks if a drain attempt times out.
Specifying the default
You can specify the default for the DSPLOCKS command option in your installation options module by using the DSPLOCKS installation option. CHECK PLUS was shipped with a default value of DRNFAIL for this option; however, the value might have been changed during installation. The command option overrides the default that is in the installation options module.
The following table describes the valid values for the DSPLOCKS option:
Value | Description |
|---|---|
DRNFAIL | If you specify DRNFAIL, CHECK PLUS displays the claims and locks once, after the final attempt to obtain the drain times out. |
NONE | If you specify NONE, CHECK PLUS does not display any claims or locks. |
RETRY | If you specify RETRY, CHECK PLUS displays claims and locks after each drain timeout. |