3 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.

For instructions on creating, changing, and storing Oracle GoldenGate parameter files, see Administering Oracle GoldenGate for Windows and UNIX.

3.1 Summary of Oracle GoldenGate Parameters

This section summarizes the Oracle GoldenGate parameters by module and purpose and includes the following topics:

3.1.1 Summary of GLOBALS Parameters

The GLOBALS file stores parameters that relate to the Oracle GoldenGate instance as a whole, as opposed to runtime parameters for a specific process.

Table 3-1 All GLOBALS Parameters

Parameter Description

TRAILBYTEORDER

Specifies the byte order (endianness) of a file created with the EXTFILE, RMTFILE, EXTTRAIL, or RMTTRAIL parameter.

CHARMAP

Specifies that the character mapping file overrides the character code point mapping.

CHARSET

Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file.

CHECKPOINTTABLE

Specifies a default checkpoint table.

CREDENTIALSTORELOCATION

Specifies the location of the Oracle GoldenGate credential store that stores login credentials.

DDLTABLE

Specifies a non-default name for the DDL history table that supports DDL synchronization for Oracle.

ENABLECATALOGNAMES

Enables support for three-part names for SQL/MX databases.

ENABLEMONITORING

Enables Oracle GoldenGate Monitor to view and monitor Oracle GoldenGate instances.

EXCLUDEWILDCARDOBJECTSONLY

Includes non-wildcarded source tables when a TABLEEXCLUDE, SCHEMAEXCLUDE, or CATALOGEXCLUDE parameter contains a wildcard.

GGSCHEMA

Specifies the name of the schema that contains the database objects that support DDL synchronization for Oracle.

MARKERTABLE

Specifies a non-default name for the DDL marker table that supports DDL synchronization for Oracle.

MAXGROUPS

Specifies the maximum number of process groups that can run in an instance of Oracle GoldenGate.

MGRSERVNAME

Specifies the name of the Manager process when it is installed as a Windows service.

NAMECCSID

Specifies a DB2 for i CCSID if the object names in the SQL catalog are of a different CCSID than the system.

NODUPMSGSUPPRESSION

Prevents the automatic suppression of duplicate informational and warning messages.

OUTPUTFILEUMASK

Specifies a umask that can be used by Oracle GoldenGate processes to create trail files and discard files.

USEANSISQLQUOTES | NOUSEANSISQLQUOTES

Enables SQL-92 rules for quoted object names and literals.

SYSLOG

Filters the types of Oracle GoldenGate messages that are written to the system logs.

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.

UPREPORT

Specifies the frequency with which Manager reports Extract and Replicat processes that are running. Every time one of those processes starts or stops, events are generated.

USEIPV4

Forces Oracle GoldenGate to use IPv4 for TCP/IP connections.

USEIPV6

Forces Oracle GoldenGate to use IPv6 for TCP/IP connections.

WALLETLOCATION

Specifies the location of the master key wallet.


3.1.2 Summary of Manager Parameters

Manager is the parent process of Oracle GoldenGate and is responsible for the management of its processes, resources, user interface, and the reporting of thresholds and errors. In most cases default settings for Manager suffice.

Table 3-2 Manager Parameters: General

Parameter Description

CHARSET

Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file.

COMMENT | --

Allows insertion of comments in a parameter file.

SOURCEDB

Specifies a data source name as part of the login information.

USERIDALIAS

Provides login information for Manager when it needs to access the database.

SYSLOG

Filters the types of Oracle GoldenGate messages that are written to the system logs on a Windows or UNIX system or to the SYSOPR message queue on an IBM i system.


Table 3-3 Manager Parameters: Port Management

Parameter Description

DYNAMICPORTLIST

Specifies the ports that Collector can dynamically allocate.

PORT

Establishes the TCP/IP port number on which Manager listens for requests.


Table 3-4 Manager Parameters: Process Management

Parameter Description

AUTORESTART

Specifies processes to be restarted by Manager after a failure.

AUTOSTART

