south with list of databases under migration support / docs / settings.rst


South has its own clutch of custom settings you can use to tweak its operation. As with normal Django settings, these go in, or a variant thereof.


South has a somewhat fragile test suite, as it has to fiddle with INSTALLED_APPS at runtime to load in its own testing apps. If the South tests are failing for you, and you'd rather they be ignored (by your CI system or similar, in particlar) set this to True. Defaults to False.


List of databases managed by South. If not set, all databases under settings.DATABASES are taken.


(Django 1.1 and below)

If set, overrides the database module South uses for generating DDL commands. Defaults to south.db.<DATABASE_ENGINE>.


(Django 1.2 and above)

A dictionary with database aliases as keys and the database module South will use as values. South defaults to using the internal south.db.<ENGINE> modules.


If (database-specific) STORAGE_ENGINE is set, South will tell MySQL to use the given storage engine for new items.

For Django version before 1.2 the (global) setting is DATABASE_STORAGE_ENGINE.

Example for Django 1.2 and above:

   'default': {

For Django before 1.2:



When set, South freezes a migration's app and appends it to the bottom of the migration file (the default behaviour, and required for --auto to work). If you want to manually pass in --freeze appname instead, or just don't like the clutter, set this to False. Defaults to True.


If this is False, South's test runner integration will make the test database be created using syncdb, rather than via migrations (the default). Set this to False if you have migrations which take too long to migrate every time tests run, but be wary if you rely on migrations to do special things. Defaults to True in 0.7 and above, False in 0.6 and below.


If this is True the SQL run by South is logged to a file. You must also set SOUTH_LOGGING_FILE to a valid file that you want to log to.


See SOUTH_LOGGING_ON for more info.

A sample setting would be:

SOUTH_LOGGING_FILE = os.path.join(os.path.dirname(__file__),"south.log")


(South 0.7 and higher)

A dictionary of alternative migration modules for apps. By default, apps look for their migrations in "<appname>.migrations", but you can override this here, if you have project-specific migrations sets.

Note that the keys in this dictionary are 'app labels', not the full paths to apps; for example, were I to provide a migrations directory for django.contrib.auth, I'd want to use auth as the key here.


    'books': 'myproject.migrations.books',

Additionally, you can use this setting to turn off migrations for certain apps, by saying their migrations are in some nonexistent module; for example:

    'books': 'ignore',


If set to True, South will also use .pyc files for migrations. Useful if you distribute your code only in .pyc format.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.