Module Parameters for MariaDB MaxScale

Overview

MariaDB MaxScale supports many module parameters.

Reference material is available for MariaDB MaxScale.

Module Parameters by MariaDB MaxScale Version

Choose a version of MariaDB MaxScale to see the Module Parameters supported by that version:

Support Matrix by Version

A summary of Module Parameters across MariaDB MaxScale versions:

Parameter

Module

In 6.2?

In 6.1?

In 2.5?

In 2.4?

In 2.3?

address

Protocol.MariaDBClient

2.5

address

Protocol.MariaDBProtocol

6.2

6.1

address

servers.servers

6.2

6.1

2.5

admin_auth

maxscale.maxscale

6.2

6.1

2.5

admin_enabled

maxscale.maxscale

6.2

6.1

2.5

admin_gui

maxscale.maxscale

6.2

6.1

2.5

admin_host

maxscale.maxscale

6.2

6.1

2.5

admin_log_auth_failures

maxscale.maxscale

6.2

6.1

2.5

admin_pam_readonly_service

maxscale.maxscale

6.2

6.1

2.5

admin_pam_readwrite_service

maxscale.maxscale

6.2

6.1

2.5

admin_port

maxscale.maxscale

6.2

6.1

2.5

admin_secure_gui

maxscale.maxscale

6.2

6.1

2.5

admin_ssl_ca_cert

maxscale.maxscale

6.2

6.1

2.5

admin_ssl_cert

maxscale.maxscale

6.2

6.1

2.5

admin_ssl_key

maxscale.maxscale

6.2

6.1

2.5

admin_ssl_version

maxscale.maxscale

6.2

6.1

2.5

allow_cluster_recovery

Monitor.mariadbmon

2.3

assume_unique_hostnames

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

auth_all_servers

Router.readconnroute

6.2

6.1

2.5

auth_all_servers

Router.readwritesplit

6.2

6.1

2.5

auth_connect_timeout

maxscale.maxscale

6.2

6.1

2.5

auth_read_timeout

maxscale.maxscale

6.2

6.1

2.5

auth_write_timeout

maxscale.maxscale

6.2

6.1

2.5

authenticator

Protocol.MariaDBClient

2.5

authenticator

Protocol.MariaDBProtocol

6.2

6.1

authenticator

servers.servers

6.2

6.1

2.5

authenticator_options

Protocol.MariaDBClient

2.5

authenticator_options

Protocol.MariaDBProtocol

6.2

6.1

auto_failover

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

auto_rejoin

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

backend_connect_attempts

Monitor.mariadbmon

6.2

6.1

2.5

backend_connect_timeout

Monitor.mariadbmon

6.2

6.1

2.5

backend_read_timeout

Monitor.mariadbmon

6.2

6.1

2.5

backend_write_timeout

Monitor.mariadbmon

6.2

6.1

2.5

causal_reads

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

causal_reads_timeout

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

cluster

Router.readconnroute

6.2

6.1

cluster

Router.readwritesplit

6.2

6.1

config_sync_cluster

maxscale.maxscale

6.2

6.1

config_sync_interval

maxscale.maxscale

6.2

6.1

config_sync_password

maxscale.maxscale

6.2

6.1

config_sync_timeout

maxscale.maxscale

6.2

6.1

config_sync_user

maxscale.maxscale

6.2

6.1

connection_init_sql_file

Protocol.MariaDBClient

2.5

connection_init_sql_file

Protocol.MariaDBProtocol

6.2

6.1

connection_keepalive

Router.readconnroute

6.2

6.1

2.5

connection_keepalive

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

connection_timeout

Router.readconnroute

6.2

6.1

2.5

connection_timeout

Router.readwritesplit

6.2

6.1

2.5

cooperative_monitoring_locks

Monitor.mariadbmon

6.2

6.1

2.5

debug

maxscale.maxscale

6.2

6.1

2.5

delayed_retry

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

