Laravel MCP Companion

# Database: Migrations - [Introduction](#introduction) - [Generating Migrations](#generating-migrations) - [Squashing Migrations](#squashing-migrations) - [Migration Structure](#migration-structure) - [Running Migrations](#running-migrations) - [Rolling Back Migrations](#rolling-back-migrations) - [Tables](#tables) - [Creating Tables](#creating-tables) - [Updating Tables](#updating-tables) - [Renaming / Dropping Tables](#renaming-and-dropping-tables) - [Columns](#columns) - [Creating Columns](#creating-columns) - [Available Column Types](#available-column-types) - [Column Modifiers](#column-modifiers) - [Modifying Columns](#modifying-columns) - [Renaming Columns](#renaming-columns) - [Dropping Columns](#dropping-columns) - [Indexes](#indexes) - [Creating Indexes](#creating-indexes) - [Renaming Indexes](#renaming-indexes) - [Dropping Indexes](#dropping-indexes) - [Foreign Key Constraints](#foreign-key-constraints) - [Events](#events) <a name="introduction"></a> ## Introduction Migrations are like version control for your database, allowing your team to define and share the application's database schema definition. If you have ever had to tell a teammate to manually add a column to their local database schema after pulling in your changes from source control, you've faced the problem that database migrations solve. The Laravel `Schema` [facade](/docs/{{version}}/facades) provides database agnostic support for creating and manipulating tables across all of Laravel's supported database systems. Typically, migrations will use this facade to create and modify database tables and columns. <a name="generating-migrations"></a> ## Generating Migrations You may use the `make:migration` [Artisan command](/docs/{{version}}/artisan) to generate a database migration. The new migration will be placed in your `database/migrations` directory. Each migration filename contains a timestamp that allows Laravel to determine the order of the migrations: ```shell php artisan make:migration create_flights_table ``` Laravel will use the name of the migration to attempt to guess the name of the table and whether or not the migration will be creating a new table. If Laravel is able to determine the table name from the migration name, Laravel will pre-fill the generated migration file with the specified table. Otherwise, you may simply specify the table in the migration file manually. If you would like to specify a custom path for the generated migration, you may use the `--path` option when executing the `make:migration` command. The given path should be relative to your application's base path. > [!NOTE] > Migration stubs may be customized using [stub publishing](/docs/{{version}}/artisan#stub-customization). <a name="squashing-migrations"></a> ### Squashing Migrations As you build your application, you may accumulate more and more migrations over time. This can lead to your `database/migrations` directory becoming bloated with potentially hundreds of migrations. If you would like, you may "squash" your migrations into a single SQL file. To get started, execute the `schema:dump` command: ```shell php artisan schema:dump # Dump the current database schema and prune all existing migrations... php artisan schema:dump --prune ``` When you execute this command, Laravel will write a "schema" file to your application's `database/schema` directory. The schema file's name will correspond to the database connection. Now, when you attempt to migrate your database and no other migrations have been executed, Laravel will first execute the SQL statements in the schema file of the database connection you are using. After executing the schema file's SQL statements, Laravel will execute any remaining migrations that were not part of the schema dump. If your application's tests use a different database connection than the one you typically use during local development, you should ensure you have dumped a schema file using that database connection so that your tests are able to build your database. You may wish to do this after dumping the database connection you typically use during local development: ```shell php artisan schema:dump php artisan schema:dump --database=testing --prune ``` You should commit your database schema file to source control so that other new developers on your team may quickly create your application's initial database structure. > [!WARNING] > Migration squashing is only available for the MySQL, PostgreSQL, and SQLite databases and utilizes the database's command-line client. <a name="migration-structure"></a> ## Migration Structure A migration class contains two methods: `up` and `down`. The `up` method is used to add new tables, columns, or indexes to your database, while the `down` method should reverse the operations performed by the `up` method. Within both of these methods, you may use the Laravel schema builder to expressively create and modify tables. To learn about all of the methods available on the `Schema` builder, [check out its documentation](#creating-tables). For example, the following migration creates a `flights` table: <?php use Illuminate\Database\Migrations\Migration; use Illuminate\Database\Schema\Blueprint; use Illuminate\Support\Facades\Schema; return new class extends Migration { /** * Run the migrations. */ public function up(): void { Schema::create('flights', function (Blueprint $table) { $table->id(); $table->string('name'); $table->string('airline'); $table->timestamps(); }); } /** * Reverse the migrations. */ public function down(): void { Schema::drop('flights'); } }; <a name="setting-the-migration-connection"></a> #### Setting the Migration Connection If your migration will be interacting with a database connection other than your application's default database connection, you should set the `$connection` property of your migration: /** * The database connection that should be used by the migration. * * @var string */ protected $connection = 'pgsql'; /** * Run the migrations. */ public function up(): void { // ... } <a name="running-migrations"></a> ## Running Migrations To run all of your outstanding migrations, execute the `migrate` Artisan command: ```shell php artisan migrate ``` If you would like to see which migrations have run thus far, you may use the `migrate:status` Artisan command: ```shell php artisan migrate:status ``` If you would like to see the SQL statements that will be executed by the migrations without actually running them, you may provide the `--pretend` flag to the `migrate` command: ```shell php artisan migrate --pretend ``` #### Isolating Migration Execution If you are deploying your application across multiple servers and running migrations as part of your deployment process, you likely do not want two servers attempting to migrate the database at the same time. To avoid this, you may use the `isolated` option when invoking the `migrate` command. When the `isolated` option is provided, Laravel will acquire an atomic lock using your application's cache driver before attempting to run your migrations. All other attempts to run the `migrate` command while that lock is held will not execute; however, the command will still exit with a successful exit status code: ```shell php artisan migrate --isolated ``` > [!WARNING] > To utilize this feature, your application must be using the `memcached`, `redis`, `dynamodb`, `database`, `file`, or `array` cache driver as your application's default cache driver. In addition, all servers must be communicating with the same central cache server. <a name="forcing-migrations-to-run-in-production"></a> #### Forcing Migrations to Run in Production Some migration operations are destructive, which means they may cause you to lose data. In order to protect you from running these commands against your production database, you will be prompted for confirmation before the commands are executed. To force the commands to run without a prompt, use the `--force` flag: ```shell php artisan migrate --force ``` <a name="rolling-back-migrations"></a> ### Rolling Back Migrations To roll back the latest migration operation, you may use the `rollback` Artisan command. This command rolls back the last "batch" of migrations, which may include multiple migration files: ```shell php artisan migrate:rollback ``` You may roll back a limited number of migrations by providing the `step` option to the `rollback` command. For example, the following command will roll back the last five migrations: ```shell php artisan migrate:rollback --step=5 ``` You may roll back a specific "batch" of migrations by providing the `batch` option to the `rollback` command, where the `batch` option corresponds to a batch value within your application's `migrations` database table. For example, the following command will roll back all migrations in batch three: ```shell php artisan migrate:rollback --batch=3 ``` If you would like to see the SQL statements that will be executed by the migrations without actually running them, you may provide the `--pretend` flag to the `migrate:rollback` command: ```shell php artisan migrate:rollback --pretend ``` The `migrate:reset` command will roll back all of your application's migrations: ```shell php artisan migrate:reset ``` <a name="roll-back-migrate-using-a-single-command"></a> #### Roll Back and Migrate Using a Single Command The `migrate:refresh` command will roll back all of your migrations and then execute the `migrate` command. This command effectively re-creates your entire database: ```shell php artisan migrate:refresh # Refresh the database and run all database seeds... php artisan migrate:refresh --seed ``` You may roll back and re-migrate a limited number of migrations by providing the `step` option to the `refresh` command. For example, the following command will roll back and re-migrate the last five migrations: ```shell php artisan migrate:refresh --step=5 ``` <a name="drop-all-tables-migrate"></a> #### Drop All Tables and Migrate The `migrate:fresh` command will drop all tables from the database and then execute the `migrate` command: ```shell php artisan migrate:fresh php artisan migrate:fresh --seed ``` By default, the `migrate:fresh` command only drops tables from the default database connection. However, you may use the `--database` option to specify the database connection that should be migrated. The database connection name should correspond to a connection defined in your application's `database` [configuration file](/docs/{{version}}/configuration): ```shell php artisan migrate:fresh --database=admin ``` > [!WARNING] > The `migrate:fresh` command will drop all database tables regardless of their prefix. This command should be used with caution when developing on a database that is shared with other applications. <a name="tables"></a> ## Tables <a name="creating-tables"></a> ### Creating Tables To create a new database table, use the `create` method on the `Schema` facade. The `create` method accepts two arguments: the first is the name of the table, while the second is a closure which receives a `Blueprint` object that may be used to define the new table: use Illuminate\Database\Schema\Blueprint; use Illuminate\Support\Facades\Schema; Schema::create('users', function (Blueprint $table) { $table->id(); $table->string('name'); $table->string('email'); $table->timestamps(); }); When creating the table, you may use any of the schema builder's [column methods](#creating-columns) to define the table's columns. <a name="determining-table-column-existence"></a> #### Determining Table / Column Existence You may determine the existence of a table or column using the `hasTable` and `hasColumn` methods: if (Schema::hasTable('users')) { // The "users" table exists... } if (Schema::hasColumn('users', 'email')) { // The "users" table exists and has an "email" column... } <a name="database-connection-table-options"></a> #### Database Connection and Table Options If you want to perform a schema operation on a database connection that is not your application's default connection, use the `connection` method: Schema::connection('sqlite')->create('users', function (Blueprint $table) { $table->id(); }); In addition, a few other properties and methods may be used to define other aspects of the table's creation. The `engine` property may be used to specify the table's storage engine when using MySQL: Schema::create('users', function (Blueprint $table) { $table->engine = 'InnoDB'; // ... }); The `charset` and `collation` properties may be used to specify the character set and collation for the created table when using MySQL: Schema::create('users', function (Blueprint $table) { $table->charset = 'utf8mb4'; $table->collation = 'utf8mb4_unicode_ci'; // ... }); The `temporary` method may be used to indicate that the table should be "temporary". Temporary tables are only visible to the current connection's database session and are dropped automatically when the connection is closed: Schema::create('calculations', function (Blueprint $table) { $table->temporary(); // ... }); 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'); // ... }); <a name="updating-tables"></a> ### Updating Tables The `table` method on the `Schema` facade may be used to update existing tables. Like the `create` method, the `table` method accepts two arguments: the name of the table and a closure that receives a `Blueprint` instance you may use to add columns or indexes to the table: use Illuminate\Database\Schema\Blueprint; use Illuminate\Support\Facades\Schema; Schema::table('users', function (Blueprint $table) { $table->integer('votes'); }); <a name="renaming-and-dropping-tables"></a> ### Renaming / Dropping Tables To rename an existing database table, use the `rename` method: use Illuminate\Support\Facades\Schema; Schema::rename($from, $to); To drop an existing table, you may use the `drop` or `dropIfExists` methods: Schema::drop('users'); Schema::dropIfExists('users'); <a name="renaming-tables-with-foreign-keys"></a> #### Renaming Tables With Foreign Keys Before renaming a table, you should verify that any foreign key constraints on the table have an explicit name in your migration files instead of letting Laravel assign a convention based name. Otherwise, the foreign key constraint name will refer to the old table name. <a name="columns"></a> ## Columns <a name="creating-columns"></a> ### Creating Columns The `table` method on the `Schema` facade may be used to update existing tables. Like the `create` method, the `table` method accepts two arguments: the name of the table and a closure that receives an `Illuminate\Database\Schema\Blueprint` instance you may use to add columns to the table: use Illuminate\Database\Schema\Blueprint; use Illuminate\Support\Facades\Schema; Schema::table('users', function (Blueprint $table) { $table->integer('votes'); }); <a name="available-column-types"></a> ### Available Column Types The schema builder blueprint offers a variety of methods that correspond to the different types of columns you can add to your database tables. Each of the available methods are listed in the table below: <style> .collection-method-list > p { columns: 10.8em 3; -moz-columns: 10.8em 3; -webkit-columns: 10.8em 3; } .collection-method-list a { display: block; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; } .collection-method code { font-size: 14px; } .collection-method:not(.first-collection-method) { margin-top: 50px; } </style> <div class="collection-method-list" markdown="1"> [bigIncrements](#column-method-bigIncrements) [bigInteger](#column-method-bigInteger) [binary](#column-method-binary) [boolean](#column-method-boolean) [char](#column-method-char) [dateTimeTz](#column-method-dateTimeTz) [dateTime](#column-method-dateTime) [date](#column-method-date) [decimal](#column-method-decimal) [double](#column-method-double) [enum](#column-method-enum) [float](#column-method-float) [foreignId](#column-method-foreignId) [foreignIdFor](#column-method-foreignIdFor) [foreignUlid](#column-method-foreignUlid) [foreignUuid](#column-method-foreignUuid) [geometryCollection](#column-method-geometryCollection) [geometry](#column-method-geometry) [id](#column-method-id) [increments](#column-method-increments) [integer](#column-method-integer) [ipAddress](#column-method-ipAddress) [json](#column-method-json) [jsonb](#column-method-jsonb) [lineString](#column-method-lineString) [longText](#column-method-longText) [macAddress](#column-method-macAddress) [mediumIncrements](#column-method-mediumIncrements) [mediumInteger](#column-method-mediumInteger) [mediumText](#column-method-mediumText) [morphs](#column-method-morphs) [multiLineString](#column-method-multiLineString) [multiPoint](#column-method-multiPoint) [multiPolygon](#column-method-multiPolygon) [nullableMorphs](#column-method-nullableMorphs) [nullableTimestamps](#column-method-nullableTimestamps) [nullableUlidMorphs](#column-method-nullableUlidMorphs) [nullableUuidMorphs](#column-method-nullableUuidMorphs) [point](#column-method-point) [polygon](#column-method-polygon) [rememberToken](#column-method-rememberToken) [set](#column-method-set) [smallIncrements](#column-method-smallIncrements) [smallInteger](#column-method-smallInteger) [softDeletesTz](#column-method-softDeletesTz) [softDeletes](#column-method-softDeletes) [string](#column-method-string) [text](#column-method-text) [timeTz](#column-method-timeTz) [time](#column-method-time) [timestampTz](#column-method-timestampTz) [timestamp](#column-method-timestamp) [timestampsTz](#column-method-timestampsTz) [timestamps](#column-method-timestamps) [tinyIncrements](#column-method-tinyIncrements) [tinyInteger](#column-method-tinyInteger) [tinyText](#column-method-tinyText) [unsignedBigInteger](#column-method-unsignedBigInteger) [unsignedDecimal](#column-method-unsignedDecimal) [unsignedInteger](#column-method-unsignedInteger) [unsignedMediumInteger](#column-method-unsignedMediumInteger) [unsignedSmallInteger](#column-method-unsignedSmallInteger) [unsignedTinyInteger](#column-method-unsignedTinyInteger) [ulidMorphs](#column-method-ulidMorphs) [uuidMorphs](#column-method-uuidMorphs) [ulid](#column-method-ulid) [uuid](#column-method-uuid) [year](#column-method-year) </div> <a name="column-method-bigIncrements"></a> #### `bigIncrements()` {.collection-method .first-collection-method} The `bigIncrements` method creates an auto-incrementing `UNSIGNED BIGINT` (primary key) equivalent column: $table->bigIncrements('id'); <a name="column-method-bigInteger"></a> #### `bigInteger()` {.collection-method} The `bigInteger` method creates a `BIGINT` equivalent column: $table->bigInteger('votes'); <a name="column-method-binary"></a> #### `binary()` {.collection-method} The `binary` method creates a `BLOB` equivalent column: $table->binary('photo'); <a name="column-method-boolean"></a> #### `boolean()` {.collection-method} The `boolean` method creates a `BOOLEAN` equivalent column: $table->boolean('confirmed'); <a name="column-method-char"></a> #### `char()` {.collection-method} The `char` method creates a `CHAR` equivalent column with of a given length: $table->char('name', 100); <a name="column-method-dateTimeTz"></a> #### `dateTimeTz()` {.collection-method} The `dateTimeTz` method creates a `DATETIME` (with timezone) equivalent column with an optional precision (total digits): $table->dateTimeTz('created_at', $precision = 0); <a name="column-method-dateTime"></a> #### `dateTime()` {.collection-method} The `dateTime` method creates a `DATETIME` equivalent column with an optional precision (total digits): $table->dateTime('created_at', $precision = 0); <a name="column-method-date"></a> #### `date()` {.collection-method} The `date` method creates a `DATE` equivalent column: $table->date('created_at'); <a name="column-method-decimal"></a> #### `decimal()` {.collection-method} The `decimal` method creates a `DECIMAL` equivalent column with the given precision (total digits) and scale (decimal digits): $table->decimal('amount', $precision = 8, $scale = 2); <a name="column-method-double"></a> #### `double()` {.collection-method} The `double` method creates a `DOUBLE` equivalent column with the given precision (total digits) and scale (decimal digits): $table->double('amount', 8, 2); <a name="column-method-enum"></a> #### `enum()` {.collection-method} The `enum` method creates a `ENUM` equivalent column with the given valid values: $table->enum('difficulty', ['easy', 'hard']); <a name="column-method-float"></a> #### `float()` {.collection-method} The `float` method creates a `FLOAT` equivalent column with the given precision (total digits) and scale (decimal digits): $table->float('amount', 8, 2); <a name="column-method-foreignId"></a> #### `foreignId()` {.collection-method} The `foreignId` method creates an `UNSIGNED BIGINT` equivalent column: $table->foreignId('user_id'); <a name="column-method-foreignIdFor"></a> #### `foreignIdFor()` {.collection-method} The `foreignIdFor` method adds a `{column}_id` equivalent column for a given model class. The column type will be `UNSIGNED BIGINT`, `CHAR(36)`, or `CHAR(26)` depending on the model key type: $table->foreignIdFor(User::class); <a name="column-method-foreignUlid"></a> #### `foreignUlid()` {.collection-method} The `foreignUlid` method creates a `ULID` equivalent column: $table->foreignUlid('user_id'); <a name="column-method-foreignUuid"></a> #### `foreignUuid()` {.collection-method} The `foreignUuid` method creates a `UUID` equivalent column: $table->foreignUuid('user_id'); <a name="column-method-geometryCollection"></a> #### `geometryCollection()` {.collection-method} The `geometryCollection` method creates a `GEOMETRYCOLLECTION` equivalent column: $table->geometryCollection('positions'); <a name="column-method-geometry"></a> #### `geometry()` {.collection-method} The `geometry` method creates a `GEOMETRY` equivalent column: $table->geometry('positions'); <a name="column-method-id"></a> #### `id()` {.collection-method} The `id` method is an alias of the `bigIncrements` method. By default, the method will create an `id` column; however, you may pass a column name if you would like to assign a different name to the column: $table->id(); <a name="column-method-increments"></a> #### `increments()` {.collection-method} The `increments` method creates an auto-incrementing `UNSIGNED INTEGER` equivalent column as a primary key: $table->increments('id'); <a name="column-method-integer"></a> #### `integer()` {.collection-method} The `integer` method creates an `INTEGER` equivalent column: $table->integer('votes'); <a name="column-method-ipAddress"></a> #### `ipAddress()` {.collection-method} The `ipAddress` method creates a `VARCHAR` equivalent column: $table->ipAddress('visitor'); When using Postgres, an `INET` column will be created. <a name="column-method-json"></a> #### `json()` {.collection-method} The `json` method creates a `JSON` equivalent column: $table->json('options'); <a name="column-method-jsonb"></a> #### `jsonb()` {.collection-method} The `jsonb` method creates a `JSONB` equivalent column: $table->jsonb('options'); <a name="column-method-lineString"></a> #### `lineString()` {.collection-method} The `lineString` method creates a `LINESTRING` equivalent column: $table->lineString('positions'); <a name="column-method-longText"></a> #### `longText()` {.collection-method} The `longText` method creates a `LONGTEXT` equivalent column: $table->longText('description'); <a name="column-method-macAddress"></a> #### `macAddress()` {.collection-method} The `macAddress` method creates a column that is intended to hold a MAC address. Some database systems, such as PostgreSQL, have a dedicated column type for this type of data. Other database systems will use a string equivalent column: $table->macAddress('device'); <a name="column-method-mediumIncrements"></a> #### `mediumIncrements()` {.collection-method} The `mediumIncrements` method creates an auto-incrementing `UNSIGNED MEDIUMINT` equivalent column as a primary key: $table->mediumIncrements('id'); <a name="column-method-mediumInteger"></a> #### `mediumInteger()` {.collection-method} The `mediumInteger` method creates a `MEDIUMINT` equivalent column: $table->mediumInteger('votes'); <a name="column-method-mediumText"></a> #### `mediumText()` {.collection-method} The `mediumText` method creates a `MEDIUMTEXT` equivalent column: $table->mediumText('description'); <a name="column-method-morphs"></a> #### `morphs()` {.collection-method} The `morphs` method is a convenience method that adds a `{column}_id` equivalent column and a `{column}_type` `VARCHAR` equivalent column. The column type for the `{column}_id` will be `UNSIGNED BIGINT`, `CHAR(36)`, or `CHAR(26)` depending on the model key type. This method is intended to be used when defining the columns necessary for a polymorphic [Eloquent relationship](/docs/{{version}}/eloquent-relationships). In the following example, `taggable_id` and `taggable_type` columns would be created: $table->morphs('taggable'); <a name="column-method-multiLineString"></a> #### `multiLineString()` {.collection-method} The `multiLineString` method creates a `MULTILINESTRING` equivalent column: $table->multiLineString('positions'); <a name="column-method-multiPoint"></a> #### `multiPoint()` {.collection-method} The `multiPoint` method creates a `MULTIPOINT` equivalent column: $table->multiPoint('positions'); <a name="column-method-multiPolygon"></a> #### `multiPolygon()` {.collection-method} The `multiPolygon` method creates a `MULTIPOLYGON` equivalent column: $table->multiPolygon('positions'); <a name="column-method-nullableTimestamps"></a> #### `nullableTimestamps()` {.collection-method} The `nullableTimestamps` method is an alias of the [timestamps](#column-method-timestamps) method: $table->nullableTimestamps(0); <a name="column-method-nullableMorphs"></a> #### `nullableMorphs()` {.collection-method} The method is similar to the [morphs](#column-method-morphs) method; however, the columns that are created will be "nullable": $table->nullableMorphs('taggable'); <a name="column-method-nullableUlidMorphs"></a> #### `nullableUlidMorphs()` {.collection-method} The method is similar to the [ulidMorphs](#column-method-ulidMorphs) method; however, the columns that are created will be "nullable": $table->nullableUlidMorphs('taggable'); <a name="column-method-nullableUuidMorphs"></a> #### `nullableUuidMorphs()` {.collection-method} The method is similar to the [uuidMorphs](#column-method-uuidMorphs) method; however, the columns that are created will be "nullable": $table->nullableUuidMorphs('taggable'); <a name="column-method-point"></a> #### `point()` {.collection-method} The `point` method creates a `POINT` equivalent column: $table->point('position'); <a name="column-method-polygon"></a> #### `polygon()` {.collection-method} The `polygon` method creates a `POLYGON` equivalent column: $table->polygon('position'); <a name="column-method-rememberToken"></a> #### `rememberToken()` {.collection-method} The `rememberToken` method creates a nullable, `VARCHAR(100)` equivalent column that is intended to store the current "remember me" [authentication token](/docs/{{version}}/authentication#remembering-users): $table->rememberToken(); <a name="column-method-set"></a> #### `set()` {.collection-method} The `set` method creates a `SET` equivalent column with the given list of valid values: $table->set('flavors', ['strawberry', 'vanilla']); <a name="column-method-smallIncrements"></a> #### `smallIncrements()` {.collection-method} The `smallIncrements` method creates an auto-incrementing `UNSIGNED SMALLINT` equivalent column as a primary key: $table->smallIncrements('id'); <a name="column-method-smallInteger"></a> #### `smallInteger()` {.collection-method} The `smallInteger` method creates a `SMALLINT` equivalent column: $table->smallInteger('votes'); <a name="column-method-softDeletesTz"></a> #### `softDeletesTz()` {.collection-method} The `softDeletesTz` method adds a nullable `deleted_at` `TIMESTAMP` (with timezone) equivalent column with an optional precision (total digits). This column is intended to store the `deleted_at` timestamp needed for Eloquent's "soft delete" functionality: $table->softDeletesTz($column = 'deleted_at', $precision = 0); <a name="column-method-softDeletes"></a> #### `softDeletes()` {.collection-method} The `softDeletes` method adds a nullable `deleted_at` `TIMESTAMP` equivalent column with an optional precision (total digits). This column is intended to store the `deleted_at` timestamp needed for Eloquent's "soft delete" functionality: $table->softDeletes($column = 'deleted_at', $precision = 0); <a name="column-method-string"></a> #### `string()` {.collection-method} The `string` method creates a `VARCHAR` equivalent column of the given length: $table->string('name', 100); <a name="column-method-text"></a> #### `text()` {.collection-method} The `text` method creates a `TEXT` equivalent column: $table->text('description'); <a name="column-method-timeTz"></a> #### `timeTz()` {.collection-method} The `timeTz` method creates a `TIME` (with timezone) equivalent column with an optional precision (total digits): $table->timeTz('sunrise', $precision = 0); <a name="column-method-time"></a> #### `time()` {.collection-method} The `time` method creates a `TIME` equivalent column with an optional precision (total digits): $table->time('sunrise', $precision = 0); <a name="column-method-timestampTz"></a> #### `timestampTz()` {.collection-method} The `timestampTz` method creates a `TIMESTAMP` (with timezone) equivalent column with an optional precision (total digits): $table->timestampTz('added_at', $precision = 0); <a name="column-method-timestamp"></a> #### `timestamp()` {.collection-method} The `timestamp` method creates a `TIMESTAMP` equivalent column with an optional precision (total digits): $table->timestamp('added_at', $precision = 0); <a name="column-method-timestampsTz"></a> #### `timestampsTz()` {.collection-method} The `timestampsTz` method creates `created_at` and `updated_at` `TIMESTAMP` (with timezone) equivalent columns with an optional precision (total digits): $table->timestampsTz($precision = 0); <a name="column-method-timestamps"></a> #### `timestamps()` {.collection-method} The `timestamps` method creates `created_at` and `updated_at` `TIMESTAMP` equivalent columns with an optional precision (total digits): $table->timestamps($precision = 0); <a name="column-method-tinyIncrements"></a> #### `tinyIncrements()` {.collection-method} The `tinyIncrements` method creates an auto-incrementing `UNSIGNED TINYINT` equivalent column as a primary key: $table->tinyIncrements('id'); <a name="column-method-tinyInteger"></a> #### `tinyInteger()` {.collection-method} The `tinyInteger` method creates a `TINYINT` equivalent column: $table->tinyInteger('votes'); <a name="column-method-tinyText"></a> #### `tinyText()` {.collection-method} The `tinyText` method creates a `TINYTEXT` equivalent column: $table->tinyText('notes'); <a name="column-method-unsignedBigInteger"></a> #### `unsignedBigInteger()` {.collection-method} The `unsignedBigInteger` method creates an `UNSIGNED BIGINT` equivalent column: $table->unsignedBigInteger('votes'); <a name="column-method-unsignedDecimal"></a> #### `unsignedDecimal()` {.collection-method} The `unsignedDecimal` method creates an `UNSIGNED DECIMAL` equivalent column with an optional precision (total digits) and scale (decimal digits): $table->unsignedDecimal('amount', $precision = 8, $scale = 2); <a name="column-method-unsignedInteger"></a> #### `unsignedInteger()` {.collection-method} The `unsignedInteger` method creates an `UNSIGNED INTEGER` equivalent column: $table->unsignedInteger('votes'); <a name="column-method-unsignedMediumInteger"></a> #### `unsignedMediumInteger()` {.collection-method} The `unsignedMediumInteger` method creates an `UNSIGNED MEDIUMINT` equivalent column: $table->unsignedMediumInteger('votes'); <a name="column-method-unsignedSmallInteger"></a> #### `unsignedSmallInteger()` {.collection-method} The `unsignedSmallInteger` method creates an `UNSIGNED SMALLINT` equivalent column: $table->unsignedSmallInteger('votes'); <a name="column-method-unsignedTinyInteger"></a> #### `unsignedTinyInteger()` {.collection-method} The `unsignedTinyInteger` method creates an `UNSIGNED TINYINT` equivalent column: $table->unsignedTinyInteger('votes'); <a name="column-method-ulidMorphs"></a> #### `ulidMorphs()` {.collection-method} The `ulidMorphs` method is a convenience method that adds a `{column}_id` `CHAR(26)` equivalent column and a `{column}_type` `VARCHAR` equivalent column. This method is intended to be used when defining the columns necessary for a polymorphic [Eloquent relationship](/docs/{{version}}/eloquent-relationships) that use ULID identifiers. In the following example, `taggable_id` and `taggable_type` columns would be created: $table->ulidMorphs('taggable'); <a name="column-method-uuidMorphs"></a> #### `uuidMorphs()` {.collection-method} The `uuidMorphs` method is a convenience method that adds a `{column}_id` `CHAR(36)` equivalent column and a `{column}_type` `VARCHAR` equivalent column. This method is intended to be used when defining the columns necessary for a polymorphic [Eloquent relationship](/docs/{{version}}/eloquent-relationships) that use UUID identifiers. In the following example, `taggable_id` and `taggable_type` columns would be created: $table->uuidMorphs('taggable'); <a name="column-method-ulid"></a> #### `ulid()` {.collection-method} The `ulid` method creates a `ULID` equivalent column: $table->ulid('id'); <a name="column-method-uuid"></a> #### `uuid()` {.collection-method} The `uuid` method creates a `UUID` equivalent column: $table->uuid('id'); <a name="column-method-year"></a> #### `year()` {.collection-method} The `year` method creates a `YEAR` equivalent column: $table->year('birth_year'); <a name="column-modifiers"></a> ### Column Modifiers In addition to the column types listed above, there are several column "modifiers" you may use when adding a column to a database table. For example, to make the column "nullable", you may use the `nullable` method: use Illuminate\Database\Schema\Blueprint; use Illuminate\Support\Facades\Schema; Schema::table('users', function (Blueprint $table) { $table->string('email')->nullable(); }); The following table contains all of the available column modifiers. This list does not include [index modifiers](#creating-indexes): Modifier | Description -------- | ----------- `->after('column')` | Place the column "after" another column (MySQL). `->autoIncrement()` | Set INTEGER columns as auto-incrementing (primary key). `->charset('utf8mb4')` | Specify a character set for the column (MySQL). `->collation('utf8mb4_unicode_ci')` | Specify a collation for the column (MySQL/PostgreSQL/SQL Server). `->comment('my comment')` | Add a comment to a column (MySQL/PostgreSQL). `->default($value)` | Specify a "default" value for the column. `->first()` | Place the column "first" in the table (MySQL). `->from($integer)` | Set the starting value of an auto-incrementing field (MySQL / PostgreSQL). `->invisible()` | Make the column "invisible" to `SELECT *` queries (MySQL). `->nullable($value = true)` | Allow NULL values to be inserted into the column. `->storedAs($expression)` | Create a stored generated column (MySQL / PostgreSQL). `->unsigned()` | Set INTEGER columns as UNSIGNED (MySQL). `->useCurrent()` | Set TIMESTAMP columns to use CURRENT_TIMESTAMP as default value. `->useCurrentOnUpdate()` | Set TIMESTAMP columns to use CURRENT_TIMESTAMP when a record is updated (MySQL). `->virtualAs($expression)` | Create a virtual generated column (MySQL / PostgreSQL / SQLite). `->generatedAs($expression)` | Create an identity column with specified sequence options (PostgreSQL). `->always()` | Defines the precedence of sequence values over input for an identity column (PostgreSQL). `->isGeometry()` | Set spatial column type to `geometry` - the default type is `geography` (PostgreSQL). <a name="default-expressions"></a> #### Default Expressions The `default` modifier accepts a value or an `Illuminate\Database\Query\Expression` instance. Using an `Expression` instance will prevent Laravel from wrapping the value in quotes and allow you to use database specific functions. One situation where this is particularly useful is when you need to assign default values to JSON columns: <?php use Illuminate\Support\Facades\Schema; use Illuminate\Database\Schema\Blueprint; use Illuminate\Database\Query\Expression; use Illuminate\Database\Migrations\Migration; return new class extends Migration { /** * Run the migrations. */ public function up(): void { Schema::create('flights', function (Blueprint $table) { $table->id(); $table->json('movies')->default(new Expression('(JSON_ARRAY())')); $table->timestamps(); }); } }; > [!WARNING] > Support for default expressions depends on your database driver, database version, and the field type. Please refer to your database's documentation. <a name="column-order"></a> #### Column Order When using the MySQL database, the `after` method may be used to add columns after an existing column in the schema: $table->after('password', function (Blueprint $table) { $table->string('address_line1'); $table->string('address_line2'); $table->string('city'); }); <a name="modifying-columns"></a> ### Modifying Columns The `change` method allows you to modify the type and attributes of existing columns. For example, you may wish to increase the size of a `string` column. To see the `change` method in action, let's increase the size of the `name` column from 25 to 50. To accomplish this, we simply define the new state of the column and then call the `change` method: Schema::table('users', function (Blueprint $table) { $table->string('name', 50)->change(); }); When modifying a column, you must explicitly include all of the modifiers you want to keep on the column definition - any missing attribute will be dropped. For example, to retain the `unsigned`, `default`, and `comment` attributes, you must call each modifier explicitly when changing the column: Schema::table('users', function (Blueprint $table) { $table->integer('votes')->unsigned()->default(1)->comment('my comment')->change(); }); <a name="modifying-columns-on-sqlite"></a> #### Modifying Columns on SQLite If your application is utilizing an SQLite database, you must install the `doctrine/dbal` package using the Composer package manager before modifying a column. The Doctrine DBAL library is used to determine the current state of the column and to create the SQL queries needed to make the requested changes to your column: composer require doctrine/dbal If you plan to modify columns created using the `timestamp` method, you must also add the following configuration to your application's `config/database.php` configuration file: ```php use Illuminate\Database\DBAL\TimestampType; 'dbal' => [ 'types' => [ 'timestamp' => TimestampType::class, ], ], ``` > [!WARNING] > When using the `doctrine/dbal` package, the following column types can be modified: `bigInteger`, `binary`, `boolean`, `char`, `date`, `dateTime`, `dateTimeTz`, `decimal`, `double`, `integer`, `json`, `longText`, `mediumText`, `smallInteger`, `string`, `text`, `time`, `tinyText`, `unsignedBigInteger`, `unsignedInteger`, `unsignedSmallInteger`, `ulid`, and `uuid`. <a name="renaming-columns"></a> ### Renaming Columns To rename a column, you may use the `renameColumn` method provided by the schema builder: Schema::table('users', function (Blueprint $table) { $table->renameColumn('from', 'to'); }); <a name="renaming-columns-on-legacy-databases"></a> #### Renaming Columns on Legacy Databases If you are running a database installation older than one of the following releases, you should ensure that you have installed the `doctrine/dbal` library via the Composer package manager before renaming a column: <div class="content-list" markdown="1"> - MySQL < `8.0.3` - MariaDB < `10.5.2` - SQLite < `3.25.0` </div> <a name="dropping-columns"></a> ### Dropping Columns To drop a column, you may use the `dropColumn` method on the schema builder: Schema::table('users', function (Blueprint $table) { $table->dropColumn('votes'); }); You may drop multiple columns from a table by passing an array of column names to the `dropColumn` method: Schema::table('users', function (Blueprint $table) { $table->dropColumn(['votes', 'avatar', 'location']); }); <a name="dropping-columns-on-legacy-databases"></a> #### Dropping Columns on Legacy Databases If you are running a version of SQLite prior to `3.35.0`, you must install the `doctrine/dbal` package via the Composer package manager before the `dropColumn` method may be used. Dropping or modifying multiple columns within a single migration while using this package is not supported. <a name="available-command-aliases"></a> #### Available Command Aliases Laravel provides several convenient methods related to dropping common types of columns. Each of these methods is described in the table below: Command | Description ------- | ----------- `$table->dropMorphs('morphable');` | Drop the `morphable_id` and `morphable_type` columns. `$table->dropRememberToken();` | Drop the `remember_token` column. `$table->dropSoftDeletes();` | Drop the `deleted_at` column. `$table->dropSoftDeletesTz();` | Alias of `dropSoftDeletes()` method. `$table->dropTimestamps();` | Drop the `created_at` and `updated_at` columns. `$table->dropTimestampsTz();` | Alias of `dropTimestamps()` method. <a name="indexes"></a> ## Indexes <a name="creating-indexes"></a> ### Creating Indexes The Laravel schema builder supports several types of indexes. The following example creates a new `email` column and specifies that its values should be unique. To create the index, we can chain the `unique` method onto the column definition: use Illuminate\Database\Schema\Blueprint; use Illuminate\Support\Facades\Schema; Schema::table('users', function (Blueprint $table) { $table->string('email')->unique(); }); Alternatively, you may create the index after defining the column. To do so, you should call the `unique` method on the schema builder blueprint. This method accepts the name of the column that should receive a unique index: $table->unique('email'); You may even pass an array of columns to an index method to create a compound (or composite) index: $table->index(['account_id', 'created_at']); When creating an index, Laravel will automatically generate an index name based on the table, column names, and the index type, but you may pass a second argument to the method to specify the index name yourself: $table->unique('email', 'unique_email'); <a name="available-index-types"></a> #### Available Index Types Laravel's schema builder blueprint class provides methods for creating each type of index supported by Laravel. Each index method accepts an optional second argument to specify the name of the index. If omitted, the name will be derived from the names of the table and column(s) used for the index, as well as the index type. Each of the available index methods is described in the table below: Command | Description ------- | ----------- `$table->primary('id');` | Adds a primary key. `$table->primary(['id', 'parent_id']);` | Adds composite keys. `$table->unique('email');` | Adds a unique index. `$table->index('state');` | Adds an index. `$table->fullText('body');` | Adds a full text index (MySQL/PostgreSQL). `$table->fullText('body')->language('english');` | Adds a full text index of the specified language (PostgreSQL). `$table->spatialIndex('location');` | Adds a spatial index (except SQLite). <a name="index-lengths-mysql-mariadb"></a> #### Index Lengths and MySQL / MariaDB By default, Laravel uses the `utf8mb4` character set. If you are running a version of MySQL older than the 5.7.7 release or MariaDB older than the 10.2.2 release, you may need to manually configure the default string length generated by migrations in order for MySQL to create indexes for them. You may configure the default string length by calling the `Schema::defaultStringLength` method within the `boot` method of your `App\Providers\AppServiceProvider` class: use Illuminate\Support\Facades\Schema; /** * Bootstrap any application services. */ public function boot(): void { Schema::defaultStringLength(191); } Alternatively, you may enable the `innodb_large_prefix` option for your database. Refer to your database's documentation for instructions on how to properly enable this option. <a name="renaming-indexes"></a> ### Renaming Indexes To rename an index, you may use the `renameIndex` method provided by the schema builder blueprint. This method accepts the current index name as its first argument and the desired name as its second argument: $table->renameIndex('from', 'to') > [!WARNING] > If your application is utilizing an SQLite database, you must install the `doctrine/dbal` package via the Composer package manager before the `renameIndex` method may be used. <a name="dropping-indexes"></a> ### Dropping Indexes To drop an index, you must specify the index's name. By default, Laravel automatically assigns an index name based on the table name, the name of the indexed column, and the index type. Here are some examples: Command | Description ------- | ----------- `$table->dropPrimary('users_id_primary');` | Drop a primary key from the "users" table. `$table->dropUnique('users_email_unique');` | Drop a unique index from the "users" table. `$table->dropIndex('geo_state_index');` | Drop a basic index from the "geo" table. `$table->dropFullText('posts_body_fulltext');` | Drop a full text index from the "posts" table. `$table->dropSpatialIndex('geo_location_spatialindex');` | Drop a spatial index from the "geo" table (except SQLite). If you pass an array of columns into a method that drops indexes, the conventional index name will be generated based on the table name, columns, and index type: Schema::table('geo', function (Blueprint $table) { $table->dropIndex(['state']); // Drops index 'geo_state_index' }); <a name="foreign-key-constraints"></a> ### Foreign Key Constraints Laravel also provides support for creating foreign key constraints, which are used to force referential integrity at the database level. For example, let's define a `user_id` column on the `posts` table that references the `id` column on a `users` table: use Illuminate\Database\Schema\Blueprint; use Illuminate\Support\Facades\Schema; Schema::table('posts', function (Blueprint $table) { $table->unsignedBigInteger('user_id'); $table->foreign('user_id')->references('id')->on('users'); }); Since this syntax is rather verbose, Laravel provides additional, terser methods that use conventions to provide a better developer experience. When using the `foreignId` method to create your column, the example above can be rewritten like so: Schema::table('posts', function (Blueprint $table) { $table->foreignId('user_id')->constrained(); }); The `foreignId` method creates an `UNSIGNED BIGINT` equivalent column, while the `constrained` method will use conventions to determine the table and column being referenced. If your table name does not match Laravel's conventions, you may manually provide it to the `constrained` method. In addition, the name that should be assigned to the generated index may be specified as well: Schema::table('posts', function (Blueprint $table) { $table->foreignId('user_id')->constrained( table: 'users', indexName: 'posts_user_id' ); }); You may also specify the desired action for the "on delete" and "on update" properties of the constraint: $table->foreignId('user_id') ->constrained() ->onUpdate('cascade') ->onDelete('cascade'); An alternative, expressive syntax is also provided for these actions: | Method | Description | |-------------------------------|---------------------------------------------------| | `$table->cascadeOnUpdate();` | Updates should cascade. | | `$table->restrictOnUpdate();` | Updates should be restricted. | | `$table->noActionOnUpdate();` | No action on updates. | | `$table->cascadeOnDelete();` | Deletes should cascade. | | `$table->restrictOnDelete();` | Deletes should be restricted. | | `$table->nullOnDelete();` | Deletes should set the foreign key value to null. | Any additional [column modifiers](#column-modifiers) must be called before the `constrained` method: $table->foreignId('user_id') ->nullable() ->constrained(); <a name="dropping-foreign-keys"></a> #### Dropping Foreign Keys To drop a foreign key, you may use the `dropForeign` method, passing the name of the foreign key constraint to be deleted as an argument. Foreign key constraints use the same naming convention as indexes. In other words, the foreign key constraint name is based on the name of the table and the columns in the constraint, followed by a "\_foreign" suffix: $table->dropForeign('posts_user_id_foreign'); Alternatively, you may pass an array containing the column name that holds the foreign key to the `dropForeign` method. The array will be converted to a foreign key constraint name using Laravel's constraint naming conventions: $table->dropForeign(['user_id']); <a name="toggling-foreign-key-constraints"></a> #### Toggling Foreign Key Constraints You may enable or disable foreign key constraints within your migrations by using the following methods: Schema::enableForeignKeyConstraints(); Schema::disableForeignKeyConstraints(); Schema::withoutForeignKeyConstraints(function () { // Constraints disabled within this closure... }); > [!WARNING] > SQLite disables foreign key constraints by default. When using SQLite, make sure to [enable foreign key support](/docs/{{version}}/database#configuration) in your database configuration before attempting to create them in your migrations. In addition, SQLite only supports foreign keys upon creation of the table and [not when tables are altered](https://www.sqlite.org/omitted.html). <a name="events"></a> ## Events For convenience, each migration operation will dispatch an [event](/docs/{{version}}/events). All of the following events extend the base `Illuminate\Database\Events\MigrationEvent` class: Class | Description -------|------- | `Illuminate\Database\Events\MigrationsStarted` | A batch of migrations is about to be executed. | | `Illuminate\Database\Events\MigrationsEnded` | A batch of migrations has finished executing. | | `Illuminate\Database\Events\MigrationStarted` | A single migration is about to be executed. | | `Illuminate\Database\Events\MigrationEnded` | A single migration has finished executing. | | `Illuminate\Database\Events\SchemaDumped` | A database schema dump has completed. | | `Illuminate\Database\Events\SchemaLoaded` | An existing database schema dump has loaded. |