index ifNotExists() modifier (references #82)

Author: tpetry

README.md

@@ -31,6 +31,7 @@ composer require tpetry/laravel-postgresql-enhanced
         - [Nulls Not Distinct](#nulls-not-distinct)
         - [Partial Indexes](#partial-indexes)
         - [Include Columns](#include-columns)
+        - [If Not Exists](#if-not-exists)
         - [Storage Parameters](#storage-parameters-index)
         - [Functional Indexes / Column Options](#functional-indexes--column-options)
         - [Fulltext Indexes](#fulltext-indexes)
@@ -452,6 +453,27 @@ Schema::table('users', function(Blueprint $table) {
 ```
 Columns are included in an index with the `include` method on an index created by `index()`, `spatialIndex` or `uniqueIndex`.
 
+#### If Not Exists
+
+Sometimes, you fix performance issues by testing new indexes on the production database rather than pushing a new migration each time.
+But when you find the perfect one, you should also make a migration for it.
+Dropping the existing index to recreate it by the migration is silly.
+Right?
+You can now skip the index creation from the migration when the exact index already exists.
+
+```php
+use Tpetry\PostgresqlEnhanced\Schema\Blueprint;
+use Tpetry\PostgresqlEnhanced\Support\Facades\Schema;
+
+Schema::table('invoices', function(Blueprint $table) {
+    $table->index(['target', 'division', 'date'])->ifNotExists();
+});
+```
+
+> [!TIP]
+> Indexes are determined to be identical by their (automatically-generated) name.
+> Either create the index statement to run in production by temporary migrations from your development machine or use specific index names.
+
 #### Storage Parameters (Index)
 
 In some cases you want to specify the storage parameters of an index. If you are using gin indexes you should read the article [Debugging random slow writes in PostgreSQL](https://iamsafts.com/posts/postgres-gin-performance/) why storage parameters for a gin index are important:

src/Schema/Grammars/GrammarIndex.php

@@ -167,6 +167,7 @@ private function genericCompileCreateIndex(Blueprint $blueprint, Fluent $command
 
         $index = [
             $unique ? 'create unique index' : 'create index',
+            $command['ifNotExists'] ? 'if not exists' : '',
             $this->wrap($command['index']),
             'on',
             $this->wrapTable($blueprint),

src/Schema/IndexDefinition.php

@@ -11,6 +11,14 @@
  */
 class IndexDefinition extends BaseIndexDefinition
 {
+    /**
+     * Only create index if it does not exist yet (PostgreSQL).
+     */
+    public function ifNotExists(): self
+    {
+        return $this;
+    }
+
     /**
      * Include non-key columns in the index (PostgreSQL).
      *

tests/Migration/IndexOptionsTest.php

@@ -12,6 +12,135 @@
 
 class IndexOptionsTest extends TestCase
 {
+    public function testIfNotExistsFulltextByColumn(): void
+    {
+        if (Comparator::lessThan($this->app->version(), '8.74.0')) {
+            $this->markTestSkipped('Fulltext indexes have been added in a later Laraverl version.');
+        }
+
+        Schema::create('test_806712', function (Blueprint $table): void {
+            $table->string('col_274742');
+        });
+        $queries = $this->withQueryLog(function (): void {
+            Schema::table('test_806712', function (Blueprint $table): void {
+                $table->fullText(['col_274742'])->ifNotExists();
+            });
+        });
+        $this->assertEquals(['create index if not exists "test_806712_col_274742_fulltext" on "test_806712" using gin ((to_tsvector(\'english\', "col_274742")))'], array_column($queries, 'query'));
+    }
+
+    public function testIfNotExistsFulltextByName(): void
+    {
+        if (Comparator::lessThan($this->app->version(), '8.74.0')) {
+            $this->markTestSkipped('Fulltext indexes have been added in a later Laraverl version.');
+        }
+
+        Schema::create('test_940928', function (Blueprint $table): void {
+            $table->string('col_563370');
+        });
+        $queries = $this->withQueryLog(function (): void {
+            Schema::table('test_940928', function (Blueprint $table): void {
+                $table->fullText(['col_563370'], 'index_726055')->ifNotExists();
+            });
+        });
+        $this->assertEquals(['create index if not exists "index_726055" on "test_940928" using gin ((to_tsvector(\'english\', "col_563370")))'], array_column($queries, 'query'));
+    }
+
+    public function testIfNotExistsIndexByColumn(): void
+    {
+        Schema::create('test_233704', function (Blueprint $table): void {
+            $table->string('col_484213');
+        });
+        $queries = $this->withQueryLog(function (): void {
+            Schema::table('test_233704', function (Blueprint $table): void {
+                $table->index(['col_484213'])->ifNotExists();
+            });
+        });
+        $this->assertEquals(['create index if not exists "test_233704_col_484213_index" on "test_233704" ("col_484213")'], array_column($queries, 'query'));
+    }
+
+    public function testIfNotExistsIndexByName(): void
+    {
+        Schema::create('test_101004', function (Blueprint $table): void {
+            $table->string('col_749919');
+        });
+        $queries = $this->withQueryLog(function (): void {
+            Schema::table('test_101004', function (Blueprint $table): void {
+                $table->index(['col_749919'], 'index_605253')->ifNotExists();
+            });
+        });
+        $this->assertEquals(['create index if not exists "index_605253" on "test_101004" ("col_749919")'], array_column($queries, 'query'));
+    }
+
+    public function testIfNotExistsRawIndex(): void
+    {
+        if (Comparator::lessThan($this->app->version(), '7.7.0')) {
+            $this->markTestSkipped('Raw indexes have been added in a later Laravel version.');
+        }
+
+        Schema::create('test_302103', function (Blueprint $table): void {
+            $table->string('col_650398');
+        });
+        $queries = $this->withQueryLog(function (): void {
+            Schema::table('test_302103', function (Blueprint $table): void {
+                $table->rawIndex('col_650398', 'idx_728687')->ifNotExists();
+            });
+        });
+        $this->assertEquals(['create index if not exists "idx_728687" on "test_302103" (col_650398)'], array_column($queries, 'query'));
+    }
+
+    public function testIfNotExistsSpatialIndexByColumn(): void
+    {
+        Schema::create('test_508190', function (Blueprint $table): void {
+            $table->integerRange('col_402778');
+        });
+        $queries = $this->withQueryLog(function (): void {
+            Schema::table('test_508190', function (Blueprint $table): void {
+                $table->spatialIndex(['col_402778'])->ifNotExists();
+            });
+        });
+        $this->assertEquals(['create index if not exists "test_508190_col_402778_spatialindex" on "test_508190" using gist ("col_402778")'], array_column($queries, 'query'));
+    }
+
+    public function testIfNotExistsSpatialIndexByName(): void
+    {
+        Schema::create('test_521621', function (Blueprint $table): void {
+            $table->integerRange('col_990392');
+        });
+        $queries = $this->withQueryLog(function (): void {
+            Schema::table('test_521621', function (Blueprint $table): void {
+                $table->spatialIndex(['col_990392'], 'index_124848')->ifNotExists();
+            });
+        });
+        $this->assertEquals(['create index if not exists "index_124848" on "test_521621" using gist ("col_990392")'], array_column($queries, 'query'));
+    }
+
+    public function testIfNotExistsUniqueIndexByColumn(): void
+    {
+        Schema::create('test_868599', function (Blueprint $table): void {
+            $table->string('col_571721');
+        });
+        $queries = $this->withQueryLog(function (): void {
+            Schema::table('test_868599', function (Blueprint $table): void {
+                $table->uniqueIndex(['col_571721'])->ifNotExists();
+            });
+        });
+        $this->assertEquals(['create unique index if not exists "test_868599_col_571721_unique" on "test_868599" ("col_571721")'], array_column($queries, 'query'));
+    }
+
+    public function testIfNotExistsUniqueIndexByName(): void
+    {
+        Schema::create('test_324400', function (Blueprint $table): void {
+            $table->string('col_208151');
+        });
+        $queries = $this->withQueryLog(function (): void {
+            Schema::table('test_324400', function (Blueprint $table): void {
+                $table->uniqueIndex(['col_208151'], 'index_810276')->ifNotExists();
+            });
+        });
+        $this->assertEquals(['create unique index if not exists "index_810276" on "test_324400" ("col_208151")'], array_column($queries, 'query'));
+    }
+
     public function testIncludeIndexByColumn(): void
     {
         Schema::create('test_130163', function (Blueprint $table): void {