Described disabling counting the results (#3180)

* Described disabling counting the results

* Fixed link

* Update docs/search/search_api.md

Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>

---------

Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>

Author: mnocon

code_samples/api/public_php_api/src/perform_count.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types=1);
+
+use Ibexa\Contracts\Core\Repository\Values\Content\LocationQuery;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query;
+
+/** @var \Ibexa\Contracts\Core\Repository\SearchService $searchService */
+
+// For location searches
+$locationQuery = new LocationQuery();
+$locationQuery->performCount = false;
+
+$locationResult = $searchService->findLocations($locationQuery);
+
+// For content searches
+$contentQuery = new Query();
+$contentQuery->performCount = false;
+
+$contentResult = $searchService->findContent($contentQuery);

docs/search/search_api.md

@@ -61,6 +61,19 @@ $output->writeln($result->getName());
     $query->limit = 100;
     ```
 
+#### Disable result count
+
+By default, a search query also counts all matching results.
+If you don't need the total count, set `performCount` to `false` on [`Query`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Query.html) or [`LocationQuery`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-LocationQuery.html) to improve performance, especially for large result sets.
+
+``` php
+[[= include_code('code_samples/api/public_php_api/src/perform_count.php', 8, 10) =]]
+
+[[= include_code('code_samples/api/public_php_api/src/perform_count.php', 14, 16) =]]
+```
+
+When `performCount` is set to `false`, `$result->totalCount` is `null`.
+
 #### Search with `query` and `filter`
 
 You can use two properties of the `Query` object to search for content: `query` and `filter`.