diff options
| author | Derek Allard <derek.allard@ellislab.com> | 2008-02-05 00:20:34 +0100 |
|---|---|---|
| committer | Derek Allard <derek.allard@ellislab.com> | 2008-02-05 00:20:34 +0100 |
| commit | 9b3e7b5f2d4ec4feae793ef90454506addbb19e1 (patch) | |
| tree | 866d6efe488c04a118cdb015991452e56d1722ec /user_guide/database | |
| parent | 613c6f605666031aa5b60c2dca568ac2d3a3c264 (diff) | |
Added and documented Active Record caching.
Made AR fully database-prefix aware
Diffstat (limited to 'user_guide/database')
| -rw-r--r-- | user_guide/database/active_record.html | 39 |
1 files changed, 35 insertions, 4 deletions
diff --git a/user_guide/database/active_record.html b/user_guide/database/active_record.html index 12c59e14b..9a75992fa 100644 --- a/user_guide/database/active_record.html +++ b/user_guide/database/active_record.html @@ -78,6 +78,7 @@ is generated by each database adapter. It also allows for safer queries, since <li><a href="#update">Updating Data</a></li>
<li><a href="#delete">Deleting Data</a></li>
<li><a href="#chaining">Method Chaining</a></li>
+<li><a href="#caching">Active Record Caching</a></li>
</ul>
@@ -698,8 +699,8 @@ $this->db->truncate('mytable'); <br /> // TRUNCATE mytable <br />
</code>
<p class="important"><strong>Note:</strong> If the TRUNCATE command isn't available, truncate() will execute as "DELETE FROM table".</p>
-<a name="chaining"> </a>
-<h1>Method Chaining</h1>
+
+<h1><a name="chaining"> </a>Method Chaining</h1>
<p>Method chaining allows you to simplify your syntax by connecting multiple functions. Consider this example:</p>
@@ -710,8 +711,38 @@ $query = $this->db->get();</code> <p class="important"><strong>Note:</strong> Method chaining only works with PHP 5.</p>
-
-
+<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>Cached calls are cumulative. If you makes 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->get('tablename');<br />
+ // Results in:<br />
+ // 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 />
+ $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>
+<p> </p>
</div>
<!-- END CONTENT -->
|