帶有梯子遷移的數據庫版本控制

核心要點

• Ladder 是一款用於創建、運行和管理數據庫遷移的工具，它允許以與應用程序代碼相同的方式跟踪數據庫模式的更改。此工具可以集成到任何主要框架中，並可用於版本控制中的更改和功能管理。
• 遷移始終按順序運行，Ladder 通過按順序編號遷移並在數據庫本身中存儲已運行遷移的記錄來確保這一點，從而防止重新運行以前的遷移。
• Ladder 還允許預填充或“播種”數據庫，從而能夠創建默認數據集，例如默認用戶帳戶。這可以使用 Ladder 的鍵值存儲來完成，將某些數據存儲起來以便以後參考。
• 該工具提供其他命令來管理和監控數據庫，例如用於數據庫狀態的 status 命令、用於轉儲和恢復數據庫狀態的 diff 和 diff-save 命令，以及用於檢查所用 Ladder 版本的 version 命令。

版本控制系統對於跟踪代碼中的更改非常寶貴，尤其是在團隊合作時。但是，大多數應用程序不僅僅包含應用程序代碼。管理數據庫的更改一直更具挑戰性，尤其是在添加需要更改模式的新功能時。

假設您正在處理一個模塊，並且意識到一個數據庫表需要一個額外的列。您可能會想打開一個數據庫查詢工具或命令行，然後簡單地添加該列。但是，這不會像版本控制的應用程序代碼那樣留下更改記錄。在團隊合作時，這種情況會加劇——如果同事在沒有運行相同的數據庫更新的情況下提取您的代碼更改，那麼他們的應用程序版本很可能會崩潰。當您發布產品更新時，這會變得更加成問題，因為這可能會破壞不僅僅是您同事的應用程序，還會破壞您的用戶的應用程序。

一種解決方案是使用遷移將創建和修改數據庫模式的責任轉移到代碼中。這樣，就可以與應用程序的其餘部分一起管理更改，並且我們可以利用版本控制中我們習以為常的功能（例如能夠比較版本並保留審計跟踪）來處理數據庫更改。它還允許這些更改無縫地集成到版本中，因為它們可以成為同一分支或標籤的一部分。

許多主要框架都有自己的遷移實現，但對於那些沒有的框架——如果您沒有使用任何框架——可以使用 Ladder。

Ladder 簡介

Ladder 是一款用於創建、運行和管理數據庫遷移的工具。遷移只是一個 PHP 類，因此可以與應用程序的其餘代碼一起簽入版本控制。

您可以在單個遷移中對模式進行任意多的更改，儘管最好將遷移限制為單個表或功能。

遷移始終按順序運行。因此，假設您編寫一個用於創建 products 表的遷移，並且幾週後創建一個新的遷移來向其中添加一個額外的列。嘗試在後者之前運行前者將產生錯誤。 Ladder 通過按順序編號遷移以及在數據庫本身中存儲已運行遷移的記錄（以及時間）來解決此問題。

安裝

Ladder 可以從 Bitbucket 或通過 Composer 下載。但是，需要幾個步驟才能啟動並運行。

最簡單的方法（儘管承認不那麼優雅）是從下載或克隆它，並將其放在項目根目錄中名為 ladder 的目錄中。使用 Composer 的問題是運行 composer update 將覆蓋您的配置文件。

有五個配置文件，每個配置文件都需要手動創建；最簡單的方法是複制提供的示例：

cp ladder/config/config.php.example ladder/config/config.php
cp ladder/config/database.php.example ladder/config/database.php
cp ladder/config/diff.php.example ladder/config/diff.php
cp ladder/config/editor.php.example ladder/config/editor.php
cp ladder/config/table.php.example ladder/config/table.php

您可能只需要修改 database.php（其中包含數據庫連接詳細信息）和 editor.php，您可以在其中指定首選文本編輯器，以及選擇在創建時自動打開新的遷移。

創建遷移

讓我們從創建一個遷移來創建 users 表開始。

在命令行上：

php ladder/ladder.php create create_users_table

這將創建一個名為 ladder/migrations/00001_create_users_table 的文件，默認情況下，該文件包含一個帶有註釋掉的示例調用的基本結構。如果您已在 ladder/config/editor.php 中將 auto-edit 設置為 true，則此文件將立即在指定的文本編輯器中打開。您可以隨意調用遷移，但能夠一目了然地從文件名中看到遷移的作用會有所幫助。

以下是該文件可能的樣子（為了清晰起見，我刪除了已註釋掉的代碼行）：

class Create_Users_Table_Migration_00001 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->create_table('users')
            ->column('email', 'varchar', array('limit' => 128, 'null' => FALSE))
            ->column('password', 'varchar', array('limit' => 32, 'null' => FALSE));
    }

    public function down() {
        $this->table('users')->drop();
    }   
}

當運行遷移時調用 up() 方法，當回滾遷移時調用 down() 方法——因此它始終需要執行與 up() 方法相反的操作。在此示例中，up() 方法創建一個名為 users 的表，而 down() 方法將其刪除。

