magein/migration

基于phinx重新封装的面向对象形式的数据库迁移类

v4.0.1 2025-09-26 06:44 UTC

Requires

• php: ^8.0
• magein/utils: ^4.0

MIT

• magein

README

简介

基于phinx:0.14.0数据库迁移工具

composer.json不依赖phinx:0.14.0,而是将phinx跟其依赖的包提取到phinx目录下,只保留了基础的功能

gitee | composer

空间类型字段mysql版本最好是>=5.7

修改

1. 可以链式调用
2. 优化了命令行的参数位置(一些命令不在局限于位置)
3. 可以省略migrate参数,支持小写,下划线的方式创建

安装

composer require magein/migration

配置文件

只保留了.php的解析, .yml格式删除

根目录生成phinx.php

return \magein\migration\PhinxConfig::config(
    [
        'environments' => [
            'default_migration_table' => 'phinx_log',
            'default_environment' => 'development',
            'production' => [
                'adapter' => 'mysql',
                'host' => 'localhost',
                'name' => 'production_db',
                'user' => 'root',
                'pass' => '',
                'port' => 3306,
                'charset' => 'utf8mb4',
                'collation' => 'utf8mb4_unicode_ci',
            ],
            'development' => [
                'adapter' => 'mysql',
                'host' => '127.0.0.1',
                'name' => 'hyt',
                'user' => 'root',
                'pass' => '',
                'port' => 3306,
                'charset' => 'utf8',
            ],
            'testing' => [
                'adapter' => 'sqlite',
                'name' => './tests/_data/database',
                'memory' => false
            ]
        ],
    ]
);

phinx

这里是phinx默认的命令(可参考官网的命令)

php phinx create CreateUserTable
php phinx migrate
php phinx -e migrate
php phinx rollback
php phinx seed:create
php phinx seed:run

调用

在根目录生成migrate

include('vendor/autoload.php');

$input = new \magein\migration\PhinxInput();
$app = new \Phinx\Console\PhinxApplication();
$app->run($input);

// 创建表
php migrate user
// 新增字段 --column 可选
php migrate user_append_xx --column xx,xx,xxx
// 移除字段 --column 可选
php migrate user_remove --column xx,xx,xxx
// user表重新命名
php migrate user_rename
// 更新字段
php migrate user_update

表字段

protected $name = 'user';

public function change()
{
    $builder = $this->builder('表描述');
    $builder->id();
    $builder->string('username', '登录账号', 30)->length(64)->unique();
    $builder->char('password', '登录账号', 32);
    $builder->integerTiny('from', '来源 1 注册 2 小程序')->default(1);
    $builder->integerSmall('age', '年龄')->nullable();
    $builder->integer('integral', '积分')->default();
    $builder->date('birthday', '生日')->nullable();
    $builder->dateTime('last_login_time', '最后一次登录时间')->nullable();
    $builder->time('notify')->comment('通知时间')->nullable();
    
    // 更新字段
    $builder->change();

    $builder->innoDB();
    $this->create($builder, false);
}

执行

run migrate create

php migrate run
php migrate migrate
php migrate user run
php migrate run  user
php migrate rollback user
php migrate user rollback 

当命令行包含run/migrate/rollback的时候将执行命令,不在区分顺序

内置字段

常规字段

$builder = $this->builder('');
$builder->id();

// 用户
$builder->user->username();
$builder->user->password();
$builder->user->name();
$builder->user->nickname();
$builder->user->money();
$builder->user->balance();
$builder->user->phone();
$builder->user->email();
$builder->user->gender();
$builder->user->age();
$builder->user->birthday();
// 民族
$builder->user->ethnic();
// 籍贯
$builder->user->nativePlace();
// 用户可积累、兑换的积分系统
$builder->user->points();
// 分数或得分
$builder->user->score();
// 证件类型  身份证 港澳通行证  台胞证等
$builder->user->idType();
// 证件号码
$builder->user->idNumber();

// 常规
$builder->gen->type();
$builder->gen->title();
$builder->gen->conent();
$builder->gen->remark();
$builder->gen->sort();
$builder->gen->beginTime();
$builder->gen->startTime();
$builder->gen->endTime();
$builder->gen->status();

// 地址
$builder->addr->address();
$builder->addr->province();
$builder->addr->city();
$builder->addr->area();
$builder->addr->district();
$builder->addr->street();
$builder->addr->postcode();
$builder->addr->location();
$builder->addr->lng();
$builder->addr->lat();

组合字段

// 分类
$builder->comb->category();
// 文章
$builder->comb->article();
// 轮播图
$builder->comb->carousel();
// 银行
$builder->comb->bank();
// 订单
$builder->comb->order();
// 支付订单
$builder->comb->payOrder();
// 发表
$builder->comb->voice();
// 用户字段合集
$builder->comb->user();
// 企业
$builder->comb->business();
// 行业
$builder->comb->industry();
// 优惠劵规则
$builder->comb->couponRule();
// 附件,文件等字段合集
$builder->comb->file();
// 同时添加状态和排序
$builder->comb->statusSort();
// 同时添加开始和结束时间
$builder->comb->datetime();
// 行政区划
$builder->comb->region();
// 省市区
$builder->comb->zone();
// 省市区地址
$builder->comb->zoneAddress();
// 追加一个备注
$builder->gen->regionAddress()->remark();