Some instructions in the RegisterMigration docstring on how to use.

This commit is contained in:
Christopher Allan Webber 2011-07-09 15:10:47 -05:00
parent dca6406a90
commit 363fc97259

View File

@ -121,6 +121,19 @@ MIGRATIONS = {}
class RegisterMigration(object): class RegisterMigration(object):
""" """
Tool for registering migrations Tool for registering migrations
Call like:
@RegisterMigration(33)
def update_dwarves(database):
[...]
This will register your migration with the default migration
registry. Alternately, to specify a very specific
migration_registry, you can pass in that as the second argument.
Note, the number of your migration should NEVER be 0 or less than
0. 0 is the default "no migrations" state!
""" """
def __init__(self, migration_number, migration_registry=MIGRATIONS): def __init__(self, migration_number, migration_registry=MIGRATIONS):
self.migration_number = migration_number self.migration_number = migration_number