README

A Symfony bundle for database and filesystem backup/restore management.

Overview

The Symfony Backup Bundle provides a complete and configurable system for automatic and manual backups of databases and filesystems, with optional Symfony Profiler integration for development.

Features

• Database backup and restore (MySQL, PostgreSQL, SQLite)
• Filesystem backup and restore
• Multiple storage adapters (Local, S3, Google Cloud)
• Compression support (gzip, zip)
• Retention policy helpers
• Scheduler/Messenger integration for automated backups (Symfony 7.3+)
• Event system for backup/restore operations
• Command-line interface and programmatic API

Requirements

• PHP: >= 8.2
• Symfony: 6.4+

Installation

composer require raffaelecarelle/symfony-backup-bundle

Profiler

If you enabled profiler section import the profiler routing file:

# config/routes/profiler.yaml
_profiler_pro_backup:
    resource: "@ProBackupBundle/Resources/config/routes.php"

Configuration

Create a configuration file at config/packages/pro_backup.yaml:

pro_backup:
    default_storage: 'local'
    backup_dir: '%kernel.project_dir%/var/backups'

    storage:
        local:
            adapter: 'local'
            options:
                path: '%kernel.project_dir%/var/backups'
                permissions: 0755

        s3:
            adapter: 's3'
            options:
                bucket: 'my-app-backups'
                region: 'eu-west-1'
                credentials:
                    key: '%env(AWS_ACCESS_KEY_ID)%'
                    secret: '%env(AWS_SECRET_ACCESS_KEY)%'

        google_cloud:
            adapter: 'google_cloud'
            options:
                bucket: 'my-app-backups'
                project_id: '%env(GOOGLE_CLOUD_PROJECT_ID)%'
                key_file: '%env(GOOGLE_CLOUD_KEY_FILE)%'

    database:
        enabled: true
        connections: ['default'] # Doctrine connection names
        compression: 'gzip'      # gzip|zip|null
        retention_days: 30
        exclude_tables: ['cache_items', 'sessions']
        options:
            mysql:
                single_transaction: true
                routines: true
                triggers: true
            postgresql:
                format: 'custom'
                verbose: true

    filesystem:
        enabled: false
        paths:
            - { path: '%kernel.project_dir%/public/uploads', exclude: ['*.tmp', '*.log'] }
            - { path: '%kernel.project_dir%/config', exclude: ['secrets/'] }
        compression: 'zip'
        retention_days: 7

    schedule:
        database:
            frequency: 'daily' # daily, weekly, monthly, cron expression
            time: '02:00'
        filesystem:
            frequency: 'weekly'
            time: '03:00'

Usage

Console commands

Create a database backup:

php bin/console pro:backup:create --type=database

Restore a backup:

php bin/console pro:backup:restore <backup-id>

List available backups:

php bin/console pro:backup:list

Programmatic usage

use ProBackupBundle\Model\BackupConfiguration;
use ProBackupBundle\Manager\BackupManager;

// Create a backup
$config = (new BackupConfiguration())
    ->setType('database')
    ->setName('my_backup');

$backupManager = $container->get(BackupManager::class);
$result = $backupManager->backup($config);

if ($result->isSuccess()) {
    echo 'Backup created: ' . $result->getFilePath();
} else {
    echo 'Backup failed: ' . $result->getError();
}

// Restore a backup
$backupId = 'backup_123';
$success = $backupManager->restore($backupId, []);

if ($success) {
    echo 'Backup restored successfully';
} else {
    echo 'Restore failed';
}

Architecture

Database Adapter Auto-Detection

The bundle automatically detects the database type from your Doctrine DBAL connection configuration using a factory pattern. The DatabaseAdapterFactory inspects the database platform at runtime using Connection::getDatabasePlatform() and creates the appropriate adapter (MySQL, PostgreSQL, SQLite).

This approach is robust and works with:

• Modern DSN-based configuration (postgresql://user:pass@host/db)
• Legacy driver-based configuration (pdo_pgsql, pdo_mysql)
• Multiple database connections
• Any Doctrine-supported database platform

No manual adapter selection is required - the bundle automatically uses the correct backup tool (mysqldump, pg_dump, sqlite3) based on your connection type.

Supported Database Platforms

• MySQL/MariaDB: Uses mysqldump and mysql for backup/restore
• PostgreSQL: Uses pg_dump and pg_restore/psql for backup/restore
• SQLite: Uses file-based backup with sqlite3 CLI

Make sure the corresponding CLI tools are available in your system PATH.

Events

The bundle dispatches the following events (see ProBackupBundle\Event\BackupEvents):

• backup.pre_backup: Before a backup operation
• backup.post_backup: After a successful backup operation
• backup.failed: When a backup operation fails
• backup.pre_restore: Before a restore operation
• backup.post_restore: After a successful restore operation
• backup.restore_failed: When a restore operation fails

Development

• Run CS fixer (dry-run): vendor/bin/php-cs-fixer fix --dry-run --diff
• Run static analysis: vendor/bin/phpstan analyse
• Run tests: vendor/bin/phpunit

CI runs on GitHub Actions with MySQL and PostgreSQL services and a matrix of PHP/Symfony versions compatible with this bundle.

License

This bundle is released under the MIT License.