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

MXS-701: Amend binlogfilter documentation

Browse Source 
Added clarifying comments and links to relevant documentation, fixed a
typo and changed some of the wording.
This commit is contained in:
Markus Mäkelä
2018-09-26 10:33:05 +03:00
parent b1c734bb16
commit d0c5b2ff61
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Documentation/Filters/BinlogFilter.md
View File

@ -1,4 +1,4 @@
# BinlogFilter # Binlog Filter
This filter was introduced in MariaDB MaxScale 2.3.0. This filter was introduced in MariaDB MaxScale 2.3.0.
@ -10,16 +10,18 @@ replicate the binary log events to slave servers.
The filter uses two parameters, `match` and `exclude`, to decide which events The filter uses two parameters, `match` and `exclude`, to decide which events
are replicated. If a binlog event does not match or is excluded, the event is are replicated. If a binlog event does not match or is excluded, the event is
replaced with an empty data event. The empty event is always 35 bytes which replaced with an empty data event. The empty event is always 35 bytes which
translates to a space reduction for most events. translates to a space reduction in most cases.
The filter works with both row based and statement based replication. The filter works with both row based and statement based replication but we
recommend using row based replication with the binlogfilter. This guarantees
that there are no ambiguities in the event filtering.
## Configuration ## Configuration
Both the `match` and `exclude` parameters are optional. If neither of them is Both the `match` and `exclude` parameters are optional. If neither of them is
defined, the filter does nothing and all events are replicated. defined, the filter does nothing and all events are replicated.
The two parameters are matched against the database and table name concatenaed The two parameters are matched against the database and table name concatenated
with a period. For example, the string the patterns are matched against for the with a period. For example, the string the patterns are matched against for the
database `test` and table `t1` is `test.t1`. database `test` and table `t1` is `test.t1`.
@ -45,8 +47,9 @@ defined, the event filtering is controlled completely by the `match` parameter.
## Example Configuration ## Example Configuration
Only events belonging to database `customers` are replicated. In addition to With the following configuration, only events belonging to database `customers`
this, events for the table `orders` are excluded and thus are not replicated. are replicated. In addition to this, events for the table `orders` are excluded
and thus are not replicated.
``` ```
[BinlogFilter] [BinlogFilter]
@ -67,3 +70,7 @@ service=BinlogServer
protocol=MySQLClient protocol=MySQLClient
port=4000 port=4000
``` ```
For more information about the binlogrouter and how to use it, refer to the
[binlogrouter documentation](../Routers/Binlogrouter.md) and the
[binlogrouter tutorial](../Tutorials/Replication-Proxy-Binlog-Router-Tutorial.md).