diff --git a/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-gc.xml b/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-gc.xml
index 40d60a6c4a..cc5f4c05bf 100644
--- a/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-gc.xml
+++ b/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-gc.xml
@@ -83,7 +83,7 @@
&reftitle.returnvalues;
- Returns &true; if the global transaction has been rolled back. Otherwise, returns &false;
+ Returns &true; if garbage collection was successful. Otherwise, returns &false;
diff --git a/reference/mysqlnd_ms/quickstart.xml b/reference/mysqlnd_ms/quickstart.xml
index c57ff3caf9..45b25630c5 100755
--- a/reference/mysqlnd_ms/quickstart.xml
+++ b/reference/mysqlnd_ms/quickstart.xml
@@ -825,14 +825,19 @@ $mysqli->close();
Version requirement
- XA related functions have been introduced in PECL mysqlnd_ms version 1.6.0-alpha.
+ XA related functions have been introduced in PECL mysqlnd_ms version 1.6.0-alpha.
- Experimental
+ Early adaptors wanted
The feature is currently under development. There may be issues and/or
- feature limitations. Do not use in production environments.
+ feature limitations. Do not use in production environments, although
+ early lab tests indicate reasonable quality.
+
+
+ Please, contact the development team if you are interested in this feature.
+ We are looking for real life feedback to complement the feature.
diff --git a/reference/mysqlnd_ms/setup.xml b/reference/mysqlnd_ms/setup.xml
index 66362ef42b..fb215cc8df 100755
--- a/reference/mysqlnd_ms/setup.xml
+++ b/reference/mysqlnd_ms/setup.xml
@@ -28,18 +28,18 @@
Plugin configuration file (>=1.1.x)
-
+
The following documentation applies to PECL/mysqlnd_ms >= 1.1.0-beta.
It is not valid for prior versions. For documentation covering earlier
- versions, see the configuration documentation
+ versions, see the configuration documentation
for mysqlnd_ms 1.0.x and below.
-
+
Introduction
-
-
+
+
Changelog: Feature was added in PECL/mysqlnd_ms 1.1.0-beta
@@ -486,7 +486,7 @@ Warning: mysqli::mysqli(): (mysqlnd_ms) Exclusive usage of configuration enforce
Configuration Directives
-
+
Here is a short explanation of the configuration directives that can be used.
@@ -2829,7 +2829,7 @@ $mysqli->set_charset("latin1");
Default: mysqlnd_ms_xa_trx
-
+ SQL definition for the MySQL state store transaction table
@@ -2993,10 +2993,24 @@ CREATE TABLE mysqlnd_ms_xa_gc (
-
+
+
+ rollback_on_close
+
+
+ Whether to automatically rollback an open global transaction when
+ a connection is closed. If enabled, it mimics the default behaviour
+ of local transactions. Should a client disconnect, the server rolls
+ back any open and unfinished transactions.
+
+
+ Default: true
+
+
+ garbage_collection
@@ -3021,8 +3035,29 @@ CREATE TABLE mysqlnd_ms_xa_gc (
probability
- Garbage collection probability. Setting the value has not effect.
- The feature is under development. Available since 1.6.0.
+ Garbage collection probability.
+ Allowed values are from 0 to 1000.
+ A setting of 0 disables automatic background
+ garbage collection. Despite a setting of 0 it is
+ still possible to trigger garbage collection by calling
+ mysqlnd_ms_gc.
+ Available since 1.6.0.
+
+
+ The automatic garbage collection of stalled XA transaction is only
+ available if a state store have been configured. The state store
+ is responsible to keep track of XA transactions. Based on its recordings
+ it can find blocked XA transactions where the client has crashed,
+ connect to the participants and rollback the unfinished transactions.
+
+
+ The garbage collection is triggered as part of PHP's request shutdown
+ procedure at the end of a web request. That is after your PHP script
+ has finished working. Do decide whether to run the garbage collection
+ a random value between 0 and 1000
+ is computed. If the probability value is higher
+ or equal to the random value, the state stores garbage collection routines
+ are invoked.
Default: 5
@@ -3030,14 +3065,23 @@ CREATE TABLE mysqlnd_ms_xa_gc (
- rollback_on_close
+ max_transactions_per_run
- Whether to automatically rollback an open global transaction is
- a connection is closed.
+ Maximum number of unfinished XA transactions considered
+ by the garbage collection during one run.
+ Allowed values are from 1 to 32768.
+ Available since 1.6.0.
- Default: true
+ Cleaning up an unfinished XA transaction takes considerable
+ amounts of time and resources. The garbage collection routine
+ may have to connect to several participants of a failed global
+ transaction to issue the SQL commands for rolling back
+ the unfinished tranaction.
+
+
+ Default: 100