EXTTRAIL

Valid For

Extract

Description

Use the EXTTRAIL parameter to specify a trail on the local system that was created with the ADD EXTTRAIL command. The trail is read by an Extract Pump group, or by a Replicat group on the local system.

EXTTRAIL must precede all associated TABLE statements. Multiple EXTTRAIL statements can be used to define different trails.

Do not use EXTTRAIL for an Extract that is configured in PASSIVE mode. See the Administering Oracle GoldenGate guide for more information about PASSIVE mode, an Oracle GoldenGate security feature.

From Oracle GoldenGate 19c (19.1.0) onward, the primary Extract writes trail file in the same format as existing trail file format when you upgrade, unless you explicitly specify the trail file format version using the FORMAT RELEASE option. This prevents subsequent Replicats from abending if they are not upgraded.

You can encrypt the data in this trail by using the ENCRYPTTRAIL parameter. See "ENCRYPTTRAIL | NOENCRYPTTRAIL" for more information.

Default

None

Syntax

EXTTRAIL file_name
[, FORMAT RELEASE major.minor]
[, OBJECTDEFS | NO_OBJECTDEFS]
[, TRAILBYTEORDER {BIGENDIAN | LITTLEENDIAN | NATIVEENDIAN}]

file_name

The relative or fully qualified name of the trail. Use a maximum of two characters for the name. As trail files are aged, a nine-character sequence number will be added to this name, for example /ogg/dirdat/rt000000001.

FORMAT RELEASEmajor.minor

Not valid for an Extract Pump. Specifies the metadata format of the data that is sent by Extract to a trail, a file, or (if a remote task) to another process. The metadata tells the reader process whether the data records are of a version that it supports. The metadata format depends on the version of the Oracle GoldenGate process. Older Oracle GoldenGate versions contain different metadata than newer ones.

FORMAT RELEASE specifies an Oracle GoldenGate release version. major is the major version number, and minor is the minor version number. The X.x must reflect a current or earlier, generally available (GA) release of Oracle GoldenGate. Valid values are 11.1 through the current Oracle GoldenGate X.x version number, for example 11.2 or 12.1.

The release version is programmatically mapped back to the appropriate trail format compatibility level. The default is the current version of the process that writes to this trail.

Note:

RELEASE versions earlier than 12.1 do not support three-part object names.

Note:

If using multiple trails in a single Extract, only RELEASE versions that are the same can coexist.

The following settings are supported for Oracle Database 12.2 and higher:

For Oracle Database 12.2 non-CDB or higher with compatibility set to 12.1, FORMAT RELEASE 12.2 or above is supported.
For Oracle Database 12.2 non-CDB or higher with compatibility set to 12.2, FORMAT RELEASE 12.2 or above is supported.
For Oracle Database 12.2 CDB/PDB or higher with compatibility set to 12.2, only FORMAT RELEASE values 12.3 or higher are supported. This is due to the use of local undo for PDBs, which requires augmenting the transaction ID with the PDB number to ensure uniqueness of trx IDs.

OBJECTDEFS | NO_OBJECTDEFS

Use the OBJECTDEFS and NO_OBJECTDEFS options to control whether or not to include the object definitions in the trail. These two options are applicable only when the output trail is formatted in Oracle GoldenGate canonical format and the trail format release is greater than 12.1. Otherwise, both options are ignored because no metadata record will be added to the trail.

TRAILBYTEORDER {BIGENDIAN | LITTLEENDIAN | NATIVEENDIAN}

Not valid for an Extract Pump. Sets the byte format of the metadata in the trail records. This parameter does not affect the column data. Valid only for trails that have a FORMAT RELEASE version of at least 12.1. Valid values are BIGENDIAN (big endian), LITTLEENDIAN (little endian), and NATIVEENDIAN (default of the local system). The default is BIGENDIAN. See the GLOBALS version of TRAILBYTEORDER for additional usage instructions.

Examples

Example 1

EXTTRAIL dirdat/ny

Example 2

EXTTRAIL /ggs/dirdat/ex, FORMAT RELEASE 18.1

Example 3

Two trail formats within the same sets of tables being captured:

EXTTRAIL ./dirdat/ea
TABLE hr.tab1 
TABLE hr.tab2 
EXTTRAIL ./dirdat/eb
TABLE scott.tab3 
TABLE scott.tab4