&reftitle.setup;
&reftitle.required;
PHP 5.3.6 or newer.
The mysqlnd_ms replication and load balancing
plugin supports all PHP applications and all available PHP MySQL extensions
(mysqli,
mysql,
PDO_MYSQL).
The PHP MySQL extension must be configured to use
mysqlnd in order to be able
to use the mysqlnd_ms plugin for
mysqlnd.
&reference.mysqlnd-ms.configure;
&reference.mysqlnd-ms.ini;
Plugin configuration file (>=1.1.x)
The below description applies to PECL/mysqlnd_ms >= 1.1.0-beta.
It is not valid for prior versions.
The plugin is using its own configuration file. The configuration file
holds information on the MySQL replication master server,
the MySQL replication slave servers, the server pick (load balancing) policy,
the failover strategy and the use of lazy connections.
The PHP configuration directive
mysqlnd_ms.ini_file
is used to set the plugins configuration file.
As of mysqlnd 1.1.0-beta JavaScript Object Notation (JSON)
format is used for the plugins configuration file.
JSON structures are fast to parse by the plugin,
thanks PHPs JSON support. The JSON format makes it easy
to define hierarchical
data structures. Hierachical data structures are used, for example,
to allow definition of chained filters. Expressing hierarchical data structures
with the standard php.ini format is much more inconvenient.
If you are unfamiliar with the JSON you may want to convert
the configuration file into a PHP hash, edit the hash and convert it back
to JSON format.
Converting a PHP hash into JSON format
array(
"master" => array(
"master_0" => array(
"host" => "localhost",
"socket" => "/tmp/mysql.sock",
),
),
"slave" => array(),
),
);
file_put_contents("mysqlnd_ms.ini", json_encode($config, JSON_PRETTY_PRINT));
printf("mysqlnd_ms.ini file created...\n");
printf("Dumping file contents...\n");
printf("%s\n", str_repeat("-", 80));
echo file_get_contents("mysqlnd_ms.ini");
printf("\n%s\n", str_repeat("-", 80));
?>
]]>
&example.outputs;
A plugin configuration file consists of one or more sections. Sections
are represented by the top-level object properties of the
object encoded in the JSON file. Sections could also
be called configuration names.
Applications reference sections by their name. Applications use section names
as the host (server) parameter to the various connect methods of the
mysqli,
mysql and
PDO_MYSQL extensions. Upon connect
the mysqlnd plugin compares the hostname
with all section names from the plugin configuration file. If hostname and
section name match, the plugin will load the sections settings.
Using section names example
]]>
Section names are strings. It is valid to use a section name such as
192.168.2.1, 127.0.0.1 or
localhost. If, for example, an application
connects to localhost and a plugin
configuration section localhost exists, the
semantics of the connect operation are changed. The application will
no longer only use the MySQL server running on the host
localhost but the plugin will start to load balance
MySQL queries following the rules from the localhost
configuration section. This way you can load balance queries from
an application without changing the applications source code.
Please keep in mind, that such a configuration may not contribute
to overall readability of your applications source code. Using section names
that can be mixed up with host names should be seen as a last resort.
Each configuration section contains at least a list of master servers
and a list of slave servers. The master list is configured with the keyword
master, the slave list is configured with the slave
Failing to provide a slave list will result in an error of type
E_ERROR (fatal error). Although you are not allowed
to omit the slave list, it may be empty.
The master and slave server lists can be optionally indexed by symbolic
names for the servers they describe. If optional indexing entries
by symbolic names is not needed, use an array of server descriptions for
the slave or master that is to be described.
List of anonymous slaves
An anonymous server list is encoded by the JSON array type.
You can optionally use symbolic names for indexing the slave or master servers
of a server list. In the latter case you have to use the
JSON object type.
Master list using symbolic names
It is recommended to index the server lists with symbolic server names.
The alias names will be shown in error messages.
The order of servers is preserved and taken into account by mysqlnd_ms.
If, for example, you configure round robin load balancing strategy, the
first SELECT statement will be executed on the
slave that appears first in the slave server list.
A configured server can be described with the host,
port, socket, db,
user, password and connect_flags.
It is mandatory to set the database server host using the host
keyword. All other settings are optional.
Keywords to configure a server
If a setting is omitted, the plugin will use the value provided by the user
API call used to open a connection. Please, see the
using section names example above.
The configuration file format has been changed in version 1.1.0-beta to allow for
chained filters. Filters are responsible for filtering the configured list of
servers to identify a server for execution of a given statement.
Filters are configured with the filter keyword. Filters
are executed by mysqlnd_ms in the order of their appearance.
Defining filters is optional. A configuration section in the plugins
configuration file does not need to have a filters entry.
Filters replace the
pick[]
setting from prior versions. The new random and
roundrobin provide the same functionality.
New roundrobin filter, old functionality
The function
mysqlnd_ms_set_user_pick_server
has been removed. Setting a callback is now done with the user
filter. Some filters accept parameters. The user filter
requires and accepts a mandatory callback parameter
to set the callback previously set through the function mysqlnd_ms_set_user_pick_server.
The user filter replaces mysqlnd_ms_set_user_pick_server
Here is a short explanation of the configuration directives that can be used.
masterarray or object
List of MySQL replication master servers. The list of either
of the JSON type array to declare an anonymous list
of servers or of the JSON type object. Please,
see above
for examples.
Setting at least one master server is mandatory. The plugin will issue an
error of type E_ERROR if the user has failed to
provide a master server list for a configuration section.
The fatal error may read
(mysqlnd_ms) Section [master] doesn't exist for host
[name_of_a_config_section] in %s on line %d.
A server is described with
the host, port,
socket, db,
user, password and
connect_flags. It is mandatory to
provide at a value for host. If any of the
other values is not given, it will be taken from the user
API connect call, please, see also:
using section names example.
Table of server configuration keywords.
KeywordDescriptionVersionhost
Database server host. This is a mandatory setting.
Failing to provide, will cause an error of type E_RECOVERABLE_ERROR
when the plugin tries to connect to the server. The error message may
read (mysqlnd_ms) Cannot find [host] in
[%s] section in config in %s on line %d.
Since 1.1.0.port
Database server TCP/IP port.
Since 1.1.0.socket
Database server Unix domain socket.
Since 1.1.0.db
Database (schemata).
Since 1.1.0.user
MySQL database user.
Since 1.1.0.password
MySQL database user password.
Since 1.1.0.connect_flags
Connection flags.
Since 1.1.0.
The plugin supports using only one master server. An experimental
setting exists to enable multi-master support. The details are
not documented. The setting is meant for development only.
slavearray or object
List of one or more MySQL replication slave servers. The syntax is
identical to setting master servers, please, see
master
above for details.
The plugin supports using one or more slave servers.
Setting a list of slave servers is mandatory. The plugin will report
an error of the type E_ERROR if slave
is not given for a configuration section. The fatal error message may read
(mysqlnd_ms) Section [slave] doesn't exist for host [%s] in %s on line %d.
Note, that it is valid to use an empty slave server list.
The error has been introduced to prevent accidently setting no slaves by
forgetting about the slave setting.
A master-only setup is still possible using an empty slave server list.
If an empty slave list is configured and an attempt is made to
execute a statement on a slave the plugin may emit a warning like
mysqlnd_ms) Couldn't find the appropriate slave connection.
0 slaves to choose from. upon statement execution.
It is possible that another warning follows such as
(mysqlnd_ms) No connection selected by the last filter.
filtersobject
List of filters. A filter is responsible to filter the list of available
servers for executing a given statement. Filters can be chained.
The random and roundrobin filter
replace the
pick[]
directive used in prior version to select a load balancing policy.
The user filter replaces the
mysqlnd_ms_set_user_pick_server function.
Filters may accept parameters to refine their actions.
If no load balancing policy is set, the plugin will default to
random_once. The random_once
policy picks a random slave server when running the first read-only
statement. The slave server will be used for all read-only
statements until the PHP script execution ends. No load balancing
policy is set and thus, defaulting takes place,
if neither the random nor the
roundrobin are part of a configuration section.
If a filter chain is configured so that a filter which output no
more than once server is used as input for a filter which should be given
more than one server as input, the plugin may emit a warning upon
opening a connection. The warning may read: (mysqlnd_ms) Error while creating
filter '%s' . Non-multi filter '%s' already created.
Stopping in %s on line %d. Futhermore an error of
the error code 2000, the sql state HY000
and an error message similar to the warning may be set on the connection
handle.
Invalid filter sequence
query("SELECT 1 FROM DUAL");
?>
]]>
&example.outputs;
Filter: randomobject
The random filter features the random and random once
load balancing policies, set through the
pick[]
directive in older versions.
The random policy will pick a random server whenever
a read-only statement is to be executed. The random once strategy
picks a random slave server once and continues using the slave for the
rest of the PHP web request. Random once is a default,
if load balancing is not configured through a filter.
If the random filter is not given any arguments, it
stands for random load balancing policy.
Random load balancing with random filter
Optionally, the sticky argument can be passed to the
filter. If the parameter sticky is set to the string
1, the filter follows the random once
load balancing strategy.
Random once load balancing with random filter
Unknown arguments are ignored. No warning or error is given.
Expects one or more servers as input. Outputs one server.
A filter sequence such as
random, roundrobin may
cause a warning and an error message to be set on the connection
handle when executing a statement.
Filter: roundrobinobject
If using the roundrobin filter, the plugin
iterates over the list of configured slave servers to pick a server
for statement execution. If the plugin reaches the end of the list,
it wraps around to the beginning of the list and picks the first
configured slave server.
roundrobin filter
Expects one or more servers as input. Outputs one server.
A filter sequence such as
roundrobin, random may
cause a warning and an error message to be set on the connection
handle when executing a statement.
Filter: userobject
The user replaces
mysqlnd_ms_set_user_pick_server function,
which was removed in 1.1.0-beta. The filter sets a callback for user-defined
read/write splitting and server selection.
The plugins built-in read/write query split mechanism decisions can be
overwritten in two ways. The easiest way is to prepend a query string
with the SQL hints MYSQLND_MS_MASTER_SWITCH,
MYSQLND_MS_SLAVE_SWITCH or
MYSQLND_MS_LAST_USED_SWITCH. Using SQL hints one can
control, for example, whether a query shall be send to the MySQL replication
master server or one of the slave servers. By help of SQL hints it is
not possible to pick a certain slave server for query execution.
Full control on server selection can be gained using a callback function.
Use of a callback is recommended to expert users only because the callback
has to cover all cases otherwise handled by the plugin.
The plugin will invoke the callback function for selecting a server from the
lists of configured master and slave servers. The callback function
inspects the query to run and picks a server for query execution by returning
the hosts URI, as found in the master and slave list.
If the lazy connections are enabled and the callback choses a slave server for
which no connection has been established so far and establishing the connection
to the slave fails, the plugin will return an error upon the next action
on the failed connection, for example, when running a query. It is the
responsibility of the application developer to handle the error. For example,
the application can re-run the query to trigger a new server selection and
callback invocation. If so, the callback must make sure to select
a different slave, or check slave availability, before returning to
the plugin to prevent an endless loop.
Setting a callback
The callback is supposed to return a host to run the query on.
The host URI is to be taken from the master and slave connection lists
passed to the callback function. If callback returns a value neither
found in the master nor in the slave connection lists the plugin
will emit an error of the type E_RECOVERABLE_ERROR
The error may read like
(mysqlnd_ms) User filter callback has returned an unknown server.
The server 'server that is not in master or slave list' can neither be found
in the master list nor in the slave list.
If the application catches the error to ignore it, follow up errors
may be set on the connection handle, for example,
(mysqlnd_ms) No connection selected by the last filter with
the error code 2000 and the sqlstate HY000.
Furthermore a warning may be emitted.
Referencing a non-existing function as a callback will result
in any error of the type E_RECOVERABLE_ERROR whenever
the plugin tries to callback function. The error message may reads like:
(mysqlnd_ms) Specified callback (pick_server) is
not a valid callback. If the application catches the error to
ignore it, follow up errors may be set on the connection handle, for example,
(mysqlnd_ms) Specified callback (pick_server) is
not a valid callback with the error code 2000
and the sqlstate HY000. Furthermore a warning
may be emitted.
The following parameters are passed from the plugin to the callback.
ParameterDescriptionVersionconnected_host
URI of the currently connected database server.
Since 1.1.0.query
Query string of the statement for which a server needs
to be picked.
Since 1.1.0.masters
List of master servers to choose from. Note, that the list of master
servers may not be identical to the list of configured master
servers if the filter is not the first in the filter chain.
Previously run filters may have reduced the master
list already.
Since 1.1.0.slaves
List of slave servers to choose from. Note, that the list of master
servers may not be identical to the list of configured master
servers if the filter is not the first in the filter chain.
Previously run filters may have reduced the master
list already.
Since 1.1.0.last_used_connection
URI of the server of the connection used to execute the previous
statement on.
Since 1.1.0.in_transaction
Boolean flag indicating wheter the statement is
part of an open transaction. If autocommit mode is turned
off, this will be set to TRUE. Otherwise
it is set to FALSE.
Transaction detection is based on monitoring the
mysqlnd library call set_autocommit.
Monitoring is not possible beofre PHP 5.4.0. Please, see
connection pooling and switching
concepts discussion for further details.
Since 1.1.0.Using a callback
query("SELECT 1 FROM DUAL")))
printf("[%d] %s\n", $mysqli->errno, $mysqli->error);
else
$res->close();
if (!($res = $mysqli->query("SELECT 2 FROM DUAL")))
printf("[%d] %s\n", $mysqli->errno, $mysqli->error);
else
$res->close();
if (!($res = $mysqli->query("SELECT * FROM table_on_slave_a_only")))
printf("[%d] %s\n", $mysqli->errno, $mysqli->error);
else
$res->close();
$mysqli->close();
?>
]]>
&example.outputs;
failoverstring
Failover policy. Supported policies:
disabled (default), master.
If no failover policy is set, the plugin will not do any
automatic failover (failover=disabled). Whenever
the plugin fails to connect a server it will emit a warning and
set the connections error code and message. Thereafter it is up to
the application to handle the error and, for example, resent the
last statement to trigger the selection of another server.
If using failover=master the plugin will implicitly
failover to a slave, if available. Please check the
concepts documentation to learn about potential
pitfalls and risks of using failover=master.
Optional master failover when failing to connect to slave
Setting failover to any other value but
disabled or master will not
emit any warning or error.
lazy_connectionsbool
Controls the use of lazy connections. Lazy connections
are connections which are not opened before the client sends the first
connection. Lazy connections are a default.
It is strongly recommended to use lazy connections.
Lazy connections help to keep the number of open connections low.
If you disable lazy connections and, for example, configure one MySQL
replication master server and two MySQL replication slaves, the
plugin will open three connections upon the first call to a
connect function although the application might use the master
connection only.
Lazy connections bare a risk if you make heavy use of actions
which change the state of a connection. The plugin does not dispatch
all state changing actions to all connections from the connection pool.
The few dispatched actions are applied to already opened connections
only. Lazy connections opened in the future are not affected.
Only some settings are "remembered" and applied when lazy
connections are opened.
Disabling lazy connectionmaster_on_writebool
If set, the plugin will use the master server only after the
first statement has been executed on the master. Applications
can still send statements to the slaves using SQL hints to
overrule the automatic decision.
The setting may help with replication lag. If an application runs
an INSERT the plugin will, by default, use the
master to execute all following statements, including
SELECT statements. This helps to avoid problems
with reads from slaves which have not replicated the
INSERT yet.
Master on write for consistent readstrx_stickinessstring
Transaction stickiness policy. Supported policies:
disabled (default), master.
Experimental feature.
The setting requires 5.4.0 or newer. If used with PHP older than 5.4.0,
the plugin will emit a warning like
(mysqlnd_ms) trx_stickiness strategy is not supported before PHP 5.3.99.
If no transaction stickiness policy is set or,
if setting trx_stickiness=disabled,
the plugin is not transaction aware. Thus, the plugin may load balance
connections and switch connections in the middle of a transaction.
The plugin is not transaction safe. SQL hints must be used
avoid connection switches during a transaction.
As of PHP 5.4.0 the mysqlnd library allows the plugin to monitor
the autocommit mode set by calls to the
libraries set_autocommit() function.
If setting set_stickiness=master and
autocommit gets disabled by a PHP MySQL extension
invoking the mysqlnd library internal
function call set_autocommit(), the plugin is made
aware of the begin of a transaction. Then, the plugin stops load balancing
and directs all statements to the master server until
autocommit is enabled. Thus, no SQL hints are required.
An example of a PHP MySQL API function calling the mysqlnd
library internal function call set_autocommit() is
mysqli_autocommit.
Although setting ser_stickiness=master, the plugin
cannot be made aware of autocommit mode changes caused
by SQL statements such as SET AUTOCOMMIT=0.
Using master to execute transactionsPlugin configuration file (<= 1.0.x)
The below description applies to PECL/mysqlnd_ms < 1.1.0-beta.
It is not valid for later versions.
The plugin is using its own configuration file. The configuration file
holds information on the MySQL replication master server,
the MySQL replication slave servers, the server pick (load balancing) policy,
the failover strategy and the use of lazy connections.
The PHP configuration directive
mysqlnd_ms.ini_file
is used to set the plugins configuration file.
The configuration file mimics standard the php.ini format.
It consists of one or more sections. Every section defines its own unit
of settings. There is no global section for setting defaults.
Applications reference sections by their name. Applications use section names
as the host (server) parameter to the various connect methods of the
mysqli,
mysql and
PDO_MYSQL extensions. Upon connect
the mysqlnd plugin compares the hostname
with all section names from the plugin configuration file. If hostname and
section name match, the plugin will load the sections settings.
Using section names example
]]>
Section names are strings. It is valid to use a section name such as
192.168.2.1, 127.0.0.1 or
localhost. If, for example, an application
connects to localhost and a plugin
configuration section [localhost] exists, the
semantics of the connect operation are changed. The application will
no longer only use the MySQL server running on the host
localhost but the plugin will start to load balance
MySQL queries following the rules from the [localhost]
configuration section. This way you can load balance queries from
an application without changing the applications source code.
The master[], slave[]
and pick[] configuration directives use a list-like syntax.
Configuration directives supporting list-like syntax may appear multiple
times in a configuration section. The plugin maintains the order in
which entries appear when interpreting them. For example,
the below example shows two slave[] configuration
directives in the configuration section [myapp].
If doing round-robin load balancing for read-only queries, the plugin
will send the first read-only query to the MySQL server
mysql_slave_1 because it is the first in the list.
The second read-only query will be send to the MySQL server
mysql_slave_2 because it is the second in the list.
Configuration directives supporting list-like syntax result are ordered
from top to bottom in accordance to their appearance within a configuration
section.
List-like syntax
Here is a short explanation of the configuration directives that can be used.
master[]string
URI of a MySQL replication master server. The URI follows the syntax
hostname[:port|unix_domain_socket].
The plugin supports using only one master server.
Setting a master server is mandatory. The plugin will report a
warning upon connect if the user has failed to provide a master
server for a configuration section.
The warning may read
(mysqlnd_ms) Cannot find master section in config.
Furthermore the plugin may set an error code for the connection handle such as
HY000/2000 (CR_UNKNOWN_ERROR). The corresponding error
message depends on your language settings.
slave[]string
URI of one or more MySQL replication slave servers. The URI follows the syntax
hostname[:port|unix_domain_socket].
The plugin supports using one or more slave servers.
Setting a slave server is mandatory. The plugin will report a
warning upon connect if the user has failed to provide at least one slave
server for a configuration section. The warning may read
(mysqlnd_ms) Cannot find slaves section in config.
Furthermore the plugin may set an error code for the connection handle such as
HY000/2000 (CR_UNKNOWN_ERROR). The corresponding error
message depends on your language settings.
pick[]string
Load balancing (server picking) policy. Supported policies:
random, random_once (default),
roundrobin, user.
If no load balancing policy is set, the plugin will default to
random_once. The random_once
policy picks a random slave server when running the first read-only
statement. The slave server will be used for all read-only
statements until the PHP script execution ends.
The random policy will pick a random server whenever
a read-only statement is to be executed.
If using
roundrobin the plugin iterates over the list of
configured slave servers to pick a server for statement execution.
If the plugin reaches the end of the list, it wraps around to the beginning
of the list and picks the first configured slave server.
Setting more than one load balancing policy for a configuration
section makes only sense in conjunction with user
and mysqlnd_ms_set_user_pick_server. If the
user defined callback fails to pick a server, the plugin falls
back to the second configured load balancing policy.
failoverstring
Failover policy. Supported policies:
disabled (default), master.
If no failover policy is set, the plugin will not do any
automatic failover (failover=disabled). Whenever
the plugin fails to connect a server it will emit a warning and
set the connections error code and message. Thereafter it is up to
the application to handle the error and, for example, resent the
last statement to trigger the selection of another server.
If using failover=master the plugin will implicitly
failover to a slave, if available. Please check the
concepts documentation to learn about potential
pitfalls and risks of using failover=master.
lazy_connectionsbool
Controls the use of lazy connections. Lazy connections
are connections which are not opened before the client sends the first
connection.
It is strongly recommended to use lazy connections.
Lazy connections help to keep the number of open connections low.
If you disable lazy connections and, for example, configure one MySQL
replication master server and two MySQL replication slaves, the
plugin will open three connections upon the first call to a
connect function although the application might use the master
connection only.
Lazy connections bare a risk if you make heavy use of actions
which change the state of a connection. The plugin does not dispatch
all state changing actions to all connections from the connection pool.
The few dispatched actions are applied to already opened connections
only. Lazy connections opened in the future are not affected.
If, for example, the connection character set is changed using a
PHP MySQL API call, the plugin will change the character set of all
currently opened connection. It will not remember the character set
change to apply it on lazy connections opened in the future. As a
result the internal connection pool would hold connections using
different character sets. This is not desired. Remember that character
sets are taken into account for escaping.
master_on_writebool
If set, the plugin will use the master server only after the
first statement has been executed on the master. Applications
can still send statements to the slaves using SQL hints to
overrule the automatic decision.
The setting may help with replication lag. If an application runs
an INSERT the plugin will, by default, use the
master to execute all following statements, including
SELECT statements. This helps to avoid problems
with reads from slaves which have not replicated the
INSERT yet.
trx_stickinessstring
Transaction stickiness policy. Supported policies:
disabled (default), master.
Experimental feature.
The setting requires 5.4.0 or newer. If used with PHP older than 5.4.0,
the plugin will emit a warning like
(mysqlnd_ms) trx_stickiness strategy is not supported before PHP 5.3.99.
If no transaction stickiness policy is set or,
if setting trx_stickiness=disabled,
the plugin is not transaction aware. Thus, the plugin may load balance
connections and switch connections in the middle of a transaction.
The plugin is not transaction safe. SQL hints must be used
avoid connection switches during a transaction.
As of PHP 5.4.0 the mysqlnd library allows the plugin to monitor
the autocommit mode set by calls to the
libraries trx_autocommit() function.
If setting trx_stickiness=master and
autocommit gets disabled by a PHP MySQL extension
invoking the mysqlnd library internal
function call trx_autocommit(), the plugin is made
aware of the begin of a transaction. Then, the plugin stops load balancing
and directs all statements to the master server until
autocommit is enabled. Thus, no SQL hints are required.
An example of a PHP MySQL API function calling the mysqlnd
library internal function call trx_autocommit() is
mysqli_autocommit.
Although setting trx_stickiness=master, the plugin
cannot be made aware of autocommit mode changes caused
by SQL statements such as SET AUTOCOMMIT=0.
Testing
The section applies to myslqnd_ms 1.1.0 or newer, not the 1.0 series.
The PECL/mysqlnd_ms test suite is in the tests/
directory of the source distribution. The test suite consists of standard
phpt tests, which are described on the PHP Quality Assurance Teams website.
Before running the tests, edit tests/config.inc to
configure the MySQL servers to be used for testing. You will need at least
one MySQL server to run the tests. However, configuring two distinct MySQL
servers is better. If two distinct servers are configured, the tests can use
one of them as a logical master and the other one as a logical slave. Those
two servers do not need to be part of a MySQL replication cluster. Tests
are written in a way that they can be successfully executed without having
to setup a MySQL replication cluster. If two servers are configured they
must allow login to a test database using the same username and password on
both servers.
The most basic configuration is as follows.
MYSQL_TEST_HOST, MYSQL_TEST_PORT and
MYSQL_TEST_SOCKET define the hostname,
TCP/IP port and Unix domain socket of the default database server.
MYSQL_TEST_USER and MYSQL_TEST_PASSWD
contain the user and password needed to connect to the database/schema
configured with MYSQL_TEST_DB. If using two distinct
servers, a logical master and a logical slave server, both of them must
have the same database user configured to give access to the test database.
Some tests require availability of two distinct MySQL test servers. Those
tests will be skipped, if only one server is configured. To configure a logical
slave server that runs on a different host and/or listens to a different port
or socket than the default server, set MYSQL_TEST_SLAVE_HOST.
Using host, host:port or host:/path/to/socket
syntax for MYSQL_TEST_SLAVE_HOST you can set an alternate
host, host and port or host and socket for the logical slave host.
The same syntax can be used to set MYSQL_TEST_MASTER_HOST.
Debugging and Tracing
The mysqlnd debug log can be used to debug and trace the actitivities of
PECL/mysqlnd_ms. As a mysqlnd PECL/mysqlnd_ms adds trace information to the
mysqlnd library debug file. Please, see the
mysqlnd.debug
PHP configuration directive documentation for a detailed description
on how to configure the debug log.
Configuration setting example to activate the debug log:
This feature is only available with a debug build of PHP. Works
on Microsoft Windows if using a debug build of PHP and PHP was
built using Microsoft Visual C version 9 and above.
The debug log shows mysqlnd library and PECL/mysqlnd_ms plugin function calls,
similar to a trace log. Mysqlnd library calls are usually prefixed with
mysqlnd_. PECL/mysqlnd internal calls begin with
mysqlnd_ms.
Example excerpt from the debug log (connect):
mysqlnd_connect
| info : host=myapp user=root db=test port=3306 flags=131072
| >mysqlnd_ms::connect
| | >mysqlnd_ms_config_json_section_exists
| | | info : section=[myapp] len=[5]
| | | >mysqlnd_ms_config_json_sub_section_exists
| | | | info : section=[myapp] len=[5]
| | | | info : ret=1
| | |
The debug log is not only useful for plugin developers but also to find the
cause of user errors. For example, if your application does not do proper
error handling and fails to record error messages, checking the debug
and trace log may help finding the cause. Use of the debug log
to debug application issues should be considered only if no other
option is available. Writing the debug log to disk is a slow
operation and may have negative impact on the application
performance.
Example excerpt from the debug log (connection failure):
error_info.error_no = 1045
| | | | | mysqlnd_conn::free_contents
| | | | | | >mysqlnd_net::free_contents
| | | | | | mysqlnd_error_list_pdtor
| | | | | |
The trace log can also be used to verify correct behaviour
of PECL/mysqlnd_ms itself, for example, to check which server has been
selected for query execution and why.
Example excerpt from the debug log (plugin decision):
mysqlnd_ms::query
| info : query=DROP TABLE IF EXISTS test
| >_mysqlnd_plugin_get_plugin_connection_data
| | info : plugin_id=5
| <_mysqlnd_plugin_get_plugin_connection_data
| >mysqlnd_ms_pick_server_ex
| | info : conn_data=0x7fb6a7d3e5a0 *conn_data=0x7fb6a7d410d0
| | >mysqlnd_ms_select_servers_all
| | mysqlnd_ms_choose_connection_rr
| | | >mysqlnd_ms_query_is_select
[...]
| | | mysqlnd_ms_advanced_connect
| | | | >mysqlnd_conn::connect
| | | | | info : host=localhost user=root db=test port=3306 flags=131072 persistent=0 state=0
]]>
In this case the statement DROP TABLE IF EXISTS test has been
executed. Note that the statement string is shown in the log file. You may want
to take measures to restrict access to the log for security considerations.
The statement has been load balanced using round robin policy,
as you can easily guess from the functions name >mysqlnd_ms_choose_connection_rr.
It has been sent to a master server running on
host=localhost user=root db=test port=3306 flags=131072 persistent=0 state=0.