Comment extraire le SQL brut du Query Builder en PHP : 3 méthodes efficaces

« Docteur, mon Query Builder génère quelque chose d’étrange… »

Situation familière : vous écrivez une requête chaînée élégante avec Query Builder, convaincu que tout fonctionne parfaitement, mais le résultat est soit une erreur, soit des données incorrectes. La première chose qui vient à l’esprit de tout développeur PHP : « Montre-moi ce que tu génères réellement ! ».

La question « How do I get the query builder to output its raw SQL query as a string? » est l’une des plus populaires sur Stack Overflow (des milliers de vues et des dizaines de réponses). Et ce n’est pas un hasard. Savoir obtenir rapidement du SQL propre est une super compétence qui fait gagner des heures de débogage.

Dans cet article, nous allons voir 3 méthodes efficaces pour les frameworks PHP (Laravel, Doctrine, CakePHP), avec des exemples de code concrets et des explications sur quand utiliser chaque méthode. C’est parti !

Pourquoi en avez-vous besoin ? (Brièvement et concrètement)

\n
• Débogage — comprendre pourquoi la requête ne retourne pas les bonnes données.
\n
• Optimisation — voir quels JOIN et WHERE sont réellement exécutés.
\n
• Apprentissage — les débutants ne comprennent souvent pas comment Query Builder traduit les méthodes en SQL.
\n
• Journalisation — enregistrer la requête brute pour un audit ou une relecture.
\n

Prêts ? Passons au code !

Méthode 1 : Laravel Eloquent / Query Builder — la classique

Dans Laravel, il existe plusieurs façons, mais la plus fiable est d’utiliser toSql() avec getBindings(). Pourquoi ensemble ? Parce que toSql() affiche la requête avec des espaces réservés ?, et sans substitution des valeurs, c’est inutile.

Exemple simple : SELECT avec WHERE

use App\\Models\\User;\n\n$query = User::where('email', 'like', '%@gmail.com')\n             ->where('active', 1)\n             ->orderBy('created_at', 'desc');\n\n// Obtenir le SQL avec les espaces réservés\n$sql = $query->toSql();\n$bindings = $query->getBindings();\n\n// Assembler le tout dans un format lisible\n$fullSql = vsprintf(str_replace('?', '%s', $sql), $bindings);\n\necho $fullSql;\n// Résultat :\n// SELECT * FROM users WHERE email LIKE '%@gmail.com' AND active = 1 ORDER BY created_at DESC

Important : vsprintf n’est pas une solution miracle. Pour les types de données complexes (par exemple, NULL ou les tableaux), il est préférable d’utiliser Str::replaceArray() ou le paquet laravel-query-builder-debug.

Variante avancée : avec join et whereIn

$query = DB::table('orders')\n    ->join('users', 'orders.user_id', '=', 'users.id')\n    ->whereIn('orders.status', ['pending', 'processing'])\n    ->where('orders.total', '>', 100)\n    ->select('orders.*', 'users.name');\n\n$bindings = $query->getBindings();\n$sql = $query->toSql();\n\n// Formater joliment\n$fullSql = preg_replace_array('/\\?/', $bindings, $sql);\necho $fullSql;\n// SELECT orders.*, users.name FROM orders INNER JOIN users ON orders.user_id = users.id WHERE orders.status IN ('pending', 'processing') AND orders.total > 100

Conseil : Utilisez preg_replace_array() — c’est plus sûr que vsprintf, surtout lorsque les données contiennent le caractère %.

Méthode 2 : Doctrine DBAL — pour ceux qui aiment la rigueur

Doctrine Query Builder (souvent utilisé dans Symfony) est une bête un peu plus complexe. Il n’y a pas de toSql() prêt à l’emploi, mais il y a getSQL() et getParameters(). De plus, il faut tenir compte des types de paramètres.

Exemple de base

use Doctrine\\DBAL\\Connection;\nuse Doctrine\\DBAL\\Query\\QueryBuilder;\n\n/** @var Connection $connection */\n$queryBuilder = $connection->createQueryBuilder();\n$queryBuilder\n    ->select('p.*', 'c.name as category_name')\n    ->from('products', 'p')\n    ->join('p', 'categories', 'c', 'p.category_id = c.id')\n    ->where('p.price > :minPrice')\n    ->andWhere('p.sto