Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: warn when using defaultPopulate on collections with uploads enabled #10138

Merged
merged 3 commits into from
Jan 2, 2025
Merged

docs: warn when using defaultPopulate on collections with uploads enabled #10138

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e9fbfd
docs: warn when using `defaultPopulate` on collections with an upload…
PlagueFPS Dec 23, 2024
db6ab70
Merge pull request #1 from PlagueFPS/PlagueFPS-patch-1
PlagueFPS Dec 23, 2024
0c8f55d
more clear wording
r1tsuu Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/queries/select.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,11 @@ export const Pages: CollectionConfig<'pages'> = {
}
```

<Banner type="warning">
<strong>Important:</strong>
When using `defaultPopulate` on a collection with [Uploads](/docs/fields/upload) enabled and you want to select the `url` field, it is important to specify `filename: true` as well, otherwise Payload will not be able to construct the correct file URL, instead returning `url: null`.
</Banner>

## populate

Setting `defaultPopulate` will enforce that each time Payload performs a "population" of a related document, only the fields specified will be queried and returned. However, you can override `defaultPopulate` with the `populate` property in the Local and REST API:
Expand Down