Skip to content

Add documentation for eager loading #147

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

Merged

Simperfit merged 2 commits into api-platform:master from meyerbaptiste:add_eager_loading_doc

Nov 18, 2016

Merged

Add documentation for eager loading #147

Simperfit merged 2 commits into api-platform:master from meyerbaptiste:add_eager_loading_doc

Nov 18, 2016

Conversation

Copy link

Member

@meyerbaptiste meyerbaptiste commented Nov 17, 2016

No description provided.

dunglas approved these changes

View reviewed changes

Simperfit reviewed

View reviewed changes

core/performance.md

#### Eager loading

By default Doctrine comes with [lazy loading](http://doctrine-orm.readthedocs.io/en/latest/reference/working-with-objects.html#by-lazy-loading).

Usually a killer time-saving feature and also a performance killer with large applications.

Copy link

Contributor

@Simperfit Simperfit Nov 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't that a little bit informal ?

Copy link

Member

@dunglas dunglas Nov 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this statement.

Copy link

Member

@soyuka soyuka Nov 18, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

haha I do agree too, this feature should give more warning than it actually does

core/performance.md Outdated

# ...

```

Be careful when you exceed your limit, it's often the result of circular references. The use of [serializer groups](serialization-groups-and-relations.md)

Copy link

Contributor

@Simperfit Simperfit Nov 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Be careful when you exceed this limit, it's often caused by the result of a circular reference. [Serializer groups](serialization-groups-and-relations.md) can be a good solution to fix this issue

core/performance.md Outdated

##### Force eager

As mentioned above, by default we force eager loading for all relations. This behaviour can be modified in the

Copy link

Contributor

@Simperfit Simperfit Nov 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This behaviour can be modified with the configuration in order to apply it only on join relations having the ...

Copy link

Contributor

@Simperfit Simperfit Nov 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this can still be better

core/performance.md Outdated

##### Override at resource and operation level

When eager loading is enabled, whatever the status of the `force_eager` parameter, you can easily override it directly

from the configuration of each resource. For now, you can do this at the resource level, at the operations level, or both:

Copy link

Contributor

@Simperfit Simperfit Nov 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You say that there will be more way to do this, but you are not saying what will be next. IMO you don't need to say For now.

@meyerbaptiste meyerbaptiste force-pushed the add_eager_loading_doc branch from d5b37c6 to 3216e63 Compare

November 17, 2016 14:35

Simperfit approved these changes

View reviewed changes

soyuka approved these changes

View reviewed changes

Copy link

Member

soyuka commented Nov 18, 2016

We may want to remove my part on performances as it's not right anymore because there are no partial select anymore https://github.com/meyerbaptiste/doc/blob/3216e636ec21917790456d9a2554edb96bed865c/core/performance.md#unserialized-properties-hydratation.

meyerbaptiste added 2 commits

November 18, 2016 10:59


 Add documentation for eager loading

6f0407d


 Remove the query hint section

c10f7c3

@meyerbaptiste meyerbaptiste force-pushed the add_eager_loading_doc branch from 5c52bc1 to c10f7c3 Compare

November 18, 2016 09:59

Copy link

Member Author

meyerbaptiste commented Nov 18, 2016

Copy link

Contributor

Simperfit commented Nov 18, 2016

Thanks @meyerbaptiste

@Simperfit Simperfit merged commit f56f4e1 into api-platform:master

@meyerbaptiste meyerbaptiste deleted the add_eager_loading_doc branch

November 18, 2016 14:13

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants

@meyerbaptiste @soyuka @Simperfit @dunglas