Module Parameters for MariaDB MaxScale 22.08

This page is part of MariaDB's MariaDB Documentation.

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

Topics on this page:

Overview
MariaDB MaxScale 22.08 Module Parameters

Overview

MariaDB MaxScale 22.08 supports many module parameters.

Reference material is available for MariaDB MaxScale 22.08.

MariaDB MaxScale 22.08 Module Parameters

The Module Parameters supported by MariaDB MaxScale 22.08 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
backend_connect_attempts	Type: count, default value: 1
backend_connect_timeout	Type: duration, default value: 3000ms
backend_read_timeout	Type: duration, default value: 3000ms
backend_write_timeout	Type: duration, default value: 3000ms
cooperative_monitoring_locks	Type: enum, default value: none
cs_admin_api_key	Type: string
cs_admin_base_path	Type: string, default value: /cmapi/0.4.0
cs_admin_port	Type: count, default value: 8640
demotion_sql_file	Type: path
disk_space_check_interval	Type: duration, default value: 0ms
disk_space_threshold	Type: string
enforce_read_only_slaves	Type: bool, default value: False
enforce_simple_topology	Type: bool, default value: False
enforce_writable_master	Type: bool, default value: False
events	Type: enum_mask, default value: all,master_down,master_up,slave_down,slave_up,server_down,server_up,synced_down,synced_up,donor_down,donor_up,lost_master,lost_slave,lost_synced,lost_donor,new_master,new_slave,new_synced,new_donor
failcount	Number of consecutive times MaxScale can fail to reach the Primary Server before it considers it down
failover_timeout	Type: duration, default value: 90000ms
handle_events	Type: bool, default value: True
journal_max_age	Type: duration, default value: 28800000ms
maintenance_on_low_disk_space	Type: bool, default value: True
master_conditions	Type: enum_mask, default value: primary_monitor_master
master_failure_timeout	Type: duration, default value: 10000ms
monitor_interval	Interval of time for performing monitoring checks
password	Type: password
promotion_sql_file	Type: path
rebuild_port	Type: count, default value: 4444
replication_master_ssl	Type: bool, default value: False
replication_password	Type: password, default value: *****
replication_user	Type: string
script	Type: string
script_max_replication_lag	Type: int, default value: -1
script_timeout	Type: duration, default value: 90000ms
servers	Type: serverlist
servers_no_promotion	Type: serverlist
slave_conditions	Type: enum_mask, default value:
ssh_check_host_key	Type: bool, default value: True
ssh_keyfile	Type: path
ssh_port	Type: count, default value: 22
ssh_timeout	Type: duration, default value: 10000ms
ssh_user	Type: string
switchover_on_low_disk_space	Type: bool, default value: False
switchover_timeout	Type: duration, default value: 90000ms
user	Type: string
verify_master_failure	Type: bool, default value: True

Read/Write Split Router (readwritesplit)

The parameters for readwritesplit:

Parameter	Description
auth_all_servers	Type: bool, default value: False
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: 300000ms
connection_timeout	Type: duration, default value: 0ms
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
enable_root_user	Type: bool, default value: False
idle_session_pool_time	Type: duration, default value: -1ms
lazy_connect	Type: bool, default value: False
localhost_match_wildcard_host	Type: bool, default value: True
log_auth_warnings	Type: bool, default value: True
log_debug	Type: bool, default value: False
log_info	Type: bool, default value: False
log_notice	Type: bool, default value: False
log_warning	Type: bool, default value: False
master_accept_reads	Type: bool, default value: False
master_failure_mode	Type: enum, default value: fail_instantly
master_reconnection	Reconnect to the Primary Server if it changes mid-session
max_connections	Type: count, default value: 0
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
multiplex_timeout	Type: duration, default value: 60000ms
net_write_timeout	Type: duration, default value: 0ms
optimistic_trx	Type: bool, default value: False
password	Type: password
prune_sescmd_history	Type: bool, default value: True
rank	Type: enum, default value: primary
retain_last_statements	Type: int, default value: -1
retry_failed_reads	Type: bool, default value: True
reuse_prepared_statements	Type: bool, default value: False
session_trace	Type: bool, default value: False
session_track_trx_state	Type: bool, default value: False
slave_connections	Type: count, default value: 255
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 CALL statements to the Primary Server
strip_db_esc	Type: bool, default value: True
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_checksum	Type: enum, default value: full
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
transaction_replay_retry_on_mismatch	Type: bool, default value: False
transaction_replay_timeout	Type: duration, default value: 0ms
use_sql_variables_in	Where the router sends session variable queries
user	Type: string
user_accounts_file	Type: path
user_accounts_file_usage	Type: enum, default value: add_when_load_ok
version_string	Type: string

MariaDB Protocol

The parameters for MariaDBProtocol:

Parameter	Description
address	Type: string, default value: ::
authenticator	Type: string
authenticator_options	Type: string
connection_init_sql_file	Type: path
port	Type: count, default value: 0
protocol	Type: module
service	Type: service
socket	Type: string
sql_mode	Type: enum, default value: default
ssl	Type: bool, default value: False
ssl_ca	Type: path
ssl_ca_cert	Type: path
ssl_cert	Type: path
ssl_cert_verify_depth	Type: count, default value: 9
ssl_cipher	Type: string
ssl_crl	Type: string
ssl_key	Type: path
ssl_verify_peer_certificate	Type: bool, default value: False
ssl_verify_peer_host	Type: bool, default value: False
ssl_version	Type: enum, default value: MAX
user_mapping_file	Type: path

