Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Information
• 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 Oracle GoldenGate Automatic Heartbeat Commands
  • 1.1.16 Summary of Miscellaneous Oracle GoldenGate Commands
• 1.2 INFO MANAGER
• 1.3 SEND MANAGER
• 1.4 START MANAGER
• 1.5 STATUS MANAGER
• 1.6 STOP MANAGER
• 1.7 ADD EXTRACT
• 1.8 ALTER EXTRACT
• 1.9 CLEANUP EXTRACT
• 1.10 DELETE EXTRACT
• 1.11 INFO EXTRACT
• 1.12 KILL EXTRACT
• 1.13 LAG EXTRACT
• 1.14 REGISTER EXTRACT
• 1.15 SEND EXTRACT
• 1.16 START EXTRACT
• 1.17 STATS EXTRACT
• 1.18 STATUS EXTRACT
• 1.19 STOP EXTRACT
• 1.20 UNREGISTER EXTRACT
• 1.21 ADD REPLICAT
• 1.22 ALTER REPLICAT
• 1.23 CLEANUP REPLICAT
• 1.24 DELETE REPLICAT
• 1.25 INFO REPLICAT
• 1.26 KILL REPLICAT
• 1.27 LAG REPLICAT
• 1.28 REGISTER REPLICAT
• 1.29 SEND REPLICAT
• 1.30 START REPLICAT
• 1.31 STATS REPLICAT
• 1.32 STATUS REPLICAT
• 1.33 STOP REPLICAT
• 1.34 SYNCHRONIZE REPLICAT
• 1.35 UNREGISTER REPLICAT
• 1.36 ER
• 1.37 CREATE WALLET
• 1.38 OPEN WALLET
• 1.39 PURGE WALLET
• 1.40 ADD MASTERKEY
• 1.41 INFO MASTERKEY
• 1.42 RENEW MASTERKEY
• 1.43 DELETE MASTERKEY
• 1.44 UNDELETE MASTERKEY
• 1.45 ADD CREDENTIALSTORE
• 1.46 ALTER CREDENTIALSTORE
• 1.47 INFO CREDENTIALSTORE
• 1.48 DELETE CREDENTIALSTORE
• 1.49 ADD EXTTRAIL
• 1.50 ADD RMTTRAIL
• 1.51 ALTER EXTTRAIL
• 1.52 ALTER RMTTRAIL
• 1.53 DELETE EXTTRAIL
• 1.54 DELETE RMTTRAIL
• 1.55 INFO EXTTRAIL
• 1.56 INFO RMTTRAIL
• 1.57 VIEW PARAMS
• 1.58 EDIT PARAMS
• 1.59 SET EDITOR
• 1.60 INFO PARAM
• 1.61 GETPARAMINFO
• 1.62 DBLOGIN
• 1.63 ENCRYPT PASSWORD
• 1.64 DUMPDDL
• 1.65 FLUSH SEQUENCE
• 1.66 LIST TABLES
• 1.67 MININGDBLOGIN
• 1.68 SET NAMECCSID
• 1.69 ADD SCHEMATRANDATA
• 1.70 ADD TRANDATA
• 1.71 DELETE SCHEMATRANDATA
• 1.72 DELETE TRANDATA
• 1.73 INFO SCHEMATRANDATA
• 1.74 INFO TRANDATA
• 1.75 SET_INSTANTIATION_CSN
• 1.76 CLEAR_INSTANTIATION_CSN
• 1.77 CLEANUP CHECKPOINTTABLE
• 1.78 DELETE CHECKPOINTTABLE
• 1.79 INFO CHECKPOINTTABLE
• 1.80 UPGRADE CHECKPOINTTABLE
• 1.81 ADD TRACETABLE
• 1.82 DELETE TRACETABLE
• 1.83 INFO TRACETABLE
• 1.84 ALTER DATASTORE
• 1.85 CREATE DATASTORE
• 1.86 DELETE DATASTORE
• 1.87 INFO DATASTORE
• 1.88 REPAIR DATASTORE
• 1.89 INFO JAGENT
• 1.90 START JAGENT
• 1.91 STATUS JAGENT
• 1.92 STOP JAGENT
• 1.93 ADD HEARTBEATTABLE
• 1.94 ALTER HEARTBEATTABLE
• 1.95 DELETE HEARTBEATTABLE
• 1.96 DELETE HEARTBEATENTRY
• 1.97 INFO HEARTBEATTABLE
• 1.98 !
• 1.99 ALLOWNESTED | NOALLOWNESTED
• 1.100 CREATE SUBDIRS
• 1.101 DEFAULTJOURNAL
• 1.102 FC
• 1.103 HELP
• 1.104 HISTORY
• 1.105 INFO ALL
• 1.106 INFO MARKER
• 1.107 OBEY
• 1.108 SHELL
• 1.109 SHOW
• 1.110 VERSIONS
• 1.111 VIEW GGSEVT
• 1.112 VIEW REPORT
• 1.113 ADD CHECKPOINTTABLE

