From d0c5b2ff6191c8fe2e23e4c1167b756d1c121049 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markus=20M=C3=A4kel=C3=A4?= Date: Wed, 26 Sep 2018 10:33:05 +0300 Subject: [PATCH] MXS-701: Amend binlogfilter documentation Added clarifying comments and links to relevant documentation, fixed a typo and changed some of the wording. --- Documentation/Filters/BinlogFilter.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/Documentation/Filters/BinlogFilter.md b/Documentation/Filters/BinlogFilter.md index 5f1e65837..e4e180e98 100644 --- a/Documentation/Filters/BinlogFilter.md +++ b/Documentation/Filters/BinlogFilter.md @@ -1,4 +1,4 @@ -# BinlogFilter +# Binlog Filter 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 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 -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 Both the `match` and `exclude` parameters are optional. If neither of them is 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 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 -Only events belonging to database `customers` are replicated. In addition to -this, events for the table `orders` are excluded and thus are not replicated. +With the following configuration, only events belonging to database `customers` +are replicated. In addition to this, events for the table `orders` are excluded +and thus are not replicated. ``` [BinlogFilter] @@ -67,3 +70,7 @@ service=BinlogServer protocol=MySQLClient 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).