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

Extends

• patio.sql.Expression

Static Properties

Property	Type	Default Value	Description
INVERT_NULLS	Object	{first:"last", last:"first"}	Hash that contains the inversions for "first" and "last".

Instance Properties

Property	Type	Default Value	Description
descending	Boolean	true	READ ONLY true if decending, false otherwise.
expression			READ ONLY the expression to order.
nulls	String	null	if value is "first" the null values will be first, if "last" then null values will be last

Constructor

Defined sql.js Source

function (expression,descending,opts){
   descending = isBoolean(descending) ? descending : true;
   opts = opts || {};
   this.__expression = expression;
   this.__descending = descending;
   var nulls = isString(opts) ? opts : opts.nulls;
   this.__nulls = isString(nulls) ? nulls.toLowerCase() : null;
           
}
            

asc Function Public

---

Defined sql.js

Returns

• patio.sql.OrderedExpression

  a copy that is ordered ASC

Source

function (){
   return new OrderedExpression(this.__expression, false, {nulls: this.__nulls});
           
}
    

desc Function Public

---

Defined sql.js

Returns

• patio.sql.OrderedExpression

  Return a copy that is ordered DESC

Source

function (){
   return new OrderedExpression(this.__expression, true, {nulls: this.__nulls});
           
}
    

invert Function Public

---

Defined sql.js

*

Returns

• patio.sql.OrderedExpression

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

Source

function (){
   return new OrderedExpression(this.__expression, !this.__descending, {nulls: this._static.INVERT_NULLS[this.__nulls] || this.__nulls});
           
}
    

toString Function Public

---

Defined sql.js

Converts the patio.sql.OrderedExpression to a string.

Arguments

• ds? :

  dataset used to created the SQL fragment, if the dataset is ommited then the default patio.Dataset implementation is used.

Returns

• String the SQL version of the patio.sql.OrderedExpression.

Source

function (ds){
   !Dataset && (Dataset = require("./dataset"));
   ds = ds || new Dataset();
   return ds.orderedExpressionSql(this);
           
}
    

---

Documentation generated using coddoc.