mysql-pconnect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5fabd07880ab15b0ad2cf7eb055c7c2b36d7120f Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.mysql-pconnect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_pconnect</refname>
  <refpurpose>Ouvre une connexion persistante à un serveur MySQL</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_connect</function> avec le préfixe d'hôte <literal>p:</literal></member>
    <member><methodname>PDO::__construct</methodname> avec <constant>PDO::ATTR_PERSISTENT</constant> comme option du driver</member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>mysql_pconnect</methodname>
   <methodparam choice="opt"><type>string</type><parameter>server</parameter><initializer>ini_get("mysql.default_host")</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>username</parameter><initializer>ini_get("mysql.default_user")</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>password</parameter><initializer>ini_get("mysql.default_password")</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>client_flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <!-- Undocumented confusing syntax:
  <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>bool</type><parameter>new_link</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>client_flags</parameter></methodparam>
  </methodsynopsis>
  -->
  <para>
   Ouvre une connexion persistante à un serveur MySQL.
  </para>
  <!-- TODO: Integrate this information more nicely with features.persistent -->
  <para>
   <function>mysql_pconnect</function> se comporte exactement comme
   <function>mysql_connect</function>, mais avec deux différences majeures :
  </para>
  <para>
   Premièrement, lors de la connexion, la fonction essaie de trouver une
   connexion permanente déjà ouverte sur cet hôte, avec le
   même nom d'utilisateur et de mot de passe. Si une telle connexion
   est trouvée, son identifiant est retourné, sans ouvrir de
   nouvelle connexion.
  </para>
  <para>
   Deuxièmement, la connexion au serveur MySQL ne sera pas terminée avec la fin
   du script. Au lieu de cela, le lien sera conservé pour un prochain accès
   (<function>mysql_close</function> ne terminera pas une connexion persistante
   établie par <function>mysql_pconnect</function>).
  </para>
  <para>
   C'est pourquoi ce type de connexion est dite persistante.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>server</parameter></term>
     <listitem>
      <para>
       Le serveur MySQL. Il peut également comprendre un numéro de port, e.g.
       <literal>"hostname:port"</literal> ou un chemin vers un socket local e.g. <literal>":/path/to/socket"</literal>.
      </para>
      <para>
       Si la directive PHP <link linkend="ini.mysql.default-host">
       mysql.default_host</link> n'est pas définie (défaut), alors,
      la valeur par défaut est <literal>"localhost:3306"</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>username</parameter></term>
     <listitem>
      <para>
       Le nom de l'utilisateur. La valeur par défaut est l'utilisateur
       faisant fonctionner le processus serveur courant.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       Le mot de passe. La valeur par défaut est un mot de passe vide.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>client_flags</parameter></term>
     <listitem>
      <para>
       Le paramètre <parameter>client_flags</parameter> peut être une
       compilation des constantes suivantes :
       128 (active le gestionnaire <literal>LOAD DATA LOCAL</literal>),
       <constant>MYSQL_CLIENT_SSL</constant>,
       <constant>MYSQL_CLIENT_COMPRESS</constant>,
       <constant>MYSQL_CLIENT_IGNORE_SPACE</constant> ou
       <constant>MYSQL_CLIENT_INTERACTIVE</constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un identifiant de lien persistant MySQL en cas de succès, ou &false;
   si une erreur survient.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Notez que les connexions persistantes ne fonctionnent que si vous utilisez
    PHP en version module. Lisez la section sur les
    <link linkend="features.persistent-connections">connexions persistantes
    aux bases de données</link> pour plus d'informations.
   </para>
  </note>
  <warning>
   <para>
    L'utilisation des connexions persistantes requiert des paramétrages 
    d'Apache et de MySQL pour vous assurer que vous n'atteindrez pas
    la limite maximale de nombre de connexions simultanées autorisée
    par MySQL.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysql_connect</function></member>
    <member><link linkend="features.persistent-connections">Les connexions 
    persistantes aux bases de données</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
-->