hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MXS-1537: Add API overview to CDC Connector documentation

Browse Source 
The overview goes over the main functions of the Connector and Row
classes.
This commit is contained in:
Markus Mäkelä
2018-02-15 10:56:37 +02:00
parent 754d80da75
commit 11a7669df4
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/Connectors/CDC-Connector.md
View File

@ -8,6 +8,20 @@ The C++ connector for the [MariaDB MaxScale](https://mariadb.com/products/techno
The CDC connector is a single-file connector which allows it to be relatively
easily embedded into existing applications.
## 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