aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/identity_map.rb
diff options
context:
space:
mode:
authorEmilio Tagua <miloops@gmail.com>2010-10-07 16:27:00 -0300
committerEmilio Tagua <miloops@gmail.com>2010-11-19 19:08:12 -0300
commita62f7220bbad1678dbf114e2f252172e76b44bab (patch)
tree59a32f2bf1e30cee2ea347788053b8b9b113e3e0 /activerecord/lib/active_record/identity_map.rb
parentda721dae1ea2cc7d33c32080aaaf86e34c91352d (diff)
downloadrails-a62f7220bbad1678dbf114e2f252172e76b44bab.tar.gz
rails-a62f7220bbad1678dbf114e2f252172e76b44bab.tar.bz2
rails-a62f7220bbad1678dbf114e2f252172e76b44bab.zip
Add docs to Identity Map.
Diffstat (limited to 'activerecord/lib/active_record/identity_map.rb')
-rw-r--r--activerecord/lib/active_record/identity_map.rb13
1 files changed, 13 insertions, 0 deletions
diff --git a/activerecord/lib/active_record/identity_map.rb b/activerecord/lib/active_record/identity_map.rb
index 6bf77c71fa..94eece9132 100644
--- a/activerecord/lib/active_record/identity_map.rb
+++ b/activerecord/lib/active_record/identity_map.rb
@@ -1,4 +1,17 @@
module ActiveRecord
+ # = Active Record Identity Map
+ #
+ # Ensures that each object gets loaded only once by keeping every loaded
+ # object in a map. Looks up objects using the map when referring to them.
+ #
+ # More information on Identity Map pattern:
+ # http://www.martinfowler.com/eaaCatalog/identityMap.html
+ #
+ # == Configuration
+ #
+ # In order to activate IdentityMap, set <tt>config.active_record.identity_map = true</tt>
+ # in your <tt>config/application.rb</tt> file.
+ #
module IdentityMap
extend ActiveSupport::Concern