2 Oracle GoldenGate Native Commands

• 2.1 Summary of Oracle GoldenGate IBM i Native Commands
• 2.2 checkprm
• 2.3 convchk
• 2.4 defgen
• 2.5 extract
• 2.6 ggsci
• 2.7 keygen
• 2.8 logdump
• 2.9 mgr
• 2.10 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
  • 3.1.9 Summary of Oracle GoldenGate Data Store Commands
• 3.2 ABORTDISCARDRECS
• 3.3 ACCESSRULE
• 3.4 ALLOCFILES
• 3.5 ALLOWDUPTARGETMAP | NOALLOWDUPTARGETMAP
• 3.6 ALLOWINVISIBLEINDEXKEYS
• 3.7 ALLOWNONVALIDATEDKEYS
• 3.8 ALLOWNOOPUPDATES | NOALLOWNOOPUPDATES
• 3.9 ALLOWOUTPUTDIR
• 3.10 APPLYNOOPUPDATES | NOAPPLYNOOPUPDATES
• 3.11 ASCIITOEBCDIC
• 3.12 ASSUMETARGETDEFS
• 3.13 AUTORESTART
• 3.14 AUTOSTART
• 3.15 BATCHSQL
• 3.16 BEGIN
• 3.17 BLOBMEMORY
• 3.18 BOOTDELAYMINUTES
• 3.19 BR
• 3.20 BULKLOAD
• 3.21 CACHEMGR
• 3.22 CATALOGEXCLUDE
• 3.23 CHARMAP
• 3.24 CHARSET
• 3.25 CHECKMINUTES
• 3.26 CHECKPARAMS
• 3.27 CHECKPOINTSECS
• 3.28 CHECKPOINTTABLE
• 3.29 CMDTRACE
• 3.30 COLCHARSET
• 3.31 COLMATCH
• 3.32 COMMENT | --
• 3.33 COMPRESSDELETES | NOCOMPRESSDELETES
• 3.34 COMPRESSUPDATES | NOCOMPRESSUPDATES
• 3.35 COORDSTATINTERVAL
• 3.36 COORDTIMER
• 3.37 CREDENTIALSTORELOCATION
• 3.38 CRYPTOENGINE
• 3.39 CUSEREXIT
• 3.40 DBOPTIONS
• 3.41 DDL
• 3.42 DDLERROR
• 3.43 DDLOPTIONS
• 3.44 DDLSUBST
• 3.45 DDLRULEHINT
• 3.46 DDLTABLE
• 3.47 DECRYPTTRAIL
• 3.48 DEFERAPPLYINTERVAL
• 3.49 DEFSFILE
• 3.50 DISCARDFILE | NODISCARDFILE
• 3.51 DISCARDROLLOVER
• 3.52 DOWNREPORT
• 3.53 DSOPTIONS
• 3.54 DYNAMICPORTLIST
• 3.55 DYNAMICRESOLUTION | NODYNAMICRESOLUTION
• 3.56 EBCDICTOASCII
• 3.57 ENABLECATALOGNAMES
• 3.58 ENABLEMONITORING
• 3.59 ENABLE_HEARTBEAT_TABLE | DISABLE_HEARTBEAT_TABLE
• 3.60 ENCRYPTTRAIL | NOENCRYPTTRAIL
• 3.61 END
• 3.62 EOFDELAY | EOFDELAYCSECS
• 3.63 EXCLUDEHIDDENCOLUMNS
• 3.64 EXCLUDETAG
• 3.65 EXCLUDEWILDCARDOBJECTSONLY
• 3.66 EXTFILE
• 3.67 EXTRACT
• 3.68 EXTTRAIL
• 3.69 FETCHOPTIONS
• 3.70 FETCHUSERID
• 3.71 FETCHUSERIDALIAS
• 3.72 FILTERDUPS | NOFILTERDUPS
• 3.73 FLUSHSECS | FLUSHCSECS
• 3.74 FORMATASCII
• 3.75 FORMATSQL
• 3.76 FORMATXML
• 3.77 FUNCTIONSTACKSIZE
• 3.78 GENLOADFILES
• 3.79 GETAPPLOPS | IGNOREAPPLOPS
• 3.80 GETDELETES | IGNOREDELETES
• 3.81 GETENV
• 3.82 GETINSERTS | IGNOREINSERTS
• 3.83 GETREPLICATES | IGNOREREPLICATES
• 3.84 GETTRUNCATES | IGNORETRUNCATES
• 3.85 GETUPDATEAFTERS | IGNOREUPDATEAFTERS
• 3.86 GETUPDATEBEFORES | IGNOREUPDATEBEFORES
• 3.87 GETUPDATES | IGNOREUPDATES
• 3.88 GGSCHEMA
• 3.89 GROUPTRANSOPS
• 3.90 HANDLECOLLISIONS | NOHANDLECOLLISIONS
• 3.91 HANDLETPKUPDATE
• 3.92 HAVEUDTWITHNCHAR
• 3.93 HEARTBEATTABLE
• 3.94 INCLUDE
• 3.95 INSERTALLRECORDS
• 3.96 INSERTAPPEND | NOINSERTAPPEND
• 3.97 INSERTDELETES | NOINSERTDELETES
• 3.98 INSERTMISSINGUPDATES | NOINSERTMISSINGUPDATES
• 3.99 INSERTUPDATES | NOINSERTUPDATES
• 3.100 LAGCRITICAL
• 3.101 LAGINFO
• 3.102 LAGREPORT
• 3.103 LIST | NOLIST
• 3.104 LOBMEMORY
• 3.105 LOGALLSUPCOLS
• 3.106 MACRO
• 3.107 MACROCHAR
• 3.108 MAP for Extract
• 3.109 MAP
• 3.110 MAPEXCLUDE
• 3.111 MAPINVISIBLECOLUMNS | NOMAPINVISIBLECOLUMNS
• 3.112 MARKERTABLE
• 3.113 MAXDISCARDRECS
• 3.114 MAXGROUPS
• 3.115 MAXSQLSTATEMENTS
• 3.116 MAXTRANSOPS
• 3.117 MGRSERVNAME
• 3.118 MONITORING_HEARTBEAT_TIMEOUT
• 3.119 NAMECCSID
• 3.120 NAMEMATCH parameters
• 3.121 NOCATALOG
• 3.122 NODUPMSGSUPPRESSION
• 3.123 NUMFILES
• 3.124 OBEY
• 3.125 OUTPUTFILEUMASK
• 3.126 OVERRIDEDUPS | NOOVERRIDEDUPS
• 3.127 PTKCAPTUREPROCSTATS
• 3.128 PTKMONITORFREQUENCY
• 3.129 PORT
• 3.130 PRESERVETARGETTIMEZONE
• 3.131 PROCEDURE
• 3.132 PURGEDDLHISTORY | PURGEDDLHISTORYALT
• 3.133 PURGEMARKERHISTORY
• 3.134 PURGEOLDEXTRACTS for Extract and Replicat
• 3.135 PURGEOLDEXTRACTS for Manager
• 3.136 PURGEOLDTASKS
• 3.137 RECOVERYOPTIONS
• 3.138 REPERROR
• 3.139 REPFETCHEDCOLOPTIONS
• 3.140 REPLACEBADCHAR
• 3.141 REPLACEBADNUM
• 3.142 REPLICAT
• 3.143 REPORT
• 3.144 REPORTCOUNT
• 3.145 REPORTROLLOVER
• 3.146 RESTARTCOLLISIONS | NORESTARTCOLLISIONS
• 3.147 RMTFILE
• 3.148 RMTHOST
• 3.149 RMTHOSTOPTIONS
• 3.150 RMTTASK
• 3.151 RMTTRAIL
• 3.152 ROLLOVER
• 3.153 SCHEMAEXCLUDE
• 3.154 SEQUENCE
• 3.155 SESSIONCHARSET
• 3.156 SETENV
• 3.157 SHOWSYNTAX
• 3.158 SOURCECATALOG
• 3.159 SOURCECHARSET
• 3.160 SOURCEDB
• 3.161 SOURCEDEFS
• 3.162 SOURCEISTABLE
• 3.163 SOURCETIMEZONE
• 3.164 SPACESTONULL | NOSPACESTONULL
• 3.165 SPECIALRUN
• 3.166 SQLDUPERR
• 3.167 SQLEXEC
• 3.168 STARTUPVALIDATIONDELAY[CSECS]
• 3.169 STATOPTIONS
• 3.170 SYSLOG
• 3.171 TABLE | MAP
• 3.172 TABLE for DEFGEN
• 3.173 TABLE for Replicat
• 3.174 TABLEEXCLUDE
• 3.175 TARGETDB
• 3.176 TARGETDEFS
• 3.177 TCPSOURCETIMER | NOTCPSOURCETIMER
• 3.178 THREADOPTIONS
• 3.179 TRACE | TRACE2
• 3.180 TRACETABLE | NOTRACETABLE
• 3.181 TRAILBYTEORDER
• 3.182 TRAILCHARSET
• 3.183 TRAILCHARSETASCII
• 3.184 TRAILCHARSETUNICODE
• 3.185 TRAILCHARSETEBCDIC
• 3.186 TRAIL_SEQLEN_6D | TRAIL_SEQLEN_9D
• 3.187 TRANLOGOPTIONS
• 3.188 TRANSACTIONTIMEOUT
• 3.189 TRANSMEMORY
• 3.190 TRIMSPACES | NOTRIMSPACES
• 3.191 TRIMVARSPACES | NOTRIMVARSPACES
• 3.192 UPDATEDELETES | NOUPDATEDELETES
• 3.193 UPDATEINSERTS | NOUPDATEINSERTS
• 3.194 UPDATERECORDFORMAT
• 3.195 UPREPORT
• 3.196 USE_TRAILDEFS | NO_USE_TRAILDEFS
• 3.197 USEANSISQLQUOTES | NOUSEANSISQLQUOTES
• 3.198 USEDEDICATEDCOORDINATIONTHREAD
• 3.199 USEIPV4
• 3.200 USEIPV6
• 3.201 USERID | NOUSERID
• 3.202 USERIDALIAS
• 3.203 VAM
• 3.204 VARWIDTHNCHAR | NOVARWIDTHNCHAR
• 3.205 VERIDATAREPORTAGE
• 3.206 WALLETLOCATION
• 3.207 WARNLONGTRANS
• 3.208 WARNRATE
• 3.209 WILDCARDRESOLVE
• 3.210 XAGENABLE
• 3.211 Y2KCENTURYADJUSTMENT | NOY2KCENTURYADJUSTMENT

