Go to main content
1/360
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Information
Conventions
1
GGSCI Commands
1.1
Manager commands
1.1.1
INFO MANAGER
1.1.2
SEND MANAGER
1.1.3
START MANAGER
1.1.4
STATUS MANAGER
1.1.5
STOP MANAGER
1.2
Extract commands
1.2.1
ADD EXTRACT
1.2.2
ALTER EXTRACT
1.2.3
CLEANUP EXTRACT
1.2.4
DELETE EXTRACT
1.2.5
INFO EXTRACT
1.2.6
KILL EXTRACT
1.2.7
LAG EXTRACT
1.2.8
SEND EXTRACT
1.2.9
START EXTRACT
1.2.10
STATUS EXTRACT
1.2.11
STOP EXTRACT
1.3
Replicat commands
1.3.1
ADD REPLICAT
1.3.2
ALTER REPLICAT
1.3.3
CLEANUP REPLICAT
1.3.4
DELETE REPLICAT
1.3.5
INFO REPLICAT
1.3.6
KILL REPLICAT
1.3.7
LAG REPLICAT
1.3.8
SEND REPLICAT
1.3.9
START REPLICAT
1.3.10
STATUS REPLICAT
1.3.11
STOP REPLICAT
1.4
ER commands
1.5
Logger commands
1.5.1
ADD LOGGER
1.5.2
ALTER LOGGER
1.5.3
DELETE LOGGER
1.5.4
INFO LOGGER
1.5.5
SEND LOGGER
1.5.6
START LOGGER
1.5.7
STATUS LOGGER
1.5.8
STOP LOGGER
1.6
Trail commands
1.6.1
ADD
1.6.2
ADD RMTTRAIL
1.6.3
ALTER
1.6.4
ALTER RMTTRAIL
1.6.5
DELETE
1.6.6
DELETE RMTTRAIL
1.6.7
INFO
1.6.8
INFO RMTTRAIL
1.7
Database commands
1.7.1
CAPTURE TABLEDEFS
1.7.2
ENCRYPT PASSWORD
1.7.3
INFO DDLDEFS
1.7.4
INFO FILES
1.8
Audit trail commands
1.8.1
ADD ATCONFIG
1.8.2
ALTER ATCONFIG
1.8.3
DELETE ATCONFIG
1.8.4
INFO ATCONFIG
1.8.5
STATUS AUDITTRAIL
1.9
Remote checkpoint commands
1.9.1
ADD REMOTECHKPT
1.9.2
DELETE REMOTECHKPT
1.9.3
INFO REMOTECHKPT
1.10
TMF commands
1.10.1
REFRESHTMFINFO
1.10.2
TMFDUMPAGE
1.10.3
TMFDUMPINFO
1.10.4
TMFDUMPTABLEENTRIES
1.10.5
TMFREFRESHINTERVAL
1.10.6
TMFTRAILINFO
1.11
Coordinator commands
1.11.1
ADD COORDINATOR
1.11.2
ALTER COORDINATOR
1.11.3
DELETE COORDINATOR
1.11.4
INFO COORDINATOR
1.11.5
SEND COORDINATOR
1.11.6
START COORDINATOR
1.11.7
STATUS COORDINATOR
1.11.8
STOP COORDINATOR
1.12
Process commands
1.12.1
SEND PROCESS
1.13
Marker commands
1.13.1
ADD MARKER
1.13.2
INFO MARKER
1.14
Programs commands
1.14.1
BIND PROGRAMS
1.14.2
INFO PROGRAMS
1.14.3
LINK PROGRAMS
1.15
Report commands
1.15.1
SEND REPORT
1.15.2
VIEW REPORT
1.16
Syncfile commands
1.16.1
ADD SYNCFILE
1.16.2
ALTER SYNCFILE
1.16.3
DELETE SYNCFILE
1.16.4
INFO SYNCFILE
1.16.5
KILL SYNCFILE
1.16.6
START SYNCFILE
1.16.7
STATUS SYNCFILE
1.16.8
STOP SYNCFILE
1.17
Miscellaneous commands
1.17.1
! command
1.17.2
ENV
1.17.3
FC
1.17.4
HELP
1.17.5
HISTORY
1.17.6
INFO ALL
1.17.7
LOG
1.17.8
LOG STOP
1.17.9
OBEY
1.17.10
EDIT PARAMS
1.17.11
VIEW PARAMS
1.17.12
SYSTEM
1.17.13
VIEW GGSEVT
2
Oracle GoldenGate Parameters
2.1
Parameter Summaries
2.1.1
GLOBALS Parameters Summary
2.1.2
Manager Parameters Summary
2.1.3
Logger Parameters Summary
2.1.4
CHGNOTE Parameters Summary
2.1.5
Extract Parameters Summary
2.1.6
Replicat Parameters Summary
2.1.7
Coordinator Parameters Summary
2.1.8
Syncfile Parameters Summary
2.2
ABORTDUPERRWINDOW
2.3
ADD DEFINE
2.4
ALLOCFILES
2.5
ALTFILERESOLVE | NOALTFILERESOLVE
2.6
ALTINPUT
2.7
ASSUMETARGETDEFS
2.8
AUDITING
2.9
AUDITREPS | NOAUDITREPS
2.10
AUDITRETRYDELAY
2.11
AUDSERVCACHEBLOCKS
2.12
AUDSERVCPU
2.13
AUDSERVPARAM
2.14
AUDSERVPREFIX
2.15
AUDSERVPROCESS
2.16
AUDSERVPROGRAM
2.17
AUTORESTART
2.18
AUTOSTART
2.19
BACKUPCPU
2.20
BEGIN
2.21
BULKIOLOAD | NOBULKIOLOAD
2.22
CHECKINTERVAL
2.23
CHECKMINUTES
2.24
CHECKPARAMS
2.25
CHECKPOINTSECS
2.26
CHECKUNIQUEKEY | NOCHECKUIQUEKEY
2.27
CLEANUPSAVECOUNT
2.28
COBOLUSEREXIT
2.29
COLMATCH
2.30
COMMENT
2.31
COMPRESSDELETES | NOCOMPRESSDELETES
2.32
CONTROLTABLELOCKOFF
2.33
CONVERTALLFLOATSTOIEEE | NOCONVERTALLFLOATSTOIEEE
2.34
CONVERTALLFLOATSTOTDM | NOCONVERTALLFLOATSTOTDM
2.35
COORDINATOR
2.36
CPU
2.37
CUSEREXIT
2.38
DEBUGONSTACKCHECK
2.39
DECRYPTTRAIL
2.40
DICTIONARY
2.41
DISCARDFILE
2.42
DISCARDROLLOVER
2.43
DISKTHRESHOLD | NODISKTHRESHOLD
2.44
DISPLAYFILEREFRESHES
2.45
DISPLAYTRAILSWITCH | NODISPLAYTRAILSWITCH
2.46
DOWNCRITICAL
2.47
DOWNINFO
2.48
DOWNREPORT
2.49
DUP
2.50
DUPONLYAFTEREVENT
2.51
DUPPROCESS
2.52
DYNAMICPORTLIST
2.53
DYNAMICPORTREASSIGNDELAY
2.54
EMBEDDEDMACROS | NOEMBEDDEDMACROS
2.55
EMSLOG
2.56
ENCRYPTTRAIL | NOENCRYPTTRAIL
2.57
END
2.58
ENTRYSEQUPDATES
2.59
EOFDELAY | EOFDELAYCSECS
2.60
ERREPLYTIMEOUT
2.61
ERROR59ROLLOVER
2.62
ETNEWFORMAT | ETOLDFORMAT
2.63
EVENT
2.64
EXCLUDEFILE
2.65
EXCLUDEGGSTRANSRECS | INCLUDEGGSTRANSRECS
2.66
EXCLUDESUFFIXCHAR
2.67
EXPANDDDL
2.68
EXTFILE
2.69
EXTRACT
2.70
EXTTRAIL
2.71
FASTIO
2.72
FASTPOSITION | NOFASTPOSITION
2.73
FASTREADS | NOFASTREADS
2.74
FETCHCOMPS | FETCHLASTIMAGE
2.75
FILE
2.76
FILE | TABLE
2.77
FILEAGEDAYS
2.78
FILEAGESCANDAYS
2.79
FILEEXCLUDE
2.80
FILEOPWARNING
2.81
FILERESOLVE
2.82
FILLSHORTRECS | NOFILLSHORTRECS
2.83
FILTERVIEW | NOFILTERVIEW
2.84
FLUSHCHECKPOINT | NOFLUSHCHECKPOINT
2.85
FLUSHSECS | FLUSHCSECS
2.86
FORCESTOPDELAY
2.87
FORCEUSESYSKEY | NOFORCEUSESYSKEY
2.88
FORMATASCII | NOFORMATASCII
2.89
FORMATLOCAL
2.90
FORMATSQL | NOFORMATSQL
2.91
FORMATXML
2.92
FUNCTIONSTACKSIZE
2.93
GETALTKEYS | IGNOREALTKEYS
2.94
GETAPPLOPS | IGNOREAPPLOPS
2.95
GETAUXTRAILS | IGNOREAUXTRAILS
2.96
GETCOMPS | IGNORECOMPS
2.97
GETCREATES | IGNORECREATES
2.98
GETDEFAULTS
2.99
GETDELETES | IGNOREDELETES
2.100
GETENV
2.101
GETFILEOPS | IGNOREFILEOPS
2.102
GETINSERTS | IGNOREINSERTS
2.103
GETMARKERS | IGNOREMARKERS
2.104
GETNETCHANGES | IGNORENETCHANGES
2.105
GETNETWORKALTFILENAMES | IGNORENETWORKALTFILENAMES
2.106
GETNEWCOLUMNS | IGNORENEWCOLUMNS
2.107
GETPARTONLYPURGEDATAS | IGNOREPARTONLYPURGEDATAS
2.108
GETPURGES | IGNOREPURGES
2.109
GETPURGEDATAS | IGNOREPURGEDATAS
2.110
GETRENAMES | IGNORERENAMES
2.111
GETREPLICATES | IGNOREREPLICATES
2.112
GETROLLBACKS | IGNOREROLLBACKS
2.113
GETUPDATEAFTERS | IGNOREUPDATEAFTERS
2.114
GETUPDATEBEFORES | IGNOREUPDATEBEFORES
2.115
GETUPDATES | IGNOREUPDATES
2.116
GROUPTRANSOPS
2.117
HANDLECOLLISIONS | NOHANDLECOLLISIONS
2.118
HEARTBEAT
2.119
HOMETERM
2.120
HOMETERMMESSAGES
2.121
HOST
2.122
IGNOREPARAMERROR
2.123
IGNORETMFDUMPS
2.124
INCLUDE
2.125
INCLUDESOURCEAPPINFO | EXCLUDESOURCEAPPINFO
2.126
INSERTALLRECORDS | NOINSERTALLRECORDS
2.127
INSERTDELETES | NOINSERTDELETES
2.128
INSERTMISSINGUPDATES | NOINSERTMISSINGUPDATES
2.129
INSERTUPDATES | NOINSERTUPDATES
2.130
IPINTERFACE
2.131
LAGCRITICAL
2.132
LAGINFO
2.133
LAGREPORT
2.134
LAGSTATS
2.135
LIMITRECS
2.136
LIST | NOLIST
2.137
LOG
2.138
LOGFILESBEHIND | LOGFILESBEHINDINFO
2.139
LOGFILEOPENS
2.140
LOGGERFILENUM
2.141
LOGGERFLUSHRECS
2.142
LOGGERFLUSHSECS | LOGGERFLUSHCSECS
2.143
LOGGERTIMEOUTSECS
2.144
LOGGGSCICOMMANDS
2.145
LOGON
2.146
MACRO
2.147
MACROCHAR
2.148
MANAGERREQUIRED
2.149
MAP
2.150
MAPEXCLUDE
2.151
MAXABENDRESTARTS
2.152
MAXDISCARDRECS
2.153
MAXETCHECKPOINTSECS
2.154
MAXTRANSMEM
2.155
MAXTRANSOPS
2.156
MAXWILDCARDENTRIES
2.157
NETWORKCHECKPOINTS
2.158
NOTSTOPPABLE
2.159
NUMEXTRACTS
2.160
NUMFILES
2.161
OBEY
2.162
OLDGROUPNAMING
2.163
OMITAUDITGAPCHECK
2.164
OPENTIMEOUT | OPENTIMEOUTMINUTES
2.165
OPENWARNINGS
2.166
OVERRIDEDUPS | NOOVERRIDEDUPS
2.167
PARTMAP
2.168
PARAMCHECK
2.169
PASSTHRU | NOPASSTHRU
2.170
PORT
2.171
POSITIONFIRSTRECORD
2.172
PRIORITY
2.173
PURGEDATAALTFILES | NOPURGEDATAALTFILE
2.174
PURGEOLDEXTRACTS for Extract and Replicat
2.175
PURGEOLDEXTRACTS for Manager
2.176
PURGEOLDTASKS
2.177
PURGERESTORE | NOPURGERESTORE
2.178
READER
2.179
READTHRULOCKS | NOREADTHRULOCKS
2.180
RECEIVEQWARN
2.181
RENAMEBUMPDELAY
2.182
REPERROR
2.183
REPLACEBADCHAR
2.184
REPLACEBADNUM
2.185
REPLICAT
2.186
REPNEWCOLUMNS | NOREPNEWCOLUMNS
2.187
REPORT
2.188
REPORTCOUNT
2.189
REPORTFILEEXTENTS
2.190
REPORTROLLOVER
2.191
REPORTTMFEXCEPTIONS
2.192
REPSQLLOG
2.193
RESTARTCOLLISIONS | NORESTARTCOLLISIONS
2.194
RESTARTINTERVAL
2.195
RESTORE | NORESTORE
2.196
RETRYDELAY
2.197
RETRYERR
2.198
REVERSEWINDOWSECS | REVERSEWINDOWCSECS
2.199
RMTBATCH
2.200
RMTFILE
2.201
RMTHOST
2.202
RMTHOSTALT
2.203
RMTTASK
2.204
RMTTRAIL
2.205
ROLLOVER
2.206
SETENV
2.207
SHORTREADDELAY
2.208
SOURCEDEFS
2.209
SOURCEISFILE | SOURCEISTABLE
2.210
SPECIALRUN
2.211
SQLFORMATDISCARDFILE
2.212
SQLFORMATDISCARDROLLOVER
2.213
STATOPTIONS
2.214
SUPPRESSALLALTERMESSAGES | NOSUPPRESSALLALTERMESSAGES
2.215
SUPPRESSALTERMESSAGES | NOSUPPRESSALTERMESSAGES
2.216
SUPPRESSFETCHCOMPRESSEDDISCARDS | NOSUPPRESSFETCHCOMPRESSEDDISCARDS
2.217
SUPPRESSFILEOPMESSAGES | NOSUPPRESSFILEOPMESSAGES
2.218
SUPPRESSMARKERMESSAGES
2.219
SWAPVOL
2.220
SYNCFILE
2.221
SYSKEYCONVERT
2.222
TABLE
2.223
TABLEEXCLUDE
2.224
TALUSEREXIT
2.225
TCPBUFSIZE
2.226
TCPFLUSHBYTES
2.227
TCPIPPROCESSNAME
2.228
TCPIPSWITCHERRS
2.229
TCPSOURCETIMER | NOTCPSOURCETIMER
2.230
THRESHOLD | NOTHRESHOLD
2.231
TMFDUMPAGE
2.232
TMFDUMPTABLEENTRIES
2.233
TMFEXCEPTIONS | NOTMFEXCEPTIONS
2.234
TMFREFRESHINTERVAL
2.235
TMFTRAILTRACE
2.236
TRACE
2.237
TRACEALLOPENS
2.238
TRACECLOSES
2.239
TRACEOPENS
2.240
TRACEPROCESSIOS
2.241
TRACESTATS
2.242
UPDATEDELETES | NOUPDATEDELETES
2.243
UPDATEINSERTS | NOUPDATEINSERTS
2.244
UPREPORT
2.245
VERBOSE
2.246
VERIDATAREPORTAGE
2.247
VERSIONERR
2.248
WAITFILEEVENT
2.249
WARNRATE
2.250
Y2KCENTURYADJUSTMENT | NOY2KCENTURYADJUSTMENT
3
Collector Parameters
3.1
Collector Parameters
3.2
QSAM Configuration Parameters
4
Field Conversion Functions
4.1
Overview of Functions
4.1.1
Function Syntax
4.1.2
Function Summaries
4.1.2.1
Working with Columns
4.1.2.2
Working with Dates
4.1.2.3
Working with Numbers and Arithmetic Expressions
4.1.2.4
Working with Conditional Statements
4.1.2.5
Working with Character and Numeric Strings
4.1.2.6
Environmental Information
4.2
BINARY
4.3
CASE
4.4
COLSTAT
4.5
COLTEST
4.6
COMPUTE
4.7
CONVERTFLOAT
4.8
DATE
4.9
DATEDIFF
4.10
DATENOW
4.11
EVAL
4.12
GETENV
4.13
GETVAL
4.14
HIGHVAL | LOWVAL
4.15
IF
4.16
NUMBIN
4.17
NUMSTR
4.18
RANGE
4.19
STRCAT
4.20
STRCMP
4.21
STREQ
4.22
STREXT
4.23
STRFIND
4.24
STRLEN
4.25
STRLTRIM
4.26
STRNCAT
4.27
STRNCMP
4.28
STRNUM
4.29
STRRTRIM
4.30
STRSUB
4.31
STRTRIM
4.32
STRUP
4.33
TOKEN
4.34
VALONEOF
5
DEFGEN Arguments
5.1
Argument Summary
5.2
EXCLUDESYSTEM | INCLUDESYSTEM
5.3
EXPANDDDL
5.4
NCHARCOMPATIBILITY
5.5
RECORDNAMEPROMPTING
5.6
FORMAT LEVEL
6
DDLGEN Arguments
6.1
Run-time arguments
6.2
Template parameters
6.3
OMITNULL | INCLUDENULL
6.4
OMITNOTNULL | INCLUDENOTNULL
6.5
OMITREDEFS | INCLUDEREDEFS
6.6
OMITCOMMENTS | INCLUDECOMMENTS
6.7
USESAMENULLS
7
User Exit Functions
7.1
Function summary
7.2
EXIT_CALL_RESULT
7.3
EXIT_CALL_TYPE
7.4
EXIT_PARAMS
7.5
EXIT_REC_BUF
7.6
Calling environment functions
7.7
COMPRESS_RECORD | COMPRESS_RECORD2
7.8
DECOMPRESS_RECORD | DECOMPRESS_RECORD2
7.9
FETCH_CURRENT_RECORD
7.10
FETCH_CURRENT_RECORD_WITH_LOCK
7.11
GET_ALTKEY_INFO
7.12
GET_COLUMN_INDEX
7.13
GET_COLUMN_NAME
7.14
GET_ENV_VALUE
7.15
GET_EXITPARAM_VALUE
7.16
GET_EXTRBA
7.17
GET_EXTSEQNO
7.18
GET_FILENAME
7.19
GET_FOPEN_NUM
7.20
GET_NUM_COLUMNS
7.21
GET_RECORD | GET_RECORD2
7.22
GET_RECORD_LENGTH | GET_RECORD_LENGTH2
7.23
GET_SYSKEY_LENGTH
7.24
GET_TRANSACTION_IND
7.25
GET_USER_TOKEN_VALUE
7.26
GGS_EMSMESSAGE
7.27
GGS_REPORTMESSAGE
7.28
SET_TARGET_RECORD2
7.29
SET_TARGET_RECORD_LENGTH2
8
Event Error and Warning Messages
Scripting on this page enhances content navigation, but does not change the content in any way.