原则-如何打印出真正的sql，而不仅仅是准备好的语句?

我们使用Doctrine，一个PHP ORM。我创建了一个这样的查询:

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

然后在函数中，我添加了各种where子句和适当的东西，像这样

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

稍后，在execute()-ing该查询对象之前，我想打印出原始SQL以检查它，并执行以下操作:

$q->getSQLQuery();

但是，这只打印准备好的语句，而不是完整的查询。我想看看它向MySQL发送了什么，但相反，它打印了一个准备好的语句，包括?的语句。是否有一些方法可以看到'full'查询?

336473 次浏览
小开

没有其他真正的查询，这就是预处理语句的工作方式。这些值绑定在数据库服务器中，而不是应用程序层。

请看我对这个问题的回答:在PHP与PDO，如何检查最后的SQL参数化查询?

(为了方便起见，这里重复一遍:)

使用带参数化值的准备语句不仅仅是动态创建SQL字符串的另一种方法。在数据库中创建一个准备好的语句，然后单独发送参数值。

因此，发送到数据库的可能是PREPARE ...，然后是SET ...，最后是EXECUTE ....

你将无法得到一些SQL字符串，如SELECT * FROM ...，即使它会产生等效的结果，因为没有这样的查询实际上发送到数据库。

小开
最佳答案

Doctrine并不是向数据库服务器发送一个“真正的SQL查询”:它实际上是使用准备好的语句，这意味着:

  • 发送语句，以便对其进行准备(这是$query->getSql()返回的内容)
  • 然后，发送参数(由$query->getParameters()返回)
  • 执行准备好的语句

这意味着PHP端从来没有一个“真正的”SQL查询——因此Doctrine无法显示它。

小开

你可以检查你的应用执行的查询，如果你把所有的查询都记录在mysql中:

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

会有更多的查询，不仅是一个你正在寻找，但你可以grep它。

但通常->getSql();工作

编辑:

查看我使用的所有mysql查询

sudo vim /etc/mysql/my.cnf

加上这两行:

general_log = on
general_log_file = /tmp/mysql.log

重新启动mysql

<强>编辑2 如果你没有找到mysql的配置(可能在很多地方)，只需要在mysql命令行中设置这些变量即可 

mysql -u root -p


SHOW VARIABLES LIKE 'general_log_file';
SHOW VARIABLES LIKE 'general_log';


SET GLOBAL general_log = 'on';
SET GLOBAL general_log_file = '/tmp/mysql.log';


//view the queries
sudo tail -f /tmp/mysql.log

这些设置的生命周期直到MySQL重新启动。或者是笔记本电脑。所以他们不是永久的-这在我看来是伟大的-我只需要他们当我调试时，我不需要担心编辑配置然后删除他们。如果您不删除日志记录，如果您忘记它，它可能会增长太多。

小开

getSqlQuery()在技术上确实显示了整个SQL命令，但当你也可以看到参数时，它会更有用。

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

为了使这个模式更加可重用，评论在来自原则查询对象的原始SQL中描述了一个很好的方法。

小开

一个工作的例子:

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

也许它对某些人有用:

// 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;
小开

我已经创建了一个Doctrine2 Logger，它就是这样做的。它使用Doctrine 2自己的数据类型转换器将参数化sql查询与值“水合”起来。

<?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;
}
}
< p >用法示例:; 下面的代码将在标准输出中回显用$em实体管理器生成的任何INSERT、UPDATE、DELETE SQL语句，

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

更明确的解决方案:

 /**
* 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
小开

我的解决方案:

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

要打印出Doctrine中的SQL查询，请使用:

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

您可以使用以下方法轻松地访问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 (:?)中的参数通常是一个嵌套数组。

同时，如果你找到了其他方法，请与我们分享:)

谢谢你！

小开
我写了一个简单的记录器，它可以记录插入参数的查询。 安装:< / p > 
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;
}
}

没有测试太多。

小开

博士TL;

$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 profiler的源码看看他们是怎么做的。教义部分是Doctrine的责任，所以他们做了一个教义包来与Symfony集成。看一下doctrine-bundle/Resources/views/Collector/db.html.twig文件，你会发现他们是如何做到这一点的(这可能会在不同版本中发生变化)。有趣的是，他们创建了我们可以重用的细枝过滤器(见上文)。

为了使一切正常工作，我们需要为查询启用Logging。有多种方法可以做到这一点，在这里我使用了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; }

希望这对你有帮助;-)

小开

我为这个主题做了一些研究，因为我想调试生成的SQL查询并在SQL编辑器中执行它。从所有的答案中可以看出，这是一个技术性很强的话题。

当我假设最初的问题是基于dev-env时，目前缺少一个非常简单的答案。您可以只使用Symfony profiler中的构建。只需点击Doctrine标签，滚动到你想检查的查询。然后点击“查看可运行查询”;您可以直接将查询粘贴到SQL编辑器中

更多的UI基础方法，但非常快，没有调试代码开销。

enter image description here

小开 
$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 prepared语句与绑定结合来构建一个sql字符串，就像这样:

$sql = str_replace_array('?', $query->getBindings(), $query->toSql())

str_replace_array(string $search, array $replacement, string $subject): string

PHP的str_replace_array函数用$replacement数组中的值顺序替换$subject中的每个$search实例。


提交答案