Utility Function Summary

You can perform the following functions with DBUTLTY. Each of these functions is documented in detail in the following sections. The functions are discussed in alphabetical order.
datacom150
You can perform the following functions with DBUTLTY. Each of these functions is documented in detail in the following sections. The functions are discussed in alphabetical order.
Functions that have a Y in the SU column can be executed in Single User mode as well as with the MUF active. Any function that does not have a Y in the SU column can therefore only be executed when the MUF is enabled. An asterisk (*) in the SU column indicates one or more exceptions that are explained in the Description column.
When external security is turned on, most DBUTLTY functions require the MUF to be enabled, even those running in Single User mode, because the MUF is used for authorization purposes.
Function
SU
Description
ACCESS
 
Allows the ability to restrict access to a table, either from the database level or the area level.
ACCT
 
Provides options to edit an accounting database definition, catalog the definition to the Accounting Facility, and request an open, close, or spill of individual Accounting tables.
BACKUP
Y
Outputs a sequential data set containing a backup of the area specified. The Directory (CXX), any specific data area, or all areas in a database can be backed up.
COMM
 
Communicates a specific request to the MUF. Only the STATUS, SNAPCSA, and SNAPSVC options can be executed in both Single User mode and with an active MUF.
CONFIRM
 
Verifies that the data in a specific table adheres to SQL-defined integrity constraints.
CXXMAINT
 
Provides functions to maintain the Directory (CXX).
CXXCLONE
 
Clones an environment to a new environment that is modeled after an existing environment.
DBTEST
 
Executes one of the following test or analysis programs:
DBTSTPR
CA Datacom®/DB
Test Program The DBTSTPR program can run in Single User mode if NO is specified for the MULTUSE= keyword.
DBIDCPR
Index Area Analysis Program
DBIDPPR
Index Area Population Analysis Program
DEFRAG
 
Defragments or compresses the DXX, that is, the "lowest" level of the IXX that contains key values and pointers to actual rows.
EDIT
Y
Validates the syntax and content of the DBUTLTY commands and associated keywords, without invoking the functions.
ENCRYPT
 
Facilitates the data encryption feature of
CA Datacom®/DB
by using certain designated options.
EXTBKUP
 
Reads a backup file and writes extract data to a sequential output data set(s).
EXTEND
 
Formats additional space to extend an Index Area (IXX) or data area.
EXTRACT
Y
Outputs a
CA Datacom®/DB
table in expanded form to a sequential data set.
FILEOUT
 
Used to define output data sets, for example to define one or more output data sets used by the EXTBKUP function.
FLEXPOOL
 
Adds or deletes dynamic data area or Index Area (IXX or DXX) buffers to the system.
INIT
Y
Formats the Directory (CXX), Log Area (LXX), Index Area (IXX), Force Area (FXX), or data area for use by
CA Datacom®/DB
.
LINK
 
Links a data area or Index Area (IXX) to the Directory (CXX).
LOAD
Y
Reads data from a sequential or VSAM data set and loads this data into the specified area. LOAD only applies to a data area or the Directory (CXX).
LOCK
 
Locks a data area when you request a backup while the MUF is updating the data area.
MASSADD
 
Reads a sequential or VSAM input data set and adds the records to a specified
CA Datacom®/DB
table. MASSADD can run in Single User mode if NO is specified for the MULTUSE= keyword.
OLREORG
 
Reorganizes the database table without having to take it offline.
RECOVERY
 
Reprocesses maintenance transactions from a Recovery File (RXX) in either forward or backward mode. Forward recovery can be run in an active MUF mode or in a Single User mode while the MUF is up, providing that the database is closed and not being used. Backward recovery must, however, be run with the MUF active.
REMOVE
 
Deletes a key ID from the Index.
REORG
 
Provides a way to reorganize a large data area into
nearly 100 percent
Native Key sequence. The REORG function executes much faster than other reorganization options.
REPLACE
 
Provides the ability to load one table in a multiple table area with new data, replacing all current data for that table. It executes in the MUF and allows full read and update access to every other table in the same area and database to other applications in the same MUF.
REPORT
 
Prints one of the following reports:
Directory (CXX) Report
Summary Space Utilization Report
Index Area (IXX) report
Database History Report
Log Area (LXX) Report
Statistics and Diagnostics Area (PXX) Report
Recovery File (RXX) Analysis Report
Split File Analysis Report
Data Area Space Estimation Report
SVC report
Utility Function History Report (TYPE=H)
RESET
Y
Resets the Log Area (LXX) as empty, or resets the Directory (CXX) exclusive control flags and sets database update and read controls to zero.
RETIX
 
Reads the area indicated (or all areas in a database) and rebuilds the data space index or the entire Index Area (IXX) information for that area based on the current data area information. You can also use the RETIX function to reset the Transaction Sequence Number (TSN).
RXXFIX
Y
Reconstructs log records being spilled to the Recovery File (RXX), if they had no End-of-File or trailer records as a result of an operating system or MUF abend.
SECURITY
 
Clears cached permissions after making security changes.
SET
 
Allows you to establish how you want DBUTLTY to support error handling of functions within a specific execution. SET also allows debugging tools and tuning options to be specified.
SPILL
 
Moves transactions that can be spilled from the Log Area (LXX). We recommend you use the SPILLOPT function instead of the SPILL function (see the following). SPILL works the same as SPILLOPT SPILL=MAX.
SPILLOPT
 
Allows you to specify MAX or MIN when requesting a spill. Also allows the setting to allow update of a SPILL history table to record SPILL activity.
UNLOCK
 
Unlocks the data area you locked with the LOCK function and allows update access to the area.