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.
This section summarizes the Oracle GoldenGate parameters by module and purpose and includes the following topics:
Section 3.1.3, "Summary of Parameters Common to Extract and Replicat"
Section 3.1.3, "Summary of Parameters Common to Extract and Replicat"
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 |
---|---|
Specifies the byte order (endianness) of a file created with the |
|
Specifies that the character mapping file overrides the character code point mapping. |
|
Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file. |
|
Specifies a default checkpoint table. |
|
Specifies the location of the Oracle GoldenGate credential store that stores login credentials. |
|
Specifies a non-default name for the DDL history table that supports DDL synchronization for Oracle. |
|
Enables support for three-part names for SQL/MX databases. |
|
Enables Oracle GoldenGate Monitor to view and monitor Oracle GoldenGate instances. |
|
Includes non-wildcarded source tables when a |
|
Specifies the name of the schema that contains the database objects that support DDL synchronization for Oracle. |
|
Specifies a non-default name for the DDL marker table that supports DDL synchronization for Oracle. |
|
Specifies the maximum number of process groups that can run in an instance of Oracle GoldenGate. |
|
Specifies the name of the Manager process when it is installed as a Windows service. |
|
Specifies a DB2 for i CCSID if the object names in the SQL catalog are of a different CCSID than the system. |
|
Prevents the automatic suppression of duplicate informational and warning messages. |
|
Specifies a umask that can be used by Oracle GoldenGate processes to create trail files and discard files. |
|
Enables SQL-92 rules for quoted object names and literals. |
|
Filters the types of Oracle GoldenGate messages that are written to the system logs. |
|
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. |
|
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. |
|
Forces Oracle GoldenGate to use IPv4 for TCP/IP connections. |
|
Forces Oracle GoldenGate to use IPv6 for TCP/IP connections. |
|
Specifies the location of the master key wallet. |
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 |
---|---|
Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file. |
|
Allows insertion of comments in a parameter file. |
|
Specifies a data source name as part of the login information. |
|
Provides login information for Manager when it needs to access the database. |
|
Filters the types of Oracle GoldenGate messages that are written to the system logs on a Windows or UNIX system or to the |
Table 3-3 Manager Parameters: Port Management
Parameter | Description |
---|---|
Specifies the ports that Collector can dynamically allocate. |
|
Establishes the TCP/IP port number on which Manager listens for requests. |
Table 3-4 Manager Parameters: Process Management
Parameter | Description |
---|---|
Specifies processes to be restarted by Manager after a failure. |
|
Specifies processes to be started when Manager starts. |
|
Determines how long after system boot time Manager delays until performing main processing activities. This parameter supports Windows. |
|
Determines how often process heartbeat messages are reported. |
Table 3-5 Manager Parameters: Event Management
Parameter | Description |
---|---|
Reports processes that stopped gracefully or abnormally. |
|
Controls the frequency for reporting stopped processes. |
|
Specifies a lag threshold that is considered critical and generates a warning to the error log. |
|
Specifies a lag threshold at which an informational message is reported to the error log. |
|
Sets an interval for reporting lag time to the error log. |
Table 3-6 Manager Parameters: Maintenance
Parameter | Description |
---|---|
Determines how often Manager cycles through maintenance activities. |
|
Purges rows from the Oracle DDL history table when they are no longer needed. |
|
Purges Oracle marker table rows that are no longer needed. |
|
Purges trail data that is no longer needed. |
|
Purges Extract and Replicat tasks after a specified period of time. |
|
Sets a delay time after which Manager checks that processes are still running after startup. |
These parameters are available for both the Extract and Replicat processes.
Table 3-7 Parameters Common to Extract and Replicat: General
Parameter | Description |
---|---|
Controls the incremental number of memory structures that are allocated after the initial memory allocation specified by the |
|
Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file. |
|
Verifies parameter file syntax. |
|
Denotes comments in a parameter file. |
|
Retrieves variables that were set with the |
|
Processes parameter statements contained in a different parameter file. |
|
Specifies a value for a UNIX environment variable from within the GGSCI interface. |
|
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. |
|
Specifies database connection information. |
|
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 |
---|---|
Allows the same source-target |
|
Converts ASCII text to EBCDIC for DB2 on z/OS systems running UNIX System Services. |
|
Excludes the specified source container or catalog from a wildcard specification. |
|
Establishes global column-mapping rules. |
|
Enables and filters the capture of DDL operations. |
|
Enables string substitution in DDL processing. |
|
Controls the extraction of delete operations. |
|
Controls the extraction of insert operations. |
|
Controls the extraction of truncate statements. |
|
Controls the extraction of update after images. |
|
Controls the extraction of update before images. |
|
Controls the extraction of update operations. |
|
Specifies a DB2 for i CCSID if the object names in the SQL catalog are of a different CCSID than the system. |
|
Replaces invalid character values with another value. |
|
Excludes the specified source schema from a wildcard specification. |
|
Specifies a file that contains source data definitions created by the |
|
Specifies a default container or catalog for all following |
|
Controls whether trailing spaces are trimmed or not when mapping |
|
Controls whether length information is written to the trail for |
|
Defines rules for processing wildcard table specifications in a |
Table 3-9 Parameters Common to Extract and Replicat: Custom Processing
Parameter | Description |
---|---|
Invokes a user exit routine during processing. |
|
Invokes a macro library. |
|
Defines an Oracle GoldenGate macro. |
|
Defines a macro character other than the default of #. |
|
Executes a stored procedure or query during Extract processing. |
Table 3-10 Parameters Common to Extract and Replicat: Reporting
Parameter | Description |
---|---|
Displays macro expansion steps in the report file. |
|
Displays or suppresses the listing of macros in the report file. |
|
Schedules a statistical report. |
|
Specifies information to include in statistical displays. |
|
Reports the number of records processed. |
|
Shows processing information to assist in revealing processing bottlenecks. |
Table 3-11 Parameters common to Extract and Replicat: Tuning
Parameter | Description |
---|---|
Controls the number of incremental memory structures allocated when the value of |
|
Manages virtual memory resources. |
|
Controls how often the process writes a checkpoint. |
|
Specifies database options. |
|
Specifies DDL processing options. |
|
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. |
|
Determines how long the process delays before searching for more data to process in its data source. |
|
Controls the size of the memory stack that is used for processing Oracle GoldenGate functions. |
|
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 |
---|---|
Controls error handling for DDL extraction. |
|
Contains records that could not be processed. |
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 |
---|---|
Controls the recovery mode of the Extract process. |
|
Specifies the data source as part of the login information. |
|
Adjusts timestamps of records transferred to other systems when those systems reflect different times. |
|
Controls whether before and after images are stored in one trail record or two. |
Table 3-15 Extract Parameters: Processing Method
Parameter | Description |
---|---|
Specifies Extract processing options when a Teradata Access Module (TAM) is being used. |
|
Defines an Extract group as an online process. |
|
Controls whether or not operations from all processes except Replicat are written to a trail or file. |
|
Controls whether or not replicated operations are captured by an Extract on the same system. |
|
Controls whether tables will be processed by a data-pump Extract in pass-through mode or whether data definitions will be required. |
|
Controls whether or not Extract writes messages for tables that are being processed in pass-through mode to the Extract report file |
|
Creates a processing task on a remote system. |
|
Extracts entire records from source tables. |
|
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 |
---|---|
Controls whether Oracle GoldenGate writes only the key or all columns to the trail for delete operations. |
|
Causes only primary key columns and changed columns to be logged for updates. |
|
Specifies Replicat or data pump changes to be excluded from trail files. |
|
Controls certain aspects of the way that Oracle GoldenGate fetches data. |
|
Logs the columns that are required to support Conflict Detection and Resolution and Integrated Replicat. |
|
Specifies sequences for synchronization. |
|
Specifies tables for extraction and controls column mapping and conversion. |
|
Excludes source tables from the extraction process. |
|
Specifies a file containing target table definitions for target databases that reside on the NonStop platform. |
|
Specifies the ASCII character set for data captured from DB2 on z/OS, when both ASCII and EBCDIC tables are present. |
|
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 |
---|---|
Specifies an extract file to which extracted data is written on the local system. |
|
Specifies a trail to which extracted data is written on the local system. |
|
Specifies an extract file to which extracted data is written on a remote system. |
|
Specifies the target system and Manager port number. |
|
Specifies a trail to which extracted data is written on a remote system. |
Table 3-18 Extract Parameters: Formatting Data
Parameter | Description |
---|---|
Formats extracted data in external ASCII format. |
|
Formats extracted data into equivalent SQL statements. |
|
Formats extracted data into equivalent XML syntax. |
|
Prevents record headers from being written to the trail. |
Table 3-19 Extract Parameters: Tuning
Parameter | Description |
---|---|
Controls the Bounded Recovery feature of Extract. |
|
Controls the virtual memory cache manager. |
|
Determines the amount of time that record data remains buffered before being written to the trail. |
|
Controls the amount of memory and temporary disk space available for caching transactions that contain |
|
Specifies connection attributes other than host information for a TCP/IP connection used by a passive Extract group. |
|
Controls aspects of the way that Extract operates in an Oracle Real Application Cluster environment. |
|
Supplies capture processing options. |
|
Controls the amount of memory and temporary disk space available for caching uncommitted transaction data. |
|
Defines a long-running transaction and controls the frequency of checking for and reporting them. |
Table 3-20 Extract Parameters: Maintenance
Parameter | Description |
---|---|
Specifies the way that trail files are aged. |
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 |
---|---|
Specifies the data source as part of the login information. |
|
Causes Replicat to connect in UTF-8 to prevent data loss when the record being processed is a user-defined type that has an |
Table 3-23 Replicat Parameters: Processing Method
Parameter | Description |
---|---|
Specifies a starting point for Replicat processing. Required when |
|
Loads data directly into the interface of the Oracle SQL*Loader utility. |
|
Specifies a stopping point for Replicat processing. Required when using |
|
Generates run and control files that are compatible with a database load utility. |
|
Specifies a Replicat group for online change synchronization. |
|
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 |
---|---|
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. |
|
Force a no-op update to be applied using all columns in both the |
|
Assumes that source and target tables have the same column structure. |
|
Inserts a new record into the target table for every change operation made to a record. |
|
Converts deletes to inserts. |
|
Converts an update to an insert when the target row does not exist. |
|
Converts updates to inserts. |
|
Specifies a relationship between one or more source and target tables and controls column mapping and conversion. |
|
Excludes source tables from being processed by a wildcard specification supplied in |
|
Overrides the default Replicat session time zone. |
|
Specifies a global substitution value for invalid numeric data encountered when mapping number columns. |
|
Controls whether the source character set it converted to the target character set. |
|
Specifies the time zone of the source database for Replicat to use as the session time zone. |
|
Controls whether or not a target column containing only spaces is converted to NULL. |
|
Specifies a table or tables for which event actions are to take place when a row satisfies the given filter criteria. |
|
Converts insert operations to update operations for all |
|
Converts deletes to updates. |
|
Converts inserts to updates. |
|
Specifies a dedicated thread for barrier transactions when Replicat is in coordinated mode. |
Table 3-25 Replicat Parameters: Routing Data
Parameter | Description |
---|---|
Defines the name of an extract file on the local system that contains data to be replicated. Used for one-time processing. |
|
Defines a trail containing data to be replicated. Used for one-time processing. |
Table 3-26 Replicat Parameters: Error Handling and Reporting
Parameter | Description |
---|---|
Handles errors for duplicate and missing records. |
|
Prevents constraint errors associated with replicating transient primary key updates. |
|
Overlays a replicated insert record onto an existing target record whenever a duplicate-record error occurs. |
|
Controls whether or not Replicat applies |
|
Determines how Replicat responds to database errors. |
|
Determines how Replicat responds to operations for which a fetch from the source database was required. |
|
Causes Replicat to print its SQL statements to the report file. |
|
Specifies the database error number that indicates a duplicate record. Use with |
|
Determines how often database errors are reported. |
Table 3-27 Replicat Parameters: Tuning
Parameter | Description |
---|---|
Increases the throughput of Replicat processing by arranging similar SQL statements into arrays and applying them at an accelerated rate. |
|
The interval at which the coordinator thread sends a request to the apply threads for statistics. |
|
The amount of time that the coordinator thread waits for the apply threads to start. |
|
Specifies a length of time for Replicat to wait before applying replicated operations to the target database. |
|
Controls the number of records that are grouped into a Replicat transaction. |
|
Controls whether or not Replicat uses an |
|
Limits the number of discarded records reported to the discard file. |
|
Controls the number of prepared SQL statements that can be used by Replicat. |
|
Divides large source transactions into smaller ones on the target system. |
|
Controls the initial allocation of memory that is dedicated to storing information about tables to be processed by Oracle GoldenGate. |
|
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. |
Table 3-28 Wildcard Exclusion Parameters
Parameter | Description |
---|---|
Forces the inclusion of non-wildcarded source objects specified in |
|
Excludes a source object from a |
|
Excludes a source object from a |
|
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 |
|
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 |
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 |
---|---|
Excludes the specified source container or catalog from a wildcard specification. |
|
Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file. |
|
Identifies the name of the file to which |
|
Specifies a DB2 for i CCSID if the object names in the SQL catalog are of a different CCSID than the system. |
|
Prevents the container or catalog name from being included in the metadata. |
|
Excludes the specified source schema from a wildcard specification. |
|
Specifies the data source as part of the login information. |
|
Identifies a table for which you want to capture a definition. |
|
Specifies database connection information. |
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.
Parameter | Description |
---|---|
Enables DDL support and filters DDL. |
|
Handles errors that occur during DDL replication. |
|
Configures aspects of DDL replication other than filtering and string substitution. |
|
Enables the substitution of strings in DDL operations. |
|
Specifies an alternate name for the DDL history table. |
|
Specifies the name of the schema that contains the objects that support DDL replication. |
|
Controls the size of the DDL history table. |
|
Controls the size of the DDL marker table. |