How to add table comments at migrations ?

[hihuangwei]

• Laravel Version: 7.11.0
• PHP Version: 7.4.5
• Database Driver & Version: MySQL 8.0.20

Description:

How to add table comments at migrations ?

[thisismhp]

in migration file add DB::statement("ALTER TABLE foo comment 'comment'") to up method

Schema::create("foo", function (Blueprint $table) 
    {
     .
     .
     .
    });


DB::statement("ALTER TABLE `foo` comment 'comment'");

[sergeByishimo]

Hi @thisismhp

https://laravel.com/docs/7.x/migrations#column-modifiers

look for comment in the Column Modifiers table.

[thisismhp]

Hi @sergeByishimo
@hihuangwei wants add comment for tables not columns

[sergeByishimo]

yeah sorry! @thisismhp that answer you provided is right!

i wonder if a much nicer way is PR worthy!!
$table->comment('example comment')

[SamAsEnd]

yeah sorry! @thisismhp that answer you provided is right!

i wonder if a much nicer way is PR worthy!!
$table->comment('example comment')

I prefer $table->comment = 'example comment' to make it consistent with other table options like $table->engine = 'InnoDB'

[thisismhp]

@sergeByishimo :) tnx

[thisismhp]

yeah sorry! @thisismhp that answer you provided is right!

i wonder if a much nicer way is PR worthy!!
$table->comment('example comment')

this is a feature request.
laravel team must answer it!

[driesvints]

Moved to discussions.

[shanezhiu]

May Schema::comment() be more standardized.

[chuoke]

Hi, Is this supported?

[tapacko88]

No, for now only DB::statement

[RbusT]

Table comments are now available from Version 9.14 on. See this PR and the Blog article

Schema::table('posts', function (Blueprint $table) {
    $table->comment('This is a comment');
});

[dogeow]

nice

[TursunboyevJahongir]

Before Laravel 9, only columns were allowed to comment. Since laravel 9 the ability to comment on the table itself has been added.
If you would like to add a "comment" to a database table, you may invoke the comment method on the table instance. Table comments are currently only supported by MySQL and Postgres:

    Schema::create('calculations', function (Blueprint $table) {
        $table->comment('Business calculations');
     
        // ...
    });