2.23 FILEHEADER

Use FILEHEADER to display the contents of the header of the currently open trail file.

The file header is stored as a record at the beginning of a trail file preceding the data records. The information that is stored in the trail header provides enough information about the records to enable an Oracle GoldenGate process to determine whether the records are in a format that the current version of Oracle GoldenGate supports.

The trail header fields are stored as tokens, where the token format remains the same across all versions of Oracle GoldenGate. If a version of Oracle GoldenGate does not support any given token, that token is ignored. Deprecated tokens are assigned a default value to preserve compatibility with previous versions of Oracle GoldenGate.

The current FILEHEADER command applies globally to the Logdump session, until a different FILEHEADER command is issued.

To View the File Header

To view the file header:

  1. Position to the beginning of the trail file with the following Logdump command.

    pos 0
    
  2. Issue the following Logdump command to see the first record of the file, the one that contains the file header.

    next
    

To Retrieve the File Header Tokens

To retrieve file header values as input parameters, use the @GETENV function with the GGFILEHEADER option. See Reference for Oracle GoldenGate for Windows and UNIX.

Note:

The Logdump command HEADERTOKEN also shows trail tokens, but it shows a brief summary of each one. FILEHEADER shows actual token values.


Table 2-8 File Header Tokens

Token/subtoken Data Type Description

Signature

UINT32

Internal use.

Compatibility

UINT16

The version of the trail. The compatibility level of the software must be greater than, or equal to, that of the trail file for a process to be able to read the trail file.

Current valid values are 0 to 5.

CharSet

INT32

The global character set of the trail file, as defined in the parameter file or the default value. For example:

WCP1252-1

-3 indicates the system default.

CreationTime

Timestamp

The time that the trail file was created, in local GMT Julian time, INT 64.

URI

String

The universal resource identifier of the process that created the trail file, in the format of:

host_name:dir:[:dir][:dir_n]group_name

Where:

  • host_name is the name of the server that hosts the process

  • dir is a subdirectory of the installation path.

  • group_name is the name of the process group that is linked with the process.

Example:

sys1:home:oracle:v9.5:extora

Shows where the trail was processed and by which process. This includes a history of previous runs.

URIHistory

String array

List of the URIs of processes that wrote to the trail file before the current process.

  • For a primary Extract, this field is empty.

  • For a data pump, this field is URIHistory + URI of the input trail file.

FileName

String

Name of the trail file. Can be absolute or relative path, with forward or backward slash depending on the file system.

MultiPart

Boolean

True/False flag indicating whether the trail file is a single file (such as one created for a batch run) or a sequentially numbered file that is part of a trail for online, continuous processing. If False, the SeqNum subtoken is not valid.

SeqNum

UINT32

The sequence number of the file in the trail, if MultiPart is true. Invalid if multipart is false. The value is the numerical sequence number, without any zero padding.

FileSize

UINT64

Size of the trail file. Value is NULL until the trail file is completed. Non-NULL values are in bytes.

FirstRecordCSN

CSN

The commit sequence number (CSN) of the first record in the trail file.Value is NULL until the trail file is completed.

LastRecordCSN

CSN

The commit sequence number (CSN) of the last record in the trail file.Value is NULL until the trail file is completed.

FirstRecordIOTime

Timestamp

The time that the first record in the trail file was written.Value is NULL until the trail file is completed.

LastRecordIOTime

Timestamp

The time that the last record in the trail file was written.Value is NULL until the trail file is completed.

SysName

String

The name of the operating system, for example:

SunOS

Linux

Microsoft Windows

NodeName

String

The name of the machine, for example sys1.

Release

String

The release level of the operating system, for example:

5.10

2.6.9-11.ELsmp

Version

String

The version of the operating system, for example:

s10_69

#1 SMP Fri Feb 24 16:56:28 EST 2006

Hardware

String

The hardware type of the processor, for example:

sun4u

x86_64

x86

Vendor

UINT16

The name of the database vendor. Some (but not all) examples are:

DB2 ZOS
CTREE
MSSQL
MYSQL
ORACLE
SQLMX
SYBASE
TERADATA
TIMESTEN
NONSTOP
ENSCRIBE

