refactor(database): rename toSql to compile in query builders

Author: innocenzi

packages/database/src/Builder/QueryBuilders/CountQueryBuilder.php

@@ -80,9 +80,9 @@ public function bind(mixed ...$bindings): self
     }
 
     /**
-     * Returns the SQL statement without the bindings.
+     * Compile the query to a SQL statement without the bindings.
      */
-    public function toSql(): ImmutableString
+    public function compile(): ImmutableString
     {
         return $this->build()->compile();
     }

packages/database/src/Builder/QueryBuilders/DeleteQueryBuilder.php

@@ -69,9 +69,9 @@ public function bind(mixed ...$bindings): self
     }
 
     /**
-     * Returns the SQL statement without the bindings.
+     * Compile the query to a SQL statement without the bindings.
      */
-    public function toSql(): ImmutableString
+    public function compile(): ImmutableString
     {
         return $this->build()->compile();
     }

packages/database/src/Builder/QueryBuilders/InsertQueryBuilder.php

@@ -74,9 +74,9 @@ public function execute(mixed ...$bindings): ?PrimaryKey
     }
 
     /**
-     * Returns the SQL statement without the bindings.
+     * Compile the query to a SQL statement without the bindings.
      */
-    public function toSql(): ImmutableString
+    public function compile(): ImmutableString
     {
         return $this->build()->compile();
     }

packages/database/src/Builder/QueryBuilders/SelectQueryBuilder.php

@@ -284,9 +284,9 @@ public function bind(mixed ...$bindings): self
     }
 
     /**
-     * Returns the SQL statement without the bindings.
+     * Compile the query to a SQL statement without the bindings.
      */
-    public function toSql(): ImmutableString
+    public function compile(): ImmutableString
     {
         return $this->build()->compile();
     }

packages/database/src/Builder/QueryBuilders/UpdateQueryBuilder.php

@@ -111,9 +111,9 @@ public function bind(mixed ...$bindings): self
     }
 
     /**
-     * Returns the SQL statement without the bindings.
+     * Compile the query to a SQL statement without the bindings.
      */
-    public function toSql(): ImmutableString
+    public function compile(): ImmutableString
     {
         return $this->build()->compile();
     }

tests/Integration/Database/Builder/CountQueryBuilderTest.php

@@ -157,7 +157,7 @@ public function test_multiple_where_raw(): void
             ->whereRaw('author_id = ?', 1)
             ->whereRaw('OR author_id = ?', 2)
             ->whereRaw('AND author_id <> NULL')
-            ->toSql();
+            ->compile();
 
         $expected = 'SELECT COUNT(*) AS `count` FROM `books` WHERE title = ? AND author_id = ? OR author_id = ? AND author_id <> NULL';
 
@@ -170,7 +170,7 @@ public function test_multiple_where(): void
             ->count()
             ->where('title', 'a')
             ->where('author_id', 1)
-            ->toSql();
+            ->compile();
 
         $expected = 'SELECT COUNT(*) AS `count` FROM `books` WHERE books.title = ? AND books.author_id = ?';
 

tests/Integration/Database/Builder/DeleteQueryBuilderTest.php

@@ -114,7 +114,7 @@ public function test_multiple_where_raw(): void
             ->whereRaw('author_id = ?', 1)
             ->whereRaw('OR author_id = ?', 2)
             ->whereRaw('AND author_id <> NULL')
-            ->toSql();
+            ->compile();
 
         $expected = 'DELETE FROM `books` WHERE title = ? AND author_id = ? OR author_id = ? AND author_id <> NULL';
 
@@ -127,7 +127,7 @@ public function test_multiple_where(): void
             ->delete()
             ->where('title', 'a')
             ->where('author_id', 1)
-            ->toSql();
+            ->compile();
 
         $expected = 'DELETE FROM `books` WHERE books.title = ? AND books.author_id = ?';
 

tests/Integration/Database/Builder/SelectQueryBuilderTest.php

@@ -75,7 +75,7 @@ public function test_multiple_where(): void
             ->whereRaw('author_id = ?', 1)
             ->whereRaw('OR author_id = ?', 2)
             ->whereRaw('AND author_id <> NULL')
-            ->toSql();
+            ->compile();
 
         $expected = 'SELECT * FROM `books` WHERE title = ? AND author_id = ? OR author_id = ? AND author_id <> NULL';
 
@@ -88,7 +88,7 @@ public function test_multiple_where_field(): void
             ->select()
             ->where('title', 'a')
             ->where('author_id', 1)
-            ->toSql();
+            ->compile();
 
         $expected = 'SELECT * FROM `books` WHERE books.title = ? AND books.author_id = ?';
 
