php-doc-en/reference/sqlite/functions/sqlite-query.xml
Stanislav Malyshev 4c0b87584e document sqlite_query behaviour
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@158498 c90b9560-bf6c-de11-be94-00142212c4b1
2004-05-13 14:32:21 +00:00

99 lines
3.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.sqlite-query">
<refnamediv>
<refname>sqlite_query</refname>
<refpurpose>
Executes a query against a given database and returns a result handle.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>sqlite_query</methodname>
<methodparam><type>resource</type><parameter>dbhandle</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>sqlite_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>resource</type><parameter>dbhandle</parameter></methodparam>
</methodsynopsis>
<para>
Executes an SQL statement given by the <parameter>query</parameter> against
a given database handle (specified by the <parameter>dbhandle</parameter>
parameter).
</para>
<para>
For queries that return rows, this function will return a result handle
which can then be used with functions such as
<function>sqlite_fetch_array</function> and
<function>sqlite_seek</function>.
</para>
<para>
For other kinds of queries, this function will return a boolean result;
&true; for success or &false; for failure.
</para>
<para>
Regardless of the query type, this function will return &false; if the
query failed.
</para>
<para>
<function>sqlite_query</function> returns a buffered, seekable result
handle. This is useful for reasonably small queries where you need to
be able to randomly access the rows. Buffered result handles will
allocate memory to hold the entire result and will not return until it
has been fetched. If you only need sequential access to the data, it is
recommended that you use the much higher performance
<function>sqlite_unbuffered_query</function> instead.
</para>
<note>
<simpara>
Two alternative syntaxes are supported for compatibility with other
database extensions (such as MySQL).
The preferred form is the first one, where the
<parameter>db</parameter> parameter is the first parameter to the
function.
</simpara>
</note>
<warning>
<simpara>
SQLite <emphasis>will</emphasis> execute multiple queries separated by
semicolons, so you can use it to execute a batch of SQL that you have
loaded from a file or have embedded in a script. However, this works only
when the result of the function is not used - if it is used,
only the first SQL statement would be executed. Function
<function>sqlite_exec</function> will always execute multiple SQL
statements.
</simpara>
<simpara>
When executing multiple queries, the return value of this function
will be &false; if the was an error, but undefined otherwise (it might
be &true; for success or it might return a result handle).
</simpara>
</warning>
<para>
See also <function>sqlite_unbuffered_query</function> and
<function>sqlite_array_query</function>.
</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:"../../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
-->