GGSCI command Summary

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