Read Connection Router (readconnroute)

The parameters for readconnroute:

Parameter	Description
auth_all_servers	Type: bool, default value: False
connection_keepalive	Type: duration, default value: 300000ms
connection_timeout	Type: duration, default value: 0ms
disable_sescmd_history	Type: bool, default value: False
enable_root_user	Type: bool, default value: False
idle_session_pool_time	Type: duration, default value: -1ms
localhost_match_wildcard_host	Type: bool, default value: True
log_auth_warnings	Type: bool, default value: True
log_debug	Type: bool, default value: False
log_info	Type: bool, default value: False
log_notice	Type: bool, default value: False
log_warning	Type: bool, default value: False
master_accept_reads	Route read operations to the Primary Server or whether it only accepts write operations
max_connections	Type: count, default value: 0
max_replication_lag	Type: duration, default value: 0ms
max_sescmd_history	Type: count, default value: 50
multiplex_timeout	Type: duration, default value: 60000ms
net_write_timeout	Type: duration, default value: 0ms
password	Type: password
prune_sescmd_history	Type: bool, default value: True
rank	Type: enum, default value: primary
retain_last_statements	Type: int, default value: -1
router_options	Type: enum_mask, default value: running
session_trace	Type: bool, default value: False
session_track_trx_state	Type: bool, default value: False
strip_db_esc	Type: bool, default value: True
user	Type: string
user_accounts_file	Type: path
user_accounts_file_usage	Type: enum, default value: add_when_load_ok
version_string	Type: string

MaxScale

The parameters for maxscale:

Parameter	Description
admin_auth	Type: bool, default value: True
admin_enabled	Type: bool, default value: True
admin_gui	Type: bool, default value: True
admin_host	Type: string, default value: 127.0.0.1
admin_jwt_algorithm	Type: enum, default value: auto
admin_jwt_key	Type: string
admin_log_auth_failures	Type: bool, default value: True
admin_oidc_url	Type: string
admin_pam_readonly_service	Type: string
admin_pam_readwrite_service	Type: string
admin_port	Type: int, default value: 8989
admin_secure_gui	Type: bool, default value: True
admin_ssl_ca	Type: path
admin_ssl_ca_cert	Type: path
admin_ssl_cert	Type: path
admin_ssl_key	Type: path
admin_ssl_version	Type: enum, default value: MAX
admin_verify_url	Type: string
auth_connect_timeout	Type: duration, default value: 10000ms
auth_read_timeout	Type: duration, default value: 10000ms
auth_write_timeout	Type: duration, default value: 10000ms
auto_tune	Type: stringlist, default value: []
config_sync_cluster	Type: string
config_sync_interval	Type: duration, default value: 5000ms
config_sync_password	Type: password, default value: *****
config_sync_timeout	Type: duration, default value: 10000ms
config_sync_user	Type: string
debug	Type: string
dump_last_statements	Type: enum, default value: never
key_manager	Type: enum, default value: none
load_persisted_configs	Type: bool, default value: True
local_address	Type: string
log_debug	Type: bool, default value: False
log_info	Type: bool, default value: False
log_notice	Type: bool, default value: True
log_throttling	Type: throttling, default value: {'count': 10, 'suppress': 10000, 'window': 1000}
log_warn_super_user	Type: bool, default value: False
log_warning	Type: bool, default value: True
max_auth_errors_until_block	Type: int, default value: 10
max_read_amount	Type: size, default value: 0
maxlog	Type: bool, default value: True
ms_timestamp	Type: bool, default value: False
passive	Type: bool, default value: False
persist_runtime_changes	Type: bool, default value: True
query_classifier	Type: string, default value: qc_sqlite
query_classifier_args	Type: string
query_classifier_cache_size	Type: size, default value is 15% of available memory
query_retries	Type: int, default value: 1
query_retry_timeout	Type: duration, default value: 5000ms
rebalance_period	Type: duration, default value: 0ms
rebalance_threshold	Type: int, default value: 20
rebalance_window	Type: count, default value: 10
retain_last_statements	Type: count, default value: 0
session_trace	Type: count, default value: 0
skip_name_resolve	Type: bool, default value: False
skip_permission_checks	Type: bool, default value: False
sql_mode	Type: enum, default value: default
syslog	Type: bool, default value: False
threads	Type: count, default value is based on cpu count
users_refresh_interval	Type: duration, default value: 0ms
users_refresh_time	Type: duration, default value: 30000ms
writeq_high_water	Type: size, default value: 65536
writeq_low_water	Type: size, default value: 1024

Server Objects

The parameters for server objects:

Parameter	Description
address	Type: string
authenticator	Type: string
disk_space_threshold	Type: disk_space_limits
extra_port	Type: count, default value: 0
max_routing_connections	Type: count, default value: 0
monitorpw	Type: string
monitoruser	Type: string
persistmaxtime	Type: duration, default value: 0ms
persistpoolmax	Type: count, default value: 0
port	Type: count, default value: 3306
priority	Type: int, default value: 0
protocol	Type: string
proxy_protocol	Type: bool, default value: False
rank	Type: enum, default value: primary
socket	Type: string
ssl	Type: bool, default value: False
ssl_ca	Type: path
ssl_ca_cert	Type: path
ssl_cert	Type: path
ssl_cert_verify_depth	Type: count, default value: 9
ssl_cipher	Type: string
ssl_key	Type: path
ssl_verify_peer_certificate	Type: bool, default value: False
ssl_verify_peer_host	Type: bool, default value: False
ssl_version	Type: enum, default value: MAX
type	Type: string, default value: server