diff options
Diffstat (limited to 'user_guide/libraries/database/results.html')
| -rw-r--r-- | user_guide/libraries/database/results.html | 235 |
1 files changed, 235 insertions, 0 deletions
diff --git a/user_guide/libraries/database/results.html b/user_guide/libraries/database/results.html new file mode 100644 index 000000000..7e6b95d2f --- /dev/null +++ b/user_guide/libraries/database/results.html @@ -0,0 +1,235 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+
+<title>Code Igniter User Guide</title>
+
+<style type='text/css' media='all'>@import url('../../userguide.css');</style>
+<link rel='stylesheet' type='text/css' media='all' href='../../userguide.css' />
+
+<script type="text/javascript" src="../../scripts/nav.js"></script>
+<script type="text/javascript" src="../../scripts/prototype.lite.js"></script>
+<script type="text/javascript" src="../../scripts/moo.fx.js"></script>
+<script type="text/javascript">
+window.onload = function() {
+ myHeight = new fx.Height('nav', {duration: 400});
+ myHeight.hide();
+}
+</script>
+
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta http-equiv='expires' content='-1' />
+<meta http-equiv= 'pragma' content='no-cache' />
+<meta name='robots' content='all' />
+<meta name='author' content='Rick Ellis' />
+<meta name='description' content='Code Igniter User Guide' />
+
+</head>
+<body>
+
+<!-- START NAVIGATION -->
+<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../../');</script></div></div>
+<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
+<div id="masthead">
+<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
+<tr>
+<td><h1>Code Igniter User Guide Version 1.4.0</h1></td>
+<td id="breadcrumb_right"><a href="../../toc.html">Full Table of Contents</a></td>
+</tr>
+</table>
+</div>
+<!-- END NAVIGATION -->
+
+
+<!-- START BREADCRUMB -->
+<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
+<tr>
+<td id="breadcrumb">
+<a href="http://www.codeigniter.com/">Code Igniter Home</a> ›
+<a href="../../index.html">User Guide Home</a> ›
+<a href="index.html">Database Library</a> ›
+Query Results
+</td>
+<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td>
+</tr>
+</table>
+<!-- END BREADCRUMB -->
+
+
+<br clear="all" />
+
+
+<!-- START CONTENT -->
+<div id="content">
+
+
+
+<h1>Query Results</h1>
+
+
+<p>There are several ways to generate query results:</p>
+
+ <h2>result()</h2>
+
+ <p>This function returns the query result as an array of <strong>objects</strong>, or <strong>FALSE</strong> on failure.
+
+ Typically you'll use this in a foreach loop, like this:</p>
+
+ <code>
+ $query = $this->db->query("YOUR QUERY");<br />
+ <br />
+ foreach ($query->result() as $row)<br />
+ {<br />
+ echo $row->title;<br />
+ echo $row->name;<br />
+ echo $row->body;<br />
+ }</code>
+
+ <p>If you run queries that might <strong>not</strong> produce a result, you are encouraged to test the result first:</p>
+
+ <code>
+ $query = $this->db->query("YOUR QUERY");<br />
+ <br />
+ if ($query->num_rows() > 0)<br />
+ {<br />
+ foreach ($query->result() as $row)<br />
+ {<br />
+ echo $row->title;<br />
+ echo $row->name;<br />
+ echo $row->body;<br />
+ }<br />
+ }
+ </code>
+
+ <h2>result_array()</h2>
+
+ <p>This function returns the query result as a pure array, or FALSE on failure. Typically you'll use this in a foreach loop, like this:</p>
+ <code>
+ $query = $this->db->query("YOUR QUERY");<br />
+ <br />
+ foreach ($query->result_array() as $row)<br />
+ {<br />
+ echo $row['title'];<br />
+ echo $row['name'];<br />
+ echo $row['body'];<br />
+ }</code>
+
+
+ <h2>row()</h2>
+
+ <p>This function returns a single result row. If your query has more than one row, it returns only the first row.
+ The result is returned as an <strong>object</strong>. Here's a usage example:</p>
+ <code>
+ $query = $this->db->query("YOUR QUERY");<br />
+ <br />
+ if ($query->num_rows() > 0)<br />
+ {<br />
+ $row = $query->row();
+ <br /><br />
+ echo $row->title;<br />
+ echo $row->name;<br />
+ echo $row->body;<br />
+ }
+ </code>
+
+ <p>If you want a specific row returned you can submit the row number as a digit in the first parameter:
+
+ <code>$row = $query->row(<dfn>5</dfn>);</code>
+
+
+ <h2>row_array()</h2>
+
+ <p>Identical to the above <var>row()</var> function, except it returns an array. Example:</p>
+
+ <code>
+ $query = $this->db->query("YOUR QUERY");<br />
+ <br />
+ if ($query->num_rows() > 0)<br />
+ {<br />
+ $row = $query->row_array();
+ <br /><br />
+ echo $row['title'];<br />
+ echo $row['name'];<br />
+ echo $row['body'];<br />
+ }
+ </code>
+
+
+ <p>If you want a specific row returned you can submit the row number as a digit in the first parameter:
+
+ <code>$row = $query->row_array(<dfn>5</dfn>);</code>
+
+
+ <p>In addition, you can walk forward/backwards/first/last through your results using these variations:</p>
+
+<p>
+ <strong>$row = $query->first_row()</strong><br />
+ <strong>$row = $query->last_row()</strong><br />
+ <strong>$row = $query->next_row()</strong><br />
+ <strong>$row = $query->previous_row()</strong>
+</p>
+
+<p>By default they return an object unless you put the word "array" in the parameter:</p>
+
+<p>
+ <strong>$row = $query->first_row('array')</strong><br />
+ <strong>$row = $query->last_row('array')</strong><br />
+ <strong>$row = $query->next_row('array')</strong><br />
+ <strong>$row = $query->previous_row('array')</strong>
+</p>
+
+
+<h1><br />Query Result Helpers</h1>
+
+<p>The following functions provide useful information when dealing with query results.</p>
+
+<h2>$query->num_rows()</h2>
+<p>The number of rows returned by the query. Note: <dfn>$query</dfn> is the variable that the query was assigned to:</p>
+
+<code>$query = $this->db->query('SELECT * FROM my_table');<br /><br />
+echo $query->num_rows();
+</code>
+
+<h2>$query->num_fields()</h2>
+<p>The number of FIELDS returned by the query. Make sure to call the function using your query result object:</p>
+
+<code>$query = $this->db->query('SELECT * FROM my_table');<br /><br />
+echo $query->num_fields();
+</code>
+
+
+<h2>$this->db->insert_id()</h2>
+<p>The insert ID number when performing database inserts.</p>
+
+<h2>$this->db->affected_rows()</h2>
+<p>Displays the number of affected rows, when doing "write" type queries (insert, update, etc.).</p>
+</p>Note: In MySQL "DELETE FROM TABLE" returns 0 affected rows. The database class has a small hack that allows it to return the
+correct number of affected rows. By default this hack is enabled but it can be turned off in the database driver file.</p>
+
+
+<h2>$this->db->version()</h2>
+<p>Outputs the database version you are running:</p>
+
+<code>echo $this->db->version();</code>
+
+
+
+
+
+</div>
+<!-- END CONTENT -->
+
+
+<div id="footer">
+<p>
+Previous Topic: <a href="queries.html">Queries</a>
+ ·
+<a href="#top">Top of Page</a> ·
+<a href="../../index.html">User Guide Home</a> ·
+Next Topic: <a href="active_record.html">Active Record Pattern</a>
+<p>
+<p><a href="http://www.codeigniter.com">Code Igniter</a> · Copyright © 2006 · <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file |