数据库：迁移

介绍
生成迁移
- 合并迁移
迁移结构
运行迁移
- 回滚迁移
表
列
索引
事件

介绍

迁移就像是数据库的版本控制，允许团队定义和共享应用程序的数据库架构定义。如果你曾经不得不告诉队友在从源控制中拉取更改后手动添加列到他们的本地数据库架构中，那么你就面临了迁移所解决的问题。

Laravel 的 Schema 门面提供了与数据库无关的支持，用于创建和操作所有 Laravel 支持的数据库系统中的表。通常，迁移将使用此门面来创建和修改数据库表和列。

生成迁移

你可以使用 make:migration Artisan 命令来生成数据库迁移。新的迁移将放置在你的 database/migrations 目录中。每个迁移文件名都包含一个时间戳，允许 Laravel 确定迁移的顺序：

shell

php artisan make:migration create_flights_table

Laravel 将使用迁移的名称来尝试猜测表的名称以及迁移是否将创建一个新表。如果 Laravel 能够从迁移名称中确定表名，Laravel 将预填充生成的迁移文件。如果不能，你可以在迁移文件中手动指定表。

如果你想为生成的迁移指定自定义路径，可以在执行 make:migration 命令时使用 --path 选项。给定的路径应相对于应用程序的基础路径。

注意

迁移存根可以通过存根发布进行自定义。

合并迁移

随着应用程序的构建，你可能会随着时间的推移积累越来越多的迁移。这可能导致你的 database/migrations 目录变得臃肿，可能有数百个迁移。如果你愿意，可以将迁移“合并”成一个 SQL 文件。要开始，请执行 schema:dump 命令：

shell

php artisan schema:dump

# 转储当前数据库架构并修剪所有现有迁移...
php artisan schema:dump --prune

当你执行此命令时，Laravel 将把“架构”文件写入应用程序的 database/schema 目录。架构文件的名称将对应于数据库连接。现在，当你尝试迁移数据库且没有其他迁移已执行时，Laravel 将首先执行你正在使用的数据库连接的架构文件中的 SQL 语句。在执行架构文件的 SQL 语句后，Laravel 将执行任何未包含在架构转储中的剩余迁移。

如果你的应用程序的测试使用与本地开发期间通常使用的数据库连接不同的数据库连接，你应该确保使用该数据库连接转储了架构文件，以便你的测试能够构建数据库。你可能希望在转储你通常在本地开发期间使用的数据库连接后执行此操作：

shell

php artisan schema:dump
php artisan schema:dump --database=testing --prune

你应该将数据库架构文件提交到源控制，以便团队中的其他新开发人员可以快速创建应用程序的初始数据库结构。

警告

迁移合并仅适用于 MariaDB、MySQL、PostgreSQL 和 SQLite 数据库，并利用数据库的命令行客户端。

迁移结构

迁移类包含两个方法：up 和 down。up 方法用于向数据库添加新表、列或索引，而 down 方法应反转 up 方法执行的操作。

在这两个方法中，你可以使用 Laravel 架构生成器来表达性地创建和修改表。要了解 Schema 生成器上可用的所有方法，请查看其文档。例如，以下迁移创建一个 flights 表：

php

<?php

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

return new class extends Migration
{
    /**
     * 运行迁移。
     */
    public function up(): void
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->string('airline');
            $table->timestamps();
        });
    }

    /**
     * 回滚迁移。
     */
    public function down(): void
    {
        Schema::drop('flights');
    }
};

设置迁移连接

如果你的迁移将与应用程序的默认数据库连接以外的数据库连接进行交互，则应设置迁移的 $connection 属性：

php

/**
 * 应该由迁移使用的数据库连接。
 *
 * @var string
 */
protected $connection = 'pgsql';

/**
 * 运行迁移。
 */
public function up(): void
{
    // ...
}

运行迁移

要运行所有未完成的迁移，请执行 migrate Artisan 命令：

shell

php artisan migrate

如果你想查看到目前为止已运行的迁移，可以使用 migrate:status Artisan 命令：

shell

php artisan migrate:status

如果你想查看将由迁移执行的 SQL 语句而不实际运行它们，可以在 migrate 命令中提供 --pretend 标志：

shell

php artisan migrate --pretend

隔离迁移执行

如果你在多个服务器上部署应用程序并将迁移作为部署过程的一部分运行，你可能不希望两个服务器同时尝试迁移数据库。为此，你可以在调用 migrate 命令时使用 isolated 选项。

当提供 isolated 选项时，Laravel 将在尝试运行迁移之前使用应用程序的缓存驱动程序获取一个原子锁。在该锁被持有的情况下，所有其他尝试运行 migrate 命令的操作将不会执行；但是，该命令仍将以成功的退出状态代码退出：