Name

String

The name of the database, for example findb.

Instance

String

The name of the database instance, if applicable to the database type, for example ORA1022A.

Charset

INT32

The character set of the database. Currently, the valid value is -1 (unknown). (For some databases, this will be empty.)

MajorVersion

UINT16

The major version of the database.

MinorVersion

UINT16

The minor version of the database.

VerString

String

The maintenance (patch) level of the database.

ClientCharset

INT32

The character set of the database client. Currently, the valid value is -1 (unknown). (For some databases, this will be empty.)

ClientVerString

String

The maintenance (patch) level of the database client. (For some databases, this will be empty.)

Name

String

The group name that is associated with the process.

DataSource

UINT16

The data source that was read by the process. Can be one of:

  • DS_EXTRACT_TRAILS (source was an extract file, populated with change data)

  • DS_LOG_TABLE (source was an log table, used for trigger-based extraction)

  • DS_DATABASE (source was a direct select from database table written to a trail, used for SOURCEISTABLE-driven initial load)

  • DS_TRAN_LOGS (source was the database transaction log)

  • DS_INITIAL_DATA_LOAD (source was Extract; data taken directly from source tables)

  • DS_VAM_EXTRACT (source was a vendor access module)

  • DS_VAM_TWO_PHASE_COMMIT (source was a VAM trail)

MajorVersion

UINT16

The major version of the process (xx).

MinorVersion

UINT16

The minor version of the process (xx.xx).

MaintenanceLevel

UINT16

The maintenance version of the process (xx.xx.xx).

PatchLevel

UINT16

The patch version of the process (xx.xx.xx.xx).

BuildNumber

UINT16

The build number of the process.

VerString

String

The version string of the process. For example:

11.1.1.17A not for production

RecoveryMode

UINT16

Internal use

LastCompletedCSN

CSN

Internal use

LastCompletedXids

Xid

Internal use

LastSCN

CSN

Internal use

LastXid

Xid

Internal use


Default

OFF

Syntax

FILEHEADER {ON | OFF | DETAIL}
ON

Enables the display of the file header, showing the main header tokens.

OFF

Disables the display of the file header.

DETAIL

Provides detailed information that includes the sub-tokens.

Examples

Example 1   
FILEHEADER ON
TokenID x46 'F' Record Header    Info x00  Length  587
TokenID x30 '0' TrailInfo        Info x00  Length  303
TokenID x31 '1' MachineInfo      Info x00  Length  103
TokenID x32 '2' DatabaseInfo     Info x00  Length   88
TokenID x33 '3' ProducerInfo     Info x00  Length   85
TokenID x34 '4' ContinunityInfo  Info x00  Length    4
TokenID x5a 'Z' Record Trailer   Info x00  Length  587
2011/1/18 13:39:18.951.346 FileHeader           Len   587 RBA 0
Name: *FileHeader*
 3000 012f 3000 0008 660d 0a71 3100 0006 0001 3200 | 0../0...f..q1.....2.
 0008 0000 0016 3300 000c 02f1 7834 eac7 7f3f 3400 | ......3.....x4...?4.
 0037 0031 7572 693a 7465 6c6c 7572 6961 6e3a 3a68 | .7.1uri:tellurian::h
 6f6d 653a 6d63 6361 7267 6172 3a67 6773 3a67 6773 | ome:mccargar:ggs:ggs
 4f72 6163 6c65 3a73 6f75 7263 6536 0000 1700 112e | Oracle:source6......
 2f64 6972 6461 742f 6572 3030 3030 3030 3700 0005 | /dirdat/er0000007...
 0138 0000 0800 01e2 4039 0000 0c00 0000 0000 001d | .8......@9..........


