Options must be specified within a configuration group named mysql-proxy. For example:

[mysql-proxy]
admin-address = host:port

All configuration options should be specified in the form of a configuration name and the value you want to set.

For options that are a simple toggle on the command-line (for example --proxy-skip-profiling, you must use true or false. For example, the following is invalid:

[mysql-proxy]
proxy-skip-profiling

But this is valid:

[mysql-proxy]
proxy-skip-profiling = true

The configuration file should have permissions of 0660 (readable and writable by user and group, no access for everybody).

--help

Show available help options.

--help-all

Show all help options.

--help-admin

Show options for the admin-module.

--help-proxy

Show options for the proxy-module.

--admin-address=host:port

The host name (or IP address) and port for the administration port. The default is localhost:4041.

--admin-lua-script=script

The script to use for the administration module for the proxy.

--admin-password=pass

The password to use to authenticate users wanting to connect to the administration module of mysql-proxy. The administration module uses the MySQL protocol to request a username and password for connections.

--admin-username=user

The username to use to authenticate users wanting to connect to the administration module of mysql-proxy. The default username is root. The administration module uses the MySQL protocol to request a username and password for connections.

--basedir

The base directory that will be prepended to all other filename configuration options. The base name should be an absolute (not relative) directory. If you specify a relative directory, mysql-proxy will generate an error during startup.

--defaults-file

The file to use as the file with configuration information. If not specified, configuration options are only taken from the command line.

--event-threads=#

The number of event threads reserved to handle incoming requests.

--keepalive

Creates a process surrounding the main mysql-proxy which will attempt to restart the true mysql-proxy process in thr event a crash or other failure.

--log-backtrace-on-crash

Logs the backtrace to the error log and tries to initialize the debugger in the event of a failure.

--log-file=filename

The name of a file to be used to record log information.

--log-file=filename

The log level to be used when outputting error messages. The specification will output that level (or lower) of a given error message. For example, message will also output info, warning, and error messages.

--log-use-syslog

Causes errors to be sent to the syslog (Unix/Linux only).

--lua-cpath=path

The LUA_CPATH to be used when loading compiled modules or libraries for Lua scripts.

--lua-path=path

The LUA_CPATH to be used when loading modules for Lua.

--max-open-files=#

The maximum number of open files and sockets supported by the mysql-proxy process. You may need to increase this with certain scripts.

--no-proxy

Disable the proxy module.

--plugin-dir=path

The directory to use when loading plugins for mysql-proxy.

--plugins=plugin,...

A comma-separated list of the plugins to be loaded.

--proxy-address=host:port

The listening host name (or IP address) and port of the proxy server. The default is :4040 (all IPs on port 4040).

--proxy-read-only-backend-addresses=host:port

The listening host name (or IP address) and port of the proxy server for read-only connections. The default is for this information not to be set.

When using this option on the command-line, you can specify the option and the server multiple times to specify multiple backends. For example:

shell> mysql-proxy --proxy-read-only-backend-addresses 192.168.0.1:3306 --proxy-read-only-backend-addresses 192.168.0.2:3306

When using the option within the configuration file, you should separate multiple servers with a comma. The equivalent of the above example would be:

...
read-only-backend-addresses = 192.168.0.1:3306, 192.168.0.2:3306

--proxy-backend-addresses=host:port

The host name (or IP address) and port of the MySQL server to connect to. You can specify multiple backend servers by supplying multiple options. Clients are connected to each backend server in round-robin fashion. For example, if you specify two servers A and B, the first client connection will go to server A; the second client connection to server B and the third client connection to server A.

When using this option on the command-line, you can specify the option and the server multiple times to specify multiple backends. For example:

shell> mysql-proxy --backend-addresses 192.168.0.1:3306 --backend-addresses 192.168.0.2:3306

When using the option within the configuration file, you should separate multiple servers with a comma. The equivalent of the above example would be:

...
backend-addresses = 192.168.0.1:3306, 192.168.0.2:3306

--proxy-pool-no-change-user

Disables the use of the MySQL protocol CHANGE_USER when reusing a connection from the pool of connections specified by the backend-addresses list.

--proxy-skip-profiling

Disables profiling of queries (tracking time statistics). The default is for tracking to be enabled.

--proxy-fix-bug-25371

Gets round an issue when connecting to a MySQL server later than 5.1.12 when using a MySQL client library of any earlier version.

--proxy-lua-script=file

The Lua script file to be loaded. Note that the script file is not physically loaded and parsed until a connection is made. Also note that the specified Lua script is reloaded for each connection; if the content of the Lua script changes while mysql-proxy is running then the updated content will automatically be used when a new connection is made.

--daemon

Starts the proxy in daemon mode.

--pid-file=file

Sets the name of the file to be used to store the process ID.

--user=user

Run mysql-proxy as the specified user.

--version

Show the version number.