Skip to main content

Smart Django migration manager.

Project description

djmigrator

djmigrator is a Django management extension that provides smart migration handling by deeply comparing Django models with the actual database schema. It automates missing migrations generation and applies them safely, ensuring that the models and database remain consistent without manually tracking changes.


Introduction

In large Django projects, inconsistencies between models and the actual database often happen due to missing migrations, manual database edits, or legacy systems. Traditional Django commands such as makemigrations and migrate assume perfect sync between models and the database.

djmigrator solves this by:

  • Performing deep inspections of your actual database schema.
  • Comparing models and fields directly against database tables and columns.
  • Identifying missing tables or missing columns.
  • Generating and applying only necessary migrations.
  • Using smart application strategies to avoid common errors like "table already exists" or "column already exists".

Key Features

  • Automatic detection of missing tables or missing columns based on model comparison.
  • Safe skipping of already existing tables and fields during migration.
  • Automatic generation of migration files only when necessary.
  • Application of migrations with --fake-initial to synchronize existing tables.
  • Clear reporting of discrepancies between models and database.
  • Minimal downtime and human intervention required for database synchronization.

How It Works

  1. The smart_makemigrations command inspects all Django models and their respective tables in the connected database.
  2. It identifies:
    • Tables missing in the database.
    • Columns missing inside an existing table.
    • Extra columns existing in the database but not defined in the Django models (reported but not modified).
  3. If discrepancies are found:
    • makemigrations is automatically triggered to generate new migration files.
    • migrate --fake-initial is applied to safely sync without duplicating existing tables.
  4. If no discrepancies are found, the command reports a clean synchronization status.

Installation and Setup

To install and set up djmigrator, follow these steps:

1. Install the Package

pip install djmigrator

That's it! The management command is automatically registered and available.

2. Use the Migration Command

python manage.py smart_makemigrations

Note: You do NOT need to add djmigrator to INSTALLED_APPS. The command is automatically discovered via setuptools entry points, just like other Django packages.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djmigrator-1.0.8.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

djmigrator-1.0.8-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file djmigrator-1.0.8.tar.gz.

File metadata

  • Download URL: djmigrator-1.0.8.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.5

File hashes

Hashes for djmigrator-1.0.8.tar.gz
Algorithm Hash digest
SHA256 d78de6469d0aee777967105376a6fae6f8abe445288fe409800929adec3b30bc
MD5 a9ce3114f80247d740c67129b8186d3f
BLAKE2b-256 1ba859b892f20b80090ce82cc628aff14ccd8a1243e34f88688056833e1d5f2a

See more details on using hashes here.

File details

Details for the file djmigrator-1.0.8-py3-none-any.whl.

File metadata

  • Download URL: djmigrator-1.0.8-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.5

File hashes

Hashes for djmigrator-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e2fb7d50c3b12f524d4b543bae2305f75962a4874fbf6b2076fc51ac6b4b5423
MD5 af3c12abd8ff3a6aa9e283249d019027
BLAKE2b-256 61fde2c465c9d11f8779e8fab69c84430b6d508a6489e8251262f75596a89040

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page