Phinx 数据库迁移工具的安装和使用

作者: 萧格 | 来源:发表于2018-08-09 00:10 被阅读0次

简介

Phinx 可以让开发者简洁的修改和维护数据库。它避免了人为的手写 SQL 语句，它使用强大的 PHP API 去管理数据库迁移。开发者可以使用版本控制管理他们的数据库迁移。 Phinx 可以方便的进行不同数据库之间数据迁移。还可以追踪到哪些迁移脚本被执行，开发者可以不再担心数据库的状态从而更加关注如何编写出更好的系统。

下载安装

系统环境

官网 http://docs.phinx.org/en/latest
中文参考网站https://tsy12321.gitbooks.io/phinx-doc/
Phinx 可以使用 Composer 进行安装，Composer是一个PHP依赖管理工具。更多信息请访问 Composer 官网。

Phinx 至少需要PHP 5.4 或更新的版本

使用 Composer 进行安装 Phinx：

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar require robmorgan/phinx
$ php composer.phar install

此时会生成vendor 文件夹，说明安装完成。

在你项目目录/data/www/test/中创建目录 db/migrations ，并给予充足权限。这个目录将是你迁移脚本放置的地方，并且应该被设置为可写权限。
安装后，Phinx 现在可以在你的项目中执行初始化(注意
：此时的vendor文件在目录/data/www/test/下)
init 命令用来Phinx初始化整个项目的时候使用。命令会生成一个phinx.yml 文件在项目根目录

$ vendor/bin/phinx init

此时生成phinx.yml文件

$ vim phinx.yml
paths:
    migrations: 'test/db/migrations'
    seeds: 'test/db/seeds'

environments:
    default_migration_table: phinxlog
    default_database: development
    production:
        adapter: mysql
        host: localhost
        name: production_db
        user: root
        pass: ''
        port: 3306
        charset: utf8

    development:
        adapter: mysql
        host: localhost
        name: development_db
        user: root
        pass: ''
        port: 3306
        charset: utf8

    testing:
        adapter: mysql
        host: localhost
        name: testing_db
        user: root
        pass: ''
        port: 3306
        charset: utf8

version_order: creation

创建迁移脚本
create 命令用来创建迁移脚本文件。需要一个参数：脚本名。迁移脚本命名应该保持驼峰命名法

$ vendor/bin/phinx create MyNewMigrate
Phinx by CakePHP - https://phinx.org. 0.10.5

using config file ./phinx.yml
using config parser yaml
using migration paths
 - /data/www/test/test/db/migrations
using seed paths
using migration base class Phinx\Migration\AbstractMigration
using default template
created test/db/migrations/20180808155721_my_new_migrate.php

编辑脚本

$ vim test/db/migrations/20180808155721_my_new_migrate.php
<?php


use Phinx\Migration\AbstractMigration;

class MyNewMigrate extends AbstractMigration
{
    /**
     * Change Method.
     *
     * Write your reversible migrations using this method.
     *
     * More information on writing migrations is available here:
     * http://docs.phinx.org/en/latest/migrations.html#the-abstractmigration-class
     *
     * The following commands can be used in this method and Phinx will
     * automatically reverse them when rolling back:
     *
     *    createTable
     *    renameTable
     *    addColumn
     *    addCustomColumn
     *    renameColumn
     *    addIndex
     *    addForeignKey
     *
     * Any other destructive changes will result in an error when trying to
     * rollback the migration.
     *
     * Remember to call "create()" or "update()" and NOT "save()" when working
     * with the Table class.
     */
    public function change()
    {
        // create the table
        $table = $this->table('user_logins');
        $table->addColumn('user_id', 'integer')
              ->addColumn('created', 'datetime')
              ->create();
    }
}

执行脚本

$ vendor/bin/phinx migrate -e production
Phinx by CakePHP - https://phinx.org. 0.10.5

using config file ./phinx.yml
using config parser yaml
using migration paths
 - /data/www/test/test/db/migrations
using seed paths
using environment production
using adapter mysql
using database goods

 == 20180808155721 MyNewMigrate: migrating
 == 20180808155721 MyNewMigrate: migrated 0.0390s

All Done. Took 0.0468s

