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。

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

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

<?php

namespace App\Commands;

use CodeIgniter\CLI\BaseCommand;
use CodeIgniter\CLI\CLI;
use Config\Services;

class MigrateFileCommand extends BaseCommand
{
    protected $group       = 'Database';
    protected $name        = 'migrate:file';
    protected $description = 'Run a single migration file by path.';
    protected $usage       = 'migrate:file [path] [options]';
    protected $arguments   = [
        'path' => '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 并行的可靠迁移双引擎。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

1110

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

380

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2069

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

379

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1602

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

585

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

439

2024.04.29

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

23

2026.03.06

热门下载

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

精品课程

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

共137课时 | 13.1万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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