Parameter |
Choices/Defaults |
Comments |
comment
|
Default:
|
Text field that can be used for any purposed defined by the user. Could be a description of what the host stores, a reminder of when the host was added or disabled, or a JSON processed by some checker script.
|
compression
|
|
If the value of compression is greater than 0, new connections to that server will use compression. If omitted the proxysql database default for compression is 0.
|
config_file
|
Default:
|
Specify a config file from which login_user and login_password are to be read.
|
hostgroup_id
|
Default:
0
|
The hostgroup in which this mysqld instance is included. An instance can be part of one or more hostgroups.
|
hostname
required |
|
The ip address at which the mysqld instance can be contacted.
|
load_to_runtime
bool |
|
Dynamically load config to runtime memory.
|
login_host
|
Default:
127.0.0.1
|
The host used to connect to ProxySQL admin interface.
|
login_password
|
|
The password used to authenticate to ProxySQL admin interface.
|
login_port
|
Default:
6032
|
The port used to connect to ProxySQL admin interface.
|
login_user
|
|
The username used to authenticate to ProxySQL admin interface.
|
max_connections
|
|
The maximum number of connections ProxySQL will open to this backend server. If omitted the proxysql database default for max_connections is 1000.
|
max_latency_ms
|
|
Ping time is monitored regularly. If a host has a ping time greater than max_latency_ms it is excluded from the connection pool (although the server stays ONLINE). If omitted the proxysql database default for max_latency_ms is 0.
|
max_replication_lag
|
|
If greater than 0, ProxySQL will reguarly monitor replication lag. If replication lag goes above max_replication_lag, proxysql will temporarily shun the server until replication catches up. If omitted the proxysql database default for max_replication_lag is 0.
|
port
|
Default:
3306
|
The port at which the mysqld instance can be contacted.
|
save_to_disk
bool |
|
Save config to sqlite db on disk to persist the configuration.
|
state
|
Choices:
present ←
- absent
|
When present - adds the host, when absent - removes the host.
|
status
|
Choices:
- ONLINE
- OFFLINE_SOFT
- OFFLINE_HARD
|
ONLINE - Backend server is fully operational. OFFLINE_SOFT - When a server is put into OFFLINE_SOFT mode, connections are kept in use until the current transaction is completed. This allows to gracefully detach a backend. OFFLINE_HARD - When a server is put into OFFLINE_HARD mode, the existing connections are dropped, while new incoming connections aren't accepted either.
If omitted the proxysql database default for status is ONLINE .
|
use_ssl
|
|
If use_ssl is set to True , connections to this server will be made using SSL connections. If omitted the proxysql database default for use_ssl is False .
|
weight
|
|
The bigger the weight of a server relative to other weights, the higher the probability of the server being chosen from the hostgroup. If omitted the proxysql database default for weight is 1.
|