数据库：迁移

• 简介
• 生成迁移
• 迁移结构
• 运行迁移
  • 回滚迁移
• 数据表
  • 创建数据表
  • 重命名/删除 数据表
• 字段
  • 创建字段
  • 字段修饰
  • 修改字段
  • 删除字段
• 索引
  • 创建索引
  • 重命名索引
  • 删除索引
  • 外键约束

简介

迁移就像是数据库的版本控制器，让你的团队更容易修改和共享程序的数据库结构。迁移通常配合 Laravel 的结构生成器，能更容易的生成应用程序的数据库结构。如果你曾经让一个团队成员在他本地的数据库结构中手动的添加了字段，那么你将面对解决数据库迁移的问题。

Laravel 的 Schema facade 提供数据库相关的支持，用于在所有 Laravel 支持的数据库系统中创建和操作表。

生成迁移

使用 Artisan 命令 make:migration 来创建迁移：

php artisan make:migration create_users_table

新创建的迁移会放在你的 database/migrations 目录。每个迁移的文件名都包含一个时间戳来让 Laravel 确认迁移的顺序。

提示：迁移 stubs 必须使用 stub publishing 进行自定义。

--table 和 --create 选项也可用于确定表的名称以及是否在迁移中创建新的数据表。这些选项用指定的迁移模板预先填充指定的数据表：

php artisan make:migration create_users_table --create=users

php artisan make:migration add_votes_to_users_table --table=users

如果你想自定义生成迁移文件的个人存放路径，你可以在你执行 make:migration 命令行的时候使用 --path 选项。给定的路径应该是相对于你的应用程序根目录的相对路径。

迁移结构

一个迁移类包含两个方法： up 和 down。up 方法是用于新增数据库的数据表、字段或者索引的，而 down方法应该与 up 方法的执行操作相反。

在这两种方法中，你可以使用 Laravel 的结构生成器以表达式方式创建和修改表。要了解 Schema 生成器上可用的所有方法，请查看其文档。例如，这是一个创建 flights 数据表的例子：

<?php

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

class CreateFlightsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->string('airline');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::drop('flights');
    }
}

运行迁移

请执行 Artisan 的 migrate 命令来执行所有未执行的迁移：

php artisan migrate

注意：如果你使用的是 Homestead 虚拟机，你应该在虚拟机中执行这个命令。

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

大多数迁移操作都是破坏性的，这意味着也许会丢失数据。为了防止有人在生产环境数据中运行这些命令，在执行这些命令之前将提示你进行确认。如果要强制迁移命令在没有提示的情况下运行，请使用 --force 参数：

php artisan migrate --force

回滚迁移

要回滚到最后一次操作，你可以用下 rollback 命令。此命令会回滚到最后一批的迁移，这可能会包含多个迁移文件：

php artisan migrate:rollback

通过向 rollback 命令加上 step 参数，可以回滚指定数量的迁移。例如，以下命令将回滚最后五个迁移：

php artisan migrate:rollback --step=5

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

php artisan migrate:reset

使用单个命令来执行迁移和回滚

migrate:refresh 命令将会在回滚你所有的迁移后执行 migrate 命令。这个命令可以高效的重新创建你的整个数据库：

php artisan migrate:refresh

// Refresh the database and run all database seeds...
php artisan migrate:refresh --seed

通过向 refresh 命令加上 step 参数，可以回滚并重新迁移指定数量的迁移。例如，以下命令将回滚并重新迁移最后五个迁移：

php artisan migrate:refresh --step=5

删除所有数据表和迁移

migrate:fresh 命令将会删除数据库中所有的数据表并在之后执行 migrate 命令：

php artisan migrate:fresh

php artisan migrate:fresh --seed

数据表

创建数据表

请使用 Schema facade 中的 create 方法来在数据库中创建一个新表。create 可以接受两个参数。一个是数据表的名字，另一个是 Closure 可以在定义一个新数据表的时候接受 Blueprint 对象：

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

在创建数据表时，你可以使用结构生成器的任何 字段方法 去定义数据表的字段。

检查表 / 列是否存在

你可以使用 hasTable 和 hasColumn 方法轻松的检查数据表和字段是否存在：

if (Schema::hasTable('users')) {
    //
}

if (Schema::hasColumn('users', 'email')) {
    //
}

数据库连接 & 数据表选项

如果你想要对非默认连接的数据库连接执行结构操作，请使用 connection 方法：

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

你可以在结构生成器上使用以下命令定义表的选项：

重命名 / 删除 数据表

重命名一个存在的数据库表，请使用 rename 方法：

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

删除一个存在的数据表，你可以使用 drop 或者 dropIfExists 方法：

Schema::drop('users');

Schema::dropIfExists('users');

重命名有外键约束的数据表

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

字段

创建字段

在 Schema 门面中可以使用 table 方法来更新已存在的数据表。和 create 方法一样，table 方法接受两个参数：一个是数据表的名字，另一个是 Closure 可以在新增一个数据表中字段的时候接受 Blueprint 对象：

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

可用的字段类型

数据库结构生成器包含构建表时可以指定的各种字段类型：

字段修饰

除了上述列出的字段类型之外，还有几个可以在添加字段到数据库表时使用的 「修饰符」。例如，如果要把字段设置为「可空」，你可以使用 nullable 方法：

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

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

默认值表示方式

