Class: Sequel::SQL::Function

Inherits:

GenericExpression

• Object
• Expression
• GenericExpression
• Sequel::SQL::Function

Defined in:

lib/sequel/sql.rb,
lib/sequel/extensions/eval_inspect.rb

Overview

Represents an SQL function call.

Direct Known Subclasses

EmulatedFunction

Constant Summary

WILDCARD =

LiteralString.new('*').freeze

DISTINCT =

["DISTINCT ".freeze].freeze

COMMA_ARRAY =

[LiteralString.new(', ').freeze].freeze

Instance Attribute Summary

• #args ⇒ Object readonly

  The array of arguments to pass to the function (may be blank).

• #f ⇒ Object readonly

  The SQL function to call.

Instance Method Summary

• #*(ce = (arg=false;nil)) ⇒ Object

  If no arguments are given, return a new function with the wildcard prepended to the arguments.

• #distinct ⇒ Object

  Return a new function with DISTINCT before the method arguments.

• #initialize(f, *args) ⇒ Function constructor

  Set the functions and args to the given arguments.

• #over(opts = OPTS) ⇒ Object

  Create a WindowFunction using the receiver and the appropriate options for the window.

Methods included from Postgres::HStoreOpMethods

#hstore

Methods included from Postgres::RangeOpMethods

#pg_range

Methods included from Postgres::ArrayOpMethods

#pg_array

Methods included from Postgres::JSONOpMethods

#pg_json

Methods included from Postgres::PGRowOp::ExpressionMethods

#pg_row

Methods included from SubscriptMethods

#sql_subscript

Methods included from StringMethods

#ilike, #like

Methods included from OrderMethods

#asc, #desc

Methods included from NumericMethods

#+

Methods included from ComplexExpressionMethods

#extract, #sql_boolean, #sql_number, #sql_string

Methods included from CastMethods

#cast, #cast_numeric, #cast_string

Methods included from BooleanMethods

#~

Methods included from AliasMethods

#as

Methods inherited from Expression

#==, attr_reader, #eql?, #hash, inherited, #inspect, #lit, #sql_literal

Constructor Details

#initialize(f, *args) ⇒ Function

Set the functions and args to the given arguments

# File 'lib/sequel/sql.rb', line 1225

def initialize(f, *args)
  @f, @args = f, args
end

Instance Attribute Details

#args ⇒ Object (readonly)

The array of arguments to pass to the function (may be blank)

# File 'lib/sequel/sql.rb', line 1222

def args
  @args
end

#f ⇒ Object (readonly)

The SQL function to call

# File 'lib/sequel/sql.rb', line 1219

def f
  @f
end

Instance Method Details

#*(ce = (arg=false;nil)) ⇒ Object

If no arguments are given, return a new function with the wildcard prepended to the arguments.

Sequel.function(:count).*  # count(*)
Sequel.function(:count, 1).*  # count(*, 1)

# File 'lib/sequel/sql.rb', line 1233

def *(ce=(arg=false;nil))
  if arg == false
    Function.new(f, WILDCARD, *args)
  else
    super(ce)
  end
end

#distinct ⇒ Object

Return a new function with DISTINCT before the method arguments.

# File 'lib/sequel/sql.rb', line 1242

def distinct
  Function.new(f, PlaceholderLiteralString.new(DISTINCT + COMMA_ARRAY * (args.length-1), args))
end

#over(opts = OPTS) ⇒ Object

Create a WindowFunction using the receiver and the appropriate options for the window.

# File 'lib/sequel/sql.rb', line 1247

def over(opts=OPTS)
  WindowFunction.new(self, Window.new(opts))
end