Module Parameters for MariaDB MaxScale 2.5

Overview

MariaDB MaxScale 2.5 supports many module parameters.

Reference material is available for MariaDB MaxScale 2.5.

MariaDB MaxScale 2.5 Module Parameters

The Module Parameters supported by MariaDB MaxScale 2.5 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: 3s

backend_read_timeout

Type: duration, default value: 3s

backend_write_timeout

Type: duration, default value: 3s

cooperative_monitoring_locks

Type: enum, default value: none

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

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

events

Type: enum_mask, default value: all

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

journal_max_age

Type: duration, default value: 28800s

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: 10s

monitor_interval

Interval of time for performing monitoring checks

password

Type: password string

promotion_sql_file

Type: path

replication_master_ssl

Type: bool, default value: False

replication_password

Type: password string

replication_user

Type: string

script

Type: string

script_timeout

Type: duration, default value: 90s

servers_no_promotion

Type: serverlist

slave_conditions

Type: enum_mask, default value: none

switchover_on_low_disk_space

Type: bool, default value: False

switchover_timeout

Type: duration, default value: 90s

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: 300s

connection_timeout

Type: duration, default value: 0

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

lazy_connect

Type: bool, default value: False

localhost_match_wildcard_host

Type: bool, default value: True

log_auth_warnings

Type: bool, default value: True

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_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

net_write_timeout

Type: duration, default value: 0

optimistic_trx

Type: bool, default value: False

password

Type: password string

prune_sescmd_history

Type: bool, default value: False

rank

Type: enum, default value: primary

retain_last_statements

Type: int, default value: -1

retry_failed_reads

Type: bool, default value: True

router_options

Type: string

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 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_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

user

Type: string

version_string

Type: string

Read Connection Router (readconnroute)

The parameters for readconnroute:

Parameter

Description

auth_all_servers

Type: bool, default value: False

connection_keepalive

Type: duration, default value: 300s

connection_timeout

Type: duration, default value: 0

enable_root_user

Type: bool, default value: False

localhost_match_wildcard_host

Type: bool, default value: True

log_auth_warnings

Type: bool, default value: True

max_connections

Type: count, default value: 0

net_write_timeout

Type: duration, default value: 0

password

Type: password string

rank

Type: enum, default value: primary

retain_last_statements

Type: int, default value: -1

router_options

Type: string

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

version_string

Type: string

MaxScale

The parameters for maxscale:

Parameter

Description

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_log_auth_failures

Type: bool, default value: True

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_cert

Type: string

admin_ssl_cert

Type: string

admin_ssl_key

Type: string

admin_ssl_version

Type: enum, default value: MAX

auth_connect_timeout

Type: duration, default value: 10000

auth_read_timeout

Type: duration, default value: 10000

auth_write_timeout

Type: duration, default value: 10000

debug

Type: string

dump_last_statements

Type: enum, default value: never

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': 0, 'suppress': 0, 'window': 0}

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

maxlog

Type: bool, default value: True

ms_timestamp

Type: bool, default value: False

passive

Type: bool, default value: False

query_classifier

Type: string, default value: qc_sqlite

query_classifier_args

Type: string

query_classifier_cache_size

Type: size, default value: 0

query_retries

Type: int, default value: 1

query_retry_timeout

Type: duration, default value: 5000

rebalance_period

Type: duration, default value: 0

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: True

threads

Type: count, default value: 1

users_refresh_interval

Type: duration, default value: 0

users_refresh_time

Type: duration, default value: 30000

writeq_high_water

Type: size, default value: 16777216

writeq_low_water

Type: size, default value: 8192

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

monitorpw

Type: string

monitoruser

Type: string

persistmaxtime

Type: duration, default value: 0

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_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

The following Module Parameters are not present in MariaDB MaxScale 2.5.21 but are present in one or more older 2.5 versions. Click on an item to see its details, including when it was removed.

Parameter

Description

exclude

Type: regular expression

match

Type: regular expression

rewrite_dest

Type: string

rewrite_src

Type: regular expression

cache_in_transactions

Type: enum, default value: all_transactions

cached_data

Type: enum, default value: thread_specific

clear_cache_on_parse_errors

Type: bool, default value: true

debug

Type: count, default value: 0

enabled

Type: bool, default value: true

