From f9da9fcc89b1d57259f7a9c125c225d81415e5fa Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Thu, 23 Feb 2012 21:57:59 +0000 Subject: [PATCH] Minor grammar/markup updates git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323459 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/mysqlnd_ms/changes.xml | 18 ++++---- .../functions/mysqlnd-ms-get-last-gtid.xml | 6 +-- .../functions/mysqlnd-ms-set-qos.xml | 43 ++++++++++--------- 3 files changed, 35 insertions(+), 32 deletions(-) diff --git a/reference/mysqlnd_ms/changes.xml b/reference/mysqlnd_ms/changes.xml index be4f34d33f..5bdd86c6ee 100644 --- a/reference/mysqlnd_ms/changes.xml +++ b/reference/mysqlnd_ms/changes.xml @@ -156,32 +156,33 @@ - Added mysqlnd_ms_set_qos() function to set required connection quality at runtime. - New constants related to mysqlnd_ms_set_qos(): + Added the mysqlnd_ms_set_qos function to set the + required connection quality at runtime. The new constants related to + mysqlnd_ms_set_qos are: - MYSQLND_MS_QOS_CONSISTENCY_STRONG + MYSQLND_MS_QOS_CONSISTENCY_STRONG - MYSQLND_MS_QOS_CONSISTENCY_SESSION + MYSQLND_MS_QOS_CONSISTENCY_SESSION - MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL + MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL - MYSQLND_MS_QOS_OPTION_GTID + MYSQLND_MS_QOS_OPTION_GTID - MYSQLND_MS_QOS_OPTION_AGE + MYSQLND_MS_QOS_OPTION_AGE @@ -231,7 +232,8 @@ - Added mysqlnd_ms_get_last_gtid() to fetch last global transaction id. + Added mysqlnd_ms_get_last_gtid to fetch the last + global transaction id. diff --git a/reference/mysqlnd_ms/functions/mysqlnd-ms-get-last-gtid.xml b/reference/mysqlnd_ms/functions/mysqlnd-ms-get-last-gtid.xml index 6402a2fb65..c2c33ab059 100644 --- a/reference/mysqlnd_ms/functions/mysqlnd-ms-get-last-gtid.xml +++ b/reference/mysqlnd_ms/functions/mysqlnd-ms-get-last-gtid.xml @@ -30,11 +30,11 @@ A PECL/mysqlnd_ms connection handle to a MySQL server of the type - PDO_MySQL, mysqli or - mysql. + PDO_MYSQL, mysqli> or + ext/mysql. The connection handle is obtained when opening a connection with a host name that matches a mysqlnd_ms configuration file - entry using any of the three extensions. + entry using any of the above three MySQL driver extensions. diff --git a/reference/mysqlnd_ms/functions/mysqlnd-ms-set-qos.xml b/reference/mysqlnd_ms/functions/mysqlnd-ms-set-qos.xml index 55fdd1c0b1..037873146d 100644 --- a/reference/mysqlnd_ms/functions/mysqlnd-ms-set-qos.xml +++ b/reference/mysqlnd_ms/functions/mysqlnd-ms-set-qos.xml @@ -22,16 +22,16 @@ a certain quality of service to the user depending on its architecture. A major aspect of the quality of service is the consistency level the cluster can offer. An asynchronous MySQL replication cluster defaults to eventual consistency for - slave reads: a slave may serve stale data, current data or it may have not the + slave reads: a slave may serve stale data, current data, or it may have not the requested data at all, because it is not synchronous to the master. In a - MySQL replication cluster only master accesses can give strong consistency, which + MySQL replication cluster, only master accesses can give strong consistency, which promises that all clients see each others changes. PECL/mysqlnd_ms hides the complexity of choosing appropriate nodes to achieve a certain level of service from the cluster. The - quality of service filter implements the necessary logic. The filter can either - be configured in the plugins configuration file or at run time using + "Quality of Service" filter implements the necessary logic. The filter can either + be configured in the plugins configuration file, or at runtime using mysqlnd_ms_set_qos. @@ -39,7 +39,7 @@ SQL hints to force the use of a certain type of node or using the master_on_write plugin configuration option. The first requires more code and causes more work on the application side. - The latter is coarser than using the quality of service filter. + The latter is less refined than using the quality of service filter. Settings made through the function call can be reversed, as shown in the example below. The example temporarily switches to a higher service level (session consistency, read your writes) and returns @@ -58,11 +58,11 @@ A PECL/mysqlnd_ms connection handle to a MySQL server of the type - PDO_MySQL, mysqli or - mysql for which a service level is to be set. - The connection handle is obtained when opening a connection with - a host name that matches a mysqlnd_ms configuration file - entry using any of the three extensions. + PDO_MYSQL, mysqli> or + ext/mysql for which a service level is to be set. + The connection handle is obtained when opening a connection with + a host name that matches a mysqlnd_ms configuration file + entry using any of the above three MySQL driver extensions. @@ -88,24 +88,24 @@ The option MYSQLND_MS_QOS_OPTION_GTID can be used to refine the service level MYSQLND_MS_QOS_CONSISTENCY_SESSION. It must be combined with a fourth function parameter, the - option_value. The option_value + option_value. The option_value shall be a global transaction ID obtained from mysqlnd_ms_get_last_gtid. If set, the plugin considers both master servers and asynchronous slaves for session consistency (read your writes). Otherwise, only masters are - used to achive session consistency. A slave is considered up-to-date and taken - into account if it has already replicated the global transaction ID from - option_value. Please note, searching appropriate slaves + used to achieve session consistency. A slave is considered up-to-date and + checked if it has already replicated the global transaction ID from + option_value. Please note, searching appropriate slaves is an expensive and slow operation. Use the feature sparsely, if the master cannot handle the read load alone. - The option MYSQLND_MS_QOS_OPTION_AGE can be used - together with the MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL - service level to filter out asynchronous slaves that lag more seconds behind - the master than option_value. If set, the plugin - will consider only slaves for reading for - which SHOW SLAVE STATUS reports + The MYSQLND_MS_QOS_OPTION_AGE option can be combined + with the MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL + service level, to filter out asynchronous slaves that lag more seconds behind + the master than option_value. If set, the plugin + will only consider slaves for reading if + SHOW SLAVE STATUS reports Slave_IO_Running=Yes, Slave_SQL_Running=Yes and Seconds_Behind_Master <= option_value. Please note, @@ -121,7 +121,8 @@ option_value - Parameter value for the service level option. See also service_level_option. + Parameter value for the service level option. See also the + service_level_option parameter.