Table of Contents

Search

  1. Preface
  2. PowerExchange CDC Publisher Overview
  3. Installing and Upgrading PowerExchange CDC Publisher
  4. PowerExchange CDC Publisher Key Concepts
  5. PowerExchange Change Capture Environment
  6. Target Messaging Systems
  7. Configuring PowerExchange CDC Publisher
  8. Streaming Change Data
  9. Monitoring PowerExchange CDC Publisher
  10. Administering PowerExchange CDC Publisher
  11. Appendix A: Command Reference for the Command-Line Utilities
  12. Appendix B: Avro Schema Formats
  13. Appendix C: Custom Pattern Formats
  14. Appendix D: Message Reference

User Guide

User Guide

Custom Pattern Data File

Custom Pattern Data File

Use the table definition syntax and parameters to specify data for the custom pattern data file.

Table Definition Syntax

To define tables in the custom pattern data file, use the following table definition syntax:
# a specific table definition [ table_name = tableName1, column_name = columnName1, column_type = columnType1, column_value = columnValue1, … column_name = columnNameN, column_type = columnTypeN, column_value = columnValueN ]
The table_name, column_name, column_type, and column_value entries can be optionally enclosed in quotation marks.
Include a default table definition that can be used if a definition for a specific table is not in the file. To define a default table definition, use the following syntax:
# a DEFAULT table definition. Will be used if no specific table definition is found for # a given file in the custom pattern file. [ table_name = DEFAULT, column_name = columnName1, column_type = columnType1, column_value = columnValue1, … column_name = columnNameN, column_type = columnTypeN, column_value = columnValueN ]
Begin a comment line with the number (#) character.

Parameters

Use the following parameters for the custom pattern data file content:
table_name
Required. The fully-qualified table name of the source table. This parameter is required for each table that requires its own data definition. The validation process uses a table name of DEFAULT if a custom pattern file for a specific table is not found in the custom pattern data file.
column_name
Required. The column name to use in the output. These column names are used by the Custom Pattern Formatter to replace the <column_name> references in the custom pattern file. The number of columns that are defined determine the number of columns that appear in the substitution within the custom pattern.
column_type
Required. The column data type. This value is used to substitute column_type tags in the custom pattern. Valid values are:
boolean
For example, provide a value of true or false:
column_name = MY_STRING_Present, column_type = boolean, column_value = "true"
date
For example, provide a value of 8 or 14 characters that matches one of the following masks: "YYYYMMDD" or ”YYYYMMDDHHMMSS”:
column_name = MY_DATE, column_type = date, column_value = "20191231"
integer
For example, provide any integer value:
column_name = MY_INT, column_type = integer, column_value = 123456
string
For example, provide any string value:
column_name = MY_STRING, column_type = string, column_value = "any quoted value"
time
For example, provide a value of six characters that matches the mask: "HHMMSS":
column_name = MY_TIME, column_type = time, column_value = "172859
timestamp
For example, provide a value of 24 characters that matches the mask: "YYYYMMDDHHMMSSffffffffff":
column_name = MY_TIMESTAMP, column_type = timestamp, column_value = "201912311728590000000000"
You must include all 10 factional seconds.
To represent null column values, use the keyword "null" as the value with or without quotation marks. For example:
column_name = MY_STRING_BeforeImage, column_type = string, column_value = “null”
Timestamp values must be 14 bytes in length without fractional seconds or 24 bytes in length with fractional seconds.
column_value
Required. The column data value. This value should correspond with the specified column type.
include_default_metadata_columns
Optional. Controls whether or not default values for metadata columns are included. Valid values are:
  • true
    . Default values are provided for metadata columns that have the INFA* and DTL__* prefixes. You do not need to provide the column name, type, or value.
  • false
    . Default values are not provided for these metadata columns. You must specify the column name, type, and value for the metadata columns you want to test in the custom pattern data file.
If you set include_default_metadata_columns =true and also provide values in the custom data pattern file for the same default metadata columns, unpredictable results might occur.
Default is true.
In the following example, this parameter is set to true:
#example definition for tableA [include_default_metadata_columns = true, table_name = tableA, ...
With this setting, the following example metadata values are generated:
Column Name: DTL__CAPXACTION Column Type: string Column Value: dtlaction Column Name: DTL__CAPXRESTART1 Column Type: string Column Value: restart1ABCDEF Column Name: DTL__CAPXRESTART2 Column Type: string Column Value: restart2GHIJK
In the following example, this parameter is set to false and you must provide the metadata column information:
[include_default_metadata_columns = false, table_name = tableA, column_name = DTL__CAPXUSER, column_type = string, column_value = "USERID", column_name = "AColumn_1", column_type = "string", column_value = "This is column 1 data for tableA", column_name = "AColumn_2", column_type = "string", column_value = "This is column 2 data for tableA" ]

0 COMMENTS

We’d like to hear from you!