Class: Arel::SelectManager

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

Defined Under Namespace

Classes: Row

Constant Summary

STRING_OR_SYMBOL_CLASS =
[Symbol, String]

Instance Attribute Summary

Attributes inherited from TreeManager

#ast, #bind_values, #engine

Instance Method Summary collapse

Methods included from Crud

#compile_delete, #compile_insert, #compile_update, #create_insert

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



7
8
9
10
11
12
# File 'lib/arel/select_manager.rb', line 7

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

Instance Method Details

#as(other) ⇒ Object



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

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

#constraintsObject



24
25
26
# File 'lib/arel/select_manager.rb', line 24

def constraints
  @ctx.wheres
end

#distinct(value = true) ⇒ Object



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

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



188
189
190
# File 'lib/arel/select_manager.rb', line 188

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

#existsObject

Produces an Arel::Nodes::Exists node



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

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

#from(table) ⇒ Object



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/arel/select_manager.rb', line 85

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

#fromsObject



101
102
103
# File 'lib/arel/select_manager.rb', line 101

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

#group(*columns) ⇒ Object



74
75
76
77
78
79
80
81
82
83
# File 'lib/arel/select_manager.rb', line 74

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



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

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

#initialize_copy(other) ⇒ Object



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

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

#intersect(other) ⇒ Object



184
185
186
# File 'lib/arel/select_manager.rb', line 184

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

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



105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/arel/select_manager.rb', line 105

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_sourcesObject



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

def join_sources
  @ctx.source.right
end

#join_sqlObject



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

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

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

#limitObject Also known as: taken



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

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

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



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

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

#lockedObject



65
66
67
# File 'lib/arel/select_manager.rb', line 65

def locked
  @ast.lock
end

#offsetObject



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

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

#on(*exprs) ⇒ Object



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

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

#order(*expr) ⇒ Object



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

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

#order_clausesObject



223
224
225
226
227
228
# File 'lib/arel/select_manager.rb', line 223

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

#ordersObject



162
163
164
# File 'lib/arel/select_manager.rb', line 162

def orders
  @ast.orders
end

#project(*projections) ⇒ Object



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

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

#projectionsObject



138
139
140
# File 'lib/arel/select_manager.rb', line 138

def projections
  @ctx.projections
end

#projections=(projections) ⇒ Object



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

def projections= projections
  @ctx.projections = projections
end

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



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

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

#sourceObject



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

def source
  @ctx.source
end

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



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

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

#union(operation, other = nil) ⇒ Object



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

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_sqlObject



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

def where_sql
  return if @ctx.wheres.empty?

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

#window(name) ⇒ Object



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

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

#with(*subqueries) ⇒ Object



193
194
195
196
197
198
199
200
201
202
# File 'lib/arel/select_manager.rb', line 193

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