hard_ttl

Type: duration, default value: 0ms

invalidate

Type: enum, default value: never

max_count

Type: count, default value: 0

max_resultset_rows

Type: count, default value: 0

max_resultset_size

Type: size, default value: 0

max_size

Type: size, default value: 0

rules

Type: path, default value:

selects

Type: enum, default value: assume_cacheable

soft_ttl

Type: duration, default value: 0ms

storage

Type: string, default value: storage_inmemory

storage_options

Type: string, default value:

users

Type: enum, default value: mixed

count

Type: count, default value: 0

global

Type: bool, default value: false

ignore

Type: regular expression, default value:

match

Type: regular expression, default value:

options

Type: enum_mask, default value: ignorecase

time

Type: duration, default value: 60000ms

inject

Type: quoted string

action

Type: enum, default value: block

log_match

Type: bool, default value: false

log_no_match

Type: bool, default value: false

rules

Type: path

strict

Type: bool, default value: true

treat_string_arg_as_field

Type: bool, default value: true

treat_string_as_field

Type: bool, default value: true

source

Type: string

user

Type: string

check_subqueries

Type: bool, default value: true

check_unions

Type: bool, default value: true

check_user_variables

Type: bool, default value: true

large_payload

Type: enum, default value: abort

prevent_function_usage

Type: bool, default value: true

require_fully_parsed

Type: bool, default value: true

rules

Type: path

treat_string_arg_as_field

Type: bool, default value: true

warn_type_mismatch

Type: enum, default value: never

debug

Type: int, default value: 0

max_resultset_return

Type: enum, default value: empty

max_resultset_rows

Type: count, default value: 4294967295

max_resultset_size

Type: size, default value: 65536

match

Type: string

match01

Type: string

match02

Type: string

match03

Type: string

match04

Type: string

match05

Type: string

match06

Type: string

match07

Type: string

match08

Type: string

match09

Type: string

match10

Type: string

match11

Type: string

match12

Type: string

match13

Type: string

match14

Type: string

match15

Type: string

match16

Type: string

match17

Type: string

match18

Type: string

match19

Type: string

match20

Type: string

match21

Type: string

match22

Type: string

match23

Type: string

match24

Type: string

match25

Type: string

match26

Type: string

match27

Type: string

match28

Type: string

match29

Type: string

options

Type: enum_mask, default value: ignorecase

server

Type: server

source

Type: string

target01

Type: string

target02

Type: string

target03

Type: string

target04

Type: string

target05

Type: string

target06

Type: string

target07

Type: string

target08

Type: string

target09

Type: string

target10

Type: string

target11

Type: string

target12

Type: string

target13

Type: string

target14

Type: string

target15

Type: string

target16

Type: string

target17

Type: string

target18

Type: string

target19

Type: string

target20

Type: string

target21

Type: string

target22

Type: string

target23

Type: string

target24

Type: string

target25

Type: string

target26

Type: string

target27

Type: string

target28

Type: string

target29

Type: string

user

Type: string

capabilities

Type: enum_mask, default value:

append

Type: bool, default value: false

exclude

Type: regular expression

filebase

Type: string

flush

Type: bool, default value: false

log_data

Type: enum_mask, default value: date,user,query

log_type

Type: enum_mask, default value: session

match

Type: regular expression

newline_replacement

Type: quoted string, default value: " "

options

Type: enum_mask, default value: ignorecase

separator

Type: quoted string, default value: ,

source

Type: string

user

Type: string

log_file

Type: string

log_trace

Type: bool, default value: false

match

Type: string

options

Type: enum_mask, default value: ignorecase

replace

Type: string

source

Type: string

user

Type: string

exclude

Type: regular expression

match

Type: regular expression

options

Type: enum_mask, default value: ignorecase

service

Type: service

source

Type: string

target

Type: target

user

Type: string

continuous_duration

Type: duration, default value: 2000ms

max_qps

Type: int

sampling_duration

Type: duration, default value: 250ms

throttling_duration

Type: duration

count

Type: count, default value: 10

exclude

Type: string

filebase

Type: string

match

Type: string

options

Type: enum_mask, default value: ignorecase

source

Type: string

user

Type: string

backend_connect_attempts

Type: count, default value: 1

backend_connect_timeout