shell

php artisan migrate --isolated

警告

要利用此功能，应用程序必须使用 memcached、redis、dynamodb、database、file 或 array 缓存驱动程序作为应用程序的默认缓存驱动程序。此外，所有服务器必须与同一个中央缓存服务器进行通信。

强制在生产环境中运行迁移

某些迁移操作是破坏性的，这意味着它们可能导致数据丢失。为了保护你不在生产数据库上运行这些命令，系统会在执行命令之前提示你确认。要强制命令在没有提示的情况下运行，请使用 --force 标志：

shell

php artisan migrate --force

回滚迁移

要回滚最新的迁移操作，可以使用 rollback Artisan 命令。此命令将回滚最后一批迁移，这可能包括多个迁移文件：

shell

php artisan migrate:rollback

你可以通过向 rollback 命令提供 step 选项来回滚有限数量的迁移。例如，以下命令将回滚最后五个迁移：

shell

php artisan migrate:rollback --step=5

你可以通过向 rollback 命令提供 batch 选项来回滚特定的“批次”迁移，其中 batch 选项对应于应用程序的 migrations 数据库表中的批次值。例如，以下命令将回滚批次三中的所有迁移：

shell

php artisan migrate:rollback --batch=3

如果你想查看将由迁移执行的 SQL 语句而不实际运行它们，可以在 migrate:rollback 命令中提供 --pretend 标志：

shell

php artisan migrate:rollback --pretend

migrate:reset 命令将回滚应用程序的所有迁移：

shell

php artisan migrate:reset

使用单个命令回滚并迁移

migrate:refresh 命令将回滚所有迁移，然后执行 migrate 命令。此命令有效地重新创建整个数据库：

shell

php artisan migrate:refresh

# 刷新数据库并运行所有数据库种子...
php artisan migrate:refresh --seed

你可以通过向 refresh 命令提供 step 选项来回滚并重新迁移有限数量的迁移。例如，以下命令将回滚并重新迁移最后五个迁移：

shell

php artisan migrate:refresh --step=5

删除所有表并迁移

migrate:fresh 命令将从数据库中删除所有表，然后执行 migrate 命令：

shell

php artisan migrate:fresh

php artisan migrate:fresh --seed

默认情况下，migrate:fresh 命令仅从默认数据库连接中删除表。但是，你可以使用 --database 选项指定应迁移的数据库连接。数据库连接名称应对应于应用程序的 database 配置文件中定义的连接：

shell

php artisan migrate:fresh --database=admin

警告

migrate:fresh 命令将删除所有数据库表，无论其前缀如何。在与其他应用程序共享的数据库上开发时，应谨慎使用此命令。

表

创建表

要创建一个新的数据库表，请使用 Schema 门面上的 create 方法。create 方法接受两个参数：第一个是表的名称，第二个是一个接收 Blueprint 对象的闭包，该对象可用于定义新表：

php

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();
});

在创建表时，你可以使用架构生成器的任何列方法来定义表的列。

确定表/列存在性

你可以使用 hasTable、hasColumn 和 hasIndex 方法来确定表、列或索引的存在性：

php

if (Schema::hasTable('users')) {
    // "users" 表存在...
}

if (Schema::hasColumn('users', 'email')) {
    // "users" 表存在并且有一个 "email" 列...
}

if (Schema::hasIndex('users', ['email'], 'unique')) {
    // "users" 表存在并且在 "email" 列上有一个唯一索引...
}

数据库连接和表选项

如果你想在不是应用程序默认连接的数据库连接上执行架构操作，请使用 connection 方法：

php

Schema::connection('sqlite')->create('users', function (Blueprint $table) {
    $table->id();
});

此外，还可以使用其他一些属性和方法来定义表创建的其他方面。engine 属性可用于指定在使用 MariaDB 或 MySQL 时表的存储引擎：

php

Schema::create('users', function (Blueprint $table) {
    $table->engine('InnoDB');

    // ...
});

charset 和 collation 属性可用于在使用 MariaDB 或 MySQL 时指定创建表的字符集和排序规则：

php

Schema::create('users', function (Blueprint $table) {
    $table->charset('utf8mb4');
    $table->collation('utf8mb4_unicode_ci');

    // ...
});

temporary 方法可用于指示表应为“临时”表。临时表仅对当前连接的数据库会话可见，并在连接关闭时自动删除：

php

Schema::create('calculations', function (Blueprint $table) {
    $table->temporary();

    // ...
});

如果你想为数据库表添加“注释”，可以在表实例上调用 comment 方法。表注释目前仅支持 MariaDB、MySQL 和 PostgreSQL：

