feat: Add Partial index

Author: Fureev Eugene

.meta.php

@@ -19,11 +19,13 @@ class Schema
     use Illuminate\Support\Fluent;
     use Php\Support\Laravel\Database\Schema\Definitions\LikeDefinition;
     use Php\Support\Laravel\Database\Schema\Definitions\UniqueDefinition;
+    use Php\Support\Laravel\Database\Schema\Definitions\PartialDefinition;
     use Php\Support\Laravel\Database\Schema\Definitions\ViewDefinition;
 
     /**
      * @method LikeDefinition like(string $table)
      * @method Fluent ifNotExists()
+     * @method PartialDefinition partial($columns, ?string $index = null, ?string $algorithm = null)
      * @method UniqueDefinition uniquePartial($columns, ?string $index = null, ?string $algorithm = null)
      * @method ViewDefinition createView(string $view, string $select, bool $materialize = false)
      * @method ViewDefinition createViewOrReplace(string $view, string $select, bool $materialize = false)

CHANGELOG.md

@@ -9,6 +9,12 @@ Check MD [online][check-online].
 
 ## [unreleased]
 
+## [1.10.0] - 2023-03-27
+
+### Added
+
+- Add `Partial index`
+
 ## [1.9.0] - 2023-02-24
 
 ### Added

readme.md

@@ -20,28 +20,29 @@ composer require efureev/laravel-support-db "^1.9"
 ## Contents
 
 - [Ext Column Types](#ext-column-types)
-  - [Bit](#bit)
-  - [GeoPoint](#geo-point)
-  - [GeoPath](#geo-path)
-  - [IP Network](#ip-network)
-  - [Ranges](#ranges)
-  - [UUID](#uuid)
-  - [XML](#xml)
-  - [Array of UUID](#array-of-uuid)
-  - [Array of Integer](#array-of-integer)
+    - [Bit](#bit)
+    - [GeoPoint](#geo-point)
+    - [GeoPath](#geo-path)
+    - [IP Network](#ip-network)
+    - [Ranges](#ranges)
+    - [UUID](#uuid)
+    - [XML](#xml)
+    - [Array of UUID](#array-of-uuid)
+    - [Array of Integer](#array-of-integer)
 - [Column Options](#column-options)
-  - [Compression](#compression)
+    - [Compression](#compression)
 - [Views](#views)
 - [Indexes](#indexes)
-  - [Unique Partial indexes](#unique-partial-indexes)
+    - [Partial indexes](#partial-indexes)
+    - [Unique Partial indexes](#unique-partial-indexes)
 - [Extended Schema](#extended-schema)
-  - [Create like another table](#create-like-another-table)
-  - [Create as another table with full data](#create-as-another-table-with-full-data)
-  - [Create as another table with data from select query](#create-as-another-table-with-data-from-select-query)
-  - [Drop Cascade If Exists](#drop-cascade-if-exists)
+    - [Create like another table](#create-like-another-table)
+    - [Create as another table with full data](#create-as-another-table-with-full-data)
+    - [Create as another table with data from select query](#create-as-another-table-with-data-from-select-query)
+    - [Drop Cascade If Exists](#drop-cascade-if-exists)
 - [Extended Query Builder](#extended-query-builder)
-  - [Update records and return deleted records` columns](#update-records-and-return-updated-records-columns)
-  - [Delete records and return deleted records` columns](#delete-records-and-return-deleted-records-columns)
+    - [Update records and return deleted records` columns](#update-records-and-return-updated-records-columns)
+    - [Delete records and return deleted records` columns](#delete-records-and-return-deleted-records-columns)
 - [Extensions](#extensions)
 
 ### Ext Column Types
@@ -201,6 +202,33 @@ Schema::dropViewIfExists('active_users');
 
 ### Indexes
 
+#### Partial indexes
+
+See: https://www.postgresql.org/docs/current/indexes-partial.html
+
+Example:
+
+```php
+use \Php\Support\Laravel\Database\Schema\Postgres\Blueprint;
+Schema::create('table', static function (Blueprint $table) {
+    $table->string('code'); 
+    $table->softDeletes();
+    $table
+        ->partial('code')
+        ->whereNull('deleted_at');
+});
+```
+
+If you want to delete partial index, use this method:
+
+```php
+use \Php\Support\Laravel\Database\Schema\Postgres\Blueprint;
+
+Schema::create('table', static function (Blueprint $table) {
+    $table->dropPartial(['code']);
+});
+```
+
 #### Unique Partial indexes
 
 Example:

src/Schema/Definitions/PartialDefinition.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Php\Support\Laravel\Database\Schema\Definitions;
+
+use Illuminate\Support\Fluent;
+
+/**
+ * @method self where(string $column, $operator, $value, $boolean = 'and')
+ * @method self whereRaw($sql, $bindings = [], $boolean = 'and')
+ * @method self whereColumn($first, $operator, $second, $boolean = 'and')
+ * @method self whereIn(string $column, $values = [], $boolean = 'and', $not = false)
+ * @method self whereNotIn(string $column, $values = [], $boolean = 'and')
+ * @method self whereBetween(string $column, $values, $boolean = 'and', $not = false)
+ * @method self whereNotBetween(string $column, $values, $boolean = 'and')
+ * @method self whereNull(string $column, $boolean = 'and', $not = false)
+ * @method self whereNotNull(string $column, $boolean = 'and')
+ * @method self whereBool(string $column, bool $value, $boolean = 'and')
+ * @method self whereTrue(string $column, $boolean = 'and')
+ * @method self whereFalse(string $column, $boolean = 'and')
+ */
+class PartialDefinition extends Fluent
+{
+}

