Order By

The orderBy method seems simple but has a lot of depth depending on the type of arguments you pass in.
Calling orderBy multiple times appends to the order list.
Order By (String)
Name
Type
Required
Default
Description
column
any
true
​
The name of the column to order by. An Expression can be passed as well.
direction
string
false
"asc"
The direction by which to order the query. Accepts "asc"or "desc". 
QueryBuilder
query.from( "users" )
    .orderBy( "email" );
MySQL
SELECT *
FROM `users`
ORDER BY `email` ASC
Calling orderBy multiple times will append to the order list.
QueryBuilder
query.from( "users" )
    .orderBy( "email" )
    .orderBy( "username", "desc" );
MySQL
SELECT *
FROM `users`
ORDER BY
  `email` ASC,
  `username` DESC
You can also provide an Expression.
QueryBuilder
query.from( "users" )
    .orderBy( query.raw( "DATE(created_at)" ) );
MySQL
SELECT *
FROM `users`
ORDER BY DATE(created_at)
Order By Shortcuts
Two order by shortcuts exist that default the order - orderByAsc and orderByDesc.  They behave like orderBy in all other regards, including being able to pass Expressions, closures, or Builder instances.
Name
Type
Required
Default
Description
column
any
true
​
The name of the column to order by. An Expression can be passed as well.
QueryBuilder
query.from( "users" )
    .orderByAsc( "email" );
MySQL
SELECT *
FROM `users`
ORDER BY `email` ASC
QueryBuilder
query.from( "users" )
    .orderByDesc( "email" );
MySQL
SELECT *
FROM `users`
ORDER BY `email` DESC
Order By (List)
Name
Type
Required
Default
Description
column
any
true
​
The list of the columns to order by.  Each column can optionally declare it's sort direction after a pipe delimiter. (e.g. "height|desc").
direction
string
false
"asc"
The direction by which to order the query. Accepts "asc"or "desc".  This value will be used as the default value for all entries in the column list that fail to specify a direction for a specific column.
QueryBuilder
query.from( "users" )
    .orderBy( "email|asc,username", "desc" );
MySQL
SELECT *
FROM `users`
ORDER BY
  `email` ASC,
  `username` DESC
Order By (Array of Strings)
Name
Type
Required
Default
Description
column
any
true
​
The array of the columns to order by.  Each column can optionally declare it's sort direction after a pipe delimiter. (e.g. "height|desc").
direction
string
false
"asc"
The direction by which to order the query. Accepts "asc"or "desc".  This value will be used as the default value for all entries in the column array that fail to specify a direction for a specific column.
QueryBuilder
query.from( "users" )
    .orderBy( [ "email|asc", "username" ], "desc" );
MySQL
SELECT *
FROM `users`
ORDER BY
  `email` ASC,
  `username` DESC
Order By (Array of Structs)
Name
Type
Required
Default
Description
column
any
true
​
The array of the columns to order by.  Each column can optionally declare it's sort direction using a struct.  The struct should have a column key and an optional direction key. (e.g. { column = "favorite_color", direction = "desc" }).
direction
string
false
"asc"
The direction by which to order the query. Accepts "asc"or "desc".  This value will be used as the default value for all entries in the column array that fail to specify a direction for a specific column.
QueryBuilder
query.from( "users" )
    .orderBy( [
        { "column": "email", "direction": "asc" },
        "username"
    ], "desc" );
MySQL
SELECT *
FROM `users`
ORDER BY
  `email` ASC,
  `username` DESC
Order By (Subquery)
Name
Type
Required
Default
Description
column
any
true
​
The name of the column to order by. An Expression can be passed as well. An array can be passed with any combination of simple values, array, struct, or list for each entry in the array (an example with all possible value styles: column = [ "last_name", [ "age", "desc" ], { column = "favorite_color", direction = "desc" }, "height|desc" ];. The column argument can also just accept a comman delimited list with a pipe ( | ) as the secondary delimiter denoting the direction of the order by. The pipe delimiter is also used when parsing the column argument when it is passed as an array and the entry in the array is a pipe delimited string.
direction
string
false
"asc"
Ignored when using a Function or QueryBuilder instance.
You can order with a subquery using either a function or a QueryBuilder instance.
QueryBuilder
query.from( "users" )
    .orderBy( function( q ) {
        q.selectRaw( "MAX(created_date)" )
            .from( "logins" )
            .whereColumn( "users.id", "logins.user_id" );
    } );
MySQL
SELECT *
FROM `users`
ORDER BY (
    SELECT MAX(created_date)
    FROM `logins`
    WHERE `users`.`id` = `logins`.`user_id`
)
Order By Raw
Name
Type
Required
Default
Description
sql
string
true
​
The SQL to use in a raw Expression.
You can order with a subquery using a raw sql string
QueryBuilder
QueryBuilder
query.from( "users" ).orderByRaw( "NVL(type, 0)" );
clearOrders
Name
Type
Required
Default
Description
No arguments
​
​
​
​
Removes any already configured orders.  Orders added after the call to clearOrders are added as normal.
QueryBuilder
QueryBuilder
query.from( "users" )
    .orderBy( "email" )
    .clearOrders()
    .orderBy( "username" );
Wheres
Group By and Having
Last updated 1 week ago
Name	Type	Required	Default	Description
column	any	`true`		The name of the column to order by. An `Expression` can be passed as well.
direction	string	`false`	`"asc"`	The direction by which to order the query. Accepts `"asc"`or `"desc"`.