更新日: 2016年1月29日
PHP & CakePHP

CakePHPでカラム追加のマイグレーション

CakePHP 3 で既存の DB テーブルにカラムを追加するマイグレーションの方法です。Rails のマイグレーションと同じように add column（addColumn）の API が用意されているので、それを利用する。

— 環境 —
PHP 5.5.19
CakePHP 3.1.1

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

以下の公式ドキュメントのページが参考になります。

もしコマンドラインのマイグレーション名が “AddXXXToYYY” や “RemoveXXXFromYYY” といった書式で、その後にカラム名と型が続けば、カラムの追加・削除を行うコードを含んだマイグレーションファイルが生成されます。

$ bin/cake bake migration AddPriceToProducts price:decimal

Migrations – CakePHP Cookbook 3.x ドキュメント

users テーブルにカラムを追加する例

データベースの users テーブルに role, name カラムを追加する例です。

まずは、マイグレーション用ファイルを生成する。


$ bin/cake bake migration AddColumnsToUsers role:string name:string

$ bin/cake bake migration AddColumnsToUsers role:string name:string

生成されたマイグレーション用のファイル。必要があれば修正します。

config/Migrations/*****_add_columns_to_users.php

<?php
use Migrations\AbstractMigration;

class AddColumnsToUsers extends AbstractMigration
{
    /**
     * Change Method.
     *
     * More information on this method is available here:
     * http://docs.phinx.org/en/latest/migrations.html#the-change-method
     * @return void
     */
    public function change()
    {
        $table = $this->table('users');
        $table->addColumn('role', 'string', [
            'default' => null,
            'limit' => 255,
            'null' => false,
        ]);
        $table->addColumn('name', 'string', [
            'default' => null,
            'limit' => 255,
            'null' => false,
        ]);
        $table->update();
    }
}