MaxScale 25.01 Configuration Settings
Configuration Settings
- Configuration Settings
- General
- MaxScale
- Global Settings
- admin_audit
- admin_audit_exclude_methods
- admin_audit_file
- admin_auth
- admin_enabled
- admin_gui
- admin_host
- admin_jwt_algorithm
- admin_jwt_issuer
- admin_jwt_key
- admin_jwt_max_age
- admin_log_auth_failures
- admin_oidc_url
- admin_pam_readonly_service
- admin_pam_readwrite_service
- admin_port
- admin_readwrite_hosts
- admin_secure_gui
- admin_ssl_ca
- admin_ssl_cert
- admin_ssl_cipher
- admin_ssl_key
- admin_ssl_version
- admin_verify_url
- auth_connect_timeout
- auto_tune
- cachedir
- config_sync_cluster
- config_sync_db
- config_sync_interval
- config_sync_password
- config_sync_timeout
- config_sync_user
- connector_plugindir
- core_file
- datadir
- debug
- dump_last_statements
- execdir
- host_cache_size
- key_manager
- language
- libdir
- load_persisted_configs
- local_address
- log_augmentation
- log_debug
- log_info
- log_notice
- log_throttling
- log_warn_super_user
- log_warning
- logdir
- max_auth_errors_until_block
- maxlog
- module_configdir
- ms_timestamp
- passive
- persist_runtime_changes
- persistdir
- piddir
- query_classifier_cache_size
- query_retries
- query_retry_timeout
- rebalance_period
- rebalance_threshold
- rebalance_window
- retain_last_statements
- secretsdir
- session_trace
- session_trace_match
- sharedir
- skip_name_resolve
- sql_mode
- substitute_variables
- syslog
- threads
- threads_max
- trace_file_dir
- trace_file_size
- users_refresh_interval
- users_refresh_time
- writeq_high_water
- writeq_low_water
- Listener
- Server
- Service
- auth_all_servers
- cluster
- connection_keepalive
- disable_sescmd_history
- enable_root_user
- filters
- force_connection_keepalive
- idle_session_pool_time
- log_auth_warnings
- log_debug
- log_info
- log_notice
- log_warning
- max_connections
- max_sescmd_history
- multiplex_timeout
- net_write_timeout
- password
- prune_sescmd_history
- retain_last_statements
- router
- servers
- session_track_trx_state
- strip_db_esc
- targets
- user
- user_accounts_file
- user_accounts_file_usage
- version_string
- wait_timeout
- Settings for File-based Key Manager
- Settings for HashiCorp Vault Key Manager
- Settings for KMIP Key Manager
- Settings for TLS/SSL Encryption
- Global Settings
- MaxScale
- Authenticators
- Filters
- Monitors
- Protocols
- MariaDB
- NoSQL
- Settings
- authentication_db
- authentication_key_id
- authentication_password
- authentication_required
- authentication_shared
- authentication_user
- authorization_enabled
- auto_create_databases
- auto_create_tables
- cursor_timeout
- debug
- host
- id_length
- internal_cache
- log_unknown_command
- on_unknown_command
- ordered_insert_behavior
- password
- user
- Settings
- Routers
- Avrorouter
- Binlogrouter
- Diff
- KafkaCDC
- KafkaImporter
- Mirror
- ReadConnRoute
- ReadWriteSplit
- Settings
- causal_reads
- causal_reads_timeout
- delayed_retry
- delayed_retry_timeout
- lazy_connect
- master_accept_reads
- master_failure_mode
- master_reconnection
- max_replication_lag
- max_slave_connections
- retry_failed_reads
- slave_connections
- slave_selection_criteria
- strict_multi_stmt
- strict_sp_calls
- strict_tmp_tables
- transaction_replay
- transaction_replay_attempts
- transaction_replay_checksum
- transaction_replay_max_size
- transaction_replay_retry_on_deadlock
- transaction_replay_retry_on_mismatch
- transaction_replay_safe_commit
- transaction_replay_timeout
- use_sql_variables_in
- Settings
- SchemaRouter
- SmartRouter
- General
General
MaxScale
Global Settings
admin_audit
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
admin_audit_exclude_methods
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
GET
,PUT
,POST
,PATCH
,DELETE
,HEAD
,OPTIONS
,CONNECT
,TRACE
- Default: No exclusions
admin_audit_file
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
/var/log/maxscale/admin_audit.csv
admin_auth
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
true
admin_enabled
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
true
admin_gui
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
true
admin_host
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
"127.0.0.1"
admin_jwt_algorithm
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
auto
,HS256
,HS384
,HS512
,RS256
,RS384
,RS512
,PS256
,PS384
,PS512
,ES256
,ES384
,ES512
,ED25519
,ED448
- Default:
auto
admin_jwt_issuer
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
maxscale
admin_jwt_key
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
admin_jwt_max_age
- Type: duration
- Mandatory: No
- Dynamic: No
- Default:
24h
admin_log_auth_failures
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
admin_oidc_url
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
admin_pam_readonly_service
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
admin_pam_readwrite_service
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
admin_port
- Type: number
- Mandatory: No
- Dynamic: No
- Default:
8989
admin_readwrite_hosts
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
%
admin_secure_gui
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
true
admin_ssl_ca
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
""
admin_ssl_cert
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
""
admin_ssl_cipher
- Type: string
- Mandatory: No
- Dynamic: No
admin_ssl_key
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
""
admin_ssl_version
- Type: enum_mask
- Mandatory: No
- Dynamic: No
- Values:
MAX
,TLSv1.0
,TLSv1.1
,TLSv1.2
,TLSv1.3
,TLSv10
,TLSv11
,TLSv12
,TLSv13
- Default:
MAX
admin_verify_url
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
auth_connect_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
10s
auto_tune
- Type: string list
- Values:
all
or list of auto tunable parameters, separated by,
- Default: No
- Mandatory: No
- Dynamic: No
cachedir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/var/cache/maxscale
config_sync_cluster
- Type: monitor
- Mandatory: No
- Dynamic: Yes
- Default: None
config_sync_db
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
mysql
config_sync_interval
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
5s
config_sync_password
- Type: password
- Mandatory: No
- Dynamic: Yes
- Default: None
config_sync_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
10s
config_sync_user
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
connector_plugindir
- Type: path
- Mandatory: No
- Dynamic: No
- Default: OS Dependent
core_file
- Type: boolean
- Default: true
- Dynamic: No
datadir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/var/lib/maxscale
debug
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
dump_last_statements
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
on_close
,on_error
,never
- Default:
never
execdir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/usr/bin
host_cache_size
- Type: integer
- Default: 128
- Dynamic: Yes
key_manager
- Type: enum
- Dynamic: Yes
- Values:
none
,file
,kmip
,vault
- Default:
none
language
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/var/lib/maxscale/
libdir
- Type: path
- Mandatory: No
- Dynamic: No
- Default: OS Dependent
load_persisted_configs
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
true
local_address
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
log_augmentation
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
0
log_debug
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
log_info
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
log_notice
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
log_throttling
log_warn_super_user
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
log_warning
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
logdir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/var/log/maxscale
max_auth_errors_until_block
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
10
maxlog
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
module_configdir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/etc/maxscale.modules.d/
ms_timestamp
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
passive
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
persist_runtime_changes
- Type: boolean
- Default: true
- Dynamic: No
persistdir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/var/lib/maxscale/maxscale.cnf.d/
piddir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/run/maxscale
query_classifier_cache_size
- Type: size
- Mandatory: No
- Dynamic: Yes
- Default: System Dependent
query_retries
- Type: number
- Mandatory: No
- Dynamic: No
- Default:
1
query_retry_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
10s
rebalance_period
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
0s
rebalance_threshold
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
20
rebalance_window
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
10
retain_last_statements
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
0
secretsdir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
""
session_trace
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
0
session_trace_match
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
sharedir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/usr/share/maxscale
skip_name_resolve
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
sql_mode
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
default
,oracle
- Default:
default
substitute_variables
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
syslog
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
threads
- Type: number or
auto
- Mandatory: No
- Dynamic: No
- Default:
auto
threads_max
- Type: positive integer
- Default: 256
- Dynamic: No
trace_file_dir
- Type: path
- Mandatory: No
- Dynamic: No
trace_file_size
- Type: size
- Mandatory: No
- Dynamic: Yes
users_refresh_interval
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
0s
users_refresh_time
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
30s
writeq_high_water
- Type: size
- Mandatory: No
- Dynamic: Yes
- Default:
65536
writeq_low_water
- Type: size
- Mandatory: No
- Dynamic: Yes
- Default:
1024
Listener
address
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
"::"
authenticator
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
authenticator_options
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
connection_init_sql_file
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
connection_metadata
- Type: stringlist
- Default:
character_set_client=auto,character_set_connection=auto,character_set_results=auto,max_allowed_packet=auto,system_time_zone=auto,time_zone=auto,tx_isolation=auto,maxscale=auto
- Dynamic: Yes
- Mandatory: No
port
- Type: number
- Mandatory: Yes, if
socket
is not provided. - Dynamic: No
- Default:
0
protocol
- Type: protocol
- Mandatory: No
- Dynamic: No
- Default:
mariadb
service
- Type: service
- Mandatory: Yes
- Dynamic: No
socket
- Type: string
- Mandatory: Yes, if
port
is not provided. - Dynamic: No
- Default:
""
sql_mode
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
default
,oracle
- Default:
default
user_mapping_file
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
Server
address
- Type: string
- Mandatory: Yes, if
socket
is not provided. - Dynamic: Yes
- Default:
""
disk_space_threshold
- Type: Custom
- Mandatory: No
- Dynamic: No
- Default: None
extra_port
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
0
max_routing_connections
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
0
monitorpw
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
monitoruser
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
persistmaxtime
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
0s
persistpoolmax
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
0
port
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
3306
priority
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default: 0
private_address
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
""
proxy_protocol
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
rank
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
primary
,secondary
- Default:
primary
replication_custom_options
- Type: string
- Default: None
- Dynamic: Yes
socket
- Type: string
- Mandatory: Yes, if
address
is not provided. - Dynamic: Yes
- Default:
""
Service
auth_all_servers
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
cluster
- Type: monitor
- Mandatory: No
- Dynamic: Yes
- Default: None
connection_keepalive
disable_sescmd_history
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
enable_root_user
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
filters
- Type: filter list
- Mandatory: No
- Dynamic: Yes
- Default: None
force_connection_keepalive
- Type: boolean
- Mandatory No
- Dynamic: Yes
- Default:
false
idle_session_pool_time
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
-1s
log_auth_warnings
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
log_debug
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
log_info
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
log_notice
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
log_warning
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
max_connections
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
0
max_sescmd_history
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
50
multiplex_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
60s
net_write_timeout
- Type: durations
- Mandatory No
- Dynamic: Yes
- Default:
0s
password
- Type: string
- Mandatory: Yes
- Dynamic: Yes
prune_sescmd_history
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
retain_last_statements
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
-1
router
- Type: router
- Mandatory: Yes
- Dynamic: No
servers
- Type: server list
- Mandatory: No
- Dynamic: Yes
- Default: None
session_track_trx_state
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
strip_db_esc
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
targets
- Type: target list
- Mandatory: No
- Dynamic: Yes
- Default: None
user
- Type: string
- Mandatory: Yes
- Dynamic: Yes
user_accounts_file
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
""
user_accounts_file_usage
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
add_when_load_ok
,file_only_always
- Default:
add_when_load_ok
version_string
- Type: string
- Mandatory: No
- Dynamic: No
- Default: None
wait_timeout
Settings for File-based Key Manager
file.keyfile
- Type: path
- Mandatory: Yes
- Dynamic: Yes
Settings for HashiCorp Vault Key Manager
vault.ca
- Type: path
- Default:
""
- Dynamic: Yes
vault.host
- Type: string
- Default:
localhost
- Dynamic: Yes
vault.mount
- Type: string
- Default:
secret
- Dynamic: Yes
vault.port
- Type: integer
- Default:
8200
- Dynamic: Yes
vault.timeout
- Type: duration
- Default: 30s
- Dynamic: Yes
vault.tls
- Type: boolean
- Default: true
- Dynamic: Yes
vault.token
- Type: password
- Mandatory: Yes
- Dynamic: Yes
Settings for KMIP Key Manager
kmip.ca
- Type: path
- Default:
""
- Dynamic: Yes
kmip.cert
- Type: path
- Mandatory: Yes
- Dynamic: Yes
kmip.host
- Type: string
- Mandatory: Yes
- Dynamic: Yes
kmip.key
- Type: path
- Mandatory: Yes
- Dynamic: Yes
kmip.port
- Type: integer
- Mandatory: Yes
- Dynamic: Yes
Settings for TLS/SSL Encryption
ssl
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
ssl_ca
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
ssl_cert
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
ssl_cert_verify_depth
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
9
ssl_cipher
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
""
ssl_crl
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
ssl_key
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
ssl_verify_peer_certificate
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
ssl_verify_peer_host
- Type: boolean
- Mandatory No
- Dynamic: Yes
- Default:
false
ssl_version
- Type: enum_mask
- Mandatory: No
- Dynamic: No
- Values:
MAX
,TLSv1.0
,TLSv1.1
,TLSv1.2
,TLSv1.3
,TLSv10
,TLSv11
,TLSv12
,TLSv13
- Default:
MAX
Authenticators
Authentication-Modules
Settings
lower_case_table_names
- Type: number
- Mandatory: No
- Dynamic: No
- Default:
0
match_host
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
true
skip_authentication
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
GSSAPI-Authenticator
Settings
gssapi_keytab_path
- Type: path
- Mandatory: No
- Dynamic: No
- Default: Kerberos Default
principal_name
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
mariadb/localhost.localdomain
MySQL-Authenticator
Settings
log_password_mismatch
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
PAM-Authenticator
Settings
pam_backend_mapping
- Type: enumeration
- Mandatory: No
- Dynamic: No
- Values:
none
,mariadb
- Default:
none
pam_mapped_pw_file
- Type: path
- Mandatory: No
- Dynamic: No
- Default: None
pam_mode
- Type: enumeration
- Mandatory: No
- Dynamic: No
- Values:
password
,password_2FA
,suid
- Default:
password
pam_use_cleartext_plugin
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
Filters
BinlogFilter
Settings
exclude
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
match
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
rewrite_dest
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
rewrite_src
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
CCRFilter
Settings
count
- Type: count
- Mandatory: No
- Dynamic: Yes
- Default:
0
global
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
ignore
- Type: regex
- Mandatory: No
- Dynamic: No
- Default:
""
match
- Type: regex
- Mandatory: No
- Dynamic: No
- Default:
""
options
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
ignorecase
,case
,extended
- Default:
ignorecase
time
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
60s
Cache
Settings
cache_in_transactions
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
never
,read_only_transactions
,all_transactions
- Default:
all_transactions
cached_data
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
shared
,thread_specific
- Default:
thread_specific
clear_cache_on_parse_errors
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
true
debug
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
0
enabled
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
true
hard_ttl
- Type: duration
- Mandatory: No
- Dynamic: No
- Default:
0s
(no limit)
invalidate
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
never
,current
- Default:
never
max_count
- Type: count
- Mandatory: No
- Dynamic: No
- Default:
0
(no limit)
max_resultset_rows
- Type: count
- Mandatory: No
- Dynamic: No
- Default:
0
(no limit)
max_resultset_size
- Type: size
- Mandatory: No
- Dynamic: No
- Default:
0
(no limit)
max_size
- Type: size
- Mandatory: No
- Dynamic: No
- Default:
0
(no limit)
rules
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
(no rules)
selects
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
assume_cacheable
,verify_cacheable
- Default:
assume_cacheable
soft_ttl
- Type: duration
- Mandatory: No
- Dynamic: No
- Default:
0s
(no limit)
storage
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
storage_inmemory
storage_options
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
timeout
- Type: duration
- Mandatory: No
- Dynamic: No
- Default:
5s
users
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
mixed
,isolated
- Default:
mixed
storage_memcached
max_value_size
- Type: size
- Mandatory: No
- Dynamic: No
- Default: 1Mi
server
- Type: The Memcached server address specified as
host[:port]
- Mandatory: Yes
- Dynamic: No
storage_redis
password
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
server
- Type: The Redis server address specified as
host[:port]
- Mandatory: Yes
- Dynamic: No
ssl
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
ssl_ca
- Type: Path to existing readable file.
- Mandatory: No
- Dynamic: No
- Default:
""
ssl_cert
- Type: Path to existing readable file.
- Mandatory: No
- Dynamic: No
- Default:
""
ssl_key
- Type: Path to existing readable file.
- Mandatory: No
- Dynamic: No
- Default:
""
username
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
Comment
Settings
inject
- Type: string
- Mandatory: Yes
- Dynamic: Yes
LDIFilter
Settings
host
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
s3.amazonaws.com
key
- Type: string
- Mandatory: No
- Dynamic: Yes
no_verify
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
port
- Type: integer
- Mandatory: No
- Dynamic: Yes
- Default: 0
protocol_version
- Type: integer
- Mandatory: No
- Dynamic: Yes
- Default: 0
- Values: 0, 1, 2
region
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
us-east-1
secret
- Type: string
- Mandatory: No
- Dynamic: Yes
use_http
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
Masking
Settings
check_subqueries
- Type: bool
- Mandatory: No
- Dynamic: Yes
- Default:
true
check_unions
- Type: bool
- Mandatory: No
- Dynamic: Yes
- Default:
true
check_user_variables
- Type: bool
- Mandatory: No
- Dynamic: Yes
- Default:
true
large_payload
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
ignore
,abort
- Default:
abort
prevent_function_usage
- Type: bool
- Mandatory: No
- Dynamic: Yes
- Default:
true
require_fully_parsed
- Type: bool
- Mandatory: No
- Dynamic: Yes
- Default:
true
rules
- Type: path
- Mandatory: Yes
- Dynamic: Yes
treat_string_arg_as_field
- Type: bool
- Mandatory: No
- Dynamic: Yes
- Default:
true
warn_type_mismatch
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
never
,always
- Default:
never
Maxrows
Settings
debug
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
0
max_resultset_return
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
empty
,error
,ok
- Default:
empty
max_resultset_rows
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default: (no limit)
max_resultset_size
- Type: size
- Mandatory: No
- Dynamic: Yes
- Default:
64Ki
Named-Server-Filter
Settings
matchXY
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
options
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
ignorecase
,case
,extended
- Default:
ignorecase
source
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
targetXY
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
user
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
Query-Log-All-Filter
Settings
append
- Type: bool
- Mandatory: No
- Dynamic: Yes
- Default:
true
duration_unit
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
milliseconds
exclude
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
filebase
- Type: string
- Mandatory: Yes
- Dynamic: No
flush
- Type: bool
- Mandatory: No
- Dynamic: Yes
- Default:
false
log_data
- Type: enum_mask
- Mandatory: No
- Dynamic: Yes
- Values:
service
,session
,date
,user
,reply_time
,total_reply_time
,query
,default_db
,num_rows
,reply_size
,transaction
,transaction_time
,num_warnings
,error_msg
- Default:
date, user, query
log_type
- Type: enum_mask
- Mandatory: No
- Dynamic: Yes
- Values:
session
,unified
,stdout
- Default:
session
match
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
newline_replacement
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
" "
options
- Type: enum_mask
- Mandatory: No
- Dynamic: Yes
- Values:
case
,ignorecase
,extended
- Default:
case
separator
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
","
source
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
""
source_exclude
- Type: regex
- Mandatory: No
- Dynamic: Yes
source_match
- Type: regex
- Mandatory: No
- Dynamic: Yes
use_canonical_form
- Type: bool
- Mandatory: No
- Dynamic: Yes
- Default:
false
user
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
""
user_exclude
- Type: regex
- Mandatory: No
- Dynamic: Yes
user_match
- Type: regex
- Mandatory: No
- Dynamic: Yes
Regex-Filter
Settings
log_file
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
log_trace
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
match
- Type: regex
- Mandatory: Yes
- Dynamic: Yes
options
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
ignorecase
,case
,extended
- Default:
ignorecase
replace
- Type: string
- Mandatory: Yes
- Dynamic: Yes
source
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
user
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
RewriteFilter
Settings
case_sensitive
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: true
log_replacement
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
regex_grammar
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: Native
- Values:
Native
,ECMAScript
,Posix
,EPosix
,Awk
,Grep
,EGrep
template_file
- Type: string
- Mandatory: Yes
- Dynamic: Yes
- Default: No default value
Settings per template in the template file
case_sensitive
- Type: boolean
- Default: From maxscale.cnf
continue_if_matched
- Type: boolean
- Default: false
ignore_whitespace
- Type: boolean
- Default: true
regex_grammar
- Type: string
- Values:
Native
,ECMAScript
,Posix
,EPosix
,Awk
,Grep
,EGrep
- Default: From maxscale.cnf
what_if
- Type: boolean
- Default: false
Tee-Filter
Settings
exclude
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
match
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
options
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
ignorecase
,case
,extended
- Default:
ignorecase
service
- Type: service
- Mandatory: No
- Dynamic: Yes
- Default: none
source
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
sync
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
target
- Type: target
- Mandatory: No
- Dynamic: Yes
- Default: none
user
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
Throttle
Settings
continuous_duration
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default: 2s
max_qps
- Type: number
- Mandatory: Yes
- Dynamic: Yes
sampling_duration
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default: 250ms
throttling_duration
- Type: duration
- Mandatory: Yes
- Dynamic: Yes
Top-N-Filter
Settings
count
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
10
exclude
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
filebase
- Type: string
- Mandatory: Yes
- Dynamic: Yes
match
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default: None
options
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
ignorecase
,case
,extended
- Default:
case
source
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
user
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
Wcar
Settings
capture_dir
- Type: path
- Default: /var/lib/maxscale/wcar/
- Mandatory: No
- Dynamic: No
capture_duration
- Type: duration
- Default: 0s
- Mandatory: No
- Dynamic: No
capture_size
- Type: size
- Default: 0
- Mandatory: No
- Dynamic: No
start_capture
- Type: boolean
- Default: false
- Mandatory: No
- Dynamic: No
Monitors
Galera-Monitor
Settings
available_when_donor
- Type: boolean
- Default: false
- Dynamic: Yes
disable_master_failback
- Type: boolean
- Default: false
- Dynamic: Yes
disable_master_role_setting
- Type: boolean
- Default: false
- Dynamic: Yes
root_node_as_master
- Type: boolean
- Default: false
- Dynamic: Yes
set_donor_nodes
- Type: boolean
- Default: false
- Dynamic: Yes
use_priority
- Type: boolean
- Default: false
- Dynamic: Yes
MariaDB-Monitor
Settings
assume_unique_hostnames
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
cooperative_monitoring_locks
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
none
,majority_of_all
,majority_of_running
- Default:
none
enforce_read_only_servers
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
enforce_read_only_slaves
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
enforce_writable_master
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
failcount
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
5
maintenance_on_low_disk_space
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
master_conditions
- Type: enum_mask
- Mandatory: No
- Dynamic: Yes
- Values:
none
,connecting_slave
,connected_slave
,running_slave
,primary_monitor_master
,disk_space_ok
- Default:
primary_monitor_master, disk_space_ok
script_max_replication_lag
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
-1
slave_conditions
- Type: enum_mask
- Mandatory: No
- Dynamic: Yes
- Values:
none
,linked_master
,running_master
,writable_master
,primary_monitor_master
- Default:
none
Settings for Backup operations
backup_storage_address
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
backup_storage_path
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default: None
rebuild_port
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
4444
ssh_check_host_key
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
ssh_keyfile
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default: None
ssh_port
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
22
ssh_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
10s
ssh_user
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
Settings for Cluster manipulation operations
auto_failover
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
true
,on
,yes
,1
,false
,off
,no
,0
,safe
- Default:
false
auto_rejoin
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
demotion_sql_file
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
enforce_simple_topology
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
failover_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
90s
handle_events
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
master_failure_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
10s
promotion_sql_file
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
replication_master_ssl
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
replication_password
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
replication_user
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
servers_no_promotion
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
switchover_on_low_disk_space
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
switchover_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
90s
verify_master_failure
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
Settings for Primary server write test
write_test_fail_action
- Type: enum
- Default:
log
- Values:
log
,failover
- Dynamic: Yes
write_test_interval
- Type: duration
- Dynamic: Yes
- Default: 0s
write_test_table
- Type: string
- Dynamic: Yes
- Default:
mxs.maxscale_write_test
Monitor-Common
Settings
backend_connect_attempts
- Type: number
- Mandatory: No
- Dynamic: Yes
- Default:
1
backend_connect_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
3s
backend_read_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
3s
backend_write_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
3s
disk_space_check_interval
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
0s
disk_space_threshold
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
events
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
master_down
,master_up
,slave_down
,slave_up
,server_down
,server_up
,lost_master
,lost_slave
,new_master
,new_slave
- Default: All events
journal_max_age
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
28800s
module
- Type: string
- Mandatory: Yes
- Dynamic: No
monitor_interval
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
2s
password
- Type: string
- Mandatory: Yes
- Dynamic: Yes
script
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default: None
script_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
90s
servers
- Type: string
- Mandatory: Yes
- Dynamic: Yes
user
- Type: string
- Mandatory: Yes
- Dynamic: Yes
Protocols
MariaDB
Settings
allow_replication
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: true
NoSQL
Settings
authentication_db
- Type: string
- Mandatory: No
- Default:
"NoSQL"
authentication_key_id
- Type: string
- Mandatory: No
- Default:
""
authentication_password
- Type: string
- Mandatory: No
- Default:
""
authentication_required
- Type: boolean
- Mandatory: No
- Default:
false
authentication_shared
- Type: boolean
- Mandatory: No
- Default:
false
authentication_user
- Type: string
- Mandatory: Yes, if
authentication_shared
is true.
authorization_enabled
- Type: boolean
- Mandatory: No
- Default:
false
auto_create_databases
- Type: boolean
- Mandatory: No
- Default:
true
auto_create_tables
- Type: boolean
- Mandatory: No
- Default:
true
cursor_timeout
- Type: duration
- Mandatory: No
- Default:
60s
debug
- Type: enum_mask
- Mandatory: No
- Values:
none
,in
,out
,back
- Default:
none
host
- Type: string
- Mandatory: No
- Default:
"%"
id_length
- Type: count
- Mandatory: No
- Range:
[35, 2048]
- *Default:
35
internal_cache
- Type: string
- Mandatory: No
- Default: ''
log_unknown_command
- Type: boolean
- Mandatory: No
- Default:
false
on_unknown_command
- Type: enum
- Mandatory: No
- Values:
return_error
,return_empty
- Default:
return_error
ordered_insert_behavior
- Type: enum
- Mandatory: No
- Values:
atomic
,default
- Default:
default
password
- Type: string
- Mandatory: No
- Default:
""
user
- Type: string
- Mandatory: No
- Default:
""
Routers
Avrorouter
Settings
avrodir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/var/lib/maxscale/
binlogdir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/var/lib/maxscale/
codec
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
null
,deflate
- Default:
null
cooperative_replication
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
exclude
- Type: regex
- Mandatory: No
- Dynamic: No
- Default:
""
filestem
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
mysql-bin
gtid_start_pos
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
match
- Type: regex
- Mandatory: No
- Dynamic: No
- Default:
""
server_id
- Type: number
- Mandatory: No
- Dynamic: No
- Default:
1234
start_index
- Type: number
- Mandatory: No
- Dynamic: No
- Default:
1
Settings for Avro File
block_size
- Type: size
- Mandatory: No
- Dynamic: Yes
- Default:
16KiB
group_rows
- Type: number
- Mandatory: No
- Dynamic: No
- Default:
1000
group_trx
- Type: number
- Mandatory: No
- Dynamic: No
- Default:
1
max_data_age
- Type: duration
- Mandatory: No
- Dynamic: No
- Default: 0s
max_file_size
- Type: size
- Mandatory: No
- Dynamic: No
- Default: 0
Binlogrouter
Settings
archivedir
- Type: string
- Mandatory: Yes
- Default: No
- Dynamic: No
compression_algorithm
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
none
,zstandard
- Default:
none
datadir
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
/var/lib/maxscale/binlogs
ddl_only
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default: false
encryption_cipher
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
AES_CBC
,AES_CTR
,AES_GCM
- Default:
AES_GCM
encryption_key_id
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
expiration_mode
- Type: enum
- Dynamic: No
- Values:
purge
,archive
- Default:
purge
expire_log_duration
- Type: duration
- Mandatory: No
- Dynamic: No
- Default:
0s
expire_log_minimum_files
- Type: number
- Mandatory: No
- Dynamic: No
- Default:
2
net_timeout
- Type: duration
- Mandatory: No
- Dynamic: No
- Default:
10s
number_of_noncompressed_files
- Type: count
- Mandatory: No
- Dynamic: No
- Default:
2
rpl_semi_sync_slave_enabled
- Type: boolean
- Mandatory: No
- Default: false
- Dynamic: Yes
select_master
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
server_id
- Type: count
- Mandatory: No
- Dynamic: No
- Default:
1234
Diff
Settings
explain
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
none
,other
, `both' - Default:
both
explain_entries
- Type: non-negative integer
- Mandatory: No
- Dynamic: Yes
- Default: 2
explain_period
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default: 15m
main
- Type: server
- Mandatory: Yes
- Dynamic: No
max_request_lag
- Type: non-negative integer
- Mandatory: No
- Dynamic: Yes
- Default: 10
on_error
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
close
,ignore
- Default:
ignore
percentile
- Type: count
- Mandatory: No
- Dynamic: Yes
- Min: 1
- Max: 100
- Default: 99
qps_window
- Type: duration
- Mandatory: No
- Dynamic: No
- Default: 15m
report
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
always
,on_discrepancy
,never
- Default:
on_discrepancy
reset_replication
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
true
retain_faster_statements
- Type: non-negative integer
- Mandatory: No
- Dynamic: Yes
- Default: 5
retain_slower_statements
- Type: non-negative integer
- Mandatory: No
- Dynamic: Yes
- Default: 5
samples
- Type: count
- Mandatory: No
- Dynamic: Yes
- Min: 100
- Default: 1000
service
- Type: service
- Mandatory: Yes
- Dynamic: No
KafkaCDC
Settings
bootstrap_servers
- Type: string
- Mandatory: Yes
- Dynamic: No
cooperative_replication
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
enable_idempotence
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
exclude
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default:
""
gtid
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
kafka_sasl_mechanism
- Type: enum
- Mandatory: No
- Dynamic: No
- Values:
PLAIN
,SCRAM-SHA-256
,SCRAM-SHA-512
- Default:
PLAIN
kafka_sasl_password
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
kafka_sasl_user
- Type: string
- Mandatory: No
- Dynamic: No
- Default:
""
kafka_ssl
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
kafka_ssl_ca
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
""
kafka_ssl_cert
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
""
kafka_ssl_key
- Type: path
- Mandatory: No
- Dynamic: No
- Default:
""
match
- Type: regex
- Mandatory: No
- Dynamic: Yes
- Default:
""
read_gtid_from_kafka
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
true
send_schema
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: true
server_id
- Type: number
- Mandatory: No
- Dynamic: No
- Default:
1234
timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
10s
topic
- Type: string
- Mandatory: Yes
- Dynamic: No
KafkaImporter
Settings
batch_size
- Type: count
- Mandatory: No
- Dynamic: Yes
- Default:
100
bootstrap_servers
- Type: string
- Mandatory: Yes
- Dynamic: Yes
engine
- Type: string
- Default:
InnoDB
- Mandatory: No
- Dynamic: Yes
kafka_sasl_mechanism
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
PLAIN
,SCRAM-SHA-256
,SCRAM-SHA-512
- Default:
PLAIN
kafka_sasl_password
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
""
kafka_sasl_user
- Type: string
- Mandatory: No
- Dynamic: Yes
- Default:
""
kafka_ssl
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default:
false
kafka_ssl_ca
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
kafka_ssl_cert
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
kafka_ssl_key
- Type: path
- Mandatory: No
- Dynamic: Yes
- Default:
""
table_name_in
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
topic
,key
- Default:
topic
timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
5000ms
topics
- Type: stringlist
- Mandatory: Yes
- Dynamic: Yes
Mirror
Settings
exporter
- Type: enum
- Mandatory: Yes
- Dynamic: Yes
- Values:
log
,file
,kafka
file
- Type: string
- Default: No default value
- Mandatory: No
- Dynamic: Yes
kafka_broker
- Type: string
- Default: No default value
- Mandatory: No
- Dynamic: Yes
kafka_topic
- Type: string
- Default: No default value
- Mandatory: No
- Dynamic: Yes
main
- Type: target
- Mandatory: Yes
- Dynamic: Yes
on_error
- Type: enum
- Default:
ignore
- Mandatory: No
- Dynamic: Yes
- Values:
ignore
,close
report
- Type: enum
- Default:
always
- Mandatory: No
- Dynamic: Yes
- Values:
always
,on_conflict
ReadConnRoute
Settings
master_accept_reads
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: true
max_replication_lag
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default: 0s
router_options
- Type: enum_mask
- Mandatory: No
- Dynamic: Yes
- Values:
master
,slave
,synced
,running
- Default:
running
ReadWriteSplit
Settings
causal_reads
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
none
,local
,global
,fast
,fast_global
,universal
,fast_universal
- Default:
none
causal_reads_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default: 10s
delayed_retry
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
delayed_retry_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default: 10s
lazy_connect
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
master_accept_reads
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
master_failure_mode
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
fail_instantly
,fail_on_write
,error_on_write
- Default:
fail_on_write
(MaxScale 23.08:fail_instantly
)
master_reconnection
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: true (>= MaxScale 24.02), false(<= MaxScale 23.08)
max_replication_lag
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default: 0s
max_slave_connections
- Type: integer
- Mandatory: No
- Dynamic: Yes
- Default: 255
retry_failed_reads
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: true
slave_connections
- Type: integer
- Mandatory: No
- Dynamic: Yes
- Default: 255
slave_selection_criteria
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
least_current_operations
,adaptive_routing
,least_behind_master
,least_router_connections
,least_global_connections
- Default:
least_current_operations
strict_multi_stmt
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
strict_sp_calls
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
strict_tmp_tables
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: true (>= MaxScale 24.02), false (<= MaxScale 23.08)
transaction_replay
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
transaction_replay_attempts
- Type: integer
- Mandatory: No
- Dynamic: Yes
- Default: 5
transaction_replay_checksum
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
full
,result_only
,no_insert_id
- Default:
full
transaction_replay_max_size
- Type: size
- Mandatory: No
- Dynamic: Yes
- Default: 1 MiB
transaction_replay_retry_on_deadlock
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
transaction_replay_retry_on_mismatch
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
transaction_replay_safe_commit
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: true
transaction_replay_timeout
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default: 30s (>= MaxScale 24.02), 0s (<= MaxScale 23.08)
use_sql_variables_in
- Type: enum
- Mandatory: No
- Dynamic: Yes
- Values:
master
,all
- Default:
all
SchemaRouter
Settings
allow_duplicates
- Type: boolean
- Mandatory: No
- Dynamic: Yes
- Default: false
ignore_tables
- Type: stringlist
- Mandatory: No
- Dynamic: Yes
- Default:
""
ignore_tables_regex
- Type: regex
- Mandatory: No
- Dynamic: No
- Default:
""
max_staleness
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default: 150s
refresh_databases
- Type: boolean
- Mandatory: No
- Dynamic: No
- Default:
false
refresh_interval
- Type: duration
- Mandatory: No
- Dynamic: Yes
- Default:
300s
SmartRouter
Settings
master
- Type: target
- Mandatory: Yes
- Dynamic: No
Content reproduced on this site is the property of its respective owners,
and this content is not reviewed in advance by MariaDB. The views, information and opinions
expressed by this content do not necessarily represent those of MariaDB or any other party.