1. Francois Lebel
  2. south


south / south / management / commands / migrate.py

Migrate management command.

import sys
from optparse import make_option

from django.core.management.base import BaseCommand
from django.core.management.color import no_style
from django.conf import settings
from django.db import models

from south import migration

class Command(BaseCommand):
    option_list = BaseCommand.option_list + (
        make_option('--all', action='store_true', dest='all_apps', default=False,
            help='Run the specified migration for all apps.'),
        make_option('--list', action='store_true', dest='list', default=False,
            help='List migrations noting those that have been applied'),
        make_option('--skip', action='store_true', dest='skip', default=False,
            help='Will skip over out-of-order missing migrations'),
        make_option('--merge', action='store_true', dest='merge', default=False,
            help='Will run out-of-order missing migrations as they are - no rollbacks.'),
        make_option('--no-initial-data', action='store_true', dest='no_initial_data', default=False,
            help='Skips loading initial data if specified.'),
        make_option('--fake', action='store_true', dest='fake', default=False,
            help="Pretends to do the migrations, but doesn't actually execute them."),
        make_option('--db-dry-run', action='store_true', dest='db_dry_run', default=False,
            help="Doesn't execute the SQL generated by the db methods, and doesn't store a record that the migration(s) occurred. Useful to test migrations before applying them."),
    if '--verbosity' not in [opt.get_opt_string() for opt in BaseCommand.option_list]:
        option_list += (
            make_option('--verbosity', action='store', dest='verbosity', default='1',
            type='choice', choices=['0', '1', '2'],
            help='Verbosity level; 0=minimal output, 1=normal output, 2=all output'),
    help = "Runs migrations for all apps."
    args = "[appname] [migrationname]"
    usage_str = "Usage: ./manage.py migrate [--all] [--list] [--skip] [--merge] [--no-initial-data] [--fake] [--db-dry-run] " + args

    def handle(self, app=None, target=None, skip=False, merge=False, backwards=False, fake=False, db_dry_run=False, list=False, **options):

        # Work out what the resolve mode is
        resolve_mode = merge and "merge" or (skip and "skip" or None)
        # NOTE: THIS IS DUPLICATED FROM django.core.management.commands.syncdb
        # This code imports any module named 'management' in INSTALLED_APPS.
        # The 'management' module is the preferred way of listening to post_syncdb
        # signals, and since we're sending those out with create_table migrations,
        # we need apps to behave correctly.
        for app_name in settings.INSTALLED_APPS:
                __import__(app_name + '.management', {}, {}, [''])
            except ImportError, exc:
                msg = exc.args[0]
                if not msg.startswith('No module named') or 'management' not in msg:
        # if all_apps flag is set, shift app over to target
        if options.get('all_apps', False):
            target = app
            app = None

        # Migrate each app
        if app:
            apps = [migration.get_app(app.split(".")[-1])]
            if apps == [None]:
                print "The app '%s' does not appear to use migrations." % app
                print self.usage_str
            apps = migration.get_migrated_apps()
        if list and apps:
        if not list:
            tree = migration.dependency_tree()
            for app in apps:
                result = migration.migrate_app(
                    resolve_mode = resolve_mode,
                    target_name = target,
                    fake = fake,
                    db_dry_run = db_dry_run,
                    verbosity = int(options.get('verbosity', 0)),
                    load_inital_data = not options.get('no_initial_data', False),
                    skip = skip,
                if result is False:

def list_migrations(apps):
    from south.models import MigrationHistory
    apps = list(apps)
    names = [migration.get_app_name(app) for app in apps]
    applied_migrations = MigrationHistory.objects.filter(app_name__in=names)
    applied_migrations = ['%s.%s' % (mi.app_name,mi.migration) for mi in applied_migrations]

    for app in apps:
        print migration.get_app_name(app)
        all_migrations = migration.get_migration_names(app)
        for migration_name in all_migrations:
            long_form = '%s.%s' % (migration.get_app_name(app),migration_name)
            if long_form in applied_migrations:
                print format_migration_list_item(migration_name)
                print format_migration_list_item(migration_name, applied=False)

def format_migration_list_item(name, applied=True):
    if applied:
        return '   * %s' % name
    return '     %s' % name