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

Jump to bottom

[Documentation] Note about changes related to upgrade to GridBundle 1.10 #12881

Merged
merged 2 commits into from
Aug 18, 2021
Merged

[Documentation] Note about changes related to upgrade to GridBundle 1.10 #12881

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e489775
docs about fetch join collection and output walkers
AdamKasp Aug 12, 2021
d70f712
[Documentation] Improve note about disabling pagination optioons
GSadee Aug 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
231 changes: 231 additions & 0 deletions docs/customization/grid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,237 @@ After these two steps your admin product grid should not have the image field.

.. include:: /customization/plugins.rst.inc

Changes related to upgrade to GridBundle 1.10
---------------------------------------------

In SyliusGridBundle all grids has options `fetch_join_collection` and `use_output_walkers` enabled by default.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
In SyliusGridBundle all grids has options `fetch_join_collection` and `use_output_walkers` enabled by default.
Since the SyliusGridBundle v1.10, all grids has options `fetch_join_collection` and `use_output_walkers` enabled by default.

According to our research it may fix a lot of pagination issues and improve big-database performance (1M+ rows) up to 70%,
but with the price of more queries required to be performed. If this trade-off is not worth it for you,
you may disable it by using the following configuration snippet:

.. code-block:: yaml

# config/packages/_sylius.yaml
sylius_grid:
grids:
sylius_admin_address_log_entry:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_admin_user:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_channel:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_country:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_currency:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_customer:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_customer_group:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_customer_order:
extends: sylius_admin_order
driver:
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_exchange_rate:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_inventory:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_locale:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_order:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_payment:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_payment_method:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_product:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_product_association_type:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_product_attribute:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_product_option:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_product_review:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_product_variant:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_promotion:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_promotion_coupon:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_shipment:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_shipping_category:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_shipping_method:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_tax_category:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_tax_rate:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_taxon:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_admin_zone:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_shop_account_order:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false
sylius_shop_product:
driver:
name: doctrine/orm
options:
pagination:
fetch_join_collection: false
use_output_walkers: false

Learn more
----------

Expand Down