この記事では

Laravelでデータベーステーブルのカラム名を変更する方法

を解説します。

検証はLaravel11で実施しました。

Laravelではマイグレーションファイルを作成・編集し、コマンドでテーブルを作成します。

その際、テーブルのカラム名を間違えて入力してしまうということも起こりえます。

また、仕様変更によってカラム名の変更が必要となる可能性も考えられるでしょう。

ケケンタ

今回ご紹介する方法を用いることで簡単にカラム名を変更できるので、ぜひご活用ください！

あわせて読みたい

PHPやWordPressを学ぶのにおすすめのプログラミングスクール【７選】 僕はこれまで独学でPHPを学習してきました。結論から言えば、それでもPHPを習得することはできました。 しかし、それに費やした累計学習期間は1年ほど。モチベーション…

【解説】Laravelでデータベースのカラム名を変更する方法

STEP１　マイグレーションファイルを作成する

まずは以下のコマンドでマイグレーションファイルを作成しましょう。

 php artisan make:migration change_column_name_comments_table

「change_column_name_comments_table」の部分の名前は任意です。（分かりやすい名前を推奨）

STEP２　マイグレーションファイルを編集する

続いて、作成されたマイグレーションファイルを編集していきます。

今回はnicesテーブルの外部キーを「comment_id」とするべきところ、誤って「post_id」にしてしまった状況を想定しています。

<?php

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

return new class extends Migration
{
    /**
     * マイグレーション実行時に動く処理
     */
    public function up(): void
    {
        Schema::table('nices', function (Blueprint $table) {
            $table->renameColumn('post_id', 'comment_id')->change();
        });
    }

    /**
     * ロールバック実行時に動く処理
     */
    public function down(): void
    {
        Schema::table('nices', function (Blueprint $table) {
            $table->renameColumn('comment_id', 'post_id')->change();
        });
    }
};

主な編集個所はup()関数とdown()関数の２つです。

Laravelにはchange()関数が用意されており、以下のように記述することでカラム名を変更することが可能です。

$table->renameColumn('post_id', 'comment_id')->change();

また、down()関数にも以下の処理を記述しています。

down()関数

$table->renameColumn('comment_id', 'post_id')->change();

down()関数はロールバック実行時に動く関数です。

ここに記述するのは、簡単に言えばup()関数で実行させる処理と逆の処理です。
※今回は「post_id」を「comment_id」へ修正しているため、down()関数の方には、その反対の処理を記述しています。

down()はマイグレーション実行時には動きませんが、ロールバックするときに正しく処理が書かれていないとエラーが発生するためご注意ください。

STEP３　マイグレーションを実行する

マイグレーションファイルが編集できたら以下のコマンドでマイグレーションを実行しましょう。

php artisan migrate

STEP４　カラム名が変更されていることを確認する

最後に、本当にカラム名が変更されたかどうかを確認してみましょう。

この記事ではSQLite3での確認方法をご紹介します。

STEP

SQLite3をCLIで起動する

Laravelプロジェクトディレクトリの直下で以下のコマンドを実行することでSQLite3をCLIで起動することができます。

sqlite3 .\database\database.sqlite

STEP

テーブル構造を確認する

SQLite3で特定のテーブル構造を確認するときは以下のコマンドを実行します。

PRAGMA table_info('nices');

STEP

SQLite3を終了する

SQLite3のCLIモードを終了するときは以下のコマンドを実行します。

.quit

末尾に「;」を付けるとエラーになるのでご注意ください。

ケケンタ

以上がLaravel11でデータベーステーブルのカラム名を変更する方法です！

まとめ

以上がLaravelでデータベーステーブルのカラム名を変更する方法でした。

人の手でおこなう以上、カラム名の記述ミスが絶対に起こらないとは言い切れません。

また、仕様変更にともなうカラム名の変更も可能性としてはゼロではないでしょう。

ケケンタ

そのようなときに今回ご紹介させていただいた内容をご活用いただければ何よりです。

それでは、最後までご覧いただきありがとうございました！

当ブログではLaravelやPHPなどWebアプリに関する情報を発信しています。

ご興味のある方はほかの記事もご覧いただけるとうれしいです！

あわせて読みたい

【Laravel】データベーステーブルのカラムタイプを変更する方法【マイグレーション】 この記事では Laravelでデータベーステーブルのカラムタイプを変更する方法 をご紹介します。 検証はLaravel11で実施しました。 Laravelではマイグレーションを実行する…

この記事では

Laravelでデータベーステーブルのカラムタイプを変更する方法

をご紹介します。

検証はLaravel11で実施しました。

Laravelではマイグレーションを実行することでデータベーステーブルを作成します。

その際、マイグレーションファイルにテーブル構造を記述しますが、「うっかりカラムタイプを誤って指定しまった！」ということもあるかもしれません。

データベースへテストデータなどを追加する前であれば、