delayed_retry_timeout

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

demotion_sql_file

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

detect_replication_lag

Monitor.mariadbmon

2.5

2.4

2.3

detect_stale_master

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

detect_stale_slave

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

detect_standalone_master

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

disable_sescmd_history

Router.readconnroute

6.2

6.1

disable_sescmd_history

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

disk_space_check_interval

Monitor.mariadbmon

6.2

6.1

2.5

disk_space_threshold

Monitor.mariadbmon

6.2

6.1

2.5

disk_space_threshold

servers.servers

6.2

6.1

2.5

dump_last_statements

maxscale.maxscale

6.2

6.1

2.5

enable_root_user

Router.readconnroute

6.2

6.1

2.5

enable_root_user

Router.readwritesplit

6.2

6.1

2.5

enforce_read_only_slaves

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

enforce_simple_topology

Monitor.mariadbmon

6.2

6.1

2.5

2.4

enforce_writable_master

Monitor.mariadbmon

6.2

6.1

events

Monitor.mariadbmon

6.2

6.1

2.5

extra_port

servers.servers

6.2

6.1

2.5

failcount

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

failover_timeout

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

filters

Router.readconnroute

6.2

6.1

filters

Router.readwritesplit

6.2

6.1

handle_events

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

idle_session_pool_time

Router.readconnroute

6.2

6.1

idle_session_pool_time

Router.readwritesplit

6.2

6.1

ignore_external_masters

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

journal_max_age

Monitor.mariadbmon

6.2

6.1

2.5

lazy_connect

Router.readwritesplit

6.2

6.1

2.5

2.4

load_persisted_configs

maxscale.maxscale

6.2

6.1

2.5

local_address

maxscale.maxscale

6.2

6.1

2.5

localhost_match_wildcard_host

Router.readconnroute

6.2

6.1

2.5

localhost_match_wildcard_host

Router.readwritesplit

6.2

6.1

2.5

log_auth_warnings

Router.readconnroute

6.2

6.1

2.5

log_auth_warnings

Router.readwritesplit

6.2

6.1

2.5

log_debug

maxscale.maxscale

6.2

6.1

2.5

log_info

maxscale.maxscale

6.2

6.1

2.5

log_notice

maxscale.maxscale

6.2

6.1

2.5

log_throttling

maxscale.maxscale

6.2

6.1

2.5

log_warn_super_user

maxscale.maxscale

6.2

6.1

2.5

log_warning

maxscale.maxscale

6.2

6.1

2.5

maintenance_on_low_disk_space

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

master_accept_reads

Router.readconnroute

6.2

6.1

master_accept_reads

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

master_conditions

Monitor.mariadbmon

6.2

6.1

2.5

master_failure_mode

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

master_failure_timeout

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

master_reconnection

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

max_auth_errors_until_block

maxscale.maxscale

6.2

6.1

2.5

max_connections

Router.readconnroute

6.2

6.1

2.5

max_connections

Router.readwritesplit

6.2

6.1

2.5

max_replication_lag

Router.readconnroute

6.2

6.1

max_sescmd_history

Router.readconnroute

6.2

6.1

max_sescmd_history

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

max_slave_connections

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

max_slave_replication_lag

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

maxlog

maxscale.maxscale

6.2

6.1

2.5

monitor_interval

Monitor.mariadbmon

6.2

6.1

2.5

monitorpw

servers.servers

6.2

6.1

2.5

monitoruser

servers.servers

6.2

6.1

2.5

ms_timestamp

maxscale.maxscale

6.2

6.1

2.5

multimaster

Monitor.mariadbmon

2.3

mysql51_replication

Monitor.mariadbmon

2.3

net_write_timeout

Router.readconnroute

6.2

6.1

2.5

net_write_timeout

Router.readwritesplit

6.2

6.1

2.5

optimistic_trx

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

passive

maxscale.maxscale

6.2

6.1

2.5

password

