odan/phinx-migrations-generator

Phinx 迁移生成器


README

通过比较您的当前数据库与架构信息来生成 Phinx 迁移。

Latest Version on Packagist Software License Build Status Code Coverage Quality Score Total Downloads

需求

  • PHP 8.1, 8.2

特性

  • 框架无关性
  • 数据库管理系统:MySQL 5.7+, MySQL 8, MariaDB(部分支持)
  • 初始架构
  • 架构差异
  • 数据库:字符集,校对规则
  • 表:创建、更新、删除、引擎、注释、字符集、校对规则
  • 列:创建、更新、删除
  • 索引:创建、删除
  • 外键:创建、删除、约束名称

安装

通过 Composer

composer require odan/phinx-migrations-generator --dev

用法

生成迁移

第一次运行生成初始架构和一个迁移类。文件 schema.php 包含了之前的数据库架构,并与当前架构进行比较。基于差异,生成一个 Phinx 迁移类。

vendor/bin/phinx-migrations generate

当再次执行 generate 命令时,仅生成与最后架构的差异。

参数

运行迁移

Phinx 迁移命令 运行所有可用的迁移。

vendor/bin/phinx migrate

配置

phinx-migrations-generator 使用 phinx 的配置。

迁移配置

示例配置

文件名:phinx.php(位于项目根目录中)

<?php

// Framework bootstrap code here
require_once __DIR__ . '/config/bootstrap.php';

// Get PDO object
$pdo = new PDO(
    'mysql:host=127.0.0.1;dbname=test;charset=utf8mb4', 'root', '',
    array(
        PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
        PDO::ATTR_PERSISTENT => false,
        PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8mb4 COLLATE utf8mb4_unicode_ci',
    )
);

return [
    'paths' => [
        'migrations' => __DIR__ . '/../resources/migrations',
    ],
    'schema_file' => __DIR__ . '/../resources/schema/schema.php',
    'foreign_keys' => false,
    'default_migration_prefix' => '',
    'mark_generated_migration' => true,
    'environments' => [
        'default_environment' => 'local',
        'local' => [
            // Database name
            'name' => $pdo->query('select database()')->fetchColumn(),
            'connection' => $pdo,
        ]
    ]
];

测试

composer test

贡献

请参阅 CONTRIBUTINGCODE_OF_CONDUCT 获取详细信息。

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件