MaxScale 24.02 CDC Connector

The MaxScale CDC Connector, a single-file C++ API for the MaxScale CDC system. The maxscale-cdc-connector package is not shipped with MariaDB MaxScale 24.02 or later.

The maxscale-cdc-connector package is not shipped with MariaDB MaxScale 24.02 or later. It was dropped from the MaxScale build in 24.02.0 (MXS-4971), and the connector source is no longer part of the MaxScale repository.

MaxScale 23.08 is the last series that ships it — see MaxScale 23.08 CDC Connector. To stream change events from MaxScale 24.02 onwards, use the KafkaCDC router.

This page is kept as a reference for the API itself.

The C++ connector for the MariaDB MaxScale CDC system.

Usage

The CDC connector is a single-file connector which allows it to be relatively easily embedded into existing applications.

To start using the connector, either download it from the MariaDB website or configure the MaxScale repository and install the maxscale-cdc-connector package.

API Overview

A CDC connection object is prepared by instantiating the CDC::Connection class. To create the actual connection, call the CDC::Connection::connect method of the class.

After the connection has been created, call the CDC::Connection::read method to get a row of data. The CDC::Row::length method tells how many values a row has and CDC::Row::value is used to access that value. The field name of a value can be extracted with the CDC::Row::key method and the current GTID of a row of data is retrieved with the CDC::Row::gtid method.

To close the connection, destroy the instantiated object.

Examples

The source code contains an example that demonstrates basic usage of the MaxScale CDC Connector.

Dependencies

The CDC connector depends on:

• OpenSSL

• Jansson

RHEL/CentOS 7

sudo yum -y install epel-release
sudo yum -y install jansson openssl-devel cmake make gcc-c++ git

Debian Stretch and Ubuntu Xenial

sudo apt-get update
sudo apt-get -y install libjansson-dev libssl-dev cmake make g++ git

Debian Jessie

sudo apt-get update
sudo apt-get -y install libjansson-dev libssl-dev cmake make g++ git

openSUSE Leap 42.3

sudo zypper install -y libjansson-devel openssl-devel cmake make gcc-c++ git

Building and Packaging

To build and package the connector as a library, follow MaxScale build instructions with the exception of adding -DTARGET_COMPONENT=devel to the CMake call.

_{This page is licensed: CC BY-SA / Gnu FDL}