diff options
author | Rizwan Reza <rizwanreza@gmail.com> | 2010-06-16 22:22:35 +0430 |
---|---|---|
committer | Rizwan Reza <rizwanreza@gmail.com> | 2010-06-16 22:22:35 +0430 |
commit | 4e3eec3d017df151ac3201be9b03f1f01c228ad3 (patch) | |
tree | b68611d5f7b4d316ce199faea8a1c28e3c7501ad /activerecord/lib/active_record/session_store.rb | |
parent | 0ebdc26caeb755df388ad31ea004960a64ba14c3 (diff) | |
download | rails-4e3eec3d017df151ac3201be9b03f1f01c228ad3.tar.gz rails-4e3eec3d017df151ac3201be9b03f1f01c228ad3.tar.bz2 rails-4e3eec3d017df151ac3201be9b03f1f01c228ad3.zip |
Adds title and proper formatting to docs.
Diffstat (limited to 'activerecord/lib/active_record/session_store.rb')
-rw-r--r-- | activerecord/lib/active_record/session_store.rb | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/activerecord/lib/active_record/session_store.rb b/activerecord/lib/active_record/session_store.rb index 931872eded..f712a2c94f 100644 --- a/activerecord/lib/active_record/session_store.rb +++ b/activerecord/lib/active_record/session_store.rb @@ -1,4 +1,6 @@ module ActiveRecord + # = Active Record Session Store + # # A session store backed by an Active Record class. A default class is # provided, but any object duck-typing to an Active Record Session class # with text +session_id+ and +data+ attributes is sufficient. @@ -7,6 +9,7 @@ module ActiveRecord # +id+ (numeric primary key), # +session_id+ (text, or longtext if your session data exceeds 65K), and # +data+ (text or longtext; careful if your session data exceeds 65KB). + # # The +session_id+ column should always be indexed for speedy lookups. # Session data is marshaled to the +data+ column in Base64 format. # If the data you write is larger than the column's size limit, @@ -14,9 +17,11 @@ module ActiveRecord # # You may configure the table name, primary key, and data column. # For example, at the end of <tt>config/environment.rb</tt>: + # # ActiveRecord::SessionStore::Session.table_name = 'legacy_session_table' # ActiveRecord::SessionStore::Session.primary_key = 'session_id' # ActiveRecord::SessionStore::Session.data_column_name = 'legacy_session_data' + # # Note that setting the primary key to the +session_id+ frees you from # having a separate +id+ column if you don't want it. However, you must # set <tt>session.model.id = session.session_id</tt> by hand! A before filter @@ -29,8 +34,11 @@ module ActiveRecord # You may provide your own session class implementation, whether a # feature-packed Active Record or a bare-metal high-performance SQL # store, by setting + # # ActiveRecord::SessionStore.session_class = MySessionClass + # # You must implement these methods: + # # self.find_by_session_id(session_id) # initialize(hash_of_session_id_and_data) # attr_reader :session_id |