php

Schema::create('calculations', function (Blueprint $table) {
    $table->comment('业务计算');

    // ...
});

更新表

Schema 门面上的 table 方法可用于更新现有表。与 create 方法一样，table 方法接受两个参数：表的名称和一个接收 Blueprint 实例的闭包，你可以用它来向表中添加列或索引：

php

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

Schema::table('users', function (Blueprint $table) {
    $table->integer('votes');
});

重命名/删除表

要重命名现有数据库表，请使用 rename 方法：

php

use Illuminate\Support\Facades\Schema;

Schema::rename($from, $to);

要删除现有表，可以使用 drop 或 dropIfExists 方法：

php

Schema::drop('users');

Schema::dropIfExists('users');

使用外键重命名表

在重命名表之前，你应该确保表上的任何外键约束在迁移文件中具有显式名称，而不是让 Laravel 分配一个约定的名称。否则，外键约束名称将引用旧的表名。

列

创建列

Schema 门面上的 table 方法可用于更新现有表。与 create 方法一样，table 方法接受两个参数：表的名称和一个接收 Illuminate\Database\Schema\Blueprint 实例的闭包，你可以用它来向表中添加列：

php

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

Schema::table('users', function (Blueprint $table) {
    $table->integer('votes');
});

可用列类型

架构生成器蓝图提供了多种方法，对应于可以添加到数据库表中的不同类型的列。每个可用方法在下表中列出：

`bigIncrements()`

bigIncrements 方法创建一个自增的 UNSIGNED BIGINT（主键）等效列：

php

$table->bigIncrements('id');

`bigInteger()`

bigInteger 方法创建一个 BIGINT 等效列：

php

$table->bigInteger('votes');

`binary()`

binary 方法创建一个 BLOB 等效列：

php

$table->binary('photo');

在使用 MySQL、MariaDB 或 SQL Server 时，你可以传递 length 和 fixed 参数来创建 VARBINARY 或 BINARY 等效列：

php

$table->binary('data', length: 16); // VARBINARY(16)

$table->binary('data', length: 16, fixed: true); // BINARY(16)

`boolean()`

boolean 方法创建一个 BOOLEAN 等效列：

php

$table->boolean('confirmed');

`char()`

char 方法创建一个给定长度的 CHAR 等效列：

php

$table->char('name', length: 100);

`dateTimeTz()`

dateTimeTz 方法创建一个带时区的 DATETIME 等效列，具有可选的分数秒精度：

php

$table->dateTimeTz('created_at', precision: 0);

`dateTime()`

dateTime 方法创建一个 DATETIME 等效列，具有可选的分数秒精度：

php

$table->dateTime('created_at', precision: 0);

`date()`

date 方法创建一个 DATE 等效列：

php

$table->date('created_at');

`decimal()`

decimal 方法创建一个具有给定精度（总位数）和规模（小数位数）的 DECIMAL 等效列：

php

$table->decimal('amount', total: 8, places: 2);

`double()`

double 方法创建一个 DOUBLE 等效列：

php

$table->double('amount');

`enum()`

enum 方法创建一个具有给定有效值的 ENUM 等效列：

php

$table->enum('difficulty', ['easy', 'hard']);

`float()`

float 方法创建一个具有给定精度的 FLOAT 等效列：

php

$table->float('amount', precision: 53);

`foreignId()`

foreignId 方法创建一个 UNSIGNED BIGINT 等效列：

php

$table->foreignId('user_id');

`foreignIdFor()`

foreignIdFor 方法为给定模型类添加一个 {column}_id 等效列。列类型将根据模型键类型为 UNSIGNED BIGINT、CHAR(36) 或 CHAR(26)：

php

$table->foreignIdFor(User::class);

`foreignUlid()`

foreignUlid 方法创建一个 ULID 等效列：

php

$table->foreignUlid('user_id');

`foreignUuid()`

foreignUuid 方法创建一个 UUID 等效列：

php

$table->foreignUuid('user_id');

`geography()`

geography 方法创建一个具有给定空间类型和 SRID（空间参考系统标识符）的 GEOGRAPHY 等效列：

php

$table->geography('coordinates', subtype: 'point', srid: 4326);

注意

空间类型的支持取决于你的数据库驱动程序。请参考数据库的文档。如果你的应用程序使用 PostgreSQL 数据库，则必须在使用 geography 方法之前安装 PostGIS 扩展。

`geometry()`

geometry 方法创建一个具有给定空间类型和 SRID（空间参考系统标识符）的 GEOMETRY 等效列：

php

$table->geometry('positions', subtype: 'point', srid: 0);

注意

