Doutrina - Como imprimir o SQL real, não apenas a declaração preparada?
-
21-09-2019 - |
Pergunta
Estamos usando doutrina, um PHP ORM. Estou criando uma consulta como esta:
$q = Doctrine_Query::create()->select('id')->from('MyTable');
E então, na função, estou adicionando várias cláusulas e coisas como apropriado, assim
$q->where('normalisedname = ? OR name = ?', array($string, $originalString));
Mais tarde, antes execute()
-ing esse objeto de consulta, quero imprimir o SQL bruto para examiná -lo e fazer isso:
$q->getSQLQuery();
No entanto, isso apenas imprime a declaração preparada, não a consulta completa. Quero ver o que está enviando para o MySQL, mas está imprimindo uma declaração preparada, incluindo ?
's. Existe alguma maneira de ver a consulta 'completa'?
Solução
A doutrina não está enviando uma "consulta SQL real" para o servidor de banco de dados: na verdade está usando declarações preparadas, o que significa:
- Enviando a declaração, para que ela seja preparada (é o que é devolvido por
$query->getSql()
) - E então, enviando os parâmetros (retornado por
$query->getParameters()
) - e executando as declarações preparadas
Isso significa que nunca há uma consulta SQL "real" no lado do PHP - então, a doutrina não pode exibi -la.
Outras dicas
Um exemplo de funcionamento:
$qb = $this->createQueryBuilder('a');
$query=$qb->getQuery();
// SHOW SQL:
echo $query->getSQL();
// Show Parameters:
echo $query->getParameters();
Você pode verificar a consulta executada pelo seu aplicativo se registrar todas as consultas no MySQL:
http://dev.mysql.com/doc/refman/5.1/en/query-log.html
Haverá mais consultas não apenas as que você está procurando, mas também pode grep.
mas usualmente ->getSql();
funciona
Editar:
Para ver todas as consultas MySQL que eu uso
sudo vim /etc/mysql/my.cnf
e adicione essas 2 linhas:
general_log = on
general_log_file = /tmp/mysql.log
e reinicie o mysql
Eu criei um registrador de doutrina2 que faz exatamente isso. Ele "hidrata" a consulta SQL parametrizada com os valores usando conversores de tipo de dados próprios da Doutrina 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;
}
}
Exemplo de uso:; A seguinte paz de código ecoará na saída padrão qualquer inserção, atualização, exclua frases SQL geradas com o $ em 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
)
)
);
Não há outra consulta real, é assim que as declarações preparadas funcionam. Os valores estão ligados no servidor de banco de dados, não na camada de aplicativos.
Veja minha resposta para esta pergunta: Em PHP com PDO, como verificar a consulta final parametrizada do SQL?
(Repetido aqui por conveniência :)
O uso de instruções preparadas com valores parametrizados não é simplesmente outra maneira de criar dinamicamente uma sequência de SQL. Você cria uma instrução preparada no banco de dados e envia apenas os valores dos parâmetros.
Então, o que provavelmente é enviado ao banco de dados será um
PREPARE ...
, entãoSET ...
e finalmenteEXECUTE ....
Você não poderá obter uma string sql como
SELECT * FROM ...
, mesmo que produza resultados equivalentes, porque essa consulta foi realmente enviada ao banco de dados.
getSqlQuery()
Tecnicamente mostra todo o comando SQL, mas é muito mais útil quando você também pode ver os parâmetros.
echo $q->getSqlQuery();
foreach ($q->getFlattenedParams() as $index => $param)
echo "$index => $param";
Para tornar esse padrão mais reutilizável, há uma boa abordagem descrita no comentários no SQL bruto do objeto de consulta da doutrina.
Minha solução:
/**
* 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;}
Exemplo de uso:
$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());
Você pode acessar facilmente os parâmetros SQL usando a seguinte abordagem.
$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,',');
Então, se você imprimiu o $param_values
e $col_names
, você pode obter os valores dos parâmetros que passam pelos nomes do SQL e das respectivas colunas.
Nota: Se $param
Retorna uma matriz, você precisa reencontrar, como parâmetros dentro IN (:?)
Geralmente vem como uma matriz aninhada.
Enquanto isso, se você encontrou outra abordagem, seja gentil o suficiente para compartilhar conosco :)
Obrigada!
Solução mais clara:
/**
* 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);
}
Você pode usar :
$query->getSQL();
Se você estiver usando o MySQL, poderá usar o Workbench para visualizar as instruções SQL em execução. Você também pode usar o View the Running Consulta do MySQL usando o seguinte:
SHOW FULL PROCESSLIST \G
Talvez possa ser útil para alguém:
// 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;
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);
Eu escrevi um logger simples, que pode registrar a consulta com parâmetros inseridos. Instalação:
composer require cmyker/doctrine-sql-logger:dev-master
Uso:
$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 modificados funcionam quando os parâmetros são strings de data como esta '2019-01-01' e quando há uma matriz passada usando como
$qb->expr()->in('ps.code', ':activeCodes'),
. Então faça tudo o que os dsamblas escreveu, mas substitua o StartQuery por este ou veja as diferenças e adicione meu código. (Caso ele modifique algo em sua função e minha versão não tenha modificações).
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;
}
}
Não testou muito.
Para imprimir uma consulta SQL em doutrina, use:
$query->getResult()->getSql();