mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
f8bd23e2bb
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@146741 c90b9560-bf6c-de11-be94-00142212c4b1
112 lines
3.9 KiB
XML
112 lines
3.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<!-- splitted from ./en/functions/mysql.xml, last change in rev 1.2 -->
|
|
<refentry id="function.mysql-pconnect">
|
|
<refnamediv>
|
|
<refname>mysql_pconnect</refname>
|
|
<refpurpose>
|
|
Open a persistent connection to a MySQL server
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>mysql_pconnect</methodname>
|
|
<methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>client_flags</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns a positive MySQL persistent link identifier on success,
|
|
or &false; on error.
|
|
</para>
|
|
<para>
|
|
<function>mysql_pconnect</function> establishes a connection
|
|
to a MySQL server. The following defaults are assumed for
|
|
missing optional parameters: <parameter>server</parameter> =
|
|
'localhost:3306', <parameter>username</parameter> = name of the
|
|
user that owns the server process and
|
|
<parameter>password</parameter> = empty password.
|
|
The <parameter>client_flags</parameter>
|
|
parameter can be a combination of the constants
|
|
MYSQL_CLIENT_COMPRESS, MYSQL_CLIENT_IGNORE_SPACE or
|
|
MYSQL_CLIENT_INTERACTIVE.
|
|
</para>
|
|
<para>
|
|
The <parameter>server</parameter> parameter can also include a port
|
|
number. e.g. "hostname:port" or a path to a socket
|
|
e.g. ":/path/to/socket" for the localhost.
|
|
<note>
|
|
<para>
|
|
Support for ":port" was added in 3.0B4.
|
|
</para>
|
|
<para>
|
|
Support for the ":/path/to/socket" was added in
|
|
3.0.10.
|
|
</para>
|
|
</note>
|
|
</para>
|
|
|
|
<!-- TODO move the story to features.persistent, and refer to that -->
|
|
<para>
|
|
<function>mysql_pconnect</function> acts very much like
|
|
<function>mysql_connect</function> with two major differences.
|
|
</para>
|
|
<para>
|
|
First, when connecting, the function would first try to find a
|
|
(persistent) link that's already open with the same host,
|
|
username and password. If one is found, an identifier for it
|
|
will be returned instead of opening a new connection.
|
|
</para>
|
|
<para>
|
|
Second, the connection to the SQL server will not be closed when
|
|
the execution of the script ends. Instead, the link will remain
|
|
open for future use (<function>mysql_close</function> will not
|
|
close links established by <function>mysql_pconnect</function>).
|
|
</para>
|
|
<para>
|
|
The optional <parameter>client_flags</parameter> parameter became
|
|
available in PHP 4.3.0.
|
|
</para>
|
|
<para>
|
|
This type of link is therefore called 'persistent'.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Note, that these kind of links only work if you are using
|
|
a module version of PHP. See the
|
|
<link linkend="features.persistent-connections">Persistent
|
|
Database Connections</link> section for more information.
|
|
</para>
|
|
</note>
|
|
<warning>
|
|
<para>
|
|
Using persistent connections can require a bit of tuning of your Apache
|
|
and MySQL configurations to ensure that you do not exceed the number of
|
|
connections allowed by MySQL.
|
|
</para>
|
|
</warning>
|
|
</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:"../../../../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
|
|
-->
|