PHPackages                             valterfc/php-database-migration - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. valterfc/php-database-migration

ActiveLibrary[Database & ORM](/categories/database)

valterfc/php-database-migration
===============================

rake and mybatis SQL migration tool

v3.7.6(7y ago)016MITPHPPHP >=5.3.0

Since Aug 21Pushed 7y ago1 watchersCompare

[ Source](https://github.com/valterfc/php-database-migration)[ Packagist](https://packagist.org/packages/valterfc/php-database-migration)[ Docs](https://github.com/valterfc/php-database-migration)[ RSS](/packages/valterfc-php-database-migration/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (7)Versions (6)Used By (0)

PhpDbMigration - full PHP database migration tool
=================================================

[](#phpdbmigration---full-php-database-migration-tool)

This is a full standalone PHP tool based on [Symfony Console](http://symfony.com/doc/current/components/console)and inspired by the Rails database migration tool and MyBatis. It merges the functionality of the two tools and has been designed to be as flexible as possible.

Usage
-----

[](#usage)

```
$ ./bin/migrate
Console Tool

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  help            Displays help for a command
  list            Lists commands
 migrate
  migrate:addenv  Initialise an environment to work with php db migrate
  migrate:create  Create a SQL migration
  migrate:down    Rollback all waiting migration down to [to] option if precised
  migrate:init    Create the changelog table on your environment database
  migrate:status  Display the current status of the specified environment
  migrate:up      Execute all waiting migration up to [to] option if precised

```

Installing it to your project
-----------------------------

[](#installing-it-to-your-project)

Just add it to your composer.json (don't forget to specify your bin directory) Warning, all migrate commands must be executed on your root folder like `bin/migrate migrate:command...`

```
{
    "name": "jdoe/testproject",
    "authors": [
        {
            "name": "Jhon DOE",
            "email": "jdoe@gmail.com"
        }
    ],
    "require": {
        "valterfc/php-database-migration" :"3.7.*"
    },
    "config": {
        "bin-dir": "bin"
    }
}

```

Adding an environment
---------------------

[](#adding-an-environment)

The first thing to do before playing with SQL migrations is to add an environment, let's add the dev one.

```
$ ./bin/migrate migrate:addenv

```

You will be prompted to answer a series of questions about your environment, and then a config file will be saved in `./database/environments/[env].yml`.

Initialization
--------------

[](#initialization)

Once the environment is added, you have to initialize it. This verifies that the database connection works, and creates a new database table for tracking the current database changes:

```
$ ./bin/migrate migrate:init [env]

```

Create a migration
------------------

[](#create-a-migration)

It is time to create our first migration file.

```
$ ./bin/migrate migrate:create

```

Migrations file are like this

```
-- // add table users
-- Migration SQL that makes the change goes here.
create table users (id integer, name text);
-- @UNDO
-- SQL to undo the change goes here.
drop table users;

```

List migrations
---------------

[](#list-migrations)

View all available migrations and their status.

```
$ ./bin/migrate migrate:status [env]
+----------------+---------+------------------+--------------------+
| id             | version | applied at       | description        |
+----------------+---------+------------------+--------------------+
| 14679010838251 |         |                  | create table users |
+----------------+---------+------------------+--------------------+

```

Up and down
-----------

[](#up-and-down)

You can now up all the pending migrations. If you decide to down a migration, the last one will be downed alone to prevent mistakes. You will be asked to confirm the downgrade of your database before running the real SQL script.

```
$ ./bin/migrate migrate:up [env]

```

You can mark migrations as applied without executing SQL (e.g. if you switched from another migration system)

```
$ ./bin/migrate migrate:up [env] --changelog-only

```

For development purposes, it is also possible to up a single migration without taking care of the other ones:

```
$ ./bin/migrate migrate:up [env] --only=[migrationid]

```

or migrate to specific migration (it will run all migrations, including the specified migration)

```
$ ./bin/migrate migrate:up [env] --to=[migrationid]

```

Same thing for down:

```
$ ./bin/migrate migrate:down [env] --only=[migrationid]

```

or

```
$ ./bin/migrate migrate:down [env] --to=[migrationid]

```

**Full Sample:**

```
cd your_project_directory

composer init

composer require valterfc/php-database-migration

./vendor/bin/migrate migrate:addenv

./vendor/bin/migrate migrate:init dev

./vendor/bin/migrate migrate:create dev

./vendor/bin/migrate migrate:status dev

./vendor/bin/migrate migrate:up dev

./vendor/bin/migrate migrate:down dev

```

### .env file

[](#env-file)

**For .env file (copy .env.example to your .env file):**

```
DB_HOST=127.0.0.1
DB_DRIVER=pgsql
DB_PORT=5432
DB_USER=postgres
DB_PWD=1234
DB_NAME=database_name
DB_CHARSET=utf8

```

**How to use .env:**

Create new env

```
./vendor/bin/migrate migrate:addenv

```

Answer yes to this question

```
Read database connection variables from System Variables? (yes/no) [yes]:

```

Answer yes to this question

```
Read database connection variables from System Variables? (yes/no) [yes]:

```

Select your .env file

```
DotEnv filename (.env)? (.envfilename/system - use System Variables) [.env]:

```

In the next questions, respond with the name of the variables used in the .env file.

Example:

```
Please enter your pdo driver: DB_DRIVER

```

Complete all fields

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 56.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~16 days

Total

5

Last Release

2760d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/38147471da69d0701230b6388a9bd7294fc33e6764caeb432f1dff5b51033cfe?d=identicon)[valterfc](/maintainers/valterfc)

---

Top Contributors

[![alwex](https://avatars.githubusercontent.com/u/63174?v=4)](https://github.com/alwex "alwex (31 commits)")[![br39](https://avatars.githubusercontent.com/u/25536771?v=4)](https://github.com/br39 "br39 (15 commits)")[![valter-accellog](https://avatars.githubusercontent.com/u/54070199?v=4)](https://github.com/valter-accellog "valter-accellog (6 commits)")[![pyldin601](https://avatars.githubusercontent.com/u/8050895?v=4)](https://github.com/pyldin601 "pyldin601 (2 commits)")[![compwright](https://avatars.githubusercontent.com/u/138688?v=4)](https://github.com/compwright "compwright (1 commits)")

---

Tags

migrationsqlrakemybatis

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/valterfc-php-database-migration/health.svg)

```
[![Health](https://phpackages.com/badges/valterfc-php-database-migration/health.svg)](https://phpackages.com/packages/valterfc-php-database-migration)
```

###  Alternatives

[php-database-migration/php-database-migration

rake and mybatis SQL migration tool

8961.2k](/packages/php-database-migration-php-database-migration)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[kimai/kimai

Kimai - Time Tracking

4.6k7.4k1](/packages/kimai-kimai)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)[rector/rector-src

Instant Upgrade and Automated Refactoring of any PHP code

134391.5k12](/packages/rector-rector-src)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)