Specifies processes to be started when Manager starts.

BOOTDELAYMINUTES

Determines how long after system boot time Manager delays until performing main processing activities. This parameter supports Windows.

UPREPORT

Determines how often process heartbeat messages are reported.


Table 3-5 Manager Parameters: Event Management

Parameter Description

DOWNCRITICAL

Reports processes that stopped gracefully or abnormally.

DOWNREPORT

Controls the frequency for reporting stopped processes.

LAGCRITICAL

Specifies a lag threshold that is considered critical and generates a warning to the error log.

LAGINFO

Specifies a lag threshold at which an informational message is reported to the error log.

LAGREPORT

Sets an interval for reporting lag time to the error log.


Table 3-6 Manager Parameters: Maintenance

Parameter Description

CHECKMINUTES

Determines how often Manager cycles through maintenance activities.

PURGEDDLHISTORY | PURGEDDLHISTORYALT

Purges rows from the Oracle DDL history table when they are no longer needed.

PURGEMARKERHISTORY

Purges Oracle marker table rows that are no longer needed.

PURGEOLDEXTRACTS for Extract and Replicat

Purges trail data that is no longer needed.

PURGEOLDTASKS

Purges Extract and Replicat tasks after a specified period of time.

STARTUPVALIDATIONDELAY[CSECS]

Sets a delay time after which Manager checks that processes are still running after startup.


3.1.3 Summary of Parameters Common to Extract and Replicat

These parameters are available for both the Extract and Replicat processes.

Table 3-7 Parameters Common to Extract and Replicat: General

Parameter Description

ALLOCFILES

Controls the incremental number of memory structures that are allocated after the initial memory allocation specified by the NUMFILES parameter is reached.

CHARSET

Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file.

CHECKPARAMS

Verifies parameter file syntax.

COMMENT | --

Denotes comments in a parameter file.

GETENV

Retrieves variables that were set with the SETENV parameter.

OBEY

Processes parameter statements contained in a different parameter file.

SETENV

Specifies a value for a UNIX environment variable from within the GGSCI interface.

TRACETABLE | NOTRACETABLE

Specifies a trace table to which Replicat adds a record whenever it updates the target database. Causes Extract to ignore database changes generated by Replicat. Supports Oracle bi-directional replication.

USERID

Specifies database connection information.

USERIDALIAS

Specifies database connection information when a credential store is in use.


Table 3-8 Parameters Common to Extract and Replicat: Selection, Converting, and Mapping Data

Parameter Description

ALLOWDUPTARGETMAP | NOALLOWDUPTARGETMAP

Allows the same source-target MAP statement to appear more than once in the parameter file.

ASCIITOEBCDIC

Converts ASCII text to EBCDIC for DB2 on z/OS systems running UNIX System Services.

CATALOGEXCLUDE

Excludes the specified source container or catalog from a wildcard specification.

COLMATCH

Establishes global column-mapping rules.

DDL

Enables and filters the capture of DDL operations.

DDLSUBST

Enables string substitution in DDL processing.

GETDELETES | IGNOREDELETES

Controls the extraction of delete operations.

GETINSERTS | IGNOREINSERTS

Controls the extraction of insert operations.

GETTRUNCATES | IGNORETRUNCATES

Controls the extraction of truncate statements.

GETUPDATEAFTERS | IGNOREUPDATEAFTERS

Controls the extraction of update after images.

GETUPDATEBEFORES | IGNOREUPDATEBEFORES

Controls the extraction of update before images.

GETUPDATES | IGNOREUPDATES

Controls the extraction of update operations.

NAMECCSID

Specifies a DB2 for i CCSID if the object names in the SQL catalog are of a different CCSID than the system.

REPLACEBADCHAR

Replaces invalid character values with another value.

SCHEMAEXCLUDE

Excludes the specified source schema from a wildcard specification.

SOURCEDEFS

Specifies a file that contains source data definitions created by the DEFGEN utility.

SOURCECATALOG

