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".

Read/Write Split Router (readwritesplit)

The parameters for readwritesplit:

Parameter

Description

auth_all_servers

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

connection_timeout

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

enable_root_user

force_connection_keepalive

lazy_connect

localhost_match_wildcard_host

log_auth_warnings

master_accept_reads

Route read operations to the Primary Server or whether it only accepts write operations

master_failure_mode

master_reconnection

Reconnect to the Primary Server if it changes mid-session

max_connections

max_sescmd_history

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

optimistic_trx

password

prune_sescmd_history

rank

retain_last_statements

retry_failed_reads

router_options

session_trace

session_track_trx_state

slave_connections

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 CALLCALL statements to the Primary Server

strip_db_esc

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

version_string

MaxScale

The parameters for maxscale:

Parameter

Description

admin_auth

Admin interface authentication

admin_enabled

Admin interface is enabled

admin_gui

Enable admin GUI

admin_host

Admin interface host

admin_log_auth_failures

Log admin interface authentication failures

admin_pam_readonly_service

PAM service for read-only users

admin_pam_readwrite_service

PAM service for read-write users

admin_port

Admin interface port

admin_secure_gui

Only serve GUI over HTTPS

admin_ssl_ca_cert

Admin SSL CA cert

admin_ssl_cert

Admin SSL cert

admin_ssl_key

Admin SSL key

admin_ssl_version

Minimum required TLS protocol version for the REST API

auth_connect_timeout

Connection timeout for fetching user accounts

auth_read_timeout

Read timeout for fetching user accounts (deprecated)

auth_write_timeout

Write timeout for for fetching user accounts (deprecated)

debug

Debug options

dump_last_statements

In what circumstances should the last statements that a client sent be dumped

load_persisted_configs

Specifies whether persisted configuration files should be loaded on startup

local_address

Local address to use when connecting

log_debug

Specifies whether debug messages should be logged (meaningful only with debug builds)

log_info

Specifies whether info messages should be logged

log_notice

Specifies whether notice messages should be logged

log_throttling

Limit the amount of identical log messages than can be logged during a certain time period

log_warn_super_user

Log a warning when a user with super privilege logs in

log_warning

Specifies whether warning messages should be logged

max_auth_errors_until_block

The maximum number of authentication failures that are tolerated before a host is temporarily blocked

maxlog

Log to MaxScale's own log

ms_timestamp

Enable or disable high precision timestamps

passive

True if MaxScale is in passive mode

query_classifier

The name of the query classifier to load

query_classifier_args

Arguments for the query classifier

query_classifier_cache_size

Type: size, default value is 15% of available memory

query_retries

Number of times an interrupted query is retried

query_retry_timeout

The total timeout in seconds for any retried queries

rebalance_period

How often should the load of the worker threads be checked and rebalancing be made

rebalance_threshold

If the difference in load between the thread with the maximum load and the thread with the minimum load is larger than the value of this parameter, then work will be moved from the former to the latter

rebalance_window

The load of how many seconds should be taken into account when rebalancing

retain_last_statements

How many statements should be retained for each session for debugging purposes

session_trace

How many log entries are stored in the session specific trace log

skip_name_resolve

Do not resolve client IP addresses to hostnames during authentication

skip_permission_checks

Skip service and monitor permission checks

sql_mode

The query classifier sql mode

syslog

Log to syslog

threads

Type: count, default value is based on cpu count

users_refresh_interval

How often the users will be refreshed

users_refresh_time

How often the users can be refreshed

writeq_high_water

High water mark of dcb write queue

writeq_low_water

Low water mark of dcb write queue

Server Objects

The parameters for server objects:

Parameter

Description

address

Server address

authenticator

Server authenticator (deprecated)

disk_space_threshold

Server disk space threshold

extra_port

Server extra port

monitorpw

Monitor password

monitoruser

Monitor user

persistmaxtime

Maximum time that a connection can be in the pool

persistpoolmax

Maximum size of the persistent connection pool

port

Server port

priority

Server priority

protocol

Server protocol (deprecated)

proxy_protocol

Enable proxy protocol

rank

Server rank

socket

Server UNIX socket

ssl

Enable TLS for server

ssl_ca_cert

Alias for ssl_ca

ssl_cert

TLS public certificate

ssl_cert_verify_depth

TLS certificate verification depth

ssl_cipher

TLS cipher list

ssl_key

TLS private key

ssl_verify_peer_certificate

Verify TLS peer certificate

ssl_verify_peer_host

Verify TLS peer host

ssl_version

Minimum TLS protocol version

type

Object type

The following Module Parameters are not present in MariaDB MaxScale 2.5.28 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

backend_connect_attempts

backend_connect_timeout

backend_read_timeout

backend_write_timeout

cluster_monitor_interval

disk_space_check_interval

disk_space_threshold

dynamic_node_detection

events

health_check_port

health_check_threshold

journal_max_age

monitor_interval

password

script

script_timeout

user