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.3.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.3-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: djmigrator-1.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 60d461dd69ab8512ccb1b029f9d58e78b73d83a3cc7b4bae479de90cbfb5109d
MD5 a80e26f82917c476850c77683de3f4ea
BLAKE2b-256 2f8fa201bf009f27899bfd7bfe0fb71bd60f58184e73ab181bc6effd1c6232e5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: djmigrator-1.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 79668048ef132bf197718ead2beeed78ed3a59d76e5847a8c6da72b262190a11
MD5 fd7679aa3f090edb2e870f36471594f8
BLAKE2b-256 83b8a21386b3a270b1b178b119b3bd3a180639f94cc24d25dd2da98d6a59cbba

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