Module Parameters for MariaDB MaxScale 22.08

This page is part of MariaDB's 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	Assume that hostnames are unique
auto_failover	Enable automatic server failover
auto_rejoin	Enable automatic server rejoin
backend_connect_attempts	Number of connection attempts to make to a server
backend_connect_timeout	Connection timeout for monitor connections
backend_read_timeout	Read timeout for monitor connections
backend_write_timeout	Write timeout for monitor connections
cooperative_monitoring_locks	Cooperative monitoring type
cs_admin_api_key	The API key used in communication with the ColumnStore admin daemon
cs_admin_base_path	The base path to be used when accessing the ColumnStore administrative daemon. If, for instance, a daemon URL is https://localhost:8640/cmapi/0.4.0/node/start then the admin_base_path is "/cmapi/0.4.0".
cs_admin_port	Port of the ColumnStore administrative daemon
demotion_sql_file	Path to SQL file that is executed during node demotion
disk_space_check_interval	How often the disk space is checked
disk_space_threshold	Disk space threshold
enforce_read_only_slaves	Enable read_only on all slave servers
enforce_simple_topology	Enforce a simple topology
enforce_writable_master	Disable read_only on the current master server
events	Events that cause the script to be called
failcount	Number of consecutive times MaxScale can fail to reach the Primary Server before it considers it down
failover_timeout	Timeout for failover
handle_events	Manage server-side events
journal_max_age	The time the on-disk cached server states are valid for
maintenance_on_low_disk_space	Put the server into maintenance mode when it runs out of disk space
master_conditions	Conditions that the master servers must meet
master_failure_timeout	Master failure timeout
monitor_interval	How often the servers are monitored
password	Password for the user used to monitor the servers
promotion_sql_file	Path to SQL file that is executed during node promotion
rebuild_port	Listen port used for transferring server backup
replication_master_ssl	Enable SSL when configuring replication
replication_password	Password for the user that is used for replication
replication_user	User used for replication
script	Script to run whenever an event occurs
script_max_replication_lag	Replication lag limit at which the script is run
script_timeout	Timeout for the script
servers	List of servers to use
servers_no_promotion	List of servers that are never promoted
slave_conditions	Conditions that the slave servers must meet
ssh_check_host_key	Is SSH host key check enabled
ssh_keyfile	SSH keyfile. Used for running remote commands on servers.
ssh_port	SSH port. Used for running remote commands on servers.
ssh_timeout	SSH connection and command timeout
ssh_user	SSH username. Used for running remote commands on servers.
switchover_on_low_disk_space	Perform a switchover when a server runs out of disk space
switchover_timeout	Timeout for switchover
user	Username used to monitor the servers
verify_master_failure	Verify master failure

Read/Write Split Router (readwritesplit)

The parameters for readwritesplit:

Parameter	Description
auth_all_servers	Retrieve users from all backend servers instead of only one
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	How ofted idle connections are pinged
connection_timeout	Connection idle 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	Disable session command history
enable_root_user	Allow the root user to connect to this service
force_connection_keepalive	Ping connections unconditionally
idle_session_pool_time	Put connections into pool after session has been idle for this long
lazy_connect	Create connections only when needed
localhost_match_wildcard_host	Match localhost to wildcard host
log_auth_warnings	Log a warning when client authentication fails
log_debug	Log debug messages for this service (debug builds only)
log_info	Log info messages for this service
log_notice	Log notice messages for this service
log_warning	Log warning messages for this service
master_accept_reads	Use master for reads
master_failure_mode	Master failure mode behavior
master_reconnection	Reconnect to the Primary Server if it changes mid-session
max_connections	Maximum number of connections
max_sescmd_history	Session command history size
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	How long a session can wait for a connection to become available
net_write_timeout	Network write timeout
optimistic_trx	Optimistically offload transactions to slaves
password	Password for the user used to retrieve database users
prune_sescmd_history	Prune old session command history if the limit is exceeded
rank	Service rank
retain_last_statements	Number of statements kept in memory
retry_failed_reads	Automatically retry failed reads outside of transactions
reuse_prepared_statements	Reuse identical prepared statements inside the same connection
session_trace	Enable session tracing for this service
session_track_trx_state	Track session state using server responses
slave_connections	Starting number of 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 CALL CALL statements to the Primary Server
strip_db_esc	Strip escape characters from database names
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 of checksum to calculate for results
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	Retry transaction on checksum mismatch
transaction_replay_timeout	Timeout for transaction replay
use_sql_variables_in	Where the router sends session variable queries
user	Username used to retrieve database users
user_accounts_file	Load additional users from a file
user_accounts_file_usage	When and how the user accounts file is used
version_string	Custom version string to use