GroupID x30 '0' TrailInfo        Info x00  Length  303
 3000 012f 3000 0008 660d 0a71 3100 0006 0001 3200 | 0../0...f..q1.....2.
 0008 0000 0016 3300 000c 02f1 7834 eac7 7f3f 3400 | ......3.....x4...?4.
 0037 0031 7572 693a 7465 6c6c 7572 6961 6e3a 3a68 | .7.1uri:tellurian::h
 6f6d 653a 6d63 6361 7267 6172 3a67 6773 3a67 6773 | ome:mccargar:ggs:ggs
 4f72 6163 6c65 3a73 6f75 7263 6536 0000 1700 112e | Oracle:source6......
 2f64 6972 6461 742f 6572 3030 3030 3030 3700 0005 | /dirdat/er0000007...
 0138 0000 0800 01e2 4039 0000 0c00 0000 0000 001d | .8......@9..........
 a33b 0000 450a 3634 3136 3138 3936 3932 0000 0000 | .;..E.6416189692....
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 3aff 0045 0000 0000 0000 | ..........:..E......
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 0000 0000 0000 0000 003d | ...................=
 0000 0c02 f178 34eb 556a 403c ff00 0c00 0000 0000 | .....x4.Uj@<........
 0000 00                                           | ...

GroupID x31 '1' MachineInfo      Info x00  Length  103
 3100 0067 3000 000b 0005 4c69 6e75 7831 0000 0f00 | 1..g0.....Linux1....
 0974 656c 6c75 7269 616e 3200 0014 000e 322e 362e | .tellurian2.....2.6.
 392d 3131 2e45 4c73 6d70 3300 0029 0023 2331 2053 | 9-11.ELsmp3..).##1 S
 4d50 2046 7269 204d 6179 2032 3020 3138 3a32 353a | MP Fri May 2018:25:
 3330 2045 4454 2032 3030 3534 0000 0c00 0678 3836 | 30 EDT 20054.....x86
 5f36 34                                           | _64

GroupID x32 '2' DatabaseInfo     Info x00  Length   88
 3200 0058 3000 0006 0007 3100 000e 0008 4f52 4131 | 2..X0.....1.....ORA1
 3032 3241 3200 000e 0008 6f72 6131 3032 3261 3300 | 022A2.....ora1022a3.
 0008 ffff ffff 3400 0006 0000 3500 0006 0000 3600 | ......4.....5.....6.
 0006 0000 3700 0008 ffff ffff 3800 0010 000a 3130 | ....7.......8.....10
 2e32 2e30 2e32 2e30                               | .2.0.2.0

GroupID x33 '3' ProducerInfo     Info x00  Length   85
 3300 0055 3000 000a 0004 4546 4152 3100 0006 0003 | 3..U0.....EFAR1.....
 3200 0006 0000 3300 0006 0000 3400 0006 0000 3500 | 2.....3.....4.....5.
 0006 0000 3600 0006 0017 3700 0023 001d 5665 7273 | ....6.....7..#..Vers
 696f 6e20 5374 2e20 416e 6472 6577 7320 4275 696c | ion St. Andrews Buil
 6420 3032 33                                      | d 023

GroupID x34 '4' ContinunityInfo  Info x00  Length    4
 3400 0004                                         | 4...
Example 2   
FILEHEADER DETAIL
TokenID x46 'F' Record Header    Info x00  Length  587
TokenID x30 '0' TrailInfo        Info x00  Length  303
TokenID x31 '1' MachineInfo      Info x00  Length  103
TokenID x32 '2' DatabaseInfo     Info x00  Length   88
TokenID x33 '3' ProducerInfo     Info x00  Length   85
TokenID x34 '4' ContinunityInfo  Info x00  Length    4
TokenID x5a 'Z' Record Trailer   Info x00  Length  587

2011/01/18 13:40:26.034.631 FileHeader           Len   587 RBA 0
Name: *FileHeader*
 3000 012f 3000 0008 660d 0a71 3100 0006 0001 3200 | 0../0...f..q1.....2.
 0008 0000 0016 3300 000c 02f1 7834 eac7 7f3f 3400 | ......3.....x4...?4.
 0037 0031 7572 693a 7465 6c6c 7572 6961 6e3a 3a68 | .7.1uri:tellurian::h
 6f6d 653a 6d63 6361 7267 6172 3a67 6773 3a67 6773 | ome:mccargar:ggs:ggs
 4f72 6163 6c65 3a73 6f75 7263 6536 0000 1700 112e | Oracle:source6......
 2f64 6972 6461 742f 6572 3030 3030 3030 3700 0005 | /dirdat/er0000007...
 0138 0000 0800 01e2 4039 0000 0c00 0000 0000 001d | .8......@9..........

