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 22.08?

In 6?

In 2.5?

In 2.4?

address

Protocol.MariaDBProtocol

22.08

6

address

servers.servers

22.08

6

2.5

admin_auth

maxscale.maxscale

22.08

6

2.5

admin_enabled

maxscale.maxscale

22.08

6

2.5

admin_gui

maxscale.maxscale

22.08

6

2.5

admin_host

maxscale.maxscale

22.08

6

2.5

admin_jwt_algorithm

maxscale.maxscale

22.08

admin_jwt_key

maxscale.maxscale

22.08

admin_log_auth_failures

maxscale.maxscale

22.08

6

2.5

admin_pam_readonly_service

maxscale.maxscale

22.08

6

2.5

admin_pam_readwrite_service

maxscale.maxscale

22.08

6

2.5

admin_port

maxscale.maxscale

22.08

6

2.5

admin_secure_gui

maxscale.maxscale

22.08

6

2.5

admin_ssl_ca

maxscale.maxscale

22.08

admin_ssl_ca_cert

maxscale.maxscale

22.08

6

2.5

admin_ssl_cert

maxscale.maxscale

22.08

6

2.5

admin_ssl_key

maxscale.maxscale

22.08

6

2.5

admin_ssl_version

maxscale.maxscale

22.08

6

2.5

assume_unique_hostnames

Monitor.mariadbmon

22.08

6

2.5

2.4

auth_all_servers

Router.readconnroute

22.08

6

2.5

auth_all_servers

Router.readwritesplit

22.08

6

2.5

auth_connect_timeout

maxscale.maxscale

22.08

6

2.5

auth_read_timeout

maxscale.maxscale

22.08

6

2.5

auth_write_timeout

maxscale.maxscale

22.08

6

2.5

authenticator

Protocol.MariaDBProtocol

22.08

6

authenticator

servers.servers

22.08

6

2.5

authenticator_options

Protocol.MariaDBProtocol

22.08

6

auto_failover

Monitor.mariadbmon

22.08

6

2.5

2.4

auto_rejoin

Monitor.mariadbmon

22.08

6

2.5

2.4

auto_tune

maxscale.maxscale

22.08

backend_connect_attempts

Monitor.mariadbmon

22.08

6

2.5

backend_connect_timeout

Monitor.mariadbmon

22.08

6

2.5

backend_read_timeout

Monitor.mariadbmon

22.08

6

2.5

backend_write_timeout

Monitor.mariadbmon

22.08

6

2.5

causal_reads

Router.readwritesplit

22.08

6

2.5

2.4

causal_reads_timeout

Router.readwritesplit

22.08

6

2.5

2.4

config_sync_cluster

maxscale.maxscale

22.08

6

config_sync_interval

maxscale.maxscale

22.08

6

config_sync_password

maxscale.maxscale

22.08

6

config_sync_timeout

maxscale.maxscale

22.08

6

config_sync_user

maxscale.maxscale

22.08

6

connection_init_sql_file

Protocol.MariaDBProtocol

22.08

6

connection_keepalive

Router.readconnroute

22.08

6

2.5

connection_keepalive

Router.readwritesplit

22.08

6

2.5

2.4

connection_timeout

Router.readconnroute

22.08

6

2.5

connection_timeout

Router.readwritesplit

22.08

6

2.5

cooperative_monitoring_locks

Monitor.mariadbmon

22.08

6

2.5

cs_admin_api_key

Monitor.mariadbmon

22.08

cs_admin_base_path

Monitor.mariadbmon

22.08

cs_admin_port

Monitor.mariadbmon

22.08

debug

maxscale.maxscale

22.08

6

2.5

delayed_retry

Router.readwritesplit

22.08

6

2.5

2.4

delayed_retry_timeout

Router.readwritesplit

22.08

6

2.5

2.4

demotion_sql_file

Monitor.mariadbmon

22.08

6

2.5

2.4

detect_replication_lag

Monitor.mariadbmon

2.5

2.4

detect_stale_master

Monitor.mariadbmon

6

2.5

2.4

detect_stale_slave

Monitor.mariadbmon

6

2.5

2.4

detect_standalone_master

