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.
Constant Summary collapse
- WILDCARD =
LiteralString.new('*').freeze
- DISTINCT =
["DISTINCT ".freeze].freeze
- COMMA_ARRAY =
[LiteralString.new(', ').freeze].freeze
Instance Attribute Summary collapse
-
#args ⇒ Object
readonly
The array of arguments to pass to the function (may be blank).
-
#name ⇒ Object
(also: #f)
readonly
The SQL function to call.
-
#opts ⇒ Object
readonly
Options for this function.
Class Method Summary collapse
Instance Method Summary collapse
-
#*(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.
-
#filter(*args, &block) ⇒ Object
Return a new function with FILTER added to it, for filtered aggregate functions:.
-
#initialize(name, *args) ⇒ Function
constructor
Set the name and args for the function.
-
#lateral ⇒ Object
Return a function which will use LATERAL when literalized:.
-
#over(window = OPTS) ⇒ Object
Return a new function with an OVER clause (making it a window function).
-
#quoted ⇒ Object
Return a new function where the function name will be quoted if the database supports quoted functions:.
-
#unquoted ⇒ Object
Return a new function where the function name will not be quoted even if the database supports quoted functions:.
-
#with_ordinality ⇒ Object
Return a new function that will use WITH ORDINALITY to also return a row number for every row the function returns:.
-
#within_group(*expressions) ⇒ Object
Return a new function that uses WITHIN GROUP ordered by the given expression, useful for ordered-set and hypothetical-set aggregate functions:.
Methods included from Postgres::HStoreOpMethods
Methods included from Postgres::RangeOpMethods
Methods included from Postgres::ArrayOpMethods
Methods included from Postgres::JSONOpMethods
Methods included from Postgres::InetOpMethods
Methods included from Postgres::PGRowOp::ExpressionMethods
Methods included from SubscriptMethods
Methods included from StringMethods
Methods included from PatternMatchMethods
Methods included from OrderMethods
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
Methods inherited from Expression
#==, attr_reader, #eql?, #hash, inherited, #inspect, #lit, #sql_literal
Constructor Details
#initialize(name, *args) ⇒ Function
Set the name and args for the function
1286 1287 1288 1289 1290 |
# File 'lib/sequel/sql.rb', line 1286 def initialize(name, *args) @name = name @args = args @opts = OPTS end |
Instance Attribute Details
#args ⇒ Object (readonly)
The array of arguments to pass to the function (may be blank)
1280 1281 1282 |
# File 'lib/sequel/sql.rb', line 1280 def args @args end |
#name ⇒ Object (readonly) Also known as: f
The SQL function to call
1276 1277 1278 |
# File 'lib/sequel/sql.rb', line 1276 def name @name end |
#opts ⇒ Object (readonly)
Options for this function
1283 1284 1285 |
# File 'lib/sequel/sql.rb', line 1283 def opts @opts end |
Class Method Details
.new!(name, args, opts) ⇒ Object
1292 1293 1294 1295 1296 |
# File 'lib/sequel/sql.rb', line 1292 def self.new!(name, args, opts) f = new(name, *args) f.instance_variable_set(:@opts, opts) 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(*)
1301 1302 1303 1304 1305 1306 1307 1308 |
# File 'lib/sequel/sql.rb', line 1301 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 |
#distinct ⇒ Object
Return a new function with DISTINCT before the method arguments.
Sequel.function(:count, :col).distinct # count(DISTINCT col)
1313 1314 1315 |
# File 'lib/sequel/sql.rb', line 1313 def distinct with_opts(:distinct=>true) end |
#filter(*args, &block) ⇒ Object
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)
1321 1322 1323 1324 |
# File 'lib/sequel/sql.rb', line 1321 def filter(*args, &block) args = args.first if args.length == 1 with_opts(:filter=>args, :filter_block=>block) end |
#lateral ⇒ Object
Return a function which will use LATERAL when literalized:
Sequel.function(:foo, :col).lateral # LATERAL foo(col)
1329 1330 1331 |
# File 'lib/sequel/sql.rb', line 1329 def lateral with_opts(:lateral=>true) end |
#over(window = OPTS) ⇒ Object
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)
1336 1337 1338 1339 1340 |
# File 'lib/sequel/sql.rb', line 1336 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 |
#quoted ⇒ Object
Return a new function where the function name will be quoted if the database supports quoted functions:
Sequel.function(:foo).quoted # "foo"()
1346 1347 1348 |
# File 'lib/sequel/sql.rb', line 1346 def quoted with_opts(:quoted=>true) end |
#unquoted ⇒ Object
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()
1354 1355 1356 |
# File 'lib/sequel/sql.rb', line 1354 def unquoted with_opts(:quoted=>false) end |
#with_ordinality ⇒ Object
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
1362 1363 1364 |
# File 'lib/sequel/sql.rb', line 1362 def with_ordinality with_opts(:with_ordinality=>true) end |
#within_group(*expressions) ⇒ Object
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)
1371 1372 1373 |
# File 'lib/sequel/sql.rb', line 1371 def within_group(*expressions) with_opts(:within_group=>expressions) end |