reference.xml

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

 <reference xml:id="ref.pdo-sqlite" xmlns="http://docbook.org/ns/docbook">
  <?phpdoc extension-membership="bundledexternal" ?>
  <title>SQLite PDO Driver (PDO_SQLITE)</title>
  <titleabbrev>SQLite PDO Driver</titleabbrev>
  <partintro>

   <section xml:id="ref.pdo-sqlite.intro">
   &reftitle.intro;
    <para>
     PDO_SQLITE is a driver that implements the <link linkend="intro.pdo">PHP
     Data Objects (PDO) interface</link> to enable access to SQLite 3 databases.
    </para>
    <note>
     <para>
      PDO_SQLITE allows using strings apart from streams together with
      <constant>PDO::PARAM_LOB</constant>.
     </para>
    </note>
   </section>

   &reference.pdo-sqlite.configure;

  </partintro>

  <refentry xml:id="ref.pdo-sqlite.connection">
   <refnamediv>
    <refname>PDO_SQLITE DSN</refname>
    <refpurpose>Connecting to SQLite databases</refpurpose>
   </refnamediv>

   <refsect1 role="description">
    &reftitle.description;
    <para>
     The PDO_SQLITE Data Source Name (DSN) is composed of the following elements:
     <variablelist>
      <varlistentry>
       <term>DSN prefix (SQLite 3)</term>
       <listitem>
        <para>
         The DSN prefix is <userinput>sqlite:</userinput>.
         <itemizedlist>
          <listitem>
           <para>
            To access a database on disk, the absolute path has to be appended to the
            DSN prefix.
           </para>
          </listitem>
          <listitem>
           <para>
            To create a database in memory, <literal>:memory:</literal> has to be appended
            to the DSN prefix.
           </para>
          </listitem>
          <listitem>
           <para>
            If the DSN consists of the DSN prefix only, a temporary database is used,
            which is deleted when the connection is closed.
           </para>
          </listitem>
         </itemizedlist>
        </para>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
   </refsect1>
   <refsect1 role="examples">
    &reftitle.examples;
    <para>
     <example>
      <title>PDO_SQLITE DSN examples</title>
      <para>
       The following examples show PDO_SQLITE DSN for connecting to
       SQLite databases:
       <programlisting>
<![CDATA[
sqlite:/opt/databases/mydb.sq3
sqlite::memory:
sqlite:
]]>
       </programlisting>
      </para>
     </example>
    </para>
   </refsect1>
  </refentry>

 &reference.pdo-sqlite.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
-->