Appendix A. GGSCI Commands

In the world of IT, writing a book takes at least a year, in which time technology has moved on and in some cases the contents can be out of date. Therefore, the objective of this appendix is two fold:

• To act as a quick reference guide to all the available GoldenGate Software Command Interface (GGSCI) commands, including the GoldenGate installed components

• To catch any subjects and terminology not addressed in the previous chapters

Some say that since the Oracle acquisition of GoldenGate, the product has changed its name. This is indeed true; GoldenGate Software (GGS) is now known as Oracle GoldenGate (OGG). No surprise there. However this is not true for the GoldenGate Command Interpreter; it is still called GGSCI and not OGGCI, even in the latest version of GoldenGate!

The following table lists and describes the available GGSCI commands, arranged by command group:

Command Group	Command	Description
MANAGER	INFO MANAGER	Displays the Manager process status information. For example: INFO MGR Or INFO MANAGER
MANAGER	REFRESH MANAGER	Updates the Manager process configuration without stopping and starting. Valid for all configuration parameters except PORT. For example: REFRESH MGR Or REFRESH MANAGER
MANAGER	SEND MANAGER	Obtains addition status information when used with the following options: CHILDSTATUS [DEBUG] GETPORTINFO [DETAIL] GETPURGEOLDEXTRACTS For example: SEND MANAGER CHILDSTATUS DEBUG SEND MANAGER GETPORTINFO DETAIL SEND MANAGER GETPURGEOLDEXTRACTS
MANAGER	START MANAGER	Starts the Manager process. The command supports wildcards. For example: START MGR Or START MANAGER
MANAGER	STATUS MANAGER	Same as INFO command.
MANAGER	STOP MANAGER	Stops the Manager process. The command supports wildcards. For example: STOP MGR Or STOP MANAGER
EXTRACT	ADD EXTRACT	Creates a new Extract group. For example: ADD EXTRACT EOLTP01, TRANLOG, BEGIN NOW, THREADS 1
EXTRACT	ALTER EXTRACT	Alters an existing Extract group. For example: ALTER EXTRACT EOLTP01, EXTSEQNO 556, EXTRBA 775531
EXTRACT	CLEANUP EXTRACT	Deletes the run history for the specified Extract group. The Extract process must first be stopped. When used with the SAVE option, the command will delete all except the last specified number of records. The command supports wildcards. For example: CLEANUP EXTRACT *, SAVE 3
EXTRACT	DELETE EXTRACT	Deletes an Extract group. The Extract process must first be stopped. When used with an exclamation mark, the command will delete all Extract groups associated with a wildcard without prompting for confirmation. For example: DELETE EXTRACT E* !
EXTRACT	INFO EXTRACT	Displays status summary for an Extract process. The DETAIL option provides more information. The command supports wildcards. For example: INFO E*, DETAIL
EXTRACT	KILL EXTRACT	Kills an Extract process. Use when the process cannot be stopped gracefully. For example: KILL EXTRACT EOLTP01
EXTRACT	LAG EXTRACT	Displays the lag time between the Extract process and the data source. The command supports wildcards. For example: LAG EXTRACT *
EXTRACT	SEND EXTRACT	Sends requests to the Extract process, such as; ad-hoc report generation and statistics. The command can also be used to force the Extract process to be rolled over to next trail file. For example: SEND EXTRACT EOLTP01, REPORT SEND EXTRACT EOLTP01, ROLLOVER
EXTRACT	VIEW REPORT	Allows process reports generated by the SEND command to be viewed. For example: VIEW REPORT EOLTP01
EXTRACT	START EXTRACT	Starts the Extract process. The command supports wildcards. For example: START EXTRACT *
EXTRACT	STATS EXTRACT	Displays Extract process statistics. For example: STATS EXTRACT EOLTP01, TOTALSONLY SRC.ORDERS
EXTRACT	STATUS EXTRACT	Provides basic Extract process state. The command supports wildcards. For example: STATUS EXTRACT E*
EXTRACT	STOP EXTRACT	Stops the Extract process. The command supports wildcards. For example: STOP EXTRACT *
REPLICAT	ADD REPLICAT	Creates a new Replicat group. For example: ADD REPLICAT ROLAP01, EXTTRAIL ./dirdat/ta
REPLICAT	ALTER REPLICAT	Alters an existing Replicat group. For example: ALTER REPLICAT ROLAP01, BEGIN 2010-09-07 10:00:00
REPLICAT	CLEANUP REPLICAT	Deletes the run history for the specified Extract group. The Replicat process must first be stopped. When used with the SAVE option, the command will delete all except the last specified number of records. The command supports wildcards. For example: CLEANUP REPLICAT *, SAVE 3
REPLICAT	DELETE REPLICAT	Deletes an Extract group. The Replicat process must first be stopped. When used with an exclamation mark, the command will delete all Replicat groups associated with a wildcard without prompting for confirmation. For example: DELETE REPLICAT R* !
REPLICAT	INFO REPLICAT	Displays status summary for a Replicat process. The DETAIL option provides more information. The command supports wildcards. For example: INFO R*, DETAIL
REPLICAT	KILL REPLICAT	Kills a Replicat process. Use when the process cannot be stopped gracefully. For example: KILL REPLICAT ROLAP01
REPLICAT	LAG REPLICAT	Displays the lag time between the Replicat process and the data source. The command supports wildcards. For example: LAG REPLICAT *
REPLICAT	SEND REPLICAT	Sends requests to the Replicat process, such as adhoc report generation and statistics. For example: SEND REPLICAT ROLAP01, REPORT
REPLICAT	VIEW REPORT	Allows process reports generated by the SEND command to be viewed. For example: VIEW REPORT ROLAP01
REPLICAT	START REPLICAT	Starts the Replicat process. The command supports wildcards. For example: START REPLICAT *
REPLICAT	STATS REPLICAT	Displays Replicat process statistics. For example: STATS REPLICAT ROLAP01, TOTALSONLY *, REPORTRATE SEC
REPLICAT	STATUS REPLICAT	Provides basic Replicat process state. The command supports wildcards. For example: STATUS REPLICAT R*
REPLICAT	STOP REPLICAT	Stops the Replicat process. The command supports wildcards. For example: STOP REPLICAT *
TRAIL	ADD EXTTRAIL	Creates a local trail for an Extract group. For example: ADD EXTTRAIL ./dirdat/sa, EXTRACT EOLTP01, MEGABYTES 50
TRAIL	ADD RMTTRAIL	Creates a remote trail for an Extract or Data pump group. For example: ADD RMTTRAIL ./dirdat/ta, EXTRACT EPMP01, MEGABYTES 50
TRAIL	ALTER EXTTRAIL	Allows the trail file size to be altered. The Extract process must be restarted for the changes to take effect. For example: ALTER EXTTRAIL ./dirdat/sa, EXTRACT EOLTP01, MEGABYTES 500
TRAIL	ALTER RMTTRAIL	Allows the trail file size to be altered. The Extract process must be restarted for the changes to take effect. For example: ALTER RMTTRAIL ./dirdat/ta, EXTRACT EPMP01, MEGABYTES 100
TRAIL	DELETE EXTTRAIL	Deletes the local trail. For example: DELETE EXTTRAIL ./dirdat/sa
TRAIL	DELETE RMTTRAIL	Deletes the remote trail. For example: DELETE RMTTRAIL ./dirdat/ta
TRAIL	INFO EXTTRAIL	Provides information on the local trail status. The command supports wildcards. For example: INFO EXTTRAIL *
TRAIL	INFO RMTTRAIL	Provides information on the remote trail status. The command supports wildcards. For example: INFO RMTTRAIL *
PARAMS	EDIT PARAMS	Allows a process' parameter file to be edited. The command invokes the default editor, such as vi. For example: EDIT PARAMS EOLTP01
PARAMS	SET EDITOR	Changes the default editor. For example: SET EDITOR VI
PARAMS	VIEW PARAMS	Allows a process' parameter file to be viewed. For example: VIEW PARAMS EOLTP01
DATABASE	DBLOGIN	Provides access to the database with username and password. For example: DBLOGIN USERID ggs_admin@OLTP, PASSWORD Password01
DATABASE	ENCRYPT PASSWORD	Allows the database password to be encrypted in the parameter file. Since Oracle 11g, the password is case sensitive. For example: ENCRYPT PASSWORD Password01
DATABASE	LIST TABLES	Lists tables in a database schema. The command supports wildcards. The command must follow a successful DBLOGIN. For example: LIST TABLES SRC.*
TRANDATA	ADD TRANDATA	Adds supplemental logging to a database table, necessary for transactional changes to be written to the redo logs. The command must follow a successful DBLOGIN. For example: ADD TRANDATA SRC.ORDERS
TRANDATA	DELETE TRANDATA	Stops the supplemental logging on a database table. The command supports wildcards and must follow a successful DBLOGIN. For example: DELETE TRANDATA SRC.*
TRANDATA	INFO TRANDATA	Provides supplemental logging status on a database table. The command supports wildcards and must follow a successful DBLOGIN. For example: INFO TRANDATA SRC.*
CHECKPOINT	ADD CHECKPOINTTABLE	Adds a Checkpoint table on the target database. The command must follow a successful DBLOGIN. For example: ADD CHECKPOINT TABLE GGS_ADMIN.GGSCHKPT
CHECKPOINT	CLEANUP CHECKPOINTTABLE	Removes obsolete checkpoint records from the Checkpoint table. Use when Replicat groups are deleted or Trail files are removed. The command must follow a successful DBLOGIN. For example: CLEANUP CHECKPOINTTABLE GGS_ADMIN.GGSCHKPT
CHECKPOINT	DELETE CHECKPOINTTABLE	Deletes the Checkpoint table from the database. The command must follow a successful DBLOGIN. For example: DELETE CHECKPOINTTABLE GGS_ADMIN.GGSCHKPT
CHECKPOINT	INFO CHECKPOINTTABLE	Displays the existence and creation date of the Checkpoint table. The command must follow a successful DBLOGIN. For example: INFO CHECKPOINTTABLE GGS_ADMIN.GGSCHKPT
MISC	!	Runs the last executed command. For example: !
MISC	CREATE SUBDIRS	Creates the GoldenGate subdirectories. For example: CREATE SUBDIRS
MISC	FC	Display, edit, and execute the last command. For example: FC
MISC	HELP	Provides help on command syntax. For example: HELP
MISC	HISTORY	Lists a history of GGSCI commands used. For example: HISTORY
MISC	INFO ALL	Displays a summary of the configured processes. For example: INFO ALL
MISC	OBEY	Invokes a GGSCI command script. For example: OBEY dirprm/config.oby
MISC	SHELL	Allows OS commands to be executed from GGSCI For example: SHELL ls –l dirdat
MISC	SHOW	Shows environment information. For example: SHOW
MISC	VERSIONS	Displays version of OS and database. For example: VERSIONS
MISC	VIEW GGSEVT	Displays the contents of the GoldenGate event log For example: VIEW GGSEVT