ロールバック→マイグレーションファイル修正→再度マイグレーション実行

という流れも取れます。

しかし、もしもカラムタイプの指定が誤っていることに気が付いたのがもっと後のタイミングだった場合、単にロールバックするだけでは何かと面倒だということもあるかもしれません。

ケケンタ

今回ご紹介するのはそんなときにご活用いただける方法です！

あわせて読みたい

PHPやWordPressを学ぶのにおすすめのプログラミングスクール【７選】 僕はこれまで独学でPHPを学習してきました。結論から言えば、それでもPHPを習得することはできました。 しかし、それに費やした累計学習期間は1年ほど。モチベーション…

【解説】Laravelでデータベースのカラムタイプを変更する方法

STEP１　マイグレーションファイルを作成する

まずは以下のコマンドでマイグレーションファイルを作成しましょう。

php artisan make:migration change_posts_table_title_column_type

「change_posts_table_title_column_type」の部分の名前は任意です。（分かりやすい名前を推奨）

STEP２　マイグレーションファイルを編集する

続いて、作成されたマイグレーションファイルを編集していきます。

今回はpostsテーブルのtitleカラムのカラムタイプをstringで指定すべきところ、「うっかり」integerで指定してしまった状況を想定しています。

<?php

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

return new class extends Migration
{
    /**
     * マイグレーション実行時に動く処理
     */
    public function up(): void
    {
        Schema::table('posts', function (Blueprint $table) {
            $table->string('title')->change();
        });
    }

    /**
     * ロールバック実行時に動く処理
     */
    public function down(): void
    {
        Schema::table('posts', function (Blueprint $table) {
            $table->integer('title')->change();
        });
    }
};

主な編集個所はup()関数とdown()関数の２つです。

Laravelにはchange()関数が用意されており、以下のように記述することでカラムタイプを変更することが可能です。

$table->string('title')->change();

カラムタイプ以外にオプション（修飾子）を指定している場合は明示的な記述が必要です。
詳しくは「【補足】カラムにオプション（修飾子）を指定している場合」をご覧ください。

また、down()関数にも以下の処理を記述しています。

down()関数

$table->integer('title')->change();

down()関数はロールバック実行時に動く関数です。

ここに記述するのは、簡単に言えばup()関数で実行させる処理と逆の処理です。
※今回はinteger指定をstring指定へ修正しているため、down()関数の方には、その反対の処理を記述しています。

down()はマイグレーション実行時には動きませんが、ロールバックするときに正しく処理が書かれていないとエラーが発生するためご注意ください。

STEP３　マイグレーションを実行する

マイグレーションファイルが編集できたら以下のコマンドでマイグレーションを実行しましょう。

php artisan migrate

STEP４　カラムタイプが変更されていることを確認する

最後に、本当にカラムタイプが変更されたかどうかを確認してみましょう。

この記事ではSQLite3での確認方法をご紹介します。

STEP

SQLite3をCLIで起動する

Laravelプロジェクトディレクトリの直下で以下のコマンドを実行することでSQLite3をCLIで起動することができます。

sqlite3 .\database\database.sqlite

STEP

テーブル構造を確認する

SQLite3で特定のテーブル構造を確認するときは以下のコマンドを実行します。

PRAGMA table_info('posts');

STEP

SQLite3を終了する

SQLite3のCLIモードを終了するときは以下のコマンドを実行します。

.quit

末尾に「;」を付けるとエラーになるのでご注意ください。

ケケンタ

以上がLaravel11でデータベーステーブルのカラムタイプを変更する方法です！

【補足】カラムにオプション（修飾子）を指定している場合

もし変更対象のカラムに何らかのオプション（修飾子）を指定していた場合は、change()を実行するときにそれらのオプション（修飾子）を明示的に指定する必要があります。

以下は「posts」テーブルの「nice_num（いいね数）」カラムにオプション（修飾子）が設定されていた場合の記述例です。

Schema::table('posts', function (Blueprint $table) {
    // 誤ってデフォルト値を「１」にしてしまっていたため、
    // $table->integer('nice_num')->unsigned()->default(1)->comment('post nice number') // ←元々のカラム設定
    
    // 「０」へ変更したい
    $table->integer('nice_num')->unsigned()->default(0)->comment('post nice number')->change();
});

ケケンタ

change()関数は簡単にカラムタイプを変更することが可能ですが、元々のオプション（修飾子）情報は保持してくれないようです！

まとめ

以上が、Laravelでデータベーステーブルのカラムタイプを変更する方法でした！

人為的ミスや仕様変更などにより、カラムタイプを変更しなくてはならないこともあるかと思います。

そんなときは「change()関数が使える」ということを覚えておくと、必要な情報をパッと調べられるかと思います。

ケケンタ

それでは最後までご覧いただきありがとうございました！

当ブログではLaravelやPHPなどに関する情報を発信しています。

ご興味のある方はほかの記事もご覧いただけるとうれしいです！