diff --git a/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-begin.xml b/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-begin.xml index a6be59db77..3228b86e68 100644 --- a/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-begin.xml +++ b/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-begin.xml @@ -14,6 +14,7 @@ mysqlnd_ms_xa_begin mixedconnection stringgtrid + inttimeout Starts a XA transaction among MySQL servers. PECL/mysqlnd_ms acts as a transaction @@ -107,6 +108,25 @@ + + timeout + + + Timeout in seconds. The default value is 60 seconds. + + + The timeout is a hint to the garbage collection. If a transaction is recorded + to take longer than expected, the garbage collection begins checking the + transactions status. + + + Setting a low value may make the garbage collection check the progress + too often. Please note, checking the status of a global transaction may + involve connecting to all recorded participants and possibly issueing + queries on the servers. + + + diff --git a/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-commit.xml b/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-commit.xml new file mode 100644 index 0000000000..09566bf51c --- /dev/null +++ b/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-commit.xml @@ -0,0 +1,108 @@ + + + + + + mysqlnd_ms_xa_commit + Commits a distributed/XA transaction among MySQL servers + + + + &reftitle.description; + + int + mysqlnd_ms_xa_commit + mixedconnection + stringgtrid + + + + Commits a global transaction among MySQL servers started by + mysqlnd_ms_xa_begin. + + + If any of the global transaction participants fails to commit + an implicit rollback is performed. It may happen that not + all cases can be handled during the rollback. For example, + no attempts will be made to reconnect to a participant after + the connection to the participant has been lost. Solving + cases that cannot easily be rolled back is left to the + garbage collection. + + + Experimental + + The feature is currently under development. There may be issues and/or + feature limitations. Do not use in production environments. + + + + + + &reftitle.parameters; + + + connection + + + A MySQL connection handle obtained from any of the + connect functions of the mysqli, + mysql or + PDO_MYSQL extensions. + + + + + gtrid + + + Global transaction identifier (gtrid). + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the global transaction has been comitted. Otherwise, returns &false; + + + + + &reftitle.seealso; + + + + Quickstart XA/Distributed transactions + + + Runtime configuration + + + + + + + + diff --git a/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-rollback.xml b/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-rollback.xml new file mode 100644 index 0000000000..58c78314bb --- /dev/null +++ b/reference/mysqlnd_ms/functions/mysqlnd-ms-xa-rollback.xml @@ -0,0 +1,103 @@ + + + + + + mysqlnd_ms_xa_rollback + Rolls back a distributed/XA transaction among MySQL servers + + + + &reftitle.description; + + int + mysqlnd_ms_xa_rollback + mixedconnection + stringgtrid + + + + Rolls back a global transaction among MySQL servers started by + mysqlnd_ms_xa_begin. + + + If any of the global transaction participants fails to rollback + the situation is left to be solved by the garbage collection. + + + Experimental + + The feature is currently under development. There may be issues and/or + feature limitations. Do not use in production environments. + + + + + + &reftitle.parameters; + + + connection + + + A MySQL connection handle obtained from any of the + connect functions of the mysqli, + mysql or + PDO_MYSQL extensions. + + + + + gtrid + + + Global transaction identifier (gtrid). + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the global transaction has been rolled back. Otherwise, returns &false; + + + + + &reftitle.seealso; + + + + Quickstart XA/Distributed transactions + + + Runtime configuration + + + + + + + + diff --git a/reference/mysqlnd_ms/versions.xml b/reference/mysqlnd_ms/versions.xml index 11963f86e5..fec0a0f9dc 100755 --- a/reference/mysqlnd_ms/versions.xml +++ b/reference/mysqlnd_ms/versions.xml @@ -15,7 +15,8 @@ - + +