Class: ActiveRecord::StatementCache

Inherits:
Object
  • Object
show all
Defined in:
activerecord/lib/active_record/statement_cache.rb

Overview

Statement cache is used to cache a single statement in order to avoid creating the AST again. Initializing the cache is done by passing the statement in the create block:

cache = StatementCache.create(Book.connection) do |params|
  Book.where(name: "my book").where("author_id > 3")
end

The cached statement is executed by using the execute method:

cache.execute([], Book, Book.connection)

The relation returned by the block is cached, and for each execute call the cached relation gets duped. Database is queried when to_a is called on the relation.

If you want to cache the statement without the values you can use the bind method of the block parameter.

cache = StatementCache.create(Book.connection) do |params|
  Book.where(name: params.bind)
end

And pass the bind values as the first argument of execute call.

cache.execute(["my book"], Book, Book.connection)

Defined Under Namespace

Classes: BindMap, Params, PartialQuery, Query, Substitute

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(query_builder, bind_map) ⇒ StatementCache

Returns a new instance of StatementCache.


97
98
99
100
# File 'activerecord/lib/active_record/statement_cache.rb', line 97

def initialize(query_builder, bind_map)
  @query_builder = query_builder
  @bind_map      = bind_map
end

Instance Attribute Details

#bind_mapObject (readonly)

Returns the value of attribute bind_map


88
89
90
# File 'activerecord/lib/active_record/statement_cache.rb', line 88

def bind_map
  @bind_map
end

#query_builderObject (readonly)

Returns the value of attribute query_builder


88
89
90
# File 'activerecord/lib/active_record/statement_cache.rb', line 88

def query_builder
  @query_builder
end

Class Method Details

.create(connection, block = Proc.new) ⇒ Object


90
91
92
93
94
95
# File 'activerecord/lib/active_record/statement_cache.rb', line 90

def self.create(connection, block = Proc.new)
  relation      = block.call Params.new
  bind_map      = BindMap.new relation.bind_values
  query_builder = connection.cacheable_query relation.arel
  new query_builder, bind_map
end

.partial_query(visitor, ast, collector) ⇒ Object


60
61
62
63
# File 'activerecord/lib/active_record/statement_cache.rb', line 60

def self.partial_query(visitor, ast, collector)
  collected = visitor.accept(ast, collector).value
  PartialQuery.new collected
end

.query(visitor, ast) ⇒ Object


56
57
58
# File 'activerecord/lib/active_record/statement_cache.rb', line 56

def self.query(visitor, ast)
  Query.new visitor.accept(ast, Arel::Collectors::SQLString.new).value
end

Instance Method Details

#execute(params, klass, connection) ⇒ Object Also known as: call


102
103
104
105
106
107
108
# File 'activerecord/lib/active_record/statement_cache.rb', line 102

def execute(params, klass, connection)
  bind_values = bind_map.bind params

  sql = query_builder.sql_for bind_values, connection

  klass.find_by_sql sql, bind_values
end