Add notes about Doctrine performances #107

soyuka · 2016-09-07T10:02:03Z

teohhanhui · 2016-09-08T14:32:22Z

core/performance.md

+
+### Search Filter
+
+When using the `SearchFilter` and case insensivity, Doctrine will be using the `LOWER` sql function. Depending on your driver, you may want to carefully index it by using a [*function-based index*](http://use-the-index-luke.com/sql/where-clause/functions/case-insensitive-search) or it will impact performances with a huge collection.


Doctrine will use ... SQL

Also, we should probably note that function-based index alone is not enough for good performance. When using PostgreSQL for example, it's necessary to add a text_pattern_ops index, and also gin_trgm_ops (from pg_trgm). But perhaps it's out of scope... 😛

e.g.:

CREATE INDEX idx_places_name_trgm ON places USING GIN (lower(name) gin_trgm_ops); CREATE INDEX idx_places_name_pattern ON places (lower(name) text_pattern_ops);

It's out of scope (because it's Driver-dependent) but I totaly agree.

Perhaps add this link: http://use-the-index-luke.com/sql/where-clause/searching-for-ranges/like-performance-tuning

soyuka · 2016-09-08T15:00:27Z

Comments addressed thx @teohhanhui

teohhanhui · 2016-09-08T15:03:52Z

core/performance.md

+Even though we're selecting only partial results (serialized properties) with Doctrine, it'll try to hydrate some relations with lazy joins (for example `OneToOne` relations). It's recommended to take a look at the Symfony Profiler, check what the generated SQL queries are doing in background and see if those may impact performance.
+
+To force Doctrine to only hydrate partial values you need to use the [`Query::HINT_FORCE_PARTIAL_LOAD`](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/dql-doctrine-query-language.html#query-hints).
+Be careful, using this query hint will force the use of partial selects. Some properties might not be available even if you expect them. If you want to be sure that Doctrine fetches them, use Eager joins and make sure that properties are serializable.


New paragraph? Missing line break.

It's linked to the previous one, I'd keep it like this.

If you want a newline without starting a new paragraph, you need to add two trailing spaces on the previous line.

Leaving it like this is really confusing...

soyuka · 2016-09-08T15:12:38Z

I think I have to wrap lines manually? What's the limit?

teohhanhui · 2016-09-08T15:18:33Z

Yes, it's better to use hard line wrapping in Markdown (it's designed with that in mind after all). Currently I think we're going for 120 characters.

dunglas · 2016-09-21T12:48:39Z

@soyuka is this PR ready for merging?

soyuka · 2016-09-21T14:29:30Z

yes

teohhanhui · 2016-09-27T04:01:55Z

core/filters.md

@@ -23,7 +23,7 @@ The search filter supports `exact`, `partial`, `start`, `end`, and `word_start`
 * `word_start` strategy uses `LIKE text% OR LIKE % text%` to search for fields that contains the word starting with `text`.

 Prepend the letter `i` to the filter if you want it to be case insensitive. For example `ipartial` or `iexact`. Note that
