mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Changed a nested table into a nested variablelist
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334103 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson
parent
1b7ddee55c
commit
d09fa07a33
1 changed files with 232 additions and 323 deletions
|
|
@ -2746,114 +2746,76 @@ $mysqli->set_charset("latin1");
|
|||
</para>
|
||||
</note>
|
||||
</para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<colspec colwidth="2*"/>
|
||||
<colspec colwidth="8*"/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Keyword</entry>
|
||||
<entry>Description</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>state_store</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<colspec colwidth="2*"/>
|
||||
<colspec colwidth="8*"/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Keyword</entry>
|
||||
<entry>Description</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>record_participant_credentials</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Whether to store the username and password of a global transaction
|
||||
participant in the participants table. If disabled, the garbage
|
||||
collection will use the default username and password when connecting
|
||||
to the participants. Unless you are using a different username and
|
||||
password for each of your MySQL servers, you can use the default
|
||||
and avoid storing the sensible information in state store.
|
||||
</para>
|
||||
<para>
|
||||
Please note, username and password are stored in clear text when using
|
||||
the MySQL state store, which is the only one available. It is in your
|
||||
responsibility to protect this sensible information.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>false</literal>
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>participant_localhost_ip</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
During XA garbage collection the plugin may find a participant server
|
||||
for which the host <literal>localhost</literal>
|
||||
has been recorded. If the garbage collection takes place on another host
|
||||
but the host that has written the participant record to the state store,
|
||||
the host name <literal>localhost</literal> now resolves to a different
|
||||
host. Therefore, when recording a participant servers host name
|
||||
in the state store, a value of <literal>localhost</literal> must
|
||||
be replaced with the actual IP address of <literal>localhost</literal>.
|
||||
</para>
|
||||
<para>
|
||||
Setting <literal>participant_localhost_ip</literal> should be considered
|
||||
only if using <literal>localhost</literal> cannot be avoided.
|
||||
From a garbage collection point of view only, it is preferrable not to
|
||||
configure any socket connection but to provide an IP address and port
|
||||
for a node.
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>mysql</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
|
||||
The MySQL state store is the only state store available.
|
||||
</para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<colspec colwidth="2*"/>
|
||||
<colspec colwidth="8*"/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Keyword</entry>
|
||||
<entry>Description</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>global_trx_table</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Name of the MySQL table used to store the state of an ongoing or aborted
|
||||
global transaction. Use the below SQL statement to create the table.
|
||||
Make sure to edit the table name to match your configuration.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>SQL definition for the MySQL state store transaction table</title>
|
||||
<programlisting role="sql">
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>state_store</term>
|
||||
<listitem>
|
||||
<variablelist xml:id="ini.mysqlnd-ms-plugin-config-v2.xa.state-store">
|
||||
<varlistentry>
|
||||
<term>record_participant_credentials</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Whether to store the username and password of a global transaction
|
||||
participant in the participants table. If disabled, the garbage
|
||||
collection will use the default username and password when connecting
|
||||
to the participants. Unless you are using a different username and
|
||||
password for each of your MySQL servers, you can use the default
|
||||
and avoid storing the sensible information in state store.
|
||||
</para>
|
||||
<para>
|
||||
Please note, username and password are stored in clear text when using
|
||||
the MySQL state store, which is the only one available. It is in your
|
||||
responsibility to protect this sensible information.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>false</literal>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>participant_localhost_ip</term>
|
||||
<listitem>
|
||||
<para>
|
||||
During XA garbage collection the plugin may find a participant server
|
||||
for which the host <literal>localhost</literal>
|
||||
has been recorded. If the garbage collection takes place on another host
|
||||
but the host that has written the participant record to the state store,
|
||||
the host name <literal>localhost</literal> now resolves to a different
|
||||
host. Therefore, when recording a participant servers host name
|
||||
in the state store, a value of <literal>localhost</literal> must
|
||||
be replaced with the actual IP address of <literal>localhost</literal>.
|
||||
</para>
|
||||
<para>
|
||||
Setting <literal>participant_localhost_ip</literal> should be considered
|
||||
only if using <literal>localhost</literal> cannot be avoided.
|
||||
From a garbage collection point of view only, it is preferrable not to
|
||||
configure any socket connection but to provide an IP address and port
|
||||
for a node.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>mysql</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The MySQL state store is the only state store available.
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>global_trx_table</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the MySQL table used to store the state of an ongoing or aborted
|
||||
global transaction. Use the below SQL statement to create the table.
|
||||
Make sure to edit the table name to match your configuration.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>mysqlnd_ms_xa_trx</literal>
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>SQL definition for the MySQL state store transaction table</title>
|
||||
<programlisting role="sql">
|
||||
<![CDATA[
|
||||
CREATE TABLE mysqlnd_ms_xa_trx (
|
||||
store_trx_id int(11) NOT NULL AUTO_INCREMENT,
|
||||
|
|
@ -2870,32 +2832,29 @@ CREATE TABLE mysqlnd_ms_xa_trx (
|
|||
KEY idx_state (state)
|
||||
) ENGINE=InnoDB
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>mysqlnd_ms_xa_trx</literal>
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>participant_table</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Name of the MySQL table used to store participants of an ongoing or aborted
|
||||
global transaction. Use the below SQL statement to create the table.
|
||||
Make sure to edit the table name to match your configuration.
|
||||
</para>
|
||||
<para>
|
||||
Storing credentials can be enabled and disabled using
|
||||
<literal>record_participant_credentials</literal>
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>SQL definition for the MySQL state store transaction table</title>
|
||||
<programlisting role="sql">
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>participant_table</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the MySQL table used to store participants of an ongoing or aborted
|
||||
global transaction. Use the below SQL statement to create the table.
|
||||
Make sure to edit the table name to match your configuration.
|
||||
</para>
|
||||
<para>
|
||||
Storing credentials can be enabled and disabled using
|
||||
<literal>record_participant_credentials</literal>
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>mysqlnd_ms_xa_participants</literal>
|
||||
</para>
|
||||
<example>
|
||||
<title>SQL definition for the MySQL state store transaction table</title>
|
||||
<programlisting role="sql">
|
||||
<![CDATA[
|
||||
CREATE TABLE mysqlnd_ms_xa_participants (
|
||||
fk_store_trx_id int(11) NOT NULL,
|
||||
|
|
@ -2922,28 +2881,24 @@ CREATE TABLE mysqlnd_ms_xa_participants (
|
|||
REFERENCES mysqlnd_ms_xa_trx (store_trx_id) ON DELETE CASCADE ON UPDATE CASCADE
|
||||
) ENGINE=InnoDB
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>mysqlnd_ms_xa_participants</literal>
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>garbage_collection_table</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Name of the MySQL table used to track and synchronize garbage collection runs.
|
||||
Use the below SQL statement to create the table.
|
||||
Make sure to edit the table name to match your configuration.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>SQL definition for the MySQL state store garbage collection table</title>
|
||||
<programlisting role="sql">
|
||||
</programlisting>
|
||||
</example>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>garbage_collection_table</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the MySQL table used to track and synchronize garbage collection runs.
|
||||
Use the below SQL statement to create the table.
|
||||
Make sure to edit the table name to match your configuration.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>mysqlnd_ms_xa_gc</literal>
|
||||
</para>
|
||||
<example>
|
||||
<title>SQL definition for the MySQL state store garbage collection table</title>
|
||||
<programlisting role="sql">
|
||||
<![CDATA[
|
||||
CREATE TABLE mysqlnd_ms_xa_gc (
|
||||
gc_id int(10) unsigned NOT NULL AUTO_INCREMENT,
|
||||
|
|
@ -2956,173 +2911,127 @@ CREATE TABLE mysqlnd_ms_xa_gc (
|
|||
KEY idx_store_trx (gtrid,format_id,fk_store_trx_id)
|
||||
) ENGINE=InnoDB
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>mysqlnd_ms_xa_gc</literal>
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>host</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Host name of the MySQL server.
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>user</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Name of the user used to connect to the MySQL server.
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>password</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Password for the MySQL server user.
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>db</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Database that holds the garbage collection tables.
|
||||
Please note, you have to create the garbage collection
|
||||
tables prior to using the plugin. The tables will not be
|
||||
created implicitly during runtime but garbage collection
|
||||
will fail if the tables to not exist.
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>port</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Port of the MySQL server.
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>socket</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Unix domain socket of the MySQL server. Please note,
|
||||
if you have multiple PHP servers each of them will
|
||||
try to carry out garbage collection and need to be able
|
||||
to connect to the state store. In this case, you may
|
||||
prefer configuring an IP address and a port for
|
||||
the MySQL state store server to ensure all PHP servers
|
||||
can reach it.
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>garbage_collection</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<informaltable>
|
||||
<tgroup cols="3">
|
||||
<colspec colwidth="1*"/>
|
||||
<colspec colwidth="7*"/>
|
||||
<colspec colwidth="2*"/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Keyword</entry>
|
||||
<entry>Description</entry>
|
||||
<entry>Version</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>max_retries</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Maximum number of garbage collection runs before giving up.
|
||||
Allowed values are from <literal>0</literal> to <literal>100</literal>.
|
||||
A setting of <literal>0</literal> means no limit, unless
|
||||
the state store enforces a limit. Should the state store enforce a limit,
|
||||
it can be supposed to be significantly higher than <literal>100</literal>.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>5</literal>
|
||||
</para>
|
||||
</entry>
|
||||
<entry>Since 1.6.0.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>probability</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Garbage collection probability. Setting the value has not effect.
|
||||
The feature is under development.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>5</literal>
|
||||
</para>
|
||||
</entry>
|
||||
<entry>Since 1.6.0.</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
<literal>rollback_on_close</literal>
|
||||
</entry>
|
||||
<entry>
|
||||
<para>
|
||||
Whether to automatically rollback an open global transaction is
|
||||
a connection is closed.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>true</literal>
|
||||
</para>
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
</section>
|
||||
</programlisting>
|
||||
</example>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>host</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Host name of the MySQL server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>user</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the user used to connect to the MySQL server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>password</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Password for the MySQL server user.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>db</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Database that holds the garbage collection tables.
|
||||
Please note, you have to create the garbage collection
|
||||
tables prior to using the plugin. The tables will not be
|
||||
created implicitly during runtime but garbage collection
|
||||
will fail if the tables to not exist.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>port</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Port of the MySQL server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>socket</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Unix domain socket of the MySQL server. Please note,
|
||||
if you have multiple PHP servers each of them will
|
||||
try to carry out garbage collection and need to be able
|
||||
to connect to the state store. In this case, you may
|
||||
prefer configuring an IP address and a port for
|
||||
the MySQL state store server to ensure all PHP servers
|
||||
can reach it.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>garbage_collection</term>
|
||||
<listitem>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>max_retries</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of garbage collection runs before giving up.
|
||||
Allowed values are from <literal>0</literal> to <literal>100</literal>.
|
||||
A setting of <literal>0</literal> means no limit, unless
|
||||
the state store enforces a limit. Should the state store enforce a limit,
|
||||
it can be supposed to be significantly higher than <literal>100</literal>.
|
||||
Available since 1.6.0.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>5</literal>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>probability</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Garbage collection probability. Setting the value has not effect.
|
||||
The feature is under development. Available since 1.6.0.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>5</literal>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>rollback_on_close</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Whether to automatically rollback an open global transaction is
|
||||
a connection is closed.
|
||||
</para>
|
||||
<para>
|
||||
Default: <literal>true</literal>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section xml:id="mysqlnd-ms.plugin-ini-v1">
|
||||
<title xmlns="http://docbook.org/ns/docbook">Plugin configuration file (<= 1.0.x)</title>
|
||||
|
|
|
|||
Loading…
Reference in a new issue