Doktryna - jak wydrukować prawdziwy sql, a nie tylko przygotowaną instrukcję?

Używamy Doctrine, PHP ORM. Tworzę takie zapytanie:

$q = Doctrine_Query::create()->select('id')->from('MyTable');

a następnie w funkcji dodaję różne klauzule Where i inne odpowiednie rzeczy, jak to

$q->where('normalisedname = ? OR name = ?', array($string, $originalString));

Później, przed wykonaniem execute()tego obiektu zapytania, chcę wydrukować nieprzetworzony kod SQL, aby go zbadać, i zrobić to:

$q->getSQLQuery();

Jednak powoduje to wydrukowanie tylko przygotowanej instrukcji, a nie całego zapytania. Chcę zobaczyć, co wysyła do MySQL, ale zamiast tego wypisuje przygotowane zestawienie, w tym ?'s. Czy istnieje sposób, aby wyświetlić „pełne” zapytanie?

Doctrine nie wysyła "prawdziwego zapytania SQL" do serwera bazy danych: w rzeczywistości używa przygotowanych instrukcji, co oznacza:

• Wysłanie wyciągu w celu jego sporządzenia (to jest zwracane przez $query->getSql())
• A następnie wysłanie parametrów (zwróconych przez $query->getParameters())
• i wykonanie przygotowanych instrukcji

Oznacza to, że po stronie PHP nigdy nie ma „prawdziwego” zapytania SQL - więc Doctrine nie może go wyświetlić.

Działający przykład:

$qb = $this->createQueryBuilder('a');
$query=$qb->getQuery();
// SHOW SQL: 
echo $query->getSQL(); 
// Show Parameters: 
echo $query->getParameters();

Możesz sprawdzić zapytanie wykonane przez Twoją aplikację, jeśli rejestrujesz wszystkie zapytania w mysql:

http://dev.mysql.com/doc/refman/5.1/en/query-log.html

będzie więcej zapytań nie tylko tego, którego szukasz, ale możesz go grepować.

ale zwykle ->getSql();działa

Edytować:

aby wyświetlić wszystkie zapytania mysql, których używam

sudo vim /etc/mysql/my.cnf 

i dodaj te 2 wiersze:

general_log = on
general_log_file = /tmp/mysql.log

i zrestartuj mysql

Stworzyłem Doctrine2 Logger, który robi dokładnie to. "Hydratuje" sparametryzowane zapytanie sql wartościami przy użyciu własnych konwerterów typu danych Doctrine 2.

<?php


namespace Drsm\Doctrine\DBAL\Logging;
use Doctrine\DBAL\Logging\SQLLogger,
    Doctrine\DBAL\Types\Type,
    Doctrine\DBAL\Platforms\AbstractPlatform;
/**
 * A SQL logger that logs to the standard output and
 * subtitutes params to get a ready to execute SQL sentence

 * @author  [email protected]
 */
class EchoWriteSQLWithoutParamsLogger implements SQLLogger

{
    const QUERY_TYPE_SELECT="SELECT";
    const QUERY_TYPE_UPDATE="UPDATE";
    const QUERY_TYPE_INSERT="INSERT";
    const QUERY_TYPE_DELETE="DELETE";
    const QUERY_TYPE_CREATE="CREATE";
    const QUERY_TYPE_ALTER="ALTER";

    private $dbPlatform;
    private $loggedQueryTypes;
    public function __construct(AbstractPlatform $dbPlatform, array $loggedQueryTypes=array()){
        $this->dbPlatform=$dbPlatform;
        $this->loggedQueryTypes=$loggedQueryTypes;
    }
    /**
     * {@inheritdoc}
     */
    public function startQuery($sql, array $params = null, array $types = null)

