Source of: /manual/en/function.sqlite-query.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sqlite.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.sqlite-query.php',
1 => 'sqlite_query',
),
'up' =>
array (
0 => 'ref.sqlite.php',
1 => 'SQLite Functions',
),
'prev' =>
array (
0 => 'function.sqlite-prev.php',
1 => 'sqlite_prev',
),
'next' =>
array (
0 => 'function.sqlite-rewind.php',
1 => 'sqlite_rewind',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.sqlite-query" class="refentry">
<div class="refnamediv">
<h1 class="refname">sqlite_query</h1>
<h1 class="refname">SQLiteDatabase->query</h1>
<p class="verinfo">(PHP 5, PECL sqlite >= 1.0.0)</p><p class="refpurpose"><span class="refname">sqlite_query</span> -- <span class="refname">SQLiteDatabase->query</span> — <span class="dc-title">Executes a query against a given database and returns a result handle</span></p>
</div>
<a name="function.sqlite-query.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>sqlite_query</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$dbhandle</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$query</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$result_type</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter reference">&$error_msg</tt></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>sqlite_query</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$query</tt></span>
, <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$dbhandle</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$result_type</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter reference">&$error_msg</tt></span>
]] )</div>
<p class="para rdfs-comment">Object oriented style (method):</p>
<div class="classsynopsis">
<div class="ooclass"><b class="classname">SQLiteDatabase</b></div>
<div class="methodsynopsis dc-description">
<span class="type">SQLiteResult</span> <span class="methodname"><b>query</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$query</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$result_type</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter reference">&$error_msg</tt></span>
]] )</div>
</div>
<p class="para">
Executes an SQL statement given by the <i><tt class="parameter">query</tt></i>
against
a given database handle.
</p>
</div>
<a name="function.sqlite-query.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">dbhandle</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The SQLite Database resource; returned from
<a href="function.sqlite-open.php" class="function">sqlite_open()</a> when used procedurally. This parameter
is not required when using the object-oriented method.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">query</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The query to be executed.
</p>
<p class="para">
Data inside the query should be <a href="function.sqlite-escape-string.php" class="link">properly escaped</a>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">result_type</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The optional <i><tt class="parameter">result_type</tt></i>
parameter accepts a constant and determines how the returned array will be
indexed. Using <b><tt class="constant">SQLITE_ASSOC</tt></b> will return only associative
indices (named fields) while <b><tt class="constant">SQLITE_NUM</tt></b> will return
only numerical indices (ordinal field numbers). <b><tt class="constant">SQLITE_BOTH</tt></b>
will return both associative and numerical indices.
<b><tt class="constant">SQLITE_BOTH</tt></b> is the default for this function.</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">error_msg</tt></i>
</span>
</dt><dd class="listitem">
<p class="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 <a href="function.sqlite-last-error.php" class="function">sqlite_last_error()</a> function.
</p>
</dd>
</dl>
<p>
</p>
<blockquote><p><b class="note">Note</b>: <span class="simpara">Two alternative syntaxes are
supported for compatibility with other database extensions (such as MySQL).
The preferred form is the first, where the <i><tt class="parameter">dbhandle</tt></i>
parameter is the first parameter to the function.</span></p></blockquote>
</div>
<a name="function.sqlite-query.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This function will return a result handle or <b><tt class="constant">FALSE</tt></b> on failure.
For queries that return rows, the result handle can then be used with
functions such as <a href="function.sqlite-fetch-array.php" class="function">sqlite_fetch_array()</a> and
<a href="function.sqlite-seek.php" class="function">sqlite_seek()</a>.
</p>
<p class="para">
Regardless of the query type, this function will return <b><tt class="constant">FALSE</tt></b> if the
query failed.
</p>
<p class="para">
<b>sqlite_query()</b> 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
<a href="function.sqlite-unbuffered-query.php" class="function">sqlite_unbuffered_query()</a> instead.
</p>
</div>
<a name="function.sqlite-query.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">5.1.0</td>
<td align="left">
Added the <i><tt class="parameter">error_msg</tt></i>
parameter
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.sqlite-query.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<div class="warning"><b class="warning">Warning</b>
<p class="simpara">
SQLite <em class="emphasis">will</em> 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
<a href="function.sqlite-exec.php" class="function">sqlite_exec()</a> will always execute multiple SQL
statements.
</p>
<p class="simpara">
When executing multiple queries, the return value of this function
will be <b><tt class="constant">FALSE</tt></b> if there was an error, but undefined otherwise (it might
be <b><tt class="constant">TRUE</tt></b> for success or it might return a result handle).
</p>
</div>
</div>
<a name="function.sqlite-query.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.sqlite-unbuffered-query.php" class="function" rel="rdfs-seeAlso">sqlite_unbuffered_query()</a> - Execute a query that does not prefetch and buffer all data</li>
<li class="member"><a href="function.sqlite-array-query.php" class="function" rel="rdfs-seeAlso">sqlite_array_query()</a> - Execute a query against a given database and returns an array</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
