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 a Distribution Path, or by a Replicat on the local system.

EXTTRAIL must precede all associated TABLE statements. Multiple EXTTRAIL statements can be used to define different trails for an Extract, except for a MySQL Extract when using GTID set positioning as only one trail is supported.

Beginning with Oracle GoldenGate 19c, the primary Extract writes trail files in the same format as the existing trail files format during an 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.

Note:

When using the ENCRYPTRAIL parameter with the EXTTRAIL parameter, ensure that the ENCRYPTRAIL parameter is mentioned before EXTTRAIL, else the trail will not be encrypted.

Note:

Local trails that are to be consumed by a Distribution Path sending to NSK, you must use TRAILBYTEORDER BIGENDIAN. This cannot be altered in the data pump.

Default

None

Syntax

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

trail_name

The relative or fully qualified path name of the trail. The trail name can contain only two characters.

Note:

In Microservices Architecture, the trail file name two-character prefix must start with an alphabet only.

Oracle GoldenGate appends this name with a nine-digit sequence number whenever a new file is created. For example, a trail named /tr would have files named /tr000000001, /tr000000002.

FORMAT RELEASE major.minor

Valid for an Extract. 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 major.minor values must reflect a current or earlier, generally available (GA) release of Oracle GoldenGate. Valid values are 11.2, 12.1, 12.2, 12.3, 18.1, 19.1 and the default is 19.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.

TRAILBYTEORDER {BIGENDIAN | LITTLEENDIAN | NATIVEENDIAN}

Sets the byte format of the trail files. 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. The default is NATIVEENDIAN. See the GLOBALS version of TRAILBYTEORDER for additional usage instructions.

Examples

Example 1   

EXTTRAIL ny

Example 2   

EXTTRAIL trails/ny, FORMAT RELEASE 12.3

Example 3   

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

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