<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Send a FrontBase query</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fbsql-pconnect.html">fbsql_pconnect</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-read-blob.html">fbsql_read_blob</a></div>
<div class="up"><a href="ref.fbsql.html">FrontBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fbsql-query" class="refentry">
<div class="refnamediv">
<h1 class="refname">fbsql_query</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">fbsql_query</span> — <span class="dc-title">Send a FrontBase query</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fbsql-query-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>fbsql_query</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link_identifier</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$batch_size</code></span>
]] )</div>
<p class="para rdfs-comment">
Sends a <em><code class="parameter">query</code></em> to the currently active database on
the server.
</p>
<p class="para">
If the query succeeds, you can call <span class="function"><a href="function.fbsql-num-rows.html" class="function">fbsql_num_rows()</a></span> to
find out how many rows were returned for a SELECT statement or
<span class="function"><a href="function.fbsql-affected-rows.html" class="function">fbsql_affected_rows()</a></span> to find out how many rows were
affected by a DELETE, INSERT, REPLACE, or UPDATE statement.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fbsql-query-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">query</code></em></span>
<dd>
<p class="para">
The SQL query to be executed.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
The query string shall always end with a semicolon.
</p>
</p></blockquote>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">
link_identifier</code></em></span><dd>
<p class="para">A FrontBase link identifier
returned by <span class="function"><a href="function.fbsql-connect.html" class="function">fbsql_connect()</a></span> or
<span class="function"><a href="function.fbsql-pconnect.html" class="function">fbsql_pconnect()</a></span>.</p><p class="para">If optional and not specified,
the function will try to find an open link to the FrontBase server and if no
such link is found it will try to create one as if
<span class="function"><a href="function.fbsql-connect.html" class="function">fbsql_connect()</a></span> was called with no arguments.</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">batch_size</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fbsql-query-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>fbsql_query()</strong></span> returns <strong><code>TRUE</code></strong> (non-zero) or <strong><code>FALSE</code></strong>
to indicate whether or not the query succeeded. A return value
of <strong><code>TRUE</code></strong> means that the query was legal and could be executed by
the server. It does not indicate anything about the number of
rows affected or returned. It is perfectly possible for a query
to succeed but affect no rows or return no rows.
</p>
<p class="para">
For SELECT statements, <span class="function"><strong>fbsql_query()</strong></span> returns a new
result identifier that you can pass to <span class="function"><a href="function.fbsql-result.html" class="function">fbsql_result()</a></span>.
</p>
<p class="para">
<span class="function"><strong>fbsql_query()</strong></span> will also fail and return <strong><code>FALSE</code></strong> if you
don't have permission to access the table(s) referenced by the query.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.fbsql-query-examples">
<h3 class="title">Examples</h3>
<p class="para">
The following query is syntactically invalid, so
<span class="function"><strong>fbsql_query()</strong></span> fails and returns <strong><code>FALSE</code></strong>:
<div class="example" id="example-1133">
<p><strong>Example #1 <span class="function"><strong>fbsql_query()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$result </span><span style="color: #007700">= </span><span style="color: #0000BB">fbsql_query</span><span style="color: #007700">(</span><span style="color: #DD0000">"SELECT * WHERE 1=1"</span><span style="color: #007700">)<br /> or die (</span><span style="color: #DD0000">"Invalid query"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
The following query is semantically invalid if
<em>my_col</em> is not a column in the table
<em>my_tbl</em>, so <span class="function"><strong>fbsql_query()</strong></span>
fails and returns <strong><code>FALSE</code></strong>:
<div class="example" id="example-1134">
<p><strong>Example #2 <span class="function"><strong>fbsql_query()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$result </span><span style="color: #007700">= </span><span style="color: #0000BB">fbsql_query </span><span style="color: #007700">(</span><span style="color: #DD0000">"SELECT my_col FROM my_tbl;"</span><span style="color: #007700">)<br /> or die (</span><span style="color: #DD0000">"Invalid query"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.fbsql-query-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.fbsql-affected-rows.html" class="function" rel="rdfs-seeAlso">fbsql_affected_rows()</a> - Get number of affected rows in previous FrontBase operation</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-db-query.html" class="function" rel="rdfs-seeAlso">fbsql_db_query()</a> - Send a FrontBase query</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-free-result.html" class="function" rel="rdfs-seeAlso">fbsql_free_result()</a> - Free result memory</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-result.html" class="function" rel="rdfs-seeAlso">fbsql_result()</a> - Get result data</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-select-db.html" class="function" rel="rdfs-seeAlso">fbsql_select_db()</a> - Select a FrontBase database</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-connect.html" class="function" rel="rdfs-seeAlso">fbsql_connect()</a> - Open a connection to a FrontBase Server</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fbsql-pconnect.html">fbsql_pconnect</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-read-blob.html">fbsql_read_blob</a></div>
<div class="up"><a href="ref.fbsql.html">FrontBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
