Order By
Last updated
Last updated
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.
Calling orderBy
multiple times will append to the order list.
You can also provide an Expression
.
You can order with a subquery using either a function or a QueryBuilder instance.
Clears the currently configured orders for the query. Usually used by downstream libraries like Quick.
Clears the currently configured orders for the query and sets the new orders passed in. Any valid argument to orderBy
can be passed here. Usually used by downstream libraries like Quick.
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"
.
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.
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.
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.
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.
Name
Type
Required
Default
Description
No arguments
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"
.