Laravel - Create Index If Not Exists / Drop Index If Exists

laravel_conditional_index_migration.php

<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class LaravelConditionalIndexMigration extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {

        Schema::table('tablename', function (Blueprint $table) {
            $sm = Schema::getConnection()->getDoctrineSchemaManager();
            $doctrineTable = $sm->listTableDetails('tablename');

            if (! $doctrineTable->hasIndex('singlecolumnindexname')) {
                $table->index('column1', 'singlecolumnindexname');
            }
                      
            if (! $doctrineTable->hasIndex('multicolumnindexname')) {
                $table->index(['column2', 'column3'], 'multicolumnindexname');
            }
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {

        Schema::table('tablename', function (Blueprint $table) {
            $sm = Schema::getConnection()->getDoctrineSchemaManager();
            $doctrineTable = $sm->listTableDetails('tablename');

            if ($doctrineTable->hasIndex('singlecolumnindexname')) {
                $table->dropIndex('singlecolumnindexname');
            }
            if ($doctrineTable->hasIndex('multicolumnindexname')) {
                $table->dropIndex('multicolumnindexname');
            }
        });

    }
}

Thanks! Great stuff 🙇‍♂️ 💯

In Laravel 11 Symfony's DBAL has been replaced by Laravel's native classes so above solutions does not work anymore. Here's the working dropIndexIfNotExists for Laravel 11.

<?php

namespace App\Traits;

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

trait MigrationIndex
{
    public function dropIndexIfExist(string $tableName, string $indexName): void
    {
        $indexes = Schema::getIndexes($tableName);

        foreach ($indexes as $index) {
            if ($index['name'] === $indexName) {
                Schema::table($tableName, static function (Blueprint $table) use ($indexName) {
                    $table->dropIndex($indexName);
                });
            }
        }
    }
}