Migrate 命令默认运行执行所有脚本，可选指定环境
$ phinx migrate -e development
可以使用 --target 或者 -t 来指定执行某个迁移脚本
$ phinx migrate -e development -t 20180808155721

进入数据库查看，已经生成user_logins表,并且还生成phinxlog操作记录表。

mysql> show tables;
+--------------------+
| Tables_in_goods    |
+--------------------+
| phinxlog           |
| user_logins        |
+--------------------+

执行查询

可以使用 execute() 和 query() 方法进行查询。execute() 方法会返回查询条数，query() 方法会返回结果。

<?php

use Phinx\Migration\AbstractMigration;

class MyNewMigration extends AbstractMigration
{
    /**
     * Migrate Up.
     */
    public function up()
    {
        // execute()
        $count = $this->execute('DELETE FROM users'); // returns the number of affected rows

        // query()
        $rows = $this->query('SELECT * FROM users'); // returns the result as an array
    }

    /**
     * Migrate Down.
     */
    public function down()
    {

    }
}

Up 方法
up方法会在Phinx执行迁移命令时自动执行，并且该脚本之前并没有执行过。你应该将修改数据库的方法写在这个方法里。
Down 方法
down方法会在Phinx执行回滚命令时自动执行，并且该脚本之前已经执行过迁移。你应该将回滚代码放在这个方法里。

字段操作

字段类型

biginteger
binary
boolean
date
datetime
decimal
float
integer
string
text
time
timestamp
uuid

另外，MySQL adapter 支持 enum 、set 、blob 和 json （json 需要 MySQL 5.7 或者更高）
Postgres adapter 支持 smallint 、json 、jsonb 和 uuid （需要 PostgresSQL 9.3 或者更高）

字段选项

所有字段：

选项	描述
limit	为string设置最大长度
length	limit 的别名
default	设置默认值
null	允许空
after	指定字段放置在哪个字段后面
comment	字段注释

decimal 类型字段：

选项	描述
precision 和 scale	组合设置精度
scale和 precision	组合设置精度
signed	开启或关闭 unsigned 选项（仅适用于 MySQL）

enum 和 set 类型字段：

选项	描述
values	用逗号分隔代表值

-integer 和 biginteger 类型字段：

选项	描述
identity	开启或关闭自增长
signed	开启或关闭 unsigned 选项（仅适用于 MySQL）

timestamp 类型字段：

选项	描述
default	设置默认值（CURRENT_TIMESTAMP）
update	当数据更新时的触发动作（CURRENT_TIMESTAMP）
timezone	开启或关闭 with time zone 选项

boolean 类型字段：

选项	描述
signed	开启或关闭 unsigned 选项（仅适用于 MySQL）

string 和text 类型字段：

选项	描述
collation	设置字段的 collation （仅适用于 MySQL）
encoding	设置字段的 encoding （仅适用于 MySQL）

索引操作

使用 addIndex() 方法可以指定索引

Phinx 默认创建的是普通索引，我们可以通过添加 unique 参数来指定唯一值。也可以使用 name 参数来制定索引名。

public function up()
    {
        $table = $this->table('users');
        $table->addColumn('email', 'string')
              ->addIndex(array('email'), array('unique' => true, 'name' => 'idx_users_email'))
              ->save();
    }

调用 removeIndex() 方法可以删除索引。必须一条条删除

 public function up()
    {
        $table = $this->table('users');
        $table->removeIndex(array('email'));

        // alternatively, you can delete an index by its name, ie:
        $table->removeIndexByName('idx_users_email');
    }

数据库 Seeding

Phinx 0.5.0 支持数据库中使用seeding插入测试数据。Seed 类可以很方便的在数据库创建以后填充数据。这些文件默认放置在 seeds 目录（本文路径：test/db/seeds），路径可以在配置文件中修改

数据库 seeding 是可选的，Phinx 并没有默认创建 seeds 目录，所以要提前创建seed目录。

创建Seed类

Phinx 用下面命令创建一个新的 seed 类
$ php vendor/bin/phinx seed:create UserSeeder
如此会在目录test/db/seeds下生成UserSeeder.php文件。
编辑UserSeeder.php文件，插入测试数据。

<?php

