Phinx是PHP数据库迁移工具，通过Composer安装并生成配置文件，支持多环境管理；创建迁移文件定义up/down方法，执行migrate命令更新数据库结构；可在PHP代码中调用API自动化运行迁移，适用于CI/CD流程；常用命令包括创建、执行、回滚迁移及管理种子数据，实现数据库版本的可追踪与协作。
在现代PHP开发中，数据库结构的版本管理变得越来越重要。特别是在团队协作或持续集成环境中，手动维护数据库变更容易出错。Phinx 是一个流行的PHP数据库迁移工具，它可以帮助你通过代码来管理数据库结构的变化。下面介绍如何在PHP项目中调用并使用 Phinx 来管理数据库版本。
安装与配置 Phinx
Phinx 可以通过 Composer 安装，这是最推荐的方式：
- composer require robmorgan/phinx
安装完成后，执行以下命令生成配置文件：
- vendor/bin/phinx init
这会生成一个 phinx.php 文件，你可以在此配置多个数据库环境，例如开发、测试和生产：
立即学习“PHP免费学习笔记（深入）”；
return [
'paths' => [
'migrations' => '%%PHINX_CONFIG_DIR%%/migrations',
],
'environments' => [
'default_database' => 'development',
'development' => [
'adapter' => 'mysql',
'host' => 'localhost',
'name' => 'myapp_dev',
'user' => 'root',
'pass' => '',
'port' => 3306,
'charset' => 'utf8mb4',
],
'production' => [
'adapter' => 'mysql',
'host' => 'prod-db.example.com',
'name' => 'myapp_prod',
'user' => 'prod_user',
'pass' => 'secure_password',
'port' => 3306,
'charset' => 'utf8mb4',
]
]
];
创建和运行迁移
使用 Phinx 创建一个新的迁移文件：
- vendor/bin/phinx create CreateUsersTable
这个命令会在 migrations 目录下生成一个带时间戳的PHP类文件。你可以在其中定义 up() 和 down() 方法：
final class CreateUsersTable extends AbstractMigration
{
public function up(): void
{
$table = $this->table('users');
$table->addColumn('username', 'string', ['limit' => 50])
->addColumn('email', 'string', ['limit' => 100])
->addColumn('created_at', 'datetime')
->create();
}
public function down(): void
{
$this->table('users')->drop();
}
}
执行迁移：
- vendor/bin/phinx migrate
默认作用于 development 环境，若要指定环境：
- vendor/bin/phinx migrate -e production
在PHP代码中调用Phinx API（可选）
虽然Phinx主要通过命令行使用，但你也可以在自己的PHP脚本中调用其API进行自动化操作。例如，在部署脚本中自动运行迁移：
require_once 'vendor/autoload.php';
use Phinx\Config\Config;
use Phinx\Migration\Manager;
$configArray = include 'phinx.php';
$config = Config::fromArray($configArray);
$manager = new Manager($config, $_SERVER);
// 运行所有待执行的迁移
$manager->migrate('development');
echo "数据库已更新到最新版本。\n";
这样可以在CI/CD流程或自定义管理命令中集成数据库更新逻辑。
常用命令汇总
- phinx create MigrationName — 创建新迁移
- phinx migrate -e env — 执行迁移
- phinx rollback -e env — 回滚上一次迁移
- phinx status -e env — 查看迁移状态
- phinx seed:create UserSeeder — 创建种子数据文件
- phinx seed:run -e env — 插入初始数据
基本上就这些。Phinx 让数据库变更变得可追踪、可重复、可协作。只要坚持每次结构变动都写迁移，就能轻松管理项目生命周期中的数据库演进。
