GGSCI Command Summary



MANAGER RELATED COMMANDS

COMMAND DESCRIPTION
INFO MANAGER
or
INFO MGR
or
STATUS MANAGER
Displays the Manager process status information.
START MANAGER Starts the Manager process.
STOP MGR
or
STOP MANAGER
or
STOP MANAGER!
Stops the Manager process.
If you put ! mark in the end then it will not ask you y/n prompt also and directly stop it.
SEND MANAGER Not used very frequently but is very useful when you are troubleshooting some issues. Checks addition status
information when used with extra options.Example to get the port information use like below:
SEND MANAGER GETPORTINFO DETAIL

EXTRACT RELATED COMMANDS

COMMAND DESCRIPTION
INFO <EXTRACT_NAME>
or
INFO EXTRACT <EXTRACT_NAME>
OR
STATUS EXTRACT
Displays the status summary for an Extract process. Use “DETAIL” keyword to get further details.

INFO EXTRACT, DETAIL

It also supports wild card, Example like below you can get details of all EXTRACT process that starts with E in single statement.

INFO E*, DETAIL

 ADD EXTRACT  creates a new Extract group

Example for Integrated Extract:

ADD EXTRACT ESOURCE01, INTEGRATED TRANLOG, BEGIN NOW

 ALTER EXTRACT  This command alters an existing Extract group
 STOP EXTRACT This command stops the Extract process
Supports wildcards too:STOP EXTRACT *
 STATS EXTRACT Displays the Extract process statistics.
 START EXTRACT This command starts the Extract process.
Supports wildcards too:START EXTRACT *
 REGISTER EXTRACT Registers an Extract process group with its source database
 UNREGISTER EXTRACT Unregisters an Extract process group from its source database
 KILL EXTRACT Kills an Extract process. Use when the process cannot be stopped gracefully.
LAG EXTRACT Displays the lag time between the Extract process and the data source
CLEANUP EXTRACT Deletes the run history for the specified Extract group. you must stop the Extract before cleaning it up.
DELETE EXTRACT It will delete the Extract group. The Extract process must first be stopped.
SEND EXTRACT It will direct Extract process to generate statistics/reports
VIEW REPORT Allows process reports generated by the SEND command to be viewed

REPLICAT RELATED COMMANDS

COMMAND  DESCRIPTION
INFO REPLICAT <REPLICAT_NAME>
or
STATUS REPLICAT <REPLICAT_NAME>
Displays the status summary for the Replicat process

The DETAIL option provides more information:

INFO REPICAT, DETAIL

START REPLICAT <REPLICAT_NAME> Starts the Replicat process
STATS REPLICAT <REPLICAT_NAME> Displays the Replicat process statistics.
STOP REPLICAT <REPLICAT_NAME> Stops the Replicat process
KILL REPLICAT <REPLICAT_NAME> kills the Replicat process and is used when the process cannot be stopped gracefully.
LAG REPLICAT <REPLICAT_NAME> Displays the lag time between the Replicat process and the data source.
REGISTER REPLICAT <REPLICAT_NAME> Registers the Replicat process group with its target database
UNREGISTER REPLICAT <REPLICAT_NAME> unregisters an Replicat from its target database.
CLEANUP REPLICAT <REPLICAT_NAME> Deletes the run history for the specified Replicat group. The Replicat process
must be stopped first.
DELETE REPLICAT <REPLICAT_NAME> This command deletes an Extract group. The Replicat process must be stopped first.
SEND REPLICAT <REPLICAT_NAME> Sends ad hoc report generation or trace file generation command to Replicat
VIEW REPORT <REPLICAT_NAME> Allows process to view reports generated by the SEND command

MISCELLANEOUS COMMANDS

COMMAND DESCRIPTION
ADD EXTTRAIL Creates a local trail for an Extract group.
ALTER EXTTRAIL Can alter local trail example if you want to edit the trail file size
ADD RMTTRAIL Creates a remote trail for an Extract or data pump group
ALTER RMTTRAIL Can be used to alter the remote trail size
INFO EXTTRAIL Provides information on the local trail status
INFO RMTTRAIL Provides information on the remote trail status
DELETE EXTTRAIL Deletes the local trail
DELETE RMTTRAIL Deletes the remote trail
VIEW PARAMS Allows a process’ parameter file to be viewed
EDIT PARAMS Allows a process’ parameter file to be edited
ADD CREDENTIALSTORE Creates a Credentials Store wallet to store database user/password
INFO CREDENTIALSTORE Lists all users defined in the Credentials Store wallet.
DBLOGIN provides access to the database with the username and password OR you can also use db login alias. Example:

DBLOGIN USERIDALIAS sourcepass

ADD SCHEMATRANDATA This command can be run only after you have connected to database using dblogin. It adds database schema level supplemental logging
ADD TRANDATA This command can be run only after you have connected to database using dblogin. It adds supplemental logging to a database table.
DELETE TRANDATA This command stops the supplemental logging on a database table
INFO TRANDATA Provides the supplemental logging status on a database table
INFO SCHEMATRANDATA Provides the supplemental logging status on a database schema
HISTORY Lists a history of GGSCI commands that were used.
ADD CHECKPOINTTABLE Adds a checkpoint table on the target database.
DELETE CHECKPOINTTABLE Deletes the checkpoint table from the database.
INFO CHECKPOINTTABLE Shows the checkpoint table status and creation date
OBEY You can run a set of command in chunks by putting those commands in .oby file and executing it

