yii2.0數據庫遷移的示例分析

這篇文章主要介紹了yii2.0數據庫遷移的示例分析，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

具體如下：

創建遷移

使用如下命令來創建一個新的遷移：

yii migrate/create <name>

必填參數 name 的作用是對新的遷移做一個簡要的描述。例如，如果這個遷移是用來往多個數據庫同一張表  ( 假設每個數據庫都有news表 )   添加字段的，那么你可以使用addColumn_news （該名稱自定義）這個名稱并運行如下命令：

yii migrate/create addColumn_news

注意：因為 name 參數會被用來生成遷移的類名的一部分，所以該參數應當只包含字母、數字和下劃線。

如上命令將會在 @app/migrations 目錄下創建一個新的名為 m150101_185401_addColumn_news.php 的 PHP 類文件。該文件包含如下的代碼，它們用來聲明一個遷移類 m150101_185401_addColumn_news，并附有代碼框架：

<?php
use yii\db\Schema;
use yii\db\Migration;
class m150101_185401_addColumn_news extends Migration
{
//createDbs 該方法是獲取數據庫對象返回
private function createDbs(){
  $dbs = [];
  $dbs_info =\Yii::$app->params['db'];
  foreach($dbs_info as $k=>$v){
    $dbs[$k] = \Yii::createObject($v);
  }
  return $dbs;
}
//up() 該方法是往不同的數據庫的news表添加 name,nickname,age,sex,site_id等字段
public function up()
{
  $dbs = $this->createDbs();
  foreach($dbs as $v){   //《------遍歷講字段同時添加到不同的數據庫中
    $this->db=$v;
    $this->addColumn('{{%news}}','name','varchar(20)');
    $this->addColumn('{{%news}}','nickname','varchar(20)');
    $this->addColumn('{{%news}}','age','int(3)');
    $this->addColumn('{{%news}}','sex','int(1)');
    $this->addColumn('{{%news}}','site_id','int(5)');
  }
}
//down()  該方法與up()方法相反,是刪除字段的意思
public function down()
{
  $dbs = $this->createDbs();
  foreach($dbs as $v){
    $this->db=$v;
    $this->dropColumn('{{%news}}','name','varchar(20)');
    $this->dropColumn('{{%news}}','nickname','varchar(20)');
    $this->dropColumn('{{%news}}','age','int(3)');
    $this->dropColumn('{{%news}}','sex','int(1)');
    $this->dropColumn('{{%news}}','site_id','int(5)');
  }
}
}

每個數據庫遷移都會被定義為一個繼承自 yii\db\Migration 的 PHP 類。類的名稱按照 m<YYMMDD_HHMMSS>_<Name> 的格式自動生成，其中

<YYMMDD_HHMMSS> 指執行創建遷移命令的 UTC 時間。

<Name> 和你執行命令時所帶的 name 參數值相同。

在遷移類當中，你應當在 up() 方法中編寫改變數據庫結構的代碼。你可能還需要在 down() 方法中編寫代碼來恢復由 up() 方法所做的改變。 當你通過 migration 升級數據庫時， up() 方法將會被調用，反之， down() 將會被調用。如下代碼展示了如何通過遷移類來創建一張 news 表：

use yii\db\Schema;
use yii\db\Migration;
class m150101_185401_create_news_table extends \yii\db\Migration
{
  public function up()
  {
    $this->createTable('news', [
      'id' => Schema::TYPE_PK,
      'title' => Schema::TYPE_STRING . ' NOT NULL',
      'content' => Schema::TYPE_TEXT,
    ]);
  }
  public function down()
  {
    $this->dropTable('news');
  }
}

注意：并不是所有遷移都是可恢復的。例如，如果 up() 方法刪除了表中的一行數據，這將無法通過 down() 方法來恢復這條數據。有時候，你也許只是懶得去執行 down() 方法了，因為它在恢復數據庫遷移方面并不是那么的通用。在這種情況下，你應當在down() 方法中返回 false 來表明這個 migration 是無法恢復的。

訪問數據庫的方法

遷移的基類 yii\db\Migration 提供了一整套訪問和操作數據庫的方法。你可能會發現這些方法的命名和 yii\db\Command 類提供的 DAO 方法很類似。 例如，yii\db\Migration::createTable() 方法可以創建一張新的表，這和 yii\db\Command::createTable() 的功能是一模一樣的。

