1/413

Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Oracle GoldenGate GGSCI Commands

• 1.1 Summary of Oracle GoldenGate Commands
  • 1.1.1 Summary of Manager Commands
  • 1.1.2 Summary of Extract Commands
  • 1.1.3 Summary of Replicat Commands
  • 1.1.4 Summary of the ER Command
  • 1.1.5 Summary of Wallet Commands
  • 1.1.6 Summary of Credential Store Commands
  • 1.1.7 Summary of Trail Commands
  • 1.1.8 Summary of Parameter Commands
  • 1.1.9 Summary of Database Commands
  • 1.1.10 Summary of Trandata Commands
  • 1.1.11 Summary of Checkpoint Table Commands
  • 1.1.12 Summary of Oracle Trace Table Commands
  • 1.1.13 Summary of Oracle GoldenGate Data Store Commands
  • 1.1.14 Summary of Oracle GoldenGate Monitor JAgent Commands
  • 1.1.15 Summary of Miscellaneous Oracle GoldenGate Commands
• INFO MANAGER
• SEND MANAGER
• START MANAGER
• STATUS MANAGER
• STOP MANAGER
• ADD EXTRACT
• ALTER EXTRACT
• CLEANUP EXTRACT
• DELETE EXTRACT
• INFO EXTRACT
• KILL EXTRACT
• LAG EXTRACT
• REGISTER EXTRACT
• SEND EXTRACT
• START EXTRACT
• STATS EXTRACT
• STATUS EXTRACT
• STOP EXTRACT
• UNREGISTER EXTRACT
• ADD REPLICAT
• ALTER REPLICAT
• CLEANUP REPLICAT
• DELETE REPLICAT
• INFO REPLICAT
• KILL REPLICAT
• LAG REPLICAT
• REGISTER REPLICAT
• SEND REPLICAT
• START REPLICAT
• STATS REPLICAT
• STATUS REPLICAT
• STOP REPLICAT
• SYNCHRONIZE REPLICAT
• UNREGISTER REPLICAT
• ER
• CREATE WALLET
• OPEN WALLET
• PURGE WALLET
• ADD MASTERKEY
• INFO MASTERKEY
• RENEW MASTERKEY
• DELETE MASTERKEY
• UNDELETE MASTERKEY
• ADD CREDENTIALSTORE
• ALTER CREDENTIALSTORE
• INFO CREDENTIALSTORE
• DELETE CREDENTIALSTORE
• ADD EXTTRAIL
• ADD RMTTRAIL
• ALTER EXTTRAIL
• ALTER RMTTRAIL
• DELETE EXTTRAIL
• DELETE RMTTRAIL
• INFO EXTTRAIL
• INFO RMTTRAIL
• EDIT PARAMS
• SET EDITOR
• VIEW PARAMS
• DBLOGIN
• ENCRYPT PASSWORD
• DUMPDDL
• FLUSH SEQUENCE
• LIST TABLES
• MININGDBLOGIN
• SET NAMECCSID
• ADD SCHEMATRANDATA
• ADD TRANDATA
• DELETE SCHEMATRANDATA
• DELETE TRANDATA
• INFO SCHEMATRANDATA
• INFO TRANDATA
• ADD CHECKPOINTTABLE
• CLEANUP CHECKPOINTTABLE
• DELETE CHECKPOINTTABLE
• INFO CHECKPOINTTABLE
• UPGRADE CHECKPOINTTABLE
• ADD TRACETABLE
• DELETE TRACETABLE
• INFO TRACETABLE
• ALTER DATASTORE
• CREATE DATASTORE
• DELETE DATASTORE
• INFO DATASTORE
• REPAIR DATASTORE
• INFO JAGENT
• START JAGENT
• STATUS JAGENT
• STOP JAGENT
• !
• ALLOWNESTED | NOALLOWNESTED
• CREATE SUBDIRS
• DEFAULTJOURNAL
• FC
• HELP
• HISTORY
• INFO ALL
• INFO MARKER
• OBEY
• SHELL
• SHOW
• VERSIONS
• VIEW GGSEVT
• VIEW REPORT

2 Oracle GoldenGate Native Commands

• 2.1 Summary of Oracle GoldenGate Native Commands
• defgen
• extract
• ggsci
• keygen
• logdump
• mgr
• replicat

3 Oracle GoldenGate Parameters

• 3.1 Summary of Oracle GoldenGate Parameters
  • 3.1.1 Summary of GLOBALS Parameters
  • 3.1.2 Summary of Manager Parameters
  • 3.1.3 Summary of Parameters Common to Extract and Replicat
  • 3.1.4 Summary of Extract Parameters
  • 3.1.5 Summary of Replicat Parameters
  • 3.1.6 Summary of Wildcard Exclusion Parameters
  • 3.1.7 Summary of DEFGEN Parameters
  • 3.1.8 Summary of DDL Parameters
