0

0

CodeIgniter 4 中如何精确运行单个迁移文件(支持模块化按需执行)

聖光之護

聖光之護

发布时间:2026-01-19 19:55:01

|

391人浏览过

|

来源于php中文网

原创

CodeIgniter 4 中如何精确运行单个迁移文件(支持模块化按需执行)

codeigniter 4 原生不支持直接运行指定迁移文件,但可通过自定义 cli 命令调用 `migrationrunner::force()` 方法实现精准迁移,适用于模块化项目中按组(如 blog、sales)独立执行特定迁移。

在模块化 CodeIgniter 4 项目中,常需按业务域(如 blog、sales、storage)组织迁移文件,并支持仅执行某模块的特定迁移——例如部署新销售功能时,仅运行 sales 目录下的迁移,而非全量迁移。遗憾的是,CI4 官方 spark migrate 命令仅支持按版本号(--force 到某时间戳)、命名空间或全部回滚,不提供“仅运行某一个 .php 迁移文件”的内置指令

所幸,CI4 的 MigrationRunner 类公开了关键方法 force($file, $namespace = 'App', $group = 'default'),它允许传入完整文件路径(相对于 ROOTPATH),跳过版本校验与依赖检查,直接执行该文件中的 up() 方法。我们可基于此构建一个高复用性的自定义命令 migrate:file。

✅ 快速创建自定义命令

在终端执行以下命令生成骨架类:

php spark make:command MigrateFile --command migrate:file --group Database --suffix Command

该命令将在 app/Commands/ 下生成 MigrateFileCommand.php。替换其内容为以下精简可靠的实现:

 [options]';
    protected $arguments   = [
        'file-path' => 'Full path to migration file (relative to ROOTPATH), e.g. "app/Database/Migrations/2023-01-01-000000_CreateOrdersTable.php"'
    ];
    protected $options     = [
        '--namespace' => 'Migration namespace (default: "App")',
        '--dbgroup'   => 'Database group name (default: "default")',
    ];

    public function run(array $params)
    {
        $filePath = $params[0] ?? null;
        if (!$filePath) {
            CLI::error('Missing required argument: migration file path.');
            $this->showHelp();
            return;
        }

        $namespace = CLI::getOption('namespace') ?: 'App';
        $dbgroup   = CLI::getOption('dbgroup') ?: 'default';

        CLI::write("Executing migration: {$filePath} (NS: {$namespace}, DB: {$dbgroup})", 'yellow');

        $runner = Services::migrations();
        try {
            if (!$runner->force(ROOTPATH . $filePath, $namespace, $dbgroup)) {
                CLI::error('Migration execution failed.', 'red');
                return;
            }

            foreach ($runner->getCliMessages() as $msg) {
                CLI::write($msg);
            }
            CLI::write('✅ Migration completed successfully.', 'green');
        } catch (\Throwable $e) {
            CLI::error("Error: {$e->getMessage()}", 'red');
        }
    }
}
? 注意:确保迁移文件路径使用正斜杠 /(Windows 也兼容),且必须包含 .php 扩展名;路径以 ROOTPATH 为根,如 app/Database/Migrations/...,而非 APP_PATH 或 WRITEPATH。

? 使用示例

执行单个迁移(默认 App 命名空间 + default 数据库):

php spark migrate:file "app/Database/Migrations/2023-05-10-120000_AddSalesDiscounts.php"

指定命名空间(如模块化结构 Modules\Sales)和数据库组:

无涯·问知
无涯·问知

无涯·问知,是一款基于星环大模型底座,结合个人知识库、企业知识库、法律法规、财经等多种知识源的企业级垂直领域问答产品

下载
php spark migrate:file "Modules/Sales/Database/Migrations/2023-05-10-120000_AddSalesDiscounts.php" \
  --namespace "Modules\Sales" \
  --dbgroup "sales_db"

查看帮助文档:

php spark help migrate:file

? 模块化批量执行(进阶用法)

回到你原始需求——按模块键(如 $files['sales'])批量运行多个迁移,可在控制器或服务中封装逻辑:

// 在任意服务类中
public function runModuleMigrations(string $module): bool
{
    $files = [
        'blog'    => ['app/Database/Migrations/2023-01-01-000000_CreatePostsTable.php'],
        'sales'   => [
            'app/Database/Migrations/2023-05-10-120000_AddSalesDiscounts.php',
            'app/Database/Migrations/2023-05-11-143000_AddOrderStatuses.php'
        ],
        'storage' => ['app/Database/Migrations/2023-02-20-090000_CreateFilesTable.php']
    ];

    $migrationRunner = \Config\Services::migrations();

    foreach ($files[$module] ?? [] as $path) {
        if (!$migrationRunner->force(ROOTPATH . $path, 'App')) {
            log_message('error', "Failed to run migration: {$path}");
            return false;
        }
    }

    return true;
}

⚠️ 重要提醒

  • force() 不校验迁移顺序或已执行状态,请确保手动维护执行顺序(如按时间戳升序);
  • 生产环境慎用,建议仅用于开发/部署脚本,避免破坏迁移历史一致性;
  • 若需幂等性与状态追踪,仍应优先使用标准 spark migrate --all 流程,将模块迁移纳入统一版本序列。

通过该方案,你不仅解决了“运行单个迁移”的技术瓶颈,更获得了面向模块的灵活迁移调度能力——让 CI4 的数据库演进真正匹配现代分层架构的演进节奏。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2679

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1660

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1517

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1419

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1235

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1488

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

12

2026.01.19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.9万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 8.3万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号