Specifies a default container or catalog for all following TABLE or MAP statements.

TRIMSPACES | NOTRIMSPACES

Controls whether trailing spaces are trimmed or not when mapping CHAR to VARCHAR columns.

VARWIDTHNCHAR | NOVARWIDTHNCHAR

Controls whether length information is written to the trail for NCHAR columns.

WILDCARDRESOLVE

Defines rules for processing wildcard table specifications in a TABLE statement.


Table 3-9 Parameters Common to Extract and Replicat: Custom Processing

Parameter Description

CUSEREXIT

Invokes a user exit routine during processing.

INCLUDE

Invokes a macro library.

MACRO

Defines an Oracle GoldenGate macro.

MACROCHAR

Defines a macro character other than the default of #.

SQLEXEC

Executes a stored procedure or query during Extract processing.


Table 3-10 Parameters Common to Extract and Replicat: Reporting

Parameter Description

CMDTRACE

Displays macro expansion steps in the report file.

LIST | NOLIST

Displays or suppresses the listing of macros in the report file.

REPORT

Schedules a statistical report.

STATOPTIONS

Specifies information to include in statistical displays.

REPORTCOUNT

Reports the number of records processed.

TRACE | TRACE2

Shows processing information to assist in revealing processing bottlenecks.


Table 3-11 Parameters common to Extract and Replicat: Tuning

Parameter Description

ALLOCFILES

Controls the number of incremental memory structures allocated when the value of NUMFILES is reached.

CACHEMGR

Manages virtual memory resources.

CHECKPOINTSECS

Controls how often the process writes a checkpoint.

DBOPTIONS

Specifies database options.

DDLOPTIONS

Specifies DDL processing options.

DYNAMICRESOLUTION | NODYNAMICRESOLUTION

Suppresses the metadata lookup for a table until Extract encounters transactional data for it. Makes Extract start faster when there are numerous tables specified for synchronization.

EOFDELAY | EOFDELAYCSECS

Determines how long the process delays before searching for more data to process in its data source.

FUNCTIONSTACKSIZE

Controls the size of the memory stack that is used for processing Oracle GoldenGate functions.

NUMFILES

Controls the initial allocation of memory dedicated to storing information about tables to be processed by Oracle GoldenGate.


Table 3-12 Parameters Common to Extract and Replicat: Error Handling

Parameter Description

DDLERROR

Controls error handling for DDL extraction.

DISCARDFILE | NODISCARDFILE

Contains records that could not be processed.


Table 3-13 Parameters Common to Extract and Replicat: Maintenance

Parameter Description

DISCARDROLLOVER

Controls how often to create a new discard file.

PURGEOLDEXTRACTS for Extract and Replicat

Purges obsolete trail files.

REPORTROLLOVER

Specifies when to create new report files.


3.1.4 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 3-14 Extract Parameters: General

Parameter Description

RECOVERYOPTIONS

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 3-15 Extract Parameters: Processing Method

Parameter Description

DSOPTIONS

Specifies Extract processing options when a Teradata Access Module (TAM) is being used.

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.

PASSTHRU | NOPASSTHRU

Controls whether tables will be processed by a data-pump Extract in pass-through mode or whether data definitions will be required.

PASSTHRUMESSAGES | NOPASSTHRUMESSAGES

Controls whether or not Extract writes messages for tables that are being processed in pass-through mode to the Extract report file

RMTTASK

Creates a processing task on a remote system.

SOURCEISTABLE

Extracts entire records from source tables.

VAM

Indicates that a Teradata Access Module (TAM) is being used to provide transactional data to the Extract process.


Table 3-16 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.

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 | NOLOGALLSUPCOLS

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 3-17 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 3-18 Extract Parameters: Formatting Data

Parameter Description

FORMATASCII

Formats extracted data in external ASCII format.

FORMATSQL

Formats extracted data into equivalent SQL statements.

FORMATXML

Formats extracted data into equivalent XML syntax.

NOHEADERS

Prevents record headers from being written to the trail.


