在 laravel 中輕鬆容易的輸出完整的 sql 語句

guanguans發表於2021-10-27
LaravelSQL

guanguans/laravel-dump-sql - 在 laravel 中輕鬆容易的輸出完整的 sql 語句。

laravel 中查詢構造方法得到的 sql 語句沒有繫結條件引數，類似於select * from users where id= ?。這個擴充套件包可輔助你獲取完整的 sql 語句。

User::query()->where('id', 1)->dd(); // 自帶方法 `dd` 的列印結果

User::query()->where('id', 1)->ddSql(); // 新增方法 `ddSql` 的列印結果

環境要求

  • laravel || lumen >= 5.5

安裝

$ composer require guanguans/laravel-dump-sql -v

lumen 中配置(laravel 中請忽略)

將下面程式碼新增到 bootstrap/app.php 檔案中的 Register Service Providers 部分

$app->register(\Guanguans\LaravelDumpSql\ServiceProvider::class);

使用

安裝配置完畢後資料庫查詢構造方法會新增以下幾個方法：

  • toRawSql() - 獲取完整的 sql
  • dumpSql() - 列印完整的 sql
  • ddSql() - 列印完整的 sql 並且退出
  • logListenedSql() - 記錄被監聽到的 sql
  • dumpListenedSql() - 列印被監聽到的 sql
  • ddListenedSql() - 列印被監聽到的 sql 並且退出

toRawSql() - 獲取完整的 sql

$sql = User::query()->where('id', 1)->toRawSql();
dd($sql);
"select * from `xb_users` where `id` = 1"

dumpSql() - 列印完整的 sql

User::query()->where('id', 1)->dumpSql();
User::query()->where('id', 2)->dumpSql();
"select * from `xb_users` where `id` = 1"
"select * from `xb_users` where `id` = 2"

ddSql() - 列印完整的 sql 並且退出

User::query()->where('id', 1)->ddSql();
User::query()->where('id', 2)->ddSql();
"select * from `xb_users` where `id` = 1"

logListenedSql() - 記錄被監聽到的 sql

User::query()->where('id', 1)->logListenedSql()->first();
User::query()->where('id', 2)->first();
# 日誌中
[Laravel] [39.97ms] select * from `xb_users` where `id` = '1' limit 1 | GET: /
[Laravel] [39.93ms] select * from `xb_users` where `id` = '2' limit 1 | GET: /

dumpListenedSql() - 列印被監聽到的 sql

User::query()->where('id', 1)->dumpListenedSql()->first();
User::query()->where('id', 2)->first();
[Laravel] [39.97ms] select * from `xb_users` where `id` = '1' limit 1 | GET: /
[Laravel] [39.93ms] select * from `xb_users` where `id` = '2' limit 1 | GET: /

ddListenedSql() - 列印被監聽到的 sql 並且退出

User::query()->where('id', 1)->ddListenedSql()->first();
User::query()->where('id', 2)->first();
[Laravel] [39.97ms] select * from `xb_users` where `id` = '1' limit 1 | GET: /

參考專案

本作品採用《CC 協議》，轉載必須註明作者和本文連結
No practice, no gain in one's wit. 我的 Gitub

相關文章