3.1 Summary of Oracle GoldenGate IBM i Native Commands

This section summarizes the commands that can be issued directly from the native command line of the Linux, UNIX, Windows, or IBM i platforms. For the purpose of this document, commands issued from the IBM i PASE environment are considered UNIX commands.

On the IBM i platform, these commands are stored in the Oracle GoldenGate installation library and can be used instead of issuing them from a PASE environment. With this support, it is possible to use the typical job submission tools such as SBMJOB to operate the Oracle GoldenGate product. If submitted to batch, the output is written to a spool file, and only job messages and any exceptions are written to the job log. In a typical installation, a batch submitted command should have both a QPRINT output spool file and a joblog spool file.

To use the native commands from the IBM CLI, you need only include the Oracle GoldenGate installation library in the library list, or reference it explicitly through a qualified name such as OGGLIB/GGSCI. During the execution of the command the current directory will be set to the Oracle GoldenGate installation directory, and all appropriate environment variables will be set to operate the Oracle GoldenGate commands. Therefore, the paths for any parameter that can take a path may be specified either as an absolute path name or as a relative path name based at the Oracle GoldenGate installation directory. The OTHERS parameter of the IBM i CLI commands is used to allow the specification of other parameters not explicitly exposed by the IBM i CLI commands. For example, if you want to specify REPORTFILE and PROCESSID for Extract, you would use the following syntax:

EXTRACT PARAMFILE('dirprm/myext.prm') OTHERS(REPORTFILE 'dirrpt/myext.rpt' PROCESSID myext)

Note:

Normally, Extract and Replicat should be run from GGSCI, but some situations, such as certain initial load procedures, require running them from the command line of the operating system.

Table 3-1 Commands

Command Description

checkprm

Assess the validity of the specified parameter file.

convchk

Converts the trail files from 9 digit to 6 digit checkpoint record for the named Extract group.

defgen

Runs the DEFGEN program. This program generates data definitions in a file that is transferred to a remote system to support the retrieval of object metadata.

extract

Runs the Extract program. This program captures either full data records or transactional data changes, depending on configuration parameters, and then sends the data to a trail for further processing by a downstream process, such as a data-pump Extract or the Replicat process.

ggsci

Runs the Oracle GoldenGate command line interface.

keygen

Runs the KEYGEN utility. This utility generates encryption keys to support Oracle GoldenGate security.

logdump

Runs the Logdump utility. This utility enables the contents of a trail file to be viewed for the purpose of troubleshooting. This command takes no arguments. For more information about Logdump, see Logdump Reference for Oracle GoldenGate.

mgr

Runs the Manager program. Manager is the parent process of Oracle GoldenGate and is responsible for the management of its processes and files, resources, user interface, and the reporting of thresholds and errors.

replicat

Runs the Replicat program. This program reads a trail, performs mapping and manipulation as needed, and applies the data to a target database.