Extend support for materialized views (#20)

* Extend support for materialized views (#18)

* Extend support for materialized views

Author: staudenmeir

README.md

@@ -150,6 +150,21 @@ Use `refreshMaterializedView()` to refresh a materialized view:
 Schema::refreshMaterializedView('active_users');
 ```
 
+Use `dropMaterializedView()` or `dropMaterializedViewIfExists()` to drop a materialized view:
+
+```php
+Schema::dropMaterializedView('active_users');
+Schema::dropMaterializedViewIfExists('active_users');
+```
+
+Use `hasMaterializedView()` to check whether a materialized view exists:
+
+```php
+if (Schema::hasMaterializedView('active_users')) {
+    //
+}
+```
+
 ## Contributing
 
 Please see [CONTRIBUTING](.github/CONTRIBUTING.md) and [CODE OF CONDUCT](.github/CODE_OF_CONDUCT.md) for details.

src/Facades/Schema.php

@@ -23,8 +23,11 @@
  * @method static void renameView(string $from, string $to)
  * @method static void dropView(string $name, bool $ifExists = false)
  * @method static void dropViewIfExists(string $name)
+ * @method static void dropMaterializedView(string $name)
+ * @method static void dropMaterializedViewIfExists(string $name)
  * @method static list<string> getViewColumnListing(string $name)
  * @method static void refreshMaterializedView(string $name)
+ * @method static bool hasMaterializedView(string $name)
  *
  * @mixin \Illuminate\Support\Facades\Schema
  */

src/Schema/Builders/ManagesViews.php

@@ -3,6 +3,7 @@
 namespace Staudenmeir\LaravelMigrationViews\Schema\Builders;
 
 use Illuminate\Support\Str;
+use RuntimeException;
 use Stringable;
 
 trait ManagesViews
@@ -123,15 +124,16 @@ public function renameView($from, $to)
      *
      * @param string $name
      * @param bool $ifExists
+     * @param bool $materialized
      * @return void
      */
-    public function dropView($name, $ifExists = false)
+    public function dropView($name, $ifExists = false, bool $materialized = false)
     {
         /** @var \Staudenmeir\LaravelMigrationViews\Schema\Grammars\ViewGrammar $grammar */
         $grammar = $this->grammar;
 
         $this->connection->statement(
-            $grammar->compileDropView($name, $ifExists)
+            $grammar->compileDropView($name, $ifExists, $materialized)
         );
     }
 
@@ -146,6 +148,28 @@ public function dropViewIfExists($name)
         $this->dropView($name, true);
     }
 
+    /**
+     * Drop a materialized view from the schema.
+     *
+     * @param string $name
+     * @return void
+     */
+    public function dropMaterializedView(string $name): void
+    {
+        $this->dropView($name, materialized: true);
+    }
+
+    /**
+     * Drop a materialized view from the schema if it exists.
+     *
+     * @param string $name
+     * @return void
+     */
+    public function dropMaterializedViewIfExists(string $name): void
+    {
+        $this->dropView($name, ifExists: true, materialized: true);
+    }
+
     /**
      * Get the column listing for a given view.
      *
@@ -175,4 +199,15 @@ public function refreshMaterializedView(string $name): void
             $grammar->compileRefreshMaterializedView($name)
         );
     }
+
+    /**
+     * Determine if the given materialized view exists.
+     *
+     * @param string $name
+     * @return bool
+     */
+    public function hasMaterializedView(string $name): bool
+    {
+        throw new RuntimeException('This database is not supported.'); // @codeCoverageIgnore
+    }
 }

src/Schema/Builders/PostgresBuilder.php

@@ -26,4 +26,26 @@ protected function stringifyBindings(array $bindings)
 
         return $this->baseStringifyBindings($bindings);
     }
+
+    /**
+     * Determine if the given materialized view exists.
+     *
+     * @param string $name
+     * @return bool
+     */
+    public function hasMaterializedView(string $name): bool
+    {
+        /** @var string $view */
+        [$schema, $view] = $this->parseSchemaAndTable($name, true);
+
+        $view = $this->connection->getTablePrefix().$view;
+
+        /** @var \Staudenmeir\LaravelMigrationViews\Schema\Grammars\PostgresGrammar $grammar */
+        $grammar = $this->grammar;
+
+        return (bool) $this->connection->scalar(
+            $grammar->compileMaterializedViewExists(),
+            [$schema, $view]
+        );
+    }
 }

src/Schema/Builders/SqlServerBuilder.php

@@ -34,9 +34,10 @@ public function createView($name, $query, ?array $columns = null, $orReplace = f
      *
      * @param string $name
      * @param bool $ifExists
+     * @param bool $materialized
      * @return void
      */
-    public function dropView($name, $ifExists = false)
+    public function dropView($name, $ifExists = false, bool $materialized = false)
     {
         /** @var \Staudenmeir\LaravelMigrationViews\Schema\Grammars\ViewGrammar $grammar */
         $grammar = $this->grammar;

src/Schema/Grammars/CompilesViews.php

@@ -31,13 +31,16 @@ public function compileCreateView($name, $query, $columns, $orReplace, bool $mat
      *
      * @param string $name
      * @param bool $ifExists
+     * @param bool $materialized
      * @return string
      */
-    public function compileDropView($name, $ifExists)
+    public function compileDropView($name, $ifExists, bool $materialized = false)
     {
         $ifExists = $ifExists ? 'if exists ' : '';
 
-        return 'drop view '.$ifExists.$this->wrapTable($name);
+        $materializedSql = $materialized ? 'materialized ' : '';
+
+        return 'drop '.$materializedSql.'view '.$ifExists.$this->wrapTable($name);
     }
 
     /**

src/Schema/Grammars/PostgresGrammar.php

@@ -7,4 +7,20 @@
 class PostgresGrammar extends Base implements ViewGrammar
 {
     use CompilesViews;
+
+    /**
+     * Compile the query to determine if a materialized view exists.
+     *
+     * @return string
+     */
+    public function compileMaterializedViewExists(): string
+    {
+        return <<<SQL
+select exists (
+    select 1
+    from "pg_matviews"
+    where "schemaname" = ? and "matviewname" = ?
+)
+SQL;
+    }
 }

src/Schema/Grammars/SqlServerGrammar.php

@@ -9,7 +9,7 @@ class SqlServerGrammar extends Base implements ViewGrammar
     use CompilesViews;
 
     /** @inheritDoc */
-    public function compileDropView($name, $ifExists)
+    public function compileDropView($name, $ifExists, bool $materialized = false)
     {
         $ifExists = $ifExists ? 'if exists ('.$this->compileViewExists().') ' : '';
 

src/Schema/Grammars/ViewGrammar.php

@@ -22,9 +22,10 @@ public function compileCreateView($name, $query, $columns, $orReplace, bool $mat
      *
      * @param string $name
      * @param bool $ifExists
+     * @param bool $materialized
      * @return string
      */
-    public function compileDropView($name, $ifExists);
+    public function compileDropView($name, $ifExists, bool $materialized = false);
 
     /**
      * Compile the query to refresh a materialized view.

tests/SchemaTest.php

@@ -127,6 +127,33 @@ public function testDropViewIfExists()
         $this->assertFalse(Schema::hasView('active_users'));
     }
 
+    public function testDropMaterializedView(): void
+    {
+        if ($this->connection !== 'pgsql') {
+            $this->markTestSkipped();
+        }
+
+        Schema::createMaterializedView(
+            'active_users',
+            DB::table('users')->where('active', true)
+        );
+
+        Schema::dropMaterializedView('active_users');
+
+        $this->assertFalse(Schema::hasMaterializedView('active_users'));
+    }
+
+    public function testDropMaterializedViewIfExists(): void
+    {
+        if ($this->connection !== 'pgsql') {
+            $this->markTestSkipped();
+        }
+
+        Schema::dropMaterializedViewIfExists('active_users');
+
+        $this->assertFalse(Schema::hasMaterializedView('active_users'));
+    }
+
     public function testGetViewColumnListing()
     {
         Schema::createView('active_users', DB::table('users')->where('active', true));
@@ -154,4 +181,20 @@ public function testRefreshMaterializedView()
 
         $this->assertDatabaseCount('active_users', 0);
     }
+
+    public function testHasMaterializedView(): void
+    {
+        if ($this->connection !== 'pgsql') {
+            $this->markTestSkipped();
+        }
+
+        $this->assertFalse(Schema::hasMaterializedView('active_users'));
+
+        Schema::createMaterializedView(
+            'active_users',
+            DB::table('users')->where('active', true)
+        );
+
+        $this->assertTrue(Schema::hasMaterializedView('active_users'));
+    }
 }