Table of Contents

Search

  1. Preface
  2. Introduction to PowerExchange
  3. DBMOVER Configuration File
  4. Netport Jobs
  5. PowerExchange Message Logs and Destination Overrides
  6. SMF Statistics Logging and Reporting
  7. PowerExchange Security
  8. Secure Sockets Layer Support
  9. PowerExchange Alternative Network Security
  10. PowerExchange Nonrelational SQL
  11. PowerExchange Globalization
  12. Using the PowerExchange ODBC Drivers
  13. PowerExchange Datatypes and Conversion Matrix
  14. Appendix A: DTL__CAPXTIMESTAMP Time Stamps
  15. Appendix B: PowerExchange Glossary

CAPI_CONNECTION - MYSQL Statement

CAPI_CONNECTION - MYSQL Statement

The MYSQL CAPI_CONNECTION statement specifies a named set of parameters that the Consumer API (CAPI) uses to connect to the change stream and control CDC processing for MySQL sources.
Linux and Windows
MySQL
Yes for MySQL CDC
CAPI_CONNECTION=(NAME=
capi_connection_name
[,DLLTRACE=
trace_id
]   ,TYPE=(MYSQL     ,SERVER={
database_server
|
localhost
} ,CATSCHEMA=
catalog_schema_name
[,CATSERVER=
catalog_server
] [,CATUSERNAME=
catalog_user_name
] [,CATEPASSWORD=
encrypted_catalog_user_password
] [,CATPASSWORD=
catalog_user_password
] [,MYSQLBINLOG=
path/binlog_file
[
option1 option2 ...
]]    [,ONDATATRUNC={WARN|
FAIL
}]    [,ONTABLEDDL={WARN|
WARN-UNTIL-EOL
|FAIL}]    [,ONTABLETRUNC={WARN|
FAIL
}] [,RECONNTRIES={
reconnection_attempts
|
12
}] [,RECONNWAIT={
seconds
|
5
}]    [,ROWMEMMAX=
bytes
]      [,RSTRADV=
seconds
]    [,UOWREADAHEAD={
minimum_transactions
|
5
},{
maximum_transactions
|
10
}]      ) )
NAME=
capi_connection_name
Required. A unique user-defined name for this CAPI_CONNECTION statement.
Maximum length is eight alphanumeric characters.
DLLTRACE=
trace_ID
Optional. The user-defined name of the TRACE statement that activates internal DLL tracing for this CAPI. Specify this parameter only at the direction of Informatica Global Customer Support.
TYPE=(MYSQL, ... )
Required. The type of CAPI_CONNECTION statement. For MySQL sources, this value must be MYSQL.
SERVER={
server_name
|localhost}[,
port_number
]
Required. The host name or IP address of the MySQL server where the MySQL source database runs. You can enter "localhost" if the MySQL server and PowerExchange Listener run locally on the same machine.
If you want the source server to listen on a port number other than the default port, append the port number to the server name.
CATSERVER
Optional. The name of the server that contains the DDL-updated catalog tables that store MySQL source table definitions.
Default is the MySQL source server name. You can use the default if you created the catalog tables and installed the MySQL ODBC drivers on the source server.
CATSCHEMA
Required. The name of the schema for the DDL catalog tables.
CATUSERNAME
Optional. A user name that is used to connect to the catalog server.
Default is the MySQL source user name if the catalog tables exist on the source server.
CATEPASSWORD
Optional. The encrypted password of the specified catalog user. Specify either CATEPASSWORD or CATPASSWORD but do not specify both parameters.
Default is the password of the MySQL source user if the catalog tables exist on the source server.
CATPASSWORD
Optional. The clear-text password of the specified catalog user. Specify either CATPASSWORD or CATEPASSWORD but do not specify both parameters.
Default is the password of the MySQL source user if the catalog tables exist on the source server.
MYSQLBINLOG=
path/binlog_file_name
[
option1 option2...
]
Optional. If the MySQL server is not installed on the local host, specify the path to the mysqlbinlog utility in this parameter or in the PATH environment variable. PowerExchange uses the mysqlbinlog utility to read change events from the MySQL binary log. You can optionally include any of the options that the mysqlbinlog utility supports, such as the --ssl- options. PowerExchange passes the options to the utility when the CDC session runs. For information about the utility options, see the
MySQL Reference Manual
.
If any part of the MYSQLBINLOG value includes spaces, you must enclose the entire MYSQLBINLOG value in double-quotation marks ("). Furthermore, if any part of the
path\binlog_file_name
value or an option includes a space, escape the value with the backslash (\) character and also enclose the value in double-quotation marks, for example:
MYSQLBINLOG="\"c:\bin\test dir\mysqlbinlog.exe\" --ssl-mode required "
If the
path\binlog_file_name
value begins with the hyphen (-) character, the entire value is treated as a utility option, as if no
path/file_name
value was specified.
ONDATATRUNC={WARN|
FAIL
}
Optional. Indicates whether PowerExchange issues a warning message and continues processing or ends abnormally when it needs to truncate data from MySQL columns that have a mediumblob, longblob, mediumtext, longtext, enum, json, set, varbinary, or varchar datatype and are longer than 98,304 bytes.
Default is FAIL.
ONTABLEDDL={WARN|
WARN-UNTIL-EOL
|FAIL}
Optional. Indicates whether PowerExchange issues a warning message and continues processing or ends abnormally when it encounters a DDL record for a source that is not consistent with the source registration. Options are:
  • WARN. Issue a warning message and continue capture processing.
  • WARN-UNTIL-EOL. Issue a warning message and continue capture processing until the end-of-log (EOL). Then issue an error message and terminate capture processing.
  • FAIL. Issue an error message and terminate capture processing.
Default is WARN-UNTIL-EOL.
ONTABLETRUNC={WARN|
FAIL
}
Optional. Indicates whether PowerExchange issues a warning message and continues processing or ends abnormally when it encounters a TRUNCATE TABLE record in the change stream.
Default is FAIL.
RECONNTRIES={
reconnection_attempts
|
12
}
Optional. The maximum number of times that PowerExchange tries to reconnect to the MySQL Server database server after detecting that the database server has shut down or the network connection to the server has been dropped. When PowerExchange and the database server run on the same machine, PowerExchange processes change records to the end of log and then checks whether the server is still running. If PowerExchange connects to a remote database server and the server shuts down or the network connection to the server is severed, the binary log reader connection might be dropped. In this case, you can use this parameter in conjunction with the RECONNWAIT parameter to improve connection resiliency.
Valid values are 0 or any positive number. A value of 0 results in no connection retries. Default is 12.
RECONNWAIT={
seconds
|
5
}
Optional. The number of seconds that PowerExchange waits before any attempt to reconnect to a MySQL Server database server after detecting that the server has shut down or the network connection to the server has been dropped. Use this parameter in conjunction with the RECONNTRIES parameter to improve connection resiliency.
Valid values are 0 through 3600. A value of 0 results in no waiting between connection retries. Default is 5.
ROWMEMMAX=
maximum_bytes
Optional. The maximum amount of memory, in bytes, that PowerExchange can use to store a row change from a MySQL source table. No default value is available. If no maximum value is provided, PowerExchange does not limit the memory for a captured row change.
RSTRADV=
seconds
Optional. The time interval, in seconds, that PowerExchange waits before advancing restart and sequence tokens for a registered data source during periods when UOWs do not include any changes of interest for the data source. When the wait interval expires, PowerExchange returns the next committed "empty UOW," which includes only updated restart information.
PowerExchange resets the wait interval to 0 when one of the following events occur:
  • PowerExchange completes processing a UOW that includes changes of interest.
  • PowerExchange returns an empty UOW because the wait interval expired without PowerExchange receiving any changes of interest.
Valid values 0 through 86400. No default is provided. A value of 0 disables restart advance processing.
For example, if you specify 5, PowerExchange waits 5 seconds after it completes processing the last UOW or after the previous wait interval expires. Then PowerExchange returns the next committed empty UOW that includes the updated restart information and resets the wait interval to 0.
If you do not specify RSTRADV, PowerExchange does not advance restart and sequence tokens for a registered source during periods when PowerExchange receives no changes of interest. In this case, when PowerExchange warm starts, it reads all changes, including those not of interest for CDC, from the restart point.
UOWREADAHEAD=
minimum_transactions_in_queue
,
maximum_transactions_in_queue
Optional. The minimum number of transactions and the maximum number of transactions that control I/O on the UOW read-ahead queue that PowerExchange uses to prefetch change data. The UOW read-ahead queue is a dynamic queue of buffered transactions that are waiting to be read by the PowerExchange capture process. When the queue reaches the maximum number of transactions, the queue reader thread stops and sleeps until enough transactions have been read from the queue to return it to the maximum value. The number of transactions in the queue might become less than the minimum number in the following cases:
  • PowerExchange has read to the end of the binary log and no additional changes are available.
  • The transactions in the queue are consumed faster than the changes are read from the binary log.
For the
minimum_transactions
field, the default value is 5 and the valid range of values is 0 through 100. For the
maximum_transactions
field, the default value is 10 and the maximum is 100.
The maximum number of transaction that the queue can hold is 100.

0 COMMENTS

We’d like to hear from you!