A simple command-line python framework to handle automatic DB migrations and updates, with working examples provided for MySQL and postgres.
This tool was written for particular requirements that existing database migration tools (eg, Redgate, DbUp, etc) don't support:
- cross platform (written in python, can support different database platforms. Note that the concepts here can be easily ported to another language)
- database scripts are written in sensible platform-specific SQL dialect, not a DSL
- suggests an approach to database change management comprised of baseline schema, migrations, reference files, and "database code" (e.g., views, stored procedures, etc). See Managing Database Changes for more detail.
- supports a distributed development model
Notes on the code, including unit testing and implementing custom extensions to handle your project's migrations if necessary, are in the code overview.
The examples folder contains some running examples. See the the
README.
A sample run:
> python examples/postgres/postgres.py -nsu
Dropping and recreating postgres_test
Execute Db.sql on postgres_test
Execute 20130427_add_a_size.sql on postgres_test
Execute 20130428_create_Widget.sql on postgres_test
Execute 10_vX.sql on postgres_test
Execute bootstrap_data.sql on postgres_test
The examples follows the notes in Managing Database Changes. If your database project follows the directory structure of these examples, the code can be used as-is.
The tests and examples manipulate actual databases running on your system. Start the local mysql and postgres database servers before running tests.
The tests assume the existence of the following accounts with admin access to the databases (to create and destroy objects, etc):
| MySql | Postgres | |
|---|---|---|
| host | localhost | localhost |
| dbname | mysql | postgres |
| admin username | user | postgres |
| admin password | passwd | admin |
$ virtualenv venv
$ source venv/bin/activate
# Install dependencies
(venv) $ make init
# Run the unit tests
(venv) $ make test
See the code overview for notes about structure.
- Fork the repo.
- Create the feature, add necessary test coverage, and ensure existing tests still pass.
- Push to your fork, and submit a GitHub pull request back to the master branch.