Previous Topic: Dynamic Extend during RETIXNext Topic: Example JCL


How to Use

You can execute this command in either Single User or Multi-User mode. Execute the RETIX function using the following command format.

Rebuilding a Full Index Area

►►─ RETIX DBID=n ─┬────────────────────────┬──────────────────────────────────►
                  └─ ,OPTIMIZE= ─┬─ NO ──┬─┘
                                 └─ YES ─┘

 ►─┬───────────────────────────────────────┬──────────────────────────────────►
   └─ ,OPTION1='PRINT=CRITICAL,ROUTE=LOG' ─┘

 ►─ ,SORT=n ─┬───────────────────────┬─┬─────────────┬────────────────────────►◄
             └─ ,VERIFY= ─┬─ NO ◄ ─┬─┘ └─ ,SORTWK=n ─┘
                          └─ YES ──┘

Rebuilding an Area's Index in Single User

►►─ RETIX DBID=n,AREA=a ─┬────────────────────────┬───────────────────────────►
                         └─ ,OPTIMIZE= ─┬─ NO ──┬─┘
                                        └─ YES ─┘

 ►─┬───────────────────────────────────────┬──────────────────────────────────►
   └─ ,OPTION1='PRINT=CRITICAL,ROUTE=LOG' ─┘

 ►─ ,SORT=n ─┬───────────────────────┬─┬─────────────┬────────────────────────►
             └─ ,VERIFY= ─┬─ NO ◄ ─┬─┘ └─ ,SORTWK=n ─┘
                          └─ YES ──┘

 ►─┬────────────────────────┬─────────────────────────────────────────────────►◄
   └─ ,MINIMAL= ─┬─ NO ◄ ─┬─┘
                 └─ YES ──┘

Rebuild an Area's Index Area in Multi-User

►►─ RETIX DBID=n,AREA=a,SORT=n ─ ,MULTUSE= ─┬─ NO ◄ ─┬────────────────────────►
                                            └─ YES ──┘

 ►─┬───────────────────────────────────────┬─┬─────────────┬──────────────────►
   └─ ,OPTION1='PRINT=CRITICAL,ROUTE=LOG' ─┘ └─ ,SORTWK=n ─┘

 ►─┬────────────────────────┬─────────────────────────────────────────────────►◄
   └─ ,MINIMAL= ─┬─ NO ◄ ─┬─┘
                 └─ YES ──┘

Command

RETIX

Invokes the function to rebuild a data space index or Index Area.

Required Keywords

DBID=

Specifies the database for which the Index Area is to be rebuilt.

Valid Entries:

DATACOM-ID of the database

Default Value:

(No default)

Optional Keywords

,AREA=

Identifies the data area or all areas in the database for which the Index Area is to be rebuilt. If this parameter is omitted, all areas are processed.

Valid Entries:

DATACOM-NAME of the area in the database

Default Value:

All areas are processed

MINIMAL=

Specifying MINIMAL=NO (the default) requires the RETIX function to perform everything it did in releases prior to Version 12.0. If MINIMAL=YES is specified, however, RETIX does only the minimal actions necessary to correct the key definition index for tables in the area.

Note: MINIMAL=YES requires SORT= to be specified with a value greater than 0 (zero).

For key definitions marked not-loaded, only those keys participate in the normal RETIX process.

For key entries in the index that have no current key definition, the low-level (DXX) blocks of the index are sequentially searched for pointers that need to be deleted.

MINIMAL=YES is only allowed at the area level (full database processing is invalid), and is only available for areas that are loaded in the URI format. When you specify MINIMAL=YES, make certain that every table in the area is loaded and has its URI index loaded.

Messages DB13283E is related to the use of the MINIMAL= keyword. For details about this message, see the CA Datacom/DB Message Reference Guide.

For information about changes in the RETIX report when MINIMAL= is used, see RETIX Report Changes Related to MINIMAL=.

Valid Entries:

YES or NO

Default Value:

NO

,MULTUSE=

Specifying MULTUSE=YES allows a single area in a database to have its index rebuilt, with no loss of read and update access to other areas in the database. When MULTUSE=YES, the function executes in a new format that is a combination of Multi-User Facility and Single User modes. The database involved must be able to be opened for update in the Multi-User Facility address space. The area, however, must have no tables open. If the database is currently open, CA Datacom/DB closes this area with the area close (you would need to close the area yourself only if the database is open and you need the Multi-User Facility to close it, so that any type of open data set lock can be released, which could be necessary in order to scratch and reallocate the data set). Once started, the function does not allow other tasks to open any tables in the area being processed. Other tables in the involved database, but not in the area, may be open for read or update in the same Multi-User Facility. With MULTUSE=YES:

When MULTUSE=YES, the SORT= option must be specified but not as zero (0). When MULTUSE=YES, the following options are not allowed to be specified: OPTIMIZE= and VERIFY=.

