Skip to content
On this page
developed by

Installation

The DbToolsBundle follows Symfony Best Practices for Bundles, you should not be lost if you are a regular Symfony developper.

Requirements & Dependencies

  • PHP 8.1 or higher
  • Symfony 6.0 or higher
  • Doctrine/DBAL, the DbToolsBundle takes advantage of available DBAL connections

Currently supported database vendors:

  • PostgreSQL 10 or higher
  • MariaDB 11 or higher
  • MySQL 5.7 or higher

INFO

The bundle could also work with other database vendors. Check out the database vendors support page.

Installation

Add the DbToolsBundle to your Symfony project with composer:

sh
composer require makinacorpus/db-tools-bundle

Then, activate the bundle:

php
// config/bundles.php

return [
    Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],

    //...

    Doctrine\Bundle\DoctrineBundle\DoctrineBundle::class => ['all' => true],
    Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle::class => ['all' => true],

    // ...

    MakinaCorpus\DbToolsBundle\DbToolsBundle::class => ['all' => true], 
];

And copy provided default configuration from vendor:

sh
cd your_project_dir
cp vendor/makinacorpus/db-tools-bundle/config/packages/db_tools.yaml config/packages/.

Feel free to read this configuration file, it will learn you basics about this bundle.

That's it, DbToolsBundle is now ready to be used.

But before starting to use it, just check the DbToolsBundle can find backup and restore binaries for your(s) doctrine connection(s):

sh
php bin/console db-tools:check

TIP

If this command returns errors, get to the binaries configuration section to understand how to solve them.

Released under the MIT License.