1 Oracle GoldenGate Parameters

This chapter contains summaries of the Oracle GoldenGate parameters that control processing, followed by detailed descriptions of each parameter in alphabetical order.

Topics:

• Summary of Extract Parameters
  
• Summary of Replicat Parameters
  
• ABORTDISCARDRECS
  
• ALLOCFILES
  
• ALLOWDUPTARGETMAP | NOALLOWDUPTARGETMAP
  
• ALLOWINVISIBLEINDEXKEYS
  
• ALLOWNULLABLEKEYS | NOALLOWNULLABLEKEYS
  
• ALLOWNONVALIDATEDKEYS
  
• ALLOWNOOPUPDATES | NOALLOWNOOPUPDATES
  
• ALLOWOUTPUTDIR
  
• APPLYNOOPUPDATES | NOAPPLYNOOPUPDATES
  
• APPLY_PARALLELISM | MAX_APPLY_PARALLELISM | MIN_APPLY_PARALLELISM
  
• ASCIITOEBCDIC
  
• ASSUMETARGETDEFS
  
• AUTORESTART
  
• AUTOSTART
  
• BATCHSQL
  
• BEGIN
  
• BLOBMEMORY
  
• BR
  
• BULKLOAD
  
• CACHEMGR
  
• CATALOGEXCLUDE
  
• CHARMAP
  
• CHECKPARAMS
  
• CHECKPOINTSECS
  
• CHECKPOINTTABLE
  
• CHUNK_SIZE
  
• CMDTRACE
  
• COLCHARSET
  
• COLMATCH
  
• COMPRESSDELETES | NOCOMPRESSDELETES
  
• COMPRESSUPDATES | NOCOMPRESSUPDATES
  
• COMMIT_SERIALIZATION
  
• COORDSTATINTERVAL
  
• COORDTIMER
  
• CREDENTIALSTORELOCATION
  
• CRYPTOENGINE
  
• CUSEREXIT
  
• DBOPTIONS
  
• DDL
  
• DDLERROR
  
• DDLOPTIONS
  
• DDLSUBST
  
• DDLRULEHINT
  
• DDLTABLE
  
• DECRYPTTRAIL
  
• DEFERAPPLYINTERVAL
  
• DEFSFILE
  
• DICTIONARY_CACHE_SIZE
  
• DISCARDFILE | NODISCARDFILE
  
• DISCARDROLLOVER
  
• DYNAMICRESOLUTION | NODYNAMICRESOLUTION
  
• EBCDICTOASCII
  
• ENABLEMONITORING
  
• ENABLE_HEARTBEAT_TABLE | DISABLE_HEARTBEAT_TABLE
  
• ENCRYPTTRAIL | NOENCRYPTTRAIL
  
• END
  
• EOFDELAY | EOFDELAYCSECS
  
• EXCLUDEHIDDENCOLUMNS
  
• EXCLUDETAG
  
• EXCLUDEWILDCARDOBJECTSONLY
  
• EXTFILE
  
• EXTRACT
  
• EXTTRAIL
  
• FETCHOPTIONS
  
• FETCHUSERID
  
• FETCHUSERIDALIAS
  
• FILTERDUPS | NOFILTERDUPS
  
• FILEGROUP
  
• FLUSHSECS | FLUSHCSECS
  
• FUNCTIONSTACKSIZE
  
• GETAPPLOPS | IGNOREAPPLOPS
  
• GETDELETES | IGNOREDELETES
  
• GETINSERTS | IGNOREINSERTS
  
• GETREPLICATES | IGNOREREPLICATES
  
• GETTRUNCATES | IGNORETRUNCATES
  
• GETUPDATEAFTERS | IGNOREUPDATEAFTERS
  
• GETUPDATEBEFORES | IGNOREUPDATEBEFORES
  
• GETUPDATES | IGNOREUPDATES
  
• GGSCHEMA
  
• GROUPTRANSOPS
  
• HANDLECOLLISIONS | NOHANDLECOLLISIONS
  
