[Docs] Configuring catalog promotions batch sizes explained

Sylius · Feb 3, 2022 · 6184d41 · 6184d41
1 parent b46a697
commit 6184d41
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/docs/cookbook/index.rst b/docs/cookbook/index.rst
@@ -76,6 +76,7 @@ Promotions
     promotions/custom-catalog-promotion-scope
     promotions/custom-catalog-promotion-action
     promotions/catalog-promotion-labels
+    promotions/catalog-promotion-performance
 
 .. include:: /cookbook/promotions/map.rst.inc
 

diff --git a/docs/cookbook/promotions/catalog-promotion-performance.rst b/docs/cookbook/promotions/catalog-promotion-performance.rst
@@ -0,0 +1,19 @@
+Catalog promotion performance
+=============================
+
+In case of looking for improving performance of processing your `catalog promotions`
+
+Change default batch size:
+--------------------------
+
+By default ``batch_size`` in Sylius is fixed at processing ``100`` variants per batch.
+In order if you want to increase or decrease it's value, you have to overwrite it.
+You can achieve that by adding to your ``_sylius.yaml`` configuration file this config with changed ``batch_size`` value:
+
+.. code-block:: yaml
+
+    sylius_core:
+        catalog_promotions:
+            batch_size: 100
+
+Then your batch size should be fixed to passed value.
diff --git a/docs/cookbook/promotions/map.rst.inc b/docs/cookbook/promotions/map.rst.inc
@@ -3,3 +3,4 @@
 * :doc:`/cookbook/promotions/custom-catalog-promotion-scope`
 * :doc:`/cookbook/promotions/custom-catalog-promotion-action`
 * :doc:`/cookbook/promotions/catalog-promotion-labels`
+* :doc:`/cookbook/promotions/catalog-promotion-performance`