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。

PNG Maker
PNG Maker

利用 PNG Maker AI 将文本转换为 PNG 图像。

下载

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

<?php

namespace App\Commands;

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

class MigrateFileCommand extends BaseCommand
{
    protected $name        = 'migrate:file';
    protected $description = 'Migrates a single migration file.';
    protected $arguments   = [
        'name' => '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 不内置模块分组执行,但借助上述命令,你可在控制器、服务类或脚本中程序化调用

// 在任意业务逻辑中(如模块安装钩子)
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 项目既能享受迁移框架的稳定性,又不失模块化开发所需的精准控制力。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

788

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

26

2025.12.06

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

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

1411

2023.07.26

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

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

1161

2023.07.27

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

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

833

2023.08.01

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

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

461

2023.08.02

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

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

2361

2023.08.08

windows自动更新
windows自动更新

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

874

2023.08.10

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

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

1

2026.03.06

热门下载

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

精品课程

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

共137课时 | 13万人学习

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号