GroupID x30 '0' TrailInfo        Info x00  Length  303
 3000 012f 3000 0008 660d 0a71 3100 0006 0001 3200 | 0../0...f..q1.....2.
 0008 0000 0016 3300 000c 02f1 7834 eac7 7f3f 3400 | ......3.....x4...?4.
 0037 0031 7572 693a 7465 6c6c 7572 6961 6e3a 3a68 | .7.1uri:tellurian::h
 6f6d 653a 6d63 6361 7267 6172 3a67 6773 3a67 6773 | ome:mccargar:ggs:ggs
 4f72 6163 6c65 3a73 6f75 7263 6536 0000 1700 112e | Oracle:source6......
 2f64 6972 6461 742f 6572 3030 3030 3030 3700 0005 | /dirdat/er0000007...
 0138 0000 0800 01e2 4039 0000 0c00 0000 0000 001d | .8......@9..........
 a33b 0000 450a 3634 3136 3138 3936 3932 0000 0000 | .;..E.6416189692....
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 3aff 0045 0000 0000 0000 | ..........:..E......
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 0000 0000 0000 0000 003d | ...................=
 0000 0c02 f178 34eb 556a 403c ff00 0c00 0000 0000 | .....x4.Uj@<........
 0000 00                                           | ...
TokenID x30 '0' Signature        Info x00  Length    8
 660d 0a71                                         | f..q
TokenID x31 '1' Compatibility    Info x00  Length    6
 0001                                              | ..
TokenID x32 '2' Charset          Info x00  Length    8
 0000 0016                                         | ....
TokenID x33 '3' CreationTime     Info x00  Length   12
 02f1 7834 eac7 7f3f                               | ..x4...?
TokenID x34 '4' URI              Info x00  Length   55
 0031 7572 693a 7465 6c6c 7572 6961 6e3a 3a68 6f6d | .1uri:tellurian::hom
 653a 6d63 6361 7267 6172 3a67 6773 3a67 6773 4f72 | e:mccargar:ggs:ggsOr
 6163 6c65 3a73 6f75 7263 65                       | acle:source
TokenID x36 '6' Filename         Info x00  Length   23
 0011 2e2f 6469 7264 6174 2f65 7230 3030 3030 30   | .../dirdat/er000000
TokenID x37 '7' MultiPart        Info x00  Length    5
 01                                                | .
TokenID x38 '8' Seqno            Info x00  Length    8
 0001 e240                                         | ...@
TokenID x39 '9' FileSize         Info x00  Length   12
 0000 0000 0000 1da3                               | ........
TokenID x3b ';' LastCSN          Info x00  Length   69
 0a36 3431 3631 3839 3639 3200 0000 0000 0000 0000 | .6416189692.........
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 00                                      | .....
TokenID x3a ':' FirstCSN         Info xff  Length   69
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 | ....................
 0000 0000 00                                      | .....
TokenID x3d '=' LastIOTime       Info x00  Length   12
 02f1 7834 eb55 6a40                               | ..x4.Uj@
TokenID x3c '<' FirstIOTime      Info xff  Length   12
 0000 0000 0000 0000                               | ........

GroupID x31 '1' MachineInfo      Info x00  Length  103
 3100 0067 3000 000b 0005 4c69 6e75 7831 0000 0f00 | 1..g0.....Linux1....
 0974 656c 6c75 7269 616e 3200 0014 000e 322e 362e | .tellurian2.....2.6.
 392d 3131 2e45 4c73 6d70 3300 0029 0023 2331 2053 | 9-11.ELsmp3..).##1 S
 4d50 2046 7269 204d 6179 2032 3020 3138 3a32 353a | MP Fri May 20 18:25:
 3330 2045 4454 2032 3030 3534 0000 0c00 0678 3836 | 30 EDT 20054.....x86
 5f36 34                                           | _64
