Module Parameters for MariaDB MaxScale 2.5
This page is part of MariaDB's MariaDB Documentation.
The parent of this page is: Reference for MariaDB MaxScale 2.5
Topics on this page:
Overview
MariaDB MaxScale 2.5 supports many module parameters.
Reference material is available for MariaDB MaxScale 2.5.
MariaDB MaxScale 2.5 Module Parameters
The Module Parameters supported by MariaDB MaxScale 2.5 are listed below.
To see Module Parameters supported in other versions, see "Module Parameters by MariaDB MaxScale Version".
MariaDB Monitor (mariadbmon)
The parameters for mariadbmon:
Parameter | Description |
---|---|
Type: bool, default value: True | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: count, default value: 1 | |
Type: duration, default value: 3s | |
Type: duration, default value: 3s | |
Type: duration, default value: 3s | |
Type: enum, default value: none | |
Type: path | |
Type: bool, default value: False | |
Require that the Primary Server have connectivity with at least one running Replica Server | |
Requires that Replica Servers have connectivity with a running Primary Server | |
Requires that the Primary Server have at least one Replica Server | |
Type: duration, default value: 0ms | |
Type: string | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: enum_ | |
Number of consecutive times MaxScale can fail to reach the Primary Server before it considers it down | |
Type: duration, default value: 90s | |
Type: bool, default value: True | |
Type: bool, default value: False | |
Type: duration, default value: 28800s | |
Type: bool, default value: True | |
Type: enum_ | |
Type: duration, default value: 10s | |
Interval of time for performing monitoring checks | |
Type: password string | |
Type: path | |
Type: bool, default value: False | |
Type: password string | |
Type: string | |
Type: string | |
Type: duration, default value: 90s | |
Type: serverlist | |
Type: enum_ | |
Type: bool, default value: False | |
Type: duration, default value: 90s | |
Type: string | |
Type: bool, default value: True |
Read/Write Split Router (readwritesplit)
The parameters for readwritesplit:
Parameter | Description |
---|---|
Type: bool, default value: False | |
Configures read causality, reads subsequent to writes issued in manner to reduce replication lag | |
Timeout for synchronization of the Primary Server with a Replica Server during causal reads | |
Type: duration, default value: 300s | |
Type: duration, default value: 0 | |
Retry queries that fail to route due to connection issues | |
Timeout for retrying queries that fail to route due to connection issues | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: bool, default value: True | |
Type: bool, default value: True | |
Route read operations to the Primary Server or whether it only accepts write operations | |
Type: enum, default value: fail_ | |
Reconnect to the Primary Server if it changes mid-session | |
Type: count, default value: 0 | |
Type: count, default value: 50 | |
Maximum number of connections the router session can use to connect to Replica Servers | |
Number of seconds a Replica Server is allowed to fall behind the Primary Server | |
Type: duration, default value: 0 | |
Type: bool, default value: False | |
Type: password string | |
Type: bool, default value: False | |
Type: enum, default value: primary | |
Type: int, default value: -1 | |
Type: bool, default value: True | |
Type: string | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: count, default value: 255 | |
Criteria the router uses to select Replica Servers in load balancing read operations | |
Routes multi-statement queries to the Primary Server | |
Routes statements to the Primary Server | |
Type: bool, default value: True | |
Replays in progress transactions that fail on a different Server | |
Maximum number of times to attempt to replay failed transactions | |
Maximum size in bytes permitted for transaction replays | |
Maximum number of times the router attempts to replay transactions in the event that the transaction fails due to deadlocks | |
Where the router sends session variable queries | |
Type: string | |
Type: string |
Read Connection Router (readconnroute)
The parameters for readconnroute:
Parameter | Description |
---|---|
Type: bool, default value: False | |
Type: duration, default value: 300s | |
Type: duration, default value: 0 | |
Type: bool, default value: False | |
Type: bool, default value: True | |
Type: bool, default value: True | |
Type: count, default value: 0 | |
Type: duration, default value: 0 | |
Type: password string | |
Type: enum, default value: primary | |
Type: int, default value: -1 | |
Type: string | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: bool, default value: True | |
Type: string | |
Type: string |
MaxScale
The parameters for maxscale:
Parameter | Description |
---|---|
Type: bool, default value: True | |
Type: bool, default value: True | |
Type: bool, default value: True | |
Type: string, default value: 127.0.0.1 | |
Type: bool, default value: True | |
Type: string | |
Type: string | |
Type: int, default value: 8989 | |
Type: bool, default value: True | |
Type: string | |
Type: string | |
Type: string | |
Type: enum, default value: MAX | |
Type: duration, default value: 10000 | |
Type: duration, default value: 10000 | |
Type: duration, default value: 10000 | |
Type: string | |
Type: enum, default value: never | |
Type: bool, default value: True | |
Type: string | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: bool, default value: True | |
Type: throttling, default value: {'count': 0, 'suppress': 0, 'window': 0} | |
Type: bool, default value: False | |
Type: bool, default value: True | |
Type: int, default value: 10 | |
Type: bool, default value: True | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: string, default value: qc_ | |
Type: string | |
Type: size, default value is 15% of available memory | |
Type: int, default value: 1 | |
Type: duration, default value: 5000 | |
Type: duration, default value: 0 | |
Type: int, default value: 20 | |
Type: count, default value: 10 | |
Type: count, default value: 0 | |
Type: count, default value: 0 | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: enum, default value: default | |
Type: bool, default value: True | |
Type: count, default value is based on cpu count | |
Type: duration, default value: 0 | |
Type: duration, default value: 30000 | |
Type: size, default value: 16777216 | |
Type: size, default value: 8192 |
Server Objects
The parameters for server objects:
Parameter | Description |
---|---|
Type: string | |
Type: string | |
Type: disk_ | |
Type: count, default value: 0 | |
Type: string | |
Type: string | |
Type: duration, default value: 0 | |
Type: count, default value: 0 | |
Type: count, default value: 3306 | |
Type: int, default value: 0 | |
Type: string | |
Type: bool, default value: False | |
Type: enum, default value: primary | |
Type: string | |
Type: bool, default value: False | |
Type: path | |
Type: path | |
Type: count, default value: 9 | |
Type: string | |
Type: path | |
Type: bool, default value: False | |
Type: bool, default value: False | |
Type: enum, default value: MAX | |
Type: string, default value: server |
The following Module Parameters are not present in MariaDB MaxScale 2.5.24 but are present in one or more older 2.5 versions. Click on an item to see its details, including when it was removed.
Parameter | Description |
---|---|
Type: regular expression | |
Type: regular expression | |
Type: string | |
Type: regular expression | |
Type: enum, default value: all_ | |
Type: enum, default value: thread_ | |
Type: bool, default value: true | |
Type: count, default value: 0 | |
Type: bool, default value: true | |
Type: duration, default value: 0ms | |
Type: enum, default value: never | |
Type: count, default value: 0 | |
Type: count, default value: 0 | |
Type: size, default value: 0 | |
Type: size, default value: 0 | |
Type: path, default value: | |
Type: enum, default value: assume_ | |
Type: duration, default value: 0ms | |
Type: string, default value: storage_ | |
Type: string, default value: | |
Type: enum, default value: mixed | |
Type: count, default value: 0 | |
Type: bool, default value: false | |
Type: regular expression, default value: | |
Type: regular expression, default value: | |
Type: enum_ | |
Type: duration, default value: 60000ms | |
Type: quoted string | |
Type: enum, default value: block | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: path | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: string | |
Type: string | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: enum, default value: abort | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: path | |
Type: bool, default value: true | |
Type: enum, default value: never | |
Type: int, default value: 0 | |
Type: enum, default value: empty | |
Type: count, default value: 4294967295 | |
Type: size, default value: 65536 | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: enum_ | |
Type: server | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: enum_ | |
Type: bool, default value: false | |
Type: regular expression | |
Type: string | |
Type: bool, default value: false | |
Type: enum_ | |
Type: enum_ | |
Type: regular expression | |
Type: quoted string, default value: " " | |
Type: enum_ | |
Type: quoted string, default value: , | |
Type: string | |
Type: string | |
Type: string | |
Type: bool, default value: false | |
Type: string | |
Type: enum_ | |
Type: string | |
Type: string | |
Type: string | |
Type: regular expression | |
Type: regular expression | |
Type: enum_ | |
Type: service | |
Type: string | |
Type: target | |
Type: string | |
Type: duration, default value: 2000ms | |
Type: int | |
Type: duration, default value: 250ms | |
Type: duration | |
Type: count, default value: 10 | |
Type: string | |
Type: string | |
Type: string | |
Type: enum_ | |
Type: string | |
Type: string | |
Type: count, default value: 1 | |
Type: duration, default value: 3s | |
Type: duration, default value: 1s | |
Type: duration, default value: 2s | |
Type: duration, default value: 0ms | |
Type: string | |
Type: enum_ | |
Type: duration, default value: 28800s | |
Type: duration, default value: 2000ms | |
Type: password string | |
Type: string | |
Type: duration, default value: 90s | |
Type: string | |
Type: count, default value: 1 | |
Type: duration, default value: 3s | |
Type: duration, default value: 1s | |
Type: duration, default value: 2s | |
Type: duration, default value: 60000ms | |
Type: duration, default value: 0ms | |
Type: string | |
Type: bool, default value: true | |
Type: enum_ | |
Type: int, default value: 3581 | |
Type: count, default value: 2 | |
Type: duration, default value: 28800s | |
Type: duration, default value: 2000ms | |
Type: password string | |
Type: string | |
Type: duration, default value: 90s | |
Type: string | |
Type: string, default value: /cmapi/0.4.0 | |
Type: count, default value: 8630 | |
Type: string, default value: | |
Type: count, default value: 1 | |
Type: duration, default value: 3s | |
Type: duration, default value: 1s | |
Type: duration, default value: 2s | |
Type: duration, default value: 0ms | |
Type: string | |
Type: enum_ | |
Type: duration, default value: 28800s | |
Type: string, default value: | |
Type: duration, default value: 2000ms | |
Type: password string | |
Type: server, default value: | |
Type: string | |
Type: duration, default value: 90s | |
Type: string | |
Type: enum | |
Type: bool, default value: false | |
Type: count, default value: 1 | |
Type: duration, default value: 3s | |
Type: duration, default value: 1s | |
Type: duration, default value: 2s | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: duration, default value: 0ms | |
Type: string | |
Type: enum_ | |
Type: duration, default value: 28800s | |
Type: duration, default value: 2000ms | |
Type: password string | |
Type: bool, default value: false | |
Type: string | |
Type: duration, default value: 90s | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: string | |
Type: string, default value: :: | |
Type: string | |
Type: string, default value: | |
Type: path | |
Type: count | |
Type: string | |
Type: string | |
Type: string | |
Type: enum, default value: false | |
Type: path | |
Type: path | |
Type: count, default value: 9 | |
Type: string | |
Type: path | |
Type: path | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: enum, default value: MAX | |
Type: string, default value: :: | |
Type: string | |
Type: string, default value: | |
Type: path | |
Type: count | |
Type: string | |
Type: string | |
Type: string | |
Type: enum, default value: false | |
Type: path | |
Type: path | |
Type: count, default value: 9 | |
Type: string | |
Type: path | |
Type: path | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: enum, default value: MAX | |
Type: bool, default value: false | |
Type: path, default value: /var/lib/maxscale | |
Type: path | |
Type: size, default value: 0 | |
Type: enum, default value: null | |
Type: duration, default value: 300s | |
Type: duration, default value: 0 | |
Type: bool, default value: false | |
Type: regular expression | |
Type: string, default value: mysql-bin | |
Type: count, default value: 1000 | |
Type: count, default value: 1 | |
Type: string | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: regular expression | |
Type: count, default value: 0 | |
Type: duration, default value: 0 | |
Type: password string | |
Type: enum, default value: primary | |
Type: int, default value: -1 | |
Type: string | |
Type: count, default value: 1234 | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: count, default value: 1 | |
Type: bool, default value: true | |
Type: string | |
Type: string | |
Type: bool, default value: false | |
Type: duration, default value: 300s | |
Type: duration, default value: 0 | |
Type: path, default value: /var/lib/maxscale/binlogs/ | |
Type: bool, default value: false | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: count, default value: 0 | |
Type: duration, default value: 30000ms | |
Type: duration, default value: 0 | |
Type: password string | |
Type: enum, default value: primary | |
Type: int, default value: -1 | |
Type: string | |
Type: bool, default value: false | |
Type: count, default value: 1234 | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: bool, default value: true | |
Type: string | |
Type: string | |
Type: bool, default value: false | |
Type: duration, default value: 300s | |
Type: duration, default value: 0 | |
Type: enum_ | |
Type: server, default value: | |
Type: bool, default value: false | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: count, default value: 0 | |
Type: int, default value: -1 | |
Type: duration, default value: 0 | |
Type: password string | |
Type: enum, default value: primary | |
Type: int, default value: -1 | |
Type: string | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: bool, default value: true | |
Type: string | |
Type: string | |
Type: bool, default value: false | |
Type: string | |
Type: duration, default value: 300s | |
Type: duration, default value: 0 | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: string, default value: | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: count, default value: 0 | |
Type: duration, default value: 0 | |
Type: password string | |
Type: enum, default value: primary | |
Type: int, default value: -1 | |
Type: string | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: bool, default value: true | |
Type: count, default value: 10 | |
Type: string | |
Type: string | |
Type: string | |
Type: bool, default value: false | |
Type: duration, default value: 300s | |
Type: duration, default value: 0 | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: string | |
Type: string | |
Type: string | |
Type: string | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: count, default value: 0 | |
Type: count, default value: 0 | |
Type: duration, default value: 0 | |
Type: password string | |
Type: server | |
Type: enum, default value: primary | |
Type: bool, default value: true | |
Type: duration, default value: 300s | |
Type: int, default value: -1 | |
Type: string | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: bool, default value: true | |
Type: string | |
Type: string | |
Type: bool, default value: false | |
Type: duration, default value: 300s | |
Type: duration, default value: 0 | |
Type: bool, default value: false | |
Type: bool, default value: true | |
Type: bool, default value: true | |
Type: target | |
Type: count, default value: 0 | |
Type: duration, default value: 0 | |
Type: password string | |
Type: bool, default value: true | |
Type: enum, default value: primary | |
Type: int, default value: -1 | |
Type: string | |
Type: bool, default value: false | |
Type: bool, default value: false | |
Type: bool, default value: true | |
Type: string | |
Type: string |