shopsys/migrations

Symfony bundle providing commands for transactional Doctrine database migrations

v15.0.0 2024-08-16 12:57 UTC

Requires

• php: ^8.3
• doctrine/dbal: ^3.8.5
• doctrine/doctrine-migrations-bundle: ^3.2.2
• doctrine/migrations: ^3.4.1
• doctrine/orm: ^2.5
• jdorn/sql-formatter: ^1.2
• psr/log: ^1.0
• symfony/config: ^5.4
• symfony/console: ^5.4
• symfony/dependency-injection: ^5.4
• symfony/filesystem: ^5.4
• symfony/framework-bundle: ^5.4
• symfony/http-kernel: ^5.4
• symfony/templating: ^5.4
• symfony/yaml: ^5.4

Requires (Dev)

• phpunit/phpunit: ^11.2.1

MIT

• Shopsys

• database
• orm
• migrations
• schema
• doctrine
• migrate

README

This bundle provides commands which can be useful for database migrations:

• shopsys:migrations:check-mapping checks if ORM mapping is valid.
• shopsys:migrations:check-schema checks if database schema is satisfying ORM.
• shopsys:migrations:count returns count of migrations to execute.
• shopsys:migrations:migrate executes all database migrations in one transaction.
  • the command supports installing migrations from multiple sources, so every bundle can have its own migrations
  • it creates a migration-lock.yml file in the project's root, persisting the order of execution
  • migrations can be manually reordered or skipped if necessary
• shopsys:migrations:generate generates database migrations if the schema was changed
  • the command does not generate migrations that break backwards compatibility - eg. column dropping
  • prompts you to choose the location for migration file if you are developing more than one bundle

This bundle uses DoctrineMigrationsBundle, so you have to install both.

This repository is maintained by shopsys/shopsys monorepo, information about changes is in monorepo CHANGELOG.md.

To be able to use this bundle, you need to do following:

1. Require shopsys/migrations in composer.json

2. Register bundles in your AppKernel.php:

   new Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle(),
   new Shopsys\MigrationBundle\ShopsysMigrationBundle(),
   

3. Configure DoctrineMigrationsBundle according to its documentation (see https://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html#configuration)

Contributing

Thank you for your contributions to Shopsys Migrations package. Together we are making Shopsys Platform better.

This repository is READ-ONLY. If you want to report issues and/or send pull requests, please use the main Shopsys repository.

Please, check our Contribution Guide before contributing.

Support

What to do when you are in troubles or need some help? The best way is to join our Slack.

If you want to report issues, please use the main Shopsys repository.