Debugging easier with Laravel 10.x's new toRawSql() method

A ride-hailing application scenario#

Imagine you are developing a ride-hailing application and need to fetch complex user ride data. Building a query with Laravel's Eloquent might look straightforward, but once bindings enter the picture, understanding what SQL actually executes becomes harder. Here is how you might construct the query:

$rides = Ride::where('user_id', 1)
    ->where('created_at', '>=', now()->subMonth())
    ->where('cost', '>', 20)
    ->orderBy('distance', 'desc')
    ->toRawSql();
dd($rides);

With the toRawSql() method, the output shows the complete SQL statement with all values filled in:

select * from `rides` where `user_id` = 1 and `created_at` >= '2023-06-12' and `cost` > 20 order by `distance` desc

Compare this with the output from the same Eloquent query using dd() in earlier Laravel versions:

$rides = Ride::where('user_id', 1)
    ->where('created_at', '>=', now()->subMonth())
    ->where('cost', '>', 20)
    ->orderBy('distance', 'desc')
    ->dd();

This produces the query template with placeholder question marks and a separate binding array:

"select * from `rides` where `user_id` = ? and `created_at` >= ? and `cost` > ? order by `distance` desc"
array:3 [
  0 => 1
  1 => "2023-06-12"
  2 => 20
]

Taking full advantage of toRawSql()#

The toRawSql() method proves invaluable when handling complex queries. It allows you to easily view the exact SQL query that will be executed, with all bindings intact. This not only saves time but also eliminates the risk of errors that might occur during manual placeholder replacements.

Laravel 10.x also introduces ddRawSql() and dumpRawSql(). These supplementary methods make it straightforward to print raw SQL queries directly. Use toRawSql() when you need the string for logging or programmatic use, ddRawSql() when you want to stop execution immediately, or dumpRawSql() when you want output without halting.

The value becomes clearer as your queries grow more complex. Nested where clauses, multiple joins, subqueries with conditions. Each binding replacement that toRawSql() handles automatically is one less place for a mistake.

Conclusion#

The introduction of the toRawSql() method in Laravel 10.x demonstrates the framework's commitment to providing developers with tools that make coding more efficient. Whether you are building a ride-hailing platform, an e-commerce system, or any application with complex database interactions, toRawSql() simplifies the debugging process significantly. As Laravel continues to evolve, it promises an exciting journey for software engineers at every level.

If you are building a SaaS platform with Laravel, toRawSql() is one component of effective debugging and optimization. For guidance on building reliable applications, explore our resources on SaaS development and maintenance and support to keep your systems running smoothly as you scale.