Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 86c60398852a299aa4a485c7e9e3c1d45e8c2184 / . / user_guide / database / caching.html
blob: ce5535c233d17aeced00e9d5c96981ef5bf42af7 [file] [log] [blame]
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3<head>
4
5<title>Code Igniter User Guide</title>
6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]13<script type="text/javascript">
14window.onload = function() {
admine334c472006-10-21 19:44:22 +0000[diff] [blame]15 myHeight = new fx.Height('nav', {duration: 400});
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]16 myHeight.hide();
17}
18</script>
19
20<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
21<meta http-equiv='expires' content='-1' />
22<meta http-equiv= 'pragma' content='no-cache' />
23<meta name='robots' content='all' />
24<meta name='author' content='Rick Ellis' />
25<meta name='description' content='Code Igniter User Guide' />
26
27</head>
28<body>
29
30<!-- START NAVIGATION -->
31<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
32<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>
33<div id="masthead">
34<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
35<tr>
admine0cd6092006-10-20 01:00:31 +0000[diff] [blame]36<td><h1>Code Igniter User Guide Version 1.5.0b3</h1></td>
admin43c36af2006-10-11 19:40:39 +0000[diff] [blame]37<td id="breadcrumb_right"><a href="../toc.html">Linear Table of Contents</a></td>
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]38</tr>
39</table>
40</div>
41<!-- END NAVIGATION -->
42
43
44<!-- START BREADCRUMB -->
45<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
46<tr>
47<td id="breadcrumb">
48<a href="http://www.codeigniter.com/">Code Igniter Home</a> &nbsp;&#8250;&nbsp;
49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50<a href="index.html">Database Library</a> &nbsp;&#8250;&nbsp;
51Database Caching Class
52</td>
53<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&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
54</tr>
55</table>
56<!-- END BREADCRUMB -->
57
58
59<br clear="all" />
60
61
62<!-- START CONTENT -->
63<div id="content">
64
65<h1>Database Caching Class</h1>
66
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]67<p>The Database Caching Class permits you to cache your queries as text files for reduced database load.</p>
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]68
admin5ffba1e2006-10-05 04:23:18 +0000[diff] [blame]69<p class="important"><strong>Important:</strong>&nbsp; This class is initialized automatically by the database driver
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]70when caching is enabled. Do NOT load this class manually.<br /><br />
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]71
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]72<strong>Also note:</strong>&nbsp; Not all query result functions are available when you use caching. Please read this page carefully.</p>
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]73
admin11c06c72006-10-05 05:12:27 +0000[diff] [blame]74<h2>Enabling Caching</h2>
75
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]76<p>Caching is enabled in three steps:</p>
admin11c06c72006-10-05 05:12:27 +0000[diff] [blame]77
78<ul>
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]79<li>Create a writable directory on your server where the cache files can be stored.</li>
80<li>Set the path to your cache folder in your <dfn>application/config/database.php</dfn> file.</li>
81<li>Enable the caching feature, either globally by setting the preference in your <dfn>application/config/database.php</dfn> file, or manually as described below.</li>
admin11c06c72006-10-05 05:12:27 +0000[diff] [blame]82</ul>
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]83
adminadb899a2006-10-10 23:11:33 +0000[diff] [blame]84<p>Once enabled, caching will happen automatically whenever a page is loaded that contains database queries.</p>
admin0a35e3d2006-10-06 06:05:02 +0000[diff] [blame]85
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]86
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]87<h2>How Does Caching Work?</h2>
adminf3428b52006-10-05 05:19:15 +0000[diff] [blame]88
admine334c472006-10-21 19:44:22 +0000[diff] [blame]89<p>Code Igniter's query caching system happens dynamically when your pages are viewed.
admin0a35e3d2006-10-06 06:05:02 +0000[diff] [blame]90When caching is enabled, the first time a web page is loaded, the query result object will
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]91be serialized and stored in a text file on your server. The next time the page is loaded the cache file will be used instead of
92accessing your database. Your database usage can effectively be reduced to zero for any pages that have been cached.</p>
adminf3428b52006-10-05 05:19:15 +0000[diff] [blame]93
admine334c472006-10-21 19:44:22 +0000[diff] [blame]94<p>Only <dfn>read-type</dfn> (SELECT) queries can be cached, since these are the only type of queries that produce a result.
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]95<dfn>Write-type</dfn> (INSERT, UPDATE, etc.) queries, since they don't generate a result, will not be cached by the system.</p>
adminf3428b52006-10-05 05:19:15 +0000[diff] [blame]96
admine334c472006-10-21 19:44:22 +0000[diff] [blame]97<p>Cache files DO NOT expire. Any queries that have been cached will remain cached until you delete them. The caching system
98permits you clear caches associated with individual pages, or you can delete the entire collection of cache files.
admin0a35e3d2006-10-06 06:05:02 +0000[diff] [blame]99Typically you'll to use the housekeeping functions described below to delete cache files after certain
100events take place, like when you've added new information to your database.</p>
adminf3428b52006-10-05 05:19:15 +0000[diff] [blame]101
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]102<h2>Will Caching Improve Your Site's Performance?</h2>
103
admine334c472006-10-21 19:44:22 +0000[diff] [blame]104<p>Getting a performance gain as a result of caching depends on many factors.
admin0a35e3d2006-10-06 06:05:02 +0000[diff] [blame]105If you have a highly optimized database under very little load, you probably won't see a performance boost.
admine334c472006-10-21 19:44:22 +0000[diff] [blame]106If your database is under heavy use you probably will see an improved response, assuming your file-system is not
admin0a35e3d2006-10-06 06:05:02 +0000[diff] [blame]107overly taxed. Remember that caching simply changes how your information is retrieved, shifting it from being a database
adminadb899a2006-10-10 23:11:33 +0000[diff] [blame]108operation to a file-system one.</p>
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]109
adminadb899a2006-10-10 23:11:33 +0000[diff] [blame]110<p>In some clustered server environments, for example, caching may be detrimental since file-system operations are so intense.
admin0a35e3d2006-10-06 06:05:02 +0000[diff] [blame]111On single servers in shared environments, caching will probably be beneficial. Unfortunately there is no
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]112single answer to the question of whether you should cache your database. It really depends on your situation.</p>
113
114<h2>How are Cache Files Stored?</h2>
115
admine334c472006-10-21 19:44:22 +0000[diff] [blame]116<p>Code Igniter places the result of EACH query into its own cache file. Sets of cache files are further organized into
admin0a35e3d2006-10-06 06:05:02 +0000[diff] [blame]117sub-folders corresponding to your controller functions. To be precise, the sub-folders are named identically to the
118first two segments of your URI (the controller class name and function name).</p>
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]119
120<p>For example, let's say you have a controller called <dfn>blog</dfn> with a function called <dfn>comments</dfn> that
admine334c472006-10-21 19:44:22 +0000[diff] [blame]121contains three queries. The caching system will create a cache folder
adminadb899a2006-10-10 23:11:33 +0000[diff] [blame]122called <kbd>blog+comments</kbd>, into which it will write three cache files.</p>
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]123
admin0a35e3d2006-10-06 06:05:02 +0000[diff] [blame]124<p>If you use dynamic queries that change based on information in your URI (when using pagination, for example), each instance of
admine334c472006-10-21 19:44:22 +0000[diff] [blame]125the query will produce its own cache file. It's possible, therefore, to end up with many times more cache files than you have
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]126queries.</p>
adminf3428b52006-10-05 05:19:15 +0000[diff] [blame]127
128
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]129<h2>Managing your Cache Files</h2>
130
131<p>Since cache files do not expire, you'll need to build deletion routines into your application. For example, let's say you have a blog
admine334c472006-10-21 19:44:22 +0000[diff] [blame]132that allows user commenting. Whenever a new comment is submitted you'll want to delete the cache files associated with the
133controller function that serves up your comments. You'll find two delete functions described below that help you
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]134clear data.</p>
adminf3428b52006-10-05 05:19:15 +0000[diff] [blame]135
136
admin0a35e3d2006-10-06 06:05:02 +0000[diff] [blame]137<h2>Not All Database Functions Work with Caching</h2>
138
139<p>Lastly, we need to point out that the result object that is cached is a simplified version of the full result object. For that reason,
140some of the query result functions are not available for use.</p>
141
142<p>The following functions <kbd>ARE NOT</kbd> available when using a cached result object:</p>
143
144<ul>
145<li>num_fields()</li>
146<li>field_names()</li>
147<li>field_data()</li>
148<li>free_result()</li>
149</ul>
150
151<p>Also, the two database resources (result_id and conn_id) are not available when caching, since result resources only
152pertain to run-time operations.</p>
153
154
155<br />
156
admin5294f4f2006-10-06 02:10:05 +0000[diff] [blame]157<h1>Function Reference</h1>
adminf3428b52006-10-05 05:19:15 +0000[diff] [blame]158
159
160
adminadb899a2006-10-10 23:11:33 +0000[diff] [blame]161<h2>$this->db->cache_on()&nbsp; / &nbsp; $this->db->cache_off()</h2>
162
163<p>Manually enables/disables caching. This can be useful if you want to
164keep certain queries from being cached. Example:</p>
165
166<code>
167// Turn caching on<br />
168$this->db->cache_on();<br />
169$query = $this->db->query("SELECT * FROM mytable");<br />
170<br />
171// Turn caching off for this one query<br />
172$this->db->cache_off();<br />
173$query = $this->db->query("SELECT * FROM members WHERE member_id = '$current_user'");<br />
174<br />
175// Turn caching back on<br />
176$this->db->cache_on();<br />
177$query = $this->db->query("SELECT * FROM another_table");
178</code>
adminf3428b52006-10-05 05:19:15 +0000[diff] [blame]179
180
adminadb899a2006-10-10 23:11:33 +0000[diff] [blame]181<h2>$this->db->cache_delete()</h2>
182
183<p>Deletes the cache files associated with a particular page. This is useful if you need to clear caching after you update your database.</p>
184
185<p>The caching system saves your cache files to folders that correspond to the URI of the page you are viewing. For example, if you are viewing
186a page at <dfn>www.your-site.com/index.php/blog/comments</dfn>, the caching system will put all cache files associated with it in a folder
187called <dfn>blog+comments</dfn>. To delete those particular cache files you will use:</p>
188
189<code>$this->db->cache_delete('blog', 'comments');</code>
190
191<p>If you do not use any parameters the current URI will be used when determining what should be cleared.</p>
192
193
194<h2>$this->db->cache_delete_all()</h2>
195
196<p>Clears all existing cache files. Example:</p>
197
198<code>$this->db->cache_delete_all();</code>
adminf3428b52006-10-05 05:19:15 +0000[diff] [blame]199
200
201
202
203
204
205
206
admin43a823e2006-09-27 01:57:10 +0000[diff] [blame]207
208
209</div>
210<!-- END CONTENT -->
211
212
213<div id="footer">
214<p>
215Previous Topic:&nbsp;&nbsp;<a href="call_function.html">Custom Function Calls</a>
216&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
217<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
218<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
219Next Topic:&nbsp;&nbsp;<a href="export.html">Database Export Class</a>
220<p>
221<p><a href="http://www.codeigniter.com">Code Igniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 &nbsp;&middot;&nbsp; <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
222</div>
223
224</body>
225</html>