0

0

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

霞舞

霞舞

发布时间:2026-01-19 19:57:01

|

424人浏览过

|

来源于php中文网

原创

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

codeigniter 4 原生不支持直接运行单个迁移文件,但可通过自定义 cli 命令调用 `migrationrunner::force()` 方法实现精准控制,适用于模块化项目中按需执行特定迁移(如仅运行 sales 模块的迁移)。

在模块化 CodeIgniter 4 项目中,常需按业务域(如 blog、storage、sales)组织迁移文件,并在部署或调试时仅执行某一个迁移类(而非全部或按时间戳顺序批量执行)。遗憾的是,CI4 官方 spark migrate 命令仅支持指定命名空间、数据库组或回滚到某版本,不提供“运行指定文件”的内置能力。但系统底层的 MigrationRunner 类已暴露 force($file, $namespace, $dbgroup) 方法,这正是我们实现目标的关键。

✅ 解决方案:创建自定义命令 migrate:file

我们通过扩展 CI4 的 CLI 系统,构建一个轻量、安全、可复用的命令,用于精准触发任意迁移文件:

步骤 1:生成命令骨架

在项目根目录运行:

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

该命令将在 app/Commands/MigrateFileCommand.php 创建基础类。

VIVA
VIVA

一个免费的AI创意视觉设计平台

下载

步骤 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 $usage       = 'migrate:file [filepath] [options]';
    protected $arguments   = [
        'filepath' => 'Full path to migration file relative to ROOTPATH (e.g. "app/Database/Migrations/2023-01-01-000000_CreateSalesTable.php")'
    ];
    protected $options     = [
        '--namespace' => 'Migration namespace (default: "App")',
        '--dbgroup'   => 'Database group (default: "default")',
    ];

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

        $runner    = Services::migrations();
        $namespace = CLI::getOption('namespace') ?: 'App';
        $dbgroup   = CLI::getOption('dbgroup') ?: 'default';

        try {
            // ✅ 核心:force 执行单个文件(自动解析类名、校验、执行 up())
            if (!$runner->force(ROOTPATH . $params[0], $namespace, $dbgroup)) {
                CLI::error(lang('Migrations.generalFault'));
                return;
            }

            foreach ($runner->getCliMessages() as $msg) {
                CLI::write($msg);
            }
            CLI::success('Migration completed successfully.');
        } catch (\Throwable $e) {
            $this->showError($e);
        }
    }
}
? 原理说明:$runner->force() 会加载指定 PHP 文件,提取其中的 Migration 类(要求符合命名规范),验证其 up() 方法存在且未被执行过(基于 migrations 表记录),然后执行并写入迁移日志 —— 完全复用 CI4 原生迁移机制,安全可靠。

步骤 3:使用示例

  • 执行默认命名空间下的迁移:

    php spark migrate:file "app/Database/Migrations/2023-05-10-120000_AddSalesOrderStatus.php"
  • 指定模块命名空间与测试数据库:

    php spark migrate:file "Modules/Sales/Database/Migrations/2023-05-10-120000_AddSalesOrderStatus.php" \
      --namespace "Modules\Sales" \
      --dbgroup "testing"
  • 在控制器或服务中动态调用(适合自动化场景):

    // 在 Controller 或 Service 中
    $output = command('migrate:file "app/Database/Migrations/2023-05-10-120000_AddSalesOrderStatus.php"');
    log_message('info', 'Sales migration result: ' . $output);

⚠️ 注意事项与最佳实践

  • 路径必须准确:$params[0] 是相对于 ROOTPATH 的路径(非绝对路径),且需包含 .php 后缀;
  • 命名空间一致性:确保迁移文件中的类命名空间与 --namespace 参数严格匹配(含反斜杠转义);
  • 幂等性保障:force() 会检查 migrations 表,若该迁移已记录为成功,则跳过执行,避免重复操作;
  • 错误处理:命令已内置异常捕获与 CLI 友好提示,生产环境建议配合日志记录;
  • 模块化扩展:可进一步封装 runAll($moduleKey) 辅助函数,遍历 $files['sales'] 数组逐个调用 migrate:file,实现您原始需求。

通过此方案,你不仅解决了“单文件迁移”问题,更获得了一个可维护、可复用、符合 CI4 设计哲学的模块化迁移管理能力。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
常用的数据库软件
常用的数据库软件

常用的数据库软件有MySQL、Oracle、SQL Server、PostgreSQL、MongoDB、Redis、Cassandra、Hadoop、Spark和Amazon DynamoDB。更多关于数据库软件的内容详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1006

2023.11.02

数据库三范式
数据库三范式

数据库三范式是一种设计规范,用于规范化关系型数据库中的数据结构,它通过消除冗余数据、提高数据库性能和数据一致性,提供了一种有效的数据库设计方法。本专题提供数据库三范式相关的文章、下载和课程。

385

2023.06.29

如何删除数据库
如何删除数据库

删除数据库是指在MySQL中完全移除一个数据库及其所包含的所有数据和结构,作用包括:1、释放存储空间;2、确保数据的安全性;3、提高数据库的整体性能,加速查询和操作的执行速度。尽管删除数据库具有一些好处,但在执行任何删除操作之前,务必谨慎操作,并备份重要的数据。删除数据库将永久性地删除所有相关数据和结构,无法回滚。

2111

2023.08.14

vb怎么连接数据库
vb怎么连接数据库

在VB中,连接数据库通常使用ADO(ActiveX 数据对象)或 DAO(Data Access Objects)这两个技术来实现:1、引入ADO库;2、创建ADO连接对象;3、配置连接字符串;4、打开连接;5、执行SQL语句;6、处理查询结果;7、关闭连接即可。

357

2023.08.31

MySQL恢复数据库
MySQL恢复数据库

MySQL恢复数据库的方法有使用物理备份恢复、使用逻辑备份恢复、使用二进制日志恢复和使用数据库复制进行恢复等。本专题为大家提供MySQL数据库相关的文章、下载、课程内容,供大家免费下载体验。

259

2023.09.05

vb中怎么连接access数据库
vb中怎么连接access数据库

vb中连接access数据库的步骤包括引用必要的命名空间、创建连接字符串、创建连接对象、打开连接、执行SQL语句和关闭连接。本专题为大家提供连接access数据库相关的文章、下载、课程内容,供大家免费下载体验。

329

2023.10.09

数据库对象名无效怎么解决
数据库对象名无效怎么解决

数据库对象名无效解决办法:1、检查使用的对象名是否正确,确保没有拼写错误;2、检查数据库中是否已存在具有相同名称的对象,如果是,请更改对象名为一个不同的名称,然后重新创建;3、确保在连接数据库时使用了正确的用户名、密码和数据库名称;4、尝试重启数据库服务,然后再次尝试创建或使用对象;5、尝试更新驱动程序,然后再次尝试创建或使用对象。

420

2023.10.16

vb连接access数据库的方法
vb连接access数据库的方法

vb连接access数据库方法:1、使用ADO连接,首先导入System.Data.OleDb模块,然后定义一个连接字符串,接着创建一个OleDbConnection对象并使用Open() 方法打开连接;2、使用DAO连接,首先导入 Microsoft.Jet.OLEDB模块,然后定义一个连接字符串,接着创建一个JetConnection对象并使用Open()方法打开连接即可。

477

2023.10.16

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

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

3

2026.03.11

热门下载

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

精品课程

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

共137课时 | 13.3万人学习

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号