4d44c378ed
This change adds support for sort with multiple fields in local API and REST API. Related discussion #2089 Co-authored-by: Dan Ribbens <dan.ribbens@gmail.com>
77 lines
2.5 KiB
Plaintext
77 lines
2.5 KiB
Plaintext
---
|
|
title: Sort
|
|
label: Sort
|
|
order: 20
|
|
desc: Payload sort allows you to order your documents by a field in ascending or descending order.
|
|
keywords: query, documents, pagination, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
|
|
---
|
|
|
|
Documents in Payload can be easily sorted by a specific [Field](../fields/overview). When querying Documents, you can pass the name of any top-level field, and the response will sort the Documents by that field in _ascending_ order. If prefixed with a minus symbol ("-"), they will be sorted in _descending_ order. In Local API multiple fields can be specificed by using an array of strings. In REST API multiple fields can be specified by separating fields with comma. The minus symbol can be in front of individual fields.
|
|
|
|
Because sorting is handled by the database, the field cannot be a [Virtual Field](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges). It must be stored in the database to be searchable.
|
|
|
|
<Banner type="success">
|
|
<strong>Tip:</strong>
|
|
For performance reasons, it is recommended to enable `index: true` for the fields that will be sorted upon. [More details](../fields/overview).
|
|
</Banner>
|
|
|
|
## Local API
|
|
|
|
To sort Documents in the [Local API](../local-api/overview), you can use the `sort` option in your query:
|
|
|
|
```ts
|
|
const getPosts = async () => {
|
|
const posts = await payload.find({
|
|
collection: 'posts',
|
|
sort: '-createdAt', // highlight-line
|
|
})
|
|
|
|
return posts
|
|
}
|
|
```
|
|
|
|
To sort by multiple fields, you can use the `sort` option with fields in an array:
|
|
|
|
```ts
|
|
const getPosts = async () => {
|
|
const posts = await payload.find({
|
|
collection: 'posts',
|
|
sort: ['priority', '-createdAt'], // highlight-line
|
|
})
|
|
|
|
return posts
|
|
}
|
|
```
|
|
|
|
## REST API
|
|
|
|
To sort in the [REST API](../rest-api/overview), you can use the `sort` parameter in your query:
|
|
|
|
```ts
|
|
fetch('https://localhost:3000/api/posts?sort=-createdAt') // highlight-line
|
|
.then((response) => response.json())
|
|
.then((data) => console.log(data))
|
|
```
|
|
|
|
To sort by multiple fields, you can use the `sort` parameter with fields separated by comma:
|
|
|
|
```ts
|
|
fetch('https://localhost:3000/api/posts?sort=priority,-createdAt') // highlight-line
|
|
.then((response) => response.json())
|
|
.then((data) => console.log(data))
|
|
```
|
|
|
|
## GraphQL API
|
|
|
|
To sort in the [GraphQL API](../graphql/overview), you can use the `sort` parameter in your query:
|
|
|
|
```ts
|
|
query {
|
|
Posts(sort: "-createdAt") {
|
|
docs {
|
|
color
|
|
}
|
|
}
|
|
}
|
|
```
|