-this will use the `LOWER` function and **will** impact performances if there is no [*function-based index*](http://use-the-index-luke.com/sql/where-clause/functions/case-insensitive-search).
+this will use the `LOWER` function and **will** impact performances [if there is no proper index](performance.md#search-filter).


performance (uncountable)

Still this one to fix.

teohhanhui · 2016-09-27T04:02:26Z

core/performance.md

+
+When using the `SearchFilter` and case insensivity, Doctrine will use the `LOWER` SQL function. Depending on your
+driver, you may want to carefully index it by using a [function-based
+index](http://use-the-index-luke.com/sql/where-clause/functions/case-insensitive-search) or it will impact performances


performance (uncountable)

soyuka · 2016-10-07T13:31:51Z

This one should be good to go

dunglas · 2016-10-07T14:04:11Z

core/performance.md

+[`PaginationExtension`](https://github.com/api-platform/core/blob/master/src/Bridge/Doctrine/Orm/Extension/PaginationExtension.php)
+by setting the query hint:
+
+```php


Should include <?php now.

dunglas · 2016-10-07T14:04:43Z

core/performance.md

+
+```yaml
+# app/config/services.yml
+


I'll keep the services: key to make it copy/pastable.

dunglas · 2016-10-07T14:04:59Z

core/performance.md

+To alter the `Query` object on an item data provider, we can also create an `QueryHintExtension` which will alter the result:
+
+```php
+// src/AppBundle/Doctrine/Orm/Extension/QueryHintExtension.php


Should include <?php

dunglas · 2016-10-07T14:33:46Z

core/filters.md

@@ -23,7 +23,7 @@ The search filter supports `exact`, `partial`, `start`, `end`, and `word_start`
 * `word_start` strategy uses `LIKE text% OR LIKE % text%` to search for fields that contains the word starting with `text`.

 Prepend the letter `i` to the filter if you want it to be case insensitive. For example `ipartial` or `iexact`. Note that
-this will use the `LOWER` function and **will** impact performances if there is no [*function-based index*](http://use-the-index-luke.com/sql/where-clause/functions/case-insensitive-search).
+this will use the `LOWER` function and **will** impact performances [if there is no proper index](performance.md#search-filter).


Still this one to fix.

dunglas · 2016-10-07T14:33:57Z

core/performance.md

+
+When using the `SearchFilter` and case insensivity, Doctrine will use the `LOWER` SQL function. Depending on your
+driver, you may want to carefully index it by using a [function-based
+index](http://use-the-index-luke.com/sql/where-clause/functions/case-insensitive-search) or it will impact performances


dunglas · 2016-10-07T14:34:20Z

core/performance.md

+        $this->managerRegistry = $managerRegistry;
+        $this->decorated = $decorated;
+    }
+


extra blank line

dunglas · 2016-10-07T14:34:40Z

core/performance.md

+    }
+
+    /**
+     * @inheritdoc


{@inheritdoc}

dunglas · 2016-10-07T14:34:44Z

core/performance.md

+
+
+    /**
+     * @inheritdoc


{@inheritdoc}

dunglas · 2016-10-07T14:34:58Z

core/performance.md

+use Doctrine\ORM\Tools\Pagination\Paginator as DoctrineOrmPaginator;
+use Doctrine\ORM\Query;
+
+class QueryHintPaginationExtension implements QueryResultCollectionExtensionInterface


Can you make this class final please?

dunglas · 2016-10-07T14:35:43Z

core/performance.md

+
+To force Doctrine to only hydrate partial values you need to use the
+[`Query::HINT_FORCE_PARTIAL_LOAD`](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/dql-doctrine-query-language.html#query-hints).
+  Be careful, using this query hint will force the use of partial selects. Some properties might not be available even if


Extra space to remove at the start of the line

dunglas · 2016-10-07T14:36:14Z

core/performance.md

+To force Doctrine to only hydrate partial values you need to use the
+[`Query::HINT_FORCE_PARTIAL_LOAD`](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/dql-doctrine-query-language.html#query-hints).
+  Be careful, using this query hint will force the use of partial selects. Some properties might not be available even if
+you expect them. If you want to be sure that Doctrine fetches them, use Eager joins and make sure that properties are


eager (no reason to have an uppercase E)

dunglas · 2016-10-07T14:36:55Z

core/performance.md

+    }
+
+    /**
+     * @inheritdoc


{@inheritdoc}

soyuka · 2016-10-07T15:07:38Z

thanks, updated

dunglas · 2016-10-10T11:23:08Z

Thanks @soyuka

soyuka · 2016-10-10T12:07:48Z

thanks @teohhanhui @dunglas for the review!

This was referenced Sep 7, 2016

Add notes about Doctrine performances #106

Closed

Add QueryResultItemExtensionInterface api-platform/core#737

Merged

teohhanhui reviewed Sep 8, 2016
View reviewed changes

soyuka force-pushed the soyuka-patch-1 branch 2 times, most recently from 527d43e to b0e7d7f Compare September 8, 2016 14:59

teohhanhui reviewed Sep 8, 2016
View reviewed changes

soyuka force-pushed the soyuka-patch-1 branch from b0e7d7f to 337ce4d Compare September 8, 2016 15:08

soyuka force-pushed the soyuka-patch-1 branch from 337ce4d to 0fccb27 Compare September 8, 2016 15:14

soyuka force-pushed the soyuka-patch-1 branch from 0fccb27 to 565c6ec Compare September 8, 2016 15:37

teohhanhui suggested changes Sep 27, 2016

View reviewed changes

soyuka force-pushed the soyuka-patch-1 branch 2 times, most recently from a364dfa to d794318 Compare September 27, 2016 06:20

soyuka mentioned this pull request Oct 7, 2016

Add documentation about doctrine query extensions #120

Merged

dunglas requested changes Oct 7, 2016

View reviewed changes

soyuka force-pushed the soyuka-patch-1 branch from d794318 to 7c0ab77 Compare October 7, 2016 14:13

dunglas requested changes Oct 7, 2016

View reviewed changes

Add notes about Doctrine performances

d5d7d92

soyuka force-pushed the soyuka-patch-1 branch from 7c0ab77 to d5d7d92 Compare October 7, 2016 15:06

teohhanhui approved these changes Oct 10, 2016

View reviewed changes

dunglas merged commit 58a8fc7 into api-platform:master Oct 10, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add notes about Doctrine performances #107

Add notes about Doctrine performances #107

soyuka commented Sep 7, 2016

teohhanhui Sep 8, 2016

teohhanhui Sep 8, 2016

soyuka Sep 8, 2016

teohhanhui Sep 8, 2016

soyuka commented Sep 8, 2016

teohhanhui Sep 8, 2016

soyuka Sep 8, 2016

teohhanhui Sep 8, 2016

teohhanhui Sep 8, 2016

soyuka commented Sep 8, 2016

teohhanhui commented Sep 8, 2016

dunglas commented Sep 21, 2016

soyuka commented Sep 21, 2016

teohhanhui Sep 27, 2016

dunglas Oct 7, 2016

teohhanhui Sep 27, 2016

dunglas Oct 7, 2016

soyuka commented Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

soyuka Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

dunglas Oct 7, 2016

soyuka commented Oct 7, 2016

dunglas commented Oct 10, 2016

soyuka commented Oct 10, 2016


		### Search Filter

		When using the `SearchFilter` and case insensivity, Doctrine will be using the `LOWER` sql function. Depending on your driver, you may want to carefully index it by using a [function-based index](http://use-the-index-luke.com/sql/where-clause/functions/case-insensitive-search) or it will impact performances with a huge collection.


		```yaml
		# app/config/services.yml

Add notes about Doctrine performances #107

Add notes about Doctrine performances #107

Conversation

soyuka commented Sep 7, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soyuka commented Sep 8, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soyuka commented Sep 8, 2016

teohhanhui commented Sep 8, 2016

dunglas commented Sep 21, 2016

soyuka commented Sep 21, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soyuka commented Oct 7, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soyuka commented Oct 7, 2016

dunglas commented Oct 10, 2016

soyuka commented Oct 10, 2016