Monitor.mariadbmon

6.2

6.1

2.5

password

Router.readconnroute

6.2

6.1

2.5

password

Router.readwritesplit

6.2

6.1

2.5

persistmaxtime

servers.servers

6.2

6.1

2.5

persistpoolmax

servers.servers

6.2

6.1

2.5

port

Protocol.MariaDBClient

2.5

port

Protocol.MariaDBProtocol

6.2

6.1

port

servers.servers

6.2

6.1

2.5

priority

servers.servers

6.2

6.1

2.5

promotion_sql_file

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

protocol

Protocol.MariaDBClient

2.5

protocol

Protocol.MariaDBProtocol

6.2

6.1

protocol

servers.servers

6.2

6.1

2.5

proxy_protocol

servers.servers

6.2

6.1

2.5

prune_sescmd_history

Router.readconnroute

6.2

6.1

prune_sescmd_history

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

query_classifier

maxscale.maxscale

6.2

6.1

2.5

query_classifier_args

maxscale.maxscale

6.2

6.1

2.5

query_classifier_cache_size

maxscale.maxscale

6.2

6.1

2.5

query_retries

maxscale.maxscale

6.2

6.1

2.5

query_retry_timeout

maxscale.maxscale

6.2

6.1

2.5

rank

Router.readconnroute

6.2

6.1

2.5

rank

Router.readwritesplit

6.2

6.1

2.5

rank

servers.servers

6.2

6.1

2.5

rebalance_period

maxscale.maxscale

6.2

6.1

2.5

rebalance_threshold

maxscale.maxscale

6.2

6.1

2.5

rebalance_window

maxscale.maxscale

6.2

6.1

2.5

replication_master_ssl

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

replication_password

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

replication_user

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

retain_last_statements

Router.readconnroute

6.2

6.1

2.5

retain_last_statements

Router.readwritesplit

6.2

6.1

2.5

retain_last_statements

maxscale.maxscale

6.2

6.1

2.5

retry_failed_reads

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

reuse_prepared_statements

Router.readwritesplit

6.2

6.1

router

Router.readconnroute

6.2

6.1

router

Router.readwritesplit

6.2

6.1

router_options

Router.readconnroute

6.2

6.1

2.5

router_options

Router.readwritesplit

2.5

script

Monitor.mariadbmon

6.2

6.1

2.5

script_max_replication_lag

Monitor.mariadbmon

6.2

6.1

script_timeout

Monitor.mariadbmon

6.2

6.1

2.5

servers

Router.readconnroute

6.2

6.1

servers

Router.readwritesplit

6.2

6.1

servers_no_promotion

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

service

Protocol.MariaDBProtocol

6.2

6.1

session_trace

Router.readconnroute

6.2

6.1

2.5

session_trace

Router.readwritesplit

6.2

6.1

2.5

session_trace

maxscale.maxscale

6.2

6.1

2.5

session_track_trx_state

Router.readconnroute

6.2

6.1

2.5

session_track_trx_state

Router.readwritesplit

6.2

6.1

2.5

skip_permission_checks

maxscale.maxscale

6.2

6.1

2.5

slave_conditions

Monitor.mariadbmon

6.2

6.1

2.5

slave_connections

Router.readwritesplit

6.2

6.1

2.5

slave_selection_criteria

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

socket

Protocol.MariaDBClient

2.5

socket

Protocol.MariaDBProtocol

6.2

6.1

socket

servers.servers

6.2

6.1

2.5

sql_mode

Protocol.MariaDBClient

2.5

sql_mode

Protocol.MariaDBProtocol

6.2

6.1

sql_mode

maxscale.maxscale

6.2

6.1

2.5

ssl

Protocol.MariaDBClient

2.5

ssl

Protocol.MariaDBProtocol

6.2

6.1

ssl

servers.servers

6.2

6.1

2.5

ssl_ca_cert

Protocol.MariaDBClient

2.5

