django-dbsync 1.0.4

Intelligent database synchronization tool for Django projects

Django DB Sync

Django DB Sync is a powerful, intelligent database synchronization tool designed specifically for Django projects. It automatically detects and resolves schema differences between your Django models and database tables, eliminating the need for manual migrations in many scenarios.

Why Django DB Sync?

Unlike Django's built-in migrations system, Django DB Sync works by analyzing the current state of your database and comparing it directly with your Django models. This approach is particularly valuable when:

• Working with legacy databases that weren't created with Django
• Dealing with databases that have been manually modified
• Syncing schemas across different environments
• Cleaning up orphaned tables and unused columns
• Requiring granular control over database schema changes

Key Features

• Multi-Database Support: Works seamlessly with MySQL, PostgreSQL, SQLite, and Oracle
• Intelligent Schema Detection: Automatically compares Django models with actual database schema
• Safety First: Built-in dry-run mode and backup creation before making changes
• Comprehensive Reporting: Detailed HTML reports and colored terminal output
• Orphaned Table Management: Identifies and manages tables without corresponding Django models
• Smart Field Mapping: Intelligent mapping between Django field types and database column types
• Constraint Handling: Proper management of foreign keys, indexes, and other constraints
• Beautiful Interface: Colored terminal output with progress indicators and status updates

🛠️ Core Capabilities

1. Table Management: Create, rename, and manage database tables
2. Column Operations: Add, modify, and remove columns with proper type mapping
3. Constraint Handling: Manage foreign keys, unique constraints, and indexes
4. Data Preservation: Safely modify schemas while preserving existing data
5. Backup Integration: Automatic backup creation before destructive operations
6. Detailed Reporting: Comprehensive logs and HTML reports of all operations

🔧 Technical Highlights

• Database Agnostic: Works with all major database backends supported by Django
• Type-Safe Operations: Intelligent field type mapping and validation
• Transaction Safety: All operations wrapped in database transactions
• Extensible Architecture: Modular design for easy customization and extension
• Production Ready: Thoroughly tested with comprehensive error handling

Installation

pip install django-dbsync

Add to your Django settings:

INSTALLED_APPS = [
    # ... other apps
    'django_dbsync',
]

# Optional: Configure django-dbsync
DJANGO_DBSYNC = {
    'DEFAULT_DATABASE': 'default',
    'AUTO_CREATE_TABLES': True,
    'AUTO_ADD_COLUMNS': True,
    'AUTO_DROP_COLUMNS': False,
    'EXCLUDE_APPS': ['admin', 'contenttypes', 'sessions'],
    'COLORED_OUTPUT': True,
    'SHOW_ORPHANED_TABLES': True,
}

Usage

Basic Sync

# Sync default database
python manage.py dbsync

# Sync specific database
python manage.py dbsync --database=secondary

# Dry run (show changes without applying)
python manage.py dbsync --dry-run

# Auto-approve all changes (dangerous!)
python manage.py dbsync --auto-approve

# Drop orphaned tables (dangerous!)
python manage.py dbsync --drop-orphaned 

Advanced Options

# Exclude specific apps
python manage.py dbsync --exclude-apps admin auth contenttypes

# Include only specific apps
python manage.py dbsync --include-apps myapp otherapp

# Create backup before sync
python manage.py dbsync --backup

# Generate detailed report
python manage.py dbsync --report json
python manage.py dbsync --report html
python manage.py dbsync --report both

# Drop orphaned tables (dry run)
python manage.py dbsync --drop-orphaned --dry-run

Database Check

# Check database schema
python manage.py dbcheck

# Check specific database
python manage.py dbcheck --database=secondary

# Show specific table details
python manage.py dbcheck --table=my_table

# Compare with Django models
python manage.py dbcheck --compare-models

Configuration

Database Settings

Support for multiple databases:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'main_db',
        'USER': 'user',
        'PASSWORD': 'pass',
        'HOST': 'localhost',
    },
    'analytics': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'analytics_db',
        'USER': 'user',
        'PASSWORD': 'pass',
        'HOST': 'localhost',
    }
}

# Sync configuration per database
DJANGO_DBSYNC = {
    'CUSTOM_DATABASES': {
        'analytics': {
            'AUTO_DROP_COLUMNS': True,
            'EXCLUDE_APPS': ['admin'],
        }
    }
}

Complete Settings Reference

DJANGO_DBSYNC = {
    # Database configuration
    'DEFAULT_DATABASE': 'default',
    'CUSTOM_DATABASES': None,
    
    # Sync behavior
    'AUTO_CREATE_TABLES': True,
    'AUTO_ADD_COLUMNS': True,
    'AUTO_DROP_COLUMNS': False,
    'AUTO_RENAME_TABLES': False,
    'BACKUP_BEFORE_SYNC': True,
    
    # Output settings
    'COLORED_OUTPUT': True,
    'VERBOSE_LOGGING': True,
    'SHOW_PROGRESS': True,
    
    # Safety settings
    'EXCLUDE_APPS': ['sessions', 'admin', 'contenttypes'],
    'EXCLUDE_TABLES': [],
    'DRY_RUN_MODE': False,
    
    # Report settings
    'GENERATE_HTML_REPORT': False,
    'REPORT_OUTPUT_DIR': 'dbsync_reports/',
    'SHOW_ORPHANED_TABLES': True,
}

Supported Field Types

All Django field types are supported across MySQL, PostgreSQL, and SQLite:

• AutoField, BigAutoField
• CharField, TextField, EmailField, URLField, SlugField
• IntegerField, BigIntegerField, SmallIntegerField
• PositiveIntegerField, PositiveSmallIntegerField
• FloatField, DecimalField
• BooleanField
• DateField, DateTimeField, TimeField
• UUIDField, JSONField
• ForeignKey, OneToOneField

Example Output

Django Database Sync v1.0.2
==================================================
Starting synchronization...

✅ myapp.User
   - Added column 'phone' to 'users'
   - Modified column 'email' in 'users'

⚠️  myapp.Order
   - Table 'orders_old' renamed to 'orders'
   - Extra column 'temp_field' in 'orders' (kept)

❌ myapp.Product
   - Failed to add column 'description'

⚠️  Orphaned Tables (2 found):
🗃️  old_backup_table - 1,247 rows, 2.45 MB
🗃️  temp_migration - 0 rows, 0.01 MB

Synchronization completed!

Contributing

1. Fork the repository
2. Create a feature branch
3. Add tests for new functionality
4. Ensure all tests pass
5. Submit a pull request

Support

• GitHub Issues: https://github.com/Lovedazzell/db_sync/issues
• Documentation: https://django-dbsync.readthedocs.io/
• Email: [e-mail]