Monitor.mariadbmon

6

2.5

2.4

disable_sescmd_history

Router.readconnroute

22.08

6

disable_sescmd_history

Router.readwritesplit

22.08

6

2.5

2.4

disk_space_check_interval

Monitor.mariadbmon

22.08

6

2.5

disk_space_threshold

Monitor.mariadbmon

22.08

6

2.5

disk_space_threshold

servers.servers

22.08

6

2.5

dump_last_statements

maxscale.maxscale

22.08

6

2.5

enable_root_user

Router.readconnroute

22.08

6

2.5

enable_root_user

Router.readwritesplit

22.08

6

2.5

enforce_read_only_slaves

Monitor.mariadbmon

22.08

6

2.5

2.4

enforce_simple_topology

Monitor.mariadbmon

22.08

6

2.5

2.4

enforce_writable_master

Monitor.mariadbmon

22.08

6

events

Monitor.mariadbmon

22.08

6

2.5

extra_port

servers.servers

22.08

6

2.5

failcount

Monitor.mariadbmon

22.08

6

2.5

2.4

failover_timeout

Monitor.mariadbmon

22.08

6

2.5

2.4

handle_events

Monitor.mariadbmon

22.08

6

2.5

2.4

idle_session_pool_time

Router.readconnroute

22.08

6

idle_session_pool_time

Router.readwritesplit

22.08

6

ignore_external_masters

Monitor.mariadbmon

6

2.5

2.4

journal_max_age

Monitor.mariadbmon

22.08

6

2.5

key_manager

maxscale.maxscale

22.08

lazy_connect

Router.readwritesplit

22.08

6

2.5

2.4

load_persisted_configs

maxscale.maxscale

22.08

6

2.5

local_address

maxscale.maxscale

22.08

6

2.5

localhost_match_wildcard_host

Router.readconnroute

22.08

6

2.5

localhost_match_wildcard_host

Router.readwritesplit

22.08

6

2.5

log_auth_warnings

Router.readconnroute

22.08

6

2.5

log_auth_warnings

Router.readwritesplit

22.08

6

2.5

log_debug

Router.readconnroute

22.08

6

log_debug

Router.readwritesplit

22.08

6

log_debug

maxscale.maxscale

22.08

6

2.5

log_info

Router.readconnroute

22.08

6

log_info

Router.readwritesplit

22.08

6

log_info

maxscale.maxscale

22.08

6

2.5

log_notice

Router.readconnroute

22.08

6

log_notice

Router.readwritesplit

22.08

6

log_notice

maxscale.maxscale

22.08

6

2.5

log_throttling

maxscale.maxscale

22.08

6

2.5

log_warn_super_user

maxscale.maxscale

22.08

6

2.5

log_warning

Router.readconnroute

22.08

6

log_warning

Router.readwritesplit

22.08

6

log_warning

maxscale.maxscale

22.08

6

2.5

maintenance_on_low_disk_space

Monitor.mariadbmon

22.08

6

2.5

2.4

master_accept_reads

Router.readconnroute

22.08

6

master_accept_reads

Router.readwritesplit

22.08

6

2.5

2.4

master_conditions

Monitor.mariadbmon

22.08

6

2.5

master_failure_mode

Router.readwritesplit

22.08

6

2.5

2.4

master_failure_timeout

Monitor.mariadbmon

22.08

6

2.5

2.4

master_reconnection

Router.readwritesplit

22.08

6

2.5

2.4

max_auth_errors_until_block

maxscale.maxscale

22.08

6

2.5

max_connections

Router.readconnroute

22.08

6

2.5

max_connections

Router.readwritesplit

22.08

6

2.5

max_read_amount

maxscale.maxscale

22.08

max_replication_lag

Router.readconnroute

22.08

6

max_routing_connections

servers.servers

22.08

6

max_sescmd_history

Router.readconnroute

22.08

6

max_sescmd_history

Router.readwritesplit

22.08

6

2.5

2.4

max_slave_connections

Router.readwritesplit

22.08

6

2.5

2.4

max_slave_replication_lag

Router.readwritesplit

22.08

6

2.5

2.4

maxlog

maxscale.maxscale

22.08