Type: duration, default value: 3s

backend_read_timeout

Type: duration, default value: 1s

backend_write_timeout

Type: duration, default value: 2s

disk_space_check_interval

Type: duration, default value: 0ms

disk_space_threshold

Type: string

events

Type: enum_mask, default value: all

journal_max_age

Type: duration, default value: 28800s

monitor_interval

Type: duration, default value: 2000ms

password

Type: password string

script

Type: string

script_timeout

Type: duration, default value: 90s

user

Type: string

backend_connect_attempts

Type: count, default value: 1

backend_connect_timeout

Type: duration, default value: 3s

backend_read_timeout

Type: duration, default value: 1s

backend_write_timeout

Type: duration, default value: 2s

cluster_monitor_interval

Type: duration, default value: 60000ms

disk_space_check_interval

Type: duration, default value: 0ms

disk_space_threshold

Type: string

dynamic_node_detection

Type: bool, default value: true

events

Type: enum_mask, default value: all

health_check_port

Type: int, default value: 3581

health_check_threshold

Type: count, default value: 2

journal_max_age

Type: duration, default value: 28800s

monitor_interval

Type: duration, default value: 2000ms

password

Type: password string

script

Type: string

script_timeout

Type: duration, default value: 90s

user

Type: string

admin_base_path

Type: string, default value: /cmapi/0.4.0

admin_port

Type: count, default value: 8630

api_key

Type: string, default value:

backend_connect_attempts

Type: count, default value: 1

backend_connect_timeout

Type: duration, default value: 3s

backend_read_timeout

Type: duration, default value: 1s

backend_write_timeout

Type: duration, default value: 2s

disk_space_check_interval

Type: duration, default value: 0ms

disk_space_threshold

Type: string

events

Type: enum_mask, default value: all

journal_max_age

Type: duration, default value: 28800s

local_address

Type: string, default value:

monitor_interval

Type: duration, default value: 2000ms

password

Type: password string

primary

Type: server, default value:

script

Type: string

script_timeout

Type: duration, default value: 90s

user

Type: string

version

Type: enum

available_when_donor

Type: bool, default value: false

backend_connect_attempts

Type: count, default value: 1

backend_connect_timeout

Type: duration, default value: 3s

backend_read_timeout

Type: duration, default value: 1s

backend_write_timeout

Type: duration, default value: 2s

disable_master_failback

Type: bool, default value: false

disable_master_role_setting

Type: bool, default value: false

disk_space_check_interval

Type: duration, default value: 0ms

disk_space_threshold

Type: string

events

Type: enum_mask, default value: all

journal_max_age

Type: duration, default value: 28800s

monitor_interval

Type: duration, default value: 2000ms

password

Type: password string

root_node_as_master

Type: bool, default value: false

script

Type: string

script_timeout

Type: duration, default value: 90s

set_donor_nodes

Type: bool, default value: false

use_priority

Type: bool, default value: false

user

Type: string

address

Type: string, default value: ::

authenticator

Type: string

authenticator_options

Type: string, default value:

connection_init_sql_file

Type: path

port

Type: count

protocol

Type: string

socket

Type: string

sql_mode

Type: string

ssl

Type: enum, default value: false

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: path

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

address

Type: string, default value: ::

authenticator

Type: string

authenticator_options

Type: string, default value:

connection_init_sql_file

Type: path

port

Type: count

protocol

Type: string

socket

Type: string

sql_mode

Type: string

ssl

Type: enum, default value: false

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: path

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

auth_all_servers

Type: bool, default value: false

avrodir

Type: path, default value: /var/lib/maxscale

binlogdir

Type: path

block_size

Type: size, default value: 0

codec

Type: enum, default value: null

connection_keepalive

Type: duration, default value: 300s

connection_timeout

Type: duration, default value: 0

enable_root_user

Type: bool, default value: false

exclude

Type: regular expression

filestem

Type: string, default value: mysql-bin

group_rows

Type: count, default value: 1000

group_trx

Type: count, default value: 1

gtid_start_pos

Type: string

localhost_match_wildcard_host

Type: bool, default value: true

log_auth_warnings

Type: bool, default value: true

match

Type: regular expression

max_connections

Type: count, default value: 0

net_write_timeout

Type: duration, default value: 0

