archived-doc-en/reference/sqlite3/sqlite3.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.sqlite3" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The SQLite3 class</title>
 <titleabbrev>SQLite3</titleabbrev>

 <partintro>

<!-- {{{ SQLite3 intro -->
  <section xml:id="sqlite3.intro">
   &reftitle.intro;
   <para>
    A class that interfaces SQLite 3 databases.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="sqlite3.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>SQLite3</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.ok">SQLite3::OK</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.deny">SQLite3::DENY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.ignore">SQLite3::IGNORE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.create-index">SQLite3::CREATE_INDEX</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.create-table">SQLite3::CREATE_TABLE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.create-temp-index">SQLite3::CREATE_TEMP_INDEX</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.create-temp-table">SQLite3::CREATE_TEMP_TABLE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.create-temp-trigger">SQLite3::CREATE_TEMP_TRIGGER</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.create-temp-view">SQLite3::CREATE_TEMP_VIEW</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.create-trigger">SQLite3::CREATE_TRIGGER</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.create-view">SQLite3::CREATE_VIEW</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.delete">SQLite3::DELETE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.drop-index">SQLite3::DROP_INDEX</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.drop-table">SQLite3::DROP_TABLE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.drop-temp-index">SQLite3::DROP_TEMP_INDEX</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.drop-temp-table">SQLite3::DROP_TEMP_TABLE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.drop-temp-trigger">SQLite3::DROP_TEMP_TRIGGER</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.drop-temp-view">SQLite3::DROP_TEMP_VIEW</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.drop-trigger">SQLite3::DROP_TRIGGER</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.drop-view">SQLite3::DROP_VIEW</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.insert">SQLite3::INSERT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.pragma">SQLite3::PRAGMA</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.read">SQLite3::READ</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.select">SQLite3::SELECT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.transaction">SQLite3::TRANSACTION</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.update">SQLite3::UPDATE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.attach">SQLite3::ATTACH</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.detach">SQLite3::DETACH</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.alter-table">SQLite3::ALTER_TABLE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.reindex">SQLite3::REINDEX</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.analyze">SQLite3::ANALYZE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.create-vtable">SQLite3::CREATE_VTABLE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.drop-vtable">SQLite3::DROP_VTABLE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.function">SQLite3::FUNCTION</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.savepoint">SQLite3::SAVEPOINT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.copy">SQLite3::COPY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="sqlite3.constants.recursive">SQLite3::RECURSIVE</varname>
    </fieldsynopsis>

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

  </section>


  <section xml:id="sqlite3.class.constants">
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="sqlite3.constants.ok">
     <term><constant>SQLite3::OK</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.deny">
     <term><constant>SQLite3::DENY</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.ignore">
     <term><constant>SQLite3::IGNORE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.create-index">
     <term><constant>SQLite3::CREATE_INDEX</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.create-table">
     <term><constant>SQLite3::CREATE_TABLE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.create-temp-index">
     <term><constant>SQLite3::CREATE_TEMP_INDEX</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.create-temp-table">
     <term><constant>SQLite3::CREATE_TEMP_TABLE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.create-temp-trigger">
     <term><constant>SQLite3::CREATE_TEMP_TRIGGER</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.create-temp-view">
     <term><constant>SQLite3::CREATE_TEMP_VIEW</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.create-trigger">
     <term><constant>SQLite3::CREATE_TRIGGER</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.create-view">
     <term><constant>SQLite3::CREATE_VIEW</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.delete">
     <term><constant>SQLite3::DELETE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.drop-index">
     <term><constant>SQLite3::DROP_INDEX</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.drop-table">
     <term><constant>SQLite3::DROP_TABLE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.drop-temp-index">
     <term><constant>SQLite3::DROP_TEMP_INDEX</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.drop-temp-table">
     <term><constant>SQLite3::DROP_TEMP_TABLE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.drop-temp-trigger">
     <term><constant>SQLite3::DROP_TEMP_TRIGGER</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.drop-temp-view">
     <term><constant>SQLite3::DROP_TEMP_VIEW</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.drop-trigger">
     <term><constant>SQLite3::DROP_TRIGGER</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.drop-view">
     <term><constant>SQLite3::DROP_VIEW</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.insert">
     <term><constant>SQLite3::INSERT</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.pragma">
     <term><constant>SQLite3::PRAGMA</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.read">
     <term><constant>SQLite3::READ</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.select">
     <term><constant>SQLite3::SELECT</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.transaction">
     <term><constant>SQLite3::TRANSACTION</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.update">
     <term><constant>SQLite3::UPDATE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.attach">
     <term><constant>SQLite3::ATTACH</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.detach">
     <term><constant>SQLite3::DETACH</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.alter-table">
     <term><constant>SQLite3::ALTER_TABLE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.reindex">
     <term><constant>SQLite3::REINDEX</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.analyze">
     <term><constant>SQLite3::ANALYZE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.create-vtable">
     <term><constant>SQLite3::CREATE_VTABLE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.drop-vtable">
     <term><constant>SQLite3::DROP_VTABLE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.function">
     <term><constant>SQLite3::FUNCTION</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.savepoint">
     <term><constant>SQLite3::SAVEPOINT</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.copy">
     <term><constant>SQLite3::COPY</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="sqlite3.constants.recursive">
     <term><constant>SQLite3::RECURSIVE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>

 </partintro>

 &reference.sqlite3.entities.sqlite3;

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