Parameter |
Choices/Defaults |
Comments |
active
|
|
A user with active set to False will be tracked in the database, but will be never loaded in the in-memory data structures. If omitted the proxysql database default for active is True .
|
backend
|
Default:
yes
|
If backend is set to True , this (username, password) pair is used for authenticating to the ProxySQL instance.
|
config_file
|
Default:
|
Specify a config file from which login_user and login_password are to be read.
|
default_hostgroup
|
|
If there is no matching rule for the queries sent by this user, the traffic it generates is sent to the specified hostgroup. If omitted the proxysql database default for use_ssl is 0.
|
default_schema
|
|
The schema to which the connection should change to by default.
|
fast_forward
|
|
If fast_forward is set to True , fast_forward will bypass the query processing layer (rewriting, caching) and pass through the query directly as is to the backend server. If omitted the proxysql database default for fast_forward is False .
|
frontend
|
Default:
yes
|
If frontend is set to True , this (username, password) pair is used for authenticating to the mysqld servers against any hostgroup.
|
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 the backend for this user. If omitted the proxysql database default for max_connections is 10000.
|
password
|
|
Password of the user connecting to the mysqld or ProxySQL instance.
|
save_to_disk
bool |
|
Save config to sqlite db on disk to persist the configuration.
|
state
|
Choices:
present ←
- absent
|
When present - adds the user, when absent - removes the user.
|
transaction_persistent
|
|
If this is set for the user with which the MySQL client is connecting to ProxySQL (thus a "frontend" user), transactions started within a hostgroup will remain within that hostgroup regardless of any other rules. If omitted the proxysql database default for transaction_persistent is False .
|
use_ssl
|
|
If use_ssl is set to True , connections by this user will be made using SSL connections. If omitted the proxysql database default for use_ssl is False .
|
username
required |
|
Name of the user connecting to the mysqld or ProxySQL instance.
|