archived-doc-en/reference/pdo_pgsql/pdo-pgsql.xml

<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.pdo-pgsql" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The Pdo\Pgsql class</title>
 <titleabbrev>Pdo\Pgsql</titleabbrev>

 <partintro>

  <!-- {{{ ClassName intro -->
  <section xml:id="pdo-pgsql.intro">
   &reftitle.intro;
   <simpara>
    A <classname>PDO</classname> subclass representing a connection using
    the PostgreSQL PDO driver.
   </simpara>
   <para>
    This driver supports a dedicated SQL query parser for the PostgreSQL dialect.
    It can handle the following:
    <itemizedlist>
     <listitem>
      <simpara>
       Single and double-quoted literals, with doubling as escaping mechanism
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C-style “escape” string literals
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       Dollar-quoted string literals
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       Two-dashes and C-style comments (non-nested).
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       Support for <literal>??</literal> as escape sequence for the
       <literal>?</literal> operator.
      </simpara>
     </listitem>
    </itemizedlist>
   </para>
  </section>
  <!-- }}} -->

  <section xml:id="pdo-pgsql.synopsis">
   &reftitle.classsynopsis;

   <!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>Pdo\Pgsql</classname>
    </ooclass>

    <ooclass>
     <modifier>extends</modifier>
     <classname>PDO</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
     <xi:fallback/>
    </xi:include>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-pgsql.constants.attr-disable-prepares">Pdo\Pgsql::ATTR_DISABLE_PREPARES</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-pgsql.constants.attr-result-memory-size">Pdo\Pgsql::ATTR_RESULT_MEMORY_SIZE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-pgsql.constants.transaction-idle">Pdo\Pgsql::TRANSACTION_IDLE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-pgsql.constants.transaction-active">Pdo\Pgsql::TRANSACTION_ACTIVE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-pgsql.constants.transaction-intrans">Pdo\Pgsql::TRANSACTION_INTRANS</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-pgsql.constants.transaction-inerror">Pdo\Pgsql::TRANSACTION_INERROR</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="pdo-pgsql.constants.transaction-unknown">Pdo\Pgsql::TRANSACTION_UNKNOWN</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo-pgsql')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Pdo\\Pgsql'])">
     <xi:fallback/>
    </xi:include>

    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='PDO'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='PDO'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
   <!-- }}} -->

  </section>

  <section xml:id="pdo-pgsql.constants">
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="pdo-pgsql.constants.attr-disable-prepares">
     <term><constant>Pdo\Pgsql::ATTR_DISABLE_PREPARES</constant></term>
     <listitem>
      <simpara>
       Send the query and the parameters to the server together in a single
       call, avoiding the need to create a named prepared statement separately.
       If the query is only going to be executed once this can reduce latency by
       avoiding an unnecessary server round-trip.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-pgsql.constants.attr-result-memory-size">
     <term><constant>Pdo\Pgsql::ATTR_RESULT_MEMORY_SIZE</constant></term>
     <listitem>
      <simpara>
       Returns the amount of memory, in bytes, allocated to the specified
       query result <classname>PDOStatement</classname> instance,
       or &null; if no results exist before the query is executed.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-pgsql.constants.transaction-idle">
     <term><constant>Pdo\Pgsql::TRANSACTION_IDLE</constant></term>
     <listitem>
      <simpara>
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-pgsql.constants.transaction-active">
     <term><constant>Pdo\Pgsql::TRANSACTION_ACTIVE</constant></term>
     <listitem>
      <simpara>
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-pgsql.constants.transaction-intrans">
     <term><constant>Pdo\Pgsql::TRANSACTION_INTRANS</constant></term>
     <listitem>
      <simpara>
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-pgsql.constants.transaction-inerror">
     <term><constant>Pdo\Pgsql::TRANSACTION_INERROR</constant></term>
     <listitem>
      <simpara>
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pdo-pgsql.constants.transaction-unknown">
     <term><constant>Pdo\Pgsql::TRANSACTION_UNKNOWN</constant></term>
     <listitem>
      <simpara>
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
 </partintro>

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

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