Class: Sequel::SQL::VirtualRow
Overview
The purpose of the VirtualRow
class is to allow the easy creation of SQL identifiers and functions without relying on methods defined on Symbol
. This is useful if another library defines the methods defined by Sequel, if you are running on ruby 1.9, or if you are not using the core extensions.
An instance of this class is yielded to the block supplied to Dataset#filter
, Dataset#order
, and Dataset#select
(and the other methods that accept a block and pass it to one of those methods). If the block doesn’t take an argument, the block is instance_execed in the context of an instance of this class.
VirtualRow
uses method_missing
to return either an Identifier
, QualifiedIdentifier
, Function
, or WindowFunction
, depending on how it is called.
If a block is not given, creates one of the following objects:
Function
-
Returned if any arguments are supplied, using the method name as the function name, and the arguments as the function arguments.
QualifiedIdentifier
-
Returned if the method name contains __, with the table being the part before __, and the column being the part after.
Identifier
-
Returned otherwise, using the method name.
If a block is given, it returns either a Function
or WindowFunction
, depending on the first argument to the method. Note that the block is currently not called by the code, though this may change in a future version. If the first argument is:
- no arguments given
-
creates a
Function
with no arguments. - :*
-
creates a
Function
with a literal wildcard argument (*), mostly useful for COUNT. - :distinct
-
creates a
Function
that prepends DISTINCT to the rest of the arguments, mostly useful for aggregate functions. - :over
-
creates a
WindowFunction
. If a second argument is provided, it should be a hash of options which are passed to Window (with possible keys :window, :partition, :order, and :frame). The arguments to the function itself should be specified as:*=>true
for a wildcard, or via the:args
option.
Examples:
ds = DB[:t]
# Argument yielded to block
ds.filter{|r| r.name < 2} # SELECT * FROM t WHERE (name < 2)
# Block without argument (instance_eval)
ds.filter{name < 2} # SELECT * FROM t WHERE (name < 2)
# Qualified identifiers
ds.filter{table__column + 1 < 2} # SELECT * FROM t WHERE ((table.column + 1) < 2)
# Functions
ds.filter{is_active(1, 'arg2')} # SELECT * FROM t WHERE is_active(1, 'arg2')
ds.select{version{}} # SELECT version() FROM t
ds.select{count(:*){}} # SELECT count(*) FROM t
ds.select{count(:distinct, col1){}} # SELECT count(DISTINCT col1) FROM t
# Window Functions
ds.select{rank(:over){}} # SELECT rank() OVER () FROM t
ds.select{count(:over, :*=>true){}} # SELECT count(*) OVER () FROM t
ds.select{sum(:over, :args=>col1, :partition=>col2, :order=>col3){}} # SELECT sum(col1) OVER (PARTITION BY col2 ORDER BY col3) FROM t
# Math Operators
ds.select{|o| o.+(1, :a).as(:b)} # SELECT (1 + a) AS b FROM t
ds.select{|o| o.-(2, :a).as(:b)} # SELECT (2 - a) AS b FROM t
ds.select{|o| o.*(3, :a).as(:b)} # SELECT (3 * a) AS b FROM t
ds.select{|o| o./(4, :a).as(:b)} # SELECT (4 / a) AS b FROM t
# Boolean Operators
ds.filter{|o| o.&({:a=>1}, :b)} # SELECT * FROM t WHERE ((a = 1) AND b)
ds.filter{|o| o.|({:a=>1}, :b)} # SELECT * FROM t WHERE ((a = 1) OR b)
ds.filter{|o| o.~({:a=>1})} # SELECT * FROM t WHERE (a != 1)
ds.filter{|o| o.~({:a=>1, :b=>2})} # SELECT * FROM t WHERE ((a != 1) OR (b != 2))
# Inequality Operators
ds.filter{|o| o.>(1, :a)} # SELECT * FROM t WHERE (1 > a)
ds.filter{|o| o.<(2, :a)} # SELECT * FROM t WHERE (2 < a)
ds.filter{|o| o.>=(3, :a)} # SELECT * FROM t WHERE (3 >= a)
ds.filter{|o| o.<=(4, :a)} # SELECT * FROM t WHERE (4 <= a)
# Literal Strings
ds.filter{{a=>`some SQL`}} # SELECT * FROM t WHERE (a = some SQL)
For a more detailed explanation, see the Virtual Rows guide.
Constant Summary collapse
- WILDCARD =
LiteralString.new('*').freeze
- QUESTION_MARK =
LiteralString.new('?').freeze
- COMMA_SEPARATOR =
LiteralString.new(', ').freeze
- DOUBLE_UNDERSCORE =
'__'.freeze
- DISTINCT =
["DISTINCT ".freeze].freeze
- COMMA_ARRAY =
[COMMA_SEPARATOR].freeze
Constants inherited from BasicObject
Instance Method Summary collapse
-
#`(s) ⇒ Object
Return a literal string created with the given string.
-
#method_missing(m, *args, &block) ⇒ Object
Return an
Identifier
,QualifiedIdentifier
,Function
, orWindowFunction
, depending on arguments and whether a block is provided.
Methods included from OperatorBuilders
Methods inherited from BasicObject
const_missing, remove_methods!
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(m, *args, &block) ⇒ Object
Return an Identifier
, QualifiedIdentifier
, Function
, or WindowFunction
, depending on arguments and whether a block is provided. Does not currently call the block. See the class level documentation.
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 |
# File 'lib/sequel/sql.rb', line 1612 def method_missing(m, *args, &block) if block if args.empty? Function.new(m) else case args.shift when :* Function.new(m, WILDCARD) when :distinct Function.new(m, PlaceholderLiteralString.new(DISTINCT + COMMA_ARRAY * (args.length-1), args)) when :over opts = args.shift || {} fun_args = ::Kernel.Array(opts[:*] ? WILDCARD : opts[:args]) WindowFunction.new(Function.new(m, *fun_args), Window.new(opts)) else Kernel.raise(Error, 'unsupported VirtualRow method argument used with block') end end elsif args.empty? table, column = m.to_s.split(DOUBLE_UNDERSCORE, 2) column ? QualifiedIdentifier.new(table, column) : Identifier.new(m) else Function.new(m, *args) end end |
Instance Method Details
#`(s) ⇒ Object
Return a literal string created with the given string.
1605 1606 1607 |
# File 'lib/sequel/sql.rb', line 1605 def `(s) Sequel::LiteralString.new(s) end |