Метод comment
Метод comment применяется к определению столбца в миграции Laravel и позволяет добавить текстовый комментарий к полю в базе данных. Первым и единственным параметром передаётся строка с комментарием. Этот метод доступен для всех типов полей и помогает разработчикам лучше понимать структуру таблицы.
Синтаксис
<?php
Schema::table('table_name', function (Blueprint $table) {
$table->field_type('column_name')->comment('Your comment here');
});
?>
Пример
Давайте добавим комментарий к полю 'status' в таблице 'articles', чтобы указать, что оно хранит статус публикации статьи:
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
public function up()
{
Schema::create('articles', function (Blueprint $table) {
$table->id();
$table->string('title');
$table->text('content');
$table->string('status', 20)->comment('Publication status: draft, published, archived');
$table->timestamps();
});
}
public function down()
{
Schema::dropIfExists('articles');
}
};
?>
Пример
Теперь добавим комментарий к полю 'age' в существующей таблице 'users' с помощью метода change:
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
public function up()
{
Schema::table('users', function (Blueprint $table) {
$table->integer('age')->comment('User age in years')->change();
});
}
public function down()
{
Schema::table('users', function (Blueprint $table) {
$table->integer('age')->comment(null)->change();
});
}
};
?>
Пример
Вы также можете использовать метод comment при изменении существующего поля, например, чтобы обновить комментарий для колонки 'email':
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
public function up()
{
Schema::table('users', function (Blueprint $table) {
$table->string('email')->comment('User primary email address')->change();
});
}
public function down()
{
Schema::table('users', function (Blueprint $table) {
$table->string('email')->comment(null)->change();
});
}
};
?>
Результат выполнения команды php artisan migrate:
"Migration table created successfully."
"Migrating: 2026_01_01_000002_update_users_table"
"Migrated: 2026_01_01_000002_update_users_table (0.05 seconds)"
