aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source
diff options
context:
space:
mode:
authorNicholas Schultz-Møller <nicholassm@gmail.com>2013-01-15 14:44:08 +0100
committerNicholas Schultz-Møller <nicholassm@gmail.com>2013-01-15 14:44:08 +0100
commit814c9875ec4cf01e1348d1ab1c9d12eee5a9adac (patch)
treedd03eb605e7a1d2af208e14c4a60f33dc875c2d6 /guides/source
parentbc9433f49598d9af163756f465ab76cb658a6dd0 (diff)
downloadrails-814c9875ec4cf01e1348d1ab1c9d12eee5a9adac.tar.gz
rails-814c9875ec4cf01e1348d1ab1c9d12eee5a9adac.tar.bz2
rails-814c9875ec4cf01e1348d1ab1c9d12eee5a9adac.zip
Improves documentation about Fragment Caching. [ci skip]
Adds documentation for: - Aggregate cache keys, - using an ActiveRecord model as cache key and - Russian Doll Caching.
Diffstat (limited to 'guides/source')
-rw-r--r--guides/source/caching_with_rails.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/guides/source/caching_with_rails.md b/guides/source/caching_with_rails.md
index 0228d463cf..c91483ed77 100644
--- a/guides/source/caching_with_rails.md
+++ b/guides/source/caching_with_rails.md
@@ -86,6 +86,53 @@ This fragment is then available to all actions in the `ProductsController` using
expire_fragment('all_available_products')
```
+If you want to avoid expiring the fragment manually, whenever an action updates a product, you can define a helper method:
+
+```ruby
+module ProductsHelper
+ def cache_key_for_products
+ count = Product.count
+ max_updated_at = Product.maximum(:updated_at).try(:utc).try(:to_s, :number)
+ "products/all-#{count}-#{max_updated_at}"
+ end
+end
+```
+
+This method generates a cache key that depends on all products and can be used in the view:
+
+```erb
+<% cache(cache_key_for_products) do %>
+ All available products:
+<% end %>
+```
+
+You can also use an `ActiveRecord` model as the cache key:
+
+```erb
+<% Product.all.each do |p| %>
+ <% cache(p) do %>
+ <%= link_to p.name, product_url(p) %>
+ <% end %>
+<% end %>
+```
+
+Behind the scenes, a method called `cache_key` will be invoked on the model and it returns a string like `products/23-20130109142513`. The cache key includes the model name, the id and finally the `updated_at` timestamp. Thus it will automatically generate a new fragment when the product is updated because the key changes.
+
+You can also combine the two schemes which is called "Russian Doll Caching":
+
+```erb
+<% cache(cache_key_for_products) do %>
+ All available products:
+ <% Product.all.each do |p| %>
+ <% cache(p) do %>
+ <%= link_to p.name, product_url(p) %>
+ <% end %>
+ <% end %>
+<% end %>
+```
+
+It's called "Russian Doll Caching" because it nests multiple fragments. The advantage is that if a single product is updated, all the other inner fragments can be reused when regenerating the outer fragment.
+
### SQL Caching
Query caching is a Rails feature that caches the result set returned by each query so that if Rails encounters the same query again for that request, it will use the cached result set as opposed to running the query against the database again.