reference.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

 <reference xml:id="ref.pdo-pgsql" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <?phpdoc extension-membership="bundledexternal" ?>
  <title>PostgreSQL PDO Driver (PDO_PGSQL)</title>
  <titleabbrev>PostgreSQL PDO Driver</titleabbrev>
  <partintro>

   <section xml:id="ref.pdo-pgsql.intro">
   &reftitle.intro;
    <para>
     PDO_PGSQL is a driver that implements the <link linkend="intro.pdo">PHP
     Data Objects (PDO) interface</link>
     to enable access from PHP to PostgreSQL databases.
    </para>
   </section>

   <section xml:id="ref.pdo-pgsql.resources">
    &reftitle.resources;
    <para>
     This extension defines a stream resource returned by
     <function>PDO::pgsqlLOBOpen</function>.
    </para>
   </section>

   &reference.pdo-pgsql.configure;
   &reference.pdo-pgsql.constants;

   <section xml:id="ref.pdo-pgsql.general-notes">
    <title>General notes</title>
    <note>
     <para>
      <literal>bytea</literal> fields are returned as streams.
     </para>
    </note>
   </section>

  </partintro>

  <refentry xml:id="ref.pdo-pgsql.connection">
   <refnamediv>
    <refname>PDO_PGSQL DSN</refname>
    <refpurpose>Connecting to PostgreSQL databases</refpurpose>
   </refnamediv>

   <refsect1 role="description">
    &reftitle.description;
    <para>
     The PDO_PGSQL Data Source Name (DSN) is composed of the following elements, delimited by spaces or semicolons:
     <variablelist>
      <varlistentry>
       <term>DSN prefix</term>
       <listitem>
        <para>
        The DSN prefix is <userinput>pgsql:</userinput>.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>host</literal></term>
       <listitem>
        <para>
         The hostname on which the database server resides.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>port</literal></term>
       <listitem>
        <para>
         The port on which the database server is running.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>dbname</literal></term>
       <listitem>
        <para>
         The name of the database.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>user</literal></term>
       <listitem>
        <para>
         The name of the user for the connection. If you specify the user name
         in the DSN, PDO ignores the value of the user name argument in the
         PDO constructor.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>password</literal></term>
       <listitem>
        <para>
         The password of the user for the connection. If you specify the
         password in the DSN, PDO ignores the value of the password argument
         in the PDO constructor.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>sslmode</literal></term>
       <listitem>
        <para>
         The SSL mode. Supported values and their meaning are listed in the
         <link xlink:href="&url.pgsql.manual;">PostgreSQL Documentation</link>.
        </para>
       </listitem>
      </varlistentry>

     </variablelist>
     <note>
      <simpara>
       All semicolons in the DSN string are replaced by spaces, because PostgreSQL
       expects this format. This implies that semicolons in any of the components
       (e.g. <literal>password</literal> or <literal>dbname</literal>) are not
       supported.
      </simpara>
     </note>
    </para>
   </refsect1>
   <refsect1 role="examples">
    &reftitle.examples;
    <para>
     <example>
      <title>PDO_PGSQL DSN examples</title>
      <para>
       The following example shows a PDO_PGSQL DSN for connecting to
       a PostgreSQL database:
       <programlisting>
<![CDATA[
pgsql:host=localhost;port=5432;dbname=testdb;user=bruce;password=mypass
]]>
       </programlisting>
      </para>
      <para>
       The following example shows a PDO_PGSQL DSN for connecting to
       a PostgreSQL database via unix socket <filename>/tmp/.s.PGSQL.5432</filename>:
       <programlisting>
<![CDATA[
pgsql:host=/tmp;port=5432;dbname=testdb;user=bruce;password=mypass
]]>
       </programlisting>
      </para>
     </example>
    </para>
   </refsect1>
  </refentry>

  &reference.pdo-pgsql.entities.pdo-overloaded;

 </reference>

<!-- 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
-->