Example:

OBEY dirprm/conf.oby

SHELL Allows OS commands to be executed from GGSCI command prompt
SHELL df -h dirdat

Also at any time you can type “HELP” in ggsci command prompt to get help on a command

Example, for help on a specific command, type HELP [command] [object]

HELP ADD EXTRACT







ggsci> help

Object:          Command:
SUBDIRS          CREATE
ER               INFO, KILL, LAG, SEND, STATUS, START, STATS, STOP
EXTRACT          ADD, ALTER, CLEANUP, DELETE, INFO, KILL, LAG,
                 SEND, START, STATS, STATUS, STOP
EXTTRAIL         ADD, ALTER, DELETE, INFO
GGSEVT           VIEW
MANAGER          INFO, REFRESH, SEND, START, STOP, STATUS
MARKER           INFO
PARAMS           EDIT, VIEW
REPLICAT         ADD, ALTER, CLEANUP, DELETE, INFO, KILL, LAG,
                 SEND, START, STATS, STATUS, STOP
REPORT           VIEW
RMTTRAIL         ADD, ALTER, DELETE, INFO
TRACETABLE       ADD, DELETE, INFO
TRANDATA         ADD, DELETE, INFO
CHECKPOINTTABLE  ADD, DELETE, CLEANUP, INFO



Commands without an object:

(Database)       DBLOGIN, LIST TABLES, ENCRYPT PASSWORD
(DDL)            DUMPDDL
(Miscellaneous)  FC, HELP, HISTORY, INFO ALL, OBEY, SET EDITOR, 
                 SHELL, SHOW, VERSIONS, !


For help on a specific command, type HELP [command] [object]

Example: HELP ADD REPLICAT

Note: You must use the keyword COMMAND to display the “!” help topic. 

ggsci> help ! command

ggsci> help add rmttrail


To create default directories within Oracle GoldenGate home directory

ggsci> CREATE SUBDIRS    

To display the status of all Manager, Extract, and Replicat processes
ggsci> INFO ALL [TASKS | ALLPROCESSES]  
ggsci> info all

Program     Status      Group       Lag       Time Since Chkpt
MANAGER     RUNNING
EXTRACT     RUNNING     EXTR      00:00:00      00:00:01
REPLICAT    ABENDED     REP       00:00:00      00:25:08


ggsci> info all tasks
ggsci> info all allprocesses

To determine whether or not the Manager process is running

ggsci> INFO MANAGER
ggsci> INFO MGR

To review recently processed markers from a NonStop system

ggsci> INFO MARKER [COUNT number_of_items]
ggsci> info marker

To display Status of Extract, Approximate Extract lag, Checkpoint information, Process run history

ggsci> INFO EXTRACT group_name [, SHOWCH [n]] [, DETAIL] [, TASKS | ALLPROCESSES]
ggsci> info extract emp_ext
ggsci> info extract cust_ext, detail
ggsci> info extract ext*, showch
ggsci> info extract *, detail
ggsci> info extract hr, tasks

To display status of Replicat, Approximate replication lag, the trail from which Replicat is reading, Replicat run history, including checkpoints in the trail, Information about the Replicat environment.

ggsci> INFO REPLICAT group_name [, SHOWCH [n]] [, DETAIL] [, TASKS | ALLPROCESSES]
ggsci> info replicat emp_rep
ggsci> info replicat emp_rep, detail
ggsci> info replicat prd*, detail, allprocesses
ggsci> info replicat *, tasks
ggsci> info replicat fin, showch

To retrieve configuration information for a local trail

ggsci> INFO EXTTRAIL trail_name 
ggsci> info exttrail *
ggsci> info exttrail e:\ogg\dirdat\ex

To retrieve configuration information for a remote trail

ggsci> INFO RMTTRAIL trail_name 
ggsci> info rmttrail *
ggsci> info rmttrail d:\ogg\dirdat\ex

To determine whether logging/replication enabled or not




ggsci> INFO TRANDATA user_name.table_names [, OLDFORMAT] [, USETRIGGER] 
ggsci> info trandata hr.*
ggsci> info trandata fin.acct


To confirm the existence of a checkpoint table and view the date and time that it was created

ggsci> INFO CHECKPOINTTABLE [user_name.table_name] 
ggsci> info checkpointtable gg_owner.chkpt_table

To verify the existence of the specified trace table

ggsci> INFO TRACETABLE [owner.table]    
ggsci> info tracetable ora_trace

To get information on multiple Extract and Replicat groups as a unit
ggsci> INFO ER group_wildcard_specification  
ggsci> info ER *ext*

To display the Oracle GoldenGate environment

ggsci> SHOW
ggsci> SHOW ALL

To establish a database connection

