Laravel のマイグレーションでテーブルカラムにコメントを設定する

Question

###前提・実現したいこと

Laravel 5.5 (PHP 7.1) + PostgreSQL 9.5 を使用。
マイグレーションでテーブルカラムにコメントを設定したい。

###発生している問題・エラーメッセージ

ドキュメントに書かれている通りにしても、テーブルカラムにコメントが設定されません。
もしかして、MySQL 以外は対応していないのでしょうか？？？

###該当のソースコード

Schema::create('users', function (Blueprint $table) {
    $table->increments('id');
    $table->string('email')->comment('メールアドレス');
});

psql 実行結果:

=> \d+ users
                                                     Table "public.users"
 Column |          Type          |                     Modifiers                      | Storage  | Stats target | Description 
--------+------------------------+----------------------------------------------------+----------+--------------+-------------
 id     | integer                | not null default nextval('users_id_seq'::regclass) | plain    |              | 
 email  | character varying(255) | not null                                           | extended |              | 

Answer 1

https://github.com/laravel/framework/pull/21855

しばらくチェックしていませんでしたが、
Laravel 5.6 以降は対応しているようです。

Answer 2

MySQLのみですね。
コメントを変更するmodifyComment()がMySQLにしかないです。

https://github.com/laravel/framework/blob/d4169a50d88048560ca9f418dad02a05ea67ecfb/src/Illuminate/Database/Schema/Grammars/MySqlGrammar.php#L920

Comments

[okinaka3]

なるほど。ありがとうございます。

[okinaka3]

ソースを見る限り、 modifyComment() だと PostgreSQL ではうまくいかなさそうですね・・・。

Answer 3

確認してみましたが、そのようです。

MySQL
https://github.com/laravel/framework/blob/5.5/src/Illuminate/Database/Schema/Grammars/MySqlGrammar.php#L16-L19

    protected $modifiers = [
        'VirtualAs', 'StoredAs', 'Unsigned', 'Charset', 'Collate', 'Nullable',
        'Default', 'Increment', 'Comment', 'After', 'First',
    ];

PostgreSQL
https://github.com/laravel/framework/blob/5.5/src/Illuminate/Database/Schema/Grammars/PostgresGrammar.php#L23

    protected $modifiers = ['Increment', 'Nullable', 'Default'];

Comments

[okinaka3]

ありがとうございます。 Issue も上がっていました。これは対応の予定はないのでしょうか？

https://github.com/laravel/framework/issues/18782

[fagai]

現状では過去にも追加予定のプルリクは上がっていませんね。
正直予定が無いというのは直接そういうPRが上がらないと判明しないので、どうしても必要な場合は自分自身で本家にPRを投げてみるしか無いかと思われます。

[okinaka3]

なるほど。とりあえず Schema によるコメントは見送ります。
直接 SQL を叩くか、コメントに対応している doctrine/dbal など別のライブラリの利用を検討してみます。

[okinaka3]

混乱の元になったドキュメントの修正は PR をあげておきました。
PostgreSQL の対応は、もしできそうであれば PR します。

[fagai]

Goodです！