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

Instance Method Summary collapse

Methods included from Crud

#compile_delete, #compile_insert, #compile_update, #create_insert, #delete, #update

Methods inherited from TreeManager

#to_dot, #to_sql, #visitor, #where

Methods included from FactoryMethods

#create_and, #create_false, #create_join, #create_on, #create_string_join, #create_table_alias, #create_true, #grouping, #lower

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

#as(other) ⇒ Object 



46
47
48
 
# File 'lib/arel/select_manager.rb', line 46

def as other
  create_table_alias grouping(@ast), Nodes::SqlLiteral.new(other)
end

#constraints ⇒ Object 



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

def constraints
  @ctx.wheres
end

#distinct(value = true) ⇒ Object 



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

def distinct(value = true)
  if value
    @ctx.set_quantifier = Arel::Nodes::Distinct.new
  else
    @ctx.set_quantifier = nil
  end
end

#except(other) ⇒ Object Also known as: minus 



199
200
201
 
# File 'lib/arel/select_manager.rb', line 199

def except other
  Nodes::Except.new ast, other.ast
end

#exists ⇒ Object

Produces an Arel::Nodes::Exists node



42
43
44
 
# File 'lib/arel/select_manager.rb', line 42

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

#from(table) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/arel/select_manager.rb', line 91

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.

  case table
  when Nodes::Join
    @ctx.source.right << table
  else
    @ctx.source.left = table
  end

  self
end

#froms ⇒ Object 



107
108
109
 
# File 'lib/arel/select_manager.rb', line 107

def froms
  @ast.cores.map { |x| x.from }.compact
end

#group(*columns) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/arel/select_manager.rb', line 80

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(*exprs) ⇒ Object 



124
125
126
127
 
# File 'lib/arel/select_manager.rb', line 124

def having *exprs
  @ctx.having = Nodes::Having.new(collapse(exprs, @ctx.having))
  self
end

#initialize_copy(other) ⇒ Object 



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

def initialize_copy other
  super
  @ctx = @ast.cores.last
end

#insert(values) ⇒ Object

FIXME: this method should go away



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/arel/select_manager.rb', line 276

def insert values
  if $VERBOSE
    warn <<-eowarn
insert (#{caller.first}) is deprecated and will be removed in Arel 4.0.0. Please
switch to `compile_insert`
    eowarn
  end

  im = compile_insert(values)
  table = @ctx.froms

  primary_key      = table.primary_key
  primary_key_name = primary_key.name if primary_key

  # 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
  # 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

#intersect(other) ⇒ Object 



195
196
197
 
# File 'lib/arel/select_manager.rb', line 195

def intersect other
  Nodes::Intersect.new ast, other.ast
end

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



111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/arel/select_manager.rb', line 111

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

  case relation
  when String, Nodes::SqlLiteral
    raise if relation.blank?
    klass = Nodes::StringJoin
  end

  @ctx.source.right << create_join(relation, nil, klass)
  self
end

#join_sources ⇒ Object 



241
242
243
 
# File 'lib/arel/select_manager.rb', line 241

def join_sources
  @ctx.source.right
end

#join_sql ⇒ Object 



227
228
229
230
231
232
 
# File 'lib/arel/select_manager.rb', line 227

def join_sql
  return nil if @ctx.source.right.empty?

  sql = visitor.dup.extend(Visitors::JoinSql).accept @ctx
  Nodes::SqlLiteral.new sql
end

#joins(manager) ⇒ Object 



249
250
251
252
253
254
255
 
# File 'lib/arel/select_manager.rb', line 249

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

#limit ⇒ Object Also known as: taken 



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

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

#lock(locking = Arel.sql('FOR UPDATE')) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/arel/select_manager.rb', line 58

def lock locking = Arel.sql('FOR UPDATE')
  case locking
  when true
    locking = Arel.sql('FOR UPDATE')
  when Arel::Nodes::SqlLiteral
  when String
    locking = Arel.sql locking
  end

  @ast.lock = Nodes::Lock.new(locking)
  self
end

#locked ⇒ Object 



71
72
73
 
# File 'lib/arel/select_manager.rb', line 71

def locked
  @ast.lock
end

#offset ⇒ Object 



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

def offset
  @ast.offset && @ast.offset.expr
end

#on(*exprs) ⇒ Object 



75
76
77
78
 
# File 'lib/arel/select_manager.rb', line 75

def on *exprs
  @ctx.source.right.last.right = Nodes::On.new(collapse(exprs))
  self
end

#order(*expr) ⇒ Object 



160
161
162
163
164
165
166
 
# File 'lib/arel/select_manager.rb', line 160

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 



234
235
236
237
238
239
 
# File 'lib/arel/select_manager.rb', line 234

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

#orders ⇒ Object 



168
169
170
 
# File 'lib/arel/select_manager.rb', line 168

def orders
  @ast.orders
end

#project(*projections) ⇒ Object 



135
136
137
138
139
140
141
142
 
# File 'lib/arel/select_manager.rb', line 135

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

#projections ⇒ Object 



144
145
146
 
# File 'lib/arel/select_manager.rb', line 144

def projections
  @ctx.projections
end

#projections=(projections) ⇒ Object 



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

def projections= projections
  @ctx.projections = projections
end

#skip(amount) ⇒ Object Also known as: offset= 



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

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

#source ⇒ Object 



245
246
247
 
# File 'lib/arel/select_manager.rb', line 245

def source
  @ctx.source
end

#take(limit) ⇒ Object Also known as: limit= 



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/arel/select_manager.rb', line 215

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

#to_a ⇒ Object

:nodoc:



269
270
271
272
273
 
# File 'lib/arel/select_manager.rb', line 269

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

#union(operation, other = nil) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/arel/select_manager.rb', line 184

def union operation, other = nil
  if other
    node_class = Nodes.const_get("Union#{operation.to_s.capitalize}")
  else
    other = operation
    node_class = Nodes::Union
  end

  node_class.new self.ast, other.ast
end

#where_clauses ⇒ Object 



50
51
52
53
54
55
56
 
# File 'lib/arel/select_manager.rb', line 50

def where_clauses
  if $VERBOSE
    warn "(#{caller.first}) where_clauses is deprecated and will be removed in arel 4.0.0 with no replacement"
  end
  to_sql = Visitors::ToSql.new @engine.connection
  @ctx.wheres.map { |c| to_sql.accept c }
end

#where_sql ⇒ Object 



177
178
179
180
181
182
 
# File 'lib/arel/select_manager.rb', line 177

def where_sql
  return if @ctx.wheres.empty?

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

#wheres ⇒ Object 



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

def wheres
  warn "#{caller[0]}: SelectManager#wheres is deprecated and will be removed in Arel 4.0.0 with no replacement"
  Compatibility::Wheres.new @engine.connection, @ctx.wheres
end

#window(name) ⇒ Object 



129
130
131
132
133
 
# File 'lib/arel/select_manager.rb', line 129

def window name
  window = Nodes::NamedWindow.new(name)
  @ctx.windows.push window
  window
end

#with(*subqueries) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/arel/select_manager.rb', line 204

def with *subqueries
  if subqueries.first.is_a? Symbol
    node_class = Nodes.const_get("With#{subqueries.shift.to_s.capitalize}")
  else
    node_class = Nodes::With
  end
  @ast.with = node_class.new(subqueries.flatten)

  self
end