Flavors
DbToolsBundle is available in various flavors:
Currently, you can either use this tool as a standalone PHP library, with its Symfony bundle or via its Docker image. An experimental integration is also available for Laravel.
You can change the current flavor from the menu in the top left-hand corner.
Most of the content (text and examples) presented on this documentation will change according to this selected flavor. Whenever this happens, a visual hint indicates it. For example:
Some specific explanation, illustrated with some code:
# a specific code exampleOr juste a specific command line in a paragraph.
Standalone
First and foremost, DbToolsBundle is a PHP library. It can easily be used on any project managed with composer.
After the installation, a binary will be available in your vendor directory: vendor/bin/db-tools.
With the standalone edition, a minimum configuration is needed to tell the system where to find the database(s) you want to manage.
Symfony
DbToolsBundle was, in its first version, a tools for Symfony developers only. The library can still be fully integrated into any Symfony project via its dedicated bridge.
Right after you installed the bundle, and with zero configuration:
- All DbToolsBundle commands will be accessible with the Symfony Console.
- Database connection URL will be autoconfigured based on available DBAL connections.
- DbToolsBundle can be setup through its bundle configuration (
config/packages/db_tools.yaml). - Anonymization can be set through PHP attributes on Doctrine Entities.
Docker
DbToolsBundle can be used in any CI/CD using its Docker image.
This image is based on FrankenPHP. Every DbtoolsBundle commands can be run with docker container run utility.
All configuration can be set up mounting a config file (see installation section for an example). This config file uses the exact same syntax as for the standalone flavor.
Laravel (experimental)
WIP