Predefined Constants

The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.

SQL hint related

The mysqlnd replication and load balancing plugin (mysqlnd_ms) does read/write splitting to direct write queries to a MySQL master server and read-only queries to MySQL slave servers in a MySQL replication setup. The plugin has a built-in read/write split logic. The logic is very basic. All queries which start with SELECT are considered read-only queries which shall be send to a MySQL slave server listed in the plugin configuration file. All other queries shall be directed to the MySQL master server specified in the plugin configuration file.

User supplied SQL hints can be used to overrule automatic read/write splitting to gain full control on the process. SQL hints are standards compliant SQL comments. The plugin will scan the beginning of a query string for a SQL comment with certain contents which control query redirection. Other systems involved in the query processing are unaffected by the plugins SQL hints because other systems will ignore the SQL comments.

The plugin supports three SQL hints to direct queries to the MySQL slave servers, the MySQL master server and the last used MySQL server. SQL hints must be placed at the beginning to be recognized by the plugin.

It is recommended to use the string constants MYSQLND_MS_MASTER_SWITCH, MYSQLND_MS_SLAVE_SWITCH and MYSQLND_MS_LAST_USED_SWITCH instead of their literal values for better portability.

<?php
/* Use constants for maximum portability */
$master_query "/*" MYSQLND_MS_MASTER_SWITCH "*/SELECT id FROM test";

/* Valid but less portable: using literal instad of constant */
$slave_query "/*ms=slave*/SHOW TABLES";

printf("master_query = '%s'\n"$master_query);
printf("slave_query = '%s'\n"$slave_query);
?>

The above examples will output:

master_query = /*ms=master*/SELECT id FROM test
slave_query = /*ms=slave*/SHOW TABLES

MYSQLND_MS_MASTER_SWITCH (string)
SQL hint used to send a query to the MySQL replication master server.
MYSQLND_MS_SLAVE_SWITCH (string)
SQL hint used to send a query to one of the MySQL replication slave servers.
MYSQLND_MS_LAST_USED_SWITCH (string)
SQL hint used to send a query to the last used MySQL server. The last used MySQL server can either be a master or a slave server in a MySQL replication setup.

mysqlnd_ms_is_select() related

MYSQLND_MS_QUERY_USE_MASTER (integer)
If mysqlnd_ms_is_select() returns MYSQLND_MS_QUERY_USE_MASTER for a given query, the built-in read/write split mechanism recommends sending the query to a MySQL replication master server.
MYSQLND_MS_QUERY_USE_SLAVE (integer)
If mysqlnd_ms_is_select() returns MYSQLND_MS_QUERY_USE_SLAVE for a given query, the built-in read/write split mechanism recommends sending the query to a MySQL replication slave server.
MYSQLND_MS_QUERY_USE_LAST_USED (integer)
If mysqlnd_ms_is_select() returns MYSQLND_MS_QUERY_USE_LAST_USED for a given query, the built-in read/write split mechanism recommends sending the query to the last used server.

Other

The plugins version number can be obtained using MYSQLND_MS_VERSION or MYSQLND_MS_VERSION_ID. MYSQLND_MS_VERSION is the string representation of the numerical version number MYSQLND_MS_VERSION_ID, which is an integer such as 10000. Developers can calculate the version number as follows.

Version (part) Example
Major*10000 1*10000 = 10000
Minor*100 0*100 = 0
Patch 0 = 0
MYSQLND_MS_VERSION_ID 10000

MYSQLND_MS_VERSION (string)
Plugin version string, for example, "1.0.0-prototype".
MYSQLND_MS_VERSION_ID (integer)
Plugin version number, for example, 10000.

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top