Minor grammar/markup updates

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323459 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2012-02-23 21:57:59 +00:00
parent 885dded38a
commit f9da9fcc89
3 changed files with 35 additions and 32 deletions

View file

@ -156,32 +156,33 @@
</listitem>
<listitem>
<para>
Added mysqlnd_ms_set_qos() function to set required connection quality at runtime.
New constants related to mysqlnd_ms_set_qos():
Added the <function>mysqlnd_ms_set_qos</function> function to set the
required connection quality at runtime. The new constants related to
<function>mysqlnd_ms_set_qos</function> are:
<itemizedlist>
<listitem>
<simpara>
<literal>MYSQLND_MS_QOS_CONSISTENCY_STRONG</literal>
<constant>MYSQLND_MS_QOS_CONSISTENCY_STRONG</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>MYSQLND_MS_QOS_CONSISTENCY_SESSION</literal>
<constant>MYSQLND_MS_QOS_CONSISTENCY_SESSION</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL</literal>
<constant>MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>MYSQLND_MS_QOS_OPTION_GTID</literal>
<constant>MYSQLND_MS_QOS_OPTION_GTID</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>MYSQLND_MS_QOS_OPTION_AGE</literal>
<constant>MYSQLND_MS_QOS_OPTION_AGE</constant>
</simpara>
</listitem>
</itemizedlist>
@ -231,7 +232,8 @@
</listitem>
<listitem>
<para>
Added mysqlnd_ms_get_last_gtid() to fetch last global transaction id.
Added <function>mysqlnd_ms_get_last_gtid</function> to fetch the last
global transaction id.
</para>
</listitem>
<listitem>

View file

@ -30,11 +30,11 @@
<listitem>
<para>
A PECL/mysqlnd_ms connection handle to a MySQL server of the type
<literal>PDO_MySQL</literal>, <literal>mysqli</literal> or
<literal>mysql</literal>.
<link linkend="ref.pdo-mysql">PDO_MYSQL</link>, <link linkend="book.mysqli">mysqli</link>> or
<link linkend="book.mysql">ext/mysql</link>.
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.
</para>
</listitem>
</varlistentry>

View file

@ -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.
</para>
<para>
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
<function>mysqlnd_ms_set_qos</function>.
</para>
<para>
@ -39,7 +39,7 @@
SQL hints to force the use of a certain type of node or using the
<literal>master_on_write</literal> 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 @@
<listitem>
<para>
A PECL/mysqlnd_ms connection handle to a MySQL server of the type
<literal>PDO_MySQL</literal>, <literal>mysqli</literal> or
<literal>mysql</literal> 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.
<link linkend="ref.pdo-mysql">PDO_MYSQL</link>, <link linkend="book.mysqli">mysqli</link>> or
<link linkend="book.mysql">ext/mysql</link> 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.
</para>
</listitem>
</varlistentry>
@ -88,24 +88,24 @@
The option <constant>MYSQLND_MS_QOS_OPTION_GTID</constant> can be used
to refine the service level <constant>MYSQLND_MS_QOS_CONSISTENCY_SESSION</constant>.
It must be combined with a fourth function parameter, the
<literal>option_value</literal>. The <literal>option_value</literal>
<parameter>option_value</parameter>. The <parameter>option_value</parameter>
shall be a global transaction ID obtained from
<function>mysqlnd_ms_get_last_gtid</function>. 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
<literal>option_value</literal>. 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
<parameter>option_value</parameter>. Please note, searching appropriate slaves
is an expensive and slow operation. Use the feature sparsely, if the
master cannot handle the read load alone.
</para>
<para>
The option <constant>MYSQLND_MS_QOS_OPTION_AGE</constant> can be used
together with the <constant>MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL</constant>
service level to filter out asynchronous slaves that lag more seconds behind
the master than <literal>option_value</literal>. If set, the plugin
will consider only slaves for reading for
which <literal>SHOW SLAVE STATUS</literal> reports
The <constant>MYSQLND_MS_QOS_OPTION_AGE</constant> option can be combined
with the <constant>MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL</constant>
service level, to filter out asynchronous slaves that lag more seconds behind
the master than <parameter>option_value</parameter>. If set, the plugin
will only consider slaves for reading if
<literal>SHOW SLAVE STATUS</literal> reports
<literal>Slave_IO_Running=Yes</literal>,
<literal>Slave_SQL_Running=Yes</literal> and
<literal>Seconds_Behind_Master &lt;= option_value</literal>. Please note,
@ -121,7 +121,8 @@
<term><parameter>option_value</parameter></term>
<listitem>
<para>
Parameter value for the service level option. See also <literal>service_level_option</literal>.
Parameter value for the service level option. See also the
<parameter>service_level_option</parameter> parameter.
</para>
</listitem>
</varlistentry>