tabshift/payloadcms
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: improves hooks docs (#7133)

Browse Source
This commit is contained in:
Jacob Fletcher
2024-07-12 15:51:17 -04:00
committed by GitHub
parent b750ebf166
commit 6578b85057
19 changed files with 472 additions and 280 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/queries/depth.mdx
View File

@@ -6,11 +6,11 @@ desc: Payload depth determines how many levels down related documents should be
keywords: query, documents, pagination, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
---
Documents in Payload can have relationships to other Documents. This is true for both [Collections](../configuration/collections) as well as [Globals](../configuration/globals). When you query a Document, you can specify the depth at which to populate any of its related Documents as full objects, or simply return their Document IDs.
Documents in Payload can have relationships to other Documents. This is true for both [Collections](../configuration/collections) as well as [Globals](../configuration/globals). When you query a Document, you can specify the depth at which to populate any of its related Documents either as full objects, or only their IDs.
Depth will optimize the performance of your application by limiting the number of queries made to the database, and significantly reducing the amount of data returned. Since Documents can be infinitely nested or recursively related, it's important to be able to control how deep your API populate.
Depth will optimize the performance of your application by limiting the amount of processing made in the database and significantly reducing the amount of data returned. Since Documents can be infinitely nested or recursively related, it's important to be able to control how deep your API populates.
When you specify a `depth` of `0`, for example, the API response might look like this:
For example, when you specify a `depth` of `0`, the API response might look like this:
```json
{
@@ -64,7 +64,7 @@ To specify depth in the [REST API](../rest-api/overview), you can use the `depth
```ts
fetch('https://localhost:3000/api/posts?depth=2') // highlight-line
.then((response) => response.json())
.then((res) => res.json())
.then((data) => console.log(data))
```
@@ -75,7 +75,7 @@ fetch('https://localhost:3000/api/posts?depth=2') // highlight-line
## Max Depth
Fields like the [Relationship Field](../fields/relationship) or the [Upload Field](../fields/upload) can also set a maximum depth. If exceeded, this will limit the population depth regardless of the depth of the request.
Fields like the [Relationship Field](../fields/relationship) or the [Upload Field](../fields/upload) can also set a maximum depth. If exceeded, this will limit the population depth regardless of what the depth might be on the request.
To set a max depth for a field, use the `maxDepth` property in your field configuration:

6
docs/queries/sort.mdx
View File

@@ -6,13 +6,13 @@ desc: Payload sort allows you to order your documents by a field in ascending or
keywords: query, documents, pagination, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
---
Payload `find` queries support a `sort` parameter through all APIs. Pass the `name` of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.
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.
Because sorting is handled by the database, the field you wish to sort on must be stored in the database to work; not a [virtual field](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges). It is recommended to enable indexing for the fields where sorting is used.
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>
A minus symbol ("-") before the field name will sort in descending order. Omitting the minus symbol will sort in ascending order.
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