/lenasys/trunk

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/lenasys/trunk

« back to all changes in this revision

Viewing changes to codeigniter/user_guide/database/caching.html

  • Committer: Gustav Hartvigsson
  • Date: 2013-04-11 16:45:55 UTC
  • mfrom: (23.2.1 lenasys)
  • Revision ID: gustav.hartvigsson@gmail.com-20130411164555-ljhmrb2ys3xatogt
commited implementation group one's team branch.
20130411.

Merge proposal comment:
Removed codeigniter user guide, shouldn't be in the repo
Added and implemented CKEditor Wysiwyg editor for editing of pages
Made already uploaded code files visible as you edit a page
Implemented Adams dropdown menu in codeviewer.

Show diffs side-by-side

added added

removed removed

Lines of Context:
codeigniter/user_guide/database/caching.html
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>Database Caching Class : 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 2.1.3</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> &nbsp;&#8250;&nbsp;
44
 
<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45
 
<a href="index.html">Database Library</a> &nbsp;&#8250;&nbsp;
46
 
Database Caching Class
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&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>
49
 
</tr>
50
 
</table>
51
 
<!-- END BREADCRUMB -->
52
 
 
53
 
 
54
 
<br clear="all" />
55
 
 
56
 
 
57
 
<!-- START CONTENT -->
58
 
<div id="content">
59
 
 
60
 
<h1>Database Caching Class</h1>
61
 
 
62
 
<p>The Database Caching Class permits you to cache your queries as text files for reduced database load.</p>
63
 
 
64
 
<p class="important"><strong>Important:</strong>&nbsp; This class is initialized automatically by the database driver
65
 
when caching is enabled.  Do NOT load this class manually.<br /><br />
66
 
 
67
 
<strong>Also note:</strong>&nbsp; Not all query result functions are available when you use caching. Please read this page carefully.</p>
68
 
 
69
 
<h2>Enabling Caching</h2>
70
 
 
71
 
<p>Caching is enabled in three steps:</p>
72
 
 
73
 
<ul>
74
 
<li>Create a writable directory on your server where the cache files can be stored.</li>
75
 
<li>Set the path to your cache folder in your <dfn>application/config/database.php</dfn> file.</li>
76
 
<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>
77
 
</ul>
78
 
 
79
 
<p>Once enabled, caching will happen automatically whenever a page is loaded that contains database queries.</p>
80
 
 
81
 
 
82
 
<h2>How Does Caching Work?</h2>
83
 
 
84
 
<p>CodeIgniter's query caching system happens dynamically when your pages are viewed.
85
 
When caching is enabled, the first time a web page is loaded, the query result object will
86
 
be 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
87
 
accessing your database.  Your database usage can effectively be reduced to zero for any pages that have been cached.</p>
88
 
 
89
 
<p>Only <dfn>read-type</dfn> (SELECT) queries can be cached, since these are the only type of queries that produce a result.
90
 
<dfn>Write-type</dfn> (INSERT, UPDATE, etc.) queries, since they don't generate a result, will not be cached by the system.</p>
91
 
 
92
 
<p>Cache files DO NOT expire.  Any queries that have been cached will remain cached until you delete them.  The caching system
93
 
permits you clear caches associated with individual pages, or you can delete the entire collection of cache files.
94
 
Typically you'll want to use the housekeeping functions described below to delete cache files after certain
95
 
events take place, like when you've added new information to your database.</p>
96
 
 
97
 
<h2>Will Caching Improve Your Site's Performance?</h2>
98
 
 
99
 
<p>Getting a performance gain as a result of caching depends on many factors.
100
 
If you have a highly optimized database under very little load, you probably won't see a performance boost.
101
 
If your database is under heavy use you probably will see an improved response, assuming your file-system is not
102
 
overly taxed.  Remember that caching simply changes how your information is retrieved, shifting it from being a database
103
 
operation to a file-system one.</p>
104
 
 
105
 
<p>In some clustered server environments, for example, caching may be detrimental since file-system operations are so intense.
106
 
On single servers in shared environments, caching will probably be beneficial. Unfortunately there is no
107
 
single answer to the question of whether you should cache your database.  It really depends on your situation.</p>
108
 
 
109
 
<h2>How are Cache Files Stored?</h2>
110
 
 
111
 
<p>CodeIgniter places the result of EACH query into its own cache file.  Sets of cache files are further organized into
112
 