空间类型的支持取决于你的数据库驱动程序。请参考数据库的文档。如果你的应用程序使用 PostgreSQL 数据库，则必须在使用 geometry 方法之前安装 PostGIS 扩展。

`id()`

id 方法是 bigIncrements 方法的别名。默认情况下，该方法将创建一个 id 列；但是，如果你想为列分配不同的名称，可以传递列名：

php

$table->id();

`increments()`

increments 方法创建一个自增的 UNSIGNED INTEGER 等效列作为主键：

php

$table->increments('id');

`integer()`

integer 方法创建一个 INTEGER 等效列：

php

$table->integer('votes');

`ipAddress()`

ipAddress 方法创建一个 VARCHAR 等效列：

php

$table->ipAddress('visitor');

在使用 PostgreSQL 时，将创建一个 INET 列。

`json()`

json 方法创建一个 JSON 等效列：

php

$table->json('options');

当使用 SQLite 时，将创建一个 TEXT 列。

`jsonb()`

jsonb 方法创建一个 JSONB 等效列：

php

$table->jsonb('options');

当使用 SQLite 时，将创建一个 TEXT 列。

`longText()`

longText 方法创建一个 LONGTEXT 等效列：

php

$table->longText('description');

在使用 MySQL 或 MariaDB 时，你可以对列应用 binary 字符集，以创建 LONGBLOB 等效列：

php

$table->longText('data')->charset('binary'); // LONGBLOB

`macAddress()`

macAddress 方法创建一个旨在保存 MAC 地址的列。一些数据库系统（如 PostgreSQL）对此类数据有专用的列类型。其他数据库系统将使用字符串等效列：

php

$table->macAddress('device');

`mediumIncrements()`

mediumIncrements 方法创建一个自增的 UNSIGNED MEDIUMINT 等效列作为主键：

php

$table->mediumIncrements('id');

`mediumInteger()`

mediumInteger 方法创建一个 MEDIUMINT 等效列：

php

$table->mediumInteger('votes');

`mediumText()`

mediumText 方法创建一个 MEDIUMTEXT 等效列：

php

$table->mediumText('description');

在使用 MySQL 或 MariaDB 时，你可以对列应用 binary 字符集，以创建 MEDIUMBLOB 等效列：

php

$table->mediumText('data')->charset('binary'); // MEDIUMBLOB

`morphs()`

morphs 方法是一个便利方法，添加一个 {column}_id 等效列和一个 {column}_type VARCHAR 等效列。{column}_id 的列类型将根据模型键类型为 UNSIGNED BIGINT、CHAR(36) 或 CHAR(26)。

此方法旨在在定义多态 Eloquent 关系所需的列时使用。在以下示例中，将创建 taggable_id 和 taggable_type 列：

php

$table->morphs('taggable');

`nullableMorphs()`

该方法类似于 morphs 方法；但是，创建的列将是“可空”的：

php

$table->nullableMorphs('taggable');

`nullableUlidMorphs()`

该方法类似于 ulidMorphs 方法；但是，创建的列将是“可空”的：

php

$table->nullableUlidMorphs('taggable');

`nullableUuidMorphs()`

该方法类似于 uuidMorphs 方法；但是，创建的列将是“可空”的：

php

$table->nullableUuidMorphs('taggable');

`rememberToken()`

rememberToken 方法创建一个可空的 VARCHAR(100) 等效列，旨在存储当前的“记住我” 身份验证令牌：

php

$table->rememberToken();

`set()`

set 方法创建一个具有给定有效值的 SET 等效列：

php

$table->set('flavors', ['strawberry', 'vanilla']);

`smallIncrements()`

smallIncrements 方法创建一个自增的 UNSIGNED SMALLINT 等效列作为主键：

php

$table->smallIncrements('id');

`smallInteger()`

smallInteger 方法创建一个 SMALLINT 等效列：

php

$table->smallInteger('votes');

`softDeletesTz()`

softDeletesTz 方法添加一个可空的 deleted_at TIMESTAMP（带时区）等效列，具有可选的分数秒精度。此列旨在存储 Eloquent 的“软删除”功能所需的 deleted_at 时间戳：

php

$table->softDeletesTz('deleted_at', precision: 0);

`softDeletes()`

softDeletes 方法添加一个可空的 deleted_at TIMESTAMP 等效列，具有可选的分数秒精度。此列旨在存储 Eloquent 的“软删除”功能所需的 deleted_at 时间戳：

php

$table->softDeletes('deleted_at', precision: 0);

`string()`

string 方法创建一个给定长度的 VARCHAR 等效列：

php

$table->string('name', length: 100);

`text()`

text 方法创建一个 TEXT 等效列：

php

$table->text('description');