ssl_ca_cert

Protocol.MariaDBProtocol

6.2

6.1

ssl_ca_cert

servers.servers

6.2

6.1

2.5

ssl_cert

Protocol.MariaDBClient

2.5

ssl_cert

Protocol.MariaDBProtocol

6.2

6.1

ssl_cert

servers.servers

6.2

6.1

2.5

ssl_cert_verify_depth

Protocol.MariaDBClient

2.5

ssl_cert_verify_depth

Protocol.MariaDBProtocol

6.2

6.1

ssl_cert_verify_depth

servers.servers

6.2

6.1

2.5

ssl_cipher

Protocol.MariaDBClient

2.5

ssl_cipher

Protocol.MariaDBProtocol

6.2

6.1

ssl_cipher

servers.servers

6.2

6.1

2.5

ssl_crl

Protocol.MariaDBClient

2.5

ssl_crl

Protocol.MariaDBProtocol

6.2

6.1

ssl_key

Protocol.MariaDBClient

2.5

ssl_key

Protocol.MariaDBProtocol

6.2

6.1

ssl_key

servers.servers

6.2

6.1

2.5

ssl_verify_peer_certificate

Protocol.MariaDBClient

2.5

ssl_verify_peer_certificate

Protocol.MariaDBProtocol

6.2

6.1

ssl_verify_peer_certificate

servers.servers

6.2

6.1

2.5

ssl_verify_peer_host

Protocol.MariaDBClient

2.5

ssl_verify_peer_host

Protocol.MariaDBProtocol

6.2

6.1

ssl_verify_peer_host

servers.servers

6.2

6.1

2.5

ssl_version

Protocol.MariaDBClient

2.5

ssl_version

Protocol.MariaDBProtocol

6.2

6.1

ssl_version

servers.servers

6.2

6.1

2.5

strict_multi_stmt

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

strict_sp_calls

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

strip_db_esc

Router.readconnroute

6.2

6.1

2.5

strip_db_esc

Router.readwritesplit

6.2

6.1

2.5

switchover_on_low_disk_space

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

switchover_timeout

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

syslog

maxscale.maxscale

6.2

6.1

2.5

targets

Router.readconnroute

6.2

6.1

targets

Router.readwritesplit

6.2

6.1

threads

maxscale.maxscale

6.2

6.1

2.5

transaction_replay

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

transaction_replay_attempts

Router.readwritesplit

6.2

6.1

2.5

2.4

transaction_replay_max_size

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

transaction_replay_retry_on_deadlock

Router.readwritesplit

6.2

6.1

2.5

2.4

type

Protocol.MariaDBProtocol

6.2

6.1

type

Router.readconnroute

6.2

6.1

type

Router.readwritesplit

6.2

6.1

type

servers.servers

6.2

6.1

2.5

use_sql_variables_in

Router.readwritesplit

6.2

6.1

2.5

2.4

2.3

user

Monitor.mariadbmon

6.2

6.1

2.5

user

Router.readconnroute

6.2

6.1

2.5

user

Router.readwritesplit

6.2

6.1

2.5

user_accounts_file

Router.readconnroute

6.2

user_accounts_file

Router.readwritesplit

6.2

user_accounts_file_usage

Router.readconnroute

6.2

user_accounts_file_usage

Router.readwritesplit

6.2

user_mapping_file

Protocol.MariaDBProtocol

6.2

users_refresh_interval

maxscale.maxscale

6.2

6.1

2.5

users_refresh_time

maxscale.maxscale

6.2

6.1

2.5

verify_master_failure

Monitor.mariadbmon

6.2

6.1

2.5

2.4

2.3

version_string

Router.readconnroute

6.2

6.1

2.5

version_string

Router.readwritesplit

6.2

6.1

2.5

writeq_high_water

maxscale.maxscale

6.2

6.1

2.5

writeq_low_water

maxscale.maxscale

6.2

6.1

2.5