Service Program rodbucx<os>

Call Format and Parameters

Use this format for calling rodbucx<os>:

rodbucx<os> [<section> [<inifile>]] [<options>]

where:

<os>	Label for the operating system. These values are possible: • M for z/OS • N for Windows • U for UNIX
<section>	Name of the server start section in the server initialization file.
<inifile>	Server initialization file.
<options>	General and database maintenance options. For more information, see General Options and Database Maintenance Options, respectively.

General Options

The general options of rodbucx<os> mainly serve as control options for the program:

Option	Description
-d=<path>	Specifies the path for a temporary directory (specified with -compress, and -defrag).
-db=<db_section>	Causes the specified options to be applied to the database specified in the section <db_section> of the initialization file.
-dba[ll]	Boolean flag; if set, the selected operations are applied to all databases made available in the <server_start> section. Applies to UNIX and Windows only.
-h[elp]	Displays Help information.
-memory=<kb>	Sets the size for memory (RAM or region) that can be used for sorting operations.
-no[progress]	Deactivates the progress display (default for z/OS specified with -check, -compress, -defrag, -itemsize, and -verify).
-p[rogress]	Activates the progress display (default for Windows and UNIX specified with -check, -compress, -defrag, -itemsize, and -verify).
-size	Computes the size of the temporary files.
-sortfl<n>=<file> -numcat=<file> -numbl=<file> -scope=<file> -ident=<file>
	File names for temporary files (specified with -defrag, -itemsize, -repair, and -verify).
-verb[ose]	Returns additional information.

These rules hold for the general options:

•

rodbucx<os> processes databases as directed by the specified options. If no options are specified, the program will list the program syntax.

•

rodbucx<os> can only process databases that are assigned via the setting DATABASE<n>=<db_section> in the section <section> of the initialization file <inifile>. For more information, see <server_start> Section.

If you do not specify <section> or <inifile>, rodbucx<os> will assume ROSRV or ROCHADE.INI, respectively, by default.

•

Depending on whether you specify -db=<db_section> or -dball, rodbucx<os> will apply the specified functions to a particular database or to all the databases specified in <section>. Of the options -db=<db_section> and -dball, you can specify only one at a time.

•

Under Windows and UNIX, rodbucx<os> writes the logging information to the file rodbu.log. Under z/OS, it writes the information to the file specified with the ddname RODBULOG. The file must not be a member of a library.

Special information required for special options (for example, -po or -dbinfo) is written to both the log file and standard output by rodbucx<os>. For the different operating systems, standard output means:

–

STDOUT for Windows and UNIX

–

SYSPRINT for z/OS

•

If you call rodbucx<os> with the -help option, the program displays its call syntax.

•

The option -noprogress suppresses the output of progress information during the execution of database operations (specified in connection with -check, -compress, -defrag, -itemsize and -verify).

•

The option -progress activates the output of progress information during the execution of database operations (specified in connection with -check, -compress, -defrag, -itemsize and -verify). The output is directed to the standard output file of the operating system that is in use.

•

The option -size evaluates the size of the temporary files that are required for the functions specified in the call to rodbucx<os>.

•

The options discussed next are used to specify directories and file names for temporary files required by rodbucx<os> for various functions. By default, these files are created in the current directory. If you estimate that the disk space available for the current directory will be insufficient, you can use one of these options to specify different paths and files:

–

With the -dir=<path> option, you can choose the directory in which the temporary files are saved when compressing databases (option -compress).

–

In connection with the options -verify, -defrag, -itemsize, and -load, up to seven temporary files are required for storing information. For more information, see Database Maintenance Options for a full list of options.

The temporary files are specified as follows:

Option	Description
-docfl=<file>	Temporary file for information on links
-ident=<file>	Temporary file for information on back links
-numbl=<file>	Temporary file for information on back links
-numcat=<file>	Temporary file for information on NUMFILE index
-scope=<file>	Temporary file for information on namespaces
-sortfl<n>=<file>	File names for the sort files; <n> is a number from 1 to 6
-tempd[b]=<file>	Temporary file for database

–

Under z/OS, you can specify the files via the DS name of a VSAM dataset or via the ddname.

•

Via the option -memory, you can specify the amount of memory (RAM or region) that rodbucx<os> may use for sort operations. Sort operations are required for the options -verify, -defrag, -repair, and -load.

By default, rodbucx<os> uses this memory depending on the operating system:

–

For z/OS: 4 MB

–

For AIX and HP-UX: 64 MB

–

For Windows, Linux, and Solaris: 128 MB

If your computer has significantly more memory available than that, you can use the option -memory=<kb> to specify how much of it you want to use for sort operations. More available memory will noticeably speed up the operations. But be sure to set <kb> such that it does not force frequent memory paging, which would lead to noticeably lower performance and thus would be counterproductive.

•

If you specify the option -verbose, rodbucx<os> returns additional information regarding the executed functions (for example, additional statistical information when loading a database). These are particularly important in problem situations in which you must contact ASG Customer Support for assistance.

