mirror
/
vapor-docs
mirror of https://github.com/vapor/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove the use of `load(on:)` in relations.md (#956) 

<!-- 🚀 Thank you for contributing! -->

<!-- Describe your changes clearly and use examples if possible. -->

<!-- When this PR is merged, the title and body will be -->
<!-- used to generate a release automatically. -->

As I've noticed on a [discord
conversation](https://discord.com/channels/431917998102675485/684159753189982218/1152776938281250896),
the `load(on:)` method is discouraged to be used and should be replaced
with `get(on:)`, which defaults to cache if possible.
This commit is contained in:
Wojciech Sierotowicz 2024-01-02 17:58:39 +01:00 committed by GitHub
parent e478d998a8
commit c9dca28ada
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/fluent/relations.md
View File

@ -283,7 +283,7 @@ See [query](query.md) for more information.
## Eager Loading
Fluent's query builder allows you to preload a model's relations when it is fetched from the database. This is called eager loading and allows you to access relations synchronously without needing to call [`load`](#lazy-eager-loading) or [`get`](#get) first.
Fluent's query builder allows you to preload a model's relations when it is fetched from the database. This is called eager loading and allows you to access relations synchronously without needing to call [`get`](#get) first.
To eager load a relation, pass a key path to the relation to the `with` method on query builder.
@ -331,16 +331,23 @@ The `with` method accepts an optional closure as a second parameter. This closur
## Lazy Eager Loading
In case that you have already retrieved the parent model and you want to load one of it's relations, you can use the `load(on:)` method for that purpose. This will fetch the related model from the database and allows it to be accessed as a local property.
In case that you have already retrieved the parent model and you want to load one of it's relations, you can use the `get(reload:on:)` method for that purpose. This will fetch the related model from the database (or cache, if available) and allows it to be accessed as a local property.
```swift
planet.$star.load(on: database).map {
planet.$star.get(on: database).map {
print(planet.star.name)
}
// Or
try await planet.$star.load(on: database)
try await planet.$star.get(on: database)
print(planet.star.name)
```
In case you want to ensure that the data you receive is not pulled from cache, use the `reload:` parameter.
```swift
try await planet.$star.get(reload: true, on: database)
print(planet.star.name)
```