GGSCI -- (Oracle) GoldenGate Software Command Interpreter[in OGG 11g and OGG 12c]
OGG files
Reports (.rpt) /u02/goldengate/ogg/dirrpt
Parameters (.prm) /u02/goldengate/ogg/dirprm
Replicat Checkpoints (.cpr) /u02/goldengate/ogg/dirchk
Extract Checkpoints (.cpe) /u02/goldengate/ogg/dirchk
Process Status (.pcs) /u02/goldengate/ogg/dirpcs
SQL Scripts (.sql) /u02/goldengate/ogg/dirsql
Database Definitions (.def) /u02/goldengate/ogg/dirdef
Dump files (.dmp) /u02/goldengate/ogg/dirdmp
Masterkey wallet files (.wlt) /u02/goldengate/ogg/dirwlt
Credential store files (.crd) /u02/goldengate/ogg/dircrd
/u02/goldengate/ogg/dirdat
How to Invoke OGG command line interface?
C:\GG> ggsci.exe (in Windows)
[oracle@prod gg]$ ./ggsci
Commands
ggsci> HELP [command] [object]
ggsci> help
GGSCI/OGG 12c Command Summary:
Object: Command:
SUBDIRS CREATEDATASTORE ALTER, CREATE, DELETE, INFO, REPAIRER INFO, KILL, LAG, SEND, STATUS, START, STATS, STOPEXTRACT ADD, ALTER, CLEANUP, DELETE, INFO, KILL, LAG, REGISTER, SEND, START, STATS, STATUS, STOP, UNREGISTEREXTTRAIL ADD, ALTER, DELETE, INFOGGSEVT VIEWJAGENT INFO, START, STATUS, STOPMANAGER INFO, SEND, START, STOP, STATUSMARKER INFOPARAMETERS EDIT, VIEW, SET EDITOR, INFO, GETPARAMINFOREPLICAT ADD, ALTER, CLEANUP, DELETE, INFO, KILL, LAG, REGISTER, SEND, START, STATS, STATUS, STOP, SYNCHRONIZE, UNREGISTERREPORT VIEWRMTTRAIL ADD, ALTER, DELETE, INFOTRACETABLE ADD, DELETE, INFOTRANDATA ADD, DELETE, INFOSCHEMATRANDATA ADD, DELETE, INFOCHECKPOINTTABLE ADD, DELETE, CLEANUP, INFO, UPGRADEWALLET CREATE, OPEN, PURGEMASTERKEY ADD, INFO, RENEW, DELETE, UNDELETECREDENTIALSTORE ADD, ALTER, INFO, DELETEHEARTBEATTABLE ADD, DELETE, ALTER, INFOHEARTBEATENTRY DELETE
Commands without an object:(Database) DBLOGIN, LIST TABLES, ENCRYPT PASSWORD, FLUSH SEQUENCE, MININGDBLOGIN, SET NAMECCSID(DDL) DUMPDDL(Miscellaneous) !, ALLOWNESTED | NOALLOWNESTED, CREATE SUBDIRS, DEFAULTJOURNAL, FC, HELP, HISTORY, INFO ALL, OBEY, SHELL, SHOW, VERSIONS, VIEW GGSEVT, VIEW REPORT (note: type the word COMMAND after the ! to display the ! help topic, for example: GGSCI (sys1)> help ! command For help on a specific command, type HELP command object.Example: HELP ADD REPLICAT
ggsci> help add rmttrail
=========================================================================ggsci > CREATE SUBDIRS -- To create default directories within Oracle GoldenGate (OGG) home directory=========================================================================DATASTORE ALTER, CREATE, DELETE, INFO, REPAIRggsci > info datastore -- to display information about the Oracle GoldenGate Monitor data storeggsci > info datastore
ggsci > create datastore { MMAP | SHM [ID ] } -- to create an Oracle GoldenGate Monitor data store in the Oracle GoldenGate installation directoryCREATE DATASTORE MMAPCREATE DATASTORE SHMCREATE DATASTORE SHM ID 999
ggsci > alter datastore { MMAP | SHM [ID ] } -- to change the memory model that is used forinterprocess communication by the Oracle GoldenGate Monitor data store.ALTER DATASTORE MMAPALTER DATASTORE SHMALTER DATASTORE SHM ID 999
ggsci > DELETE DATASTORE [!] -- to remove the Oracle GoldenGate Monitor data store from the Oracle GoldenGate installation directory.DELETE DATASTOREDELETE DATASTORE !
ggsci > REPAIR DATASTORE -- to repair the Oracle GoldenGate Monitor data store if it is corrupt or after an upgrade.REPAIR DATASTORE=========================================================================ER INFO, KILL, LAG, SEND, STATUS, START, STATS, STOPggsci > INFO ER group_wildcard_specification -- To get information on multiple Extract and Replicat groups as a unitggsci > info er *ext*ggsci > info ER *
ggsci > START ER group_wildcard_specification -- To start multiple Extract and Replicat groups as a unitggsci > start er *rep*
ggsci > STOP ER group_wildcard_specification -- To stop multiple Extract and Replicat groups as a unitggsci > stop er *ext*
ggsci > STATUS ER group_wildcard_specification -- To check the status of multiple Extract and Replicat groups as a unitggsci > status er *EX*
ggsci > LAG ER group_wildcard_specification -- To get lag information on multiple Extract and Replicat groups as a unitggsci > lag er *ext*
ggsci > KILL ER group_wildcard_specification -- To forcefully terminate multiple Extract and Replicat groups as a unitggsci > kill er *x*
ggsci > SEND ER group_wildcard_specification -- To send instructions to multiple Extract and Replicat groups as a unitggsci > send er *ext
ggsci > STATS ER group_wildcard_specification -- To get statistics on multiple Extract and Replicat groups as a unitggsci > stats er ext*stats ER *=========================================================================EXTRACT ADD, ALTER, CLEANUP, DELETE, INFO, KILL, LAG, REGISTER, SEND, START, STATS, STATUS, STOP, UNREGISTERggsci > INFO EXTRACT group_name [, SHOWCH [n]] [, DETAIL] [, TASKS | ALLPROCESSES] -- To display status of Extract, approximate Extract lag, checkpoint information, process run historyggsci > info extract emp_extggsci > info extract cust_ext, detailggsci > info extract ext*, showchINFO EXTRACT E*, SHOWCH 10ggsci > info extract *, detailggsci > info extract hr, tasksggsci > info extract extp, allprocesses
ggsci > ADD EXTRACT group_name{, SOURCEISTABLE | , TRANLOG | , INTEGRATED TRANLOG | , VAM | , EXTFILESOURCE file_name | , EXTTRAILSOURCE trail_name | , VAMTRAILSOURCE VAM_trail_name} BEGIN {NOW | yyyy-mm-dd[ hh:mi:[ss[.cccccc]]]} | EXTSEQNO sequence_number, EXTRBA relative_byte_address | EOF | LSN [value] | bsds_name | LRI_NUMBER | EXTRBA relative_byte_address | PAGE data_page, ROW row_ID | SEQNO sequence_number SCN value THREADS [n] PASSIVE PARAMS file_name REPORT file_name DESC 'description' SOCKSPROXY {host_name | IP_address}[:port] [PROXYCSALIAS credential_store_alias[PROXYCSDOMAIN credential_store_domain]]] RMTNAME passive_Extract_name] DESC [description]} -- To create an Extract groupSyntax 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 nowggsci > add extract finext, tranlog, begin now, threads 4ggsci > add extract fin, tranlog, begin now, passiveADD EXTRACT ESOURCE02, INTEGRATED TRANLOG, BEGIN NOWggsci > add extract ext_ms, extseqno 111, begin nowggsci > add extract hr_ext, extrba 567890, begin 2018-04-02 12:00:00ggsci > add extract initload, sourceistableggsci > add extract pump, exttrailsource /oracle/ogg/dirdat/hrggsci > add extract fin, vam -- VAM - Vendor Access Moduleggsci > add extract fin, vamtrailsource /ogg/dirdat/vtggsci > add extract finA, rmthost host123, mgrport 7810, rmtname finADD EXTRACT finance TRANLOG SCN 123456ADD EXTRACT finance INTEGRATED TRANLOG SCN 123456
ggsci > REGISTER EXTRACT extract_group_name LOGRETENTION -- For classic ExtractREGISTER EXTRACT group-name ( LOGRETENTION | DATABASE ( [ CONTAINER container-list | ADD CONTANER container-list | DROP CONTAINER container-list ] [ SCN scn ] [ SHARE ( AUTOMATIC | group-name | NONE ) ] [ [NO]OPTIMIZED ])) -- For Integrated Extractggsci > register extract extr logretentionggsci > REGISTER EXTRACT 1ext DATABASEREGISTER EXTRACT ext9 database SCN 136589 SHARE AUTOMATICREGISTER EXTRACT ext2 DATABASE SHARE NONE REGISTER EXTRACT sales DATABASE CONTAINER (sales, finance, hr)
ggsci > UNREGISTER EXTRACT extract_group_name {DATABASE | LOGRETENTION}ggsci > unregister extract extr logretentionUNREGISTER EXTRACT sales DATABASE
ggsci > ALTER EXTRACT group_name [ADD_EXTRACT_attribute] [TRANLOG LRI_number] [UPGRADE INTEGRATED TRANLOG] [DOWNGRADE INTEGRATED TRANLOG [THREADS number]] [THREAD number] [LSN value] [SCN value] [ETROLLOVER] -- To change the attributes of an Extract group, To increment a trail to the next file in the sequenceggsci > alter extract PA_AD, begin nowggsci > alter extract EA_AD, begin 2018-08-23ggsci > alter extract PA_AD, etrolloverggsci > alter extract PA_AD, extseqno 5470, extrba 209184ALTER EXTRACT EA01RA THREAD 1ggsci > alter extract accounts, thread 4, begin 2018-03-09ggsci > alter extract sales, lsn 1234:123:1ALTER EXTRACT finance, SCN 778899ALTER EXTRACT finance, UPGRADE INTEGRATED TRANLOGALTER EXTRACT efin8, DOWNGRADE INTEGRATED TRANLOG THREADS 2ALTER EXTRACT finance, SEQNO 1234 JOURNAL accts/acctsjrn JRNRCV accts/jrnrcv0005ggsci > LAG EXTRACT group_name [GLOBAL] -- To determine a true lag time between Extract and the datasourceggsci > lag extract ext*ggsci > lag extract *
ggsci > KILL EXTRACT group_name -- To kill an Extract process running in regular or PASSIVE modeggsci > kill extract fin
ggsci > DELETE EXTRACT group_name [!] -- To delete an Extract groupggsci > delete extract emp_extggsci > delete extract emp_ext ! -- will not ask for confirmation
ggsci > CLEANUP EXTRACT group_name [, SAVE count] -- To delete run history for the specified Extract groupggsci > cleanup extract finggsci > cleanup extract e*, save 6
ggsci > START EXTRACT extract_name [ATCSN csn | AFTERCSN csn] -- To start Extract processggsci > start extract extrggsci > start *START EXTRACT finance ATCSN 684993 START EXTRACT finance AFTERCSN 684993 START EXT1PMP FORCEAPPEND
ggsci > STOP EXTRACT extract_name -- To stop Extract gracefullyggsci > stop extract extr
ggsci > STATUS EXTRACT group_name [, TASKS | ALLPROCESSES] [UPGRADE | DOWNGRADE] -- To determine whether or not Extract is runningggsci > status extract extr_hrggsci > status extract ext*, tasksggsci > status extract *ext*, allprocesses
ggsci > STATS EXTRACT group_name [, statistic] [, TABLE table] [, TOTALSONLY table_specification] [, REPORTFETCH | NOREPORTFETCH] [, REPORTRATE HR|MIN|SEC] [, ... ] -- To display statistics for one or more Extract groupggsci > stats ext_hrggsci > stats ecm*ggsci > stats extract extggsci > stats extract ext2 reportrate secggsci > stats extract fin, total, dailystats extract fin, total, hourly, table acct, reportrate min, reset, reportfetchstats extract ext_1a, resetSTATS EXTRACT ext, LATEST, REPORTFETCH
ggsci > SEND EXTRACT group_name, { BR {BRINTERVAL interval | BRSTART | BRSTOP | BRCHECKPOINT {IMMEDIATE | IN n{M|H} | AT yyyy-mm-dd hh:mm[:ss]]}} | BR BRFSOPTION { MS_SYNC | MS_ASYNC } CACHEMGR {CACHESTATS | CACHEQUEUES | CACHEVMUSAGE} | FORCESTOP | FORCETRANS transaction_ID [THREAD n] [FORCE] | GETLAG | GETPARAMINFO [parameter_name] [FILE output_file] | GETTCPSTATS | LOGEND | LOGSTATS | REPORT | RESUME | ROLLOVER | SHOWTRANS [transaction_ID] [THREAD n] [COUNT n] [DURATION duration unit] [TABULAR] [FILE file_name [DETAIL]] | SKIPTRANS transaction_ID [THREAD n] [FORCE] | STATUS | STOP | TRACE[2] file_name | TRACE[2] OFF | TRACE OFF file_name | TRACEINIT | TRANSLOGOPTIONS INTEGRATEDPARAMS(parameter_specification)| TRANLOGOPTIONS {PREPAREFORUPGRADETOIE | NOPREPAREFORUPGRADETOIE} |TRANLOGOPTIONS {PURGEORPHANEDTRANSACTIONS | NOPURGEORPHANEDTRANSACTIONS} | TRANLOGOPTIONS TRANSCLEANUPFREQUENCY minutes | VAMMESSAGE 'Teradata_command' | VAMMESSAGE {'ARSTATS' | 'INCLUDELIST [filter]' | 'FILELIST [filter]'| 'EXCLUDELIST [filter]'} | VAMMESSAGE 'OPENTRANS' } -- To communicate with a running Extract processTeradata_command = {"control:terminate" | "control:suspend" | "control:resume" | "control:copy database.table"ggsci > send extract exthr statusggsci > send extract extr, getlagggsci > send extract group_name tltrace file file_name ddlincludeggsci > send extract fin, rolloverggsci > send extract fin stopggsci > send extract fin, vammessage control:suspendggsci > send extract fin, tranlogoptions transcleanupfrequency 15ggsci > send extract fin, showtransggsci > send extract fin, showtrans count 10ggsci > send extract fin, skiptrans 15.7.42734 thread 4SEND EXTRACT EXTORD, ROLLREPORT=========================================================================EXTTRAIL ADD, ALTER, DELETE, INFOggsci > INFO EXTTRAIL trail_name -- To retrieve configuration information for a local trailggsci > info exttrail *ggsci > info exttrail e:\ogg\dirdat\ex
ggsci > ADD EXTTRAIL trail_name, EXTRACT group_name [, MEGABYTES n] [, SEQNO n] -- To create a trail for online processing on local systemggsci > add exttrail /oracle/ogg/dirdat/lt, extract s_extrggsci > add exttrail C:\OGG\dirdat\et, extract emp_extggsci > add exttrail e:\ogg\dirdat\fi, extract fin, megabytes 50
ggsci > ALTER EXTTRAIL trail_name, EXTRACT group_name [, MEGABYTES n] -- To change the attributes of a trail (on the local system)ggsci > alter exttrail c:\ogg\dirdat\aa, extract fin, megabytes 30
ggsci > DELETE EXTTRAIL trail_name -- To delete the record of checkpoints associated with a trail on a local systemggsci > delete exttrail /home/ogg/dirdat/et=========================================================================JAGENT INFO, START, STATUS, STOPINFO JAGENT Returns information about the JAgent. INFO JAGENT
START JAGENT Starts the JAgent. START JAGENT
STATUS JAGENT Returns the state of the JAgent. STATUS JAGENT
STOP JAGENT Stops the JAgent.STOP JAGENTSTOP JAGENT !=========================================================================MANAGER INFO, SEND, START, STOP, STATUSggsci > INFO MANAGER -- To determine whether or not the Manager process is runningggsci > INFO MGRggsci > INFO MARKER [COUNT number_of_items] -- To review recently processed markers from a nonstop systemggsci > info markerggsci > info marker count 6
ggsci > EDIT PARAMS {MGR | ./GLOBALS | group_name | file_name} -- To create or change a parameter fileggsci > EDIT PARAMS DEFGENggsci > edit params ./GLOBALS GGSCHEMA ogg_own
CHECKPOINTTABLE ogg_own.checkpoint ALLOWOUTPUTDIR /u02/ogg_trails HEARTBEATTABLE table_name ENABLEMONITORING
ggsci > edit params mgr
ggsci > VIEW PARAMS {MGR | group_name | file_name} -- To view the contents of a parameter fileggsci > view params mgrggsci > view params s_extrggsci > view params e:\ogg_parameters\replp.prm
ggsci > START MANAGER -- To start Manager processggsci > start MGRggsci > start manager
ggsci > STOP MANAGER [!] -- To stop Manager processggsci > stop managerggsci > stop mgrggsci > stop manager ! -- will not ask for confirmation
ggsci > REFRESH MANAGER -- not available in Oracle 11gggsci > REFRESH MGR
ggsci > SEND MANAGER [CHILDSTATUS [DEBUG]] [GETPORTINFO [DETAIL]] [GETPURGEOLDEXTRACTS] -- To retrieve the status of the active Manager process or to retrieve dynamic port information as configured in the Manager parameter fileggsci > send manager childstatusggsci > send manager childstatus debugggsci > send manager getportinfoggsci > send manager getportinfo detailggsci > send manager getpurgeoldextracts
ggsci > STATUS MANAGER -- To determine whether or not the Manager process is runningggsci > status manager=========================================================================PARAMETERS EDIT, VIEW, SET EDITOR, INFO, GETPARAMINFOggsci > SET EDITOR program_name -- To change the default text editor for the current session of GGSCI, default editors are Notepad for Windows and vi for UNIXggsci > set editor wordpad=========================================================================REPLICAT ADD, ALTER, CLEANUP, DELETE, INFO, KILL, LAG, REGISTER, SEND, START, STATS, STATUS, STOP, SYNCHRONIZE, UNREGISTERggsci > INFO REPLICAT group_name [, SHOWCH [n]] [, DETAIL] [, TASKS | ALLPROCESSES] -- 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 emp_repggsci > info replicat emp_rep, detailggsci > info replicat prd*, detail, allprocessesggsci > info replicat *, tasksggsci > info replicat fin, showchinfo ra002 detail
INFO command will read the checkpoint file. LAG command get the lag time more precisely, because it directly communicates with ER to obtain the lag time. SEND command communicates directly with the process and gets the current/latest status of it.
ggsci > edit params e:\ogg\dirprm\replp.prm
ggsci > ADD REPLICAT group_name INTEGRATED | COORDINATED [MAXTHREADS number]] {, SPECIALRUN | , EXTFILE file_name | , EXTTRAIL trail_name} BEGIN {NOW | yyyy-mm-dd[ hh:mm[:ss[.cccccc]]]} | , EXTSEQNO sequence_number, EXTRBA rba]{PARALLEL | PARALLEL INTEGRATED EXTTRAIL trail_name , CHECKPOINTTABLE owner.table | NODBCHECKPOINT} PARAMS file_name] REPORT file_name] DESC 'description'] -- To create a Replicat groupggsci > add replicat repl, exttrail C:\OGG\dirdat\ltggsci > add replicat R3CT, exttrail /u01/ogg/dirdat/lt, checkpointtable ogg_own.checkpointggsci > add replicat initload, specialrunggsci > add replicat sales, exttrail /oracle/ogg/dirdat/lt, nodbcheckpointADD REPLICAT financer, INTEGRATED, EXTTRAIL c:\ggs\dirdat\rtggsci > add replicat sales, EXTTRAIL /ogg/dirdat/ex, FORMAT RELEASE 11.1ADD REPLICAT sales, COORDINATED MAXTHREADS 100, EXTTRAIL dirdat/rt ADD REPLICAT sales, PARALLEL INTEGRATED, EXTTRAIL dirdat/rt, checkpointtable ggadmin.checkpointADD REPLICAT R01AD INTEGRATED EXTTRAIL /ogg/trail/ra CHECKPOINTTABLE OGGOWN.CHKPTAB BEGIN 2018-10-31 20:04:25.293534ggsci > ALTER REPLICAT group_name[threadID], { ADD REPLICAT option ...] | INTEGRATED | NONINTEGRATED, CHECKPOINTTABLE owner.table } -- To change the attributes of a Replicat groupggsci > alter replicat fin, begin nowggsci > alter replicat rfin, begin 2018-08-08 08:08:08ggsci > alter replicat RA_AD, extseqno 3804ggsci > alter replicat RA_AD, extrba 766338576alter replicat RBBP01 extseqno 13, extrba 11995ALTER REPLICAT finance, INTEGRATED ALTER REPLICAT finance, NONINTEGRATED, CHECKPOINTTABLE ogg.checkpt
ggsci > CLEANUP REPLICAT group_name [, SAVE count] -- To delete run history for a specified Replicat groupggsci > cleanup replicat finggsci > cleanup replicat *, save 10
ggsci > DELETE REPLICAT group_name [!] -- To delete a Replicat groupggsci > delete replicat emp_extggsci > delete replicat emp_ext ! -- will not ask for confirmation
ggsci > KILL REPLICAT group_name -- To kill a Replicat processggsci > kill replicat fin
ggsci > LAG REPLICAT group_name [GLOBAL] -- To determine a true lag time between Replicat and the trailggsci > lag replicat myreplggsci > lag replicat *
ggsci > SEND REPLICAT group_name[threadID], { CACHEMGR {CACHESTATS | CACHEQUEUES | CACHEVMUSAGE} | DEPENDENCYINFO|DEPINFO [TXNCOUNT num] |FORCESTOP | GETLAG | GETPARAMINFO [parameter_name] [FILE output_file] | HANDLECOLLISIONS | NOHANDLECOLLISIONS [table_spec] | INTEGRATEDPARAMS(parameter_specification) | REPORT [HANDLECOLLISIONS [table_spec]] | RESUME | STATUS | STOP | TRACE[2] [DDLINCLUDE | DDL[ONLY]] file_name | TRACE[2] OFF | TRACE OFF file_name | TRACEINIT | THREADS (threadID threadID] ...] thread_range thread_range] ...]) } -- To communicate with a starting or running Replicat processggsci > send replicat fin, handlecollisionsggsci > send replicat fin, report handlecollisions fin_*ggsci > send replicat fin, getlagSEND REPLICAT finance, INTEGRATEDPARAMS (parallelism 10) SEND REPLICAT fin, TRACE THREADS(1) FILE ./dirrpt/trace.trc SEND REPLICAT R01IX TRACE FILE ./dirrpt/R01IX_trace.trc send Rep2 DEPENDENCYINFO TXNCOUNT 5send replicat R01IX status
ggsci > START REPLICAT group_name [SKIPTRANSACTION | ATCSN csn | AFTERCSN csn] [FILTERDUPTRANSACTIONS | NOFILTERDUPTRANSACTIONS] [THREADS (threadID threadID] ...] thread_range thread_range] ...]) -- To start Replicat processggsci > start *ggsci > start replicat RCTggsci > start replicat fin, atcsn 5238306 -- commit sequence number (CSN)ggsci > start replicat fin, aftercsn 0X000006B1:0002334D:0004ggsci > start replicat MYREP skiptransactionstart RAU8 NOFILTERDUPTRANSACTIONSSTART REPLICAT fin ATCSN 6488359 THREADS(1-3), AFTERCSN 6488360 THREADS(9-10), SKIPTRANSACTION THREADS(7,8)
ggsci > STOP REPLICAT replicat_name [!] -- To stop Replicat gracefullyggsci > stop replicat 2RCTggsci > stop replicat rep !
ggsci > STATUS REPLICAT group_name [, TASKS | ALLPROCESSES] -- To determine whether or not Replicat is runningggsci > status replicat emp_repggsci > status replicat cust_rep, tasksggsci > status replicat rep, allprocesses
ggsci > STATS REPLICAT group_name [statistic] [TABLE [container. | catalog.]schema.table] [TOTALSONLY [container. | catalog.]schema.table] [REPORTCDR] [REPORTCHARCONV] [REPORTDETAIL | NOREPORTDETAIL] REPORTRATE {HR | MIN | SEC}] ... ] -- To display statistics for one or more Replicat groupsggsci > stats rep_hrggsci > stats rep_name -totalSTATS REPLICAT r_trg REPORTDETAIL SECSTATS REPLICAT r_trg, TOTAL, DAILYstats replicat fin, total, table acct, reportrate hr, reset, noreportdetailSTATS REPLICAT group, REPORTCDRSTATS REPLICAT RA_TH table OWNER.USERS REPORTCDR hourly REPORTRATE MIN
ggsci > SYNCHRONIZE REPLICAT group_nameSYNCHRONIZE REPLICAT rep_fin
ggsci > UNREGISTER REPLICAT group_name DATABASE UNREGISTER REPLICAT sales DATABASE
ggsci > SET_INSTANTIATION_CSN csn FOR [schema.] table FROM source_database_name SET_INSTANTIATION_CSN 12345678 FOR hr.employees FROM DBS6
ggsci > CLEAR_INSTANTIATION_CSN FOR [schema.]table FROM source_database_nameCLEAR_INSTANTIATION_CSN FOR hr.employees FROM orcl=========================================================================RMTTRAIL ADD, ALTER, DELETE, INFOggsci > INFO RMTTRAIL trail_name -- To retrieve configuration information for a remote trailggsci > info rmttrail *ggsci > info rmttrail d:\ogg\dirdat\ex
ggsci > ADD RMTTRAIL trail_name, EXTRACT group_name [, MEGABYTES n] [, SEQNO n] -- To create a trail for online processing on remote systemggsci > add rmttrail C:\OGG\dirdat\hr, extract extrggsci > add rmttrail /u01/app/oracle/ogg/dirdat/ms, extract msextrggsci > add rmttrail /u02/app/ogg/dirdat/my, extract mysql, megabytes 50
ggsci > ALTER RMTTRAIL trail_name, EXTRACT group_name [, MEGABYTES n] -- To change the attributes of a trail (on a remote system)ggsci > alter rmttrail c:\ogg\dirdat\et, extract fin, megabytes 25
ggsci > DELETE RMTTRAIL trail_name -- To delete the record of checkpoints associated with a trail on a remote systemggsci > delete rmttrail /home/ogg/dirdat/et=========================================================================TRACETABLE ADD, DELETE, INFOggsci > INFO TRACETABLE [owner.table] -- To verify the existence of the specified trace tableggsci > info tracetableggsci > info tracetable ora_trace
ggsci > ADD TRACETABLE [owner.table] -- To create a trace table in the Oracle databaseggsci > add tracetableggsci > add tracetable ora_trace
ggsci > DELETE TRACETABLE [owner.table] -- To delete a trace tableggsci > delete tracetableggsci > delete tracetable ora_trace=========================================================================TRANDATA ADD, DELETE, INFOggsci > INFO TRANDATA user_name.table_names [, OLDFORMAT] [, USETRIGGER] -- To determine whether logging/replication enabled or notggsci > info trandata hr.*ggsci > info trandata fin.acctINFO TRANDATA finance.ac* NOVALIDATE
ggsci > ADD TRANDATA {[container.]owner.table | schema.table [JOURNAL library/journal] | library/file [JOURNAL library/journal]} [NOSCHEDULINGCOLS | ALLCOLS] [COLS (columns)] [INCLUDELONG | EXCLUDELONG] [LOBSNEVER | LOBSALWAYS | LOBSIFCHANGED | LOBSALWAYSNOINDEX] [NOKEY] [NOVALIDATE] [PREPARECSN {WAIT | LOCK | NOWAIT | NONE}] -- To enable Oracle GoldenGate to acquire the transaction information it needs from the transaction recordsggsci > add trandata hr.*ggsci > add trandata emp.employeesggsci > add trandata fin.acct, cols (name, address)ggsci > add trandata fin.acct, nokey, cols (name, pid)ggsci > add trandata fin.acct, lobsalwaysnoindexADD TRANDATA \u20AC1ggsci > ADD TRANDATA SCHEMA_NAME.TABLE_NAME ALLCOLS
ggsci > DELETE TRANDATA user_name.table_names [, OLDFORMAT] [, USETRIGGER] -- To delete logging/replication dataggsci > delete trandata fin.acctggsci > delete trandata fin.cust*ggsci > delete trandata emp.hr, usetrigger=========================================================================SCHEMATRANDATA ADD, DELETE, INFOggsci > ADD SCHEMATRANDATA schema { [ALLOWNONVALIDATEDKEYS] [NOSCHEDULINGCOLS | ALLCOLS]} [NOVALIDATE][PREPARECSN {WAIT | LOCK | NOWAIT | NONE}] ggsci > ADD SCHEMATRANDATA OWNER ALLCOLSggsci > ADD SCHEMATRANDATA scott
ggsci > INFO SCHEMATRANDATA schema_nameggsci > INFO SCHEMATRANDATA scott
ggsci > DELETE SCHEMATRANDATA schema_nameggsci > DELETE SCHEMATRANDATA scottggsci > DELETE SCHEMATRANDATA scott ALLCOLS=========================================================================CHECKPOINTTABLE ADD, DELETE, CLEANUP, INFO, UPGRADEggsci > INFO CHECKPOINTTABLE [user_name.table_name] -- To confirm the existence of a checkpoint table and view the date and time that it was createdggsci > info checkpointtableggsci > info checkpointtable ogg_own.chkpt_table
ggsci > ADD CHECKPOINTTABLE [user_name.table_name] -- To create a checkpoint table in the target databaseggsci > add checkpointtableggsci > add checkpointtable ogg_own.checkpoint
ggsci > CLEANUP CHECKPOINTTABLE [user_name.table_name] -- To remove checkpoint records from the checkpoint tableggsci > cleanup checkpointtable ggs.fin_check
ggsci > DELETE CHECKPOINTTABLE [user_name.table_name] [!] -- To drop a checkpoint table from the databaseggsci > delete checkpointtable ggs.fin_check
ggsci > UPGRADE CHECKPOINTTABLE [[container. | catalog.]owner.table] ggsci > UPGRADE CHECKPOINTTABLEggsci > UPGRADE CHECKPOINTTABLE ggs.fin_check
=========================================================================WALLET CREATE, OPEN, PURGEcreate wallet -- to encrypt the encryption keys that secure data over the network and in trail files and other Oracle GoldenGate files that store sensitive data.ggsci > create wallet
open wallet -- to open a master-key walletggsci > open wallet
purge wallet -- to permanently remove master key versions from the master-key wallet.ggsci > purge wallet=========================================================================MASTERKEY ADD, INFO, RENEW, DELETE, UNDELETEADD MASTERKEYadd masterkey ogg_mkadd masterkey renew
INFO MASTERKEY [VERSION version]INFO MASTERKEYINFO MASTERKEY VERSION 7info masterkey ogg_mk version 1
DELETE MASTERKEY {VERSION version | RANGE FROM begin_value TO end_value | ALL}DELETE MASTERKEY VERSION 10DELETE MASTERKEY RANGE FROM 3 TO 6
UNDELETE MASTERKEY VERSION versionUNDELETE MASTERKEY VERSION 3
renew masterkeyrenew masterkey ogg=========================================================================CREDENTIALSTORE ADD, ALTER, INFO, DELETEggsci > ADD CREDENTIALSTOREggsci > ADD CREDENTIALSTORE
ggsci > ALTER CREDENTIALSTORE delete user gg_rootALTER CREDENTIALSTORE { ADD USER userid | REPLACE USER userid | DELETE USER userid }[PASSWORD password][ALIAS alias][DOMAIN domain]ggsci > ALTER CREDENTIALSTORE ADD USER oggadmin password passwordggsci > ALTER CREDENTIALSTORE ADD USER oggadmin@link alias gg_rootALTER CREDENTIALSTORE ADD USER oggown PASSWORD oggown ALIAS gg_rootALTER CREDENTIALSTORE ADD USER ggadmin PASSWORD oracle ALIAS gg_root DOMAIN ggggsci > ALTER CREDENTIALSTORE REPLACE USER oggadmin password passwordALTER CREDENTIALSTORE REPLACE USER oggown@testdb PASSWORD oggown ALIAS gg_rootggsci > ALTER CREDENTIALSTORE delete user gg_root
ggsci > INFO CREDENTIALSTORE [DOMAIN domain-name]INFO CREDENTIALSTORE DOMAIN support
ggsci > DELETE CREDENTIALSTOREggsci > DELETE CREDENTIALSTORE=========================================================================HEARTBEATTABLE ADD, DELETE, ALTER, INFO
ADD HEARTBEATTABLE [, FREQUENCY number in seconds] [, RETENTION_TIME number in days] | [, PURGE_FREQUENCY number in days] [, PARTITIONED] [, NOADDTRANDATA ] [, TARGETONLY] ggsci > ADD HEARTBEATTABLE # from OGG 12.2.0ggsci > add heartbeattable, frequency 5ADD HEARTBEATTABLE, partitioned
ALTER HEARTBEATTABLE [FREQUENCY number in seconds] [RETENTION_TIME number in days] | [PURGE_FREQUENCY number in days] [TARGETONLY | NOTARGETONLY]ggsci > ALTER HEARTBEATTABLEALTER HEARTBEATTABLE FREQUENCY 60ALTER HEARTBEATTABLE RETENTION_TIME 30ALTER HEARTBEATTABLE PURGE_FREQUENCY 1
ggsci > INFO heartbeattableggsci > INFO heartbeattable
DELETE HEARTBEATTABLE group_nameggsci > DELETE HEARTBEATTABLE=========================================================================HEARTBEATENTRY DELETEggsci > DELETE HEARTBEATENTRY group_name Deletes entries in the heartbeat table.DELETE HEARTBEATENTRY =========================================================================
Commands without an object:(Database) DBLOGIN, LIST TABLES, ENCRYPT PASSWORD, FLUSH SEQUENCE, MININGDBLOGIN, SET NAMECCSID
ggsci > DBLOGIN {SOURCEDB|TARGETDB dsn | USERID user_name[, PASSWORD password] [SYSDBA] | SOURCEDB|TARGETDB dsn, USERID user_name[, PASSWORD password] [SYSDBA] [SQLID sqlid] -- To establish a database connectionggsci > dblogin sourcedb testdbggsci > dblogin targetdb repldbggsci > dblogin userid ggggsci > dblogin userid gg, password oracleggsci > dblogin userid system@localhost:1521/prod, password 12345678ggsci > dblogin sourcedb ctdb@host1, userid ogg_own, password ggs sysdbaggsci > dblogin USERIDALIAS gg_login
ggsci > ENCRYPT PASSWORD password [AES128 | AES192 | AES256 | BLOWFISH] ENCRYPTKEY {key_name | DEFAULT} -- To encrypt a database login passwordggsci > encrypt password oracle143 encryptkey spidermanENCRYPT PASSWORD oracle123 BLOWFISH ENCRYPTKEY DEFAULT ENCRYPT PASSWORD oracle890 AES192 ENCRYPTKEY superkey2
FLUSH SEQUENCE owner.sequenceFLUSH SEQUENCE scott.seq*
ggsci > LIST TABLES table_name -- To list all tables in the database that match the specificationggsci > list tables cust*
MININGDBLOGIN { USERID {/ | userid} PASSWORD password] [algorithm ENCRYPTKEY {keyname | DEFAULT}] | USERIDALIAS alias [DOMAIN domain] | [SYSDBA] } MININGDBLOGIN USERIDALIAS oggalias SESSIONCHARSET ISO-8859-11 MININGDBLOGIN USERID ogg@ora1.ora, PASSWORD AACAAAAAAAAAAAJAUEUGODSCVGJEEIUGKJDJTFNDKEJFFFTC AES128, ENCRYPTKEY securekey1
SET NAMECCSID {CCSID | DEFAULT}SET NAMECCSID 1141=========================================================================(DDL) DUMPDDL
ggsci > DUMPDDL [SHOW] -- To view the data in the Oracle GoldenGate DDL history tableggsci > dumpddl=========================================================================
(Miscellaneous) !, ALLOWNESTED | NOALLOWNESTED, CREATE SUBDIRS, DEFAULTJOURNAL, FC, HELP, HISTORY, INFO ALL, OBEY, SHELL, SHOW, VERSIONS, VIEW GGSEVT, VIEW REPORT
ggsci > SHOW -- To display the Oracle GoldenGate (OGG) environmentggsci > SHOW ALL
ggsci > INFO ALL [TASKS | ALLPROCESSES] -- To display the status of all Manager, Extract, Datapump and Replicat processesggsci > info allProgram Status Group Lag Time Since ChkptMANAGER RUNNING
EXTRACT STOPPED EXTR 00:01:15 00:00:07
REPLICAT ABENDED REP 00:00:00 00:00:04ggsci > info all tasksggsci > info all allprocesses
ggsci > VIEW GGSEVT -- To view GoldenGate error log (ggserr.log file)
ggsci > VIEW REPORT {group_name[n] | file_name|mgr} -- To view the process report that is generated by Extract or Replicatggsci > view report ext6ggsci > view report repggsci > view report mgr ggsci > view report c:\ogg\dirrpt\orders.rpt
ggsci > HISTORY [n] -- To view the most recently issued GGSCI commands since the session startedggsci > history -- by default, shows last 10 commandsggsci > history 30
pause sleep_intervalpause 900
ggsci > VERSIONS -- To display operating system and database version informationggsci > versions
Operating System:
Linux
Version #1 SMP Mon Mar 29 20:19:03 EDT 2013, Release 2.6.18-194.el5PAE
Node: linux03.calldba.com
Machine: x86_64Database:
Oracle Database 11g Enterprise Edition Release 11.2.0.3.0 – Production
PL/SQL Release 11.2.0.3.0 – Production
CORE 11.2.0.3.0 Production
TNS for Linux: Version 11.2.0.3.0 – Production
NLSRTL Version 11.2.0.3.0 – Production
ggsci > FC [n | -n | string] -- To display edit a previously issued GGSCI command and then execute it againggsci > fcggsci > fc 9ggsci > fc -3ggsci > fc staFC editor commandsi text -- Inserts textr text -- Replaces textd -- Deletes a characterreplacement_text -- Replaces the displayed command with the text that we enter on a one-for-one basis.
ggsci > SHELL shell_command -- To execute shell commands from within GGSCI interfaceggsci > shell ls -l /u01/app/oracle/ogg/dirdatggsci > sh dir dirprm\*ggsci > shell rm ./dat*GGSCI > shell pmap -x replicate_process_id
ggsci > ! [n | -n | string] -- To execute previous GGSCI commandggsci > !ggsci > ! 6 -- To run the command 6 listed in the historyggsci > ! -3ggsci > ! staggsci > help ! command
ggsci > OBEY ggsci_script -- To process a file that contains a list of Golden Gate commands.ggsci > shell more /u01/app/oracle/ogg/startup.txtSTART MANAGER
START EXTRACT EXT3
START EXTRACT DPUMP
INFO ALLggsci > obey /u01/app/oracle/ogg/startup.txtggsci > obey ./mycommands.txt
INFO PARAM nameINFO PARAM RMTHOSTINFO PARAM RETRYDELAY
ALLOWNESTEDNOALLOWNESTED
DEFAULTJOURNAL [library/journal] [CLEAR]
ggsci > EXIT
New Commands in OGG 12c R3 (Oracle GoldenGate 12c (12.3.0.1))
=========================================================================
PMSRVR - Performance Metrics Server process
INFO PMSRVR Returns information about the PMSRVR.
INFO PMSRVR
START PMSRVR Starts the PMSRVR.
START PMSRVR
STATUS PMSRVR Returns the state of the PMSRVR.
STATUS PMSRVR
STOP PMSRVR Stops the PMSRVR.
STOP PMSRVR
STOP PMSRVR !
START PMSRVR Starts the PMSRVR.
=========================================================================
ADD PROCEDURETRANDATA Adding supplemental logging for Procedural Replication.
ADD PROCEDURETRANDATA
DELETE PROCEDURETRANDATA Remove supplemental logging for Procedural Replication.
DELETE PROCEDURETRANDATA
INFO PROCEDURETRANDATA Display display supplemental logging information about Procedural Replication.
INFO PROCEDURETRANDATA
=========================================================================