@@ -199,17 +199,17 @@ public function test_order_by_sql_generation(): void
     {
         $this->assertSameWithoutBackticks(
             expected: 'SELECT * FROM `books` ORDER BY `title` ASC',
-            actual: query('books')->select()->orderBy('title')->toSql(),
+            actual: query('books')->select()->orderBy('title')->compile(),
         );
 
         $this->assertSameWithoutBackticks(
             expected: 'SELECT * FROM `books` ORDER BY `title` DESC',
-            actual: query('books')->select()->orderBy('title', Direction::DESC)->toSql(),
+            actual: query('books')->select()->orderBy('title', Direction::DESC)->compile(),
         );
 
         $this->assertSameWithoutBackticks(
             expected: 'SELECT * FROM `books` ORDER BY title DESC NULLS LAST',
-            actual: query('books')->select()->orderByRaw('title DESC NULLS LAST')->toSql(),
+            actual: query('books')->select()->orderByRaw('title DESC NULLS LAST')->compile(),
         );
     }
 
@@ -421,7 +421,7 @@ public function test_select_query_execute_with_relations(): void
 
     public function test_eager_loads_combined_with_manual_loads(): void
     {
-        $query = AWithEager::select()->with('b.c')->toSql();
+        $query = AWithEager::select()->with('b.c')->compile();
 
         $this->assertSameWithoutBackticks(
             'SELECT a.id AS `a.id`, a.b_id AS `a.b_id`, b.id AS `b.id`, b.c_id AS `b.c_id`, c.id AS `b.c.id`, c.name AS `b.c.name` FROM `a` LEFT JOIN b ON b.id = a.b_id LEFT JOIN c ON c.id = b.c_id',
@@ -434,7 +434,7 @@ public function test_group_by(): void
         $sql = query('authors')
             ->select()
             ->groupBy('name')
-            ->toSql();
+            ->compile();
 
         $expected = 'SELECT * FROM authors GROUP BY name';
 
@@ -446,7 +446,7 @@ public function test_having(): void
         $sql = query('authors')
             ->select()
             ->having('name = ?', 'Brent')
-            ->toSql();
+            ->compile();
 
         $expected = 'SELECT * FROM authors HAVING name = ?';
 

tests/Integration/Database/Builder/UpdateQueryBuilderTest.php

@@ -252,7 +252,7 @@ public function test_multiple_where(): void
             ->whereRaw('author_id = ?', 1)
             ->whereRaw('OR author_id = ?', 2)
             ->whereRaw('AND author_id <> NULL')
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET title = ? WHERE title = ? AND author_id = ? OR author_id = ? AND author_id <> NULL';
 
@@ -267,7 +267,7 @@ public function test_multiple_where_field(): void
             )
             ->where('title', 'a')
             ->where('author_id', 1)
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET title = ? WHERE books.title = ? AND books.author_id = ?';
 
@@ -321,7 +321,7 @@ public function test_update_with_where_in(): void
         $sql = query('books')
             ->update(title: 'Updated Book')
             ->whereIn('id', [1, 2, 3])
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET `title` = ? WHERE `books`.`id` IN (?,?,?)';
 
@@ -333,7 +333,7 @@ public function test_update_with_where_not_in(): void
         $sql = query('books')
             ->update(title: 'Updated Book')
             ->whereNotIn('author_id', [1, 2])
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET `title` = ? WHERE `books`.`author_id` NOT IN (?,?)';
 
@@ -345,7 +345,7 @@ public function test_update_with_where_null(): void
         $sql = query('books')
             ->update(title: 'Updated Book')
             ->whereNull('author_id')
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET `title` = ? WHERE `books`.`author_id` IS NULL';
 
@@ -357,7 +357,7 @@ public function test_update_with_where_not_null(): void
         $sql = query('books')
             ->update(title: 'Updated Book')
             ->whereNotNull('author_id')
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET `title` = ? WHERE `books`.`author_id` IS NOT NULL';
 
@@ -369,7 +369,7 @@ public function test_update_with_where_between(): void
         $sql = query('books')
             ->update(title: 'Updated Book')
             ->whereBetween('id', 1, 100)
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET `title` = ? WHERE `books`.`id` BETWEEN ? AND ?';
 
@@ -381,7 +381,7 @@ public function test_update_with_where_not_between(): void
         $sql = query('books')
             ->update(title: 'Updated Book')
             ->whereNotBetween('id', 1, 10)
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET `title` = ? WHERE `books`.`id` NOT BETWEEN ? AND ?';
 
@@ -394,7 +394,7 @@ public function test_update_with_or_where_in(): void
             ->update(title: 'Updated Book')
             ->whereIn('id', [1, 2])
             ->orWhereIn('author_id', [10, 20])
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET `title` = ? WHERE `books`.`id` IN (?,?) OR `books`.`author_id` IN (?,?)';
 
@@ -406,7 +406,7 @@ public function test_update_captures_primary_key_for_relations_with_convenience_
         $sql = query(Book::class)
             ->update(title: 'Updated Book')
             ->whereIn('id', [5])
-            ->toSql();
+            ->compile();
 
         $expected = 'UPDATE `books` SET `title` = ? WHERE `books`.`id` IN (?)';