LOGSCAN logical log output definition
This topic describes the Logical log output definition syntax of the LOGSCAN statement.
A logical log is a readable version of the Db2 log that contains before and after images of database changes. This syntax specifies the location and format of the output logical log control file and the logical log data file that Log Master creates using the log records selected in your log scan.
For more information about using logical log files as input, see INPUT-statement. For more information about Unicode characters in logical log files, see Considerations-for-output-files-and-Unicode.
The following figure shows the Logical log definition syntax diagram.
Option | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
DATASET Output definition | Specifies the characteristics of the data set that contains the logical log data file. For more information, see LOGSCAN-output-definition. | ||||||||
CONTROL Output definition | Specifies the characteristics of the data set that contains the logical log control file. For more information, see LOGSCAN-output-definition. | ||||||||
XMLSTRING Output definition | Specifies the characteristics of the data set where Log Master stores the XMLSTRING control file. This file contains the string IDs and string data that Db2 uses to encode the data in XML columns. By default, Log Master does not generate this data set. Specify this file only if you intend to use the output logical log file to migrate data to a different Db2 subsystem. When you apply the changes in the logical log to a different target subsystem, Log Master or the High-speed Apply Engine need the string IDs and data to serialize your XML data correctly. Log Master obtains this data from the Db2 catalog table SYSIBM.SYSXMLSTRINGS. For more information on specifying the data set characteristics, see LOGSCAN-output-definition. | ||||||||
RECFM | Documents the record format of the output logical log files. Log Master forces the record format of logical log control and data files to be variable length, and blocked (VB). If Log Master detects that any records in the logical log data file exceed the length restrictions of the VB format, it automatically divides the records into multiple segments and writes those segments to a VB file. For more information, see Normal-and-segmented-logical-log-record-formats.
| ||||||||
DATEFMT | Specifies the date and time format used in the output logical log.
| ||||||||
EXPAND VAR | Determines how Log Master writes variable length fields in the output logical log.
Log Master does not expand data definition language (DDL) information in the logical log data file, even when this keyword is YES. | ||||||||
INCLUDE ROLLBACK | Determines whether Log Master includes information from compensated log records in the output logical log file. Use the default value of NO for normal processing. In this context, compensated log records are the log records of database changes that Db2 subsequently 'compensates for' or 'reverses' (for example, log records of changes that are later reversed by a ROLLBACK statement). Depending on the value of this keyword, Log Master includes or excludes compensated log records. For more information, see INCLUDE ROLLBACK.
If you do not specify INCLUDE ROLLBACK, Log Master ignores compensated log records. If you specify INCLUDE ROLLBACK without specifying YES or NO, the default value is YES (Log Master includes both compensated and non compensated log records). | ||||||||
INCLUDE SYNONYMS | Determines whether Log Master includes information about the synonyms and aliases of Db2 tables in the output logical log file. Use this keyword when later processing of the logical log file needs to use or select records based on synonym or alias names. By default, Log Master does not include this information. To obtain synonym and alias names, Log Master reads the SYSIBM.SYSSYNONYMS table in the Db2 catalog. This processing can slow performance. If you include synonyms or aliases frequently, you can reduce the performance loss by creating an additional index on the SYSSYNONYMS table. The ALPIXSYN member in the HLQ.DBSAMP library contains a sample DDL statement that you can modify to create the additional index. The HLQ value represents a qualifier that your environment assigns during installation. | ||||||||
INCLUDE DDL | Determines whether Log Master includes data definition language (DDL) information in the output logical log file. When the value of this keyword is YES, Log Master writes objects representing DDL activity into the logical log data file. The DDL objects that Log Master writes in an output logical log file are not the same as the DDL statements that it writes in an output DDL (or SQL) file. A DDL object can represent multiple DDL statements, and a DDL statement can represent multiple insert, update, or delete actions against several tables in the Db2 catalog. A DDL object that Log Master writes can be interpreted as input by either Log Master itself (using the LLOG keyword of the INPUT statement) or by the High-speed Apply Engine that is distributed with Log Master.
If you omit the INCLUDE DDL keyword, the default value is NO (Log Master does not include DDL statements). If you specify the INCLUDE DDL keyword, but omit the YES or NO keywords, the default value is YES (DDL objects are included). The DDL objects written in the output logical log file are not affected by the setting of the EXPANDVAR keyword. See also DDLOBJ=NO. | ||||||||
INCLUDE LOBS | Determines whether Log Master includes the data from large object (LOB) columns in the output logical log. When the value of this keyword is YES, Log Master writes LOB VSAM files and saves them permanently to disk. Log Master generates one LOB VSAM file for each LOB column (or each partition of a LOB column) that occurs in the selected log records. Log Master allocates an additional LOB VSAM file only when it has filled the initial data set and all possible extents, but more LOB column data remains to be written. Depending on your environment and your LOB data, the additional disk I/O required for the LOB VSAM files can slow Log Master performance. The names of the LOB VSAM files are determined by a prefix value that you define. For more information, see PREFIX (clusterPrefix) or LOBPREF=&&SYSUID..LOB. If you run this log scan repeatedly and use the output files as input to another execution of Log Master, consider using symbolic values such as &DATE. and &TIME. in the prefix to avoid duplicate data set errors. For more information about how Log Master processes LOB columns and data, see Specifying-LOB-columns.
If you do not specify INCLUDE LOBS, Log Master does not include LOB data. If you specify INCLUDE LOBS without specifying YES, NO, or INLINE, the default value is YES (Log Master includes LOB data). | ||||||||
INCLUDE XML | Determines whether Log Master includes the data from XML columns in the output logical log. When the value of this keyword is YES, Log Master writes XML VSAM files and saves them permanently to disk. Log Master generates one XML VSAM file for each XML column (or each partition of an XML column) that occurs in the selected log records. Log Master allocates an additional XML VSAM file only when it has filled the initial data set and all possible extents, but more XML column data remains to be written. Depending on your environment and your XML data, the additional disk I/O required for the XML VSAM files can slow Log Master performance. The names of the XML VSAM files are determined by a prefix value that you define (for more information, see PREFIX (clusterPrefix) or XMLPREF=&&SYSUID..XML). If you run this log scan repeatedly and use the output files as input to another execution of Log Master, consider using symbolic values such as &DATE. and &TIME. in the prefix to avoid duplicate data set errors.
If you do not specify INCLUDE XML, Log Master does not include XML data. If you specify INCLUDE XML without specifying YES or NO, the default value is YES (Log Master includes XML data). | ||||||||
INCLUDE COMMAND | Determines whether Log Master includes Db2 command records in the output logical log. When you specify YES or ONLY, Log Master includes all Db2 commands that were issued during the specified time range. Log Master does not filter on command name in the output logical log.
If you do not specify INCLUDE COMMAND, Log Master does not include Db2 command record information. If you specify INCLUDE COMMAND without specifying YES or NO, the default value is YES (Log Master includes Db2 command record information). | ||||||||
INCLUDE STATUS CHANGES | Determines whether Log Master includes database exception (DBE) records that are logged by Db2 utilities.
If you do not specify INCLUDE STATUS CHANGES, Log Master does not include DBE records. If you specify INCLUDE STATUS CHANGES without specifying YES, NO, or ONLY, the default value is YES (Log Master includes DBE records). | ||||||||
Column include/exclude | The Column include/exclude definition enables you to control the information in your logical log file based on table columns. If you include columns in (or exclude columns from) your logical log, the same columns are included or excluded from all other forms of output that are defined in the log scan. For example, if you request both logical log and SQL output files, and you exclude the ROWID column of a LOB column from the output logical log file, Log Master excludes the LOB column from the output SQL file as well. In this situation, Log Master cannot generate the SQL for the LOB column because the ROWID was removed from the logical log record that it was processing. This limitation also applies to the DOCID column of an XML column. For more information about including or excluding column data, see LOGSCAN-column-include-exclude-definition. |
Related topics