Table 3-19 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.

THREADOPTIONS

Controls aspects of the way that Extract operates in an Oracle Real Application Cluster environment.

TRANLOGOPTIONS

Supplies capture processing options.

TRANSMEMORY

Controls the amount of memory and temporary disk space available for caching uncommitted transaction data.

WARNLONGTRANS

Defines a long-running transaction and controls the frequency of checking for and reporting them.


Table 3-20 Extract Parameters: Maintenance

Parameter Description

ROLLOVER

Specifies the way that trail files are aged.


Table 3-21 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.


3.1.5 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.

Table 3-22 Replicat Parameters: General

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.


Table 3-23 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.

GENLOADFILES

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.


Table 3-24 Replicat Parameters: Selecting, Converting, and Mapping Data

Parameter Description

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.

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.

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.

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.

UPDATEDELETES | NOUPDATEDELETES

Converts inserts to updates.

USEDEDICATEDCOORDINATIONTHREAD

Specifies a dedicated thread for barrier transactions when Replicat is in coordinated mode.


Table 3-25 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.


Table 3-26 Replicat Parameters: Error Handling and Reporting

Parameter Description

HANDLECOLLISIONS | NOHANDLECOLLISIONS

Handles errors for duplicate and missing records.

HANDLETPKUPDATE

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.


Table 3-27 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.

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.

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.

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.


3.1.6 Summary of Wildcard Exclusion Parameters

Table 3-28 Wildcard Exclusion Parameters

Parameter Description

EXCLUDEWILDCARDOBJECTSONLY

Forces the inclusion of non-wildcarded source objects specified in TABLE or MAP parameters when an exclusion parameter contains a wildcard that otherwise would exclude that object.

MAPEXCLUDE

Excludes a source object from a MAP statement.

TABLEEXCLUDE

Excludes a source object from a TABLE statement.

CATALOGEXCLUDE

Excludes source objects in the specified source container or catalog from the Oracle GoldenGate configuration when the container or catalog name is being specified with a wildcard in TABLE or MAP statements.

SCHEMAEXCLUDE

Excludes source objects that are owned by the specified source owner (such as a schema) from the Oracle GoldenGate configuration when wildcards are being used to specify the owners in TABLE or MAP statements.


3.1.7 Summary of DEFGEN Parameters

DEFGEN creates a file with data definitions for source or target tables. Data definitions are needed when the source and target tables have different definitions or the databases are of different types.

Table 3-29 All DEFGEN Parameters

Parameter Description

CATALOGEXCLUDE

Excludes the specified source container or catalog from a wildcard specification.

CHARSET

Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file.

DEFSFILE

Identifies the name of the file to which DEFGEN writes the definitions

NAMECCSID

Specifies a DB2 for i CCSID if the object names in the SQL catalog are of a different CCSID than the system.

NOCATALOG

Prevents the container or catalog name from being included in the metadata.

SCHEMAEXCLUDE

Excludes the specified source schema from a wildcard specification.

SOURCEDB

Specifies the data source as part of the login information.

TABLE for DEFGEN

Identifies a table for which you want to capture a definition.

USERIDALIAS

Specifies database connection information.


3.1.8 Summary of DDL Parameters

These parameters control Oracle GoldenGate DDL support. Other parameters may be required with DDL support, but the ones here deal specifically with the DDL feature.

Table 3-30 All DDL Parameters

Parameter Description

DDL

Enables DDL support and filters DDL.

DDLERROR

Handles errors that occur during DDL replication.

DDLOPTIONS

Configures aspects of DDL replication other than filtering and string substitution.

DDLSUBST

Enables the substitution of strings in DDL operations.

DDLTABLE

Specifies an alternate name for the DDL history table.

GGSCHEMA

Specifies the name of the schema that contains the objects that support DDL replication.

PURGEDDLHISTORY | PURGEDDLHISTORYALT

Controls the size of the DDL history table.

PURGEMARKERHISTORY

Controls the size of the DDL marker table.