Module: ActiveRecord::ConnectionAdapters::QueryCache

Defined in:
activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Instance Attribute Details

- (Object) query_cache (readonly)

Returns the value of attribute query_cache



21
22
23
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 21

def query_cache
  @query_cache
end

- (Object) query_cache_enabled (readonly)

Returns the value of attribute query_cache_enabled



21
22
23
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 21

def query_cache_enabled
  @query_cache_enabled
end

Class Method Details

+ (Object) dirties_query_cache(base, *method_names)



9
10
11
12
13
14
15
16
17
18
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 9

def dirties_query_cache(base, *method_names)
  method_names.each do |method_name|
    base.class_eval <<-end_code, __FILE__, __LINE__ + 1
      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
    end_code
  end
end

+ (Object) included(base)



5
6
7
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 5

def included(base)
  dirties_query_cache base, :insert, :update, :delete
end

Instance Method Details

- (Object) cache

Enable the query cache within the block.



24
25
26
27
28
29
30
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 24

def cache
  old, @query_cache_enabled = @query_cache_enabled, true
  yield
ensure
  clear_query_cache
  @query_cache_enabled = old
end

- (Object) clear_query_cache

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.



54
55
56
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 54

def clear_query_cache
  @query_cache.clear
end

- (Object) disable_query_cache!



36
37
38
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 36

def disable_query_cache!
  @query_cache_enabled = false
end

- (Object) enable_query_cache!



32
33
34
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 32

def enable_query_cache!
  @query_cache_enabled = true
end

- (Object) select_all(arel, name = nil, binds = [])



58
59
60
61
62
63
64
65
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 58

def select_all(arel, name = nil, binds = [])
  if @query_cache_enabled
    sql = to_sql(arel)
    cache_sql(sql, binds) { super(sql, name, binds) }
  else
    super
  end
end

- (Object) uncached

Disable the query cache within the block.



41
42
43
44
45
46
# File 'activerecord/lib/active_record/connection_adapters/abstract/query_cache.rb', line 41

def uncached
  old, @query_cache_enabled = @query_cache_enabled, false
  yield
ensure
  @query_cache_enabled = old
end