Module Parameters for MariaDB MaxScale 6
This page is part of MariaDB's Documentation.
The parent of this page is: Reference for MariaDB MaxScale 6
Topics on this page:
Overview
MariaDB MaxScale 6 supports many module parameters.
Reference material is available for MariaDB MaxScale 6.
MariaDB MaxScale 6 Module Parameters
The Module Parameters supported by MariaDB MaxScale 6 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 |
|---|---|
Retrieve users from all backend servers instead of only one | |
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 | |
How ofted idle connections are pinged | |
Connection idle timeout | |
Retry queries that fail to route due to connection issues | |
Timeout for retrying queries that fail to route due to connection issues | |
Disable session command history | |
Allow the root user to connect to this service | |
Ping connections unconditionally | |
Put connections into pool after session has been idle for this long | |
Create connections only when needed | |
Match localhost to wildcard host | |
Log a warning when client authentication fails | |
Log debug messages for this service (debug builds only) | |
Log info messages for this service | |
Log notice messages for this service | |
Log warning messages for this service | |
Use master for reads | |
Master failure mode behavior | |
Reconnect to the Primary Server if it changes mid-session | |
Maximum number of connections | |
Session command history size | |
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 | |
How long a session can wait for a connection to become available | |
Network write timeout | |
Optimistically offload transactions to slaves | |
Password for the user used to retrieve database users | |
Prune old session command history if the limit is exceeded | |
Service rank | |
Number of statements kept in memory | |
Automatically retry failed reads outside of transactions | |
Reuse identical prepared statements inside the same connection | |
Enable session tracing for this service | |
Track session state using server responses | |
Starting number of slave connections | |
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 | |
Strip escape characters from database names | |
Replays in progress transactions that fail on a different Server | |
Maximum number of times to attempt to replay failed transactions | |
Type of checksum to calculate for results | |
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 | |
Retry transaction on checksum mismatch | |
Timeout for transaction replay | |
Where the router sends session variable queries | |
Username used to retrieve database users | |
Load additional users from a file | |
When and how the user accounts file is used | |
Custom version string to use |
MariaDB Protocol
The parameters for MariaDBProtocol:
Parameter | Description |
|---|---|
Listener address | |
Listener authenticator | |
Authenticator options | |
Path to connection initialization SQL | |
Listener port | |
Listener protocol to use | |
Service to which the listener connects to | |
Listener UNIX socket | |
SQL parsing mode | |
Enable TLS for server | |
Alias for | |
TLS public certificate | |
TLS certificate verification depth | |
TLS cipher list | |
TLS certificate revocation list | |
TLS private key | |
Verify TLS peer certificate | |
Verify TLS peer host | |
Minimum TLS protocol version | |
Path to user and group mapping file |
Read Connection Router (readconnroute)
The parameters for readconnroute:
Parameter | Description |
|---|---|
Retrieve users from all backend servers instead of only one | |
How ofted idle connections are pinged | |
Connection idle timeout | |
Disable session command history | |
Allow the root user to connect to this service | |
Ping connections unconditionally | |
Put connections into pool after session has been idle for this long | |
Match localhost to wildcard host | |
Log a warning when client authentication fails | |
Log debug messages for this service (debug builds only) | |
Log info messages for this service | |
Log notice messages for this service | |
Log warning messages for this service | |
Route read operations to the Primary Server or whether it only accepts write operations | |
Maximum number of connections | |
Maximum acceptable replication lag | |
Session command history size | |
How long a session can wait for a connection to become available | |
Network write timeout | |
Password for the user used to retrieve database users | |
Prune old session command history if the limit is exceeded | |
Service rank | |
Number of statements kept in memory | |
A comma separated list of server roles | |
Enable session tracing for this service | |
Track session state using server responses | |
Strip escape characters from database names | |
Username used to retrieve database users | |
Load additional users from a file | |
When and how the user accounts file is used | |
Custom version string to use |
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) | |
Cluster used for configuration synchronization. If left empty (i.e., value is ""), synchronization is not done. | |
Database where the 'maxscale_ | |
How often to synchronize the configuration | |
Password for the user used for configuration synchronization | |
Timeout for the configuration synchronization operations | |
User account used for configuration synchronization | |
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 | |
Regular expression that is matched against the contents of the session trace log and if it matches the contents are logged when the session stops | |
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 | |
Maximum routing connections | |
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 6.4.10 but are present in one or more older 6 versions. Click on an item to see its details, including when it was removed.
Parameter | Description |
|---|---|
Object type | |
The cluster of servers to use | |
List of filters to use | |
The router to use | |
List of servers to use | |
List of targets to use | |
The type of the object | |
The cluster of servers to use | |
List of filters to use | |
The router to use | |
List of servers to use | |
List of targets to use | |
The type of the object |