Version 8.2.5
 —  Utilities  —

ONLREORFILE: Start Online Reorder Associator and Data for Files

The ONLREORFILE function starts an online process to reorder the Associator and Data Storage of specified files.

Notes:

  1. The online reorder process does not change the existing file extents but only reorganizes the file's index and Data Storage records within these extents.
  2. This function is not available in the Adabas Cluster Services or Adabas Parallel Services environments.
  3. Released index blocks are not put into the unused RABN chain.

graphics/util_adadbs_onlreorfile.png

This document covers the following topics:


Essential Parameters

FILE: File Number

FILE specifies the file to which the parameters that follow in the statement sequence apply.

Several files and their related parameters may be specified within one ONLREORFILE operation. In this case, the files are reordered in the specified sequence.

If a component file of an Adabas expanded file is specified, only that file's Associator and Data Storage is reordered; this has no adverse effect on the other component files.

The Adabas checkpoint or security file number must not be specified.

Top of page

Optional Parameters

ASSOPFAC: Associator Padding Factor

ASSOPFAC defines the new Associator block padding factor, which is the percentage of each Associator block not used during the reorder process. Specify a value in the range 1-90. The number of bytes free after padding must be greater than the largest descriptor value plus 10.

If this parameter is omitted, the current padding factor in effect for the file is used.

DATAPFAC: Data Storage Padding Factor

DATAPFAC specifies the new Data Storage padding factor. The number specified represents the percentage of each Data Storage block that remains unused when the file is reordered. A value in the range 1-90 may be specified (see the ADALOD utility for additional information about setting and using the Data Storage padding factor).

If this parameter is omitted, the current padding factor in effect for the file is used.

SORTSEQ: File Reordering Sequence

SORTSEQ determines the sequence in which the file is processed. If this parameter is omitted, the records are processed in physical sequence.

Note:
Records within a single Data Storage block are not sorted according to the specified sequence.

If a descriptor is specified, the file is processed in the logical sequence of the descriptor values. Do not use a hyperdescriptor, a phonetic descriptor, a multiple-value field, or a descriptor contained in a periodic group.

If ISN is specified, the file is processed in ascending ISN sequence.

PASSWORD: File Password

If the file is password-protected, use this parameter to specify the password.

NOUSERABEND: Termination without Abend

When a parameter error or a functional error occurs while this utility function is running, the utility ordinarily prints an error message and terminates with user abend 34 (with a dump) or user abend 35 (without a dump). If NOUSERABEND is specified, the utility will not abend after printing the error message. Instead, the message "utility TERMINATED DUE TO ERROR CONDITION" is displayed and the utility terminates with condition code 20.

Note:
When NOUSERABEND is specified, we recommend that it be specified as the first parameter of the utility function (before all other parameters). This is necessary to ensure that its parameter error processing occurs properly.

TEST: Test Syntax

The TEST parameter tests the operation syntax without actually performing the operation. Only the syntax of the specified parameters can be tested; not the validity of values and variables.

WAIT: Wait for End of Process

Specify WAIT if ADADBS is to wait for the end of the online process before proceeding either with the next function or with termination.

If WAIT is not specified, ADADBS proceeds immediately after initiating the online process.

Top of page

Example

Initiate an online process that reorders the Associator and Data Storage of file 10 first, and then file 11. The Associator padding factor of file 10 is to be 5 percent; the Data Storage padding factor of file 11 is to be 10 percent.

ADADBS ONLREORFILE FILE=10,ASSOPFAC=5
ADADBS             FILE=11,DATAPFAC=10

Top of page