0

0

CodeIgniter 4 中如何精准执行单个迁移文件(Migration)

霞舞

霞舞

发布时间:2026-01-19 19:21:03

|

957人浏览过

|

来源于php中文网

原创

CodeIgniter 4 中如何精准执行单个迁移文件(Migration)

codeigniter 4 原生不支持直接运行单个迁移文件,但可通过自定义 cli 命令调用 `migrationrunner::force()` 方法实现精准迁移控制,支持指定命名空间、数据库组及动态路径。

在 CodeIgniter 4 的数据库迁移体系中,php spark migrate 默认按时间戳顺序执行所有待迁移文件,而 php spark migrate -f 仅支持指定已注册的迁移类名(含完整命名空间),无法直接通过文件路径触发单次迁移。当项目采用模块化架构(如 blog、sales、storage 等独立模块),需按需激活某模块的特定迁移时,原生能力便显得力不从心。此时,最可靠、可复用的解决方案是:创建自定义 CLI 命令,封装 MigrationRunner::force() 调用逻辑

✅ 实现步骤详解

1. 生成命令骨架

在项目根目录执行:

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

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

Vinteo AI
Vinteo AI

利用人工智能在逼真的室内环境中创建产品可视化。无需设计师和产品照片拍摄

下载

2. 编写核心逻辑(关键改造)

将生成的文件替换为以下精简可靠的实现(已适配 CI4.4+,兼容命名空间与多数据库组):

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

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

        if (!isset($params[0])) {
            CLI::error('Error: Missing migration file path.');
            $this->showHelp();
            return;
        }

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

        if (!is_file($filePath)) {
            CLI::error("File not found: {$filePath}");
            return;
        }

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

            foreach ($runner->getCliMessages() as $msg) {
                CLI::write($msg);
            }
            CLI::write('✅ Migration completed successfully.', 'green');
        } catch (\Throwable $e) {
            CLI::error('Exception: ' . $e->getMessage());
        }
    }
}
? 关键说明:$runner->force($filePath, $namespace, $dbgroup) 是核心——它绕过版本检查,强制加载并执行指定 PHP 文件中的迁移类,完全满足“按需触发单文件”的诉求。

3. 使用示例

# 执行 App 命名空间下的迁移文件
php spark migrate:file "app/Database/Migrations/2023-05-10-120000_AddSalesOrderTable.php"

# 指定模块命名空间(如 Modules\Sales)
php spark migrate:file "Modules/Sales/Database/Migrations/2023-06-01-090000_UpdateInvoiceStatus.php" --namespace "Modules\Sales"

# 切换至测试数据库组
php spark migrate:file "app/Database/Migrations/2023-01-01-000000_TestDataSeeder.php" --dbgroup "tests"

4. 进阶:在代码中调用(如 Controller 或 Service)

// 在控制器中动态触发迁移
public function triggerSalesMigration()
{
    $output = command('migrate:file "app/Database/Migrations/2023-05-10-120000_AddSalesOrderTable.php"');
    log_message('info', 'Sales migration output: ' . $output);
    return $this->response->setJSON(['status' => 'done', 'output' => $output]);
}

⚠️ 注意事项与最佳实践

  • 路径必须准确:$params[0] 是相对于 ROOTPATH 的路径,不要包含 ROOTPATH 前缀(命令内部已自动拼接)。
  • 命名空间需匹配:确保迁移文件顶部 namespace 声明与 --namespace 参数一致,否则类无法被正确反射加载。
  • 幂等性保障:force() 不检查是否已执行,重复运行可能引发 SQL 错误(如重复建表)。建议在业务逻辑中自行校验 migration_version 表或添加 if (! $this->db->tableExists(...)) 防御。
  • 生产环境慎用:单文件迁移适合开发/部署调试,正式环境推荐使用标准 migrate 流程保证版本一致性。
  • 错误处理:示例中已包含基础异常捕获,实际项目中可扩展日志记录(如写入 writable/logs/)便于追踪。

通过该方案,你不仅能解决模块化迁移的精准调度问题,更可将其封装为团队标准工具——让 php spark migrate:file 成为 CI4 项目中与 migrate 并行的可靠迁移双引擎。

相关专题

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

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

2683

2023.09.01

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

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

1660

2023.10.11

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

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

1518

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.4万人学习

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

共13课时 | 0.9万人学习

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

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