6

2.5

monitor_interval

Monitor.mariadbmon

22.08

6

2.5

monitorpw

servers.servers

22.08

6

2.5

monitoruser

servers.servers

22.08

6

2.5

ms_timestamp

maxscale.maxscale

22.08

6

2.5

multiplex_timeout

Router.readconnroute

22.08

6

multiplex_timeout

Router.readwritesplit

22.08

6

net_write_timeout

Router.readconnroute

22.08

6

2.5

net_write_timeout

Router.readwritesplit

22.08

6

2.5

optimistic_trx

Router.readwritesplit

22.08

6

2.5

2.4

passive

maxscale.maxscale

22.08

6

2.5

password

Monitor.mariadbmon

22.08

6

2.5

password

Router.readconnroute

22.08

6

2.5

password

Router.readwritesplit

22.08

6

2.5

persist_runtime_changes

maxscale.maxscale

22.08

persistmaxtime

servers.servers

22.08

6

2.5

persistpoolmax

servers.servers

22.08

6

2.5

port

Protocol.MariaDBProtocol

22.08

6

port

servers.servers

22.08

6

2.5

priority

servers.servers

22.08

6

2.5

promotion_sql_file

Monitor.mariadbmon

22.08

6

2.5

2.4

protocol

Protocol.MariaDBProtocol

22.08

6

protocol

servers.servers

22.08

6

2.5

proxy_protocol

servers.servers

22.08

6

2.5

prune_sescmd_history

Router.readconnroute

22.08

6

prune_sescmd_history

Router.readwritesplit

22.08

6

2.5

2.4

query_classifier

maxscale.maxscale

22.08

6

2.5

query_classifier_args

maxscale.maxscale

22.08

6

2.5

query_classifier_cache_size

maxscale.maxscale

22.08

6

2.5

query_retries

maxscale.maxscale

22.08

6

2.5

query_retry_timeout

maxscale.maxscale

22.08

6

2.5

rank

Router.readconnroute

22.08

6

2.5

rank

Router.readwritesplit

22.08

6

2.5

rank

servers.servers

22.08

6

2.5

rebalance_period

maxscale.maxscale

22.08

6

2.5

rebalance_threshold

maxscale.maxscale

22.08

6

2.5

rebalance_window

maxscale.maxscale

22.08

6

2.5

rebuild_port

Monitor.mariadbmon

22.08

replication_master_ssl

Monitor.mariadbmon

22.08

6

2.5

2.4

replication_password

Monitor.mariadbmon

22.08

6

2.5

2.4

replication_user

Monitor.mariadbmon

22.08

6

2.5

2.4

retain_last_statements

Router.readconnroute

22.08

6

2.5

retain_last_statements

Router.readwritesplit

22.08

6

2.5

retain_last_statements

maxscale.maxscale

22.08

6

2.5

retry_failed_reads

Router.readwritesplit

22.08

6

2.5

2.4

reuse_prepared_statements

Router.readwritesplit

22.08

6

router_options

Router.readconnroute

22.08

6

2.5

router_options

Router.readwritesplit

2.5

script

Monitor.mariadbmon

22.08

6

2.5

script_max_replication_lag

Monitor.mariadbmon

22.08

6

script_timeout

Monitor.mariadbmon

22.08

6

2.5

servers

Monitor.mariadbmon

22.08

servers_no_promotion

Monitor.mariadbmon

22.08

6

2.5

2.4

service

Protocol.MariaDBProtocol

22.08

6

session_trace

Router.readconnroute

22.08

6

2.5

session_trace

Router.readwritesplit

22.08

6

2.5

session_trace

maxscale.maxscale

22.08

6

2.5

session_track_trx_state

Router.readconnroute

22.08

6

2.5

session_track_trx_state

Router.readwritesplit

22.08

6

2.5

skip_name_resolve

maxscale.maxscale

22.08

6

2.5

skip_permission_checks

maxscale.maxscale

22.08

6

2.5

slave_conditions

Monitor.mariadbmon

22.08

6

2.5

slave_connections

Router.readwritesplit

22.08

6

2.5

slave_selection_criteria

Router.readwritesplit

22.08

6

2.5

