Module and Class References

Note

Most of the codebase should not be considered stable API, as many parts will change.

The code documented here is a subset of the codebase. Backend database implementations and some internal modules are not included.

Public API

django_evolution	Django Evolution version and package information.
django_evolution.consts	Constants used throughout Django Evolution.
django_evolution.errors	Standard exceptions for Django Evolution.
django_evolution.evolve	Main interface for evolving applications.
django_evolution.models	Database models for tracking project schema history.
django_evolution.mutations	Support for schema mutation operations and hint output.
django_evolution.signals	Signals for monitoring the evolution process.
django_evolution.signature	Classes for working with stored evolution state signatures.

Private API

django_evolution.diff	Support for diffing project signatures.
django_evolution.mock_models	Utilities for building mock database models and fields.
django_evolution.mutators	Classes that optimize mutations and generate SQL to apply.
django_evolution.support	Constants indicating available Django features.
django_evolution.compat.apps	Compatibility functions for the application registration.
django_evolution.compat.commands	Compatibility module for management commands.
django_evolution.compat.datastructures	Compatibility imports for data structures.
django_evolution.compat.db	Compatibility functions for database-related operations.
django_evolution.compat.models	Compatibility functions for model-related operations.
django_evolution.compat.picklers	Picklers for working with serialized data.
django_evolution.compat.py23	Compatibility functions for Python 2 and 3.
django_evolution.db.common	Common evolution operations backend for databases.
django_evolution.db.mysql	Evolution operations backend for MySQL/MariaDB.
django_evolution.db.postgresql	Evolution operations backend for Postgres.
django_evolution.db.sql_result	Classes for storing SQL statements and Alter Table operations.
django_evolution.db.sqlite3	Evolution operations backend for SQLite.
django_evolution.db.state	Database state tracking for in-progress evolutions.
django_evolution.utils.apps	Utilities for working with apps.
django_evolution.utils.datastructures	Utilities for working with data structures.
django_evolution.utils.evolutions	Utilities for working with evolutions and mutations.
django_evolution.utils.graph	Dependency graphs for tracking and ordering evolutions and migrations.
django_evolution.utils.migrations	Utility functions for working with Django Migrations.
django_evolution.utils.models	Utilities for working with models.
django_evolution.utils.sql	Utilities for working with SQL statements.