feat: pgsql query plan analyzer support #479
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace staabm\PHPStanDba\Analyzer; | ||
|
|
||
| interface Analyzer | ||
| { | ||
| public function analyze(string $query): QueryPlanResult; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace staabm\PHPStanDba\Analyzer; | ||
|
|
||
| use PDO; | ||
| use PHPStan\ShouldNotHappenException; | ||
| use staabm\PHPStanDba\QueryReflection\QueryReflection; | ||
|
|
||
| final class QueryPlanAnalyzerPgSql implements Analyzer | ||
| { | ||
| /** @var PDO */ | ||
| private $connection; | ||
|
|
||
| public function __construct(PDO $connection) | ||
| { | ||
| $this->connection = $connection; | ||
| } | ||
|
|
||
| public function analyze(string $query): QueryPlanResult | ||
| { | ||
| $simulatedQuery = 'EXPLAIN (FORMAT JSON) '.$query; | ||
|
|
||
| $stmt = $this->connection->query($simulatedQuery); | ||
|
|
||
| return $this->buildResult($simulatedQuery, $stmt); | ||
| } | ||
|
|
||
| /** @param \PDOStatement<array<float|int|string|null>> $stmt */ | ||
| private static function buildResult(string $simulatedQuery, $stmt): QueryPlanResult | ||
| { | ||
| $allowedUnindexedReads = QueryReflection::getRuntimeConfiguration()->getNumberOfAllowedUnindexedReads(); | ||
| if (false === $allowedUnindexedReads) { | ||
| throw new ShouldNotHappenException(); | ||
| } | ||
|
|
||
| $allowedRowsNotRequiringIndex = QueryReflection::getRuntimeConfiguration()->getNumberOfRowsNotRequiringIndex(); | ||
| if (false === $allowedRowsNotRequiringIndex) { | ||
| throw new ShouldNotHappenException(); | ||
| } | ||
|
|
||
| $queryPlanResult = new QueryPlanResult($simulatedQuery); | ||
| $result = $stmt->fetch(); | ||
| $queryPlans = \is_array($result) && \array_key_exists('QUERY PLAN', $result) | ||
| ? json_decode($result['QUERY PLAN'], true) | ||
| : []; | ||
| \assert(\is_array($queryPlans)); | ||
| foreach ($queryPlans as $queryPlan) { | ||
| $plan = $queryPlan['Plan']; | ||
| $table = $plan['Alias'] ?? null; | ||
|
|
||
| if (null === $table) { | ||
| continue; | ||
| } | ||
|
|
||
| $rowReads = $plan['Plan Rows']; | ||
| $nodeType = $plan['Node Type']; | ||
| if ('Seq Scan' === $nodeType && $rowReads >= $allowedRowsNotRequiringIndex) { | ||
| $queryPlanResult->addRow($table, QueryPlanResult::ROW_SEQ_SCAN); | ||
| } | ||
| if ('Bitmap Heap Scan' === $nodeType) { | ||
| $queryPlanResult->addRow($table, QueryPlanResult::ROW_BITMAP_HEAP_SCAN); | ||
| } | ||
| if ('Bitmap Index Scan' === $nodeType) { | ||
| $queryPlanResult->addRow($table, QueryPlanResult::ROW_BITMAP_INDEX_SCAN); | ||
| } | ||
| if ('Index Scan' === $nodeType) { | ||
| $queryPlanResult->addRow($table, QueryPlanResult::ROW_INDEX_SCAN); | ||
| } | ||
| if ('Aggregate' === $nodeType) { | ||
| $queryPlanResult->addRow($table, QueryPlanResult::ROW_AGGREGATE); | ||
| } | ||
| if ('Hash Aggregate' === $nodeType) { | ||
| $queryPlanResult->addRow($table, QueryPlanResult::ROW_HASH_AGGREGATE); | ||
| } | ||
| } | ||
|
|
||
| return $queryPlanResult; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
renaming existing constants is a BC break. Please leave the old ones additionally in and mark them as deprecated