thinkphp6/thinkphp-migration-generator

如果你从未使用过迁移文件生成器

dev-main 2021-12-02 07:03 UTC

This package is auto-updated.

Last update: 2024-09-29 06:25:45 UTC


README

如果你还未使用或者正想使用数据库迁移功能,但不想自己编写迁移文件的话,这个工具可以很好地帮助你实现文件迁移,目前提供了 Laravel5.5+ 和 Thinkphp6+ 的迁移文件生成。

源项目: https://github.com/JaguarJack/migration-generator
由于原本存在一些BUG,我fork了一个版本进行修复

更新日志

  • 修复DateTime大小写问题
  • 增加SimpleArrayType,修复Set类型导致的异常问题

安装

composer require thinkphp6/thinkphp-migration-generator:dev-main

平台支持

laravel

php artisan migration:generate

ThinkPHP

php think migration:generate

注意

包中提供的命令如果不能完全满足你的需求,那么你可以根据实际自定义需求。

定义新类型

  • 继承 \Doctrine\DBAL\Types\Type
class newType extend \Doctrine\DBAL\Types\Type{} 
  • 主要实现两个方法
public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
{
    return $platform->getIntegerTypeDeclarationSQL($fieldDeclaration);
}

public function getName()
{
    return 'TypeName';
}
  • 注入
$generator = new MigrateGenerator('thinkphp');
$generator->registerNewType([
    'TypeName' => TypeClass
]);

新增类型解析

对应框架迁移的格式

  • 继承实现
classType extend JaguarJack\MigrateGenerator\Migration\Columns\AbstractType
{}

继承这个基类可以获取两个信息 - 获取当前 column 的所有信息 - 整个表结构的原始信息,这里可以得到 DBAL 不会提供的信息

  • 必须实现的两个方法

因为现在支持了 Laravel 和 ThinkPHP,所以定义了这两个方法

    public function laravelMigrationColumn():string

    public function thinkphpMigrationColumn():string
  • 注入
$generator = new MigrateGenerator('thinkphp');
$generator->registerNewTypeParse([
    'TypeClassName' => ParseTypeClass
]);

TypeClassName 指的是新类型的类的名称,ParseTypeClass 也必须和 TypeClass 相同,这是约定,方便更好地解析。

其他

除了提供的自定义命令外,通过两个对外接口自己生成文件

$generator->getDatabase;

这个方法可以获取表信息以及字段信息等等

$generator->getMigrationContent;

这个方法可以获取解析后的迁移文件内容