Represents an SQL function call.
If no arguments are given, return a new function with the wildcard prepended to the arguments.
Sequel.function(:count).* # count(*)
# File lib/sequel/sql.rb, line 1269 def *(ce=(arg=false;nil)) if arg == false raise Error, "Cannot apply * to functions with arguments" unless args.empty? with_opts(:"*"=>true) else super(ce) end end
Return a new function with DISTINCT before the method arguments.
Sequel.function(:count, :col).distinct # count(DISTINCT col)
# File lib/sequel/sql.rb, line 1281 def distinct with_opts(:distinct=>true) end
Return a new function with FILTER added to it, for filtered aggregate functions:
Sequel.function(:foo, :col).filter(:a=>1) # foo(col) FILTER (WHERE a = 1)
# File lib/sequel/sql.rb, line 1289 def filter(*args, &block) args = args.first if args.length == 1 with_opts(:filter=>args, :filter_block=>block) end
Return a function which will use LATERAL when literalized:
Sequel.function(:foo, :col).lateral # LATERAL foo(col)
# File lib/sequel/sql.rb, line 1297 def lateral with_opts(:lateral=>true) end
Return a new function with an OVER clause (making it a window function).
Sequel.function(:row_number).over(:partition=>:col) # row_number() OVER (PARTITION BY col)
# File lib/sequel/sql.rb, line 1304 def over(window=OPTS) raise Error, "function already has a window applied to it" if opts[:over] window = Window.new(window) unless window.is_a?(Window) with_opts(:over=>window) end
Return a new function where the function name will be quoted if the database supports quoted functions:
Sequel.function(:foo).quoted # "foo"()
# File lib/sequel/sql.rb, line 1314 def quoted with_opts(:quoted=>true) end
Return a new function where the function name will not be quoted even if the database supports quoted functions:
Sequel.expr(:foo).function.unquoted # foo()
# File lib/sequel/sql.rb, line 1322 def unquoted with_opts(:quoted=>false) end
Return a new function that will use WITH ORDINALITY to also return a row number for every row the function returns:
Sequel.function(:foo).with_ordinality # foo() WITH ORDINALITY
# File lib/sequel/sql.rb, line 1330 def with_ordinality with_opts(:with_ordinality=>true) end
Return a new function that uses WITHIN GROUP ordered by the given expression, useful for ordered-set and hypothetical-set aggregate functions:
Sequel.function(:rank, :a).within_group(:b, :c) # rank(a) WITHIN GROUP (ORDER BY b, c)
# File lib/sequel/sql.rb, line 1339 def within_group(*expressions) with_opts(:within_group=>expressions) end
Generated with the Darkfish Rdoc Generator 2.