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


### 2. Add to Django Settings

Add `djmigrator` to your Django project's `INSTALLED_APPS` in `settings.py`:

```python
INSTALLED_APPS = [
    ...
    'djmigrator',
]

### 3. Migration Command

```bash
python manage.py smart_makemigrations

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.4.tar.gz (5.2 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.4-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: djmigrator-1.0.4.tar.gz
  • Upload date:
  • Size: 5.2 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.4.tar.gz
Algorithm Hash digest
SHA256 9b2cb7e3bf4c5b49ab302841c5ab3476e9b1822af42159fc51d9040f4663850a
MD5 c0a009840c8e8bc6040c09a71d6c3a97
BLAKE2b-256 e1eb37fca2e810d1d11b26030629eca65ca049fb3c27ac02ee4b19c99648359d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: djmigrator-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 5.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 734aabc05e4cbdc6479f1d60387838a1dc306d8ce0dd88a1f71f52ca201d7818
MD5 efb10c4d25b1d72742fb81b4bfe8fbde
BLAKE2b-256 d58fc0f5e1576fb107a0d627e99f72f99ebc25f422b152860ff83e6a66f2b433

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