    {
        if($this->isLoggable($sql)){
            if(!empty($params)){
                foreach ($params as $key=>$param) {
                    $type=Type::getType($types[$key]);
                    $value=$type->convertToDatabaseValue($param,$this->dbPlatform);
                    $sql = join(var_export($value, true), explode('?', $sql, 2));
                }

            }
            echo $sql . " ;".PHP_EOL;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function stopQuery()
    {

    }
    private function isLoggable($sql){
        if (empty($this->loggedQueryTypes)) return true;
        foreach($this->loggedQueryTypes as $validType){
            if (strpos($sql, $validType) === 0) return true;
        }
        return false;
    }
}

Przykład użycia :; Poniższy spokój kodu odbija się echem na standardowym wyjściu wszystkich zdań SQL INSERT, UPDATE, DELETE wygenerowanych za pomocą $ em Entity Manager,

/**@var  \Doctrine\ORM\EntityManager $em */
$em->getConnection()
                ->getConfiguration()
                ->setSQLLogger(
                    new EchoWriteSQLWithoutParamsLogger(
                        $em->getConnection()->getDatabasePlatform(),
                        array(
                            EchoWriteSQLWithoutParamsLogger::QUERY_TYPE_UPDATE,
                            EchoWriteSQLWithoutParamsLogger::QUERY_TYPE_INSERT,
                            EchoWriteSQLWithoutParamsLogger::QUERY_TYPE_DELETE
                        )
                    )
                );

getSqlQuery() technicznie pokazuje całe polecenie SQL, ale jest o wiele bardziej przydatne, gdy można również zobaczyć parametry.

echo $q->getSqlQuery();
foreach ($q->getFlattenedParams() as $index => $param)
  echo "$index => $param";

Aby uczynić ten wzorzec łatwiejszym do ponownego użycia, w komentarzach w Raw SQL z Doctrine Query Object opisano przyjemne podejście .

Nie ma innego prawdziwego zapytania, tak działają przygotowane zestawienia. Wartości są powiązane na serwerze bazy danych, a nie w warstwie aplikacji.

Zobacz moją odpowiedź na to pytanie: Jak w PHP z PDO sprawdzić ostateczne sparametryzowane zapytanie SQL?

(Powtórzono tutaj dla wygody :)

Używanie przygotowanych instrukcji ze sparametryzowanymi wartościami nie jest po prostu kolejnym sposobem na dynamiczne tworzenie łańcucha SQL. Tworzysz przygotowaną instrukcję w bazie danych, a następnie wysyłasz same wartości parametrów.

Więc to, co prawdopodobnie zostanie wysłane do bazy danych, będzie PREPARE ..., SET ...i na końcuEXECUTE ....

Nie będziesz w stanie uzyskać takiego ciągu SQL SELECT * FROM ..., nawet jeśli dałoby to równoważne wyniki, ponieważ żadne takie zapytanie nigdy nie zostało wysłane do bazy danych.

Moje rozwiązanie:

 /**
 * Get SQL from query
 * 
 * @author Yosef Kaminskyi 
 * @param QueryBilderDql $query
 * @return int
 */
public function getFullSQL($query)
{
    $sql = $query->getSql();
    $paramsList = $this->getListParamsByDql($query->getDql());
    $paramsArr =$this->getParamsArray($query->getParameters());
    $fullSql='';
    for($i=0;$i<strlen($sql);$i++){
        if($sql[$i]=='?'){
            $nameParam=array_shift($paramsList);

            if(is_string ($paramsArr[$nameParam])){
                $fullSql.= '"'.addslashes($paramsArr[$nameParam]).'"';
             }
            elseif(is_array($paramsArr[$nameParam])){
                $sqlArr='';
                foreach ($paramsArr[$nameParam] as $var){
                    if(!empty($sqlArr))
                        $sqlArr.=',';

                    if(is_string($var)){
                        $sqlArr.='"'.addslashes($var).'"';
                    }else
                        $sqlArr.=$var;
                }
                $fullSql.=$sqlArr;
            }elseif(is_object($paramsArr[$nameParam])){
                switch(get_class($paramsArr[$nameParam])){
                    case 'DateTime':
                             $fullSql.= "'".$paramsArr[$nameParam]->format('Y-m-d H:i:s')."'";
                          break;
                    default:
                        $fullSql.= $paramsArr[$nameParam]->getId();
                }

            }
            else                     
                $fullSql.= $paramsArr[$nameParam];

        }  else {
            $fullSql.=$sql[$i];
        }
    }
    return $fullSql;
}

 /**
 * Get query params list
 * 
 * @author Yosef Kaminskyi <[email protected]>
 * @param  Doctrine\ORM\Query\Parameter $paramObj
 * @return int
 */
protected function getParamsArray($paramObj)
{
    $parameters=array();
    foreach ($paramObj as $val){
        /* @var $val Doctrine\ORM\Query\Parameter */
        $parameters[$val->getName()]=$val->getValue();
    }

    return $parameters;
}
 public function getListParamsByDql($dql)
{
    $parsedDql = preg_split("/:/", $dql);
    $length = count($parsedDql);
    $parmeters = array();
    for($i=1;$i<$length;$i++){
        if(ctype_alpha($parsedDql[$i][0])){
            $param = (preg_split("/[' ' )]/", $parsedDql[$i]));
            $parmeters[] = $param[0];
        }
    }

    return $parmeters;}

Przykład użycia:

$query = $this->_entityRepository->createQueryBuilder('item');
$query->leftJoin('item.receptionUser','users');
$query->where('item.customerid = :customer')->setParameter('customer',$customer)
->andWhere('item.paymentmethod = :paymethod')->setParameter('paymethod',"Bonus");
echo $this->getFullSQL($query->getQuery());

Możesz łatwo uzyskać dostęp do parametrów SQL, korzystając z następującego podejścia.

   $result = $qb->getQuery()->getSQL();

   $param_values = '';  
   $col_names = '';   

   foreach ($result->getParameters() as $index => $param){              
            $param_values .= $param->getValue().',';
            $col_names .= $param->getName().',';
   } 

   //echo rtrim($param_values,',');
   //echo rtrim($col_names,',');    

Więc jeśli wydrukowałeś $param_valuesi $col_names, możesz uzyskać wartości parametrów przechodzące przez sql i nazwy odpowiednich kolumn.

Uwaga: Jeśli $paramzwraca tablicę, musisz powtórzyć iterację, ponieważ parametry w środku IN (:?)zwykle pojawiają się jako tablica zagnieżdżona.

W międzyczasie, jeśli znalazłeś inne podejście, prosimy o podzielenie się z nami :)

Dziękuję Ci!

Bardziej przejrzyste rozwiązanie:

