cvs: phpdoc /en/functions mysql.xml

betz Fri Mar 29 18:26:31 2002 EDT Modified files: /phpdoc/en/functions mysql.xml Log: added ini-settings from config.xml to Runtime Config Index: phpdoc/en/functions/mysql.xml diff -u phpdoc/en/functions/mysql.xml:1.103 phpdoc/en/functions/mysql.xml:1.104 --- phpdoc/en/functions/mysql.xml:1.103 Fri Mar 29 10:26:33 2002 +++ phpdoc/en/functions/mysql.xml Fri Mar 29 18:26:31 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.103 $ --> +<!-- $Revision: 1.104 $ --> <reference id="ref.mysql"> <title>MySQL Functions</title> <titleabbrev>MySQL</titleabbrev> @@ -44,9 +44,9 @@ <title>Runtime Configuration</title> <para> The behaviour of the MySQL functions is affected by settings in the - global <link linkend="configuration">configuration</link> file. + global <link linkend="configuration.file">configuration file</link> &php.ini;. <table> - <title><link linkend="ini.sect.mysql">MySQL Configuration</link> Options</title> + <title>MySQL Configuration Options</title> <tgroup cols="3"> <thead> <row> @@ -96,12 +96,131 @@ <entry>NULL</entry> <entry>PHP_INI_ALL</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> + Wether 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> + + </variablelist> </para> </section>