ty-team / migration-generator
当你从未使用过它时,生成迁移文件
dev-master
2022-08-07 15:09 UTC
Requires
- php: >=7.1
- doctrine/dbal: ^3.0
This package is auto-updated.
Last update: 2024-09-07 20:07:51 UTC
README
如果你还未使用或者正想使用数据库迁移功能,但又不想自己编写迁移文件,这个工具可以很好地帮助你实现文件迁移,目前提供了 Laravel5.5+ 和 Thinkphp6+ 的迁移文件生成。
支持 php>=8.0 由于 jaguarjack/migration-generator 不支持 PHP8,所以创建了本项目
更新日志
- 修复DateTime大小写问题
- 增加SimpleArrayType 修复Set类型导致异常问题
安装
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'; }
- 注入
$generator = new MigrateGenerator('thinkphp'); $generator->registerNewType([ 'TypeName' => TypeClass ]);
新增类型解析
对应框架 migration 的格式
- 继承实现
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;
这个方法可以获取解析后 migration 文件内容