 /**
 * Get string query 
 * 
 * @param Doctrine_Query $query
 * @return string
 */
public function getDqlWithParams(Doctrine_Query $query){
    $vals = $query->getFlattenedParams();
    $sql = $query->getDql();
    $sql = str_replace('?', '%s', $sql);
    return vsprintf($sql, $vals);
}

Solution:1
====================================================================================

function showQuery($query)
{
    return sprintf(str_replace('?', '%s', $query->getSql()), $query->getParams());
}

// call function  
echo showQuery($doctrineQuery);

Solution:2
====================================================================================

function showQuery($query)
{
    // define vars              
    $output    = NULL;
    $out_query = $query->getSql();
    $out_param = $query->getParams();

    // replace params
   for($i=0; $i<strlen($out_query); $i++) {
       $output .= ( strpos($out_query[$i], '?') !== FALSE ) ? "'" .str_replace('?', array_shift($out_param), $out_query[$i]). "'" : $out_query[$i];
   }

   // output
   return sprintf("%s", $output);
}

// call function  
echo showQuery($doctrineQueryObject);

Możesz użyć :

$query->getSQL();

Jeśli używasz MySQL, możesz użyć Workbench do przeglądania uruchomionych instrukcji SQL. Możesz również użyć widoku uruchomionego zapytania z mysql, używając następujących poleceń:

 SHOW FULL PROCESSLIST \G

Może komuś się przyda:

// Printing the SQL with real values
$vals = $query->getFlattenedParams();
foreach(explode('?', $query->getSqlQuery()) as $i => $part) {
    $sql = (isset($sql) ? $sql : null) . $part;
    if (isset($vals[$i])) $sql .= $vals[$i];
}

echo $sql;

TL; DR

$qb = ... // your query builder
$query = $qb->getQuery();
// temporarily enable logging for your query (will also work in prod env)
$conf = $query->getEntityManager()->getConnection()->getConfiguration();
$backupLogger = $conf->getSQLLogger();
$logger = new \Doctrine\DBAL\Logging\DebugStack();
$conf->setSQLLogger($logger);
// execute query
$res = $query->getResult();
$conf->setSQLLogger($backupLogger); //restore logger for other queries
$params = [
  'query' => array_pop($logger->queries) //extract query log details
  //your other twig params here...
]
return $params; //send this to your twig template...

w swoich plikach twig użyj filtrów pomocników gałązek Doctrine:

// show raw query:
{{ (query.sql ~ ';')|doctrine_replace_query_parameters(query.params)
// highlighted
{{ (query.sql ~ ';')|doctrine_replace_query_parameters(query.params)|doctrine_pretty_query(highlight_only = true) }}
// highlighted and formatted (i.e. with tabs and newlines)
{{ (query.sql ~ ';')|doctrine_replace_query_parameters(query.params)|doctrine_pretty_query }}

Wyjaśnienie:

Inne odpowiedzi, w których wspomina się, że Prepared statement są w rzeczywistości „prawdziwymi zapytaniami”, są prawidłowe, ale nie odpowiadają oczywistym oczekiwaniom pytającego ... Każdy programista chce wyświetlić „wykonalne zapytanie” w celu debugowania (lub wyświetlenia go użytkownikowi) .

Więc przejrzałem źródła profilera Symfony, aby zobaczyć, jak to robią. Za część Doctrine odpowiada Doctrine, więc stworzyli pakiet doktryn do integracji z Symfony. Rzucając okiem nadoctrine-bundle/Resources/views/Collector/db.html.twig plik, dowiesz się, jak to robią (może się to zmienić w różnych wersjach). Co ciekawe, stworzyli filtry gałązkowe, których możemy użyć ponownie (patrz wyżej).

Aby wszystko działało, musimy włączyć rejestrowanie dla naszego zapytania. Można to zrobić na wiele sposobów i tutaj używam DebugStack, który pozwala rejestrować zapytania bez ich drukowania. Zapewnia to również, że będzie działać w trybie produkcyjnym, jeśli tego potrzebujesz ...

Jeśli potrzebujesz dalszego formatowania, zobaczysz, że zawierają one CSS w tagu stylu, więc po prostu go „ukradnij” ^^:

.highlight pre { margin: 0; white-space: pre-wrap; }
.highlight .keyword   { color: #8959A8; font-weight: bold; }
.highlight .word      { color: #222222; }
.highlight .variable  { color: #916319; }
.highlight .symbol    { color: #222222; }
.highlight .comment   { color: #999999; }
.highlight .backtick  { color: #718C00; }
.highlight .string    { color: #718C00; }
.highlight .number    { color: #F5871F; font-weight: bold; }
.highlight .error     { color: #C82829; }

Mam nadzieję, że to pomoże ;-)

Napisałem prosty logger, który może logować zapytanie z wstawionymi parametrami. Instalacja:

composer require cmyker/doctrine-sql-logger:dev-master

Stosowanie:

$connection = $this->getEntityManager()->getConnection(); 
$logger = new \Cmyker\DoctrineSqlLogger\Logger($connection);
$connection->getConfiguration()->setSQLLogger($logger);
//some query here
echo $logger->lastQuery;

$sql = $query->getSQL();

$parameters = [];
    foreach ($query->getParameters() as $parameter) {
        $parameters[] = $parameter->getValue();
    }

$result = $connection->executeQuery($sql, $parameters)
        ->fetchAll();

Zmodyfikowano funkcję @dsamblas, aby działała, gdy parametry są ciągami dat, takimi jak „2019-01-01”, i gdy jest przekazywana tablica przy użyciu IN, takich jak

$qb->expr()->in('ps.code', ':activeCodes'),

. Zrób więc wszystko, co napisał dsamblas, ale zamień startQuery na ten lub zobacz różnice i dodaj mój kod. (w przypadku, gdy zmodyfikował coś w swojej funkcji, a moja wersja nie ma modyfikacji).

public function startQuery($sql, array $params = null, array $types = null)

{
    if($this->isLoggable($sql)){
        if(!empty($params)){
            foreach ($params as $key=>$param) {

                try {
                    $type=Type::getType($types[$key]);
                    $value=$type->convertToDatabaseValue($param,$this->dbPlatform);
                } catch (Exception $e) {
                    if (is_array($param)) {
                        // connect arrays like ("A", "R", "C") for SQL IN
                        $value = '"' . implode('","', $param) . '"';
                    } else {
                        $value = $param; // case when there are date strings
                    }
                }

                $sql = join(var_export($value, true), explode('?', $sql, 2));
            }

        }
        echo $sql . " ;".PHP_EOL;
    }
}

Nie testowałem dużo.

Zrobiłem trochę badań na ten temat, ponieważ chciałem zdebugować wygenerowane zapytanie SQL i wykonać je w edytorze sql. Jak widać we wszystkich odpowiedziach, jest to temat wysoce techniczny.

Kiedy zakładam, że początkowe pytanie opiera się na dev-env, w tej chwili brakuje jednej, bardzo prostej odpowiedzi. Możesz po prostu użyć kompilacji w profilerze Symfony. Po prostu kliknij kartę Doctrine, przewiń do zapytania, które chcesz sprawdzić. Następnie kliknij „wyświetl zapytanie do wykonania” i możesz wkleić zapytanie bezpośrednio w edytorze SQL

Bardziej podstawowe podejście do interfejsu użytkownika, ale bardzo szybkie i bez obciążenia związanego z debugowaniem kodu.

$sql = $query->getSQL();
$obj->mapDQLParametersNamesToSQL($query->getDQL(), $sql);
echo $sql;//to see parameters names in sql
$obj->mapDQLParametersValuesToSQL($query->getParameters(), $sql);
echo $sql;//to see parameters values in sql

public function mapDQLParametersNamesToSQL($dql, &$sql)
{
    $matches = [];
    $parameterNamePattern = '/:\w+/';
    /** Found parameter names in DQL */
    preg_match_all($parameterNamePattern, $dql, $matches);
    if (empty($matches[0])) {
        return;
    }
    $needle = '?';
    foreach ($matches[0] as $match) {
        $strPos = strpos($sql, $needle);
        if ($strPos !== false) {
            /** Paste parameter names in SQL */
            $sql = substr_replace($sql, $match, $strPos, strlen($needle));
        }
    }
}

public function mapDQLParametersValuesToSQL($parameters, &$sql)
{
    $matches = [];
    $parameterNamePattern = '/:\w+/';
    /** Found parameter names in SQL */
    preg_match_all($parameterNamePattern, $sql, $matches);
    if (empty($matches[0])) {
        return;
    }
    foreach ($matches[0] as $parameterName) {
        $strPos = strpos($sql, $parameterName);
        if ($strPos !== false) {
            foreach ($parameters as $parameter) {
                /** @var \Doctrine\ORM\Query\Parameter $parameter */
                if ($parameterName !== ':' . $parameter->getName()) {
                    continue;
                }
                $parameterValue = $parameter->getValue();
                if (is_string($parameterValue)) {
                    $parameterValue = "'$parameterValue'";
                }
                if (is_array($parameterValue)) {
                    foreach ($parameterValue as $key => $value) {
                        if (is_string($value)) {
                            $parameterValue[$key] = "'$value'";
                        }
                    }
                    $parameterValue = implode(', ', $parameterValue);
                }
                /** Paste parameter values in SQL */
                $sql = substr_replace($sql, $parameterValue, $strPos, strlen($parameterName));
            }
        }
    }
}

Aby wydrukować zapytanie SQL w Doctrine, użyj:

$query->getResult()->getSql();