• ALLOCFILES
• ALLOWDUPTARGETMAP | NOALLOWDUPTARGETMAP
• ALLOWINVISIBLEINDEXKEYS
• ALLOWNONVALIDATEDKEYS
• ALLOWNOOPUPDATES | NOALLOWNOOPUPDATES
• APPLYNOOPUPDATES | NOAPPLYNOOPUPDATES
• ASCIITOEBCDIC
• ASSUMETARGETDEFS
• AUTORESTART
• AUTOSTART
• BATCHSQL
• BEGIN
• BLOBMEMORY
• BOOTDELAYMINUTES
• BR
• BULKLOAD
• CACHEMGR
• CATALOGEXCLUDE
• CHARMAP
• CHARSET
• CHECKMINUTES
• CHECKPARAMS
• CHECKPOINTSECS
• CHECKPOINTTABLE
• CMDTRACE
• COLMATCH
• COMMENT | --
• COMPRESSDELETES | NOCOMPRESSDELETES
• COMPRESSUPDATES | NOCOMPRESSUPDATES
• COORDSTATINTERVAL
• COORDTIMER
• CREDENTIALSTORELOCATION
• CUSEREXIT
• DBOPTIONS
• DDL
• DDLERROR
• DDLOPTIONS
• DDLSUBST
• DDLRULEHINT
• DDLTABLE
• DECRYPTTRAIL
• DEFERAPPLYINTERVAL
• DEFSFILE
• DISCARDFILE | NODISCARDFILE
• DISCARDROLLOVER
• DOWNCRITICAL
• DOWNREPORT
• DSOPTIONS
• DYNAMICPORTLIST
• DYNAMICRESOLUTION | NODYNAMICRESOLUTION
• EBCDICTOASCII
• ENABLECATALOGNAMES
• ENABLEMONITORING
• ENCRYPTTRAIL | NOENCRYPTTRAIL
• END
• EOFDELAY | EOFDELAYCSECS
• EXCLUDETAG
• EXCLUDEWILDCARDOBJECTSONLY
• EXTFILE
• EXTRACT
• EXTTRAIL
• FETCHOPTIONS
• FILTERDUPS | NOFILTERDUPS
• FLUSHSECS | FLUSHCSECS
• FORMATASCII
• FORMATSQL
• FORMATXML
• FUNCTIONSTACKSIZE
• GENLOADFILES
• GETAPPLOPS | IGNOREAPPLOPS
• GETDELETES | IGNOREDELETES
• GETENV
• GETINSERTS | IGNOREINSERTS
• GETREPLICATES | IGNOREREPLICATES
• GETTRUNCATES | IGNORETRUNCATES
• GETUPDATEAFTERS | IGNOREUPDATEAFTERS
• GETUPDATEBEFORES | IGNOREUPDATEBEFORES
• GETUPDATES | IGNOREUPDATES
• GGSCHEMA
• GROUPTRANSOPS
• HANDLECOLLISIONS | NOHANDLECOLLISIONS
• HANDLETPKUPDATE
• HAVEUDTWITHNCHAR
• INCLUDE
• INSERTALLRECORDS
• INSERTAPPEND | NOINSERTAPPEND
• INSERTDELETES | NOINSERTDELETES
• INSERTMISSINGUPDATES | NOINSERTMISSINGUPDATES
• INSERTUPDATES | NOINSERTUPDATES
• LAGCRITICAL
• LAGINFO
• LAGREPORT
• LIST | NOLIST
• LOBMEMORY
• LOGALLSUPCOLS | NOLOGALLSUPCOLS
• MACRO
• MACROCHAR
• MAP for Extract
• MAP
• MAPEXCLUDE
• MARKERTABLE
• MAXDISCARDRECS
• MAXGROUPS
• MAXSQLSTATEMENTS
• MAXTRANSOPS
• MGRSERVNAME
• NAMECCSID
• NAMEMATCH parameters
• NOCATALOG
• NOHEADERS
• NODUPMSGSUPPRESSION
• NUMFILES
• OBEY
• OUTPUTFILEUMASK
• OVERRIDEDUPS | NOOVERRIDEDUPS
• PASSTHRU | NOPASSTHRU
• PASSTHRUMESSAGES | NOPASSTHRUMESSAGES
• PORT
• PRESERVETARGETTIMEZONE
• PURGEDDLHISTORY | PURGEDDLHISTORYALT
• PURGEMARKERHISTORY
• PURGEOLDEXTRACTS for Extract and Replicat
• PURGEOLDEXTRACTS for Manager
• PURGEOLDTASKS
• RECOVERYOPTIONS
• REPERROR
• REPFETCHEDCOLOPTIONS
• REPLACEBADCHAR
• REPLACEBADNUM
• REPLICAT
• REPORT
• REPORTCOUNT
• REPORTROLLOVER
• RESTARTCOLLISIONS | NORESTARTCOLLISIONS
• RMTFILE
• RMTHOST
• RMTHOSTOPTIONS
• RMTTASK
• RMTTRAIL
• ROLLOVER
• SCHEMAEXCLUDE
• SEQUENCE
• SESSIONCHARSET
• SETENV
• SHOWSYNTAX
• SOCKSPROXY
• SOURCECATALOG
• SOURCECHARSET
• SOURCEDB
• SOURCEDEFS
• SOURCEISTABLE
• SOURCETIMEZONE
• SPACESTONULL | NOSPACESTONULL
• SPECIALRUN
• SQLDUPERR
• SQLEXEC
• STARTUPVALIDATIONDELAY[CSECS]
• STATOPTIONS
• SYSLOG
• TABLE | MAP
• TABLE for DEFGEN
• TABLE for Replicat
• TABLEEXCLUDE
• TARGETDB
• TARGETDEFS
• TCPSOURCETIMER | NOTCPSOURCETIMER
• THREADOPTIONS
• TRACE | TRACE2
• TRACETABLE | NOTRACETABLE
• TRAILBYTEORDER
• TRAILCHARSET
• TRAILCHARSETASCII
• TRAILCHARSETEBCDIC
• TRANLOGOPTIONS
• TRANSACTIONTIMEOUT
• TRANSMEMORY
• TRIMSPACES | NOTRIMSPACES
• TRIMVARSPACES | NOTRIMVARSPACES
• UPDATEDELETES | NOUPDATEDELETES
• UPDATEINSERTS | NOUPDATEINSERTS
• UPDATERECORDFORMAT
• UPREPORT
• USEANSISQLQUOTES | NOUSEANSISQLQUOTES
• USEDEDICATEDCOORDINATIONTHREAD
• USEIPV4
• USEIPV6
• USERID
• USERIDALIAS
• VAM
• VARWIDTHNCHAR | NOVARWIDTHNCHAR
• WALLETLOCATION
• WARNLONGTRANS
• WARNRATE
• WILDCARDRESOLVE
• Y2KCENTURYADJUSTMENT | NOY2KCENTURYADJUSTMENT