TokenID x30 '0' Sysname          Info x00  Length   11
 0005 4c69 6e75 78                                 | ..Linux
TokenID x31 '1' Nodename         Info x00  Length   15
 0009 7465 6c6c 7572 6961 6e                       | ..tellurian
TokenID x32 '2' Release          Info x00  Length   20
 000e 322e 362e 392d 3131 2e45 4c73 6d70           | ..2.6.9-11.ELsmp
TokenID x33 '3' Version          Info x00  Length   41
 0023 2331 2053 4d50 2046 7269 204d 6179 2032 3020 | .##1 SMP Fri May 20
 3138 3a32 353a 3330 2045 4454 2032 3030 35        | 18:25:30 EDT 2005
TokenID x34 '4' Hardware         Info x00  Length   12
 0006 7838 365f 3634                               | ..x86_64

GroupID x32 '2' DatabaseInfo     Info x00  Length   88
 3200 0058 3000 0006 0007 3100 000e 0008 4f52 4131 |2..X0.....1.....ORA1
 3032 3241 3200 000e 0008 6f72 6131 3032 3261 3300 |022A2.....ora1022a3.
 0008 ffff ffff 3400 0006 0000 3500 0006 0000 3600 |......4.....5.....6.
 0006 0000 3700 0008 ffff ffff 3800 0010 000a 3130 |....7.......8.....10
 2e32 2e30 2e32 2e30                               | .2.0.2.0
TokenID x30 '0' Vendor           Info x00  Length    6
 0007                                              | ..
TokenID x31 '1' Name             Info x00  Length   14
 0008 4f52 4131 3032 3241                          | ..ORA1022A
TokenID x32 '2' Instance         Info x00  Length   14
 0008 6f72 6131 3032 3261                          | ..ora1022a
TokenID x33 '3' Charset          Info x00  Length    8
 ffff ffff                                         | ....
TokenID x34 '4' MajorVersion     Info x00  Length    6
 0000                                              | ..
TokenID x35 '5' MinorVersion     Info x00  Length    6
 0000                                              | ..
TokenID x36 '6' VerString        Info x00  Length    6
 0000                                              | ..
TokenID x37 '7' ClientCharset    Info x00  Length    8
 ffff ffff                                         | ....
TokenID x38 '8' ClientVerString  Info x00  Length   16
 000a 3130 2e32 2e30 2e32 2e30                     | ..10.2.0.2.0

GroupID x33 '3' ProducerInfo     Info x00  Length   85
 3300 0055 3000 000a 0004 4546 4152 3100 0006 0003 | 3..U0.....EFAR1.....
 3200 0006 0000 3300 0006 0000 3400 0006 0000 3500 | 2.....3.....4.....5.
 0006 0000 3600 0006 0017 3700 0023 001d 5665 7273 | ....6.....7..#..Vers
 696f 6e20 5374 2e20 416e 6472 6577 7320 4275 696c | ion St. Andrews Buil
 6420 3032 33                                      | d 023
TokenID x30 '0' Name             Info x00  Length   10
 0004 4546 4152                                    | ..EFAR
TokenID x31 '1' DataSource       Info x00  Length    6
 0003                                              | ..
TokenID x32 '2' MajorVersion     Info x00  Length    6
 0000                                              | ..
TokenID x33 '3' MinorVersion     Info x00  Length    6
 0000                                              | ..
TokenID x34 '4' MaintLevel       Info x00  Length    6
 0000                                              | ..
TokenID x35 '5' BugFixLevel      Info x00  Length    6
 0000                                              | ..
TokenID x36 '6' BuildNumber      Info x00  Length    6
 0017                                              | ..
TokenID x37 '7' VerString        Info x00  Length   35
 001d 5665 7273 696f 6e20 5374 2e20 416e 6472 6577 | ..Version St.Andrew
 7320 4275 696c 6420 3032 33                       | s Build 023

GroupID x34 '4' ContinunityInfo  Info x00  Length    4
 3400 0004                                         | 4...