php-doc-en/reference/sqlite/functions/sqlite-unbuffered-query.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.sqlite-unbuffered-query" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>sqlite_unbuffered_query</refname>
  <refname>SQLiteDatabase->unbufferedQuery</refname>
  <refpurpose>Execute a query that does not prefetch and buffer all data</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>sqlite_unbuffered_query</methodname>
   <methodparam><type>resource</type><parameter>dbhandle</parameter></methodparam>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>result_type</parameter><initializer>SQLITE_BOTH</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">error_msg</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>resource</type><methodname>sqlite_unbuffered_query</methodname>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
   <methodparam><type>resource</type><parameter>dbhandle</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>result_type</parameter><initializer>SQLITE_BOTH</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">error_msg</parameter></methodparam>   
  </methodsynopsis>
  <para>Object oriented style (method):</para>
  <classsynopsis>
   <ooclass><classname>SQLiteDatabase</classname></ooclass>
   <methodsynopsis>
    <type>SQLiteUnbuffered</type><methodname>unbufferedQuery</methodname>
    <methodparam><type>string</type><parameter>query</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>result_type</parameter><initializer>SQLITE_BOTH</initializer></methodparam>
    <methodparam choice="opt"><type>string</type><parameter role="reference">error_msg</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   <function>sqlite_unbuffered_query</function> is identical to
   <function>sqlite_query</function> except that the result that is returned
   is a sequential forward-only result set that can only be used to read
   each row, one after the other.
  </para>
  <para>
   This function is ideal for generating things such as HTML tables where
   you only need to process one row at a time and don't need to randomly
   access the row data.
  </para>
  <note>
   <para>
    Functions such as <function>sqlite_seek</function>, 
    <function>sqlite_rewind</function>, <function>sqlite_next</function>,
    <function>sqlite_current</function>, and
    <function>sqlite_num_rows</function> do not work on result handles
    returned from <function>sqlite_unbuffered_query</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dbhandle</parameter></term>
     <listitem>
      <para>
       The SQLite Database resource; returned from
       <function>sqlite_open</function> when used procedurally. This parameter
       is not required when using the object-oriented method.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>query</parameter></term>
     <listitem>
      <para>
       The query to be executed.
      </para>
      <para>
       Data inside the query should be <link
       linkend="function.sqlite-escape-string">properly escaped</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result_type</parameter></term>
     <listitem>
      &sqlite.result-type;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_msg</parameter></term>
     <listitem>
      <para>
       The specified variable will be filled if an error occurs. This is
       specially important because SQL syntax errors can't be fetched using
       the <function>sqlite_last_error</function> function.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  &sqlite.param-compat;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a result handle&return.falseforfailure;.
  </para>
  <para>
   <function>sqlite_unbuffered_query</function> returns a sequential
   forward-only result set that can only be used to read each row, one after
   the other.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.1.0</entry>
       <entry>
        Added the <parameter>error_msg</parameter> parameter
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sqlite_query</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
 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
 -->