PHPackages                             aymdev/fregata-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. aymdev/fregata-bundle

ActiveSymfony-bundle

aymdev/fregata-bundle
=====================

Symfony bundle for the Fregata migration framework.

v1.0.0(3y ago)26MITPHPPHP >=8.1

Since May 24Pushed 3y ago1 watchersCompare

[ Source](https://github.com/AymDev/FregataBundle)[ Packagist](https://packagist.org/packages/aymdev/fregata-bundle)[ RSS](/packages/aymdev-fregata-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (24)Versions (2)Used By (0)

Fregata Bundle
==============

[](#fregata-bundle)

**Symfony** bundle for the [Fregata](https://github.com/AymDev/Fregata) data migration framework. Provides an UI and executes migrations asynchronously using the **Messenger** component.

[![Testing](https://github.com/AymDev/FregataBundle/workflows/Testing/badge.svg)](https://github.com/AymDev/FregataBundle/workflows/Testing/badge.svg)[![Coding Standards](https://github.com/AymDev/FregataBundle/workflows/Coding%20Standards/badge.svg)](https://github.com/AymDev/FregataBundle/workflows/Coding%20Standards/badge.svg)[![Bundle installation](https://github.com/AymDev/FregataBundle/workflows/Bundle%20installation/badge.svg)](https://github.com/AymDev/FregataBundle/workflows/Bundle%20installation/badge.svg)[![Latest Stable Version](https://camo.githubusercontent.com/6664a3f20a17910abef542c45b6f0ddd54af9d579be2071ff3eb85dff61cebb8/68747470733a2f2f706f7365722e707567782e6f72672f61796d6465762f667265676174612d62756e646c652f76)](//packagist.org/packages/aymdev/fregata-bundle)[![License](https://camo.githubusercontent.com/26fbc7ea61fc796a14af78658898ddb055475bb5215a50bac9126cce650c00c0/68747470733a2f2f706f7365722e707567782e6f72672f61796d6465762f667265676174612d62756e646c652f6c6963656e7365)](//packagist.org/packages/aymdev/fregata-bundle)

**Documentation**:

1. [Requirements](#requirements)
2. [Installation](#installation)
    1. [Doctrine entities](#doctrine-entities)
    2. [Messenger transport](#messenger-transport)
    3. [User interface](#user-interface)
3. [User interface overview](#user-interface-overview)
    1. [Main pages](#main-pages)
    2. [Run list](#run-list)
    3. [Run details](#run-details)
4. [Starting a migration](#starting-a-migration)

Requirements
------------

[](#requirements)

This bundle requires **PHP >= 8.1** and a **Symfony 4.4** or **5** application. Note that as it uses a database, it will install the **Doctrine** bundle.

If you are not familiar with **Fregata**'s features, make sure to read its [documentation](https://github.com/AymDev/Fregata).

Installation
------------

[](#installation)

Install with **Composer**:

```
composer require aymdev/fregata-bundle
```

### Doctrine entities

[](#doctrine-entities)

Then you will need to create the database tables for the provided entities (3 entities + a *ManyToMany* relation). You can do this how you want.

> **Suggestion:** My preferred way to use database migrations is by using the [MakerBundle](https://symfony.com/doc/current/bundles/SymfonyMakerBundle/index.html) and its `make:migration` command followed by **Doctrine**'s `doctrine:migrations:migrate` command.

### Messenger transport

[](#messenger-transport)

As the main work of the bundle happens in *Messenger* components, you need to *route* the provided **messages** to a **transport** of your choice. Example **config/packages/messenger.yaml**:

```
framework:
    messenger:
        transports:
            # You are entirely responsible for the transport configuration
            async: '%env(MESSENGER_TRANSPORT_DSN)%'

        routing:
            # Every message implements the following interface, nothing more is needed
            'Fregata\FregataBundle\Messenger\FregataMessageInterface': async
```

### User interface

[](#user-interface)

To enable the user interface, import the routes by creating a **config/routes/fregata.yaml** file:

```
fregata:
    resource: "@FregataBundle/Resources/config/routes.xml"
    prefix: /fregata
```

> Change the `prefix` to anything you want, or remove it if you want to set the Fregata dashboard at the root of your app.

You can then reach the dashboard at `/fregata`.

User interface overview
-----------------------

[](#user-interface-overview)

### Main pages

[](#main-pages)

The **dashboard** lists the current migration runs, or the last one if nothing is running. The **migrations** page lists the currently configured migrations with a link to a dedicated page to get a quick overview with the list of components and the run history of a specific migration. The complete **run history** is on a separated page. [![](./docs/images/history.png)](./docs/images/history.png)

### Run list

[](#run-list)

The table shown here is used in multiple pages of the user interface and contains:

- the id of the migration run
- the name of the migration with a link to the **details page**
- the **status** tag
- the time stats: start time, end time and duration
- the number of components
- a link to the **run details**

### Run details

[](#run-details)

The same informations can be found on the **run details**: [![](./docs/images/migration_run.png)](./docs/images/migration_run.png)A cancel button is shown in the top right corner as long as the migration is running. The run is divided on 3 steps with tabs:

- Before tasks
- Migrators
- After tasks

Each tab shows a progress bar and its associated components. The migrators are sorted according to their dependencies from left to right.

Starting a migration
--------------------

[](#starting-a-migration)

You can start a migration from the user interface by clicking the *"New run"* button in the menu. Alternatively, the `fregata:migration:execute` console command is available:

```
php ./bin/console fregata:migration:execute
```

You should then see the run on the user interface.

If you want to run a migration as in the **Fregata** framework, without Messenger, you can add the `--synchronous` option.

> **Warning**: by doing so, the migration runs in the foreground, doesn't use the database and can't show on the UI.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1454d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/58fe05cbfb0d7e61f369dabfdd2bac390e8e93bfbd4634a9cc6c1e7786efaaf3?d=identicon)[aymdev](/maintainers/aymdev)

---

Top Contributors

[![AymDev](https://avatars.githubusercontent.com/u/22072016?v=4)](https://github.com/AymDev "AymDev (41 commits)")

###  Code Quality

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/aymdev-fregata-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/aymdev-fregata-bundle/health.svg)](https://phpackages.com/packages/aymdev-fregata-bundle)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[easycorp/easyadmin-bundle

Admin generator for Symfony applications

4.3k16.7M310](/packages/easycorp-easyadmin-bundle)[contao/core-bundle

Contao Open Source CMS

1231.6M2.4k](/packages/contao-core-bundle)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)