Utility Descriptions

Utility Operations › Using the Utility Statements › Utility Descriptions

Utility Descriptions

Backup and recovery utilities

CA IDMS/DB provides the following utilities for backup and recovery operations:

Utility	Purpose
ARCHIVE JOURNAL	Offload disk journal files to archive files
BACKUP	Back up database areas
EXTRACT JOURNAL	Extract AFTR images from archived journal file and write them to an extract file; the extract file can be used as input to the ROLLFORWARD utility
FIX ARCHIVE	Rewrite a tape journal file
FIX PAGE	Verify or modify the contents of a database page
MERGE ARCHIVE	Merge archived journal files of data sharing group members. The output file can be used as input to the ROLLFORWARD, ROLLBACK, EXTRACT JOURNAL, and MERGE ARCHIVE utility statements.
PRINT JOURNAL	Report on transaction activity
RESTORE	Restore backed up database areas
ROLLBACK	Restore files or areas to earlier states using journal information
ROLLFORWARD	Update a backup copy of a file or area using journal information
UNLOCK	Remove locks from an area

Note: For more information about backup and recovery operations, see the sections on the individual utilities in this document or see the CA IDMS Database Administration Guide.

Log maintenance utilities

CA IDMS/DB provides the following utilities for maintaining the DC/UCF system log:

Utility	Purpose
ARCHIVE LOG	Offload system log to archive file
ARCHIVE TRACE	Offloads the contents of the DC/UCF trace area to an archive file.
PRINT LOG	Print all or part of a system log or archive log

Note: For more information about maintaining the system log, see the sections on the individual utilities in this document or see the CA IDMS System Operations Guide.

Area maintenance utilities

CA IDMS/DB provides the following utilities for database and journal file maintenance:

Utility	Purpose
CLEANUP	Erase logically deleted records
EXPAND PAGE	Increase page size for a database file
FIX PAGE	Verify or modify the contents of a database page
FORMAT	Prepare a file, area, or segment for use by CA IDMS/DB
INSTALL STAMPS	Store synchronization stamps for an SQL-defined database
LOCK	Lock an area or segment in a batch job
PRINT PAGE	Print the contents of database pages
PRINT SPACE	Report on space utilization in areas
SYNCHRONIZE STAMPS	Display the stamps in the catalog and the data area(s) and update the stamps
TUNE INDEX	Walk a sorted index to cause the adoption of orphaned index records
UNLOCK	Remove locks from an area
UPDATE STATISTICS	Update statistics used by CA IDMS/DB to optimize access to an SQL-defined database

Note: For more information about database area maintenance, see the chapters on the individual utilities in this document or see the CA IDMS Database Administration Guide.

Database loading and restructuring utilities

CA IDMS/DB provides the following utilities for loading and restructuring a database:

Utility	Purpose
BUILD	Build or rebuild indexes and build referential constraints for an SQL-defined database
CONVERT CATALOG	Convert the SYSTEM schema within a catalog to reflect the definition specified by the SYSTEM schema DDL delivered with the current release of CA IDMS
CONVERT PAGE	Change the page range for an area or change the maximum number of records that can be stored on a page of an area
CREATE DSMODEL	Create a temporary model of data set attributes to use for dynamic file allocation in conjunction with the REORG utility
FASTLOAD	Load data into a non-SQL-defined database for the first time
IDMSDIRL	Load the IDMSNTWK version 1 schema and the IDMSNWKA subschema into a data dictionary
IDMSRSTC	Generate IDMSRSTT macro statements for restructuring a non-SQL-defined database
LOAD	Load data into an SQL-defined database
MAINTAIN INDEX	Build, rebuild, or delete indexes in a non-SQL-defined database
RELOAD	Reload a database unloaded by UNLOAD
REORG	Unload and reload all or part of a database
RESTRUCTURE CONNECT	Connect new prior and owner pointers in existing sets in a non-SQL-defined database
RESTRUCTURE	Modify record occurrences to match new schema specifications
UNLOAD	Unload all or part of a database
VALIDATE	Check referential constraints for an SQL-defined database

Note: For more information about loading data into the database, see the chapters on the individual utilities in this document or see the CA IDMS Database Administration Guide.

Integrity checking utilities

CA IDMS/DB provides the following utilities for checking database integrity:

Utility	Purpose
IDMSDBAN	Analyze the structure of an existing non-SQL-defined database
PRINT INDEX	Report on system owned indexes and indexed sets
VALIDATE	Check referential constraints for an SQL-defined database

Note: For more information about checking database integrity, see the chapters on the individual utilities in this document or see the CA IDMS Database Administration Guide.

Database reporting utilities

CA IDMS/DB provides the following utilities for reporting on database structure and contents:

IDMSDBAN	Analyze the structure of an existing non-SQL-defined database
IDMSLOOK	Report on the contents of load modules
IDMSRPTS	Report on information stored in a data dictionary
PRINT INDEX	Report on system owned indexes and indexed sets
PRINT JOURNAL	Report on transaction activity
PRINT PAGE	Print the contents of database pages
PRINT SPACE	Report on space utilization in areas