default 修饰符接收一个变量或者一个 \Illuminate\Database\Query\Expression 实例。使用 Expression 实例可以避免使用包含在引号中的值，并且允许你使用特定数据库函数。这个在一个场景特别有用，就是当你需要给 JSON 字段指定默认值的时候：

<?php

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

class CreateFlightsTable extends Migration
{
    /**
     * 运行迁移
     *
     * @return void
     */
    public function up()
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->id();
            $table->json('movies')->default(new Expression('(JSON_ARRAY())'));
            $table->timestamps();
        });
    }
}

注意：支持哪些默认值的表示方式取决于你的数据库驱动、数据库版本、还有字段类型。请参考合适的文档使用。还有一点要注意的是，使用数据库特定函数，可能会将你绑牢到特定的数据库驱动上。

修改字段

先决条件

在修改字段之前，请确保将 doctrine/dbal 依赖添加到 composer.json 文件中。Doctrine DBAL 库用于确定字段的当前状态， 并创建对该字段进行指定调整所需的 SQL 查询：

composer require doctrine/dbal

更新字段属性

change 方法可以将现有的字段类型修改为新的类型或修改属性。
比如，你可能想增加。字符串字段的长度，可以使用 change 方法把 name 字段的长度从 25 增加到 50：

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

我们同样可以将字段修改为 nullable：

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

注意：只有以下字段类型能被 「修改」：bigInteger、binary、boolean、date、dateTime、dateTimeTz、decimal、integer、json、 longText、mediumText、smallInteger、string、text、time、unsignedBigInteger、unsignedInteger 和 unsignedSmallInteger。

重命名字段

可以使用结构生成器上的 renameColumn 方法来重命名字段。在重命名字段前 ， 请确保你的 composer.json 文件内已经加入 doctrine/dbal 依赖：

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

注意：当前不支持 enum 类型的字段重命名。

删除字段

可以使用结构生成器上的 dropColumn 方法来删除字段。在从 SQLite 数据库删除字段前，你需要在 composer.json 文件中加入 doctrine/dbal 依赖并在终端执行 composer update 来安装该依赖：

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

你可以传递一个字段数组给 dropColumn 方法来删除多个字段：

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

注意：不支持在使用 SQLite 数据库时在单个迁移中删除或修改多个字段。

可用的命令别名

索引

创建索引

结构生成器支持多种类型的索引。下面的例子中新建了一个值唯一的 email 字段。我们可以将 unique 方法链式地添加到字段定义上来创建索引：

$table->string('email')->unique();

或者，你也可以在定义完字段之后创建索引。例如：

$table->unique('email');

你甚至可以将数组传递给索引方法来创建一个复合（或合成）索引：

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

Laravel 会自动生成一个合理的索引名称，但你也可以传递第二个参数来自定义索引名称：

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

可用的索引类型

每个索引方法都接受一个可选的第二个参数来指定索引的名称。如果省略，名称将根据表和列的名称生成。

索引长度 & MySQL / MariaDB

Laravel 默认使用 utf8mb4 编码，它支持在数据库中储存 emojis 。如果你是在版本低于 5.7.7 的 MySQL 或者版本低于 10.2.2 的 MariaDB 上创建索引，那你就需要手动配置数据库迁移的默认字符串长度。即在 AppServiceProvider 中调用 Schema::defaultStringLength 方法来配置它：

use Illuminate\Support\Facades\Schema;

/**
 * Bootstrap any application services.
 *
 * @return void
 */
public function boot()
{
    Schema::defaultStringLength(191);
}

当然，你也可以选择开启数据库的 innodb_large_prefix 选项。至于如何正确开启，请自行查阅数据库文档。

重命名索引

若要重命名索引，你需要调用 renameIndex方法。此方法接受当前索引名称作为其第一个参数，并将所需名称作为其第二个参数:

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

删除索引

若要删除索引，则必须指定索引的名称。Laravel 默认会自动将数据表名称、索引的字段名及索引类型简单地连接在一起作为名称。举例如下：

如果将字段数组传给 dropIndex 方法，会删除根据表名、字段和键类型生成的索引名称。

Schema::table('geo', function (Blueprint $table) {
    $table->dropIndex(['state']); // Drops index 'geo_state_index'
});

外键约束

Laravel 还支持创建用于在数据库层中的强制引用完整性的外键约束。例如，让我们在 posts 表上定义一个引用 users 表的 id 字段的 user_id 字段：

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

    $table->foreignId('user_id')->references('id')->on('users');
});

由于这种外键约束的定义方式过于繁复，Laravel 额外提供了更简洁的方法，这些方法使用约定来提供更好的开发人员体验。上面的示例还可以这么写：

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

foreignId 方法是 unsignedBigInteger 的别名，而 constrained 方法将使用约定来确定引用的表名和列名。

你可以为 on delete 和on update 属性指定所需的操作：

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

你可以使用 dropForeign 方法来删除外键。外键约束采用的命名方式与索引相同。即，将数据表名称和约束的字段连接起来，再加上 _foreign 后缀：

$table->dropForeign('posts_user_id_foreign');

或者，你也可以传递一个字段数组，在删除的时候会按照约定字段转换为对应的外键名称：

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

你可以在迁移文件中使用以下方法来开启或关闭外键约束：

Schema::enableForeignKeyConstraints();

Schema::disableForeignKeyConstraints();

注意：SQLite 默认禁用外键约束。 使用 SQLite 时，请确保在数据库配置中启用 启用外键支持 然后再尝试在迁移中创建它们。