Yii2之数据库迁移（Migrate）

最新推荐文章于 2026-03-30 16:15:00 发布

原创最新推荐文章于 2026-03-30 16:15:00 发布 · 2.1w 阅读

6 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#数据库 #yii #迁移 #版本控制

Yii 专栏收录该内容

13 篇文章

订阅专栏

本文介绍了Yii2框架中的数据库迁移功能，用于管理数据库结构的变化。通过`migrate`命令，可以进行数据库迁移的提交、还原、重做以及列出迁移等操作。迁移文件包含`up`和`down`方法，分别对应数据库结构的增改和回滚。使用抽象定义字段类型，确保在不同数据库间的兼容性。迁移记录保存在`migration`表中，方便跟踪数据库状态。

在开发和维护一个数据库驱动的应用程序时，数据库的结构会随代码的改变而改变。例如，在开发应用程序的过程中，会增加一张新表且必须得加进来；在应用程序被部署到生产环境后，需要建立一个索引来提高查询的性能等等。因为一个数据库结构发生改变的时候源代码也经常会需要做出改变，Yii 提供了一个数据库迁移功能，该功能可以记录数据库的变化，以便使数据库和源代码一起受版本控制。

migrate的使用

进入项目的根目录，windows系统在当前根目录打开DOS命令行，以下所有的指令都是在这执行。
ps：如果windows8及以上的可以使用Windows Power Shell，使用Windows Power Shell执行指令时yii指令应该写作.\yii。
创建一个数据库迁移：
yii migrate/create <name>
这是一个通用的创建数据迁移格式，其中<name>是必填的参数，用来描述当前迁移。
ps：<name>这个只能字母、数字、下划线，因为这个指令会生成一个迁移类，<name>会不是这个类的类名的一部分。
举例说明，执行以下指令：
.\yii migrate/create create_test_table
如图：
Yii2 migrate
提示创建，填写yes。
这里写图片描述

m160623_034801_create_test_table.php的内容：

<?php

use yii\db\Migration;

/**
 * Handles the creation for table `test_table`.
 */
class m160623_034801_create_test_table extends Migration
{
    /**
     * @inheritdoc
     */
    public function up()
    {
        $this->createTable('test_table', [
            'id' => $this->primaryKey(),
        ]);
    }

    /**
     * @inheritdoc
     */
    public function down()
    {
        $this->dropTable('test_table');
    }
}

up方法用来编写改变数据库结构的代码；down方法中编写代码来恢复由up方法所做的改变。当使用migration升级数据库时，up方法会被调用，反之，down方法会被调用。
m160623_034801_create_test_table.php的内容增加后：

<?php

use yii\db\Migration;

/**
 * Handles the creation for table `test_table`.
 */
class m160623_034801_create_test_table extends Migration
{
    /**
     * 改变数据表结构方法
     * @inheritdoc
     */
    public function up()
    {
        //创建数据表test_table并且定义表中字段
        $this->createTable('test_table', [
            //`id` int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY
            'id' => $this->primaryKey(),
            //`title` varchar(300) not null
            'title' => $this->string(300)->notNull(),
            //`content` text
            'content' => $this->text(),
            // `create_time` datetime
            'create_time' => $this->dateTime(),
        ]);

        //插入一条数据
        $this->insert('test_table',[
            'id' => 1,
            'title' => '哆啦A梦',
            'content' => '大雄'
        ]);
    }

    /**
     * 还原数据表改动的方法
     * 执行顺序要与up方法内部操作顺序相反
     * @inheritdoc
     */
    public function down()
    {
        //删除一条数据
        $this->delete('test_table',[
            'id' => 1
        ]);
        //drop掉整个表
        $this->dropTable('test_table');
    }
}

补充解释下以上的代码：
$this->string(300)->notNull()这样的代码指的是抽象定义字段类型，什么是抽象定义字段类型？就是说我并不直接写字段的类型，我只是写不同数据库中类似的字段定义。举个例子：
mysql数据库中有text数据类型，用来存储大文本一类数据。而mssql数据库中并没有text数据类型，但是有个类似的数据类型，叫做ntext。如果在数据库迁移到mysql的时候直接写实体字段类型text，那么如果改换数据库为mssql的时候就会很麻烦。使用抽象定义字段类型，就可以避免这个问题。他会根据你选择的数据库与定义的抽象字段类型灵活改变。

如下是所有这些数据库访问方法的列表：

yii\db\Migration::execute(): 执行一条 SQL 语句
yii\db\Migration::insert(): 插入单行数据
yii\db\Migration::batchInsert(): 插入多行数据
yii\db\Migration::update(): 更新数据
yii\db\Migration::delete(): 删除数据
yii\db\Migration::createTable(): 创建表
yii\db\Migration::renameTable(): 重命名表名
yii\db\Migration::dropTable(): 删除一张表
yii\db\Migration::truncateTable(): 清空表中的所有数据
yii\db\Migration::addColumn(): 加一个字段
yii\db\Migration::renameColumn(): 重命名字段名称
yii\db\Migration::dropColumn(): 删除一个字段
yii\db\Migration::alterColumn(): 修改字段
yii\db\Migration::addPrimaryKey(): 添加一个主键
yii\db\Migration::dropPrimaryKey(): 删除一个主键
yii\db\Migration::addForeignKey(): 添加一个外键
yii\db\Migration::dropForeignKey(): 删除一个外键
yii\db\Migration::createIndex(): 创建一个索引
yii\db\Migration::dropIndex(): 删除一个索引

提交迁移：

可以执行如下：
.\yii migrate
这个指令会提交所有的迁移
或者这样，指定类名，提交一个迁移
.\yii migrate m160623_034801_create_test_table
如图：

迁移成功

数据库中会出现一个叫做migration的表，用来记录迁移记录，如图：

选中的就是当前迁移操作生成的记录。
会生成一个数据表test_table并且插入一条数据。

还原迁移：

还原最近一次迁移：
.\yii migrate/down
如图：
还原迁移
还原最近三次迁移：
.\yii migrate/down 3

重做迁移：

重做迁移的意思是先还原指定的迁移，然后再次提交：

.\yii migrate/redo  ##重做最近一次提交的迁移
.\yii migrate/redo 3 ##重做最近三次提交的迁移

列出迁移

可以通过指令列出提交或者未提交的迁移：

.\yii migrate/history  #显示最近10次提交的迁移
.\yii migrate/history 6 #显示最近5次提交的迁移
.\yii migrate/history all #显示所有的提交迁移

.\yii migrate/new #显示最近10次未提交的迁移
.\yii migrate/new 6 #显示最近6次未提交的迁移
.\yii migrate/new all #显示所有的未提交迁移