在使用 MySQL 或 MariaDB 时，你可以对列应用 binary 字符集，以创建 BLOB 等效列：

php

$table->text('data')->charset('binary'); // BLOB

`timeTz()`

timeTz 方法创建一个带时区的 TIME 等效列，具有可选的分数秒精度：

php

$table->timeTz('sunrise', precision: 0);

`time()`

time 方法创建一个 TIME 等效列，具有可选的分数秒精度：

php

$table->time('sunrise', precision: 0);

`timestampTz()`

timestampTz 方法创建一个带时区的 TIMESTAMP 等效列，具有可选的分数秒精度：

php

$table->timestampTz('added_at', precision: 0);

`timestamp()`

timestamp 方法创建一个 TIMESTAMP 等效列，具有可选的分数秒精度：

php

$table->timestamp('added_at', precision: 0);

`timestampsTz()`

timestampsTz 方法创建 created_at 和 updated_at TIMESTAMP（带时区）等效列，具有可选的分数秒精度：

php

$table->timestampsTz(precision: 0);

`timestamps()`

timestamps 方法创建 created_at 和 updated_at TIMESTAMP 等效列，具有可选的分数秒精度：

php

$table->timestamps(precision: 0);

`tinyIncrements()`

tinyIncrements 方法创建一个自增的 UNSIGNED TINYINT 等效列作为主键：

php

$table->tinyIncrements('id');

`tinyInteger()`

tinyInteger 方法创建一个 TINYINT 等效列：

php

$table->tinyInteger('votes');

`tinyText()`

tinyText 方法创建一个 TINYTEXT 等效列：

php

$table->tinyText('notes');

在使用 MySQL 或 MariaDB 时，你可以对列应用 binary 字符集，以创建 TINYBLOB 等效列：

php

$table->tinyText('data')->charset('binary'); // TINYBLOB

`unsignedBigInteger()`

unsignedBigInteger 方法创建一个 UNSIGNED BIGINT 等效列：

php

$table->unsignedBigInteger('votes');

`unsignedInteger()`

unsignedInteger 方法创建一个 UNSIGNED INTEGER 等效列：

php

$table->unsignedInteger('votes');

`unsignedMediumInteger()`

unsignedMediumInteger 方法创建一个 UNSIGNED MEDIUMINT 等效列：

php

$table->unsignedMediumInteger('votes');

`unsignedSmallInteger()`

unsignedSmallInteger 方法创建一个 UNSIGNED SMALLINT 等效列：

php

$table->unsignedSmallInteger('votes');

`unsignedTinyInteger()`

unsignedTinyInteger 方法创建一个 UNSIGNED TINYINT 等效列：

php

$table->unsignedTinyInteger('votes');

`ulidMorphs()`

ulidMorphs 方法是一个便利方法，添加一个 {column}_id CHAR(26) 等效列和一个 {column}_type VARCHAR 等效列。

此方法旨在在定义多态 Eloquent 关系所需的列时使用，该关系使用 ULID 标识符。在以下示例中，将创建 taggable_id 和 taggable_type 列：

php

$table->ulidMorphs('taggable');

`uuidMorphs()`

uuidMorphs 方法是一个便利方法，添加一个 {column}_id CHAR(36) 等效列和一个 {column}_type VARCHAR 等效列。

此方法旨在在定义多态 Eloquent 关系所需的列时使用，该关系使用 UUID 标识符。在以下示例中，将创建 taggable_id 和 taggable_type 列：

php

$table->uuidMorphs('taggable');

`ulid()`

ulid 方法创建一个 ULID 等效列：

php

$table->ulid('id');

`uuid()`

uuid 方法创建一个 UUID 等效列：

php

$table->uuid('id');

`vector()`

vector 方法创建一个 vector 等效列：

php

$table->vector('embedding', dimensions: 100);

`year()`

year 方法创建一个 YEAR 等效列：

php

$table->year('birth_year');

列修饰符

除了上述列类型外，还有几个列“修饰符”，你可以在向数据库表添加列时使用。例如，要使列“可空”，你可以使用 nullable 方法：

php

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

Schema::table('users', function (Blueprint $table) {
    $table->string('email')->nullable();
});

以下表格包含所有可用的列修饰符。此列表不包括索引修饰符：

