MXS-1537: Move CDC Connector documentation
Placed the CDC Connector documentation in the main documentation directory under the Connector directory. Added a link into the Documentation-Contents.md document.
This commit is contained in:
@ -1,12 +1,18 @@
|
|||||||
# maxscale-cdc-connector
|
# Maxscale CDC Connector
|
||||||
|
|
||||||
The C++ connector for the [MariaDB MaxScale](https://mariadb.com/products/technology/maxscale)
|
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/).
|
[CDC system](https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-22-avrorouter-tutorial/).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
The CDC connector is a single-file connector which allows it to be
|
The CDC connector is a single-file connector which allows it to be relatively
|
||||||
relatively easily embedded into existing applications.
|
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
|
## Dependencies
|
||||||
|
|
||||||
@ -45,5 +51,5 @@ sudo zypper install -y libjansson-devel openssl-devel cmake make gcc-c++ git
|
|||||||
## Building and Packaging
|
## Building and Packaging
|
||||||
|
|
||||||
To build and package the connector as a library, follow MaxScale build
|
To build and package the connector as a library, follow MaxScale build
|
||||||
instructions with the exception of adding `-DTARGET_COMPONENT=devel` to
|
instructions with the exception of adding `-DTARGET_COMPONENT=devel` to the
|
||||||
the CMake call.
|
CMake call.
|
||||||
@ -113,6 +113,10 @@ Documentation for MaxScale protocol modules.
|
|||||||
- [Change Data Capture (CDC) Protocol](Protocols/CDC.md)
|
- [Change Data Capture (CDC) Protocol](Protocols/CDC.md)
|
||||||
- [Change Data Capture (CDC) Users](Protocols/CDC_users.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
|
## Authenticators
|
||||||
|
|
||||||
A short description of the authentication module type can be found in the
|
A short description of the authentication module type can be found in the
|
||||||
|
|||||||
Reference in New Issue
Block a user