Skip to main content

Yet another sqlalchemy based database schema migration tool

Project description

Yet another sqlalchemy based database schema migration tool


To install it, add:

recipe = zc.recipe.egg

to your buildout.cfg

You might want to add your databse driver pakcage and your application
package like this:

recipe = zc.recipe.egg


Add to your development.ini or some other kind of ini:

app = app:busy
package = busy.migration

migrator expects sqlalchemy configuration to be present in the app
section, for example:

sqlalchemy.url = postgresql:///development

I might add sqlalchemy configuration to the migration section too if
someone will ask.

You can also add:

vcs = git
schema_diff_cmd = git diff src/busy/models/schema.sql

so that add_script command would add the files to the version control
system, and populate them with the delta of your schema automatically.

These two settings might go the setup.cfg as they are not really
deployment related and are never required to run your application.


bin/migrate development.ini [upgrade|downgrade|setup|add_script] [version]

Integrating with your application

Add something like this:

engine = engine_from_config(conf, 'sqlalchemy.')
DBMigrator(engine, 'busy.migration').set_up_migration(init_migration=DBSetUp(), run_scripts=False)

to your setup_app, or in your initialize_sql

DBSetUp is a class that has an "upgrade" method that initializes your

You can do it in multiple ways, you can add a migration script that
sets up your tables and then migrate that using migration scripts:

DBMigrator(engine, 'busy.migration').set_up_migration(run_scripts=True)

Or you can have a canonical schema set up and initialize it all at
once and just mark all the scripts as 'done'

DBMigrator(engine, 'busy.migration').set_up_migration(init_migration=DBSetUp(), run_scripts=False)


Put your scripts in the package that you have set up in your migration

Scripts are tracked separately.

Script files should be of this format:

Timestamp script title

Timestamp script title

If both, python and sql exist with the same timestamp I assume that
python script is responsible for running sql scripts. I might add
helpers to make running an sql file later.

Sql files are just that, sql files that will be executed. Python files
should contain callables: upgrade and downgrade, downgrade can be
missing if script is not intended to be reversable.

TODO: add example migration scripts

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
nous.migration-0.7.1.tar.gz (5.7 kB) Copy SHA256 hash SHA256 Source None Mar 11, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page