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-0.0.8.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

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

djmigrator-0.0.8-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for djmigrator-0.0.8.tar.gz
Algorithm Hash digest
SHA256 20a28a0b0832c2438eda554fc1d3c4494055b56743b71bc0ff8786a3cc34ae1f
MD5 a7358e716ef5ad8a3749725a8f5b0ef7
BLAKE2b-256 0f73d7a987788fec782de2245d8c7f4f04590e07a46195240097eacc91828cf9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for djmigrator-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 bb440f7db6a159c501859a317d2d9d641397b7c7543653a516132211824b1191
MD5 fd904bf2c0482466ff7a7212106c4aca
BLAKE2b-256 58c660759c03c08752b90920da023df81a331186b028b4718178e35a7ef7990d

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