ggsci> DBLOGIN {SOURCEDB|TARGETDB dsn | USERID user_name[, PASSWORD password] [SYSDBA] | 
SOURCEDB|TARGETDB dsn, USERID user_name[, PASSWORD password] [SYSDBA] [SQLID sqlid]  
ggsci> dblogin sourcedb testdb
ggsci> dblogin targetdb repldb
ggsci> dblogin userid gg
ggsci> dblogin userid gg, password oracle
ggsci> dblogin userid system@localhost:1521/prod, password 12345678
ggsci> dblogin sourcedb ctdb@host1, userid gg_owner, password ggs sysdba

To encrypt a database login password

ggsci> ENCRYPT PASSWORD password [ENCRYPTKEY keyname]  
ggsci> encrypt password oracle143 encryptkey spiderman

To list all tables in the database that match the specification

ggsci> LIST TABLES table_name  
ggsci> list tables cust*

To create or change a parameter file

ggsci> EDIT PARAMS {MGR | ./GLOBALS | group_name | file_name} 
ggsci> edit params mgr
ggsci> edit params ./GLOBALS
ggsci> edit params myload
ggsci> edit params rep_emp
ggsci> edit params e:\gg\dirprm\replp.prm

To view the contents of a parameter file

ggsci> VIEW PARAMS {MGR | group_name | file_name}   ggsci> view params mgr
ggsci> view params s_extr
ggsci> view params e:\prm\replp.prm

To view GoldenGate error log (ggserr.log file)

ggsci> VIEW GGSEVT
               

To view the process report that is generated by Extract or Replicat

ggsci> VIEW REPORT {group_name[n] | file_name}  
ggsci> view report ext6
ggsci> view report rep
ggsci> view report c:\ogg\dirrpt\orders.rpt


To create an Extract group
ggsci> ADD EXTRACT group_name
{, SOURCEISTABLE |, TRANLOG [bsds_name] |, VAM |, EXTFILESOURCE file_name |, EXTTRAILSOURCE trail_name |, VAMTRAILSOURCE VAM_trail_name} {, BEGIN {NOW | yyyy-mm-dd hh:mi:[ss[.cccccc]]]} |, EXTSEQNO seqno, EXTRBA relative_byte_address |, LOGNUM log_number, LOGPOS byte_offset |, EOF |, LSN value |, EXTRBA relative_byte_address |, PAGE data_page, ROW row | } [, THREADS n] [, PASSIVE] [, PARAMS parameter_file] [, REPORT report_file] [, DESC "description"]

Syntax for an alias Extract:

ADD EXTRACT group_name, RMTHOST {host_name | IP_address}, {MGRPORT port} | {PORT port} [, RMTNAME name] [, DESC "description"]

ggsci> add extract s_extr, tranlog, begin now
ggsci> add extract finext, tranlog, begin now, threads 4
ggsci> add extract fin, tranlog, begin now, passive
ggsci> add extract ext_ms, extseqno 111, begin now
ggsci> add extract hr_ext, extrba 567890, begin 2012-02-02 12:00:00
ggsci> add extract initload, sourceistable
ggsci> add extract pump, exttrailsource /oracle/gg11/dirdat/hr
ggsci> add extract fin, vam       -- VAM - Vendor Access Module
ggsci> add extract fin, vamtrailsource /ogg/dirdat/vt
ggsci> add extract finA, rmthost host123, mgrport 7810, rmtname fin

To create a Replicat group

ggsci> ADD REPLICAT group_name
{, SPECIALRUN |, EXTFILE full_path_name |, EXTTRAIL full_path_name}
[, BEGIN {NOW | YYYY-MM-DD HH:MM[:SS[.CCCCCC]]} |, EXTSEQNO seqno, EXTRBA rba] [, CHECKPOINTTABLE owner.table | NODBCHECKPOINT]
[, PARAMS parameter_file] [, REPORT report_file] [, DESC "description"]  
ggsci> add replicat repl, exttrail C:\OGG10G\dirdat\lt
ggsci> add replicat t_rep, exttrail /oracle/gg11/dirdat/lt, checkpointtable gg_owner.checkpoint
ggsci> add replicat initload, specialrun
ggsci> add replicat sales, exttrail /oracle/gg11/dirdat/lt, nodbcheckpoint

To create a trail for online processing on local system

ggsci> ADD EXTTRAIL trail_name, EXTRACT group_name [, MEGABYTES n] [, SEQNO n]  
ggsci> add exttrail /oracle/gg11/dirdat/lt, extract s_extr
ggsci> add exttrail C:\OGG10G\dirdat\et, extract emp_ext
ggsci> add exttrail c:\ogg\dirdat\fi, extract fin, megabytes 30

To create a trail for online processing on remote system

ggsci> ADD RMTTRAIL trail_name, EXTRACT group_name [, MEGABYTES n] [, SEQNO n]  
ggsci> add rmttrail C:\OGG10G\dirdat\hr, extract extr
ggsci> add rmttrail /u01/app/oracle/ogg/dirdat/ms, extract msextr
ggsci> add rmttrail /u01/app/oracle/ogg/dirdat/my, extract mysql, megabytes 50

To enable Oracle GoldenGate to acquire the transaction information it needs from the transaction records

