diff options
Diffstat (limited to 'user_guide')
| -rw-r--r-- | user_guide/database/active_record.html | 29 |
1 files changed, 20 insertions, 9 deletions
diff --git a/user_guide/database/active_record.html b/user_guide/database/active_record.html index 77a168fdb..2a8955c4d 100644 --- a/user_guide/database/active_record.html +++ b/user_guide/database/active_record.html @@ -698,34 +698,45 @@ $query = $this->db->get();</code> <p> </p>
<h1><a name="caching"> </a>Active Record Caching</h1>
-<p>While not "true" caching, Active Record enables you to save (or "cache") certain parts of your queries for reuse later. Normally, when an Active Record call is completed, all stored information is reset for the next call. With caching, you can prevent this reset, and reuse information easily.</p>
+
+<p>While not "true" caching, Active Record enables you to save (or "cache") certain parts of your queries for reuse at a later point in your script's execution. Normally, when an Active Record call is completed, all stored information is reset for the next call. With caching, you can prevent this reset, and reuse information easily.</p>
+
<p>Cached calls are cumulative. If you make 2 cached select() calls, and then 2 uncached select() calls, this will result in 4 select() calls. There are three Caching functions available:</p>
+
<h2>$this->db->start_cache()</h2>
+
<p>This function must be called to begin caching. All Active Record queries of the correct type (see below for supported queries) are stored for later use.</p>
+
<h2>$this->db->stop_cache()</h2>
+
<p>This function can be called to stop caching.</p>
+
<h2>$this->db->flush_cache()</h2>
+
<p>This function deletes all items from the Active Record cache.</p>
+
<p>Here's a usage example:</p>
+
<p><code>$this->db->start_cache();<br />
$this->db->select('field1');<br />
-$this->db->stop_cache();<br />
+$this->db->stop_cache();<br /><br />
$this->db->get('tablename');<br />
-// Results in:<br />
-// SELECT `field1` FROM (`tablename`)<br />
+<br />
+//Generates: SELECT `field1` FROM (`tablename`)<br />
<br />
$this->db->select('field2');<br />
$this->db->get('tablename');<br />
-// Results in:<br />
-// SELECT `field1`, `field2` FROM (`tablename`)<br />
+<br />
+//Generates: SELECT `field1`, `field2` FROM (`tablename`)<br />
<br />
$this->db->flush_cache();<br />
<br />
$this->db->select('field2');<br />
$this->db->get('tablename');<br />
-// Results in:<br />
-// SELECT `field2` FROM (`tablename`)</code></p>
-<p class="important"> <strong>Note:</strong> The following fields can be cached: ‘select’, ‘from’, ‘join’, ‘where’, ‘like’, ‘groupby’, ‘having’, ‘orderby’, ‘set’</p>
+<br />
+//Generates: SELECT `field2` FROM (`tablename`)</code></p>
+
+<p class="important"> <strong>Note:</strong> The following statements can be cached: select, from, join, where, like, groupby, having, orderby, set</p>
<p> </p>
</div>
<!-- END CONTENT -->
|