RMTFILE

Valid For

Extract

Description

Use the RMTFILE parameter to define the name of an extract file on a remote system to which extracted data will be written. Use this parameter for initial-load configurations. For online change synchronization, use the RMTTRAIL parameter.

The size of an extract file cannot exceed 2GB .

RMTFILE must be preceded by a RMTHOST statement, and it must precede any TABLE statements.

RMTFILE is deprecated and ignored for Data Pump.

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

Default

None

Syntax

RMTFILE file_name
[, APPEND]
[, PURGE]
[, MEGABYTES megabytes]
[, FORMAT RELEASE major.minor]
[, OBJECTDEFS | NO_OBJECTDEFS]
[, TRAILBYTEORDER {BIGENDIAN | LITTLEENDIAN | NATIVEENDIAN}]

file_name

The relative or fully qualified name of the file.

APPEND

Adds the current data to existing data in the file. If you use APPEND, do not use PURGE.

PURGE

Deletes an existing file before creating a new one. If you use PURGE, do not use APPEND.

MEGABYTES megabytes

Valid for Extract. The maximum size, in megabytes, of a file in the trail. The default is 2000.

FORMAT RELEASE major.minor

Specifies the metadata format of the data that is sent by Extract to the file. 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 is a required keyword.
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 9.0 through the current Oracle GoldenGate X.x version number, for example 11.2 or 12.1. (If you use an Oracle GoldenGate version that is earlier than 9.0, specify either 9.0 or 9.5.)

The release version is programmatically mapped back to an appropriate internal compatibility level. The default is the current version of the process that writes to this trail. Note that RELEASE versions earlier than 12.1 do not support three-part object names.

There is a dependency between FORMAT and the RECOVERYOPTIONS parameter. When RECOVERYOPTIONS is set to APPENDMODE, FORMAT must be set to RELEASE 10.0 or greater. When RECOVERYOPTIONS is set to OVERWRITEMODE, FORMAT must be set to RELEASE 9.5 or less.

The following settings are supported in Oracle Database 12.2:

For Oracle Database 12.2 non-CDB with compatibility set to 12.1, FORMAT RELEASE 12.2 or above is supported.
For Oracle Database 12.2 non-CDB with compatibility set to 12.2, FORMAT RELEASE 12.2 or above is supported.
For Oracle Database 12.2 CDB/PDB with compatibility set to 12.2, only FORMAT RELEASE 12.3 is 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.

When replicating from an Open Systems database to NonStop, specify format version below 12.2 to avoid including the object definitions in the trail since NonStop does not support processing object definitions from the trail.

TRAILBYTEORDER {BIGENDIAN | LITTLEENDIAN | NATIVEENDIAN}

Sets the byte format of the metadata in the file records. This parameter does not affect the column data. Valid only for files 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

RMTFILE /ggs/dirdat/salesny, MEGABYTES 2, PURGE

Example 2

RMTFILE /ggs/dirdat/salesny, MEGABYTES 2, FORMAT RELEASE 10.4