ggsci> ADD TRANDATA user_name.table_names [, COLS (column_list)] [, INCLUDELONG | EXCLUDELONG]
 [, LOBSNEVER | LOBSALWAYS | LOBSIFCHANGED | LOBSALWAYSNOINDEX] [, NOKEY] [, OLDFORMAT] [, USETRIGGER]     
ggsci> add trandata hr.*
ggsci> add trandata emp.employees
ggsci> add trandata fin.acct, cols (name, address)
ggsci> add trandata fin.acct, nokey, cols (name, pid)
ggsci> add trandata fin.acct, lobsalwaysnoindex
To create a checkpoint table in the target database

ggsci> ADD CHECKPOINTTABLE [user_name.table_name]  
ggsci> add checkpointtable
ggsci> add checkpointtable gg_owner.checkpoint

To create a trace table in the Oracle database

ggsci> ADD TRACETABLE [owner.table]
 
ggsci> add tracetable
ggsci> add tracetable ora_trace

ggsci> REGISTER EXTRACT extract_group_name LOGRETENTION
ggsci> register extract extr logretention

To start Manager process

ggsci> START MANAGER   
ggsci> START MGR
ggsci> START *

To start Extract process

ggsci> START EXTRACT extract_name    
ggsci> start extract extr

To start Replicat process

ggsci> START REPLICAT group_name [SKIPTRANSACTION | ATCSN csn | AFTERCSN csn]  
ggsci> start replicat rep
ggsci> start replicat fin, atcsn 5238306       -- commit sequence number (CSN)
ggsci> start replicat fin, aftercsn 0X000006B1:0002334D:0004

To start multiple Extract and Replicat groups as a unit

ggsci> START ER group_wildcard_specification   
ggsci> start er *rep*

To stop Manager process

ggsci> STOP MANAGER [!]   
ggsci> stop manager
ggsci> stop manager !              -- will not ask for confirmation

ggsci> STOP EXTRACT extract_name
  -- To stop Extract gracefully
ggsci> stop extract extr
To stop Replicat gracefully

ggsci> STOP REPLICAT replicat_name [!]
 
ggsci> stop replicat rep

To stop multiple Extract and Replicat groups as a unit

ggsci> STOP ER group_wildcard_specification  
ggsci> stop er *ext*

To determine whether or not the Manager process is running

ggsci> STATUS MANAGER 

To determine whether or not Extract is running

ggsci> STATUS EXTRACT group_name [, TASKS | ALLPROCESSES]  
ggsci> status extract extr_hr
ggsci> status extract ext*, tasks
ggsci> status extract *ext*, allprocesses

To determine whether or not Replicat is running

