added ini.xml, linked from reference

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@95583 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Friedhelm Betz 2002-09-12 10:35:56 +00:00
parent 1906d0f40b
commit 64b03cbe35
2 changed files with 230 additions and 211 deletions

228
reference/mysql/ini.xml Normal file
View file

@ -0,0 +1,228 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="mysql.configuration">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>MySQL Configuration Options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
</row>
</thead>
<tbody>
<row>
<entry>mysql.allow_persistent</entry>
<entry>"On"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
<row>
<entry>mysql.max_persistent</entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
<row>
<entry>mysql.max_links</entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
<row>
<entry>mysql.default_port</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.default_socket</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.default_host</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.default_user</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.default_password</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.connect_timeout</entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
</tbody>
</tgroup>
</table>
For further details and definition of the PHP_INI_* constants see
<function>ini_set</function>.
</para>
<para>
Here is a short explanation of the configuration directives.
<variablelist>
<varlistentry id="ini.mysql.allow-persistent">
<term>
<parameter>mysql.allow_persistent</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Whether to allow
<link linkend="features.persistent-connections">persistent connections</link>
to MySQL.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.max-persistent">
<term>
<parameter>mysql.max_persistent</parameter>
<type>integer</type>
</term>
<listitem>
<para>
The maximum number of persistent MySQL connections per
process.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.max-links">
<term>
<parameter>mysql.max_links</parameter>
<type>integer</type>
</term>
<listitem>
<para>
The maximum number of MySQL connections per process, including
persistent connections.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-port">
<term>
<parameter>mysql.default_port</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default TCP port number to use when connecting to
the database server if no other port is specified. If
no default is specified, the port will be obtained
from the <literal>MYSQL_TCP_PORT</literal> environment
variable, the <literal>mysql-tcp</literal> entry in
<filename>/etc/services</filename> or the compile-time
<literal>MYSQL_PORT</literal> constant, in that order. Win32
will only use the <literal>MYSQL_PORT</literal> constant.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-socket">
<term>
<parameter>mysql.default_socket</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default socket name to use when connecting to a local
database server if no other socket name is specified.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-host">
<term>
<parameter>mysql.default_host</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default server host to use when connecting to the database
server if no other host is specified. Doesn't apply in
<link linkend="ini.safe-mode">safe mode</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-user">
<term>
<parameter>mysql.default_user</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default user name to use when connecting to the database
server if no other name is specified. Doesn't apply in
<link linkend="ini.safe-mode">safe mode</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-password">
<term>
<parameter>mysql.default_password</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default password to use when connecting to the database
server if no other password is specified. Doesn't apply in
<link linkend="ini.safe-mode">safe mode</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.connect-timeout">
<term>
<parameter>mysql.connect_timeout</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Connect timeout in seconds. On Linux this timeout is also used for
waiting for the first answer from the server.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section id="mysql.resources">
&reftitle.resources;
<para>
There are two resource types used in the MySQL module. The first one
is the link identifier for a database connection, the second a resource
which holds the result of a query.
</para>
</section>
<!-- 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:"../../../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
-->

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- $Revision: 1.13 $ -->
<reference id="ref.mysql">
<title>MySQL Functions</title>
<titleabbrev>MySQL</titleabbrev>
@ -51,216 +51,7 @@
</warning>
</section>
<section id="mysql.configuration">
&reftitle.runtime;
<para>
The behaviour of the MySQL functions is affected by settings in the
global <link linkend="configuration.file">configuration file</link> &php.ini;.
<table>
<title>MySQL Configuration Options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
</row>
</thead>
<tbody>
<row>
<entry>mysql.allow_persistent</entry>
<entry>"On"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
<row>
<entry>mysql.max_persistent</entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
<row>
<entry>mysql.max_links</entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
<row>
<entry>mysql.default_port</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.default_socket</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.default_host</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.default_user</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.default_password</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>mysql.connect_timeout</entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
</tbody>
</tgroup>
</table>
For further details and definition of the PHP_INI_* constants see
<function>ini_set</function>.
</para>
<para>
Here is a short explanation of the configuration directives.
<variablelist>
<varlistentry id="ini.mysql.allow-persistent">
<term>
<parameter>mysql.allow_persistent</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Whether to allow
<link linkend="features.persistent-connections">persistent connections</link>
to MySQL.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.max-persistent">
<term>
<parameter>mysql.max_persistent</parameter>
<type>integer</type>
</term>
<listitem>
<para>
The maximum number of persistent MySQL connections per
process.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.max-links">
<term>
<parameter>mysql.max_links</parameter>
<type>integer</type>
</term>
<listitem>
<para>
The maximum number of MySQL connections per process, including
persistent connections.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-port">
<term>
<parameter>mysql.default_port</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default TCP port number to use when connecting to
the database server if no other port is specified. If
no default is specified, the port will be obtained
from the <literal>MYSQL_TCP_PORT</literal> environment
variable, the <literal>mysql-tcp</literal> entry in
<filename>/etc/services</filename> or the compile-time
<literal>MYSQL_PORT</literal> constant, in that order. Win32
will only use the <literal>MYSQL_PORT</literal> constant.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-socket">
<term>
<parameter>mysql.default_socket</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default socket name to use when connecting to a local
database server if no other socket name is specified.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-host">
<term>
<parameter>mysql.default_host</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default server host to use when connecting to the database
server if no other host is specified. Doesn't apply in
<link linkend="ini.safe-mode">safe mode</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-user">
<term>
<parameter>mysql.default_user</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default user name to use when connecting to the database
server if no other name is specified. Doesn't apply in
<link linkend="ini.safe-mode">safe mode</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.default-password">
<term>
<parameter>mysql.default_password</parameter>
<type>string</type>
</term>
<listitem>
<para>
The default password to use when connecting to the database
server if no other password is specified. Doesn't apply in
<link linkend="ini.safe-mode">safe mode</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.mysql.connect-timeout">
<term>
<parameter>mysql.connect_timeout</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Connect timeout in seconds. On Linux this timeout is also used for
waiting for the first answer from the server.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section id="mysql.resources">
&reftitle.resources;
<para>
There are two resource types used in the MySQL module. The first one
is the link identifier for a database connection, the second a resource
which holds the result of a query.
</para>
</section>
&reference.mysql.ini;
&reference.mysql.constants;