svn: /phpdoc/en/trunk/reference/mysqlnd_ms/ concepts.xml functions/mysqlnd-ms-xa-gc.xml setup.xml
| From: | Ulf Wendel | Date: | Tue, 29 Jul 2014 19:54:42 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/mysqlnd_ms/ concepts.xml functions/mysqlnd-ms-xa-gc.xml setup.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-12670@lists.php.net to get a copy of this message | ||
uw Tue, 29 Jul 2014 19:54:42 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=334415
Log:
Third parameter for mysqlnd_ms_xa_gc to force GC runs
Changed paths:
U phpdoc/en/trunk/reference/mysqlnd_ms/concepts.xml
U phpdoc/en/trunk/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-gc.xml
U phpdoc/en/trunk/reference/mysqlnd_ms/setup.xml
Modified: phpdoc/en/trunk/reference/mysqlnd_ms/concepts.xml
===================================================================
--- phpdoc/en/trunk/reference/mysqlnd_ms/concepts.xml 2014-07-29 17:16:01 UTC (rev 334414)
+++ phpdoc/en/trunk/reference/mysqlnd_ms/concepts.xml 2014-07-29 19:54:42 UTC (rev 334415)
@@ -2312,12 +2312,14 @@
<para>
For each failed XA transaction the garbage collection makes
<literal>max_retries</literal> (default: 5) attempts to finish it. After that
- <literal>PECL/mysqlnd_ms</literal> gives up and the XA transaction must be
- cleaned up by a human operator. There are two possible reasons for this. Either
+ <literal>PECL/mysqlnd_ms</literal> gives up. There are two possible reasons for
this. Either
a participating server crashed and has not become accessible again within
<literal>max_retries</literal> invocations of the garbage collection, or there
is a situation that the built-in garbage collection cannot cope with. Likely, the
- latter would be considered a bug.
+ latter would be considered a bug. However, you can manually force more
+ garbage collection runs calling <function>mysqlnd_ms_xa_gc</function> with the
+ appropriate parameter set. Should even those function runs fail to solve
+ the situation, then the problem must be solved by an operator.
</para>
<para>
The function <link
linkend="function.mysqlnd-ms-get-stats"><function>mysqlnd_ms_get_stats</function></link>
Modified: phpdoc/en/trunk/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-gc.xml
===================================================================
--- phpdoc/en/trunk/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-gc.xml 2014-07-29 17:16:01 UTC (rev
334414)
+++ phpdoc/en/trunk/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-gc.xml 2014-07-29 19:54:42 UTC (rev
334415)
@@ -14,7 +14,9 @@
<methodname>mysqlnd_ms_xa_gc</methodname>
<methodparam><type>mixed</type><parameter>connection</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>gtrid</parameter></methodparam>
+ <methodparam
choice="opt"><type>boolean</type><parameter>ignore_max_retries</parameter></methodparam>
+
</methodsynopsis>
<para>
Garbage collects unfinished XA transactions.
@@ -77,6 +79,21 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>ignore_max_retries</parameter></term>
+ <listitem>
+ <para>
+ Whether to ignore the plugin configuration <literal>max_retries</literal>
setting.
+ If garbage collection continously fails and the <literal>max_retries</literal>
+ limit is reached prior to finishing the failed global transaction,
+ you can attempt further runs prior to investigating the cause
+ and solving the issue manually by issueing appropriate SQL statements
+ on the participants. Setting the parameter has the same effect
+ as temporarily setting <literal>max_retries = 0</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mysqlnd_ms/setup.xml
===================================================================
--- phpdoc/en/trunk/reference/mysqlnd_ms/setup.xml 2014-07-29 17:16:01 UTC (rev 334414)
+++ phpdoc/en/trunk/reference/mysqlnd_ms/setup.xml 2014-07-29 19:54:42 UTC (rev 334415)
@@ -3034,6 +3034,9 @@
long as crashed servers become available again quickly.
Still, a situation may arise where a human is required to
act because the built-in garbage collection stopped or failed.
+ In this case, you may first want to check if the transaction still
+ cannot be fixed by forcing <function>mysqlnd_ms_xa_gc</function>
+ to ignore the setting, prior to handling it manually.
</para>
<para>
Default: <literal>5</literal>