src/Schema/Postgres/Blueprint.php

@@ -12,8 +12,10 @@
 use Illuminate\Support\Fluent;
 use Php\Support\Laravel\Database\Schema\Definitions\ColumnDefinition;
 use Php\Support\Laravel\Database\Schema\Definitions\LikeDefinition;
+use Php\Support\Laravel\Database\Schema\Definitions\PartialDefinition;
 use Php\Support\Laravel\Database\Schema\Definitions\UniqueDefinition;
 use Php\Support\Laravel\Database\Schema\Definitions\ViewDefinition;
+use Php\Support\Laravel\Database\Schema\Postgres\Builders\Indexes\PartialBuilder;
 use Php\Support\Laravel\Database\Schema\Postgres\Builders\Indexes\Unique\UniqueBuilder;
 
 class Blueprint extends BaseBlueprint
@@ -180,7 +182,7 @@ public function intArray(string $column): ColumnDefinition
      *
      * @return ColumnDefinition
      */
-    public function addColumn($type, $name, array $parameters = [])
+    public function addColumn($type, $name, array $parameters = []): ColumnDefinition
     {
         return $this->addColumnDefinition(
             new ColumnDefinition(
@@ -282,6 +284,26 @@ public function uniquePartial($columns, ?string $index = null, ?string $algorith
         );
     }
 
+    /**
+     * @param array|string $columns
+     * @param string|null $index
+     * @param string|null $algorithm
+     *
+     * @return PartialDefinition|PartialBuilder
+     */
+    public function partial($columns, ?string $index = null, ?string $algorithm = null): Fluent
+    {
+        $columns = (array)$columns;
+
+        $index = $index ?: $this->createIndexName('partial', $columns);
+
+        return $this->addExtendedCommand(
+            PartialBuilder::class,
+            'partial',
+            compact('columns', 'index', 'algorithm')
+        );
+    }
+
     public function ginIndex($columns, ?string $name = null): Fluent
     {
         return $this->indexCommand('index', $columns, $name, 'gin');
@@ -292,6 +314,11 @@ public function dropUniquePartial($index): Fluent
         return $this->dropIndexCommand('dropIndex', 'unique', $index);
     }
 
+    public function dropPartial($index): Fluent
+    {
+        return $this->dropIndexCommand('dropIndex', 'partial', $index);
+    }
+
     protected function getSchemaManager()
     {
         return Schema::getConnection()->getDoctrineSchemaManager();

src/Schema/Postgres/Builders/Indexes/PartialBuilder.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Php\Support\Laravel\Database\Schema\Postgres\Builders\Indexes;
+
+use Illuminate\Support\Fluent;
+use Php\Support\Laravel\Database\Schema\Postgres\Builders\WhereBuilderTrait;
+
+class PartialBuilder extends Fluent
+{
+    use WhereBuilderTrait;
+}

src/Schema/Postgres/Compilers/PartialCompiler.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Php\Support\Laravel\Database\Schema\Postgres\Compilers;
+
+use Php\Support\Laravel\Database\Schema\Postgres\Blueprint;
+use Php\Support\Laravel\Database\Schema\Postgres\Builders\Indexes\PartialBuilder;
+use Php\Support\Laravel\Database\Schema\Postgres\Grammar;
+
+class PartialCompiler
+{
+    use WheresBuilder;
+
+    public static function compile(
+        Grammar $grammar,
+        Blueprint $blueprint,
+        PartialBuilder $fluent
+    ): string {
+        $wheres = static::build($grammar, $blueprint, $fluent);
+
+        $where = count($wheres) === 0 ? '' : ' WHERE %s';
+        return sprintf(
+            "CREATE INDEX %s ON %s (%s)$where",
+            $fluent->get('index'),
+            $blueprint->getTable(),
+            implode(',', (array)$fluent->get('columns')),
+            static::removeLeadingBoolean(implode(' ', $wheres))
+        );
+    }
+}

src/Schema/Postgres/Grammar/GrammarIndexes.php

@@ -4,10 +4,11 @@
 
 namespace Php\Support\Laravel\Database\Schema\Postgres\Grammar;
 
-use Illuminate\Support\Fluent;
 use Php\Support\Laravel\Database\Schema\Postgres\Blueprint;
+use Php\Support\Laravel\Database\Schema\Postgres\Builders\Indexes\PartialBuilder;
 use Php\Support\Laravel\Database\Schema\Postgres\Builders\Indexes\Unique\UniqueBuilder;
 use Php\Support\Laravel\Database\Schema\Postgres\Builders\Indexes\Unique\UniquePartialBuilder;
+use Php\Support\Laravel\Database\Schema\Postgres\Compilers\PartialCompiler;
 use Php\Support\Laravel\Database\Schema\Postgres\Compilers\UniqueCompiler;
 
 trait GrammarIndexes
@@ -20,4 +21,9 @@ public function compileUniquePartial(Blueprint $blueprint, UniqueBuilder $comman
         }
         return $this->compileUnique($blueprint, $command);
     }
+
+    public function compilePartial(Blueprint $blueprint, PartialBuilder $command): string
+    {
+        return PartialCompiler::compile($this, $blueprint, $command);
+    }
 }