对Yii2 migrate数据库迁移的一些看法和操作分享

前言

Yii2 migrate 数据库迁移要我用一个词形容的话，“鸡助”最适合不过了，食之无味，弃之可惜。Yii2 migrate能完成的操作，手工会更快，数据表结构变化也不能保存源表的数据，但是对于一些修改和建表操作在团队协作中还是挺方便的，数据库管理者只需要执行yii migrate的命令就能操作表，追踪数据库迁移的历史，应用新的迁移版本，或恢复之前的迁移版本。但凡有优劣，可当优势大于劣势的时候，我们会更多的去考虑如何落地的问题。

建立迁移

1、建立新的迁移请运行以下命令：
./yii migrate/create plan_admin //plan_admin 迁移建立名为plan_admin的新表

2、运行结果，生成文件及文件名看下图：

3、打开m170108_055206_plan_admin.php即可看到

<?php

use yii\db\Migration;

class m170108_055206_plan_admin extends Migration
{
    public function up()
    {

    }

    public function down()
    {
        echo "m170108_055206_plan_admin cannot be reverted.\n";

        return false;
    }

    /*
    // Use safeUp/safeDown to run migration code within a transaction
    public function safeUp()
    {
    }

    public function safeDown()
    {
    }
    */
}

注释：当执行./yii migrate/create plan_admin命令遇到如下问题：'The configuration for the "user" component must contain a "class" element.' 或者'The configuration for the "session" component must contain a "class" element.'。

解决办法：
首先说一下问题的根源，是你的配置文件（main.php）配置user或者session的时候缺少了class类了，加上即可。 user类：'class' => \yii\web\User，session类：'class' => 'yii\web\Session'，注意这里的类必须是yiiweb下的，不能自定义，否则错误问题没法解决。参考网址

创建数据表

 public function up()
    {
            $tableOptions = null;
            if ($this->db->driverName === 'mysql') {
              $tableOptions = 'CHARACTER SET utf8 COLLATE utf8_general_ci ENGINE=InnoDB COMMENT="计划管理表"';
            }
            //一开始没有PlanAdmin models类可将PlanAdmin::tableName()用'{{plan_admin}}'替换。
            $this->createTable(PlanAdmin::tableName(), [
                'id' => $this->primaryKey(),
                'titile' => $this->string(100)->notNull()->comment('计划标题'),
                'module' => $this->integer()->defaultValue(0)->comment('模块'),
                'status' => $this->integer()->defaultValue(0)->comment('状态'),
                'plan_content' => $this->text()->comment('计划内容'),
                'supervisor' => $this->string(100)->comment('督导人'),
                'end_time' => $this->integer()->comment('完成时间'),
                'daily_maxim' => $this->text()->comment('每日格言'),
                'daily_summary' => $this->text()->comment('每日总结'),
                'company_id' => $this->integer()->comment('公司id'),
                'created_time' => $this->integer()->comment('添加时间'),
                'update_time' => $this->integer()->comment('修改时间'),
            ], $tableOptions);

    }

添加字段

 public function up()
    {   
        //添加字段
        $this->addColumn(PlanAdmin::tableName(), 'user_id', 'INT(11) DEFAULT 0 COMMENT "计划人" AFTER `titile`');
        // $this->addColumn(PlanAdmin::tableName(), 'company_id', 'INT(10) NOT NULL COMMENT "公司id" AFTER `daily_summary`');
    }

修改字段

 public function up()
    {   
        
        $this->alterColumn(PlanAdmin::tableName(), 'end_time', 'string(150) COMMENT "完成时间"');
    }

增加索引

public function up()
 {
    $this->createIndex('module', PlanAdmin::tableName(), ['module'],true); 
 }

删除某字段

public function down()
 {
    $this->dropColumn(PlanAdmin::tableName(), 'update_time');
 }

删除某表

public function down()
  {
    $this->dropTable(PlanAdmin::tableName());
  }

添加主键

public function up()
    {   
        $this->addForeignKey('contract_id' , '{{service_plan}}' , 'contract_id' , '{{contract}}' , 'id' , 'CASCADE' , 'RESTRICT');
    }
    
    addForeignKey()方法的参数注释：
    
    参数1：设置本表的外键名（可自定义）。
    参数2：本表表名。
    参数3：本表中与外表关联的字段名称。如果有多个字段，以逗号分隔或使用一个数组。
    参数4：外表表名。
    参数5：外表中与本表关联的字段名称。如果有多个字段，以逗号分隔或使用一个数组。
    参数6：删除选项，可选，默认为空。可选的类型有 RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL。
    参数7：更新选项，可选，默认为空。可选的类型有 RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL。
    
    注意：参数3和参数5的字段类型必须一致，否则执行失败。

事务性的迁移（整体迁移或回滚）

执行复杂的 DB 迁移时，通常想确定每个完整迁移全体是成功了还是失败了，以便数据库保持一致和完整。为实现该目标，可以利用数据库事务来处理，使用专用的 safeUp 和 safeDown 方法来达到这些目的。参考文档

常用命令

./yii migrate 默认执行 ./yii migrate/up
./yii migrate/down 执行某些撤销对表的操作
./yii migrate/redo (指定了重做多少迁移，默认为 1) 重做迁移 就是首先回退然后应用指定的迁移
./yii migratre/to （迁移文件名）执行某个指定的迁移文件
./yii migrate/history (迁移数量，不指定将显示所有) 显示被应用的所有迁移
./yii migrate/new （迁移数量，不指定将显示所有） 显示没有被应用的所有新迁移。

在创建数据表的过程中可以同时声称多张表，删除多张表。

执行过的迁移文件，会在数据库的migration中生成一条记录，记录此迁移文件已经执行过，下次将执行数据表中不存在的迁移文件。意思就是说文件执行过了，想要再次执行的话，得把文件名改一下。

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

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(): 删除一个索引

注意事项

以上是XFtp上操作记录，如果是本地的话运行时把yii前面的“./”去掉。注意要在项目的根目录运行命令。

相关资料

Yii2 migrate 数据库迁移
Yii2之数据库迁移（Migrate）