Backup Configuration

BackupConfig
├── BackupStorageConfig      # Where to store backups
├── BackupScheduleConfig     # When to run backups
├── BackupRetentionConfig    # How long to keep backups
└── BackupDatabaseConfig[]   # Per-database overrides

from django_cfg import (
    DjangoConfig,
    BackupConfig,
    BackupStorageConfig,
    BackupScheduleConfig,
    BackupRetentionConfig,
)
 
class MyConfig(DjangoConfig):
    backup: BackupConfig = BackupConfig(
        # Enable/disable the entire module
        enabled=True,
 
        # Storage configuration
        storage=BackupStorageConfig(...),
 
        # Schedule configuration
        schedule=BackupScheduleConfig(...),
 
        # Retention policy
        retention=BackupRetentionConfig(...),
 
        # Per-database configurations (optional)
        databases=[...],
 
        # Compression algorithm
        compression="gzip",  # gzip | bz2 | xz | none
 
        # Optional encryption key (GPG-compatible)
        encryption_key=None,
 
        # Notifications
        notify_on_success=False,
        notify_on_failure=True,
 
        # Filename template
        filename_template="{database}_{timestamp}_{env}",
    )

storage=BackupStorageConfig(
    backend="local",
    local_path="backups/",  # Relative to BASE_DIR or absolute
)

storage=BackupStorageConfig(
    backend="s3",
    s3_bucket="my-backups",
    s3_endpoint_url="https://xxx.r2.cloudflarestorage.com",  # For R2/MinIO
    s3_access_key="${AWS_ACCESS_KEY_ID}",
    s3_secret_key="${AWS_SECRET_ACCESS_KEY}",
    s3_region="auto",  # "auto" for R2, or specific region
    s3_prefix="db-backups/",  # Key prefix in bucket
)

schedule=BackupScheduleConfig(
    enabled=True,
    cron="0 2 * * *",  # Daily at 2 AM
    queue="default",   # RQ queue name
)

schedule=BackupScheduleConfig(
    enabled=True,
    interval_hours=6,  # Every 6 hours
)

from datetime import time
 
schedule=BackupScheduleConfig(
    enabled=True,
    daily_time=time(2, 0),  # Daily at 02:00
)

retention=BackupRetentionConfig(
    enabled=True,
    keep_daily=7,       # Keep 7 daily backups
    keep_weekly=4,      # Keep 4 weekly backups
    keep_monthly=3,     # Keep 3 monthly backups
    max_total_size_mb=None,  # Optional size limit
)

from django_cfg import BackupDatabaseConfig
 
backup=BackupConfig(
    enabled=True,
    databases=[
        # Default database with table exclusions
        BackupDatabaseConfig(
            alias="default",
            enabled=True,
            exclude_tables=["django_session", "django_cache"],
        ),
        # Analytics database with custom schedule
        BackupDatabaseConfig(
            alias="analytics",
            enabled=True,
            schedule_override=BackupScheduleConfig(
                cron="0 4 * * *",  # Different time
            ),
        ),
        # Logs database - skip backup
        BackupDatabaseConfig(
            alias="logs",
            enabled=False,
        ),
    ],
)

backup=BackupConfig(
    enabled=True,
    storage=BackupStorageConfig(
        backend="local",
        local_path="backups/",
    ),
    schedule=BackupScheduleConfig(
        enabled=False,  # Manual only in development
    ),
    retention=BackupRetentionConfig(
        keep_daily=3,
        keep_weekly=0,
        keep_monthly=0,
    ),
    notify_on_failure=False,
)

backup=BackupConfig(
    enabled=True,
    storage=BackupStorageConfig(
        backend="s3",
        s3_bucket="company-db-backups",
        s3_endpoint_url="https://xxx.r2.cloudflarestorage.com",
        s3_access_key="${R2_ACCESS_KEY}",
        s3_secret_key="${R2_SECRET_KEY}",
        s3_region="auto",
        s3_prefix="production/",
    ),
    schedule=BackupScheduleConfig(
        cron="0 */4 * * *",  # Every 4 hours
        queue="backups",
    ),
    retention=BackupRetentionConfig(
        keep_daily=14,
        keep_weekly=8,
        keep_monthly=12,
        max_total_size_mb=50000,  # 50 GB limit
    ),
    compression="xz",  # Best compression
    notify_on_success=True,
    notify_on_failure=True,
)

backup=BackupConfig(
    enabled=True,
    storage=BackupStorageConfig(backend="s3", ...),
    schedule=BackupScheduleConfig(cron="0 2 * * *"),
    databases=[
        BackupDatabaseConfig(
            alias="default",
            exclude_tables=["django_session"],
        ),
        BackupDatabaseConfig(
            alias="analytics",
            schedule_override=BackupScheduleConfig(
                cron="0 6 * * *",  # Later time (less critical)
            ),
        ),
        BackupDatabaseConfig(
            alias="cache_db",
            enabled=False,  # Don't backup cache database
        ),
    ],
)

storage=BackupStorageConfig(
    backend="s3",
    s3_bucket="${BACKUP_S3_BUCKET}",
    s3_access_key="${BACKUP_S3_ACCESS_KEY}",
    s3_secret_key="${BACKUP_S3_SECRET_KEY}",
)

BACKUP_S3_BUCKET=my-backups
BACKUP_S3_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE
BACKUP_S3_SECRET_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY