CDBDB

Summary

This command updates reference file relations in a database using SQL provided by CDBS. The SQL should contain insert/delete statements that correspond to each entry in a release catalog. New reference files result in database insertions, while obsolete reference files result in database deletions.

Description

If the CDB_DISK_CHECK resource option is TRUE, this command first verifies that the reference files listed in a release catalog are found on disk, either in the incoming directory or in the reference file directories. Next the database name (CDB_DB_NAME) is added to the CDBS-provided SQL and the SQL is executed. The SQL output is parsed for an indication that it succeeded (the string "OPUS_MODS_OK" occurs in the output if the entire SQL transaction was committed to the database).

Usage

cdbdb release_name path_name

[-localfiles] [-checkonly] The flags (preceded by a dash '-') are optional and can be specified in any order by any number of unique characters (e.g. -localfiles, -loc, -l are treated equally). The positional parameters 'release_name' and 'path_name' are required and MUST occur in the order listed.

Input

CDBS-provided SQL file(s).

OPUS path file.

OPUS resource file.

Output

Constraint

The SQL is only verified by searching for a string that indicates the database transaction was committed. No verification is performed to ensure that the database changes made have anything to do with the reference files listed in a particular release catalog. That confirmation is performed by the CDBVER command.

Resource File

CDB_DB_UPDATE

Flags if database updates are allowed. Can be obtained from path value OK_TO_UPDATE_DATABASE. Must be TRUE if SQL updates are to be performed.

The name of the database to be updated by the SQL. This can be a name which is obtained through the path file (e.g. OPUS_DB). The DSQUERY logical is always used to specify which server this database is located on.

The directory searched for release catalogs matching the mask provided for the release_name parameter. Successfully installed catalogs and SQL files will be removed from this directory. Use of the -localfiles qualifier supercedes this value.

The directory where incoming reference files and tables listed in a catalog will be found. Successfully installed files will be removed from this directory.

The directory searched for SQL files matching the mask provided for the release_name parameter. This value is usually the same as CDB_CATALOG_IN_DIR, but can be different. Use of the -localfiles qualifier supercedes this value.

.sql

.sqlout

NOTE: DO NOT USE A LOGICAL IN THE DEFINITION OF THIS PARAMETER.

VMS ONLY: THIS PARAMETER IS PASSED TO IRAF WHICH CURRENTLY CANNOT DEAL WITH A LOGICAL NAME. USE A FULL DIRECTORY PATH IN THE DEFINITION, EITHER IN CDB_UPDATE.RESOURCE, OR IN THE PATH FILE IF THIS PARAMETER IS LINKED TO A MNEMONIC IN THE PATH FILE.

If set to TRUE, this command will first verify that all reference files listed in the release catalog exist on disk, either in CDB_RETRIEVAL_DIR or in the reference file directories. If this check fails, the command will not execute. To suppress this check, set the value to FALSE. NOTE: Suppressing this value should only be done in special cases, where you need to load some SQL no matter what the result of the disk check is.

Required Command-Line Arguments

A newly released catalog file name. Wild card names are permitted. Will be searched for in CDB_CATALOG_IN_DIR unless the -localfiles flag is set on the command line, in which case the current directory is used.

Optional Command-Line Arguments

Optional flag specifying that only catalog verification is performed. This consists of locating the files listed in the catalog on disk and verifying that sufficient free disk space exists to perform the installation. No disk changes are made in this mode.

Optional flag specifying that CDBDB will look in the current working directory for the release catalogs. If no catalogs are found, no processing will be performed.

Examples

$ cdbdb opus_101_z.cat OPUS_DEFINITIONS_DIR:blue.path

Verifies that the files listed in the catalog opus_101_z.cat exist on disk in either the incoming (CDB_RETRIEVAL_IN_DIR) or reference file directories. Once verified the SQL file opus_101_z.sql is used to load the reference file relations in the database.