Add table of contents to router documentation
The TOC was added only to the long documentation files to make them easier to navigate. Also modified the headings for Avro and Binlog routers and did some minor cleanup.
This commit is contained in:
Esa Korhonen
@ -4,11 +4,12 @@ The avrorouter is a MariaDB 10.0 binary log to Avro file converter. It consumes
|
||||
binary logs from a local directory and transforms them into a set of Avro files.
|
||||
These files can then be queried by clients for various purposes.
|
||||
|
||||
This router is intended to be used in tandem with the [Binlog Server](Binlogrouter.md).
|
||||
The Binlog Server can connect to a master server and request binlog records. These
|
||||
records can then consumed by the avrorouter directly from the binlog cache of
|
||||
the Binlog Server. This allows MariaDB MaxScale to automatically transform binlog events
|
||||
on the master to local Avro format files.
|
||||
This router is intended to be used in tandem with the
|
||||
[Binlog Server](Binlogrouter.md).
|
||||
The Binlog Server can connect to a master server and request binlog records.
|
||||
These records can then consumed by the avrorouter directly from the binlog cache
|
||||
of the Binlog Server. This allows MariaDB MaxScale to automatically transform
|
||||
binlog events on the master to local Avro format files.
|
||||
|
||||
|
||||
|
||||
@ -21,14 +22,46 @@ should be used to communicate with the avrorouter and currently it is the only
|
||||
supported protocol. The clients can request either Avro or JSON format data
|
||||
streams from a database table.
|
||||
|
||||
# Configuration
|
||||
Table of Contents
|
||||
=================
|
||||
|
||||
* [Configuration](#configuration)
|
||||
* [Router Parameters](#router-parameters)
|
||||
* [source](#source)
|
||||
* [codec](#codec)
|
||||
* [match](#match)
|
||||
* [exclude](#exclude)
|
||||
* [Router Options](#router-options)
|
||||
* [General Options](#general-options)
|
||||
* [binlogdir](#binlogdir)
|
||||
* [avrodir](#avrodir)
|
||||
* [filestem](#filestem)
|
||||
* [start_index](#start_index)
|
||||
* [Avro file options](#avro-file-options)
|
||||
* [group_trx](#group_trx)
|
||||
* [group_rows](#group_rows)
|
||||
* [block_size](#block_size)
|
||||
* [Module commands](#module-commands)
|
||||
* [avrorouter::convert SERVICE {start | stop}](#avrorouterconvert-service-start--stop)
|
||||
* [avrorouter::purge SERVICE](#avrorouterpurge-service)
|
||||
* [Files Created by the Avrorouter](#files-created-by-the-avrorouter)
|
||||
* [Resetting the Conversion Process](#resetting-the-conversion-process)
|
||||
* [Stopping the Avrorouter](#stopping-the-avrorouter)
|
||||
* [Example Client](#example-client)
|
||||
* [Avro Schema Generator](#avro-schema-generator)
|
||||
* [Python Schema Generator](#python-schema-generator)
|
||||
* [Go Schema Generator](#go-schema-generator)
|
||||
* [Examples](#examples)
|
||||
* [Building Avrorouter](#building-avrorouter)
|
||||
|
||||
## Configuration
|
||||
|
||||
For information about common service parameters, refer to the
|
||||
[Configuration Guide](../Getting-Started/Configuration-Guide.md).
|
||||
|
||||
## Router Parameters
|
||||
### Router Parameters
|
||||
|
||||
### `source`
|
||||
#### `source`
|
||||
|
||||
The source for the binary logs. This is an optional parameter.
|
||||
|
||||
@ -57,7 +90,7 @@ router=avrorouter
|
||||
source=replication-router
|
||||
```
|
||||
|
||||
### `codec`
|
||||
#### `codec`
|
||||
|
||||
The compression codec to use. By default, the avrorouter does not use compression.
|
||||
|
||||
@ -66,7 +99,7 @@ _deflate_. These are the mandatory compression algorithms required by the
|
||||
Avro specification. For more information about the compression types,
|
||||
refer to the [Avro specification](https://avro.apache.org/docs/current/spec.html#Required+Codecs).
|
||||
|
||||
### `match`
|
||||
#### `match`
|
||||
|
||||
Only process events for tables that match this PCRE2 regular expression. See
|
||||
[Regular Expressions](../Getting-Started/Configuration-Guide.md#regular-expressions)
|
||||
@ -74,7 +107,7 @@ for more information about regular expressions.
|
||||
|
||||
This parameter was added in MaxScale 2.2.14.
|
||||
|
||||
### `exclude`
|
||||
#### `exclude`
|
||||
|
||||
Ignore events for tables that match this PCRE2 regular expression. This can be
|
||||
combined with the `match` parameter to implement table event filtering.
|
||||
@ -100,7 +133,7 @@ filestem=binlog
|
||||
avrodir=/var/lib/maxscale
|
||||
```
|
||||
|
||||
## Router Options
|
||||
### Router Options
|
||||
|
||||
The avrorouter is configured with a comma-separated list of key-value pairs.
|
||||
Currently the router has one mandatory parameter, `binlogdir`. If no `source`
|
||||
@ -108,11 +141,11 @@ parameter is defined, binlogdir needs to be manually defined in the router
|
||||
options. The following options should be given as a value to the
|
||||
`router_options` parameter.
|
||||
|
||||
### General Options
|
||||
#### General Options
|
||||
|
||||
These options control various file locations and names.
|
||||
|
||||
#### `binlogdir`
|
||||
##### `binlogdir`
|
||||
|
||||
The location of the binary log files. This is the first mandatory parameter
|
||||
and it defines where the module will read binlog files from. Read access to
|
||||
@ -122,7 +155,7 @@ If used in conjunction with the Binlog Server, the value of this option should
|
||||
be the same for both the Binlog Server and the avrorouter if the `source` parameter
|
||||
is not used.
|
||||
|
||||
#### `avrodir`
|
||||
##### `avrodir`
|
||||
|
||||
The location where the Avro files are stored. This is the second mandatory
|
||||
parameter and it governs where the converted files are stored. This directory
|
||||
@ -135,7 +168,7 @@ files. These files are named _avro.index_ and _avro-conversion.ini_. By default,
|
||||
the default data directory, _/var/lib/maxscale/_, is used. Before version 2.1 of
|
||||
MaxScale, the value of _binlogdir_ was used as the default value for _avrodir_.
|
||||
|
||||
#### `filestem`
|
||||
##### `filestem`
|
||||
|
||||
The base name of the binlog files. The default value is "mysql-bin". The binlog
|
||||
files are assumed to follow the naming schema _<filestem>.<N>_ where _<N>_ is
|
||||
@ -149,7 +182,7 @@ filestem=mybin,binlogdir=/var/lib/mysql/binlogs/
|
||||
|
||||
The first binlog file the avrorouter would look for is `/var/lib/mysql/binlogs/mybin.000001`.
|
||||
|
||||
#### `start_index`
|
||||
##### `start_index`
|
||||
|
||||
The starting index number of the binlog file. The default value is 1.
|
||||
For the binlog _mysql-bin.000001_ the index would be 1, for _mysql-bin.000005_
|
||||
@ -159,17 +192,18 @@ If you need to start from a binlog file other than 1, you need to set the value
|
||||
of this option to the correct index. The avrorouter will always start from the
|
||||
beginning of the binary log file.
|
||||
|
||||
**Note**: MaxScale version 2.2 introduces MariaDB GTID support
|
||||
in Binlog Server: currently, if used with Avrorouter, the option `mariadb10_master_gtid`
|
||||
must be set to off in the Binlog Server configuration in order to correclty
|
||||
read the binlog files.
|
||||
**Note**: MaxScale version 2.2 introduces MariaDB GTID support in Binlog Server:
|
||||
currently, if used with Avrorouter, the option `mariadb10_master_gtid` must be
|
||||
set to off in the Binlog Server configuration in order to correclty read the
|
||||
binlog files.
|
||||
|
||||
### Avro file options
|
||||
#### Avro file options
|
||||
|
||||
These options control how large the Avro file data blocks can get.
|
||||
Increasing or lowering the block size could have a positive effect
|
||||
depending on your use case. For more information about the Avro file
|
||||
format and how it organizes data, refer to the [Avro documentation](https://avro.apache.org/docs/current/).
|
||||
format and how it organizes data, refer to the
|
||||
[Avro documentation](https://avro.apache.org/docs/current/).
|
||||
|
||||
The avrorouter will flush a block and start a new one when either `group_trx`
|
||||
transactions or `group_rows` row events have been processed. Changing these
|
||||
@ -180,29 +214,29 @@ It is highly recommended to keep the block sizes relatively large to allow
|
||||
larger chunks of memory to be flushed to disk at one time. This will make
|
||||
the conversion process noticeably faster.
|
||||
|
||||
#### `group_trx`
|
||||
##### `group_trx`
|
||||
|
||||
Controls the number of transactions that are grouped into a single Avro
|
||||
data block. The default value is 1 transaction.
|
||||
|
||||
|
||||
#### `group_rows`
|
||||
##### `group_rows`
|
||||
|
||||
Controls the number of row events that are grouped into a single Avro
|
||||
data block. The default value is 1000 row events.
|
||||
|
||||
#### `block_size`
|
||||
##### `block_size`
|
||||
|
||||
The Avro data block size in bytes. The default is 16 kilobytes. Increase this
|
||||
value if individual events in the binary logs are very large. The value is a
|
||||
size type parameter which means that it can also be defined with an SI
|
||||
suffix. Refer to the
|
||||
[Configuration Guide](../Getting-Started/Configuration-Guide.md) for more
|
||||
details about size type parameters and how to use them.
|
||||
size type parameter which means that it can also be defined with an SI suffix.
|
||||
Refer to the [Configuration Guide](../Getting-Started/Configuration-Guide.md)
|
||||
for more details about size type parameters and how to use them.
|
||||
|
||||
## Module commands
|
||||
|
||||
Read [Module Commands](../Reference/Module-Commands.md) documentation for details about module commands.
|
||||
Read [Module Commands](../Reference/Module-Commands.md) documentation for
|
||||
details about module commands.
|
||||
|
||||
The avrorouter supports the following module commands.
|
||||
|
||||
@ -224,7 +258,7 @@ the conversion process. Issuing a `convert start` command **will not work**.
|
||||
**WARNING:** You will lose any and all converted data when this command is
|
||||
executed.
|
||||
|
||||
# Files Created by the Avrorouter
|
||||
## Files Created by the Avrorouter
|
||||
|
||||
The avrorouter creates two files in the location pointed by _avrodir_:
|
||||
_avro.index_ and _avro-conversion.ini_. The _avro.index_ file is used to store
|
||||
@ -232,7 +266,7 @@ the locations of the GTIDs in the .avro files. The _avro-conversion.ini_ contain
|
||||
the last converted position and GTID in the binlogs. If you need to reset the
|
||||
conversion process, delete these two files and restart MaxScale.
|
||||
|
||||
# Resetting the Conversion Process
|
||||
## Resetting the Conversion Process
|
||||
|
||||
To reset the binlog conversion process, issue the `purge` module command by
|
||||
executing it via MaxAdmin and stop MaxScale. If manually created schema files
|
||||
@ -240,7 +274,7 @@ were used, they need to be recreated once MaxScale is stopped. After stopping
|
||||
MaxScale and optionally creating the schema files, the conversion process can be
|
||||
started by starting MaxScale.
|
||||
|
||||
# Stopping the Avrorouter
|
||||
## Stopping the Avrorouter
|
||||
|
||||
The safest way to stop the avrorouter when used with the binlogrouter is to
|
||||
follow the following steps:
|
||||
@ -252,7 +286,7 @@ follow the following steps:
|
||||
This guarantees that the conversion process halts at a known good position in
|
||||
the latest binlog file.
|
||||
|
||||
# Example Client
|
||||
## Example Client
|
||||
|
||||
The avrorouter comes with an example client program, _cdc.py_, written in Python 3.
|
||||
This client can connect to a MaxScale configured with the CDC protocol and the
|
||||
@ -266,13 +300,13 @@ and [CDC Users](../Protocols/CDC_users.md) documentation.
|
||||
Read the output of `cdc.py --help` for a full list of supported options
|
||||
and a short usage description of the client program.
|
||||
|
||||
# Avro Schema Generator
|
||||
## Avro Schema Generator
|
||||
|
||||
If the CREATE TABLE statements for the tables aren't present in the current
|
||||
binary logs, the schema files must be generated with a schema file
|
||||
generator. There are currently two methods to generate the .avsc schema files.
|
||||
|
||||
## Python Schema Generator
|
||||
### Python Schema Generator
|
||||
|
||||
```
|
||||
usage: cdc_schema.py [--help] [-h HOST] [-P PORT] [-u USER] [-p PASSWORD] DATABASE
|
||||
@ -285,7 +319,7 @@ The script will generate the .avsc schema files into the current directory. Run
|
||||
the script for all required databases copy the generated .avsc files to the
|
||||
directory where the avrorouter stores the .avro files (the value of `avrodir`).
|
||||
|
||||
## Go Schema Generator
|
||||
### Go Schema Generator
|
||||
|
||||
The _cdc_schema.go_ example Go program is provided with MaxScale. This file
|
||||
can be used to create Avro schemas for the avrorouter by connecting to a
|
||||
@ -302,15 +336,15 @@ to be used by the router itself.
|
||||
Read the output of `go run cdc_schema.go -help` for more information on how
|
||||
to run the program.
|
||||
|
||||
# Examples
|
||||
## Examples
|
||||
|
||||
The [Avrorouter Tutorial](../Tutorials/Avrorouter-Tutorial.md) shows you how
|
||||
the Avrorouter works with the Binlog Server to convert binlogs from a master server
|
||||
into easy to process Avro data.
|
||||
|
||||
Here is a simple configuration example which reads binary logs locally from `/var/lib/mysql/`
|
||||
and stores them as Avro files in `/var/lib/maxscale/avro/`. The service has one listener
|
||||
listening on port 4001 for CDC protocol clients.
|
||||
Here is a simple configuration example which reads binary logs locally from
|
||||
`/var/lib/mysql/` and stores them as Avro files in `/var/lib/maxscale/avro/`.
|
||||
The service has one listener listening on port 4001 for CDC protocol clients.
|
||||
|
||||
```
|
||||
[avro-converter]
|
||||
@ -327,33 +361,40 @@ protocol=CDC
|
||||
port=4001
|
||||
```
|
||||
|
||||
Here is an example how you can query for data in JSON format using the _cdc.py_ Python script.
|
||||
It queries the table _test.mytable_ for all change records.
|
||||
Here is an example how you can query for data in JSON format using the _cdc.py_
|
||||
Python script. It queries the table _test.mytable_ for all change records.
|
||||
|
||||
```
|
||||
cdc.py --user=myuser --password=mypasswd --host=127.0.0.1 --port=4001 test.mytable
|
||||
```
|
||||
|
||||
You can then combine it with the _cdc_kafka_producer.py_ to publish these change records to a Kafka broker.
|
||||
You can then combine it with the _cdc_kafka_producer.py_ to publish these change
|
||||
records to a Kafka broker.
|
||||
|
||||
```
|
||||
cdc.py --user=myuser --password=mypasswd --host=127.0.0.1 --port=4001 test.mytable | cdc_kafka_producer.py --kafka-broker 127.0.0.1:9092 --kafka-topic test.mytable
|
||||
cdc.py --user=myuser --password=mypasswd --host=127.0.0.1 --port=4001 test.mytable |
|
||||
cdc_kafka_producer.py --kafka-broker 127.0.0.1:9092 --kafka-topic test.mytable
|
||||
```
|
||||
|
||||
For more information on how to use these scripts, see the output of `cdc.py -h` and `cdc_kafka_producer.py -h`.
|
||||
For more information on how to use these scripts, see the output of `cdc.py -h`
|
||||
and `cdc_kafka_producer.py -h`.
|
||||
|
||||
# Building Avrorouter
|
||||
## Building Avrorouter
|
||||
|
||||
To build the avrorouter from source, you will need the [Avro C](https://avro.apache.org/docs/current/api/c/)
|
||||
library, liblzma, [the Jansson library](http://www.digip.org/jansson/) and sqlite3 development headers. When
|
||||
configuring MaxScale with CMake, you will need to add `-DBUILD_CDC=Y` to build the CDC module set.
|
||||
To build the avrorouter from source, you will need the
|
||||
[Avro C](https://avro.apache.org/docs/current/api/c/) library, liblzma,
|
||||
[the Jansson library](http://www.digip.org/jansson/) and sqlite3 development
|
||||
headers. When configuring MaxScale with CMake, you will need to add
|
||||
`-DBUILD_CDC=Y` to build the CDC module set.
|
||||
|
||||
The Avro C library needs to be build with position independent code enabled. You can do this by
|
||||
adding the following flags to the CMake invocation when configuring the Avro C library.
|
||||
The Avro C library needs to be build with position independent code enabled. You
|
||||
can do this by adding the following flags to the CMake invocation when
|
||||
configuring the Avro C library.
|
||||
|
||||
```
|
||||
-DCMAKE_C_FLAGS=-fPIC -DCMAKE_CXX_FLAGS=-fPIC
|
||||
```
|
||||
|
||||
For more details about building MaxScale from source, please refer to the
|
||||
[Building MaxScale from Source Code](../Getting-Started/Building-MaxScale-from-Source-Code.md) document.
|
||||
[Building MaxScale from Source Code](../Getting-Started/Building-MaxScale-from-Source-Code.md)
|
||||
document.
|
||||
|
||||
Reference in New Issue
Block a user