php db migration validator下載 - php db migration validator原始碼下載

php db migration validator

其他類別

1.0.2

下載

php db migration validator

php-db-遷移-驗證器

介紹

在 Symfony 和 Laravel 等現代 PHP 框架中，遷移通常有up和down方法。在遷移定義的up方法中，您必須編寫僅在向前運行遷移時呼叫的程式碼，而在down中，您必須編寫僅在回滾遷移時呼叫的程式碼。使資料庫遷移不可逆轉是標準做法。遷移應該向後相容並且只能向前進行。

在 Laravel 中，缺失或空的down方法不會阻止執行php artisan migrate:rollback CLI 指令時的回滾遷移。資料庫的狀態不會改變，但遷移會從套用的遷移登錄中刪除，下次執行php artisan migrate會再呼叫up方法。為了防止這種行為，所有遷移都應該有down方法，該方法會拋出異常，僅此而已。

php db migration validator檢查所有遷移檔案是否符合此要求。您可以將其新增至伺服器的 git hooks 以防止移轉回滾，或將驗證步驟新增至 CI。

安裝

透過 Composer 拉入包。

php composer require antonkomarev/php-db-migration-validator

用法

驗證遷移是不可逆的

驗證文件

php vendor/bin/php-db-migration-validator --rule=irreversible migrations/file.php

驗證許多文件

php vendor/bin/php-db-migration-validator --rule=irreversible migrations/file.php migrations/file2.php

透過通配符驗證多個文件

php vendor/bin/php-db-migration-validator --rule=irreversible migrations/2022_ *

驗證目錄中的文件

php vendor/bin/php-db-migration-validator --rule=irreversible migrations/

驗證多個目錄中的文件

php vendor/bin/php-db-migration-validator --rule=irreversible app/migrations/ vendor/migrations/

CI自動化

作為持續整合的一部分，自動驗證對儲存庫的所有貢獻是使用此工具的可能方法之一。

GitHub 行動

在應用程式儲存庫中建立檔案.github/workflows/db-migration-validation.yaml 。

php db migration validator dependency run: composer global require antonkomarev/php-db-migration-validator --no-interaction - name: Ensure all database migrations are irreversible run: php-db-migration-validator --rule=irreversible ./database/migrations">

 name : DB Migration Validation

on :
    push :

jobs :
    db-migration-validation :
        runs-on : ubuntu-latest
        steps :
            - uses : actions/checkout@v2
            - uses : shivammathur/setup-php@v2
              with :
                  php-version : 8.1
                  extensions : tokenizer
                  coverage : none
            - name : Install php db migration validator dependency
              run : composer global require antonkomarev/php-db-migration-validator --no-interaction
            - name : Ensure all database migrations are irreversible
              run : php-db-migration-validator --rule=irreversible ./database/migrations

命令使用說明

php db migration validator -------------------------- by Anton Komarev <[email protected]> Usage: php-db-migration-validator --rule=<rule> <path> The following commands are available: help Shows this usage instructions. Options: --rules=<rule> Validates the database migration(s) in the specified <path>. Exits with code 1 on validation errors, 2 on other errors and 0 on success. Available rules (at least one should be specified): - irreversible — ensure if migration file has `down` method and this method throws an Exception.">

 $ php vendor/bin/php-db-migration-validator --help
php db migration validator
--------------------------
by Anton Komarev <[email protected]>

Usage: php-db-migration-validator --rule=<rule> <path>

  The following commands are available:

    help  Shows this usage instructions.

  Options:

    --rules=<rule>   Validates the database migration(s) in the specified <path>.
                     Exits with code 1 on validation errors, 2 on other errors and 0 on success.
                     Available rules (at least one should be specified):
                     - irreversible — ensure if migration file has `down` method and this method throws an Exception.