Module Parameters for MariaDB MaxScale 2.5
This page is part of MariaDB's 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 |
|---|---|
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 | |
Number of consecutive times MaxScale can fail to reach the Primary Server before it considers it down | |
Read/Write Split Router (readwritesplit)
The parameters for readwritesplit:
Parameter | Description |
|---|---|
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 | |
Retry queries that fail to route due to connection issues | |
Timeout for retrying queries that fail to route due to connection issues | |
Route read operations to the Primary Server or whether it only accepts write operations | |
Reconnect to the Primary Server if it changes mid-session | |
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 | |
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 | |
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 | |
Read Connection Router (readconnroute)
The parameters for readconnroute:
Parameter | Description |
|---|---|
MaxScale
The parameters for maxscale:
Parameter | Description |
|---|---|
Admin interface authentication | |
Admin interface is enabled | |
Enable admin GUI | |
Admin interface host | |
Log admin interface authentication failures | |
PAM service for read-only users | |
PAM service for read-write users | |
Admin interface port | |
Only serve GUI over HTTPS | |
Admin SSL CA cert | |
Admin SSL cert | |
Admin SSL key | |
Minimum required TLS protocol version for the REST API | |
Connection timeout for fetching user accounts | |
Read timeout for fetching user accounts (deprecated) | |
Write timeout for for fetching user accounts (deprecated) | |
Debug options | |
In what circumstances should the last statements that a client sent be dumped | |
Specifies whether persisted configuration files should be loaded on startup | |
Local address to use when connecting | |
Specifies whether debug messages should be logged (meaningful only with debug builds) | |
Specifies whether info messages should be logged | |
Specifies whether notice messages should be logged | |
Limit the amount of identical log messages than can be logged during a certain time period | |
Log a warning when a user with super privilege logs in | |
Specifies whether warning messages should be logged | |
The maximum number of authentication failures that are tolerated before a host is temporarily blocked | |
Log to MaxScale's own log | |
Enable or disable high precision timestamps | |
True if MaxScale is in passive mode | |
The name of the query classifier to load | |
Arguments for the query classifier | |
Type: size, default value is 15% of available memory | |
Number of times an interrupted query is retried | |
The total timeout in seconds for any retried queries | |
How often should the load of the worker threads be checked and rebalancing be made | |
If the difference in load between the thread with the maximum load and the thread with the minimum load is larger than the value of this parameter, then work will be moved from the former to the latter | |
The load of how many seconds should be taken into account when rebalancing | |
How many statements should be retained for each session for debugging purposes | |
How many log entries are stored in the session specific trace log | |
Do not resolve client IP addresses to hostnames during authentication | |
Skip service and monitor permission checks | |
The query classifier sql mode | |
Log to syslog | |
Type: count, default value is based on cpu count | |
How often the users will be refreshed | |
How often the users can be refreshed | |
High water mark of dcb write queue | |
Low water mark of dcb write queue |
Server Objects
The parameters for server objects:
Parameter | Description |
|---|---|
Server address | |
Server authenticator (deprecated) | |
Server disk space threshold | |
Server extra port | |
Monitor password | |
Monitor user | |
Maximum time that a connection can be in the pool | |
Maximum size of the persistent connection pool | |
Server port | |
Server priority | |
Server protocol (deprecated) | |
Enable proxy protocol | |
Server rank | |
Server UNIX socket | |
Enable TLS for server | |
Alias for | |
TLS public certificate | |
TLS certificate verification depth | |
TLS cipher list | |
TLS private key | |
Verify TLS peer certificate | |
Verify TLS peer host | |
Minimum TLS protocol version | |
Object type |
The following Module Parameters are not present in MariaDB MaxScale 2.5.28 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 |
|---|---|