2.4

socket

Protocol.MariaDBProtocol

22.08

6

socket

servers.servers

22.08

6

2.5

sql_mode

Protocol.MariaDBProtocol

22.08

6

sql_mode

maxscale.maxscale

22.08

6

2.5

ssh_check_host_key

Monitor.mariadbmon

22.08

ssh_keyfile

Monitor.mariadbmon

22.08

ssh_timeout

Monitor.mariadbmon

22.08

ssh_user

Monitor.mariadbmon

22.08

ssl

Protocol.MariaDBProtocol

22.08

6

ssl

servers.servers

22.08

6

2.5

ssl_ca

servers.servers

22.08

ssl_ca_cert

Protocol.MariaDBProtocol

22.08

6

ssl_ca_cert

servers.servers

22.08

6

2.5

ssl_cert

Protocol.MariaDBProtocol

22.08

6

ssl_cert

servers.servers

22.08

6

2.5

ssl_cert_verify_depth

Protocol.MariaDBProtocol

22.08

6

ssl_cert_verify_depth

servers.servers

22.08

6

2.5

ssl_cipher

Protocol.MariaDBProtocol

22.08

6

ssl_cipher

servers.servers

22.08

6

2.5

ssl_crl

Protocol.MariaDBProtocol

22.08

6

ssl_key

Protocol.MariaDBProtocol

22.08

6

ssl_key

servers.servers

22.08

6

2.5

ssl_verify_peer_certificate

Protocol.MariaDBProtocol

22.08

6

ssl_verify_peer_certificate

servers.servers

22.08

6

2.5

ssl_verify_peer_host

Protocol.MariaDBProtocol

22.08

6

ssl_verify_peer_host

servers.servers

22.08

6

2.5

ssl_version

Protocol.MariaDBProtocol

22.08

6

ssl_version

servers.servers

22.08

6

2.5

strict_multi_stmt

Router.readwritesplit

22.08

6

2.5

2.4

strict_sp_calls

Router.readwritesplit

22.08

6

2.5

2.4

strip_db_esc

Router.readconnroute

22.08

6

2.5

strip_db_esc

Router.readwritesplit

22.08

6

2.5

switchover_on_low_disk_space

Monitor.mariadbmon

22.08

6

2.5

2.4

switchover_timeout

Monitor.mariadbmon

22.08

6

2.5

2.4

syslog

maxscale.maxscale

22.08

6

2.5

threads

maxscale.maxscale

22.08

6

2.5

transaction_replay

Router.readwritesplit

22.08

6

2.5

2.4

transaction_replay_attempts

Router.readwritesplit

22.08

6

2.5

2.4

transaction_replay_checksum

Router.readwritesplit

22.08

6

transaction_replay_max_size

Router.readwritesplit

22.08

6

2.5

2.4

transaction_replay_retry_on_deadlock

Router.readwritesplit

22.08

6

2.5

2.4

transaction_replay_retry_on_mismatch

Router.readwritesplit

22.08

6

transaction_replay_timeout

Router.readwritesplit

22.08

6

type

servers.servers

22.08

6

2.5

use_sql_variables_in

Router.readwritesplit

22.08

6

2.5

2.4

user

Monitor.mariadbmon

22.08

6

2.5

user

Router.readconnroute

22.08

6

2.5

user

Router.readwritesplit

22.08

6

2.5

user_accounts_file

Router.readconnroute

22.08

6

user_accounts_file

Router.readwritesplit

22.08

6

user_accounts_file_usage

Router.readconnroute

22.08

6

user_accounts_file_usage

Router.readwritesplit

22.08

6

user_mapping_file

Protocol.MariaDBProtocol

22.08

6

users_refresh_interval

maxscale.maxscale

22.08

6

2.5

users_refresh_time

maxscale.maxscale

22.08

6

2.5

verify_master_failure

Monitor.mariadbmon

22.08

6

2.5

2.4

version_string

Router.readconnroute

22.08

6

2.5

version_string

Router.readwritesplit

22.08

6

2.5

writeq_high_water

maxscale.maxscale

22.08

6

2.5

writeq_low_water

maxscale.maxscale

22.08

6

2.5