password

Type: password string

rank

Type: enum, default value: primary

retain_last_statements

Type: int, default value: -1

router_options

Type: string

server_id

Type: count, default value: 1234

session_trace

Type: bool, default value: false

session_track_trx_state

Type: bool, default value: false

start_index

Type: count, default value: 1

strip_db_esc

Type: bool, default value: true

user

Type: string

version_string

Type: string

auth_all_servers

Type: bool, default value: false

connection_keepalive

Type: duration, default value: 300s

connection_timeout

Type: duration, default value: 0

datadir

Type: path, default value: /var/lib/maxscale/binlogs/

enable_root_user

Type: bool, default value: false

localhost_match_wildcard_host

Type: bool, default value: true

log_auth_warnings

Type: bool, default value: true

max_connections

Type: count, default value: 0

net_timeout

Type: duration, default value: 30000ms

net_write_timeout

Type: duration, default value: 0

password

Type: password string

rank

Type: enum, default value: primary

retain_last_statements

Type: int, default value: -1

router_options

Type: string

select_master

Type: bool, default value: false

server_id

Type: count, default value: 1234

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

version_string

Type: string

auth_all_servers

Type: bool, default value: false

connection_keepalive

Type: duration, default value: 300s

connection_timeout

Type: duration, default value: 0

default_action

Type: enum_mask, default value: master

default_server

Type: server, default value:

enable_root_user

Type: bool, default value: false

localhost_match_wildcard_host

Type: bool, default value: true

log_auth_warnings

Type: bool, default value: true

max_connections

Type: count, default value: 0

max_slaves

Type: int, default value: -1

net_write_timeout

Type: duration, default value: 0

password

Type: password string

rank

Type: enum, default value: primary

retain_last_statements

Type: int, default value: -1

router_options

Type: string

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

version_string

Type: string

auth_all_servers

Type: bool, default value: false

bootstrap_servers

Type: string

connection_keepalive

Type: duration, default value: 300s

connection_timeout

Type: duration, default value: 0

enable_idempotence

Type: bool, default value: false

enable_root_user

Type: bool, default value: false

gtid

Type: string, default value:

localhost_match_wildcard_host

Type: bool, default value: true

log_auth_warnings

Type: bool, default value: true

max_connections

Type: count, default value: 0

net_write_timeout

Type: duration, default value: 0

password

Type: password string

rank

Type: enum, default value: primary

retain_last_statements

Type: int, default value: -1

router_options

Type: string

session_trace

Type: bool, default value: false

session_track_trx_state

Type: bool, default value: false

strip_db_esc

Type: bool, default value: true

timeout

Type: count, default value: 10

topic

Type: string

user

Type: string

version_string

Type: string

auth_all_servers

Type: bool, default value: false

connection_keepalive

Type: duration, default value: 300s

connection_timeout

Type: duration, default value: 0

debug

Type: bool, default value: false

disable_sescmd_history

Type: bool, default value: false

enable_root_user

Type: bool, default value: false

ignore_databases

Type: string

ignore_databases_regex

Type: string

ignore_tables

Type: string

ignore_tables_regex

Type: string

localhost_match_wildcard_host

Type: bool, default value: true

log_auth_warnings

Type: bool, default value: true

max_connections

Type: count, default value: 0

max_sescmd_history

Type: count, default value: 0

net_write_timeout

Type: duration, default value: 0

password

Type: password string

preferred_server

Type: server

rank

Type: enum, default value: primary

refresh_databases

Type: bool, default value: true

refresh_interval

Type: duration, default value: 300s

retain_last_statements

Type: int, default value: -1

router_options

Type: string

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

version_string

Type: string

auth_all_servers

Type: bool, default value: false

connection_keepalive

Type: duration, default value: 300s

connection_timeout

Type: duration, default value: 0

enable_root_user

Type: bool, default value: false

localhost_match_wildcard_host

Type: bool, default value: true

log_auth_warnings

Type: bool, default value: true

master

Type: target

max_connections

Type: count, default value: 0

net_write_timeout

Type: duration, default value: 0

password

Type: password string

persist_performance_data

Type: bool, default value: true

rank

Type: enum, default value: primary

retain_last_statements

Type: int, default value: -1

router_options

Type: string

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

version_string

Type: string