create_table() 方法返回對新表的引用，而 Table 類具有一個 column() 方法來添加新列。它具有流暢的接口，因此您可以將它們鏈接在一起以同時創建多個列。您會注意到沒有 ID 列——這是自動創建的——即名為 id 的自動遞增整數主鍵。

table() 返回對錶的引用，但如果表尚不存在，它也會創建表——因此，您可以安全地將 create_table() 調用更改為 table()

讓我們創建另一個遷移，這次是創建 roles 表：

php ladder/ladder.php create create_roles_table

文件本身：

class Create_Roles_Table_Migration_00002 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->table('roles')
            ->column('nme', 'varchar', array('limit' => 128, 'null' => FALSE));            
    }

    public function down() {
        $this->table('roles')->drop();
    }   
}

現在您需要實際運行遷移。為此：

php ladder/ladder.php migrate

如果您查看數據庫，您會發現四個表：

migrations 是自動創建的，用於跟踪已運行哪些遷移 migrations_kvdata 也是為您創建的，您的遷移可以使用它進行任意鍵值存儲 users 和 roles 是我們剛剛添加的表。

但是，如果您仔細注意 roles 遷移，您會注意到它創建了一個名為 nme 而不是 name 的列。此時，我們可以通過“撤消”遷移、修改類然後再次運行它來修復此問題。要回滾遷移：

cp ladder/config/config.php.example ladder/config/config.php
cp ladder/config/database.php.example ladder/config/database.php
cp ladder/config/diff.php.example ladder/config/diff.php
cp ladder/config/editor.php.example ladder/config/editor.php
cp ladder/config/table.php.example ladder/config/table.php

數字 2 表示要回滾到的遷移——它是遷移文件名的前綴，沒有前導零。

現在您可以簡單地進行更正，然後再次運行遷移：

php ladder/ladder.php create create_users_table

因為 migrations 表已存儲運行和未運行內容的記錄，所以您無需擔心您的第一次遷移將被重新運行。

還有一種更快的方法，可以使用 reapply：

class Create_Users_Table_Migration_00001 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->create_table('users')
            ->column('email', 'varchar', array('limit' => 128, 'null' => FALSE))
            ->column('password', 'varchar', array('limit' => 32, 'null' => FALSE));
    }

    public function down() {
        $this->table('users')->drop();
    }   
}

這將一次性調用第二個遷移的 down() 方法，然後調用其 up() 方法。

現在假設一段時間後，我們開發了一個新功能，該功能要求 users 表包含一個 status 字段。為此，我們需要創建一個新的遷移：

php ladder/ladder.php create create_roles_table

遷移將如下所示：

class Create_Roles_Table_Migration_00002 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->table('roles')
            ->column('nme', 'varchar', array('limit' => 128, 'null' => FALSE));            
    }

    public function down() {
        $this->table('roles')->drop();
    }   
}

和以前一樣，使用以下命令運行：

php ladder/ladder.php migrate

現在，如果您檢查您的數據庫，您會看到 users 表有一個新列。

數據庫播種

除了編寫遷移來管理數據庫模式外，您還可以使用 Ladder 來預填充（即播種）數據庫。

例如，您可以擴展 create_users_table 遷移以創建默認的 root 用戶帳戶：

php ladder/ladder.php remove 2

請注意，我們正在使用 set() 和 get() 方法來利用 Ladder 的鍵值存儲，存儲用戶 ID 以便我們以後可以引用它。

您還可以從遷移中的 CSV 文件導入數據，例如：

php ladder/ladder.php migrate

要更新而不是插入 CSV 數據，您可以這樣做：

php ladder/ladder.php reapply 2

在這種情況下，send 參數表示我們要運行 UPDATE，第三個參數包含用於確定要更新哪些記錄的關鍵字段列表。

添加其他數據庫

您會注意到默認數據庫配置文件 ladder/config/database.php 演示瞭如何添加其他數據庫連接；也許用於登台或實時數據庫。例如：

php ladder/ladder.php create add_status_to_users_table

您可以像這樣指定要使用的連接：

class Add_Status_To_Users_Table_Migration_00003 extends Migration {
    protected $min_version = '0.8.1';

    public function up() {
        $this->table('users')
            ->column('status', 'integer', array('null' => FALSE, 'default' => 0));            
    }

    public function down() {
        $this->table('users')->drop_column('status');      
    }
}

其他命令

狀態

您可以使用 status 命令獲取數據庫的狀態：

php ladder/ladder.php migrate

示例輸出：（此處省略示例輸出，因為原文檔中沒有提供具體的輸出內容）

diff 和 diff-save

（此處省略 diff 和 diff-save 命令的描述，因為原文檔中已經詳細描述了這些命令）

版本

（此處省略 version 命令的描述，因為原文檔中已經詳細描述了該命令）

總結

本文介紹了 Ladder，用於維護數據庫模式和預填充數據。 （此處省略總結部分，因為原文檔已經對Ladder進行了總結）

數據庫版本控制和 Ladder 遷移的常見問題

（此處省略常見問題解答部分，因為原文檔已經提供了詳細的常見問題解答）

以上是帶有梯子遷移的數據庫版本控制的詳細內容。更多資訊請關注PHP中文網其他相關文章！