Allow defining columns of the view (#66)

Co-authored-by: tpetry <[email protected]>

Author: bastien-phi

README.md

@@ -285,6 +285,14 @@ Schema::createView('users_with_2fa', 'SELECT * FROM users WHERE two_factor_secre
 Schema::createViewOrReplace('users_without_2fa', DB::table('users')->whereNull('two_factor_secret'));
 ```
 
+You can specify alternative names for the view's columns by passing an array as the last parameter:
+```php
+use Illuminate\Support\Facades\DB;
+use Tpetry\PostgresqlEnhanced\Support\Facades\Schema;
+
+Schema::createView('users_with_2fa', DB::table('users')->select('id')->whereNull('two_factor_secret'), ['user_id']);
+```
+
 If you need to create recursive views the `createRecursiveView` and `createRecursiveViewOrReplace` methods can be used like in the former examples but you need to provide the available columns as last parameter:
 
 ```php
@@ -330,6 +338,7 @@ use Tpetry\PostgresqlEnhanced\Support\Facades\Schema;
 
 Schema::createMaterializedView('users_with_2fa', 'SELECT * FROM users WHERE two_factor_secret IS NOT NULL');
 Schema::createMaterializedView('users_with_2fa', DB::table('users')->whereNull('two_factor_secret'));
+Schema::createMaterializedView('users_with_2fa', DB::table('users')->select('id')->whereNull('two_factor_secret'), columns: ['user_id']);
 
 Schema::createMaterializedView('very_slow_query_materialized', 'SELECT ...', withData: false);
 

src/Schema/BuilderView.php

@@ -12,9 +12,13 @@ trait BuilderView
     /**
      * Create a materialized view on the schema.
      */
-    public function createMaterializedView(string $name, QueryBuilder|string $query, bool $withData = true): void
+    public function createMaterializedView(string $name, QueryBuilder|string $query, bool $withData = true, array $columns = []): void
     {
         $name = $this->getConnection()->getSchemaGrammar()->wrapTable($name);
+        if (filled($columns)) {
+            $columns = $this->getConnection()->getSchemaGrammar()->columnize($columns);
+            $name = "{$name} ({$columns})";
+        }
         $query = Query::toSql($query);
         $withData = $withData ? 'with data' : 'with no data';
         $this->getConnection()->statement("create materialized view {$name} as {$query} {$withData}");
@@ -45,19 +49,27 @@ public function createRecursiveViewOrReplace(string $name, QueryBuilder|string $
     /**
      * Create a view on the schema.
      */
-    public function createView(string $name, QueryBuilder|string $query): void
+    public function createView(string $name, QueryBuilder|string $query, array $columns = []): void
     {
         $name = $this->getConnection()->getSchemaGrammar()->wrapTable($name);
+        if (filled($columns)) {
+            $columns = $this->getConnection()->getSchemaGrammar()->columnize($columns);
+            $name = "{$name} ({$columns})";
+        }
         $query = Query::toSql($query);
         $this->getConnection()->statement("create view {$name} as {$query}");
     }
 
     /**
      * Create or replace a view on the schema.
      */
-    public function createViewOrReplace(string $name, QueryBuilder|string $query): void
+    public function createViewOrReplace(string $name, QueryBuilder|string $query, array $columns = []): void
     {
         $name = $this->getConnection()->getSchemaGrammar()->wrapTable($name);
+        if (filled($columns)) {
+            $columns = $this->getConnection()->getSchemaGrammar()->columnize($columns);
+            $name = "{$name} ({$columns})";
+        }
         $query = Query::toSql($query);
         $this->getConnection()->statement("create or replace view {$name} as {$query}");
     }

src/Support/Facades/Schema.php

@@ -18,9 +18,9 @@
  * @method static void createFunctionOrReplace(string $name, array $parameters, array|string $return, string $language, string $body, array $options = [])
  * @method static void createRecursiveView(string $name, Builder|string $query, array $columns)
  * @method static void createRecursiveViewOrReplace(string $name, Builder|string $query, array $columns)
- * @method static void createMaterializedView(string $name, Builder|string $query, bool $withData = true)
- * @method static void createView(string $name, Builder|string $query)
- * @method static void createViewOrReplace(string $name, Builder|string $query)
+ * @method static void createMaterializedView(string $name, Builder|string $query, bool $withData = true, array $columns = [])
+ * @method static void createView(string $name, Builder|string $query, array $columns = [])
+ * @method static void createViewOrReplace(string $name, Builder|string $query, array $columns = [])
  * @method static void dropExtension(string ...$name)
  * @method static void dropExtensionIfExists(string ...$name)
  * @method static void dropFunction(string $name, ?array $arguments = null)

tests/Migration/ViewTest.php

@@ -10,6 +10,14 @@
 
 class ViewTest extends TestCase
 {
+    public function testCreateMaterializedViewWithColumns(): void
+    {
+        $queries = $this->withQueryLog(function (): void {
+            Schema::createMaterializedView('test_553410', DB::query()->selectRaw('random()'), columns: ['column_221818']);
+        });
+        $this->assertEquals(['create materialized view "test_553410" ("column_221818") as select random() with data'], array_column($queries, 'query'));
+    }
+
     public function testCreateMaterializedViewWithData(): void
     {
         $queries = $this->withQueryLog(function (): void {
@@ -58,6 +66,22 @@ public function testCreateViewOrReplace(): void
         $this->assertEquals(['create or replace view "test_623631" as select random() as column_449988'], array_column($queries, 'query'));
     }
 
+    public function testCreateViewOrReplaceWithColumns(): void
+    {
+        $queries = $this->withQueryLog(function (): void {
+            Schema::createViewOrReplace('test_623632', DB::query()->selectRaw('random()'), ['column_449989']);
+        });
+        $this->assertEquals(['create or replace view "test_623632" ("column_449989") as select random()'], array_column($queries, 'query'));
+    }
+
+    public function testCreateViewWithColumns(): void
+    {
+        $queries = $this->withQueryLog(function (): void {
+            Schema::createView('test_787483', DB::query()->selectRaw('random()'), ['column_275665']);
+        });
+        $this->assertEquals(['create view "test_787483" ("column_275665") as select random()'], array_column($queries, 'query'));
+    }
+
     public function testDropView(): void
     {
         DB::statement('CREATE VIEW test_125382 AS SELECT random() as column_298864');