• HAVEUDTWITHNCHAR
  
• HEARTBEATTABLE
  
• INCLUDE
  
• INSERTALLRECORDS
  
• INSERTAPPEND | NOINSERTAPPEND
  
• INSERTDELETES | NOINSERTDELETES
  
• INSERTMISSINGUPDATES | NOINSERTMISSINGUPDATES
  
• INSERTUPDATES | NOINSERTUPDATES
  
• INSERTUPSERTS | NOINSERTUPSERTS
  
• LIST | NOLIST
  
• LOBMEMORY
  
• LOGALLSUPCOLS
  
• LOOK_AHEAD_TRANSACTIONS
  
• MACRO
  
• MACROCHAR
  
• MAP for Extract
  
• MAP
  
• MAPALLCOLUMNS| NOMAPALLCOLUMNS
  
• MAP_PARALLELISM
  
• MAPEXCLUDE
  
• MAPINVISIBLECOLUMNS | NOMAPINVISIBLECOLUMNS
  
• MARKERTABLE
  
• MASTERKEYNAME
  
• MAXDISCARDRECS
  
• MAXGROUPS
  
• MAXSQLSTATEMENTS
  
• MAXTRANSOPS
  
• MGRSERVNAME
  
• NAMECCSID
  
• NAMEMATCH parameters
  
• NOCATALOG
  
• NODUPMSGSUPPRESSION
  
• NUMFILES
  
• OBEY
  
• OUTPUTFILEUMASK
  
• OUTPUTFORMAT
  
• OVERRIDEDUPS | NOOVERRIDEDUPS
  
• PARTIALBLOCKRETRYSECS
  
• PTKCAPTUREPROCSTATS
  
• PTKMONITORFREQUENCY
  
• PRESERVETARGETTIMEZONE
  
• PROCEDURE
  
• PURGEOLDEXTRACTS for Extract and Replicat
  
• REPERROR
  
• REPFETCHEDCOLOPTIONS
  
• REPLACEBADCHAR
  
• REPLACEBADNUM
  
• REPLICAT
  
• REPORT
  
• REPORTCOUNT
  
• REPORTROLLOVER
  
• REPOUDPPORT
  
• RESTARTCOLLISIONS | NORESTARTCOLLISIONS
  
• RMTFILE
  
• RMTHOST
  
• RMTHOSTOPTIONS
  
• RMTTASK
  
• RMTTRAIL
  
• ROLLOVER
  
• SCHEMAEXCLUDE
  
• SEQUENCE
  
• SESSIONCHARSET
  
• SETENV
  
• SHOWSYNTAX
  
• SOURCEDB
  
• SOURCECATALOG
  
• SOURCECHARSET
  
• SOURCEDEFS
  
• SOURCEISTABLE
  
• SOURCETIMEZONE
  
• SPACESTONULL | NOSPACESTONULL
  
• SPECIALRUN
  
• SPLIT_TRANS_RECS
  
• SQLDUPERR
  
• SQLEXEC
  
• STATOPTIONS
  
• TABLE | MAP
  
• TABLE for DEFGEN
  
• TABLE for Replicat
  
• TABLEEXCLUDE
  
• TARGETDB
  
• TARGETDEFS
  
• TCPSOURCETIMER | NOTCPSOURCETIMER
  
• TRACE | TRACE2
  
• TRACETABLE | NOTRACETABLE
  
• TRAILBYTEORDER
  
• TRAILCHARSET
  
• TRAILCHARSETASCII
  
• TRAILCHARSETEBCDIC
  
• TRAIL_SEQLEN_6D | TRAIL_SEQLEN_9D
  
• TRANLOGOPTIONS
  
• TRANSACTIONTIMEOUT
  
• TRANSMEMORY
  
• TRIMSPACES | NOTRIMSPACES
  
• TRIMVARSPACES | NOTRIMVARSPACES
  
• UPDATEDELETES | NOUPDATEDELETES
  
• UPDATEINSERTS | NOUPDATEINSERTS
  
• UPDATERECORDFORMAT
  
