lonny-common-pg-migrate 0.1.0

A CLI for managing postgres DB migrations

lonny_pg_migrate

A CLI for managing postgres DB migrations.

Installation

pip install lonny_pg_migrate

Usage

First, we must create a MigrationRunner object. We can do this like:

from lonny_pg_migrate import MigrationRunner

# Get a 'lonny_pg' DB connection.
db = get_lonny_pg_connection()

runner = MigrationRunner(db)

To define a migration, we can simply now do:

# N.B. sort_key is optional and defaults to the slug.
@runner.migrate("migration_0", sort_key = "0")
def migration_0(db):
    do_some_action(db)

To perform the migration, we can either invoke the runner directly using:

# This will wipe the database
runner.drop()
# This will run - in order of sort_key, all migrations which haven't yet run.
runner.migrate()

Or via the CLI using:

pg_migrate path.to.module:runner_var

As above, drop functionality is supported by passing in a --drop argument.