Database Maintenance Options

These options are provided for database maintenance tasks:

Option	Description
-c[ompress]	Compresses the database (specified with -compress and -defrag).
-ch[eck]	Checks the physical consistency of the database.
-clearl[ocks]	Deletes all lock information in ROLOCK items.
-cont[ainer]	Checks the container free list for used and lost containers.
-copy	Copies the contents of a new compressed database to the source database instead of removing the source database and then renaming the compressed one (specified with -compress and -defrag).
-dbinfo	Writes header record information for the database.
-dbsetid	Assigns a new ID to the database.
-defr[ag]	Defragments and compresses the database.
-detach[logfile]	Removes the binding to a specific LOG file from a database.
-dump	Writes the contents of items that have been deleted (specified with -repair).
-dell[ocks]	Deletes all ROLOCK items and the lock information in the database.
-it[emsize][=<n>]	Writes item size and item identification (specified with -statistcs, and -verify).
-load=<section>	Loads a database.
-n[umreb]	Rebuilds the NUMFILE index.
-po[stprocessing]=<file>	File to which rodbucx<os> in connection with -load writes procedure code for postprocessing of data in the database.
-rel[ease]	Releases free memory space before compressing or defragmenting the database.
-rep[air]	Repairs a database.
-res[tore]	Restores a database using the LOG file.
-sh[owmtr]	Writes maintenance information for a database (specified with -dellocks, -repair, -size, and -verify).
-st[atistics]	Writes statistical information.
-tempd[b]	Specifies the name of a temporary file for compressing the database (specified with -compress and -defrag).
-time=<t_stamp>	Specifies the time up to which a log file is to be processed. Format: YYYYMMDDHHMMSS
-v[erify]	Checks the logical consistency of the database.

These rules hold for the database maintenance options:

•

Use the options -compress, -defrag, and -release to compress a database and to release free memory space. The option -copy retains the attributes of the source database file during the process. For details, see Compressing a Database and Defragmenting a Database.

•

Use the option -check to examine the physical consistency of a database. Rochade checks at the level of the access method RISAM if all records are accessible via the index, and vice versa, if the index refers to the records with the respective keys. If -repair does not lead to the desired results, you can use the option -check to determine whether the root of the problem lies at the RISAM level. To repair the database, you can then use the option -compress or -defrag. For details, see Defragmenting a Database.

•

If you specify the option -dbinfo, rodbucx<os> will write the header record information and a list of the most recently executed database maintenance operations into the server event log. From the header record information of the database, you can find out, for instance, which version of the database you are dealing with, whether the database has been closed properly, and whether there are any data from an online backup that still need to be restored to the database.

•

The option -dbsetid serves to assign a new database ID to a copied database. For more information, see Assigning a New Database ID.

•

To verify the logical consistency of a database, repair a database, or restore a database with the help of LOG files, use these options:

Option	Function	See Section
-repair	Repair a database	Repairing a Database
-restore	Restore a database with the help of LOG files	Restoring a Database
-verify	Verify the logical consistency of a database	Verifying a Database

–

In conjunction with the reconstruction options, you can obtain additional maintenance information on the database and the items therein using the options -itemsize, -showmtr, and -statistics.

–

The -dump option in conjunction with -repair causes the content of deleted items to be output to the log file.

–

The -container option in conjunction with -verify and -repair causes the check of the container free list for used and lost containers.

•

The option -detachlogfile removes the binding to a specific LOG file from a database. After a server crash for which restore logging has been enabled the server can perform the recovery process without the LOG file.

The database recovery process cannot recover write operations that have been written to the log file but not to the databases.

•

Use the -clearlocks or -dellocks option to delete item locks in the database.

Persistent item locks are saved in items of type ROLOCK, which the server analyzes during the start.

–

The option -clearlocks deletes the item locks in the ROLOCK items; however, the items are still saved in the database. If a large number of ROLOCK items exists, this method has little savings because the server must read all ROLOCK items even if they are empty.

–

The option -dellocks deletes all ROLOCK items in the database. As a result, the server starts faster because it does not have to read the ROLOCK items.

Command Call Conventions

You should observe these conventions when using the various options of the rodbucx<os> program call:

• Except under UNIX, every option begins with the minus sign (-) or the slash character (/). Under UNIX, this is not allowed because path expressions may start with a slash in UNIX.
• Options are either Boolean switches (for example, -dfrag and -compress) or they have an explicitly specified value (for example, -d=/tmp).
• The value assigned to an option must always follow one of these characters: an equal sign (=), a hash mark (#), or a colon (:).
• Options are not case-sensitive; they can be written in lowercase or uppercase letters (such as, -D is identical to -d).
• For the values of options, lowercase and uppercase are interpreted in accordance with the conventions of the operating system that is in use.
• If you call a program with the -h option or an invalid option, help text is displayed.
• The order in which you specify options in a command line is immaterial.