修饰符	描述
`->after('column')`	将列“放在”另一个列之后（MariaDB / MySQL）。
`->autoIncrement()`	将 `INTEGER` 列设置为自增（主键）。
`->charset('utf8mb4')`	为列指定字符集（MariaDB / MySQL）。
`->collation('utf8mb4_unicode_ci')`	为列指定排序规则。
`->comment('my comment')`	为列添加注释（MariaDB / MySQL / PostgreSQL）。
`->default($value)`	为列指定“默认”值。
`->first()`	将列“放在”表的第一位（MariaDB / MySQL）。
`->from($integer)`	设置自增字段的起始值（MariaDB / MySQL / PostgreSQL）。
`->invisible()`	使列对 `SELECT *` 查询“不可见”（MariaDB / MySQL）。
`->nullable($value = true)`	允许将 `NULL` 值插入到列中。
`->storedAs($expression)`	创建一个存储生成的列（MariaDB / MySQL / PostgreSQL / SQLite）。
`->unsigned()`	将 `INTEGER` 列设置为 `UNSIGNED`（MariaDB / MySQL）。
`->useCurrent()`	将 `TIMESTAMP` 列设置为使用 `CURRENT_TIMESTAMP` 作为默认值。
`->useCurrentOnUpdate()`	将 `TIMESTAMP` 列设置为在记录更新时使用 `CURRENT_TIMESTAMP`（MariaDB / MySQL）。
`->virtualAs($expression)`	创建一个虚拟生成的列（MariaDB / MySQL / SQLite）。
`->generatedAs($expression)`	创建一个具有指定序列选项的身份列（PostgreSQL）。
`->always()`	定义序列值优先于输入的身份列的优先级（PostgreSQL）。

默认表达式

default 修饰符接受一个值或一个 Illuminate\Database\Query\Expression 实例。使用 Expression 实例将防止 Laravel 将值用引号括起来，并允许你使用数据库特定的函数。一个特别有用的情况是，当你需要为 JSON 列分配默认值时：

php

<?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
{
    /**
     * 运行迁移。
     */
    public function up(): void
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->id();
            $table->json('movies')->default(new Expression('(JSON_ARRAY())'));
            $table->timestamps();
        });
    }
};

警告

默认表达式的支持取决于你的数据库驱动程序、数据库版本和字段类型。请参考数据库的文档。

列顺序

在使用 MariaDB 或 MySQL 数据库时，可以使用 after 方法在架构中添加列，使其位于现有列之后：

php

$table->after('password', function (Blueprint $table) {
    $table->string('address_line1');
    $table->string('address_line2');
    $table->string('city');
});

修改列

change 方法允许你修改现有列的类型和属性。例如，你可能希望将 string 列的大小从 25 增加到 50。要查看 change 方法的实际应用，我们只需定义列的新状态，然后调用 change 方法：

php

Schema::table('users', function (Blueprint $table) {
    $table->string('name', 50)->change();
});

在修改列时，必须显式包含你希望保留的所有修饰符 - 任何缺失的属性将被删除。例如，要保留 unsigned、default 和 comment 属性，必须在更改列时显式调用每个修饰符：

php

Schema::table('users', function (Blueprint $table) {
    $table->integer('votes')->unsigned()->default(1)->comment('my comment')->change();
});

change 方法不会更改列的索引。因此，你可以使用索引修饰符在修改列时显式添加或删除索引：

php

// 添加索引...
$table->bigIncrements('id')->primary()->change();

// 删除索引...
$table->char('postal_code', 10)->unique(false)->change();

重命名列

要重命名列，可以使用架构生成器提供的 renameColumn 方法：

php

Schema::table('users', function (Blueprint $table) {
    $table->renameColumn('from', 'to');
});

删除列

要删除列，可以使用架构生成器上的 dropColumn 方法：

php

Schema::table('users', function (Blueprint $table) {
    $table->dropColumn('votes');
});

你可以通过将列名的数组传递给 dropColumn 方法，从表中删除多个列：

php

Schema::table('users', function (Blueprint $table) {
    $table->dropColumn(['votes', 'avatar', 'location']);
});

可用命令别名

Laravel 提供了几个与删除常见类型列相关的方便方法。每个方法在下表中描述：

命令	描述
`$table->dropMorphs('morphable');`	删除 `morphable_id` 和 `morphable_type` 列。
`$table->dropRememberToken();`	删除 `remember_token` 列。
`$table->dropSoftDeletes();`	删除 `deleted_at` 列。
`$table->dropSoftDeletesTz();`	`dropSoftDeletes()` 方法的别名。
`$table->dropTimestamps();`	删除 `created_at` 和 `updated_at` 列。
`$table->dropTimestampsTz();`	`dropTimestamps()` 方法的别名。

索引

创建索引

Laravel 架构生成器支持多种类型的索引。以下示例创建一个新的 email 列，并指定其值应是唯一的。要创建索引，我们可以将 unique 方法链接到列定义：

php

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

Schema::table('users', function (Blueprint $table) {
    $table->string('email')->unique();
});

