社畜系WEBエンジニアの消耗戦

社畜系WEBエンジニアの消耗戦

修羅の国でせっせと働く社畜系WEBエンジニアのブログ

Laravel5.3のチュートリアルがまだないから5.2でチュートリアルしてみる。その1、マイグレーション編

Laravelに入門するぞ!と意気込んでみたのはいいものの、5.3のチュートリアルがないので、仕方なく5.2でチュートリアルしていきます。

そもそもPHP自体忘れかけているので、その辺もちゃんとがんばりますね爆。

参考サイト

基本のタスクリスト 5.2 Laravel

5.3はまだないけど、5.2なら日本語で入門できるみたいなので、こちらを使っていきます。まだ英語のドキュメントは抵抗あるお年頃です。

マイグレーションファイルの作成

コマンドは断りのない限りは、前回作成したvagrantの中で実行してきます。

$ php artisan make:migration create_tasks_table --create=tasks
Created Migration: 2016_12_12_154117_create_tasks_table

これで、以下のファイルが出力されます。

<?php

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

class CreateTasksTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('tasks', function (Blueprint $table) {
            $table->increments('id');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('tasks');
    }
}

コマンドを読み解く

さて、ここで先ほどマイグレーションファイルを生成したコマンドを見てみましょう。

$ php artisan make:migration create_tasks_table --create=tasks

まず目につくのがartisanですね。これ、アルチザンと発音するみたいです。じゃあコイツはなにかって話ですが、Laravelを構成しているコマンドラインインターフェイスの名前です。色んな便利コマンドを提供してくれているみたいです。もちろん自作もできます。Railsでいうところのrakeみたいなもんですかね。

まず、提供してくれているコマンドの一覧を見てみましょう。一覧は、php artisan listで閲覧できます。

$ php artisan list
Laravel Framework version 5.3.26

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  clear-compiled       Remove the compiled class file
  down                 Put the application into maintenance mode
  env                  Display the current framework environment
  help                 Displays help for a command
  inspire              Display an inspiring quote
  list                 Lists commands
  migrate              Run the database migrations
  optimize             Optimize the framework for better performance
  serve                Serve the application on the PHP development server
  tinker               Interact with your application
  up                   Bring the application out of maintenance mode
 app
  app:name             Set the application namespace
 auth
  auth:clear-resets    Flush expired password reset tokens
 cache
  cache:clear          Flush the application cache
  cache:table          Create a migration for the cache database table
 config
  config:cache         Create a cache file for faster configuration loading
  config:clear         Remove the configuration cache file
 db
  db:seed              Seed the database with records
 event
  event:generate       Generate the missing events and listeners based on registration
 key
  key:generate         Set the application key
 make
  make:auth            Scaffold basic login and registration views and routes
  make:command         Create a new Artisan command
  make:controller      Create a new controller class
  make:event           Create a new event class
  make:job             Create a new job class
  make:listener        Create a new event listener class
  make:mail            Create a new email class
  make:middleware      Create a new middleware class
  make:migration       Create a new migration file
  make:model           Create a new Eloquent model class
  make:notification    Create a new notification class
  make:policy          Create a new policy class
  make:provider        Create a new service provider class
  make:request         Create a new form request class
  make:seeder          Create a new seeder class
  make:test            Create a new test class
 migrate
  migrate:install      Create the migration repository
  migrate:refresh      Reset and re-run all migrations
  migrate:reset        Rollback all database migrations
  migrate:rollback     Rollback the last database migration
  migrate:status       Show the status of each migration
 notifications
  notifications:table  Create a migration for the notifications table
 queue
  queue:failed         List all of the failed queue jobs
  queue:failed-table   Create a migration for the failed queue jobs database table
  queue:flush          Flush all of the failed queue jobs
  queue:forget         Delete a failed queue job
  queue:listen         Listen to a given queue
  queue:restart        Restart queue worker daemons after their current job
  queue:retry          Retry a failed queue job
  queue:table          Create a migration for the queue jobs database table
  queue:work           Start processing jobs on the queue as a daemon
 route
  route:cache          Create a route cache file for faster route registration
  route:clear          Remove the route cache file
  route:list           List all registered routes
 schedule
  schedule:run         Run the scheduled commands
 session
  session:table        Create a migration for the session database table
 storage
  storage:link         Create a symbolic link from "public/storage" to "storage/app/public"
 vendor
  vendor:publish       Publish any publishable assets from vendor packages
 view
  view:clear           Clear all compiled view files

くそ多いですねww

まぁ使っていくうちに、頻度の高いやつから順次覚えていけばいいかなー。マイグレーションを作るのは今回使った、make:migration。よし、一つ覚えた。

マイグレーションコマンドを読み解く

大体のケースで、-hでヘルプが見れるはず。ということで見てみる。

$ php artisan make:migration -h
Usage:
  make:migration [options] [--] <name>

Arguments:
  name                   The name of the migration.

