> For the complete documentation index, see [llms.txt](https://quick.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://quick.ortusbooks.com/6.1.0/guide/relationships/ordering-by-relationships.md).

# Ordering By Relationships

To order by a relationship field, you will use a dot-delimited syntax.

```javascript
getInstance( "Post" ).orderBy( "author.name" );
```

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.

```javascript
getInstance( "Post" ).orderBy( "author.team.name" );
```

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`.                                                                                              |

```javascript
getInstance( "Post" ).orderByRelated( "author.team", "name" );
// or
getInstance( "Post" ).orderByRelated( [ "author", "team" ], "name" );
```

You might prefer the explicitness of this method, but it cannot handle normal orders like `orderBy`.  Use whichever method you prefer.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://quick.ortusbooks.com/6.1.0/guide/relationships/ordering-by-relationships.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.