或者，你可以在定义列后创建索引。为此，你应该在架构生成器蓝图上调用 unique 方法。此方法接受应接收唯一索引的列的名称：

php

$table->unique('email');

你甚至可以将列数组传递给索引方法，以创建复合（或复合）索引：

php

$table->index(['account_id', 'created_at']);

在创建索引时，Laravel 将根据表、列名和索引类型自动生成索引名称，但你可以将第二个参数传递给方法以指定索引名称：

php

$table->unique('email', 'unique_email');

可用索引类型

Laravel 的架构生成器蓝图类提供了用于创建 Laravel 支持的每种类型索引的方法。每个索引方法接受一个可选的第二个参数来指定索引的名称。如果省略，则名称将根据用于索引的表和列名以及索引类型派生。每个可用索引方法在下表中描述：

命令	描述
`$table->primary('id');`	添加主键。
`$table->primary(['id', 'parent_id']);`	添加复合键。
`$table->unique('email');`	添加唯一索引。
`$table->index('state');`	添加索引。
`$table->fullText('body');`	添加全文索引（MariaDB / MySQL / PostgreSQL）。
`$table->fullText('body')->language('english');`	添加指定语言的全文索引（PostgreSQL）。
`$table->spatialIndex('location');`	添加空间索引（SQLite 除外）。

重命名索引

要重命名索引，可以使用架构生成器蓝图提供的 renameIndex 方法。此方法接受当前索引名称作为第一个参数，所需名称作为第二个参数：

php

$table->renameIndex('from', 'to')

删除索引

要删除索引，必须指定索引的名称。默认情况下，Laravel 根据表名、索引列的名称和索引类型自动分配索引名称。以下是一些示例：

命令	描述
`$table->dropPrimary('users_id_primary');`	从“users”表中删除主键。
`$table->dropUnique('users_email_unique');`	从“users”表中删除唯一索引。
`$table->dropIndex('geo_state_index');`	从“geo”表中删除基本索引。
`$table->dropFullText('posts_body_fulltext');`	从“posts”表中删除全文索引。
`$table->dropSpatialIndex('geo_location_spatialindex');`	从“geo”表中删除空间索引（SQLite 除外）。

如果你将列数组传递给删除索引的方法，则将根据表名、列名和索引类型生成常规索引名称：

php

Schema::table('geo', function (Blueprint $table) {
    $table->dropIndex(['state']); // 删除索引 'geo_state_index'
});

外键约束

Laravel 还提供了创建外键约束的支持，用于在数据库级别强制引用完整性。例如，让我们在 posts 表上定义一个 user_id 列，该列引用 users 表上的 id 列：

php

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');
});

由于这种语法相当冗长，Laravel 提供了额外的、更简洁的方法，使用约定来提供更好的开发者体验。当使用 foreignId 方法创建列时，上面的示例可以重写如下：

php

Schema::table('posts', function (Blueprint $table) {
    $table->foreignId('user_id')->constrained();
});

foreignId 方法创建一个 UNSIGNED BIGINT 等效列，而 constrained 方法将使用约定来确定被引用的表和列。如果你的表名与 Laravel 的约定不匹配，你可以手动提供它。此外，还可以指定应分配给生成的索引的名称：

php

Schema::table('posts', function (Blueprint $table) {
    $table->foreignId('user_id')->constrained(
        table: 'users', indexName: 'posts_user_id'
    );
});

你还可以指定约束的“删除时”和“更新时”的所需操作：

php

$table->foreignId('user_id')
    ->constrained()
    ->onUpdate('cascade')
    ->onDelete('cascade');

还提供了一种替代的、富有表现力的语法来进行这些操作：

方法	描述
`$table->cascadeOnUpdate();`	更新应级联。
`$table->restrictOnUpdate();`	更新应被限制。
`$table->nullOnUpdate();`	更新应将外键值设置为 null。
`$table->noActionOnUpdate();`	更新时不采取任何行动。
`$table->cascadeOnDelete();`	删除应级联。
`$table->restrictOnDelete();`	删除应被限制。
`$table->nullOnDelete();`	删除应将外键值设置为 null。
`$table->noActionOnDelete();`	如果存在子记录，则阻止删除。

任何额外的列修饰符必须在 constrained 方法之前调用：

php

$table->foreignId('user_id')
    ->nullable()
    ->constrained();

删除外键

要删除外键，可以使用 dropForeign 方法，传递要删除的外键约束的名称。外键约束使用与索引相同的命名约定。换句话说，外键约束名称基于表名和约束中的列，后跟“_foreign”后缀：

php

$table->dropForeign('posts_user_id_foreign');