使用 yii\db\Migration 所提供的方法的好處在于你不需要再顯式的創建 yii\db\Command 實例，而且在執行每個方法的時候都會顯示一些有用的信息來告訴我們數據庫操作是不是都已經完成，還有它們完成這些操作花了多長時間等等。

如下是所有這些數據庫訪問方法的列表：

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

這條命令會列出迄今為止所有未提交的遷移。如果你確定你需要提交這些遷移，它將會按照類名當中的時間戳的順序，一個接著一個的運行每個新的遷移類里面的 up() 或者是 safeUp() 方法。如果其中任意一個遷移提交失敗了，那么這條命令將會退出并停止剩下的那些還未執行的遷移。

對于每一個成功提交的遷移，這條命令都會在一個叫做 migration 的數據庫表中插入一條包含應用程序成功提交遷移的記錄，該記錄將幫助遷移工具判斷哪些遷移已經提交， 哪些還沒有提交。

提示：遷移工具將會自動在數據庫當中創建 migration 表，該數據庫是在該命令的 yii\console\controllers\MigrateController::db 選項當中指定的。默認情況下，是由 db application component 指定的。

有時，你可能只需要提交一個或者少數的幾個遷移，你可以使用該命令指定需要執行的條數，而不是執行所有的可用遷移。例如，如下命令將會嘗試提交前三個可用的遷移：

yii migrate 3

你也可以指定一個特定的遷移，按照如下格式使用 migrate/to 命令來指定數據庫應該提交哪一個遷移：

yii migrate/to 150101_185401           # using timestamp to specify the migration 使用時間戳來指定遷移
yii migrate/to "2015-01-01 18:54:01"       # using a string that can be parsed by strtotime() 使用一個可以被 strtotime() 解析的字符串
yii migrate/to m150101_185401_create_news_table  # using full name 使用全名
yii migrate/to 1392853618             # using UNIX timestamp 使用 UNIX 時間戳

如果在指定要提交的遷移前面還有未提交的遷移，那么在執行這個被指定的遷移之前，這些還未提交的遷移會先被提交。

如果被指定提交的遷移在之前已經被提交過，那么在其之后的那些遷移將會被還原。

還原遷移

你可以使用如下命令來還原其中一個或多個意見被提交過的遷移：

yii migrate/down   # revert the most recently applied migration 還原最近一次提交的遷移
yii migrate/down 3  # revert the most 3 recently applied migrations 還原最近三次提交的遷移

注意：并不是所有的遷移都能被還原。嘗試還原這類遷移將可能導致報錯甚至是終止所有的還原進程。

重做遷移

重做遷移的意思是先還原指定的遷移，然后再次提交。如下所示：

yii migrate/redo    # redo the last applied migration 重做最近一次提交的遷移
yii migrate/redo 3   # redo the last 3 applied migrations 重做最近三次提交的遷移

注意：如果一個遷移是不能被還原的，那么你將無法對它進行重做。

列出遷移

你可以使用如下命令列出那些提交了的或者是還未提交的遷移：

yii migrate/history   # 顯示最近10次提交的遷移
yii migrate/history 5  # 顯示最近5次提交的遷移
yii migrate/history all # 顯示所有已經提交過的遷移
yii migrate/new     # 顯示前10個還未提交的遷移
yii migrate/new 5    # 顯示前5個還未提交的遷移
yii migrate/new all   # 顯示所有還未提交的遷移

修改遷移歷史

有時候你也許需要簡單的標記一下你的數據庫已經升級到一個特定的遷移，而不是實際提交或者是還原遷移。這個經常會發生在你手動的改變數據庫的一個特定狀態，而又不想相應的遷移被重復提交。那么你可以使用如下命令來達到目的：

yii migrate/mark 150101_185401           # 使用時間戳來指定遷移
yii migrate/mark "2015-01-01 18:54:01"       # 使用一個可以被 strtotime() 解析的字符串
yii migrate/mark m150101_185401_create_news_table  # 使用全名
yii migrate/mark 1392853618             # 使用 UNIX 時間戳

該命令將會添加或者刪除 migration 表當中的某幾行數據來表明數據庫已經提交到了指定的某個遷移上。執行這條命令期間不會有任何的遷移會被提交或還原。

自定義遷移

有很多方法可以自定義遷移命令。

使用命令行選項

