Module: ActiveRecord::ConnectionAdapters::QueryCache
- Included in:
- AbstractAdapter
- Defined in:
- lib/active_record/connection_adapters/abstract/query_cache.rb
Defined Under Namespace
Modules: ConnectionPoolConfiguration
Instance Attribute Summary collapse
-
#query_cache ⇒ Object
readonly
Returns the value of attribute query_cache.
-
#query_cache_enabled ⇒ Object
readonly
Returns the value of attribute query_cache_enabled.
Class Method Summary collapse
Instance Method Summary collapse
-
#cache ⇒ Object
Enable the query cache within the block.
-
#clear_query_cache ⇒ Object
Clears the query cache.
- #disable_query_cache! ⇒ Object
- #enable_query_cache! ⇒ Object
- #initialize ⇒ Object
- #select_all(arel, name = nil, binds = [], preparable: nil) ⇒ Object
-
#uncached ⇒ Object
Disable the query cache within the block.
Instance Attribute Details
#query_cache ⇒ Object (readonly)
Returns the value of attribute query_cache.
45 46 47 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 45 def query_cache @query_cache end |
#query_cache_enabled ⇒ Object (readonly)
Returns the value of attribute query_cache_enabled.
45 46 47 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 45 def query_cache_enabled @query_cache_enabled end |
Class Method Details
.dirties_query_cache(base, *method_names) ⇒ Object
12 13 14 15 16 17 18 19 20 21 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 12 def dirties_query_cache(base, *method_names) method_names.each do |method_name| base.class_eval <<-end_code, __FILE__, __LINE__ + 1 def #{method_name}(*) clear_query_cache if @query_cache_enabled super end end_code end end |
.included(base) ⇒ Object
:nodoc:
5 6 7 8 9 10 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 5 def included(base) #:nodoc: dirties_query_cache base, :insert, :update, :delete, :rollback_to_savepoint, :rollback_db_transaction base.set_callback :checkout, :after, :configure_query_cache! base.set_callback :checkin, :after, :disable_query_cache! end |
Instance Method Details
#cache ⇒ Object
Enable the query cache within the block.
54 55 56 57 58 59 60 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 54 def cache old, @query_cache_enabled = @query_cache_enabled, true yield ensure @query_cache_enabled = old clear_query_cache unless @query_cache_enabled end |
#clear_query_cache ⇒ Object
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.
85 86 87 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 85 def clear_query_cache @query_cache.clear end |
#disable_query_cache! ⇒ Object
66 67 68 69 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 66 def disable_query_cache! @query_cache_enabled = false clear_query_cache end |
#enable_query_cache! ⇒ Object
62 63 64 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 62 def enable_query_cache! @query_cache_enabled = true end |
#initialize ⇒ Object
47 48 49 50 51 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 47 def initialize(*) super @query_cache = Hash.new { |h,sql| h[sql] = {} } @query_cache_enabled = false end |
#select_all(arel, name = nil, binds = [], preparable: nil) ⇒ Object
89 90 91 92 93 94 95 96 97 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 89 def select_all(arel, name = nil, binds = [], preparable: nil) if @query_cache_enabled && !locked?(arel) arel, binds = binds_from_relation arel, binds sql = to_sql(arel, binds) cache_sql(sql, binds) { super(sql, name, binds, preparable: preparable) } else super end end |
#uncached ⇒ Object
Disable the query cache within the block.
72 73 74 75 76 77 |
# File 'lib/active_record/connection_adapters/abstract/query_cache.rb', line 72 def uncached old, @query_cache_enabled = @query_cache_enabled, false yield ensure @query_cache_enabled = old end |