weifashi/think-migration-generator

如果你从未使用过它,则会生成迁移文件

dev-master 2023-07-29 08:42 UTC

This package is not auto-updated.

Last update: 2024-09-22 12:05:34 UTC


README

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

安装

composer require composer require weifashi/think-migration-generator:dev-master

平台支持

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;

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