pg-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_connect</refname>
  <refpurpose>
   Établit une connexion PostgreSQL
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>PgSql\Connection</type><type>false</type></type><methodname>pg_connect</methodname>
   <methodparam><type>string</type><parameter>connection_string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_connect</function> ouvre une connexion à une base de données
   PostgreSQL grâce à la chaîne de connexion
   <parameter>connection_string</parameter>.
  </para>
  <para>
   Si un deuxième appel à <function>pg_connect</function> est
   fait avec les mêmes arguments, aucune nouvelle connexion ne sera
   établie à moins qu'on ne passe <constant>PGSQL_CONNECT_FORCE_NEW</constant>
   à <parameter>flags</parameter>, mais la connexion précédente sera
   retournée.
  </para>
  <para>
   L'ancienne syntaxe 
   <command>$conn = pg_connect("host", "port", "options", "tty", "dbname")</command> 
   est obsolète.
  </para>
 </refsect1>

<refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection_string</parameter></term>
     <listitem>
      <para>
       La chaîne <parameter>connection_string</parameter> peut être vide pour
       utiliser tous les paramètres par défaut ou elle peut contenir un ou
       plusieurs paramètres de configuration séparés par des espaces.
       Chaque paramètre de configuration est sous la forme <literal>code =
       valeur</literal>. Les espaces autour du signe égal sont optionnels.
       Pour écrire une valeur vide ou une valeur contenant des espaces,
       entourez cette valeur avec des apostrophes, par exemple : <literal>code =
       'une valeur'</literal>. Les apostrophes et les antislashs à l'intérieur
       de la valeur doivent être échappés par un antislash, c'est-à-dire
       \' et \\.
      </para>
      <para>
       Les mots-clé actuellement reconnus sont :
       <parameter>host</parameter>, <parameter>hostaddr</parameter>,
       <parameter>port</parameter>,
       <parameter>dbname</parameter> (valeur par défaut: <parameter>user</parameter>),
       <parameter>user</parameter>,
       <parameter>password</parameter>,
       <parameter>connect_timeout</parameter>,
       <parameter>options</parameter>, <parameter>tty</parameter> (ignoré),
       <parameter>sslmode</parameter>,
       <parameter>requiressl</parameter> (obsolète, utiliser
       <parameter>sslmode</parameter>) et
       <parameter>service</parameter>. La liste de ces arguments dépend de
       la version du serveur PostgreSQL.
      </para>
      <para>
       Le paramètre <parameter>options</parameter> peut être utilisé pour passer des paramètres
       pour la ligne de commande invoquant le serveur.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Si <constant>PGSQL_CONNECT_FORCE_NEW</constant> est passé en argument,
       alors une nouvelle connexion sera créée, même si la chaîne
       <parameter>connection_string</parameter> est identique à celle de la
       connexion existante.
      </para>
      <para>
       Si <constant>PGSQL_CONNECT_ASYNC</constant> est fourni, la connexion
       sera établie de façon asynchrone. Le statut de la connexion peut être
       vérifié via la fonction <function>pg_connect_poll</function> ou via la
       fonction <function>pg_connection_status</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une instance de <classname>PgSql\Connection</classname> en cas de succès, &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       Retourne désormais une instance de <classname>PgSql\Connection</classname> ;
       auparavant, une &resource; était retournée.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>pg_connect</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_connect("dbname=marie");
// connexion à une base de données nommée "marie"

$dbconn2 = pg_connect("host=localhost port=5432 dbname=marie");
// connexion à une base de données nommée "marie" sur l'hôte "localhost" sur le port "5432"

$dbconn3 = pg_connect("host=mouton port=5432 dbname=marie user=agneau password=foo");
// connexion à une base de données nommée "marie" sur l'hôte "mouton" avec un
// nom d'utilisateur et un mot de passe

$conn_string = "host=mouton port=5432 dbname=test user=agneau password=bar";
$dbconn4 = pg_connect($conn_string);
// connexion à une base de données nommée "test" sur l'hôte "mouton" avec un
// nom d'utilisateur et un mot de passe

$dbconn5 = pg_connect("host=localhost options='--client_encoding=UTF8'");
//connexion à la base sur "localhost" et passage d'un paramètre de la ligne de
// commande concernant l'encodage UTF-8
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_pconnect</function></member>
    <member><function>pg_close</function></member>
    <member><function>pg_host</function></member>
    <member><function>pg_port</function></member>
    <member><function>pg_tty</function></member>
    <member><function>pg_options</function></member>
    <member><function>pg_dbname</function></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
-->