遷移命令附帶了幾個命令行選項，可以用來自定義它的行為：

interactive: boolean (默認值為 true)，指定是否以交互模式來運行遷移。當被設置為 true 時，在命令執行某些操作前，會提示用戶。如果你希望在后臺執行該命令，那么你應該把它設置成 false。

migrationPath: string (默認值為 @app/migrations)，指定存放所有遷移類文件的目錄。該選項可以是一個目錄的路徑，也可以是 路徑別名。需要注意的是指定的目錄必選存在，否則將會觸發一個錯誤。

migrationTable: string (默認值為 migration)，指定用于存儲遷移歷史信息的數據庫表名稱。如果這張表不存在，那么遷移命令將自動創建這張表。當然你也可以使用這樣的字段結構： version
 varchar(255) primary key, apply_time integer 來手動創建這張表。

db: string (默認值為 db)，指定數據庫 application component 的 ID。它指的是將會被該命令遷移的數據庫。

templateFile: string (defaults to @yii/views/migration.php)，指定生產遷移框架代碼類文件的模版文件路徑。該選項即可以使用文件路徑來指定，也可以使用路徑 別名 來指定。該模版文件是一個可以使用預定義變量 $className 來獲取遷移類名稱的 PHP 腳本。

如下例子向我們展示了如何使用這些選項：

例如，如果我們需要遷移一個 forum 模塊，而該遷移文件放在該模塊下的 migrations 目錄當中，那么我們可以使用如下命令：

# 在 forum 模塊中以非交互模式進行遷移
yii migrate --migrationPath=@app/modules/forum/migrations --interactive=0

全局配置命令

在運行遷移命令的時候每次都要重復的輸入一些同樣的參數會很煩人，這時候，你可以選擇在應用程序配置當中進行全局配置，一勞永逸：

return [
  'controllerMap' => [
    'migrate' => [
      'class' => 'yii\console\controllers\MigrateController',
      'migrationTable' => 'backend_migration',
    ],
  ],
];

如上所示配置，在每次運行遷移命令的時候，backend_migration 表將會被用來記錄遷移歷史。你再也不需要通過 migrationTable 命令行參數來指定這張歷史紀錄表了。

遷移多個數據庫

默認情況下，遷移將會提交到由 db application component 所定義的同一個數據庫當中。如果你需要提交到不同的數據庫，你可以像下面那樣指定 db 命令行選項，

yii migrate --db=db2

上面的命令將會把遷移提交到 db2 數據庫當中。

偶爾有限時候你需要提交 一些 遷移到一個數據庫，而另外一些則提交到另一個數據庫。為了達到這個目的，你應該在實現一個遷移類的時候指定需要用到的數據庫組件的 ID ， 如下所示：

use yii\db\Schema;
use yii\db\Migration;
class m150101_185401_create_news_table extends Migration
{
  public function init()
  {
    $this->db = 'db2';
    parent::init();
  }
}

即使你使用 db 命令行選項指定了另外一個不同的數據庫，上面的遷移還是會被提交到 db2 當中。需要注意的是這個時候遷移的歷史信息依然會被記錄到 db 命令行選項所指定的數據庫當中。

如果有多個遷移都使用到了同一個數據庫，那么建議你創建一個遷移的基類，里面包含上述的 init() 代碼。然后每個遷移類都繼承這個基類就可以了。

提示：除了在 yii\db\Migration::db 參數當中進行設置以外，你還可以通過在遷移類中創建新的數據庫連接來操作不同的數據庫。然后通過這些連接再使用 DAO 方法 來操作不同的數據庫。

另外一個可以讓你遷移多個數據庫的策略是把遷移存放到不同的目錄下，然后你可以通過如下命令分別對不同的數據庫進行遷移：

yii migrate --migrationPath=@app/migrations/db1 --db=db1
yii migrate --migrationPath=@app/migrations/db2 --db=db2
...

第一條命令將會把 @app/migrations/db1 目錄下的遷移提交到 db1 數據庫當中，第二條命令則會把 @app/migrations/db2 下的遷移提交到 db2 數據庫當中，以此類推。

感謝你能夠認真閱讀完這篇文章，希望小編分享的“yii2.0數據庫遷移的示例分析”這篇文章對大家有幫助，同時也希望大家多多支持億速云，關注億速云行業資訊頻道，更多相關知識等著你來學習!