Files

Class Index [+]

Quicksearch

ActiveRecord::ConnectionAdapters::QueryCache

Attributes

query_cache[R]
query_cache_enabled[R]

Public Class Methods

dirties_query_cache(base, *method_names) click to toggle source
    # File lib/active_record/connection_adapters/abstract/query_cache.rb, line 11
11:         def dirties_query_cache(base, *method_names)
12:           method_names.each do |method_name|
13:             base.class_eval               def #{method_name}(*)                         # def update_with_query_dirty(*args)                clear_query_cache if @query_cache_enabled   #   clear_query_cache if @query_cache_enabled                super                                       #   update_without_query_dirty(*args)              end                                           # end, __FILE__, __LINE__ + 1
14:           end
15:         end
included(base) click to toggle source
   # File lib/active_record/connection_adapters/abstract/query_cache.rb, line 7
7:         def included(base)
8:           dirties_query_cache base, :insert, :update, :delete
9:         end

Public Instance Methods

cache() click to toggle source

Enable the query cache within the block.

    # File lib/active_record/connection_adapters/abstract/query_cache.rb, line 26
26:       def cache
27:         old, @query_cache_enabled = @query_cache_enabled, true
28:         yield
29:       ensure
30:         clear_query_cache
31:         @query_cache_enabled = old
32:       end
clear_query_cache() click to toggle source

Clears the query cache.

One reason you may wish to call this method explicitly is between queries that ask the database to randomize results. Otherwise the cache would see the same SQL query and repeatedly return the same result each time, silently undermining the randomness you were expecting.

    # File lib/active_record/connection_adapters/abstract/query_cache.rb, line 48
48:       def clear_query_cache
49:         @query_cache.clear
50:       end
select_all(*args) click to toggle source
    # File lib/active_record/connection_adapters/abstract/query_cache.rb, line 52
52:       def select_all(*args)
53:         if @query_cache_enabled
54:           cache_sql(args.first) { super }
55:         else
56:           super
57:         end
58:       end
uncached() click to toggle source

Disable the query cache within the block.

    # File lib/active_record/connection_adapters/abstract/query_cache.rb, line 35
35:       def uncached
36:         old, @query_cache_enabled = @query_cache_enabled, false
37:         yield
38:       ensure
39:         @query_cache_enabled = old
40:       end

Private Instance Methods

cache_sql(sql) click to toggle source
    # File lib/active_record/connection_adapters/abstract/query_cache.rb, line 61
61:         def cache_sql(sql)
62:           result =
63:             if @query_cache.has_key?(sql)
64:               ActiveSupport::Notifications.instrument("sql.active_record",
65:                 :sql => sql, :name => "CACHE", :connection_id => self.object_id)
66:               @query_cache[sql]
67:             else
68:               @query_cache[sql] = yield
69:             end
70: 
71:           if Array === result
72:             result.collect { |row| row.dup }
73:           else
74:             result.duplicable? ? result.dup : result
75:           end
76:         rescue TypeError
77:           result
78:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.