Check If a Column Exists in Laravel Migration File

A safety racket for dropping columns

Let's play safe when dropping columns to prevent errors. Laravel's Schema::hasColumn() method can be your lifesaver while writing the down() method in migrations to ensure a smooth rollback.

Here's how to do a conditional drop:

public function down()
{
    if (Schema::hasColumn('users', 'phone')) {
        Schema::table('users', function (Blueprint $table) {
            $table->dropColumn('phone');
            // "Phone" has left the chat
        });
    }
    // If the "phone" wasn't at the party, no harm done.
}


This code ensures that even the column was not invited to the party (i.e., missed due to a branch merge or manual removal), your migrations can still reverse smoothly without crashing the party.

The journey to smoother migrations

Creating maintainable migrations

Scaling applications require us to future-proof our migrations. Encapsulating the dropColumn logic within a reusable method or extending the Blueprint for custom conditional actions fits the bill:

function dropColumnIfExists($tableName, $columnName)
{
    if (Schema::hasColumn($tableName, $columnName)) {
        Schema::table($tableName, function (Blueprint $table) use ($columnName) {
            $table->dropColumn($columnName);
            // Column has left the database... quietly.
        });
    }
}


And then:

public function down()
{
    dropColumnIfExists('users', 'phone');
    // If 'phone' was thus dropped, expect a goodbye text!
}


Mind the variable scope

Keeping an eye on variable scope is just as important as keeping an eye on your cup of coffee. When using the use keyword in the context of Schema::table(), we ensure that $columnName is always invited to the party!

public function down()
{
    $columnName = 'phone';
    if (Schema::hasColumn('users', $columnName)) {
        Schema::table('users', function (Blueprint $table) use ($columnName) {
            $table->dropColumn($columnName);
            // 'columnName' saw the party through to the end! 🎉
        });
    }
}


Ensure uniformity for all databases

By using Schema::hasColumn(), we're creating a universal code of conduct for our local, staging, and production databases. So, no matter which database you're partying with, you'll always know who made it to the guest list.