<!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 CUBRID query</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.cubrid-ping.html">cubrid_ping</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.cubrid-real-escape-string.html">cubrid_real_escape_string</a></div>
<div class="up"><a href="cubridmysql.cubrid.html">CUBRID MySQL Compatibility Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.cubrid-query" class="refentry">
<div class="refnamediv">
<h1 class="refname">cubrid_query</h1>
<p class="verinfo">(PECL CUBRID >= 8.3.1)</p><p class="refpurpose"><span class="refname">cubrid_query</span> — <span class="dc-title">Send a CUBRID query</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.cubrid-query-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>cubrid_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">$conn_identifier</code></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>cubrid_query()</strong></span> sends a unique query (multiple queries are not supported) to the
currently active database on the server that's associated with the specified <em><code class="parameter">conn_identifier</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.cubrid-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">
An SQL query
</p>
<p class="para">
Data inside the query should be <a href="function.cubrid-real-escape-string.html" class="link">properly escaped</a>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">conn_identifier</code></em></span>
<dd>
<p class="para">
The CUBRID connection. If the connection identifier is not specified,
the last connection opened by <span class="function"><a href="function.cubrid-connect.html" class="function">cubrid_connect()</a></span> is
assumed.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.cubrid-query-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset,
<span class="function"><strong>cubrid_query()</strong></span> returns a <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span> on success, or <strong><code>FALSE</code></strong> on error.
</p>
<p class="para">
For other type of SQL statements, INSERT, UPDATE, DELETE, DROP, etc,
<span class="function"><strong>cubrid_query()</strong></span> returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on error.
</p>
<p class="para">
The returned result resource should be passed to <span class="function"><a href="function.cubrid-fetch-array.html" class="function">cubrid_fetch_array()</a></span>, and other
functions for dealing with result tables, to access the returned data.
</p>
<p class="para">
Use <span class="function"><a href="function.cubrid-num-rows.html" class="function">cubrid_num_rows()</a></span> to find out how many rows were returned for a SELECT statement or
<span class="function"><a href="function.cubrid-affected-rows.html" class="function">cubrid_affected_rows()</a></span> to find out how many rows were affected by a DELETE, INSERT, REPLACE, or UPDATE statement.
</p>
<p class="para">
<span class="function"><strong>cubrid_query()</strong></span> will also fail and return <strong><code>FALSE</code></strong>
if the user does not have permission to access the table(s) referenced by the query.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.cubrid-query-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1085">
<p><strong>Example #1 Invalid Query</strong></p>
<div class="example-contents"><p>
The following query is syntactically invalid, so <span class="function"><strong>cubrid_query()</strong></span> fails and returns <strong><code>FALSE</code></strong>.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #0000BB">33000</span><span style="color: #007700">, </span><span style="color: #DD0000">'demodb'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_query</span><span style="color: #007700">(</span><span style="color: #DD0000">'SELECT * WHERE 1=1'</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">'Invalid query: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">cubrid_error</span><span style="color: #007700">());<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-1086">
<p><strong>Example #2 Valid Query</strong></p>
<div class="example-contents"><p>
The following query is valid, so <span class="function"><strong>cubrid_query()</strong></span> returns a <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span>.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// This could be supplied by a user, for example<br /></span><span style="color: #0000BB">$firstname </span><span style="color: #007700">= </span><span style="color: #DD0000">'fred'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$lastname </span><span style="color: #007700">= </span><span style="color: #DD0000">'fox'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #0000BB">33000</span><span style="color: #007700">, </span><span style="color: #DD0000">'demodb'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">cubrid_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">,</span><span style="color: #DD0000">"DROP TABLE if exists friends"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">cubrid_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">,</span><span style="color: #DD0000">"create table friends(firstname varchar,lastname varchar,address char(24),age int)"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">cubrid_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">,</span><span style="color: #DD0000">"insert into friends values('fred','fox','home-1','20')"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">cubrid_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">,</span><span style="color: #DD0000">"insert into friends values('blue','cat','home-2','21')"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// Formulate Query<br />// This is the best way to perform an SQL query<br />// For more examples, see cubrid_real_escape_string()<br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #0000BB">sprintf</span><span style="color: #007700">(</span><span style="color: #DD0000">"SELECT firstname, lastname, address, age FROM friends WHERE firstname='%s' AND lastname='%s'"</span><span style="color: #007700">,<br /></span><span style="color: #0000BB">cubrid_real_escape_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$firstname</span><span style="color: #007700">),<br /></span><span style="color: #0000BB">cubrid_real_escape_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$lastname</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// Perform Query<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Check result<br />// This shows the actual query sent to CUBRID, and the error. Useful for debugging.<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$message </span><span style="color: #007700">= </span><span style="color: #DD0000">'Invalid query: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">cubrid_error</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$message </span><span style="color: #007700">.= </span><span style="color: #DD0000">'Whole query: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$query</span><span style="color: #007700">;<br /> die(</span><span style="color: #0000BB">$message</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">// Use result<br />// Attempting to print $result won't allow access to information in the resource<br />// One of the cubrid result functions must be used<br />// See also cubrid_result(), cubrid_fetch_array(), cubrid_fetch_row(), etc.<br /></span><span style="color: #007700">while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_fetch_assoc</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'firstname'</span><span style="color: #007700">];<br /> echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'lastname'</span><span style="color: #007700">];<br /> echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'address'</span><span style="color: #007700">];<br /> echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'age'</span><span style="color: #007700">];<br />}<br /><br /></span><span style="color: #FF8000">// Free the resources associated with the result set<br />// This is done automatically at the end of the script<br /></span><span style="color: #0000BB">cubrid_free_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</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.cubrid-query-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.cubrid-connect.html" class="function" rel="rdfs-seeAlso">cubrid_connect()</a> - Open a connection to a CUBRID Server</span></li>
<li class="member"> <span class="function"><a href="function.cubrid-error.html" class="function" rel="rdfs-seeAlso">cubrid_error()</a> - Get the error message</span></li>
<li class="member"> <span class="function"><a href="function.cubrid-real-escape-string.html" class="function" rel="rdfs-seeAlso">cubrid_real_escape_string()</a> - Escape special characters in a string for use in an SQL statement</span></li>
<li class="member"> <span class="function"><a href="function.cubrid-result.html" class="function" rel="rdfs-seeAlso">cubrid_result()</a> - Return the value of a specific field in a specific row</span></li>
<li class="member"> <span class="function"><a href="function.cubrid-fetch-assoc.html" class="function" rel="rdfs-seeAlso">cubrid_fetch_assoc()</a> - Return the associative array that corresponds to the fetched row</span></li>
<li class="member"> <span class="function"><a href="function.cubrid-unbuffered-query.html" class="function" rel="rdfs-seeAlso">cubrid_unbuffered_query()</a> - Perform a query without fetching the results into memory</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.cubrid-ping.html">cubrid_ping</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.cubrid-real-escape-string.html">cubrid_real_escape_string</a></div>
<div class="up"><a href="cubridmysql.cubrid.html">CUBRID MySQL Compatibility Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
