diff --git a/connectors/cdc-connector/README.md b/Documentation/Connectors/CDC-Connector.md similarity index 76% rename from connectors/cdc-connector/README.md rename to Documentation/Connectors/CDC-Connector.md index b5bcf94b5..63ecace82 100644 --- a/connectors/cdc-connector/README.md +++ b/Documentation/Connectors/CDC-Connector.md @@ -1,12 +1,18 @@ -# maxscale-cdc-connector +# Maxscale CDC Connector The C++ connector for the [MariaDB MaxScale](https://mariadb.com/products/technology/maxscale) [CDC system](https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-22-avrorouter-tutorial/). ## Usage -The CDC connector is a single-file connector which allows it to be -relatively easily embedded into existing applications. +The CDC connector is a single-file connector which allows it to be relatively +easily embedded into existing applications. + +## Examples + +The source code +[contains an example](https://github.com/mariadb-corporation/MaxScale/blob/2.2/connectors/cdc-connector/examples/main.cpp) +that demonstrates basic usage of the MaxScale CDC Connector. ## Dependencies @@ -45,5 +51,5 @@ 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. +instructions with the exception of adding `-DTARGET_COMPONENT=devel` to the +CMake call. diff --git a/Documentation/Documentation-Contents.md b/Documentation/Documentation-Contents.md index 3009bba65..b52a22427 100644 --- a/Documentation/Documentation-Contents.md +++ b/Documentation/Documentation-Contents.md @@ -113,6 +113,10 @@ Documentation for MaxScale protocol modules. - [Change Data Capture (CDC) Protocol](Protocols/CDC.md) - [Change Data Capture (CDC) Users](Protocols/CDC_users.md) +The MaxScale CDC Connector provides a C++ API for consuming data from a CDC system. + + - [CDC Connector](Connectors/CDC-Connector.md) + ## Authenticators A short description of the authentication module type can be found in the