fix: db wipe support for materialized views and timescale (resolves #104)

Author: tpetry

src/Schema/Builder.php

@@ -14,6 +14,7 @@ class Builder extends PostgresBuilder
     use BuilderExtension;
     use BuilderFunction;
     use BuilderView;
+    use BuilderWipe;
 
     /**
      * Get the database connection instance.

src/Schema/BuilderWipe.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tpetry\PostgresqlEnhanced\Schema;
+
+trait BuilderWipe
+{
+    public function dropAllContinuousAggregates(): void
+    {
+        $continuousAggregates = rescue(
+            callback: fn () => $this->getConnection()->table('timescaledb_information.continuous_aggregates')->select(['view_schema', 'view_name'])->whereIn('view_schema', $this->getActiveSchemas())->get(),
+            rescue: [],
+            report: false,
+        );
+        foreach ($continuousAggregates as $continuousAggregate) {
+            $name = "{$continuousAggregate->view_schema}.{$continuousAggregate->view_name}";
+            if (!\in_array($name, $this->connection->getConfig('dont_drop') ?? [])) {
+                $this->connection->statement("drop materialized view if exists {$this->grammar->wrap($name)} cascade");
+            }
+        }
+    }
+
+    public function dropAllHypertables(): void
+    {
+        $hypertables = rescue(
+            callback: fn () => $this->getConnection()->table('timescaledb_information.hypertables')->select(['hypertable_schema', 'hypertable_name'])->whereIn('hypertable_schema', $this->getActiveSchemas())->get(),
+            rescue: [],
+            report: false,
+        );
+        foreach ($hypertables as $hypertable) {
+            $name = "{$hypertable->hypertable_schema}.{$hypertable->hypertable_name}";
+            if (!\in_array($name, $this->connection->getConfig('dont_drop') ?? [])) {
+                $this->connection->statement("drop table if exists {$this->grammar->wrap($name)} cascade");
+            }
+        }
+    }
+
+    public function dropAllMaterializedViews(): void
+    {
+        $materializedViews = $this->getConnection()->table('pg_matviews')->select(['schemaname', 'matviewname'])->whereIn('schemaname', $this->getActiveSchemas())->get();
+        foreach ($materializedViews as $materializedView) {
+            $name = "{$materializedView->schemaname}.{$materializedView->matviewname}";
+            if (!\in_array($name, $this->connection->getConfig('dont_drop') ?? [])) {
+                $this->connection->statement("drop materialized view if exists {$this->grammar->wrap($name)} cascade");
+            }
+        }
+    }
+
+    public function dropAllTables(): void
+    {
+        $this->dropAllHypertables();
+        parent::dropAllTables();
+    }
+
+    public function dropAllViews(): void
+    {
+        $this->dropAllContinuousAggregates();
+        $this->dropAllMaterializedViews();
+        parent::dropAllViews();
+    }
+
+    /**
+     * @return string[]
+     */
+    private function getActiveSchemas(): array
+    {
+        return rescue(
+            callback: fn () => $this->getCurrentSchemaListing(), // Laravel >= 12.x
+            rescue: [$this->connection->getConfig('schema') ?? 'public'], // Laravel < 12.x
+            report: false,
+        );
+    }
+}

tests/Migration/ExtensionTimescaleTest.php

@@ -6,6 +6,7 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
+use Illuminate\Support\Facades\Artisan;
 use Tpetry\PostgresqlEnhanced\Schema\Blueprint;
 use Tpetry\PostgresqlEnhanced\Schema\Grammars\Grammar;
 use Tpetry\PostgresqlEnhanced\Schema\Timescale\Actions\Action;
@@ -341,6 +342,23 @@ public function testCreateContinuousAggregate(): void
         ], array_column($queries, 'query'));
     }
 
+    public function testDbWipeWillRemoveAllTimescaleStuff(): void
+    {
+        Schema::create('hypertbl', function (Blueprint $table): void {
+            $table->text('tenant_id');
+            $table->timestampsTz();
+            $table->timescale(new CreateHypertable('created_at', '14 days'));
+        });
+        Schema::continuousAggregate('hypertbl_agg', function (CaggBlueprint $table): void {
+            $table->as("select time_bucket('1 day', created_at) bucket, tenant_id, count(*) from hypertbl group by bucket, tenant_id");
+        });
+
+        Artisan::call('db:wipe --drop-views');
+
+        $this->assertEquals(0, $this->getConnection()->table('timescaledb_information.hypertables')->count());
+        $this->assertEquals(0, $this->getConnection()->table('timescaledb_information.continuous_aggregates')->count());
+    }
+
     public function testDropContinuousAggregate(): void
     {
         $this->getConnection()->statement('create table hypertbl(time timestamptz)');

tests/Migration/ViewTest.php

@@ -4,6 +4,7 @@
 
 namespace Tpetry\PostgresqlEnhanced\Tests\Migration;
 
+use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\DB;
 use Tpetry\PostgresqlEnhanced\Support\Facades\Schema;
 use Tpetry\PostgresqlEnhanced\Tests\TestCase;
@@ -82,6 +83,15 @@ public function testCreateViewWithColumns(): void
         $this->assertEquals(['create view "test_787483" ("column_275665") as select random()'], array_column($queries, 'query'));
     }
 
+    public function testDbWipeWillRemoveMaterializedViews(): void
+    {
+        DB::statement('CREATE MATERIALIZED VIEW test_585504 AS SELECT random() as column_954390');
+
+        Artisan::call('db:wipe --drop-views');
+
+        $this->assertEmpty($this->getConnection()->select('select * from pg_matviews'));
+    }
+
     public function testDropView(): void
     {
         DB::statement('CREATE VIEW test_125382 AS SELECT random() as column_298864');