或者，你可以将包含外键的列名的数组传递给 dropForeign 方法。该数组将根据 Laravel 的约束命名约定转换为外键约束名称：

php

$table->dropForeign(['user_id']);

切换外键约束

你可以通过使用以下方法在迁移中启用或禁用外键约束：

php

Schema::enableForeignKeyConstraints();

Schema::disableForeignKeyConstraints();

Schema::withoutForeignKeyConstraints(function () {
    // 在此闭包内禁用约束...
});

警告

SQLite 默认禁用外键约束。在使用 SQLite 时，请确保在尝试在迁移中创建它们之前启用外键支持。

事件

为了方便起见，每个迁移操作将调度一个事件。以下所有事件都扩展了基础 Illuminate\Database\Events\MigrationEvent 类：

类	描述
`Illuminate\Database\Events\MigrationsStarted`	一批迁移即将执行。
`Illuminate\Database\Events\MigrationsEnded`	一批迁移已完成执行。
`Illuminate\Database\Events\MigrationStarted`	单个迁移即将执行。
`Illuminate\Database\Events\MigrationEnded`	单个迁移已完成执行。
`Illuminate\Database\Events\NoPendingMigrations`	迁移命令未找到待处理的迁移。
`Illuminate\Database\Events\SchemaDumped`	数据库架构转储已完成。
`Illuminate\Database\Events\SchemaLoaded`	已加载现有数据库架构转储。

数据库：迁移 ​

介绍 ​

生成迁移 ​

合并迁移 ​

迁移结构 ​

设置迁移连接 ​

运行迁移 ​

隔离迁移执行 ​

强制在生产环境中运行迁移 ​

回滚迁移 ​

使用单个命令回滚并迁移 ​

删除所有表并迁移 ​

表 ​

创建表 ​

确定表/列存在性 ​

数据库连接和表选项 ​

更新表 ​

重命名/删除表 ​

使用外键重命名表 ​

列 ​

创建列 ​

可用列类型 ​

布尔类型 ​

字符串和文本类型 ​

数值类型 ​

日期时间类型 ​

二进制类型 ​

对象 & JSON 类型 ​

UUID & ULID 类型 ​

空间类型 ​

关系类型 ​

特殊类型 ​

bigIncrements() ​

bigInteger() ​

binary() ​

boolean() ​

char() ​

dateTimeTz() ​

dateTime() ​

date() ​

decimal() ​

double() ​

enum() ​

float() ​

foreignId() ​

foreignIdFor() ​

foreignUlid() ​

foreignUuid() ​

geography() ​

geometry() ​

id() ​

increments() ​

integer() ​

ipAddress() ​

json() ​

jsonb() ​

longText() ​

macAddress() ​

mediumIncrements() ​

mediumInteger() ​

mediumText() ​

morphs() ​

nullableMorphs() ​

nullableUlidMorphs() ​

nullableUuidMorphs() ​

rememberToken() ​

set() ​

smallIncrements() ​

smallInteger() ​

softDeletesTz() ​

softDeletes() ​

string() ​

text() ​

timeTz() ​

time() ​

timestampTz() ​

timestamp() ​

timestampsTz() ​

timestamps() ​

tinyIncrements() ​

数据库：迁移

介绍

生成迁移

合并迁移

迁移结构

设置迁移连接

运行迁移

隔离迁移执行

强制在生产环境中运行迁移

回滚迁移

使用单个命令回滚并迁移

删除所有表并迁移

表

创建表

确定表/列存在性

数据库连接和表选项

更新表

重命名/删除表

使用外键重命名表

列

创建列

可用列类型

布尔类型

字符串和文本类型

数值类型

日期时间类型

二进制类型

对象 & JSON 类型

UUID & ULID 类型

空间类型

关系类型

特殊类型

`bigIncrements()`

`bigInteger()`

`binary()`

`boolean()`

`char()`

`dateTimeTz()`

`dateTime()`

`date()`

`decimal()`

`double()`

`enum()`

`float()`

`foreignId()`

`foreignIdFor()`

`foreignUlid()`

`foreignUuid()`

`geography()`

`geometry()`

`id()`

`increments()`

`integer()`

`ipAddress()`

`json()`

`jsonb()`

`longText()`

`macAddress()`

`mediumIncrements()`

`mediumInteger()`

`mediumText()`

`morphs()`

`nullableMorphs()`

`nullableUlidMorphs()`

`nullableUuidMorphs()`

`rememberToken()`

`set()`

`smallIncrements()`

`smallInteger()`

`softDeletesTz()`

`softDeletes()`

`string()`

`text()`

`timeTz()`

`time()`

`timestampTz()`

`timestamp()`

`timestampsTz()`

`timestamps()`

`tinyIncrements()`