gwind55 / migration-generator

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

v3.0.1 2020-09-27 07:03 UTC

This package is auto-updated.

Last update: 2024-09-12 04:20:57 UTC


README

目的

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

如何使用

  • composer require jaguarjack/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';
    }
  • 注入
(new MigrateGenerator('thinkphp'))
->registerNewType([
          'TypeName' => TypeClass,
    ]);

新增类型解析

即对应框架迁移的格式

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

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

  • 必须实现的两个方法

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

    public function laravelMigrationColumn():string

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

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

其他

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

$migrateGenerat->getDatabase

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

$migrateGenerator->getMigrationContent

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