4 Collector Parameters

• 4.1 Overview of the Collector Process
• 4.2 Summary of Collector Parameters
• 4.3 -B
• 4.4 -b
• 4.5 -cp
• 4.6 -d
• 4.7 -E
• 4.8 -e
• 4.9 -ENCRYPT
• 4.10 -f
• 4.11 -g
• 4.12 -h
• 4.13 -k
• 4.14 -KEYNAME
• 4.15 -l
• 4.16 -m
• 4.17 -P
• 4.18 -p
• 4.19 -R
• 4.20 -x

5 Column Conversion Functions

• 5.1 Summary of Column-Conversion Functions
• 5.2 AFTER
• 5.3 BEFORE
• 5.4 BEFOREAFTER
• 5.5 BINARY
• 5.6 BINTOHEX
• 5.7 CASE
• 5.8 COLSTAT
• 5.9 COLTEST
• 5.10 COMPUTE
• 5.11 DATE
• 5.12 DATEDIFF
• 5.13 DATENOW
• 5.14 DDL
• 5.15 EVAL
• 5.16 GETENV
• 5.17 GETVAL
• 5.18 HEXTOBIN
• 5.19 HIGHVAL | LOWVAL
• 5.20 IF
• 5.21 NUMBIN
• 5.22 NUMSTR
• 5.23 OGG_SHA1
• 5.24 RANGE
• 5.25 STRCAT
• 5.26 STRCMP
• 5.27 STREQ
• 5.28 STREXT
• 5.29 STRFIND
• 5.30 STRLEN
• 5.31 STRLTRIM
• 5.32 STRNCAT
• 5.33 STRNCMP
• 5.34 STRNUM
• 5.35 STRRTRIM
• 5.36 STRSUB
• 5.37 STRTRIM
• 5.38 STRUP
• 5.39 TOKEN
• 5.40 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
• 6.8 COMPRESS_RECORD
• 6.9 DECOMPRESS_RECORD
• 6.10 GET_BASE_OBJECT_NAME
• 6.11 GET_BASE_OBJECT_NAME_ONLY
• 6.12 GET_BASE_SCHEMA_NAME_ONLY
• 6.13 GET_BEFORE_AFTER_IND
• 6.14 GET_CATALOG_NAME_ONLY
• 6.15 GET_COL_METADATA_FROM_INDEX
• 6.16 GET_COL_METADATA_FROM_NAME
• 6.17 GET_COLUMN_INDEX_FROM_NAME
• 6.18 GET_COLUMN_NAME_FROM_INDEX
• 6.19 GET_COLUMN_VALUE_FROM_INDEX
• 6.20 GET_COLUMN_VALUE_FROM_NAME
• 6.21 GET_DATABASE_METADATA
• 6.22 GET_DDL_RECORD_PROPERTIES
• 6.23 GETENV
• 6.24 GET_ENV_VALUE
• 6.25 GET_ERROR_INFO
• 6.26 GET_GMT_TIMESTAMP
• 6.27 GET_MARKER_INFO
• 6.28 GET_OBJECT_NAME
• 6.29 GET_OBJECT_NAME_ONLY
• 6.30 GET_OPERATION_TYPE
• 6.31 GET_POSITION
• 6.32 GET_RECORD_BUFFER
• 6.33 GET_RECORD_LENGTH
• 6.34 GET_RECORD_TYPE
• 6.35 GET_SCHEMA_NAME_ONLY
• 6.36 GET_SESSION_CHARSET
• 6.37 GET_STATISTICS
• 6.38 GET_TABLE_COLUMN_COUNT
• 6.39 GET_TABLE_METADATA
• 6.40 GET_TABLE_NAME
• 6.41 GET_TABLE_NAME_ONLY
• 6.42 GET_TIMESTAMP
• 6.43 GET_TRANSACTION_IND
• 6.44 GET_USER_TOKEN_VALUE
• 6.45 OUTPUT_MESSAGE_TO_REPORT
• 6.46 RESET_USEREXIT_STATS
• 6.47 SET_COLUMN_VALUE_BY_INDEX
• 6.48 SET_COLUMN_VALUE_BY_NAME
• 6.49 SET_OPERATION_TYPE
• 6.50 SET_RECORD_BUFFER
• 6.51 SET_SESSION_CHARSET
• 6.52 SET_TABLE_NAME