container = $container; } /** * Renders the profiler panel for the given token. * * @param string $token The profiler token * @param string $connectionName * @param int $query * * @return Response A Response instance */ public function explainAction($token, $connectionName, $query) { $profiler = $this->container->get('profiler'); assert($profiler instanceof Profiler); $profiler->disable(); $profile = $profiler->loadProfile($token); $collector = $profile->getCollector('db'); assert($collector instanceof DoctrineDataCollector); $queries = $collector->getQueries(); if (! isset($queries[$connectionName][$query])) { return new Response('This query does not exist.'); } $query = $queries[$connectionName][$query]; if (! $query['explainable']) { return new Response('This query cannot be explained.'); } $connection = $this->container->get('doctrine')->getConnection($connectionName); assert($connection instanceof Connection); try { $platform = $connection->getDatabasePlatform(); if ($platform instanceof SqlitePlatform) { $results = $this->explainSQLitePlatform($connection, $query); } elseif ($platform instanceof SQLServerPlatform) { $results = $this->explainSQLServerPlatform($connection, $query); } elseif ($platform instanceof OraclePlatform) { $results = $this->explainOraclePlatform($connection, $query); } else { $results = $this->explainOtherPlatform($connection, $query); } } catch (Throwable $e) { return new Response('This query cannot be explained.'); } return new Response($this->container->get('twig')->render('@Doctrine/Collector/explain.html.twig', [ 'data' => $results, 'query' => $query, ])); } /** * @param mixed[] $query * * @return mixed[] */ private function explainSQLitePlatform(Connection $connection, array $query): array { $params = $query['params']; if ($params instanceof Data) { $params = $params->getValue(true); } return $connection->executeQuery('EXPLAIN QUERY PLAN ' . $query['sql'], $params, $query['types']) ->fetchAll(PDO::FETCH_ASSOC); } /** * @param mixed[] $query * * @return mixed[] */ private function explainSQLServerPlatform(Connection $connection, array $query): array { if (stripos($query['sql'], 'SELECT') === 0) { $sql = 'SET STATISTICS PROFILE ON; ' . $query['sql'] . '; SET STATISTICS PROFILE OFF;'; } else { $sql = 'SET SHOWPLAN_TEXT ON; GO; SET NOEXEC ON; ' . $query['sql'] . '; SET NOEXEC OFF; GO; SET SHOWPLAN_TEXT OFF;'; } $params = $query['params']; if ($params instanceof Data) { $params = $params->getValue(true); } $stmt = $connection->executeQuery($sql, $params, $query['types']); // DBAL 2.13 "forward compatibility" BC break handling if ($stmt instanceof Result) { $stmt = $stmt->getIterator(); } if (! $stmt instanceof PDOStatement) { throw new LogicException('We need nextRowSet() functionality feature, which is not available with current DBAL driver'); } $stmt->nextRowset(); return $stmt->fetchAll(PDO::FETCH_ASSOC); } /** * @param mixed[] $query * * @return mixed[] */ private function explainOtherPlatform(Connection $connection, array $query): array { $params = $query['params']; if ($params instanceof Data) { $params = $params->getValue(true); } return $connection->executeQuery('EXPLAIN ' . $query['sql'], $params, $query['types']) ->fetchAll(PDO::FETCH_ASSOC); } /** * @param mixed[] $query * * @return mixed[] */ private function explainOraclePlatform(Connection $connection, array $query): array { $connection->executeQuery('EXPLAIN PLAN FOR ' . $query['sql']); return $connection->executeQuery('SELECT * FROM TABLE(DBMS_XPLAN.DISPLAY())') ->fetchAll(PDO::FETCH_ASSOC); } }