use Phinx\Seed\AbstractSeed;

class UserSeeder extends AbstractSeed
{
    /**
     * Run Method.
     *
     * Write your database seeder using this method.
     *
     * More information on writing seeders is available here:
     * http://docs.phinx.org/en/latest/seeding.html
     */
    public function run()
    {
        $data = array(
            array(
                'name'    => 'foo',
                'created_at' => date('Y-m-d H:i:s'),
            ),
            array(
                'name'    => 'bar',
                'created_at' => date('Y-m-d H:i:s'),
            )
        );

        $posts = $this->table('test');
        $posts->insert($data)
              ->save();
    }
}

提交数据时必须调用 save() 方法。Phinx 将缓存数据直到你调用save
所有 Phinx Seed 都继承 AbstractSeed类。这个类提供了 Seed 需要的基础方法。Seed 类大部分用来插入测试数据。

Run 方法将在 Phinx 执行 seed:run 时被自动调用。你可以将测试数据的插入写在里面。

不像数据库迁移，Phinx 并不记录 seed 是否执行过。这意味着 seeders 可以被重复执行。

当然也可以在run方法中写原生Sql，如：

<?php

use Phinx\Seed\AbstractSeed;

class UserSeeder extends AbstractSeed
{
    /**
     * Run Method.
     *
     * Write your database seeder using this method.
     *
     * More information on writing seeders is available here:
     * http://docs.phinx.org/en/latest/seeding.html
     */
    public function run()
    {
        $sql = " insert into `test` set `name`='zhangsan', `created_at`='2018-08-15 23:00:00' ";
        $this-> execute($sql);
    }
}

执行 Seed

这很简单，当注入数据库时，只需要运行 seed:run 命令
$ php vendor/bin/phinx seed:run
默认Phinx会执行所有 seed。如果你想要指定执行一个，只要增加 -s 参数并接 seed 的名字
$ php vendor/bin/phinx seed:run -s UserSeeder
也可以一次性执行多个 seed
$ php vendor/bin/phinx seed:run -s UserSeeder -s PermissionSeeder -s LogSeeder
可以使用 -v 参数获取更多提示信息
$ php vendor/bin/phinx seed:run -v
Phinx seed 提供了一个很简单的机制方便开发者可重复的插入测试数据

清空数据表

可以用truncate来清空数据表

<?php

use Phinx\Seed\AbstractSeed;

class UserSeeder extends AbstractSeed
{
    /**
     * Run Method.
     *
     * Write your database seeder using this method.
     *
     * More information on writing seeders is available here:
     * http://docs.phinx.org/en/latest/seeding.html
     */
    public function run()
    {
        $posts = $this->table('test');
        $posts->truncate();
    }
}

命令

Rollback
Rollback 命令用来回滚之前的迁移脚本。与 Migrate 命令相反。
你可以使用 rollback 命令回滚上一个迁移脚本。不带任何参数
$ phinx rollback -e development
使用 --target 或者 -t 回滚指定版本迁移脚本
$ phinx rollback -e development -t 20120103083322
指定版本如果设置为0则回滚所有脚本
$ phinx rollback -e development -t 0
可以使用 --date 或者 -d 参数回滚指定日期的脚本

$ phinx rollback -e development -d 2012
$ phinx rollback -e development -d 201201
$ phinx rollback -e development -d 20120103
$ phinx rollback -e development -d 2012010312
$ phinx rollback -e development -d 201201031205
$ phinx rollback -e development -d 20120103120530

如果断点阻塞了回滚，你可以使用 --force 或者-f参数强制回滚
$ phinx rollback -e development -t 0 -f

Status 命令
Status 命令可以打印所有迁移脚本和他们的状态。你可以用这个命令来看哪些脚本被运行过了
$ phinx status -e development
当所有脚本都已经执行（up）该命令将退出并返回 0
1：至少有一个回滚过的脚本（down）
2：至少有一个未执行的脚本

具体还有更多phinx数据库迁移操作可以参考官网。

Phinx 数据库迁移工具的安装和使用

简介

下载安装

系统环境

执行查询

字段操作

字段类型

字段选项

索引操作

数据库 Seeding

创建Seed类

执行 Seed

清空数据表

命令

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读