Доктрина - Як роздрукувати реальний sql, а не лише підготовлену заяву?

Ми використовуємо Doctrine, PHP ORM. Я створюю такий запит:

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

а потім у функції, яку я додаю в різні пункти та речі, як це доречно, як це

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

Пізніше, перед тим, як execute()ввести цей об’єкт запиту, я хочу роздрукувати необроблений SQL для того, щоб його вивчити, і зробити це:

$q->getSQLQuery();

Однак це видає лише підготовлене твердження, а не повний запит. Я хочу побачити, що він надсилає до MySQL, але замість цього він роздруковує підготовлену операцію, включаючи ?s. Чи є спосіб побачити "повний" запит?

Доктрина не посилає "реальний запит SQL" на сервер бази даних: він фактично використовує підготовлені оператори, що означає:

• Надсилання заяви, щоб вона була підготовлена ​​(це те, що повертається $query->getSql())
• А потім, надсилаючи параметри (повертається $query->getParameters())
• та виконання підготовлених заяв

Це означає, що ніколи не існує "справжнього" SQL запиту на стороні PHP - тому Doctrine не може його відображати.

Робочий приклад:

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

Ви можете перевірити запит, виконаний вашим додатком, якщо ви записуєте всі запити в mysql:

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

буде більше запитів, не тільки тих, які ви шукаєте, але ви зможете відповісти за них.

але зазвичай ->getSql();працює

Редагувати:

для перегляду всіх запитів mysql, які я використовую

sudo vim /etc/mysql/my.cnf 

і додайте ці 2 рядки:

general_log = on
general_log_file = /tmp/mysql.log

і перезапустити mysql

Я створив Doctrine2 Logger, який робить саме це. Він "гідратує" параметризований запит sql зі значеннями, використовуючи власні перетворювачі типу даних 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  dsamblas@gmail.com
 */
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;
    }
}

Приклад використання:; Наступний мир коду буде перегукуватися на стандартному виході будь-яких пропозицій INSERT, UPDATE, DELETE SQL, згенерованих за допомогою $ 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() технічно показує всю команду SQL, але це набагато корисніше, коли ви також можете бачити параметри.

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

Щоб зробити цю модель більш багаторазовою, є приємний підхід, описаний в коментарях на Raw SQL від Doctrine Query Object .

Іншого реального запиту немає, саме так працюють підготовлені заяви. Значення пов'язані на сервері баз даних, а не на рівні додатків.

Дивіться мою відповідь на це питання: У PHP з PDO, як перевірити остаточний параметризований SQL запит?

(Повторюємось тут для зручності :)

Використання підготовлених операторів із параметрами параметризованих значень - це не просто інший спосіб динамічного створення рядка SQL. Ви створюєте готову операцію в базі даних, а потім надсилаєте значення параметрів самостійно.

Тож те, що, ймовірно, відправляється в базу даних, буде PREPARE ...потім, SET ...і нарештіEXECUTE ....

Ви не зможете отримати такий зразок SQL SELECT * FROM ..., навіть якщо це дасть еквівалентні результати, тому що жоден такий запит ніколи не надсилався до бази даних.

Моє рішення:

 /**
 * 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 <yosefk@spotoption.com>
 * @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;}

Приклад використання:

$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());

Ви можете легко отримати доступ до параметрів SQL, використовуючи наступний підхід.

   $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,',');    

Отже, якщо ви роздрукували $param_valuesі $col_names, ви можете отримати значення параметрів, що проходять через sql та відповідні назви стовпців.

Примітка: Якщо $paramповертає масив, вам потрібно повторити ітерацію, оскільки параметри всередині IN (:?)зазвичай приходять як вкладений масив.

Тим часом, якщо ви знайшли інший підхід, будьте ласкаві поділитися з нами :)

Дякую!

Більш чітке рішення:

 /**
 * 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);

Ви можете використовувати:

$query->getSQL();

Якщо ви використовуєте MySQL, ви можете використовувати Workbench для перегляду запущених операторів SQL. Ви також можете переглянути перегляд запущеного запиту з mysql, використовуючи наступне:

 SHOW FULL PROCESSLIST \G

Можливо, комусь це може бути корисно:

// 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...

у своїх гілочках використовуйте фільтри помічників гілочок 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 }}

Пояснення:

Інші відповіді, в яких згадується, що Підготовлена ​​заява насправді є "справжніми запитами", є правильними, але вони не відповідають очевидним очікуванням запитувача ... Кожен розробник хоче відобразити "запущений запит" для налагодження (або показати його користувачеві) .

Отже, я заглянув у джерело провідника Symfony, щоб побачити, як вони це роблять. Частина доктрини - це відповідальність Доктрини, тому вони склали вчення, щоб інтегруватися з Symfony. Переглянувши doctrine-bundle/Resources/views/Collector/db.html.twigфайл, ви дізнаєтесь, як вони це роблять (це може змінитися в різних версіях). Цікаво, що вони створили гілочкові фільтри, які ми можемо повторно використовувати (див. Вище).

Щоб все працювало, нам потрібно включити Журнал для нашого запиту. Існує кілька способів зробити це, і тут я використовую DebugStack, який дозволяє вести запити без фактичного їх друку. Це також гарантує, що це буде працювати в режимі виробництва, якщо це те, що вам потрібно ...

Якщо вам потрібно подальше форматування, ви побачите, що вони включають деякі CSS в тег стилю, тому просто "вкрадіть" його ^^:

.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; }

Сподіваюся, це допоможе ;-)

Я написав простий реєстратор, який може ввести запит із вставленими параметрами. Установка:

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

Використання:

$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();

Модифікована функція @dsamblas працює, коли параметри - це рядки дат, подібні до цього "2019-01-01" і коли масив передається за допомогою IN, як

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

. Тому виконайте все, що написав dsamblas, але замініть startQuery на цей або перегляньте відмінності та додайте мій код. (якщо він змінив щось у своїй функції, а моя версія не має змін).

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;
    }
}

Не тестував багато.

Я зробив деякі дослідження з цієї теми, тому що я хотів налагодити згенерований SQL-запит і виконати його в редакторі sql. Як видно з усіх відповідей, це дуже технічна тема.

Коли я припускаю, що початкове питання базується на dev-env, наразі відсутня одна дуже проста відповідь. Ви можете просто використовувати збірку в профайлері Symfony. Просто натисніть на вкладку Доктрина, перейдіть до запиту, який ви хочете перевірити. Потім натисніть кнопку "переглянути запит, який можна виконати", і ви зможете вставити запит безпосередньо у свій редактор SQL

Більш базовий підхід інтерфейсу, але дуже швидкий і без налагодження накладних кодів.

$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));
            }
        }
    }
}

Щоб роздрукувати запит SQL в Doctrine, використовуйте:

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