[8.x] Add method to dump the SQL query replacing all bindings

[mateusjunges]

About this PR

This PR adds a new toSqlWithBindings method to the Query Builder class.

It allows developers to dump the query with all binding replaced with it actual value, for example:

Post::where('title', 'like', 'Example%');

With the actual ->toSql() method, it returns this:

"select * from `posts` where `title` like ?"

Of course you can use the ->dd() method, and it returns your bindings as an array, which is useful but it kinda take some time to figure out the place for each binding within your query if you have a query with too many bindings:

"select * from `posts` where `title` like ?"

array:1 [
  0 => "Example%"
]

Using the new proposed ->toSqlWithBindings() method, you can easily see your query with all bindings:

select * from `posts` where `title` like 'Example%'

Questions

I don't know if my tests were added to the correct class. If not, tell me what class they should be in and I make the correction.

[morloderex]

This will throw a fatal if the object in question does not implement __toString(), is that desired or should it be catched and turned into a logic exception?

[mateusjunges]

I tested it with SQLite, SQL Server, MySQL and PostgreSQL, and the tests still passing (i'll add the tests as a separate commit and we can drop if later if it's unnecesssary). Can you provide an example where you think the object does not implement __toString()?

[rodrigopedra]

Sure:

User::query()->where('updated_at', '>', new DateTime('yesterday'))->get();

https://3v4l.org/Xi2hT

Fatal error: Uncaught Error: Object of class DateTime could not be converted to string

[rodrigopedra]

Just to clarify:

The query from the first snippet above works on a stock Laravel installation.

The link was to show the \DateTime class fails to be cast to a string.

[rodrigopedra]

I would look into previous attempts to see why they got rejected

• [8.x] Query builder to sql with bindings #35910
• [8.x] Add query builder toSqlWithBindings method #35900
• Print SQL query with bindings #25516
• [5.5] toRaw added to builder #21796

Also you need to account for:

• booleans
  • true becomes 1 and false becomes 0
  • I think true already is converted to 1 when concatenating, but false I am pretty sure gets coerced to an empty string
• nulls
  • gets coerced to an empty string
  • should be an unquoted NULL

Another suggestion is to look how these packages handle this:

• https://github.com/barryvdh/laravel-debugbar
• https://github.com/laravel/telescope
• https://github.com/facade/ignition

They all have some sort of full query display.

Good luck

[driesvints]

This PR won't be reviewed until it's out of draft.

[thiagorb]

I guess it would be safer to call some existing functionality to quote query parameters, otherwise this would not work when one of the bound strings contains a single quote.

[mateusjunges]

@thiagorb I think PDO quote method solve this problem. Can you check it again?

[rodrigopedra]

$this->connection is type-hinted as a Illuminate\Database\ConnectionInterface, which does not have a getPdo() method.

[mateusjunges]

@rodrigopedra Do you think something like this would be better?

$search = ["\\",  "\x00", "\n",  "\r",  "'",  '"', "\x1a"];
$replace = ["\\\\","\\0","\\n", "\\r", "\'", '\"', "\\Z"];

return "'" . str_replace($search, $replace, $value) . "'";

[rodrigopedra]

I think a combination of both, similar to what debugbar does:

https://github.com/barryvdh/laravel-debugbar/blob/6420113d90bb746423fa70b9940e9e7c26ebc121/src/DataCollector/QueryCollector.php#L121-L126

https://github.com/barryvdh/laravel-debugbar/blob/6420113d90bb746423fa70b9940e9e7c26ebc121/src/DataCollector/QueryCollector.php#L148-L152

https://github.com/barryvdh/laravel-debugbar/blob/6420113d90bb746423fa70b9940e9e7c26ebc121/src/DataCollector/QueryCollector.php#L191-L197

Although I would use method_exists instead of try...catch to check for PDO

[mateusjunges]

@rodrigopedra done.

[taylorotwell]

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If possible, please consider releasing your code as a package so that the community can still take advantage of your contributions!

If you feel absolutely certain that this code corrects a bug in the framework, please "@" mention me in a follow-up comment with further explanation so that GitHub will send me a notification of your response.

[taylorotwell]

I suggest checking out tools like Telescope and DebugBar.