| 1 |
lars |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
|
3 |
<head>
|
|
|
4 |
|
|
|
5 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
6 |
<title>Queries : CodeIgniter User Guide</title>
|
|
|
7 |
|
|
|
8 |
<style type='text/css' media='all'>@import url('../userguide.css');</style>
|
|
|
9 |
<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
|
|
|
10 |
|
|
|
11 |
<script type="text/javascript" src="../nav/nav.js"></script>
|
|
|
12 |
<script type="text/javascript" src="../nav/prototype.lite.js"></script>
|
|
|
13 |
<script type="text/javascript" src="../nav/moo.fx.js"></script>
|
|
|
14 |
<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
|
|
|
15 |
|
|
|
16 |
<meta http-equiv='expires' content='-1' />
|
|
|
17 |
<meta http-equiv= 'pragma' content='no-cache' />
|
|
|
18 |
<meta name='robots' content='all' />
|
|
|
19 |
<meta name='author' content='ExpressionEngine Dev Team' />
|
|
|
20 |
<meta name='description' content='CodeIgniter User Guide' />
|
|
|
21 |
|
|
|
22 |
</head>
|
|
|
23 |
<body>
|
|
|
24 |
|
|
|
25 |
<!-- START NAVIGATION -->
|
|
|
26 |
<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
|
|
|
27 |
<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
|
|
|
28 |
<div id="masthead">
|
|
|
29 |
<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
|
|
|
30 |
<tr>
|
|
|
31 |
<td><h1>CodeIgniter User Guide Version 1.7.1</h1></td>
|
|
|
32 |
<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
|
|
|
33 |
</tr>
|
|
|
34 |
</table>
|
|
|
35 |
</div>
|
|
|
36 |
<!-- END NAVIGATION -->
|
|
|
37 |
|
|
|
38 |
|
|
|
39 |
<!-- START BREADCRUMB -->
|
|
|
40 |
<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
|
|
|
41 |
<tr>
|
|
|
42 |
<td id="breadcrumb">
|
|
|
43 |
<a href="http://codeigniter.com/">CodeIgniter Home</a> ›
|
|
|
44 |
<a href="../index.html">User Guide Home</a> ›
|
|
|
45 |
<a href="index.html">Database Library</a> ›
|
|
|
46 |
Queries
|
|
|
47 |
</td>
|
|
|
48 |
<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="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>
|
|
|
49 |
</tr>
|
|
|
50 |
</table>
|
|
|
51 |
<!-- END BREADCRUMB -->
|
|
|
52 |
|
|
|
53 |
|
|
|
54 |
|
|
|
55 |
<br clear="all" />
|
|
|
56 |
|
|
|
57 |
|
|
|
58 |
<!-- START CONTENT -->
|
|
|
59 |
<div id="content">
|
|
|
60 |
|
|
|
61 |
|
|
|
62 |
<h1>Queries</h1>
|
|
|
63 |
|
|
|
64 |
<h2>$this->db->query();</h2>
|
|
|
65 |
|
|
|
66 |
<p>To submit a query, use the following function:</p>
|
|
|
67 |
|
|
|
68 |
<code>$this->db->query('YOUR QUERY HERE');</code>
|
|
|
69 |
|
|
|
70 |
<p>The <dfn>query()</dfn> function returns a database result <strong>object</strong> when "read" type queries are run,
|
|
|
71 |
which you can use to <a href="results.html">show your results</a>. When "write" type queries are run it simply returns TRUE or FALSE
|
|
|
72 |
depending on success or failure. When retrieving data you will typically assign the query to your own variable, like this:</p>
|
|
|
73 |
|
|
|
74 |
<code><var>$query</var> = $this->db->query('YOUR QUERY HERE');</code>
|
|
|
75 |
|
|
|
76 |
<h2>$this->db->simple_query();</h2>
|
|
|
77 |
|
|
|
78 |
<p>This is a simplified version of the <dfn>$this->db->query()</dfn> function. It ONLY returns TRUE/FALSE on success or failure.
|
|
|
79 |
It DOES NOT return a database result set, nor does it set the query timer, or compile bind data, or store your query for debugging.
|
|
|
80 |
It simply lets you submit a query. Most users will rarely use this function.</p>
|
|
|
81 |
|
|
|
82 |
|
|
|
83 |
<h1>Adding Database prefixes manually</h1>
|
|
|
84 |
<p>If you have configured a database prefix and would like to add it in manually for, you can use the following.</p>
|
|
|
85 |
<p><code>$this->db->dbprefix('tablename');<br />
|
|
|
86 |
// outputs prefix_tablename</code></p>
|
|
|
87 |
|
|
|
88 |
|
|
|
89 |
<h1>Protecting identifiers</h1>
|
|
|
90 |
<p>In many databases it is advisable to protect table and field names - for example with backticks in MySQL. <strong>Active Record queries are automatically protected</strong>, however if you need to manually protect an identifier you can use:</p>
|
|
|
91 |
<p><code>$this->db->protect_identifiers('table_name');</code></p>
|
|
|
92 |
|
|
|
93 |
<p>This function will also add a table prefix to your table, assuming you have a prefix specified in your database config file. To enable the prefixing set <kbd>TRUE</kbd> (boolen) via the second parameter:</p>
|
|
|
94 |
<p><code>$this->db->protect_identifiers('table_name', <kbd>TRUE</kbd>);</code></p>
|
|
|
95 |
|
|
|
96 |
|
|
|
97 |
<h1>Escaping Queries</h1>
|
|
|
98 |
<p>It's a very good security practice to escape your data before submitting it into your database.
|
|
|
99 |
CodeIgniter has two functions that help you do this:</p>
|
|
|
100 |
|
|
|
101 |
<ol>
|
|
|
102 |
<li><strong>$this->db->escape()</strong> This function determines the data type so that it
|
|
|
103 |
can escape only string data. It also automatically adds single quotes around the data so you don't have to:
|
|
|
104 |
|
|
|
105 |
<code>$sql = "INSERT INTO table (title) VALUES(".$this->db->escape($title).")";</code></li>
|
|
|
106 |
|
|
|
107 |
<li><strong>$this->db->escape_str()</strong> This function escapes the data passed to it, regardless of type.
|
|
|
108 |
Most of the time you'll use the above function rather than this one. Use the function like this:
|
|
|
109 |
|
|
|
110 |
<code>$sql = "INSERT INTO table (title) VALUES('".$this->db->escape_str($title)."')";</code></li>
|
|
|
111 |
</ol>
|
|
|
112 |
|
|
|
113 |
|
|
|
114 |
<h1>Query Bindings</h1>
|
|
|
115 |
|
|
|
116 |
|
|
|
117 |
<p>Bindings enable you to simplify your query syntax by letting the system put the queries together for you. Consider the following example:</p>
|
|
|
118 |
|
|
|
119 |
<code>
|
|
|
120 |
$sql = "SELECT * FROM some_table WHERE id = <var>?</var> AND status = <var>?</var> AND author = <var>?</var>";
|
|
|
121 |
<br /><br />
|
|
|
122 |
$this->db->query($sql, array(3, 'live', 'Rick'));
|
|
|
123 |
</code>
|
|
|
124 |
|
|
|
125 |
<p>The question marks in the query are automatically replaced with the values in the array in the second parameter of the query function.</p>
|
|
|
126 |
<p class="important">The secondary benefit of using binds is that the values are automatically escaped, producing safer queries. You don't have to remember to manually escape data; the engine does it automatically for you.</p>
|
|
|
127 |
|
|
|
128 |
|
|
|
129 |
|
|
|
130 |
</div>
|
|
|
131 |
<!-- END CONTENT -->
|
|
|
132 |
|
|
|
133 |
|
|
|
134 |
<div id="footer">
|
|
|
135 |
<p>
|
|
|
136 |
Previous Topic: <a href="connecting.html">Connecting to your Database</a>
|
|
|
137 |
·
|
|
|
138 |
<a href="#top">Top of Page</a> ·
|
|
|
139 |
<a href="../index.html">User Guide Home</a> ·
|
|
|
140 |
Next Topic: <a href="results.html">Query Results</a>
|
|
|
141 |
</p>
|
|
|
142 |
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
|
|
|
143 |
</div>
|
|
|
144 |
|
|
|
145 |
</body>
|
|
|
146 |
</html>
|