MariaDB Protocol

The parameters for MariaDBProtocol:

Parameter	Description
address	Listener address
authenticator	Listener authenticator
authenticator_options	Authenticator options
connection_init_sql_file	Path to connection initialization SQL
port	Listener port
protocol	Listener protocol to use
service	Service to which the listener connects to
socket	Listener UNIX socket
sql_mode	SQL parsing mode
ssl	Enable TLS for server
ssl_ca	Path to the X.509 certificate authority chain file in PEM format. In MaxScale 6 and earlier, this parameter was named `ssl_ca_cert`. In MaxScale 22.08, `ssl_ca_cert` was renamed to `ssl_ca`. For backward compatibility, `ssl_ca_cert` can be used as an alias, but MariaDB recommends using `ssl_ca` because `ssl_ca_cert` has been deprecated.
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_crl	TLS certificate revocation 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
user_mapping_file	Path to user and group mapping file

Read Connection Router (readconnroute)

The parameters for readconnroute:

Parameter	Description
auth_all_servers	Retrieve users from all backend servers instead of only one
connection_keepalive	How ofted idle connections are pinged
connection_timeout	Connection idle timeout
disable_sescmd_history	Disable session command history
enable_root_user	Allow the root user to connect to this service
force_connection_keepalive	Ping connections unconditionally
idle_session_pool_time	Put connections into pool after session has been idle for this long
localhost_match_wildcard_host	Match localhost to wildcard host
log_auth_warnings	Log a warning when client authentication fails
log_debug	Log debug messages for this service (debug builds only)
log_info	Log info messages for this service
log_notice	Log notice messages for this service
log_warning	Log warning messages for this service
master_accept_reads	Route read operations to the Primary Server or whether it only accepts write operations
max_connections	Maximum number of connections
max_replication_lag	Maximum acceptable replication lag
max_sescmd_history	Session command history size
multiplex_timeout	How long a session can wait for a connection to become available
net_write_timeout	Network write timeout
password	Password for the user used to retrieve database users
prune_sescmd_history	Prune old session command history if the limit is exceeded
rank	Service rank
retain_last_statements	Number of statements kept in memory
router_options	A comma separated list of server roles
session_trace	Enable session tracing for this service
session_track_trx_state	Track session state using server responses
strip_db_esc	Strip escape characters from database names
user	Username used to retrieve database users
user_accounts_file	Load additional users from a file
user_accounts_file_usage	When and how the user accounts file is used
version_string	Custom version string to use

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_jwt_algorithm	JWT signature algorithm
admin_jwt_key	Encryption key ID for symmetric signature algorithms. If left empty, MaxScale will generate a random key that is used to sign the JWT.
admin_log_auth_failures	Log admin interface authentication failures
admin_oidc_url	Extra public certificates used to validate externally signed JWTs
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	Admin SSL CA cert
admin_ssl_ca_cert	Alias for 'admin_ssl_ca'
admin_ssl_cert	Admin SSL cert
admin_ssl_key	Admin SSL key
admin_ssl_version	Minimum required TLS protocol version for the REST API
admin_verify_url	URL for third-party verification of client tokens
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)
auto_tune	Specifies whether a MaxScale parameter whose value depends on a specific global server variable, should automatically be updated to match the variable's current value
config_sync_cluster	Cluster used for configuration synchronization. If left empty (i.e., value is ""), synchronization is not done.
config_sync_db	Database where the 'maxscale_config' table is created
config_sync_interval	How often to synchronize the configuration
config_sync_password	Password for the user used for configuration synchronization
config_sync_timeout	Timeout for the configuration synchronization operations
config_sync_user	User account used for configuration synchronization
debug	Debug options
dump_last_statements	In what circumstances should the last statements that a client sent be dumped
key_manager	Key manager type
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
max_read_amount	Maximum amount of data read before return to epoll_wait
maxlog	Log to MaxScale's own log
ms_timestamp	Enable or disable high precision timestamps
passive	True if MaxScale is in passive mode
persist_runtime_changes	Persist configurations changes done at runtime
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
session_trace_match	Regular expression that is matched against the contents of the session trace log and if it matches the contents are logged when the session stops
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
max_routing_connections	Maximum routing connections
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	Path to the X.509 certificate authority chain file in PEM format. In MaxScale 6 and earlier, this parameter was named `ssl_ca_cert`. In MaxScale 22.08, `ssl_ca_cert` was renamed to `ssl_ca`. For backward compatibility, `ssl_ca_cert` can be used as an alias, but MariaDB recommends using `ssl_ca` because `ssl_ca_cert` has been deprecated.
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