• UPREPORTMINUTES | UPREPORTHOURS
  
• USE_TRAILDEFS | NO_USE_TRAILDEFS
  
• USEDEDICATEDCOORDINATIONTHREAD
  
• USEIPV4 | USEIPV6
  
• USERID | NOUSERID
  
• USERIDALIAS
  
• VARWIDTHNCHAR | NOVARWIDTHNCHAR
  
• WALLETLOCATION
  
• WARNLONGTRANS
  
• WARNRATE
  
• WILDCARDRESOLVE
  
• XAGENABLE
  
• Y2KCENTURYADJUSTMENT | NOY2KCENTURYADJUSTMENT
  

1.1 Summary of Extract Parameters

The Extract process captures either full data records or transactional data changes, depending on configuration parameters, and then sends the data to a target system to be applied to target tables or processed further by another process, such as a load utility.

Table 1-1 Extract Parameters: General

Parameter	Description
ABORTDISCARDRECS	Controls the number of discarded records after which Extract aborts.
unresolvable-reference.html	Controls the recovery mode of the Extract process.
SOURCEDB	Specifies the data source as part of the login information.
TCPSOURCETIMER | NOTCPSOURCETIMER	Adjusts timestamps of records transferred to other systems when those systems reflect different times.
UPDATERECORDFORMAT	Controls whether before and after images are stored in one trail record or two.

Table 1-2 Extract Parameters: Processing Method

Parameter	Description
EXTRACT	Defines an Extract group as an online process.
GETAPPLOPS | IGNOREAPPLOPS	Controls whether or not operations from all processes except Replicat are written to a trail or file.
GETREPLICATES | IGNOREREPLICATES	Controls whether or not replicated operations are captured by an Extract on the same system.
SOURCEISTABLE	Extracts entire records from source tables.
unresolvable-reference.html	Indicates that a Teradata Access Module (TAM) is being used to provide transactional data to the Extract process.

Table 1-3 Extract Parameters: Selecting, Converting, and Mapping Data

Parameter	Description
COMPRESSDELETES | NOCOMPRESSDELETES	Controls whether Oracle GoldenGate writes only the key or all columns to the trail for delete operations.
COMPRESSUPDATES | NOCOMPRESSUPDATES	Causes only primary key columns and changed columns to be logged for updates.
EXCLUDEHIDDENCOLUMNS	The parameter disables all the Oracle Database hidden columns including the timestamp columns created using automatic CDR.
EXCLUDETAG	Specifies Replicat or data pump changes to be excluded from trail files.
FETCHOPTIONS	Controls certain aspects of the way that Oracle GoldenGate fetches data.
LOGALLSUPCOLS	Logs the columns that are required to support Conflict Detection and Resolution and Integrated Replicat.
SEQUENCE	Specifies sequences for synchronization.
TABLE | MAP	Specifies tables for extraction and controls column mapping and conversion.
TABLEEXCLUDE	Excludes source tables from the extraction process.
TARGETDEFS	Specifies a file containing target table definitions for target databases that reside on the NonStop platform.
TRAILCHARSETASCII	Specifies the ASCII character set for data captured from DB2 on z/OS, when both ASCII and EBCDIC tables are present.
TRAILCHARSETEBCDIC	Specifies the EBCDIC character set for data captured from DB2 on z/OS, when both ASCII and EBCDIC tables are present.

Table 1-4 Extract Parameters: Routing Data

Parameter	Description
EXTFILE	Specifies an extract file to which extracted data is written on the local system.
EXTTRAIL	Specifies a trail to which extracted data is written on the local system.
RMTFILE	Specifies an extract file to which extracted data is written on a remote system.
RMTHOST	Specifies the target system and Manager port number.
RMTTRAIL	Specifies a trail to which extracted data is written on a remote system.

Table 1-5 Extract Parameters: Tuning

