Class: Sequel::SQL::OrderedExpression

Inherits:
Expression show all
Defined in:
lib/sequel/sql.rb,
lib/sequel/extensions/eval_inspect.rb

Overview

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

Constant Summary

INVERT_NULLS =
{:first=>:last, :last=>:first}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Expression

#==, attr_reader, #clone, #eql?, #hash, inherited, #inspect

Constructor Details

#initialize(expression, descending = true, opts = OPTS) ⇒ OrderedExpression

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

:nulls

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



1608
1609
1610
1611
1612
1613
# File 'lib/sequel/sql.rb', line 1608

def initialize(expression, descending = true, opts=OPTS)
  @expression = expression
  @descending = descending
  @nulls = opts[:nulls]
  freeze
end

Instance Attribute Details

#descendingObject (readonly)

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



1599
1600
1601
# File 'lib/sequel/sql.rb', line 1599

def descending
  @descending
end

#expressionObject (readonly)

The expression to order the result set by.



1596
1597
1598
# File 'lib/sequel/sql.rb', line 1596

def expression
  @expression
end

#nullsObject (readonly)

Whether to sort NULLS FIRST/LAST



1602
1603
1604
# File 'lib/sequel/sql.rb', line 1602

def nulls
  @nulls
end

Instance Method Details

#ascObject

Return a copy that is ordered ASC



1616
1617
1618
# File 'lib/sequel/sql.rb', line 1616

def asc
  OrderedExpression.new(@expression, false, :nulls=>@nulls)
end

#descObject

Return a copy that is ordered DESC



1621
1622
1623
# File 'lib/sequel/sql.rb', line 1621

def desc
  OrderedExpression.new(@expression, true, :nulls=>@nulls)
end

#invertObject

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



1626
1627
1628
# File 'lib/sequel/sql.rb', line 1626

def invert
  OrderedExpression.new(@expression, !@descending, :nulls=>INVERT_NULLS.fetch(@nulls, @nulls))
end