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。替换其内容为以下精简可靠的实现:

<?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 explicitly.';
    protected $usage       = 'migrate:file <file-path> [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 数据库):

百宝箱
百宝箱

百宝箱是支付宝推出的一站式AI原生应用开发平台,无需任何代码基础,只需三步即可完成AI应用的创建与发布。

下载
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 的数据库演进真正匹配现代分层架构的演进节奏。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
default gateway怎么配置
default gateway怎么配置

配置default gateway的步骤:1、了解网络环境;2、获取路由器IP地址;3、登录路由器管理界面;4、找到并配置WAN口设置;5、配置默认网关;6、保存设置并退出;7、检查网络连接是否正常。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

236

2023.12.07

windows查看端口占用情况
windows查看端口占用情况

Windows端口可以认为是计算机与外界通讯交流的出入口。逻辑意义上的端口一般是指TCP/IP协议中的端口,端口号的范围从0到65535,比如用于浏览网页服务的80端口,用于FTP服务的21端口等等。怎么查看windows端口占用情况呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1496

2023.07.26

查看端口占用情况windows
查看端口占用情况windows

端口占用是指与端口关联的软件占用端口而使得其他应用程序无法使用这些端口,端口占用问题是计算机系统编程领域的一个常见问题,端口占用的根本原因可能是操作系统的一些错误,服务器也可能会出现端口占用问题。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1170

2023.07.27

windows照片无法显示
windows照片无法显示

当我们尝试打开一张图片时,可能会出现一个错误提示,提示说"Windows照片查看器无法显示此图片,因为计算机上的可用内存不足",本专题为大家提供windows照片无法显示相关的文章,帮助大家解决该问题。

835

2023.08.01

windows查看端口被占用的情况
windows查看端口被占用的情况

windows查看端口被占用的情况的方法:1、使用Windows自带的资源监视器;2、使用命令提示符查看端口信息;3、使用任务管理器查看占用端口的进程。本专题为大家提供windows查看端口被占用的情况的相关的文章、下载、课程内容,供大家免费下载体验。

463

2023.08.02

windows无法访问共享电脑
windows无法访问共享电脑

在现代社会中,共享电脑是办公室和家庭的重要组成部分。然而,有时我们可能会遇到Windows无法访问共享电脑的问题。这个问题可能会导致数据无法共享,影响工作和生活的正常进行。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2362

2023.08.08

windows自动更新
windows自动更新

Windows操作系统的自动更新功能可以确保系统及时获取最新的补丁和安全更新,以提高系统的稳定性和安全性。然而,有时候我们可能希望暂时或永久地关闭Windows的自动更新功能。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

874

2023.08.10

windows boot manager
windows boot manager

windows boot manager无法开机的解决方法:1、系统文件损坏,使用Windows安装光盘或USB启动盘进入恢复环境,选择修复计算机,然后选择自动修复;2、引导顺序错误,进入恢复环境,选择命令提示符,输入命令"bootrec /fixboot"和"bootrec /fixmbr",然后重新启动计算机;3、硬件问题,使用硬盘检测工具进行扫描和修复;4、重装操作系统。本专题还提供其他解决

1976

2023.08.28

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共137课时 | 13.4万人学习

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号