Oracle GoldenGate Commands Reference
4 min read
A quick-reference guide to commonly used Oracle GoldenGate (GGSCI) commands, covering Manager, Extract, Replicat, and other commands with descriptions and examples for troubleshooting, administration, and maintenance.
| Category | Command | Description |
|---|---|---|
| Manager Commands | INFO MANAGER / INFO MGR / STATUS MANAGER | Displays the Manager process status information. |
| START MANAGER | Starts the Manager process. | |
| STOP MGR / STOP MANAGER / STOP MANAGER! | Stops the Manager process. Using “!” skips the y/n prompt and stops directly. | |
| SEND MANAGER | Useful for troubleshooting; provides additional status information. Example: SEND MANAGER GETPORTINFO DETAIL | |
| Extract Commands | INFO <EXTRACT_NAME> / INFO EXTRACT <EXTRACT_NAME> / STATUS EXTRACT | Displays the Extract process status. Use DETAIL for more information. Wildcards supported: INFO E*, DETAIL |
| ADD EXTRACT | Creates a new Extract group. Example for Integrated Extract: ADD EXTRACT ESOURCE01, INTEGRATED TRANLOG, BEGIN NOW | |
| ALTER EXTRACT | Alters an existing Extract group. | |
| STOP EXTRACT | Stops the Extract process. Wildcards supported: STOP EXTRACT * | |
| STATS EXTRACT | Displays Extract process statistics. | |
| START EXTRACT | Starts the Extract process. Wildcards supported: START EXTRACT * | |
| REGISTER EXTRACT | Registers an Extract group with its source database. | |
| UNREGISTER EXTRACT | Unregisters an Extract group from its source database. | |
| KILL EXTRACT | Forces an Extract process to stop if it cannot be stopped gracefully. | |
| LAG EXTRACT | Displays lag time between the Extract process and the data source. | |
| CLEANUP EXTRACT | Deletes the run history for an Extract group. The Extract must be stopped first. | |
| DELETE EXTRACT | Deletes the Extract group. The Extract must be stopped first. | |
| SEND EXTRACT | Directs Extract process to generate statistics or reports. | |
| VIEW REPORT | Views process reports generated by the SEND command. | |
| Replicat Commands | INFO REPLICAT <REPLICAT_NAME> / STATUS REPLICAT <REPLICAT_NAME> | Displays the Replicat process status. Use DETAIL for more information. |
| START REPLICAT <REPLICAT_NAME> | Starts the Replicat process. | |
| STATS REPLICAT <REPLICAT_NAME> | Displays Replicat process statistics. | |
| STOP REPLICAT <REPLICAT_NAME> | Stops the Replicat process. | |
| KILL REPLICAT <REPLICAT_NAME> | Forces a Replicat process to stop if it cannot be stopped gracefully. | |
| LAG REPLICAT <REPLICAT_NAME> | Displays lag time between the Replicat process and the data source. | |
| REGISTER REPLICAT <REPLICAT_NAME> | Registers a Replicat process with its target database. | |
| UNREGISTER REPLICAT <REPLICAT_NAME> | Unregisters a Replicat process from its target database. | |
| CLEANUP REPLICAT <REPLICAT_NAME> | Deletes the run history for a Replicat group. Must be stopped first. | |
| DELETE REPLICAT <REPLICAT_NAME> | Deletes the Replicat group. Must be stopped first. | |
| SEND REPLICAT <REPLICAT_NAME> | Sends ad-hoc commands for report generation or tracing. | |
| VIEW REPORT <REPLICAT_NAME> | Views reports generated by the SEND command. | |
| Miscellaneous | ADD EXTTRAIL / ALTER EXTTRAIL | Creates or alters a local trail for an Extract group. |
| ADD RMTTRAIL / ALTER RMTTRAIL | Creates or alters a remote trail for an Extract or data pump group. | |
| INFO EXTTRAIL / INFO RMTTRAIL | Provides information on local or remote trail status. | |
| DELETE EXTTRAIL / DELETE RMTTRAIL | Deletes local or remote trail files. | |
| VIEW PARAMS / EDIT PARAMS | Views or edits parameter files for a process. | |
| ADD CREDENTIALSTORE | Creates a Credentials Store wallet for database credentials. | |
| INFO CREDENTIALSTORE | Lists all users in the Credentials Store wallet. | |
| DBLOGIN | Logs into the database with credentials. Example: DBLOGIN USERIDALIAS sourcepass | |
| ADD SCHEMATRANDATA / ADD TRANDATA | Adds schema-level or table-level supplemental logging. Requires DBLOGIN. | |
| DELETE TRANDATA | Stops supplemental logging on a database table. | |
| INFO TRANDATA / INFO SCHEMATRANDATA | Displays supplemental logging status for a table or schema. | |
| HISTORY | Lists a history of GGSCI commands used. | |
| ADD CHECKPOINTTABLE / DELETE CHECKPOINTTABLE | Adds or deletes a checkpoint table on the target database. | |
| INFO CHECKPOINTTABLE | Displays the status and creation date of a checkpoint table. | |
| OBEY | Runs a set of commands from a .oby file. Example: OBEY dirprm/conf.oby | |
| SHELL | Executes OS commands from the GGSCI prompt. Example: SHELL df -h dirdat | |
| HELP | Provides help for GGSCI commands. Example: HELP ADD EXTRACT |
For detailed explanations and examples, refer to the Oracle GoldenGate Documentation.
