123456789_123456789_123456789_123456789_123456789_

Class: Arel::Nodes::Function

Do not use. This class is for internal use only.
Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
Count, NamedFunction
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, NodeExpression, Node
Instance Chain:
self, ::Arel::FilterPredications, ::Arel::WindowPredications, NodeExpression, ::Arel::Math, ::Arel::OrderPredications, ::Arel::AliasPredication, ::Arel::Predications, ::Arel::Expressions, Node, ::Arel::FactoryMethods
Inherits: Arel::Nodes::NodeExpression
Defined in: activerecord/lib/arel/nodes/function.rb

Class Method Summary

Instance Attribute Summary

Node - Inherited

#equality?

Instance Method Summary

::Arel::FilterPredications - Included

#filter

::Arel::WindowPredications - Included

#over

::Arel::Math - Included

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

::Arel::OrderPredications - Included

#asc, #desc

::Arel::AliasPredication - Included

#as

::Arel::Predications - Included

#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, #grouping_all, #grouping_any, #infinity?, #open_ended?, #quoted_node, #unboundable?

::Arel::Expressions - Included

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

Node - Inherited

#and

Factory method to create an And node.
#fetch_attribute, #invert,
#not

Factory method to create a Nodes::Not node that has the recipient of the caller as a child.
#or

Factory method to create a Grouping node that has an Or node as a child.
#to_sql

FIXME: this method should go away.

::Arel::FactoryMethods - Included

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

Create a LOWER() function.

Constructor Details

.new(expr, aliaz = nil) ⇒ Function

[ GitHub ] 

  


# 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   (rw)
  

  [ GitHub ]


  

  


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



attr_accessor :expressions, :alias, :distinct


  








  

    #distinct   (rw)
  

  [ GitHub ]


  

  


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



attr_accessor :expressions, :alias, :distinct


  








  

    #expressions   (rw)
  

  [ GitHub ]


  

  


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



attr_accessor :expressions, :alias, :distinct


  







Instance Method Details



  

    #==(other)  
  



  

    

Alias for #eql?.


  



  [ GitHub ]


  

  


# File 'activerecord/lib/arel/nodes/function.rb', line 32



alias :== :eql?


  








  

    #as(aliaz)  
  

  [ GitHub ]


  

  


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



  

    
  





  


  [ GitHub ]


  

  


# 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  
  

  [ GitHub ]


  

  


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



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