Class: Arel::SelectManager

Inherits:
TreeManager show all
Includes:
Crud
Defined in:
lib/arel/select_manager.rb

Defined Under Namespace

Classes: Row

Instance Attribute Summary

Attributes inherited from TreeManager

#ast, #engine, #visitor

Instance Method Summary collapse

Methods included from Crud

#delete, #update

Methods inherited from TreeManager

#initialize_copy, #to_dot, #to_sql, #where

Constructor Details

#initialize(engine, table = nil) ⇒ SelectManager

Returns a new instance of SelectManager.



5
6
7
8
9
10
 
# File 'lib/arel/select_manager.rb', line 5

def initialize engine, table = nil
  super(engine)
  @ast   = Nodes::SelectStatement.new
  @ctx    = @ast.cores.last
  from table
end

Instance Method Details

#constraints ⇒ Object 



16
17
18
 
# File 'lib/arel/select_manager.rb', line 16

def constraints
  @ctx.wheres
end

#exists ⇒ Object

Produces an Arel::Nodes::Exists node



27
28
29
 
# File 'lib/arel/select_manager.rb', line 27

def exists
  Arel::Nodes::Exists.new @ast
end

#from(table) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/arel/select_manager.rb', line 64

def from table
  table = Nodes::SqlLiteral.new(table) if String === table
  # FIXME: this is a hack to support
  # test_with_two_tables_in_from_without_getting_double_quoted
  # from the AR tests.
  if @ctx.froms
    source = @ctx.froms

    if Nodes::SqlLiteral === table && Nodes::Join === source
      source.left = table
      table = source
    end
  end

  @ctx.froms = table
  self
end

#group(*columns) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/arel/select_manager.rb', line 53

def group *columns
  columns.each do |column|
    # FIXME: backwards compat
    column = Nodes::SqlLiteral.new(column) if String === column
    column = Nodes::SqlLiteral.new(column.to_s) if Symbol === column

    @ctx.groups.push Nodes::Group.new column
  end
  self
end

#having(expr) ⇒ Object 



94
95
96
97
98
99
 
# File 'lib/arel/select_manager.rb', line 94

def having expr
  expr = Nodes::SqlLiteral.new(expr) if String === expr

  @ctx.having = Nodes::Having.new(expr)
  self
end

#insert(values) ⇒ Object

FIXME: this method should go away



179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/arel/select_manager.rb', line 179

def insert values
  im = InsertManager.new @engine
  table = @ctx.froms
  primary_key_name = (primary_key = table.primary_key) && primary_key.name
  # FIXME: in AR tests values sometimes were Array and not Hash therefore is_a?(Hash) check is added
  primary_key_value = primary_key && values.is_a?(Hash) && values[primary_key]
  im.into table
  im.insert values
  # Oracle adapter needs primary key name to generate RETURNING ... INTO ... clause
  # for tables which assign primary key value using trigger.
  # RETURNING ... INTO ... clause will be added only if primary_key_value is nil
  # therefore it is necessary to pass primary key value as well
  @engine.connection.insert im.to_sql, 'AREL', primary_key_name, primary_key_value
end

#join(relation, klass = Nodes::InnerJoin) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/arel/select_manager.rb', line 82

def join relation, klass = Nodes::InnerJoin
  return self unless relation

  case relation
  when String, Nodes::SqlLiteral
    raise if relation.blank?
    from Nodes::StringJoin.new(@ctx.froms, relation)
  else
    from klass.new(@ctx.froms, relation, nil)
  end
end

#join_sql ⇒ Object 



139
140
141
142
143
144
 
# File 'lib/arel/select_manager.rb', line 139

def join_sql
  return nil unless @ctx.froms

  viz = Visitors::JoinSql.new @engine
  Nodes::SqlLiteral.new viz.accept @ctx
end

#joins(manager) ⇒ Object 



152
153
154
155
156
157
158
 
# File 'lib/arel/select_manager.rb', line 152

