mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 19:38:56 +00:00
a662aadca1
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334434 c90b9560-bf6c-de11-be94-00142212c4b1
106 lines
2.9 KiB
XML
106 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.mysqlnd-ms-xa-rollback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>mysqlnd_ms_xa_rollback</refname>
|
|
<refpurpose>Rolls back a distributed/XA transaction among MySQL servers</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type>
|
|
<methodname>mysqlnd_ms_xa_rollback</methodname>
|
|
<methodparam><type>mixed</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>gtrid</parameter></methodparam>
|
|
|
|
</methodsynopsis>
|
|
<para>
|
|
Rolls back a global transaction among MySQL servers started by
|
|
<function>mysqlnd_ms_xa_begin</function>.
|
|
</para>
|
|
<para>
|
|
If any of the global transaction participants fails to rollback
|
|
the situation is left to be solved by the garbage collection.
|
|
</para>
|
|
<note>
|
|
<title>Experimental</title>
|
|
<para>
|
|
The feature is currently under development. There may be issues and/or
|
|
feature limitations. Do not use in production environments.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A MySQL connection handle obtained from any of the
|
|
connect functions of the <link linkend="ref.mysqli">mysqli</link>,
|
|
<link linkend="ref.mysql">mysql</link> or
|
|
<link linkend="ref.pdo-mysql">PDO_MYSQL</link> extensions.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>gtrid</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Global transaction identifier (gtrid).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns &true; if the global transaction has been rolled back. Otherwise, returns &false;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member>
|
|
<link linkend="mysqlnd-ms.quickstart.xa_transactions">Quickstart XA/Distributed transactions</link>
|
|
</member>
|
|
<member>
|
|
<link linkend="mysqlnd-ms.configuration">Runtime configuration</link>
|
|
</member>
|
|
<member>
|
|
<link linkend="function.mysqlnd-ms-get-stats"><function>mysqlnd_ms_get_stats</function></link>
|
|
</member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|