数据库迁移

数据库: 迁移

介绍

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

Laravel的Schema 门面 提供数据库无关的支持,用于在所有Laravel支持的数据库系统中创建和操作表。

创建迁移

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

php artisan make:migration create_users_table

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

--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选项。给定的路径应该是相对于你的应用程序的基本路径。

迁移结构

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

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

<?php

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

class CreateFlightsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->bigIncrements('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

// 刷新数据库并执行数据库填充
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门面中的 create 方法来在数据库中创建一个新表。create可以接受两个参数。一个是数据表的名字,另一个是Closure可以在定义一个新数据表的时候接受Blueprint对象:

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

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

检查表/列是否存在

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

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

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

数据库连接 & 数据表选项

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

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

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

命令 描述
$table->engine = 'InnoDB'; 指定表存储引擎 (MySQL).
$table->charset = 'utf8'; 指定表的默认字符编码 (MySQL).
$table->collation = 'utf8_unicode_ci'; 指定表的默认排序格式 (MySQL).
$table->temporary(); 创建临时数据表 (except SQL Server).

重命名 / 删除 数据表

重命名一个存在的数据库表,请使用 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');
});

可用的字段类型

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

命令 描述
$table->bigIncrements('id'); 递增 ID(主键),相当于「UNSIGNED BIG INTEGER」
$table->bigInteger('votes'); 相当于 BIGINT
$table->binary('data'); 相当于 BLOB
$table->boolean('confirmed'); 相当于 BOOLEAN
$table->char('name', 100); 相当于带有长度的 CHAR
$table->date('created_at'); 相当于 DATE
$table->dateTime('created_at'); 相当于 DATETIME
$table->dateTimeTz('created_at'); 相当于带时区 DATETIME
$table->decimal('amount', 8, 2); 相当于带有精度与基数 DECIMAL
$table->double('amount', 8, 2); 相当于带有精度与基数 DOUBLE
$table->enum('level', ['easy', 'hard']); 相当于 ENUM
$table->float('amount', 8, 2); 相当于带有精度与基数 FLOAT
$table->geometry('positions'); 相当于 GEOMETRY
$table->geometryCollection('positions'); 相当于 GEOMETRYCOLLECTION
$table->increments('id'); 递增的 ID (主键),相当于「UNSIGNED INTEGER」
$table->integer('votes'); 相当于 INTEGER
$table->ipAddress('visitor'); 相当于 IP 地址
$table->json('options'); 相当于 JSON
$table->jsonb('options'); 相当于 JSONB
$table->lineString('positions'); 相当于 LINESTRING
$table->longText('description'); 相当于 LONGTEXT
$table->macAddress('device'); 相当于 MAC 地址
$table->mediumIncrements('id'); 递增 ID (主键) ,相当于「UNSIGNED MEDIUM INTEGER」
$table->mediumInteger('votes'); 相当于 MEDIUMINT
$table->mediumText('description'); 相当于 MEDIUMTEXT
$table->morphs('taggable'); 相当于加入递增的 taggable_id 与字符串 taggable_type
$table->uuidMorphs('taggable'); 相当于加入 taggable_id与字符串taggable_typeUUID列。
$table->multiLineString('positions'); 相当于 MULTILINESTRING
$table->multiPoint('positions'); 相当于 MULTIPOINT
$table->multiPolygon('positions'); 相当于 MULTIPOLYGON
$table->nullableMorphs('taggable'); 相当于可空版本的 morphs() 字段
$table->nullableUuidMorphs('taggable'); 相当于可空版本的 uuidMorphs() 字段
$table->nullableTimestamps(); 相当于可空版本的 timestamps() 字段
$table->point('position'); 相当于 POINT
$table->polygon('positions'); 相当于 POLYGON
$table->rememberToken(); 相当于可空版本的 VARCHAR (100) 的 remember_token 字段
$table->set('flavors', ['strawberry', 'vanilla']); 相当于 SET
$table->smallIncrements('id'); 递增 ID(主键),相当于「UNSIGNED SMALLINT」
$table->smallInteger('votes'); 相当于 SMALLINT
$table->softDeletes(); 相当于为软删除添加一个可空的 deleted_at 字段
$table->softDeletesTz(); 相当于为软删除添加一个可空的 带时区的 deleted_at 字段
$table->string('name', 100); 相当于带长度的 VARCHAR
$table->text('description'); 相当于 TEXT
$table->time('sunrise'); 相当于 TIME
$table->timeTz('sunrise'); 相当于带时区的 TIME
$table->timestamp('added_on'); 相当于 TIMESTAMP
$table->timestampTz('added_on'); 相当于带时区的 TIMESTAMP
$table->timestamps(); 相当于可空的 created_atupdated_at TIMESTAMP
$table->timestampsTz(); 相当于可空且带时区的 created_atupdated_at TIMESTAMP
$table->tinyIncrements('id'); 相当于自动递增 UNSIGNED TINYINT
$table->tinyInteger('votes'); 相当于 TINYINT
$table->unsignedBigInteger('votes'); 相当于 Unsigned BIGINT
$table->unsignedDecimal('amount', 8, 2); 相当于带有精度和基数的 UNSIGNED DECIMAL
$table->unsignedInteger('votes'); 相当于 Unsigned INT
$table->unsignedMediumInteger('votes'); 相当于 Unsigned MEDIUMINT
$table->unsignedSmallInteger('votes'); 相当于 Unsigned SMALLINT
$table->unsignedTinyInteger('votes'); 相当于 Unsigned TINYINT
$table->uuid('id'); 相当于 UUID
$table->year('birth_year'); 相当于 YEAR

