Configuring Connection Details

This section provides instructions for configuring the connection details required to establish communication between the Micro-Integration and your third-party system.

For information about configuring the connection to the event broker, see Connecting to Your Event Broker .

The name of the binder for MySQL is mysqlcdc.

spring:
  cloud:
    stream:
      <binder-name>:
        default:
          <shared parameters>
        bindings:
          input-0:
            <workflow-specific parameters>

MySQL Database Prerequisites

Before you use the Micro-Integration for MySQL Bulk CDC, you must configure your MySQL database with the following settings:

• Binary logging enabled

  MySQL must be configured with binary logging enabled in ROW format. Add the following settings to your MySQL configuration file (my.cnf or my.ini):

  server-id = 1
  log_bin = mysql-bin
  binlog_format = ROW
  binlog_row_image = FULL
  expire_logs_days = 10

• Required user privileges

  The MySQL user specified in the connection configuration must have the following privileges:

  • REPLICATION SLAVE—Required to read the binary log

  • REPLICATION CLIENT—Required to use SHOW MASTER STATUS, SHOW SLAVE STATUS, and SHOW BINARY LOGS

  • SELECT—Required on all tables being monitored

  To grant these privileges, run the following SQL commands:

  CREATE USER 'mysqluser'@'%' IDENTIFIED BY 'password';
  GRANT REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'mysqluser'@'%';
  GRANT SELECT ON <database_name>.* TO 'mysqluser'@'%';
  FLUSH PRIVILEGES;

• GTID mode (recommended)

  We strongly recommend using Global Transaction Identifiers (GTID) mode for production deployments because it provides better consistency and failover support. To enable GTID mode, add the following settings to your MySQL configuration:

  gtid_mode = ON
  enforce_gtid_consistency = ON

  For more information about MySQL binary logging and GTID configuration, consult your MySQL server administrator or refer to the MySQL documentation for your specific MySQL version.

MySQL Connection Details

To manually configure the MySQL connection details, set the following properties in application.yml:

spring:
  cloud:
    stream:
      mysqlcdc:
        bindings:
          input-0:
            consumer:
              endpoint:
                query-parameters:
                  databaseHostname: <hostname>
                  databasePort: <port>
                  databaseUser: <database user name>
                  databaseServerId: <unique server ID>
                  <authentication parameter>: <authentication parameter value>
                  <authentication parameter>: <authentication parameter value>
                  ...

Where:

• databaseHostname is the hostname or IP address of the MySQL database server.

• databasePort is the connection port of the MySQL database server.

• databaseUser is the MySQL user to log in as. The MySQL user must have replication privileges (REPLICATION SLAVE, REPLICATION CLIENT).

• databaseServerId is a unique server ID for replication. This must be a unique integer identifier for the connector instance.

• <authentication parameter> is a parameter required for authenticating with the MySQL database server. Choose one of:

  • Basic Authentication—Use a username and password to authenticate. For more information, see Basic Authentication Parameters.

  • Client Certificate Authentication—Use a client certificate to authenticate. For more information, see Client Certificate Authentication Parameters.

Basic Authentication Parameters

Client Certificate Authentication Parameters

For SSL/TLS certificate-based authentication, configure the following SSL properties in addition to the basic connection parameters.

Checkpoint Store Configuration

The Micro-Integration for MySQL Bulk CDC stores the information about the current progress of processing change events in a checkpoint store backed by a Last Value Queue (LVQ) on a Solace event broker. The checkpoint store contains information about the binlog position and GTID that have been processed.

For example, add the following settings to the application.yml file:

solace:
  mysqlcdc:
    checkpoint:
      lvqName: lvq-checkpoint
      autoProvisionLvq: true

The following table lists the configuration options for the Checkpoint Store.

MySQL Bulk CDC Binder Configuration Options

The following properties are available at the MySQL Bulk CDC binder level.

MySQL Bulk CDC Consumer Configuration Options

The following table lists the MySQL Bulk CDC source-specific properties.

All properties must be prefixed with spring.cloud.stream.mysqlcdc.bindings.input-0.consumer.endpoint.query-parameters.

Example configuration:

spring:
  cloud:
    stream:
      mysqlcdc:
        bindings:
          input-0:
            consumer:
              endpoint:
                query-parameters:
                  <connection parameters>
                  databaseServerId: 12345
                  snapshotMode: no_data
                  skipDeleteEvents: false
                  tableIncludeList: inventory.customers;inventory.orders
                  offsetFlushIntervalMs: 60000
                  bigintUnsignedHandlingMode: long
                  decimalHandlingMode: precise
                  timePrecisionMode: adaptive_time_microseconds