mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
ab8f44f73b
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@180267 c90b9560-bf6c-de11-be94-00142212c4b1
135 lines
4.4 KiB
XML
135 lines
4.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.13 $ -->
|
|
<refentry id="function.sqlite-query">
|
|
<refnamediv>
|
|
<refname>sqlite_query</refname>
|
|
<refname>SQLiteDatabase->query</refname>
|
|
<refpurpose>Executes a query against a given database and returns a result handle</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>Object oriented style (method):</para>
|
|
<classsynopsis>
|
|
<ooclass><classname>SQLiteDatabase</classname></ooclass>
|
|
<methodsynopsis>
|
|
<type>SQLiteResult</type><methodname>query</methodname>
|
|
<methodparam><type>string</type><parameter>query</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</classsynopsis>
|
|
<para>
|
|
Executes an SQL statement given by the <parameter>query</parameter> against
|
|
a given database handle.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>query</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The query to be executed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<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>
|
|
</variablelist>
|
|
</para>
|
|
&sqlite.param-compat;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
This function will return a result handle or &false; on failure.
|
|
For queries that return rows, the result handle can then be used with
|
|
functions such as <function>sqlite_fetch_array</function> and
|
|
<function>sqlite_seek</function>.
|
|
</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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<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 there was an error, but undefined otherwise (it might
|
|
be &true; for success or it might return a result handle).
|
|
</simpara>
|
|
</warning>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>sqlite_unbuffered_query</function></member>
|
|
<member><function>sqlite_array_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:"../../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
|
|
-->
|