def joins manager
  if $VERBOSE
    warn "joins is deprecated and will be removed in 2.2"
    warn "please remove your call to joins from #{caller.first}"
  end
  manager.join_sql
end

#lock(locking = true) ⇒ Object 



37
38
39
40
41
42
 
# File 'lib/arel/select_manager.rb', line 37

def lock locking = true
  # FIXME: do we even need to store this?  If locking is +false+ shouldn't
  # we just remove the node from the AST?
  @ast.lock = Nodes::Lock.new
  self
end

#locked ⇒ Object 



44
45
46
 
# File 'lib/arel/select_manager.rb', line 44

def locked
  @ast.lock
end

#on(*exprs) ⇒ Object 



48
49
50
51
 
# File 'lib/arel/select_manager.rb', line 48

def on *exprs
  @ctx.froms.constraint = Nodes::On.new(collapse(exprs))
  self
end

#order(*expr) ⇒ Object 



110
111
112
113
114
115
116
 
# File 'lib/arel/select_manager.rb', line 110

def order *expr
  # FIXME: We SHOULD NOT be converting these to SqlLiteral automatically
  @ast.orders.concat expr.map { |x|
    String === x || Symbol === x ? Nodes::SqlLiteral.new(x.to_s) : x
  }
  self
end

#order_clauses ⇒ Object 



146
147
148
149
150
 
# File 'lib/arel/select_manager.rb', line 146

def order_clauses
  Visitors::OrderClauses.new(@engine).accept(@ast).map { |x|
    Nodes::SqlLiteral.new x
  }
end

#orders ⇒ Object 



118
119
120
 
# File 'lib/arel/select_manager.rb', line 118

def orders
  @ast.orders
end

#project(*projections) ⇒ Object 



101
102
103
104
105
106
107
108
 
# File 'lib/arel/select_manager.rb', line 101

def project *projections
  # FIXME: converting these to SQLLiterals is probably not good, but
  # rails tests require it.
  @ctx.projections.concat projections.map { |x|
    [Symbol, String].include?(x.class) ? SqlLiteral.new(x.to_s) : x
  }
  self
end

#skip(amount) ⇒ Object 



20
21
22
23
 
# File 'lib/arel/select_manager.rb', line 20

def skip amount
  @ast.offset = Nodes::Offset.new(amount)
  self
end

#take(limit) ⇒ Object 



133
134
135
136
137
 
# File 'lib/arel/select_manager.rb', line 133

def take limit
  @ast.limit = Nodes::Limit.new(limit)
  @ctx.top   = Nodes::Top.new(limit)
  self
end

#taken ⇒ Object 



12
13
14
 
# File 'lib/arel/select_manager.rb', line 12

def taken
  @ast.limit && @ast.limit.expr
end

#to_a ⇒ Object

:nodoc:



172
173
174
175
176
 
# File 'lib/arel/select_manager.rb', line 172

def to_a # :nodoc:
  warn "to_a is deprecated. Please remove it from #{caller[0]}"
  # FIXME: I think `select` should be made public...
  @engine.connection.send(:select, to_sql, 'AREL').map { |x| Row.new(x) }
end

#where_clauses ⇒ Object 



31
32
33
34
35
 
# File 'lib/arel/select_manager.rb', line 31

def where_clauses
  #warn "where_clauses is deprecated" if $VERBOSE
  to_sql = Visitors::ToSql.new @engine
  @ctx.wheres.map { |c| to_sql.accept c }
end

#where_sql ⇒ Object 



126
127
128
129
130
131
 
# File 'lib/arel/select_manager.rb', line 126

def where_sql
  return if @ctx.wheres.empty?

  viz = Visitors::WhereSql.new @engine
  Nodes::SqlLiteral.new viz.accept @ctx
end

#wheres ⇒ Object 



122
123
124
 
# File 'lib/arel/select_manager.rb', line 122

def wheres
  Compatibility::Wheres.new @engine, @ctx.wheres
end