4 Collector Parameters

• 4.1 Overview of the Collector Process
• 4.2 Summary of Collector Parameters
• -b
• -cp
• -d
• -E
• -e
• -ENCRYPT
• -f
• -g
• -h
• -k
• -KEYNAME
• -l
• -m
• -P
• -p
• -R
• -x

5 Column Conversion Functions

• 5.1 Summary of Column-Conversion Functions
• AFTER
• BEFORE
• BEFOREAFTER
• BINARY
• BINTOHEX
• CASE
• COLSTAT
• COLTEST
• COMPUTE
• DATE
• DATEDIFF
• DATENOW
• DDL
• EVAL
• GETENV
• GETVAL
• HEXTOBIN
• HIGHVAL | LOWVAL
• IF
• NUMBIN
• NUMSTR
• RANGE
• STRCAT
• STRCMP
• STREQ
• STREXT
• STRFIND
• STRLEN
• STRLTRIM
• STRNCAT
• STRNCMP
• STRNUM
• STRRTRIM
• STRSUB
• STRTRIM
• STRUP
• TOKEN
• VALONEOF

6 User Exit Functions

• 6.1 Calling a User Exit
• 6.2 Summary of User Exit Functions
• 6.3 Using EXIT_CALL_TYPE
• 6.4 Using EXIT_CALL_RESULT
• 6.5 Using EXIT_PARAMS
• 6.6 Using ERCALLBACK
• 6.7 Function Codes
• COMPRESS_RECORD
• DECOMPRESS_RECORD
• GET_BASE_OBJECT_NAME
• GET_BASE_OBJECT_NAME_ONLY
• GET_BASE_SCHEMA_NAME_ONLY
• GET_BEFORE_AFTER_IND
• GET_CATALOG_NAME_ONLY
• GET_COL_METADATA_FROM_INDEX
• GET_COL_METADATA_FROM_NAME
• GET_COLUMN_INDEX_FROM_NAME
• GET_COLUMN_NAME_FROM_INDEX
• GET_COLUMN_VALUE_FROM_INDEX
• GET_COLUMN_VALUE_FROM_NAME
• GET_DATABASE_METADATA
• GET_DDL_RECORD_PROPERTIES
• GET_ENV_VALUE
• GET_ERROR_INFO
• GET_GMT_TIMESTAMP
• GET_MARKER_INFO
• GET_OBJECT_NAME
• GET_OBJECT_NAME_ONLY
• GET_OPERATION_TYPE
• GET_POSITION
• GET_RECORD_BUFFER
• GET_RECORD_LENGTH
• GET_RECORD_TYPE
• GET_SCHEMA_NAME_ONLY
• GET_SESSION_CHARSET
• GET_STATISTICS
• GET_TABLE_COLUMN_COUNT
• GET_TABLE_METADATA
• GET_TABLE_NAME
• GET_TABLE_NAME_ONLY
• GET_TIMESTAMP
• GET_TRANSACTION_IND
• GET_USER_TOKEN_VALUE
• OUTPUT_MESSAGE_TO_REPORT
• RESET_USEREXIT_STATS
• SET_COLUMN_VALUE_BY_INDEX
• SET_COLUMN_VALUE_BY_NAME
• SET_OPERATION_TYPE
• SET_RECORD_BUFFER
• SET_SESSION_CHARSET
• SET_TABLE_NAME