sub-folders corresponding to your controller functions.  To be precise, the sub-folders are named identically to the
113
 
first two segments of your URI (the controller class name and function name).</p>
114
 
 
115
 
<p>For example, let's say you have a controller called <dfn>blog</dfn> with a function called <dfn>comments</dfn> that
116
 
contains three queries.  The caching system will create a cache folder
117
 
called <kbd>blog+comments</kbd>, into which it will write three cache files.</p>
118
 
 
119
 
<p>If you use dynamic queries that change based on information in your URI (when using pagination, for example), each instance of
120
 
the query will produce its own cache file.  It's possible, therefore, to end up with many times more cache files than you have
121
 
queries.</p>
122
 
 
123
 
 
124
 
<h2>Managing your Cache Files</h2>
125
 
 
126
 
<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
127
 
that allows user commenting.  Whenever a new comment is submitted you'll want to delete the cache files associated with the
128
 
controller function that serves up your comments.  You'll find two delete functions described below that help you
129
 
clear data.</p>
130
 
 
131
 
 
132
 
<h2>Not All Database Functions Work with Caching</h2>
133
 
 
134
 
<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,
135
 
some of the query result functions are not available for use.</p>
136
 
 
137
 
<p>The following functions <kbd>ARE NOT</kbd> available when using a cached result object:</p>
138
 
 
139
 
<ul>
140
 
<li>num_fields()</li>
141
 
<li>field_names()</li>
142
 
<li>field_data()</li>
143
 
<li>free_result()</li>
144
 
</ul>
145
 
 
146
 
<p>Also, the two database resources (result_id and conn_id) are not available when caching, since result resources only
147
 
pertain to run-time operations.</p>
148
 
 
149
 
 
150
 
<br />
151
 
 
152
 
<h1>Function Reference</h1>
153
 
 
154
 
 
155
 
 
156
 
<h2>$this->db->cache_on()&nbsp; / &nbsp; $this->db->cache_off()</h2>
157
 
 
158
 
<p>Manually enables/disables caching.  This can be useful if you want to
159
 
keep certain queries from being cached.  Example:</p>
160
 
 
161
 
<code>
162
 
// Turn caching on<br />
163
 
$this->db->cache_on();<br />
164
 
$query = $this->db->query("SELECT * FROM mytable");<br />
165
 
<br />
166
 
// Turn caching off for this one query<br />
167
 
$this->db->cache_off();<br />
168
 
$query = $this->db->query("SELECT * FROM members WHERE member_id = '$current_user'");<br />
169
 
<br />
170
 
// Turn caching back on<br />
171
 
$this->db->cache_on();<br />
172
 
$query = $this->db->query("SELECT * FROM another_table");
173
 
</code>
174
 
 
175
 
 
176
 
<h2>$this->db->cache_delete()</h2>
177
 
 
178
 
<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>
179
 
 
180
 
<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
181
 
a page at <dfn>example.com/index.php/blog/comments</dfn>, the caching system will put all cache files associated with it in a folder
182
 
called <dfn>blog+comments</dfn>.  To delete those particular cache files you will use:</p>
183
 
 
184
 
<code>$this->db->cache_delete('blog', 'comments');</code>
185
 
 
186
 
<p>If you do not use any parameters the current URI will be used when determining what should be cleared.</p>
187
 
 
188
 
 
189
 
<h2>$this->db->cache_delete_all()</h2>
190
 
 
191
 
<p>Clears all existing cache files.  Example:</p>
192
 
 
193
 
<code>$this->db->cache_delete_all();</code>
194
 
 
195
 
 
196
 
 
197
 
 
198
 
 
199
 
 
200
 
 
201
 
 
202
 
 
203
 
 
204
 
</div>
205
 
<!-- END CONTENT -->
206
 
 
207
 
 
208
 
<div id="footer">
209
 
<p>
210
 
Previous Topic:&nbsp;&nbsp;<a href="call_function.html">Custom Function Calls</a>
211
 
&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
212
 
<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
213
 
<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
214
 
Next Topic:&nbsp;&nbsp;<a href="forge.html">Database manipulation with Database Forge</a>
215
 
</p>
216
 
<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2012 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
217
 
</div>
218
 
 
219
 
</body>
220
 
</html>
 
 
b'\\ No newline at end of file'