Ordering By Relationships

Search…
To order by a relationship field, you will use a dot-delimited syntax.
1
getInstance( "Post" ).orderBy( "author.name" );
Copied!
The last item in the dot-delimited string should be an attribute on the related entity.
Nested relationships are also supported.  Continue to chain relationships in your dot-delimited string until arriving at the desired entity.  Remember to end with the attribute to order by.
1
getInstance( "Post" ).orderBy( "author.team.name" );
Copied!
If you desire to be explicit, you can use the orderByRelated method, which is what is being called under the hood.
Name
Type
Required
Default
Description
relationshipName
String | [String]
true
​
A dot-delimited string of relationship names or an array of relationship names to traverse to get to the related entity to order by.
columnName
string
true
​
The column name in the final relationship to order by.
direction
string
false
"asc"
The direction to sort, asc or desc.
1
getInstance( "Post" ).orderByRelated( "author.team", "name" );
2
// or
3
getInstance( "Post" ).orderByRelated( [ "author", "team" ], "name" );
Copied!
You might prefer the explicitness of this method, but it cannot handle normal orders like orderBy.  Use whichever method you prefer.
Relationship Counts
Eager Loading
Last modified 2yr ago
Copy link
Edit on GitHub