class Sequel::SQL::OrderedExpression

Represents a column/expression to order the result set by.

Constants

INVERT_NULLS

Attributes

descending[R]

Whether the expression should order the result set in a descending manner

expression[R]

The expression to order the result set by.

nulls[R]

Whether to sort NULLS FIRST/LAST

Public Class Methods

new(expression, descending = true, opts=OPTS) click to toggle source

Set the expression and descending attributes to the given values. Options:

:nulls

Can be :first/:last for NULLS FIRST/LAST.

     # File lib/sequel/sql.rb
1672 def initialize(expression, descending = true, opts=OPTS)
1673   @expression = expression
1674   @descending = descending
1675   @nulls = opts[:nulls]
1676   freeze
1677 end

Public Instance Methods

asc() click to toggle source

Return a copy that is ordered ASC

     # File lib/sequel/sql.rb
1680 def asc
1681   OrderedExpression.new(@expression, false, :nulls=>@nulls)
1682 end
desc() click to toggle source

Return a copy that is ordered DESC

     # File lib/sequel/sql.rb
1685 def desc
1686   OrderedExpression.new(@expression, true, :nulls=>@nulls)
1687 end
invert() click to toggle source

Return an inverted expression, changing ASC to DESC and NULLS FIRST to NULLS LAST.

     # File lib/sequel/sql.rb
1690 def invert
1691   OrderedExpression.new(@expression, !@descending, :nulls=>INVERT_NULLS.fetch(@nulls, @nulls))
1692 end

Private Instance Methods

inspect_args() click to toggle source

OrderedExpression's initializer takes the :nulls information inside a hash, so if a NULL order was given, include a hash with that information.

    # File lib/sequel/extensions/eval_inspect.rb
167 def inspect_args
168   if nulls
169     [:expression, :descending, :opts_hash]
170   else
171     [:expression, :descending]
172   end
173 end
opts_hash() click to toggle source

A hash of null information suitable for passing to the initializer.

    # File lib/sequel/extensions/eval_inspect.rb
176 def opts_hash
177   {:nulls=>nulls} 
178 end