Parameter	Description
BR	Controls the Bounded Recovery feature of Extract.
CACHEMGR	Controls the virtual memory cache manager.
FLUSHSECS | FLUSHCSECS	Determines the amount of time that record data remains buffered before being written to the trail.
LOBMEMORY	Controls the amount of memory and temporary disk space available for caching transactions that contain LOBs.
RMTHOSTOPTIONS	Specifies connection attributes other than host information for a TCP/IP connection used by a passive Extract group.
TRANLOGOPTIONS	Supplies capture processing options.
WARNLONGTRANS	Defines a long-running transaction and controls the frequency of checking for and reporting them.

Table 1-6 Extract Parameters: Maintenance

Parameter	Description
ROLLOVER	Specifies the way that trail files are aged.

Table 1-7 Extract Parameters: Security

Parameter	Description
DECRYPTTRAIL	Required to decrypt data when Extract is used as a data pump and must do work on the data.
ENCRYPTTRAIL | NOENCRYPTTRAIL	Controls encryption of data in a trail or extract file.

1.2 Summary of Replicat Parameters

The Replicat process reads data extracted by the Extract process and applies it to target tables or prepares it for use by another application, such as a load utility.

Parameter	Description
TARGETDB	Specifies the data source as part of the login information.
HAVEUDTWITHNCHAR	Causes Replicat to connect in UTF-8 to prevent data loss when the record being processed is a user-defined type that has an NCHAR/NVARCHAR2 attribute.

Replicat parameters: Processing method.

Parameter	Description
BEGIN	Specifies a starting point for Replicat processing. Required when SPECIALRUN is specified.
BULKLOAD	Loads data directly into the interface of the Oracle SQL*Loader utility.
END	Specifies a stopping point for Replicat processing. Required when using SPECIALRUN.
unresolvable-reference.html	Generates run and control files that are compatible with a database load utility.
REPLICAT	Specifies a Replicat group for online change synchronization.
SPECIALRUN	Used for one-time processing that does not require checkpointing from run to run.

Replicat parameters: Selecting, converting, and mapping data.

Parameter	Description
unresolvable-reference.html	Specifies database options. This is a global parameter, applying to all TABLE or MAP statements in the parameter file. Some DBOPTIONS options apply only to Extract or Replicat.
ALLOWNOOPUPDATES | NOALLOWNOOPUPDATES	Controls how Replicat responds to a no-op operation. A no-op operation is one in which there is no effect on the target table.
APPLYNOOPUPDATES | NOAPPLYNOOPUPDATES	Force a no-op update to be applied using all columns in both the SET and WHERE clauses.
APPLY_PARALLELISM	Configures number of appliers. This controls the number of connections in the target database used to apply the changes. The default value is four.
ASSUMETARGETDEFS	Assumes that source and target tables have the same column structure.
INSERTALLRECORDS	Inserts a new record into the target table for every change operation made to a record.
INSERTDELETES | NOINSERTDELETES	Converts deletes to inserts.
INSERTMISSINGUPDATES | NOINSERTMISSINGUPDATES	Converts an update to an insert when the target row does not exist.
INSERTUPDATES | NOINSERTUPDATES	Converts updates to inserts.
TABLE | MAP	Specifies a relationship between one or more source and target tables and controls column mapping and conversion.
MAPEXCLUDE	Excludes source tables from being processed by a wildcard specification supplied in MAP statements.
MAP_PARALLELISM	Configures the number of mappers. This controls the number of threads used to read the trail file. The minimum value is 1, maximum value is 100 and the default value is 2.
MAX_PARALLELISM , MIN_PARALLELISM	APPLY_PARALLELISM is auto-tuned. You can set a minimum and maximum value to define the ranges in which the Replicat automatically adjusts its parallelism. There are no defaults. Do not use with APPLY_PARALLELISM at the same time.
PRESERVETARGETTIMEZONE	Overrides the default Replicat session time zone.
REPLACEBADNUM	Specifies a global substitution value for invalid numeric data encountered when mapping number columns.
SOURCECHARSET	Controls whether the source character set it converted to the target character set.
SOURCETIMEZONE	Specifies the time zone of the source database for Replicat to use as the session time zone.
SPACESTONULL | NOSPACESTONULL	Controls whether or not a target column containing only spaces is converted to NULL.
TABLE for Replicat	Specifies a table or tables for which event actions are to take place when a row satisfies the given filter criteria.
TRAILCHARSET	Specifies the character set of the source data when the trail is of an older version that does not store the source character set, or to override the character set that is stored in the trail.
UPDATEINSERTS | NOUPDATEINSERTS	Converts insert operations to update operations for all MAP statements that are specified after it in the parameter file.
UPDATEDELETES | NOUPDATEDELETES	Converts deletes to updates.
USEDEDICATEDCOORDINATIONTHREAD	Specifies a dedicated thread for barrier transactions when Replicat is in coordinated mode.