When MULTUSE=NO is specified or is allowed to default in the LOAD and RETIX functions, the functions execute as in versions prior to Version 11.0, that is, the database involved may not be open for update, and all processing executes in the Single User mode.

For more information on area level DBUTLTY control, see Area Level DBUTLTY Control.

Valid Entries:

NO or YES

Default Value:

NO

,OPTIMIZE=

Specifies whether the Index entry creation optimization option is to be used. When YES is selected, if this Index Retrieve fails for any reason, reinitialize the Index Area. If any other data areas are already loaded, re-create the Index entries using this function of DBUTLTY, or reload all areas. If you select YES, you must also specify a value in the SORT= parameter.

NO

All Index entries are to be validated as they are created.

YES

All Index entries are not to be completed until the Index retrieve terminates. Selection of this option enhances performance by deferring Index pointer validation and complete Index structure update.

Note: Do not specify this option if MULTUSE=YES is specified.

Valid Entries:

NO or YES

Default Value:

NO (if one area is specified)
YES (if the full database is processed)

,OPTION1=

(z/VSE only) Specifies the options for the associated sort/merge program application. The values for this keyword must be 44 characters or less, and they must be enclosed in quotes. Depending on the features of your installations sort, the values that apply to this keyword can vary. CA Datacom/DB does not edit anything that you place inside of the quotes.

Valid Entries:

Any values that your installation's sort allows. These values must be less than 44 characters and be inside quotes.

Default Value:

CRITICAL for PRINT

LOG for ROUTE

,SORT=

Activates the Index Area entry sort option. When you specify a value, no Index Area entries are created as the data is retrieved. The required Index Area entries are sorted at the end of the data retrieval and merged into the Index Area in ascending sequence. Selecting this option enhances the performance of the Index Retrieve process for large databases. It is highly recommended when the number of records exceeds several hundred.

Note: The SORT option is required when specifying the RETIX function for the full database, or if you specify VERIFY=YES, OPTIMIZE=YES, or MULTUSE=YES.

Specify that the sort is to be used by entering a non-zero number. Any number from 1 to 999999999 is valid.

If sort is selected by entering a non-zero number, the Index entries in the Index Area (IXX) are not deleted by a separate Index pass. The Index Area is updated and only the Index blocks that reflect changes are written. If the SORT option is used, the partition size should be at least one megabyte.

Note: Do not specify over 99 million unless you verify that the sort package you are using allows a larger number.

Specifying SORT=0 (or any number of zeros) is the same as not specifying the keyword.

Many features introduced in previous releases require a non-zero value for SORT=, and the following two features, new for Version 12.0) that are also blocked during LOAD or RETIX executions when the sort option is not being used are as follows:

Most user-JCL is expected to already have a non-zero value for SORT= specified. If, however, a user has a LOAD or RETIX function coded in their JCL with SORT=0 specified or defaulted (SORT= not specified at all), beginning with Version 12.0 this information is added to the history report, and the first time in each MUF execution that an area is opened in a database that has a Version 12.0 LOAD or RETIX coded without the sort option, an informational message is generated. The message alerts you to the condition and can therefore help you know to first add the sort option, then see the results.

Two messages related to using LOAD and RETIX without the sort option are messages DB02809I and DB13128E. For details about these messages, see the CA Datacom/DB Message Reference Guide.

Valid Entries:

0 to 99999999999

Default Value:

(No default)

,SORTWK=

Specifies the number of sort work areas. The parameter is always edited, but is only used when the SORT= parameter is specified as not zero.

Note: Do not specify a 2-digit number unless the sort package you are using allows a 2-digit number. Sort packages that do not support a 2-digit number can fail in an unpredictable manner, if you specify a 2-digit number.

Valid Entries:

0 to 99

Note: Do not use two-digit numbers unless the SORT package to be used supports the larger number.

Default Value:

3

,VERIFY=

Verifies if the Index Area and data area are in exact agreement. It is only used when the SORT= parameter is specified as not zero.

Specify VERIFY=YES to activate the search for differences in the current Index and the Index being built. If a difference is detected, a Master List dump is produced. Only the first five differences cause a dump. Any additional differences are ignored.

The dumps have no effect on the execution of the RETIX function which continues to successful completion regardless of the value specified for the VERIFY option.

If you specify VERIFY=YES, you must specify the SORT option. If you do not specify SORT= when using VERIFY=YES, the first five records found cause a Master List dump whether or not a difference is found between the current Index and the Index being built.

Do not specify VERIFY=YES if you are using the RETIX function for the full database. Using the VERIFY is also not recommended for non-URI areas because records that have been moved are dumped, even though this condition is not an error.

Note: Do not specify this option if MULTUSE=YES is specified.

Valid Entries:

NO or YES

Default Value:

NO