ggsci> STATUS REPLICAT group_name [, TASKS | ALLPROCESSES
ggsci> status replicat emp_rep
ggsci> status replicat cust_rep, allprocesses

To check the status of multiple Extract and Replicat groups as a unit

ggsci> STATUS ER group_wildcard_specification    
ggsci> status er *EX*

To display statistics for one or more Extract group

ggsci> STATS EXTRACT group_name [, statistic] [, TABLE table] [, TOTALSONLY table_specification] [, REPORTFETCH | NOREPORTFETCH] [, REPORTRATE HR|MIN|SEC] [, ... ] 
ggsci> stats ext_hr
ggsci> stats extract ext
ggsci> stats extract ext2 reportrate sec
ggsci> stats extract fin, total, daily
ggsci> stats extract fin, total, hourly, table acct, reportrate min, reset, reportfetch

To display statistics for one or more Replicat groups

ggsci> STATS REPLICAT group_name [, statistic] [, TABLE table] [, TOTALSONLY table_specification] [, REPORTDETAIL | NOREPORTDETAIL] [, REPORTRATE HR|MIN|SEC] [, ... ]  
ggsci> stats rep_hr
ggsci> stats replicat fin, total, table acct, reportrate hr, reset, noreportdetail

To get statistics on multiple Extract and Replicat groups as a unit

ggsci> STATS ER group_wildcard_specification  
ggsci> stats er ext*

ggsci> REFRESH MANAGER  -- not available in Oracle 11g

To retrieve the status of the active Manager process or to retrieve dynamic port information as configured in the Manager parameter file

ggsci> SEND MANAGER [CHILDSTATUS [DEBUG]] [GETPORTINFO [DETAIL]] [GETPURGEOLDEXTRACTS]  
ggsci> send manager childstatus
ggsci> send manager childstatus debug
ggsci> send manager getportinfo
ggsci> send manager getportinfo detail
ggsci> send manager getpurgeoldextracts

To communicate with a running Extract process

ggsci> SEND EXTRACT group_name, 
{ CACHEMGR {CACHESTATS | CACHEQUEUES | CACHEPOOL} | FORCESTOP | FORCETRANS id [THREAD n] [FORCE] | GETLAG | GETTCPSTATS | LOGEND | REPORT | ROLLOVER | SHOWTRANS [id] [THREAD n] [COUNT n] [DURATION duration_unit] [TABULAR] [FILE file_name [DETAIL]] | SKIPTRANS id [THREAD n] [FORCE] | STATUS | STOP | TLTRACE {DEBUG | OFF | level} [SIZELIMIT size] [DDLINCLUDE | DDL[ONLY]] [FILE] file_name | TRACE[2] {tracefile | OFF} | TRACEINIT | TRANLOGOPTIONS {PURGEORPHANEDTRANSACTIONS | NOPURGEORPHANEDTRANSACTIONS} | TRANLOGOPTIONS TRANSCLEANUPFREQUENCY minutes | VAMMESSAGE "Teradata_command" | VAMMESSAGE {ARSTATS | INCLUDELIST [filter] | EXCLUDELIST [filter]} | VAMMESSAGE OPENTRANS
}    
Teradata_command = {"control:terminate" | "control:suspend" | "control:resume" | "control:copy database.table"
ggsci> send extract exthr status
ggsci> send extract extr, getlag
ggsci> send extract group_name tltrace file file_name ddlinclude
ggsci> send extract fin, rollover
ggsci> send extract fin  stop
ggsci> send extract fin, vammessage control:suspend
ggsci> send extract fin, tranlogoptions transcleanupfrequency 15
ggsci> send extract fin, showtrans count 10
ggsci> send extract fin, skiptrans 5.17.27634 thread 2

To communicate with a starting or running Replicat process

ggsci> SEND REPLICAT group_name,
{ FORCESTOP | GETLAG | HANDLECOLLISIONS [table_specification] | NOHANDLECOLLISIONS [table_specification] | REPORT [HANDLECOLLISIONS [table_specification]] | STATUS | STOP | TRACE[2] [DDLINCLUDE | DDL[ONLY]] [FILE] file_name | TRACE[2] OFF | TRACEINIT
 
ggsci> send replicat fin, handlecollisions
ggsci> send replicat fin, report handlecollisions fin_*
ggsci> send replicat fin, getlag

To send instructions to multiple Extract and Replicat groups as a unit

ggsci> SEND ER group_wildcard_specification  
ggsci> send er *ext

To change the attributes of an Extract group, To increment a trail to the next file in the sequence

ggsci> ALTER EXTRACT group_name [, ADD_EXTRACT_attribute] [, THREAD number] [, ETROLLOVER] 
ggsci> alter extract fin, begin 2012-02-16
ggsci> alter extract fin, etrollover
ggsci> alter extract fin, extseqno 26, extrba 338
ggsci> alter extract accounts, thread 4, begin 2012-03-09
ggsci> alter extract sales, lsn 1234:123:1

To change the attributes of a Replicat group

ggsci> ALTER REPLICAT group_name , 
[, BEGIN {NOW | YYYY-MM-DD HH:MM[:SS[.CCCCCC]]} |, EXTSEQNO seqno, EXTRBA rba] [, PARAMS parameter_file] [, REPORT report_file] [, DESC "description"]  
ggsci> alter replicat fin, begin 2011-09-28 08:08:08
ggsci> alter replicat fin, extseqno 53
ggsci> alter replicat fin, extrba 666

To change the attributes of a trail (on the local system)

ggsci> ALTER EXTTRAIL trail_name, EXTRACT group_name [, MEGABYTES n]  
ggsci> alter exttrail c:\ogg\dirdat\aa, extract fin, megabytes 30

To change the attributes of a trail (on a remote system)

ggsci> ALTER RMTTRAIL trail_name, EXTRACT group_name [, MEGABYTES n]  
ggsci> alter rmttrail c:\ogg\dirdat\et, extract fin, megabytes 25

To delete run history for specified Extract group

ggsci> CLEANUP EXTRACT group_name [, SAVE count]   
ggsci> cleanup extract fin
ggsci> cleanup extract e*, save 6

To delete run history for specified Replicat group

ggsci> CLEANUP REPLICAT group_name [, SAVE count]  
ggsci> cleanup replicat fin
ggsci> cleanup replicat *, save 10

To remove checkpoint records from the checkpoint table

ggsci> CLEANUP CHECKPOINTTABLE [user_name.table_name]
 
ggsci> cleanup checkpointtable ggs.fin_check

To delete an Extract group

ggsci> DELETE EXTRACT group_name [!]  
ggsci> delete extract emp_ext
ggsci> delete extract emp_ext !              -- will not ask for confirmation

To delete a Replicat group

ggsci> DELETE REPLICAT group_name [!]  
ggsci> delete replicat emp_ext
ggsci> delete replicat emp_ext !             -- will not ask for confirmation

To delete the record of checkpoints associated with a trail on a local system

ggsci> DELETE EXTTRAIL trail_name   
ggsci> delete exttrail /home/ogg/dirdat/et

To delete the record of checkpoints associated with a trail on a remote system

ggsci> DELETE RMTTRAIL trail_name     
ggsci> delete rmttrail /home/ogg/dirdat/et

To delete logging/replication data

ggsci> DELETE TRANDATA user_name.table_names [, OLDFORMAT] [, USETRIGGER] 
ggsci> delete trandata fin.acct
ggsci> delete trandata fin.cust*
ggsci> delete trandata emp.hr, usetrigger

To drop checkpoint table from database

ggsci> DELETE CHECKPOINTTABLE [user_name.table_name] [!]    
ggsci> delete checkpointtable ggs.fin_check

To delete a trace table

ggsci> DELETE TRACETABLE [owner.table]  
ggsci> delete tracetable ora_trace

To kill an Extract process running in regular or PASSIVE mode

ggsci> KILL EXTRACT group_name   
ggsci> kill extract fin

To kill a Replicat process

ggsci> KILL REPLICAT group_name
 
ggsci> kill replicat fin

To forcefully terminate multiple Extract and Replicat groups as a unit

ggsci> KILL ER group_wildcard_specification  
ggsci> kill er *x*

To determine a true lag time between Extract and the datasource

ggsci> LAG EXTRACT group_name   
ggsci> lag extract ext*
ggsci> lag extract *

To determine a true lag time between Replicat and the trail

ggsci> LAG REPLICAT group_name    
ggsci> lag replicat myrepl
ggsci> lag replicat *

To get lag information on multiple Extract and Replicat groups as a unit

ggsci> LAG ER group_wildcard_specification  
ggsci> lag er *ext*

To view the data in the Oracle GoldenGate DDL history table

ggsci> DUMPDDL [SHOW]  
ggsci> dumpddl

To view the most recently issued GGSCI commands since the session started

ggsci> HISTORY [n]  
ggsci> history       -- by default, shows last 10 commands
ggsci> history 30

To change the default text editor for the current session of GGSCI, default editors are Notepad for Windows and vi for UNIX

ggsci> SET EDITOR program_name     
ggsci> set editor wordpad

To display operating system and database version information

ggsci> VERSIONS
To display edit a previously issued GGSCI command and then execute it again
ggsci> FC [n | -n | string]  
ggsci> fc
ggsci> fc 9
ggsci> fc -3
ggsci> fc sta

FC editor commands

i text  -- Inserts text
r text  -- Replaces text
d       -- Deletes a character
replacement_text  -- Replaces the displayed command with the text that we enter on a one-for-one basis.

To execute shell commands from within GGSCI interface

ggsci> SHELL shell_command  
ggsci> shell ls -l /u01/app/oracle/gg/dirdat
ggsci> shell dir dirprm\*
ggsci> shell rm ./dat*

To execute previous GGSCI command

ggsci> ! [n | -n | string]     
ggsci> !
ggsci> ! 6    -- To run the command 6 listed in the history
ggsci> ! -3
ggsci> ! sta
ggsci> help ! command

To process a file that contains a list of GoldenGate commands.

ggsci> OBEY ggsci_script     
ggsci> shell more /u01/app/oracle/gg/startup.txt
START MANAGER
START EXTRACT EXT3
START EXTRACT DPUMP
INFO ALL
ggsci> OBEY /u01/app/oracle/gg/startup.txt
ggsci> OBEY ./mycommands.txt

ggsci> EXIT





INFO
INFO MANAGER Provides details of the Manager process
INFO MGR Also provides details of the Manager process
STATUS MANAGER This command also display the info of manager
REFRESH
REFRESH MANAGER Reloads from the Manager Parameter file
REFRESH MGR Reloads from the Manager Parameter file
SEND
SEND MANAGER CHILDSTATUS Displays status of processes, started by Manager.
SEND MANAGER CHILDSTATUS DEBUG Return the ports numbers allocated by the Manager
SEND MANAGER GETPORTINFO Displays the list of currently allocated ports by Manager process
SEND MANAGER GETPORTINFO DETAIL Provides info on ports and process assigned to them.
SEND MANAGER GETPURGEOLDEXTRACTS Retrieves trail purge retention info.
START
START MANAGER Starts the Manager Process
START MGR Starts the Manager Process
STOP
STOP MGR Stops the Manager Process
STOP MANAGER ! Stops Manager without asking for user confirmation.
STOP MGR ! Stops Manager without asking for user confirmation.
ADD Command Creates an Extract group.
ADD EXTRACT E_SRC, Tranlog, Begin Now Used to specify transaction logs as data source for extract.
ADD EXTRACT E_SRC, Begin Now, Passive Specifies the extract to be run in passive mode.
ADD EXTRACT E_SRC, Extseqno 000008 Extrba 287458, Begin Now Specifies the extract process starting position
ADD EXTRACT E_SRC, SOURCEISTABLE Extracts data from data tables for initial loading.


ALTER Command
ALTER EXTRACT e_src, BEGIN NOW Instructs extract to start processing
ALTER EXTRACT e_src, BEGIN 2013-04-16 Instructs extract to start processing from specific date
ALTER EXTRACT e_src, ETROLLOVER Extract rolls over to next trail file
ALTER EXTRACT e_src, EXTSEQNO 01, EXTRBA 2887 Alters extract to start from the specific locaton in the trail
ALTER EXTRACT e_src, THREAD 4, BEGIN 2012-03-09 Alters extract thread & start date for RAC
ALTER EXTRACT e_src, LSN 1234:123:1 Altering extract for the SQL Server


CLEANUP Command It is used to clear the run history for the specific extract group
CLEANUP EXTRACT e_src It purges all history of records except last
CLEANUP EXTRACT e_src, SAVE 10 It saves last 10 records and deletes all other


DELETE Command It is used to delete the extract process, its checkpoints detail and unregister the extract group.


DELETE EXTRACT e_src deletes the extract process
DELETE EXTRACT e* deletes all extract process whose name starts with e
DELETE EXTRACT e* ! deletes all extract process whose name starts with e without prompting


INFO Command It is used to display the info of the extract like its status, lag, checkpoint, run history, trail info etc
INFO EXTRACT e_src, SHOWCH Display checkpoint info of extract
INFO EXTRACT e_src, DETAIL Display trail info, run history
INFO EXTRACT e_src, TASKS Display extract tasks


KILL Command It is used to kill the extract that can't be stopped with STOP Command""
KILL EXTRACT e_src


LAG Command It is used to find the lag time between Extract and data source more precisely than the "INFO Command"
LAG EXTRACT e_src To find lag for extract "e_src"
LAG EXTRACT * To find lag for all of the extract processes


REGISTER Command It is used to register the extract process, so that it can retain the archive logs required for its recovery.
REGISTER EXTRACT e_src LOGRETENTION To register extract "e_src"


SEND Command It is used to communicate with the running extract like sending requests for report creation, stats, to force extract to rollover to next trail etc
SEND EXTRACT finance, ROLLOVER To increment the extract to next file in trail
SEND EXTRACT finance, STOP To stop the extract process
SEND EXTRACT finance, TRANLOGOPTIONS TRANSCLEANUPFREQUENCY 20 For the Oracle RAC, specify the time after which the OGG scan and delete the orphan transactions
SEND EXTRACT finance, SKIPTRANS 5.17.27634 THREAD 2 For skipping the transaction in the Oracle RAC environment
SEND EXTRACT e_src, SHOWTRANS Display the info about the open transactions like checkpoint, extract group name, SCN, Redo log and RB, status etc
SEND EXTRACT e_src, SHOWTRANS COUNT 2 Display the info for two transactions only


START Command It is used to start the Extract process
START EXTRACT e_src


STATS Command It is used to display the stats for the extract process including the DDL and DML operations.
STATS e_src
STATS EXTRACT e_src stats will be displayed for the extract E_SRC""
STATS EXTRACT e_src REPORTRATE SEC display the stats for the fetch opertions per sec
STATS EXTRACT e_src, TOTAL, DAILY The total stats is shown since the start of the day
STATS EXTRACT e_src, TOTAL, HOURLY, REPORTRATE MIN, RESET, REPORTFETCH By using comma between the keywords multiple options can be used for the stats command


STATUS Command It is used to check whether extract process is currently running or not.
STATUS EXTRACT e_src To check the status for extract "E_SRC"
STATUS EXTRACT e* To check the status for all extracts starting with "e"


STOP Command It is used to stop the running extract process
STOP EXTRACT e_src To stop the extract "e_src"
STOP EXTRACT e* To stop all of the running extract process whose name start with "e"
STOP EXTRACT * To stop all of the running extract processes


UNREGISTER Command it is used to unregister the extract group by removing its registration from oracle DB.
UNREGISTER EXTRACT e_src LOGRETENTION To unregister the extract e_src""
ADD Command It is used to create the replicat process by creating checkpoints
ADD REPLICAT INITLOAD, SPECIALRUN It will create a special run replicat as task.
ADD REPLICAT r_trg, EXTTRAIL /ORACLE/GOLDENGATE/DIRDAT/TT Create the replicat with the trail
ADD REPLICAT r_trg, EXTTRAIL /ORACLE/GOLDENGATE/DIRDAT/TT, CHECKPOINTTABLE OGG_USER.OGG_CHECKPOINT Create the replicat with the trail and the checkpoint info like the DB table used to save checkpoint info.
ADD REPLICAT r_trg, EXTTRAIL /ORACLE/GOLDENGATE/DIRDAT/TT, NODBCHECKPOINT Create the replicat with the trail and specifying that this replicat did'nt write info to DB table


ALTER Command It is used to change the properties of the existing replicat process
ALTER REPLICAT r_trg, BEGIN NOW Alter replicat to start processing from now
ALTER REPLICAT r_trg, BEGIN 2013-05-11 Alter replicat to start processing from specific date
ALTER REPLICAT r_trg, BEGIN 2013-01-07 08:00:01 Alter replicat to start processing from specific date and time
ALTER REPLICAT r_trg, EXTSEQNO 00007 Alter replicat to start from the specific trail file
ALTER REPLICAT r_trg, EXTRBA 65477 Alter replicat to start from the specific location in the trail


CLEANUP Command It is used to clear the run history for the specific replicat process
CLEANUP REPLICAT r_trg It purges all history of records except last
CLEANUP REPLICAT r_trg, SAVE 10 It saves last 10 records and deletes all other
DELETE Command It is used to delete the replicat process, by removing the checkpoints and freeing trail file for purging by manager. But the process must be stopped and user must be logged in using DBlogin command
DELETE REPLICAT r_trg deletes the replicat process
DELETE EXTRACT r* deletes all replicat process whose name starts with r
DELETE EXTRACT r* ! deletes all replicat process whose name starts with r without prompting


INFO Command It is used to display the replicat info like processing history, status, appox lag, trail info, checkpoint info and environment of replicat.
INFO REPLICAT *, TASKS It is used to display replicat tasks only.
INFO REPLICAT r_trg It is used to display the information of replicat.
INFO REPLICAT r_trg, DETAIL It display the detailed information of replicat.
INFO REPLICAT r_trg, SHOWCH It displays the checkpoint table information, from checkpoint file and checkpoint table.


KILL Command It is used to kill the replicat that can't be stopped with "STOP Command", but checkpoint info remain unchanged and transactions are rolled back in DB
KILL REPLICAT r_trg


LAG Command It is used to find the lag time between Replicat and trail more precisely than the "INFO Command"
LAG REPLICAT r_trg To find lag for replicat "r_trg"
LAG REPLICAT * To find lag for all of the replicat processes


SEND Command It is used to communicate with the running replicat process
SEND REPLICAT r_trg, HANDLECOLLISIONS Enable the handlecollisions option of OGG used for error handling
SEND REPLICAT r_trg, REPORT HANDLECOLLISIONS r_* Generate statical report to replicat report file
SEND REPLICAT r_trg, GETLAG Get the lag info in seconds


START Command To start the replicat process
START REPLICAT r_trg
START REPLICAT r_trg, ATCSN 6454388 To start the replicat process from the oracle-specific CSN number including the CSN no transaction
START REPLICAT r_trg, AFTERCSN 6454389 To start the replicat process from the oracle-specific CSN number, but ignoring that CSN no transaction


STATS Command It is used to display the stats for the replicat process.
STATS r_trg
STATS REPLICAT r_trg stats will be displayed for the REPLICAT r_trg""
STATS REPLICAT r_trg REPORTDETAIL SEC display the stats for the opertaion that were not replicated due to errors
STATS REPLICAT r_trg, TOTAL, DAILY The total stats is shown since the start of the day
STATS REPLICAT r_trg, TOTAL, HOURLY, REPORTRATE MIN, RESET, NOREPORTDETAIL By using comma between the keywords multiple options can be used for the stats command


STATUS Command It is used to find whether replicat is running or not
STATUS REPLICAT r_trg To check the status for replicat "r_trg"
STATUS REPLICAT r* To check the status for all replicat starting with "r"


STOP Command It is used to stop the running replicat process
STOP REPLICAT r_trg To stop the replicat "r_trg"
STOP REPLICAT r* To stop all of the running replicat process whose name start with "r"
STOP REPLICAT * To stop all of the running replicat processes
ER Commands They are used to control the multiple extract and replicat processes
INFO ER * To info all of the process
KILL ER * To kill all of the process
LAG ER * To get lag info of all the process
SEND ER * To use send command on all of the process
START ER * To start all of the process
STATS ER * To check the stats all of the process
STATUS ER * To find status of all the process
STOP ER * To stop all of the process
ADD EXTTRAIL It is used to create the local trail file for extract process on local system
ADD EXTTRAIL /ORACLE/GOLDENGATE/DIRDAT/SE, EXTRACT e_src, MEGABYTES 100 Create EXTTRAIL with the Prefix"SE", and the size of 100 mb
ADD EXTTRAIL /ORACLE/GOLDENGATE/DIRDAT/SE000009 To create the EXTTRAIL with specific sequence number


ADD RMTTRAIL It is used to create the remote trail files for the extract or pump processes on remote systems
ADD RMTTRAIL /ORACLE/GOLDENGATE/DIRDAT/TE, EXTRACT p_src, MEGABYTES 100 Create RMTTRAIL with the Prefix"TE", and the size of 100 mb
ADD RMTTRAIL /ORACLE/GOLDENGATE/DIRDAT/SE000009 To create the RMTTRAIL with specific sequence number


ALTER EXTTRAIL It is used to change the options of the existing EXTTRAIL file for extract process on local system
ALTER EXTTRAIL /ORACLE/GOLDENGATE/DIRDAT/SE, EXTRACT e_src, MEGABYTES 50


ALTER RMTTRAIL It is used to change the options of the existing RMTTRAIL file of extract or pump processes on remote systems
ALTER RMTTRAIL /ORACLE/GOLDENGATE/DIRDAT/TE, EXTRACT p_src, MEGABYTES 50


DELETE EXTTRAIL It is used to delete the exttrail assigned to the extract on local system by deleting its references from checkpoint file
DELETE EXTTRAIL /ORACLE/GOLDENGATE/DIRDAT/SE


DELETE RMTTRAIL It is used to delete the exttrail for the extract or pump on remote system by deleting its references from checkpoint file
DELETE RMTTRAIL /ORACLE/GOLDENGATE/DIRDAT/TE


INFO EXTTRAIL It is used to display the info of local trail like name, associated extract, rba and file size etc
INFO EXTTRAIL /ORACLE/GOLDENGATE/DIRDAT/SE Display info for specific exttrails
INFO EXTTRAIL * Display info for all exttrails


INFO RMTTRAIL It is used to display the info of remote trail like name, associated extract, rba and file size etc
INFO RMTTRAIL /ORACLE/GOLDENGATE/DIRDAT/TE Display info for specific rmttrails
INFO RMTTRAIL * Display info for all rmttrails