|
MANAGER
|
INFO MANAGER
|
This command displays the Manager process status information.
Here is an example:
INFO MGR
Or
INFO MANAGER
|
|
MANAGER
|
SEND MANAGER
|
This command obtains addition status information when used with the following options:
CHILDSTATUS [DEBUG]
GETPORTINFO [DETAIL]
GETPURGEOLDEXTRACTS
Here is an example:
SEND MANAGER CHILDSTATUS DEBUG
SEND MANAGER GETPORTINFO DETAIL
SEND MANAGER GETPURGEOLDEXTRACTS
|
|
MANAGER
|
START MANAGER
|
This command starts the Manager process and supports wildcards.
Here is an example:
START MGR
Or
START MANAGER
|
|
MANAGER
|
STATUS MANAGER
|
This is the same as the INFO command.
Here is an example:
STATUS MANAGER
|
|
MANAGER
|
STOP MANAGER [!]
|
This command stops the Manager process and supports wildcards.
Here is an example:
STOP MGR
Or
STOP MANAGER
The subsequent ! (exclamation mark) bypasses the y/n prompt to shutdown the GoldenGate Manager process.
|
|
EXTRACT
|
ADD EXTRACT
|
This command creates a new Extract group.
Here is an example:
ADD EXTRACT EOLTP01, TRANLOG, BEGIN NOW, THREADS 1
And for integrated mode:
ADD EXTRACT EOLTP01, INTEGRATED TRANLOG, BEGIN 2015-05-26 12:39:27
|
|
EXTRACT
|
ALTER EXTRACT
|
This command alters an existing Extract group.
Here is an example:
ALTER EXTRACT EOLTP01, EXTSEQNO 556, EXTRBA 775531
|
|
EXTRACT
|
CLEANUP EXTRACT
|
This command 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. This command supports wildcards.
Here is an example:
CLEANUP EXTRACT *, SAVE 3
|
|
EXTRACT
|
DELETE EXTRACT
|
This command 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.
Here is an example:
DELETE EXTRACT E* !
|
|
EXTRACT
|
INFO EXTRACT
|
This command displays the status summary for an Extract process. The DETAIL option provides more information. The command supports wildcards.
Here is an example:
INFO E*, DETAIL
The following command displays whether an Extract can be upgraded to integrated capture mode.
INFO EOLTP01 UPGRADE
|
|
EXTRACT
|
KILL EXTRACT
|
This command kills an Extract process. Use it when the process cannot be stopped gracefully.
Here is an example:
KILL EXTRACT EOLTP01
|
|
EXTRACT
|
LAG EXTRACT
|
This command displays the lag time between the Extract process and the data source. It supports wildcards.
Here is an example:
LAG EXTRACT *
|
|
EXTRACT
|
SEND EXTRACT
|
This command sends ad hoc report generation and statistics requests to the Extract process. The command can also be used to set the interval for bounded recovery checkpoints or force the Extract process to be rolled over to the next trail file. It also shows open transactions.
Here is an example:
SEND EXTRACT EOLTP01, REPORT
SEND EXTRACT EOLTP01, ROLLOVER
SEND EXTRACT EOLTP01, BRINTERVAL 30M
SEND EXTRACT EOLTP01, SHOWTRANS COUNT 1
0
|
|
EXTRACT
|
VIEW REPORT
|
This command allows process reports generated by the SEND command to be viewed.
Here is an example:
VIEW REPORT EOLTP01
|
|
EXTRACT
|
REGISTER EXTRACT
|
This command registers an Extract process group with its source database.
Here is an example of classic mode:
REGISTER EXTRACT EOLTP01 LOGRETENTION
This is an example of integrated mode for the container database:
REGISTER EXTRACT EOLTP01 DATABASE CONTAINER (PDB1)
|
|
EXTRACT
|
UNREGISTER EXTRACT
|
This command unregisters an Extract process group from its source database.
Here is an example:
UNREGISTER EXTRACT EOLTP01 LOGRETENTION
This is an example of integrated mode for the container database:
UNREGISTER EXTRACT EOLTP01 DATABASE CONTAINER (PDB1) LOGRETENTION
|
|
EXTRACT
|
START EXTRACT
|
This command starts the Extract process and supports wildcards.
Here is an example:
START EXTRACT *
|
|
EXTRACT
|
STATS EXTRACT
|
This command displays the Extract process statistics.
Here is an example:
STATS EXTRACT EOLTP01, TOTALSONLY SRC.ORDERS
|
|
EXTRACT
|
STATUS EXTRACT
|
This command provides the basic Extract process state and supports wildcards.
For example:
STATUS EXTRACT E
*
|
|
EXTRACT
|
STOP EXTRACT
|
This command stops the Extract process and supports wildcards.
Here is an example:
STOP EXTRACT *
|
|
REPLICAT
|
ADD REPLICAT
|
This command creates a new Replicat group.
Here is an example:
ADD REPLICAT ROLAP01, EXTTRAIL ./dirdat/ta
And for integrated mode:
ADD REPLICAT ROLAP01, INTEGRATED, EXTTRAIL ./dirdat/ta
This is an example for coordinated mode:
ADD REPLICAT ROLAP01, COORDINATED MAXTHREADS 16, EXTTRAIL ./dirdat/ta
|
|
REPLICAT
|
ALTER REPLICAT
|
This command alters the existing Replicat group.
Here is an example:
ALTER REPLICAT ROLAP01, BEGIN 2015-06-07 10:00:00
To switch from the Replicat to integrated mode, use the following command:
ALTER REPLICAT ROLAP01, INTEGRATED
|
|
REPLICAT
|
CLEANUP REPLICAT
|
This command 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. It also supports wildcards.
Here is an example:
CLEANUP REPLICAT *, SAVE 3
|
|
REPLICAT
|
DELETE REPLICAT
|
This command 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 a confirmation.
Here is an example:
DELETE REPLICAT R* !
|
|
REPLICAT
|
INFO REPLICAT
|
This command displays the status summary for the Replicat process and supports wildcards. The DETAIL option provides more information.
Here is an example:
INFO R*, DETAIL
|
|
REPLICAT
|
KILL REPLICAT
|
This command kills the Replicat process and is used when the process cannot be stopped gracefully.
Here is an example:
KILL REPLICAT ROLAP01
|
|
REPLICAT
|
LAG REPLICAT
|
This command displays the lag time between the Replicat process and the data source. The command supports wildcards that must be used to view all Replicat processes in coordinated mode.
Here is an example:
LAG REPLICAT *
LAG REPLICAT REPCO*
|
|
REPLICAT
|
REGISTER REPLICAT
|
This command explicitly registers the Replicat process group with its target database.
Here is an example:
REGISTER REPLICAT ROLAP01 DATABASE
|
|
REPLICAT
|
SEND REPLICAT
|
This command sends ad hoc report generation, statistics, and tracing requests to the Replicat process.
Here is an example:
SEND REPLICAT ROLAP01, REPORT
SEND REPLICAT ROLAP01, GETLAG
SEND REPLICAT ROLAP01, TRACE FILE ./dirrpt/rolap01.trc
|
|
REPLICAT
|
VIEW REPORT
|
This command allows process reports generated by the SEND command to be viewed.
Here is an example:
VIEW REPORT ROLAP01
|
|
REPLICAT
|
START REPLICAT
|
This command starts the Replicat process and supports wildcards.
Here is an example:
START REPLICAT *
In order to start the Replicat from a specific CSN, use the following command:
START REPLICAT ROLAP, ATCSN 64597862
|
|
REPLICAT
|
STATS REPLICAT
|
This command displays the Replicat process statistics.
Here is an example:
STATS REPLICAT ROLAP01, TOTALSONLY *, REPORTRATE SEC
To show the statistics for conflict detection and resolution, use the following command:
STATS REPLICAT ROLAP, REPORTCDR
|
|
REPLICAT
|
STATUS REPLICAT
|
This command provides the Replicat process state and supports wildcards.
Here is an example:
STATUS REPLICAT R*
|
|
REPLICAT
|
STOP REPLICAT
|
This command stops the Replicat process and supports wildcards.
Here is an example:
STOP REPLICAT *
|
|
REPLICAT
|
SYNCHRONIZE REPLICAT
|
This command is used for Coordinated Replicat only. It returns all threads to the same position in the trail file following an unclean shutdown.
Here is an example:
SYNCHRONIZE REPLICAT REPCO
|
|
REPLICAT
|
UNREGISTER REPLICAT
|
This command unregisters an Integrated Replicat from its target database following a forced deletion of the same Replicat process group.
Here is an example:
UNREGISTER REPLICAT ROLAP01 DATABASE
|
|
TRAIL
|
ADD EXTTRAIL
|
This command creates a local trail for an Extract group.
Here is an example:
ADD EXTTRAIL ./dirdat/sa, EXTRACT EOLTP01, MEGABYTES 100
|
|
TRAIL
|
ADD RMTTRAIL
|
This command creates a remote trail for an Extract or data pump group.
Here is an example:
ADD RMTTRAIL ./dirdat/ta, EXTRACT EPMP01, MEGABYTES 100
|
|
TRAIL
|
ALTER EXTTRAIL
|
This command allows the trail file size to be altered. The Extract process must be restarted for all the changes to take effect.
Here is an example:
ALTER EXTTRAIL ./dirdat/sa, EXTRACT EOLTP01, MEGABYTES 500
|
|
TRAIL
|
ALTER RMTTRAIL
|
This command allows the trail file size to be altered. The Extract process must be restarted for all the changes to take effect.
Here is an example:
ALTER RMTTRAIL ./dirdat/ta, EXTRACT EPMP01, MEGABYTES 100
|
|
TRAIL
|
DELETE EXTTRAIL
|
This command deletes the local trail.
Here is an example:
DELETE EXTTRAIL ./dirdat/sa
|
|
TRAIL
|
DELETE RMTTRAIL
|
This command deletes the remote trail.
Here is an example:
DELETE RMTTRAIL ./dirdat/ta
|
|
TRAIL
|
INFO EXTTRAIL
|
This command provides information on the local trail status and supports wildcards.
Here is an example:
INFO EXTTRAIL *
|
|
TRAIL
|
INFO RMTTRAIL
|
This command provides information on the remote trail status and supports wildcards.
Here is an example:
INFO RMTTRAIL *
|
|
PARAMS
|
EDIT PARAMS
|
This command allows a process' parameter file to be edited and invokes the vi default editor.
Here is an example:
EDIT PARAMS EOLTP01
|
|
PARAMS
|
SET EDITOR
|
This command changes the default editor.
Here is an example:
SET EDITOR VI
|
|
PARAMS
|
VIEW PARAMS
|
This command allows a process' parameter file to be viewed.
Here is an example:
VIEW PARAMS EOLTP01
|
|
WALLET
|
CREATE WALLET
|
This command creates a master key wallet to store encryption keys used by GoldenGate processes.
Here is an example:
CREATE WALLET
|
|
WALLET
|
OPEN WALLET
|
This command opens the GoldenGate wallet and decrypts its contents. Use this command before adding or deleting keys from the wallet.
Here is an example:
OPEN WALLET
|
|
WALLET
|
PURGE WALLET
|
This command purges the GoldenGate wallet and permanently removes all the master keys.
Here is an example:
PURGE WALLET
|
|
WALLET
|
ADD MASTERKEY
|
This commands adds a master key to an opened wallet.
Here is an example:
ADD MASTERKEY
|
|
WALLET
|
INFO MASTERKEY
|
This command displays the master key version information from an opened wallet.
Here is an example:
INFO MASTERKEY
|
|
WALLET
|
RENEW MASTERKEY
|
This command renews the current version of the master encryption key in an opened wallet.
Here is an example:
RENEW MASTERKEY
|
|
WALLET
|
DELETE MASTERKEY
|
This command deletes a specified version of the master encryption key from an opened wallet.
Here is an example:
DELETE MASTERKEY VERSION 7
Or deletes a range:
DELETE MASTERKEY RANGE FROM 1 TO 4
|
|
WALLET
|
UNDELETE MASTERKEY
|
This command removes the deletion mark from a specified version of the master encryption key in an opened wallet.
Here is an example:
UNDELETE MASTERKEY VERSION 7
|
|
CREDENTIALSTORE
|
ADD CREDENTIALSTORE
|
This command creates a Credentials Store wallet to store encrypted database user credentials used by GoldenGate processes.
Here is an example:
ADD CREDENTIALSTORE
|
|
CREDENTIALSTORE
|
ALTER CREDENTIALSTORE
|
This command alters a record in a Credentials Store wallet. The options are ADD, REPLACE, or DELETE user.
Here is an example:
ALTER CREDENTIALSTORE ADD USER GGADMIN@PDB2 PASSWORD oracle_123 ALIAS tgtdb DOMAIN admin
|
|
CREDENTIALSTORE
|
INFO CREDENTIALSTORE
|
This command lists all users defined in the Credentials Store wallet.
Here is an example:
INFO CREDENTIALSTORE DOMAIN admin
|
|
CREDENTIALSTORE
|
DELETE CREDENTIALSTORE
|
This command permanently deletes a Credentials Store wallet from the system.
Here is an example:
DELETE CREDENTIALSTORE
|
|
DATABASE
|
DBLOGIN
|
This command provides access to the database with the username and password or from the Credentials Store wallet using an alias.
Here is an example:
DBLOGIN USERID GGADMIN@OLTP, PASSWORD oracle_123
Or using wallet:
DBLOGIN USERIDALIAS srcdb DOMAIN admin
|
|
DATABASE
|
MININGDBLOGIN
|
This command is used to provide access for a downstream database log mining server with a username and password or from the Credentials Store wallet for subsequent GGSCI commands.
Here is an example:
MININGDBLOGIN USERID GGADMIN@OLAP, PASSWORD oracle_123
Or using wallet:
MININGDBLOGIN SOURCEDB pdb1 USERIDALIAS srcdb DOMAIN admin
|
|
DATABASE
|
ENCRYPT PASSWORD
|
This command allows the database password to be encrypted in a process' parameter file instead of the wallet.
Here is an example:
ENCRYPT PASSWORD oracle_123
|
|
DATABASE
|
LIST TABLES
|
This command lists tables in a database schema and supports wildcards. It must follow a successful DBLOGIN.
Here is an example:
LIST TABLES SRC.*
|
|
TRANDATA
|
ADD SCHEMATRANDATA
|
This command adds database schema level supplemental logging. This is necessary for all the transactional changes to be captured and written to the redo logs. The command must follow a successful DBLOGIN.
Here is an example:
ADD SCHEMATRANDATA SRC
|
|
TRANDATA
|
ADD TRANDATA
|
This command adds supplemental logging to a database table. This is necessary for transactional changes to be captured and written to the redo logs. It must follow a successful DBLOGIN.
Here is an example:
ADD TRANDATA SRC.ORDERS
|
|
TRANDATA
|
DELETE TRANDATA
|
This command stops the supplemental logging on a database table and supports wildcards. It must follow a successful DBLOGIN.
Here is an example:
DELETE TRANDATA SRC.*
|
|
TRANDATA
|
INFO SCHEMATRANDATA
|
This command provides the supplemental logging status on a database schema. It supports wildcards and must follow a successful DBLOGIN.
Here is an example:
INFO TRANDATA SRC
|
|
TRANDATA
|
INFO TRANDATA
|
This command provides the supplemental logging status on a database table. It supports wildcards and must follow a successful DBLOGIN.
Here is an example:
INFO TRANDATA SRC.*
|
|
CHECKPOINT
|
ADD CHECKPOINTTABLE
|
This command adds a checkpoint table on the target database. It must follow a successful DBLOGIN. The command applies to classic Replicat only.
Here is an example:
ADD CHECKPOINT TABLE GGADMIN.GGCHECKPOIN
T
|
|
CHECKPOINT
|
CLEANUP CHECKPOINTTABLE
|
This command removes obsolete checkpoint records from the checkpoint table. This is used when Replicat groups are deleted or trail files are removed. The command must follow a successful DBLOGIN and applies to classic Replicat only.
Here is an example:
CLEANUP CHECKPOINTTABLE GGADMIN.GGCHECKPOINT
|
|
CHECKPOINT
|
DELETE CHECKPOINTTABLE
|
This command deletes the checkpoint table from the database. It must follow a successful DBLOGIN.
Here is an example:
DELETE CHECKPOINTTABLE GGADMIN.GGCHECKPOINT
|
|
CHECKPOINT
|
INFO CHECKPOINTTABLE
|
This command displays the existence and creation date of the checkpoint table. It must follow a successful DBLOGIN.
Here is an example:
INFO CHECKPOINTTABLE GGADMIN.GGCHECKPOINT
|
|
MISC
|
!
|
This command runs the last executed command.
Here is an example:
!
|
|
MISC
|
CREATE SUBDIRS
|
This command creates the GoldenGate subdirectories.
Here is an example:
CREATE SUBDIRS
|
|
MISC
|
FC
|
This command displays, edits, and executes the last command.
Here is an example:
FC
|
|
MISC
|
HELP
|
This command provides help on command syntax.
Here is an example:
HELP
|
|
MISC
|
HISTORY
|
This command lists a history of GGSCI commands that are used.
Here is an example:
HISTORY
|
|
MISC
|
INFO ALL
|
This command displays a summary of all the configured processes.
Here is an example:
INFO ALL
|
|
MISC
|
OBEY
|
This command invokes a GGSCI command script.
Here is an example:
OBEY dirprm/config.oby
|
|
MISC
|
SHELL
|
This command allows OS commands to be executed from GGSCI
Here is an example:
SHELL ls –l dirdat
|
|
MISC
|
SHOW
|
This command shows environment information.
Here is an example:
SHOW
|
|
MISC
|
VERSIONS
|
This command displays the database and the version of OS.
Here is an example:
VERSIONS
|
|
MISC
|
VIEW GGSEVT
|
This command displays the contents of the GoldenGate event log.
Here is an example:
VIEW GGSEVT
|
