MariaDB MaxScale Configuration Variables

Table of Contents

• Global Options
• Service Options
• Server Options
• Routing Modules
• Listener Options
• Monitor Options
• Filter Options

Global Options

Service Options

Routing Modules

• ReadConnRoute
• ReadWriteSplit
• SchemaRouter
• BinlogRouter
• KafkaCDC Router
• AvroRouter
• Cat
• HintRouter
• Mirror Router
• SmartRouter

ReadConnRoute

For (weighted) load balancing.

MariaDB MaxScale Readconnroute Router (readconnroute): 2.0, 2.1, 2.2, 2.3, 2.4, 2.5

ReadWriteSplit

For increased read-only throughput by read write splitting.

MariaDB MaxScale Readwritesplit Router (readwritesplit): 2.0, 2.1, 2.2, 2.3, 2.4, 2.5

SchemaRouter

For sharding.

MariaDB MaxScale Schema Router (schemarouter): 2.0, 2.1, 2.2, 2.3, 2.4, 2.5

Binlogrouter

For binlog routing in massive Master/Slave set-up.

MariaDB MaxScale Binlog Router (binlogrouter): 2.0, 2.1, 2.2, 2.3, 2.4, 2.5

KafkaCDC Router (kafkacdc)

The KafkaCDC module reads data changes in MariaDB via replication and converts them into JSON objects that are then streamed to a Kafka broker.

MariaDB MaxScale KafkaCDC Router: 2.5

AvroRouter

The avrorouter is a MariaDB 10.0 binary log to Apache Avro file converter.

MariaDB MaxScale AvroRouter: 2.5

Cat Router

The cat router is a special router that concatenates result sets.

MariaDB MaxScale Cat Router: 2.5

HintRouter

The HintRouter module is a simple router intended to operate in conjunction with the NamedServerFilter. The router looks at the hints embedded in a packet buffer and attempts to route the packet according to the hint.

MariaDB MaxScale HintRouter: 2.5

Mirror Router

The Mirror Router is designed for data consistency and database behaviour verification during system upgrades. It allows statement duplication to multiple servers in a manner similar to that of the Tee Filter with exporting of collected query metrics.

MariaDB MaxScale Mirror Router: 2.5

Example:

[Mirror-Router]
type=service
router=mirror
user=maxscale
password=secret
targets=mariadb-105,mysql-57
main=mariadb-105
exporter=file
file=/tmp/Mirror-Router.log

SmartRouter

SmartRouter is the query router of the SmartQuery framework. Based on the type of the query, each query is routed to the server or cluster that can best handle it.

MariaDB MaxScale SmartRouter: 2.5

Server Options

A server sections defines the backend database instance to which a client can be connected via MaxScale. For Server status see here.

Listener Options

Monitor Options

See also different MaxScale Monitors.

Filter Options

• Binlog Filter
• Cache
• Consistent Critical Read Filter
• Database Firewall filter
• Hintfilter
• Insert Stream Filter
• Lua Filter
• Masking
• Maxrows
• Named Server Filter
• Query Log All Filter
• Regex Filter
• Tee Filter
• Throttle
• Top Filter
• Transaction Performance Monitoring Filter