0

0

CodeIgniter 4 中如何精准执行单个迁移文件(含模块化批量调用方案)

聖光之護

聖光之護

发布时间:2026-01-19 17:56:36

|

881人浏览过

|

来源于php中文网

原创

CodeIgniter 4 中如何精准执行单个迁移文件(含模块化批量调用方案)

codeigniter 4 原生不支持直接运行单个迁移文件,但可通过自定义 cli 命令(基于 `migrationrunner::force()`)实现精确控制;结合数组分组策略,还可轻松扩展为按模块(如 blog、sales)批量执行指定迁移。

在 CodeIgniter 4 的数据库迁移体系中,php spark migrate 默认按时间戳顺序执行所有待迁移文件,而 php spark migrate -f 仅支持指定类名(需完整命名空间),无法直接通过文件路径或模块标识触发单个或一组迁移。面对模块化项目(如 blog、storage、sales 各自独立维护迁移脚本),这种限制会显著降低开发与部署灵活性。幸运的是,CI4 提供了高度可扩展的 CLI 命令机制和底层迁移 API,让我们能自主构建精准迁移能力。

✅ 核心方案:自定义 migrate:file 命令

我们通过创建一个专用 CLI 命令,封装 MigrationRunner::force() 方法,实现「按文件路径一键执行」:

步骤 1:生成命令骨架

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

该命令将在 app/Commands/ 下生成 MigrateFileCommand.php。

步骤 2:实现核心逻辑(精简关键部分)

 'Migration file path relative to ROOTPATH. E.g.: "app/Database/Migrations/2022-02-16-101819_AddBlogMigration.php"'
    ];
    protected $options     = [
        '--namespace' => 'Set migration namespace. Default: "App".',
        '--dbgroup'   => 'Set database group. Default: "default".',
    ];

    public function run(array $params)
    {
        CLI::write('Running migration...', 'yellow');

        if (count($params) !== 1) {
            CLI::error('Invalid arguments: exactly one file path is required.', 'red');
            $this->showHelp();
            return;
        }

        $runner    = Services::migrations();
        $namespace = CLI::getOption('namespace') ?: 'App';
        $dbgroup   = CLI::getOption('dbgroup') ?: 'default';
        $filePath  = ROOTPATH . $params[0];

        try {
            if (!$runner->force($filePath, $namespace, $dbgroup)) {
                CLI::error(lang('Migrations.generalFault'), 'red');
                return;
            }

            foreach ($runner->getCliMessages() as $msg) {
                CLI::write($msg);
            }
            CLI::write('Done migration.', 'green');
        } catch (\Throwable $e) {
            $this->showError($e);
        }
    }
}
? 关键点:$runner->force($filePath, $namespace, $dbgroup) 是底层核心——它绕过版本检查,强制加载并执行指定 PHP 文件中的迁移类,完全跳过时间戳排序逻辑。

步骤 3:使用示例

# 执行 App 命名空间下的单个迁移
php spark migrate:file "app/Database/Migrations/2022-02-16-101819_AddBlogMigration.php"

# 指定非默认命名空间与数据库组(如模块化销售系统)
php spark migrate:file "Modules/Sales/Database/Migrations/2023-05-01-090000_CreateOrdersTable.php" \
  --namespace "Modules\Sales" \
  --dbgroup "sales_db"

? 进阶:按模块批量执行迁移(runAll($files['sales']))

虽然 CI4 不内置模块分组执行,但借助上述命令,你可在控制器、服务类或脚本中程序化调用

百度MCP广场
百度MCP广场

探索海量可用的MCP Servers

下载
// 在任意业务逻辑中(如模块安装钩子)
public function runModuleMigrations(string $module): void
{
    $migrations = [
        'blog'    => ['app/Database/Migrations/2022-02-16-101819_AddBlogMigration.php'],
        'sales'   => [
            'Modules/Sales/Database/Migrations/2023-05-01-090000_CreateOrdersTable.php',
            'Modules/Sales/Database/Migrations/2023-05-02-103000_AddOrderStatus.php'
        ],
        'storage' => ['app/Database/Migrations/2022-11-10-142000_CreateStorageBuckets.php']
    ];

    if (!isset($migrations[$module])) {
        throw new \InvalidArgumentException("Unknown module: {$module}");
    }

    foreach ($migrations[$module] as $file) {
        $output = command("migrate:file \"{$file}\" --namespace \"App\" --dbgroup \"default\"");
        if (strpos($output, 'Done migration.') === false) {
            log_message('error', "Migration failed: {$file}");
            throw new \RuntimeException("Failed to migrate {$file}");
        }
    }

    log_message('info', "Successfully migrated module: {$module}");
}

⚠️ 注意事项:

  • command() 函数会捕获 CLI 输出,适合后台调度;若需实时日志,建议改用 exec() 或重定向输出流。
  • 确保迁移文件路径从 ROOTPATH 开始书写,且使用正斜杠 /(Windows 兼容)。
  • force() 不校验已执行状态,重复执行可能导致数据异常,请确保幂等性或手动管理 migrations 表记录。

✅ 总结

  • 原生无解 → 自定义命令破局:CI4 官方未提供单文件迁移指令,但 MigrationRunner::force() 为开发者留出了强大扩展入口。
  • 灵活可控:支持任意命名空间、数据库组、绝对/相对路径,完美适配模块化架构。
  • 可编程集成:通过 command() 在代码中驱动,轻松实现模块级迁移编排(如 runAll($files['sales']))。
  • ⚠️ 安全提醒:force() 跳过版本锁,务必确保迁移类逻辑幂等,或配合自定义状态表做二次校验。

从此,你的 CI4 项目既能享受迁移框架的稳定性,又不失模块化开发所需的精准控制力。

相关专题

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

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

2684

2023.09.01

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

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

1661

2023.10.11

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

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

1521

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使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

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号