Options:
      --create[=CREATE]  The table to be created.
      --table[=TABLE]    The table to migrate.
      --path[=PATH]      The location where the migration file should be created.
  -h, --help             Display this help message
  -q, --quiet            Do not output any message
  -V, --version          Display this application version
      --ansi             Force ANSI output
      --no-ansi          Disable ANSI output
  -n, --no-interaction   Do not ask any interactive question
      --env[=ENV]        The environment the command should run under
  -v|vv|vvv, --verbose   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  Create a new migration file

なるほどなるほど、migrationのオプションはこうなってるんだね。チュートリアルではさっき生成したファイルを編集してカラムを追加してたけど、上記を参考にすれば、--tableオプションでmodify用のマイグレーションファイルが生成できるはず。

$ php artisan make:migration add_name_tasks_table --table=tasks
Created Migration: 2016_12_12_155751_add_name_tasks_table

ビンゴ。空のやつができた。

<?php

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

class AddNameTasksTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('tasks', function (Blueprint $table) {
            //
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('tasks', function (Blueprint $table) {
            //
        });
    }
}

それぞれ以下のように追記すればよさそう。

<?php

public function up()
{
    Schema::table('tasks', function (Blueprint $table) {
        $table->string('name');
    });
}

public function down()
{
    Schema::table('tasks', function (Blueprint $table) {
        $table->dropColumn('name');
    });
}

ここまで来たら、一度マイグレーション走らせてみようかね。

マイグレーションしてみる

長かったけど、ようやくマイグレーションコマンドを叩いてみます。

$ php artisan migrate
Migration table created successfully.
Migrated: 2014_10_12_000000_create_users_table
Migrated: 2014_10_12_100000_create_password_resets_table
Migrated: 2016_12_12_154117_create_tasks_table
Migrated: 2016_12_12_155751_add_name_tasks_table

なんかダミーでもとからあるテーブルまで作られたね。。ナニコレいるの?まぁそれはおいといて、接続して確認してみると、ちゃんと先ほどのテーブルが出来ていますね。

mysql> show tables;
+---------------------+
| Tables_in_homestead |
+---------------------+
| migrations          |
| password_resets     |
| tasks               |
| users               |
+---------------------+
4 rows in set (0.00 sec)
mysql> show create table tasks;
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Table | Create Table                                                                                                                                                                                                                                                                                              |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tasks | CREATE TABLE `tasks` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `created_at` timestamp NULL DEFAULT NULL,
  `updated_at` timestamp NULL DEFAULT NULL,
  `name` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

migrationsテーブルの中身

こうなってた。

mysql> select * from migrations;
+----+------------------------------------------------+-------+
| id | migration                                      | batch |
+----+------------------------------------------------+-------+
|  1 | 2014_10_12_000000_create_users_table           |     1 |
|  2 | 2014_10_12_100000_create_password_resets_table |     1 |
|  3 | 2016_12_12_154117_create_tasks_table           |     1 |
|  4 | 2016_12_12_155751_add_name_tasks_table         |     1 |
+----+------------------------------------------------+-------+
4 rows in set (0.01 sec)

マイグレーションファイル名と、それが適用されたかどうかが入ってるみたい。これってブランチ跨いで前の日付のマイグレーションファイルとかあってももしかして実行してくれるクソ優しい仕様なんじゃ。Laravelサイコー。

ロールバックしたい

マイグレーションできたら当然ロールバックもしたいよね。

 migrate
  migrate:install      Create the migration repository
  migrate:refresh      Reset and re-run all migrations
  migrate:reset        Rollback all database migrations
  migrate:rollback     Rollback the last database migration
  migrate:status       Show the status of each migration

さっきのコマンドのリストからみるに、rollbackでできそうですね。resetですっからかんにして、refreshですっからかんにした後で全ファイルマイグレーションしてくれる感じかな。

で、やりたかったrollbackのオプションをみてみると。

$ php artisan migrate:rollback -h
Usage:
  migrate:rollback [options]

Options:
      --database[=DATABASE]  The database connection to use.
      --force                Force the operation to run when in production.
      --path[=PATH]          The path of migrations files to be executed.
      --pretend              Dump the SQL queries that would be run.
      --step[=STEP]          The number of migrations to be reverted.
  -h, --help                 Display this help message
  -q, --quiet                Do not output any message
  -V, --version              Display this application version
      --ansi                 Force ANSI output
      --no-ansi              Disable ANSI output
  -n, --no-interaction       Do not ask any interactive question
      --env[=ENV]            The environment the command should run under
  -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  Rollback the last database migration

STEP使えば、一個ずつ戻したりってのも難なくできそう。

あと、statusコマンドで適用未適用が参照できるのも非常にいいですね。こんな感じで表示されます。

$ php artisan migrate:status
+------+------------------------------------------------+
| Ran? | Migration                                      |
+------+------------------------------------------------+
| Y    | 2014_10_12_000000_create_users_table           |
| Y    | 2014_10_12_100000_create_password_resets_table |
| Y    | 2016_12_12_154117_create_tasks_table           |
| Y    | 2016_12_12_155751_add_name_tasks_table         |
+------+------------------------------------------------+

おわりに

マイグレーションロールバックだけでこんなに学ぶことが多いとは、、まだ始まったばっかりなんですけど。どうしてくれるんですか?ねぇ、どうしてくれるんですか?