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.Name | Type | Required | Default | Description |
column | any | true | | |
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
QueryBuilder
query.from( "users" )
.orderBy( query.raw( "DATE(created_at)" ) );
MySQL
SELECT *
FROM `users`
ORDER BY DATE(created_at)
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
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
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
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`
)
Name | Type | Required | Default | Description |
expression | string | true | | The raw SQL expression to use. |
bindings | array | false | [] | Any bindings ( ? ) used in the expression. |
QueryBuilder
query.from( "users" )
.orderByRaw( "CASE WHEN status = ? THEN 1 ELSE 0 END DESC", [ 1 ] );
MySQL
SELECT *
FROM `users`
ORDER BY CASE WHEN status = ? THEN 1 ELSE 0 END DESC
Name | Type | Required | Default | Description |
No arguments | | | | |
Clears the currently configured orders for the query. Usually used by downstream libraries like Quick.
QueryBuilder
query.from( "users" )
.orderBy( "email" )
.clearOrders();
MySQL
SELECT *
FROM `users`
Name | Type | Required | Default | Description |
column | any | true | | |
direction | string | false | "asc" | The direction by which to order the query. Accepts "asc" or "desc" . |
QueryBuilder
query.from( "users" )
.orderBy( "email" )
.reorder( "username" );
MySQL
SELECT *
FROM `users`
ORDER BY `username` ASC
Last modified 10d ago