Skip to content
A PHP based database migrations/patch management system
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


dbpatch is a management tool for tracking and applying database migration/schema patches.

It currently supports MySQL (via PDO).


You can install dbpatch as a git submodule. More ideal (and coming soon) will be via composer.

Once you have installed the application, then you want to create a new configuration folder set. A sample configuration folder is at test/. It consists of a config.php that lets you set up a config object and a sql/ folder that contains three sub folders that store different types of patches.

schema/ - used to store patches that adjust table/function references.
data/ - used to store patches that apply data updates.
script/ - used to store script files, like bash or PHP scripts that can be applied to modify database data

To run the initialization:

./dbpatch init relative_path_folder_name

Then edit folder/config.php and modify the instantiation line for the config class.

The parameters are in the following order:

$id => An ID you define to identify the configuration
$driver => For now, this should remain "mysql"
$host => This is the IP of the database server
$databaseName => The name of the database in question
$user => The username to connect as
$pass => The password of the user
$port => The port the database is listening at

The config.php is set up like it is, so if you want to import the database connection parameters from somewhere else in your project, you can do so, then populate the parameters of the config class.


Applying patches that are unapplied to the working copy database: ./dbpatch patch

Creating a patch file:

./dbpatch create:data ./dbpatch create:schema ./dbpatch create:script

The descriptor of the create command dictates the type of patch created. schema: This is used typically for database schema adjustments, like adding or removing a table or field. data: This is used for manipulating data in the database, like adding in seed data. script: Sometimes a a complex operation on the data is needed. Script allows you to write a PHP script that can do the data modifications required for the patch.

Record a patch manually, but don't apply it: ./dbpatch record

Get help on the commands and options available: ./dbpatch --help

You can’t perform that action at this time.