docs (#387)

* docs

* allow numberOfRowsNotRequiringIndex=0

* cs

Co-authored-by: Markus Staab <[email protected]>

Author: staabm

docs/query-plan-analysis.md

@@ -5,6 +5,12 @@ When enabled, `phpstan-dba` will error when queries are not using indices or que
 
 The analyzer is reporting problems related to queries not using index, full-table-scans and too many unindexed reads.
 
+## Signature
+
+`analyzeQueryPlans($numberOfAllowedUnindexedReads = true, $numberOfRowsNotRequiringIndex = QueryPlanAnalyzerMysql::DEFAULT_SMALL_TABLE_THRESHOLD)`
+
+## Examples
+
 Passing `true` will enable the feature:
 
 ```php
@@ -27,6 +33,14 @@ $config = new RuntimeConfiguration();
 $config->analyzeQueryPlans(0);
 ```
 
+When running in environments in which only the database schema, but no data is available pass `$numberOfRowsNotRequiringIndex=0`.
+
+```php
+$config = new RuntimeConfiguration();
+$config->analyzeQueryPlans(true, 0);
+```
+
+
 **Note:** For a meaningful performance analysis it is vital to utilize a database, which containts data and schema as similar as possible to the production database.
 
 **Note:** "Query Plan Analysis" requires an active database connection.

src/Analyzer/QueryPlanAnalyzerMysql.php

@@ -76,7 +76,7 @@ private function buildResult($it): QueryPlanResult
                 continue;
             }
 
-            if (null === $row['key'] && $row['rows'] > $allowedRowsNotRequiringIndex) {
+            if (null === $row['key'] && $row['rows'] >= $allowedRowsNotRequiringIndex) {
                 // derived table aka. a expression that generates a table within the scope of a query FROM clause
                 // is a temporary table, which indexes cannot be created for.
                 if ('derived' === strtolower($row['select_type'])) {
@@ -85,11 +85,11 @@ private function buildResult($it): QueryPlanResult
 
                 $result->addRow($row['table'], QueryPlanResult::NO_INDEX);
             } else {
-                if (null !== $row['type'] && 'all' === strtolower($row['type']) && $row['rows'] > $allowedRowsNotRequiringIndex) {
+                if (null !== $row['type'] && 'all' === strtolower($row['type']) && $row['rows'] >= $allowedRowsNotRequiringIndex) {
                     $result->addRow($row['table'], QueryPlanResult::TABLE_SCAN);
-                } elseif (true === $allowedUnindexedReads && $row['rows'] > self::DEFAULT_UNINDEXED_READS_THRESHOLD) {
+                } elseif (true === $allowedUnindexedReads && $row['rows'] >= self::DEFAULT_UNINDEXED_READS_THRESHOLD) {
                     $result->addRow($row['table'], QueryPlanResult::UNINDEXED_READS);
-                } elseif (\is_int($allowedUnindexedReads) && $row['rows'] > $allowedUnindexedReads) {
+                } elseif (\is_int($allowedUnindexedReads) && $row['rows'] >= $allowedUnindexedReads) {
                     $result->addRow($row['table'], QueryPlanResult::UNINDEXED_READS);
                 }
             }

src/QueryReflection/RuntimeConfiguration.php

@@ -45,7 +45,7 @@ final class RuntimeConfiguration
      */
     private $numberOfAllowedUnindexedReads = false;
     /**
-     * @var false|positive-int
+     * @var false|0|positive-int
      */
     private $numberOfRowsNotRequiringIndex = false;
 
@@ -112,7 +112,7 @@ public function stringifyTypes(bool $stringify): self
      * @param bool|0|positive-int $numberOfAllowedUnindexedReads `true` to enable analysis with QueryPlanAnalyzerMysql::DEFAULT_UNINDEXED_READS_THRESHOLD. `false` to disable analysis.
      *                                                           Otherwise the number of reads a query is allowed to execute, before it is considered inefficient.
      *                                                           `0` disables the efficiency checks but still scans for queries not using an index.
-     * @param positive-int        $numberOfRowsNotRequiringIndex number of reads a query is allowed to execute, without requiring a index
+     * @param 0|positive-int      $numberOfRowsNotRequiringIndex number of reads a query is allowed to execute, without requiring a index
      *
      * @return $this
      */
@@ -133,7 +133,7 @@ public function getNumberOfAllowedUnindexedReads()
     }
 
     /**
-     * @return false|positive-int
+     * @return false|0|positive-int
      */
     public function getNumberOfRowsNotRequiringIndex()
     {