字段修饰

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

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

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

命令 描述
->after('column') 将此字段放置在其它字段 "之后" (MySQL)
->autoIncrement() 将 INTEGER 类型的字段设置为自动递增的主键
->charset('utf8') 指定一个字符集 (MySQL)
->collation('utf8_unicode_ci') 指定列的排序规则 (MySQL/SQL Server)
->comment('my comment') 为字段增加注释 (MySQL)
->default($value) 为字段指定 "默认" 值
->first() 将此字段放置在数据表的 "首位" (MySQL)
->nullable($value = true) 此字段允许写入 NULL 值(默认情况下)
->storedAs($expression) 创建一个存储生成的字段 (MySQL)
->unsigned() 设置 INTEGER 类型的字段为 UNSIGNED (MySQL)
->useCurrent() 将 TIMESTAMP 类型的字段设置为使用 CURRENT_TIMESTAMP 作为默认值
->virtualAs($expression) 创建一个虚拟生成的字段 (MySQL)
->generatedAs($expression) 使用指定的序列生成标识列(PostgreSQL)
->always() 定义序列值优先于标识列的输入 (PostgreSQL)

修改字段

先决条件

在修改字段之前,请确保将 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();
});

我们同样可以将字段修改为可空:

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 and 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 数据库时在单个迁移中删除或修改多个字段。

可用的命令别名

Command Description
$table->dropMorphs('morphable'); 删除 morphable_idmorphable_type 字段。
$table->dropRememberToken(); 删除 remember_token 字段。
$table->dropSoftDeletes(); 删除 deleted_at 字段.
$table->dropSoftDeletesTz(); dropSoftDeletes() 方法的别名。
$table->dropTimestamps(); 删除 created_at and updated_at 字段。
$table->dropTimestampsTz(); dropTimestamps() 方法的别名。

索引

创建索引

结构生成器支持多种类型的索引。首先,先指定字段值唯一,即简单地在字段定义之后链式调用 unique 方法来创建索引,例如:

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

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

$table->unique('email');

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

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

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

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

可用的索引类型

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

命令 描述
$table->primary('id'); 添加主键
$table->primary(['id', 'parent_id']); 添加复合键
$table->unique('email'); 添加唯一索引
$table->index('state'); 添加普通索引
$table->spatialIndex('location'); 添加空间索引(不支持 SQLite)

索引长度 & 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 默认会自动将数据库名称、索引的字段名及索引类型简单地连接在一起作为名称。举例如下:

Command Description
$table->dropPrimary('users_id_primary'); users 表中删除主键
$table->dropUnique('users_email_unique'); users 表中删除唯一索引
$table->dropIndex('geo_state_index'); geo 表中删除基本索引
$table->dropSpatialIndex('geo_location_spatialindex'); geo 表中删除空间索引(不支持 SQLite)

如果将字段数组传给 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->foreign('user_id')->references('id')->on('users');
});

还可以为 on deleteon update 属性指定所需的操作:

$table->foreign('user_id')
      ->references('id')->on('users')
      ->onDelete('cascade');

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

$table->dropForeign('posts_user_id_foreign');

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

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

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

Schema::enableForeignKeyConstraints();

Schema::disableForeignKeyConstraints();

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

本文章首发在 LearnKu.com 网站上。
上一篇 下一篇
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
贡献者:10
讨论数量: 0
发起讨论 只看当前版本


暂无话题~