Class: Arel::Nodes::Function

Inherits:
NodeExpression show all
Includes:
FilterPredications, WindowPredications
Defined in:
activerecord/lib/arel/nodes/function.rb

Direct Known Subclasses

Count, NamedFunction

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from FilterPredications

#filter

Methods included from WindowPredications

#over

Methods included from Math

#&, #*, #+, #-, #/, #<<, #>>, #^, #|, #~@

Methods included from OrderPredications

#asc, #desc

Methods included from Predications

#between, #concat, #contains, #does_not_match, #does_not_match_all, #does_not_match_any, #does_not_match_regexp, #eq, #eq_all, #eq_any, #gt, #gt_all, #gt_any, #gteq, #gteq_all, #gteq_any, #in, #in_all, #in_any, #is_distinct_from, #is_not_distinct_from, #lt, #lt_all, #lt_any, #lteq, #lteq_all, #lteq_any, #matches, #matches_all, #matches_any, #matches_regexp, #not_between, #not_eq, #not_eq_all, #not_eq_any, #not_in, #not_in_all, #not_in_any, #overlaps, #quoted_array, #when

Methods included from Expressions

#average, #count, #extract, #maximum, #minimum, #sum

Methods inherited from Node

#and, #equality?, #fetch_attribute, #invert, #not, #or, #to_sql

Methods included from FactoryMethods

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

Constructor Details

#initialize(expr, aliaz = nil) ⇒ Function

Returns a new instance of Function.



10
11
12
13
14
15
 
# File 'activerecord/lib/arel/nodes/function.rb', line 10

def initialize(expr, aliaz = nil)
  super()
  @expressions = expr
  @alias       = aliaz && SqlLiteral.new(aliaz)
  @distinct    = false
end

Instance Attribute Details

#alias ⇒ Object

Returns the value of attribute alias



8
9
10
 
# File 'activerecord/lib/arel/nodes/function.rb', line 8

def alias
  @alias
end

#distinct ⇒ Object

Returns the value of attribute distinct



8
9
10
 
# File 'activerecord/lib/arel/nodes/function.rb', line 8

def distinct
  @distinct
end

#expressions ⇒ Object

Returns the value of attribute expressions



8
9
10
 
# File 'activerecord/lib/arel/nodes/function.rb', line 8

def expressions
  @expressions
end

Instance Method Details

#as(aliaz) ⇒ Object 



17
18
19
20
 
# File 'activerecord/lib/arel/nodes/function.rb', line 17

def as(aliaz)
  self.alias = SqlLiteral.new(aliaz)
  self
end

#eql?(other) ⇒ Boolean Also known as: ==

Returns:

  • (Boolean) 


26
27
28
29
30
31
 
# File 'activerecord/lib/arel/nodes/function.rb', line 26

def eql?(other)
  self.class == other.class &&
    self.expressions == other.expressions &&
    self.alias == other.alias &&
    self.distinct == other.distinct
end

#hash ⇒ Object 



22
23
24
 
# File 'activerecord/lib/arel/nodes/function.rb', line 22

def hash
  [@expressions, @alias, @distinct].hash
end