Module Parameters for MariaDB MaxScale 2.4

This page is part of MariaDB's Enterprise Documentation.

The parent of this page is: Reference for MariaDB MaxScale 2.4

Topics on this page:

Overview
MariaDB MaxScale 2.4 Module Parameters
- MariaDB Monitor (mariadbmon)
- Read/Write Split Router (readwritesplit)

Overview

MariaDB MaxScale 2.4 supports many module parameters.

Reference material is available for MariaDB MaxScale 2.4.

MariaDB MaxScale 2.4 Module Parameters

The Module Parameters supported by MariaDB MaxScale 2.4 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
assume_unique_hostnames	Type: bool, default value: true
auto_failover	Type: bool, default value: false
auto_rejoin	Type: bool, default value: false
demotion_sql_file	Type: path
detect_replication_lag	Type: bool, default value: false
detect_stale_master	Require that the Primary Server have connectivity with at least one running Replica Server.
detect_stale_slave	Requires that Replica Servers have connectivity with a running Primary Server.
detect_standalone_master	Requires that the Primary Server have at least one Replica Server.
enforce_read_only_slaves	Type: bool, default value: false
enforce_simple_topology	Type: bool, default value: false
failcount	Number of consecutive times MaxScale can fail to reach the Primary Server before it considers it down.
failover_timeout	Type: duration, default value: 90s
handle_events	Type: bool, default value: true
ignore_external_masters	Type: bool, default value: false
maintenance_on_low_disk_space	Type: bool, default value: true
master_failure_timeout	Type: duration, default value: 10s
promotion_sql_file	Type: path
replication_master_ssl	Type: bool, default value: false
replication_password	Type: password string
replication_user	Type: string
servers_no_promotion	Type: serverlist
switchover_on_low_disk_space	Type: bool, default value: false
switchover_timeout	Type: duration, default value: 90s
verify_master_failure	Type: bool, default value: true

Read/Write Split Router (readwritesplit)

The parameters for readwritesplit:

Parameter	Description
causal_reads	Configures read causality, reads subsequent to writes issued in manner to reduce replication lag.
causal_reads_timeout	Timeout for synchronization of the Primary Server with a Replica Server during causal reads.
connection_keepalive	Type: duration, default value: 300s
delayed_retry	Retry queries that fail to route due to connection issues.
delayed_retry_timeout	Timeout for retrying queries that fail to route due to connection issues.
disable_sescmd_history	Type: bool, default value: false
lazy_connect	Type: bool, default value: false
master_accept_reads	Route read operations to the Primary Server or whether it only accepts write operations.
master_failure_mode	Type: enum, default value: fail_instantly
master_reconnection	Reconnect to the Primary Server if it changes mid-session.
max_sescmd_history	Type: count, default value: 50
max_slave_connections	Maximum number of connections the router session can use to connect to Replica Servers.
max_slave_replication_lag	Number of seconds a Replica Server is allowed to fall behind the Primary Server.
optimistic_trx	Type: bool, default value: false
prune_sescmd_history	Type: bool, default value: false
retry_failed_reads	Type: bool, default value: true
slave_selection_criteria	Criteria the router uses to select Replica Servers in load balancing read operations.
strict_multi_stmt	Routes multi-statement queries to the Primary Server.
strict_sp_calls	Routes CALL statements to the Primary Server.
transaction_replay	Replays in progress transactions that fail on a different Server.
transaction_replay_attempts	Maximum number of times to attempt to replay failed transactions.
transaction_replay_max_size	Maximum size in bytes permitted for transaction replays.
transaction_replay_retry_on_deadlock	Maximum number of times the router attempts to replay transactions in the event that the transaction fails due to deadlocks.
use_sql_variables_in	Where the router sends session variable queries.