Replicat parameters: Routing data.

Parameter	Description
EXTFILE	Defines the name of an extract file on the local system that contains data to be replicated. Used for one-time processing.
EXTTRAIL	Defines a trail containing data to be replicated. Used for one-time processing.

Replicat parameters: Error handling and reporting.

Parameter	Description
HANDLECOLLISIONS | NOHANDLECOLLISIONS	Handles errors for duplicate and missing records.
unresolvable-reference.html	Prevents constraint errors associated with replicating transient primary key updates.
OVERRIDEDUPS | NOOVERRIDEDUPS	Overlays a replicated insert record onto an existing target record whenever a duplicate-record error occurs.
RESTARTCOLLISIONS | NORESTARTCOLLISIONS	Controls whether or not Replicat applies HANDLECOLLISIONS logic after Oracle GoldenGate has abended because of a conflict.
REPERROR	Determines how Replicat responds to database errors.
REPFETCHEDCOLOPTIONS	Determines how Replicat responds to operations for which a fetch from the source database was required.
SHOWSYNTAX	Causes Replicat to print its SQL statements to the report file.
SQLDUPERR	Specifies the database error number that indicates a duplicate record. Use with OVERRIDEDUPS.
WARNRATE	Determines how often database errors are reported.

Replicat parameters: Tuning.

Parameter	Description
BATCHSQL	Increases the throughput of Replicat processing by arranging similar SQL statements into arrays and applying them at an accelerated rate.
COORDSTATINTERVAL	The interval at which the coordinator thread sends a request to the apply threads for statistics.
COORDTIMER	The amount of time that the coordinator thread waits for the apply threads to start.
CHUNK_SIZE	Controls how large a transaction must be for parallel Replicat to consider it as large. When parallel Replicat encounters a transaction larger than this size, it will serialize it, resulting in decreased performance. However, increasing this value will also increase the amount of memory consumed by parallel Replicat.
COMMIT_SERIALIZATION	Enables commit FULL serialization mode, which forces transactions to be committed in trail order.
DEFERAPPLYINTERVAL	Specifies a length of time for Replicat to wait before applying replicated operations to the target database.
GROUPTRANSOPS	Controls the number of records that are grouped into a Replicat transaction.
INSERTAPPEND | NOINSERTAPPEND	Controls whether or not Replicat uses an APPEND hint when applying INSERT operations to Oracle target tables.
LOOK_AHEAD_TRANSACTIONS	Controls how far ahead the Scheduler looks when batching transactions. The default value is 10000.
MAXDISCARDRECS	Limits the number of discarded records reported to the discard file.
MAXSQLSTATEMENTS	Controls the number of prepared SQL statements that can be used by Replicat.
MAXTRANSOPS	Divides large source transactions into smaller ones on the target system.
NUMFILES	Controls the initial allocation of memory that is dedicated to storing information about tables to be processed by Oracle GoldenGate.
SPLIT_TRANS_REC	Specifies that large transactions should be broken into pieces of specified size and applied in parallel. Dependencies between pieces are still honored. Disabled by default.
TRANSACTIONTIMEOUT	Specifies a time interval after which Replicat will commit its open target transaction and roll back any incomplete source transactions that it contains, saving them for when the entire source transaction is ready to be applied.