Skip to content

Flexible migrations library with the goal of providing a solid foundation for more concrete (e.g. database-specific) implementations. I can also be run autonomously for simple tasks.

License

jjsaunier/migrations

 
 

Repository files navigation

Status

Build Status Code Coverage Scrutinizer Code Quality SensioLabsInsight Packagist

Author Author License Documentation Status

NB!: This project is still an early release. Please do not use in production-critical environments. Refer to the LICENSE for more information.

Introduction

Baleen Migrations is a project that seeks to abstract the domain logic of performing migrations of any kind into a single package. Its simple goal is to excel at one single task: provide an intuitive, well-tested framework to migrate from point A to point B (or vice-versa if going down).

In other words, we take care of WHICH migrations are run and in what ORDER. Everything else is left up to the implementation:

  • WHAT is going to be migrated? It could be a database, images, documents, etc.
  • HOW its going to be migrated? You can wrap each migration into DB transactions. Or not, its up to you.
  • What to do when a migration fails? We'll let you know WHEN it happens, but its up to you to the implementation to decide what to do (e.g. cancel the transaction).

Installation (Composer)

Installation with Composer is simple:

composer require baleen/migrations

Documentation

For more documentation please refer to the online documentation.

Contributing

See CONTRIBUTING.md

LICENSE

MIT - for more details please refer to LICENSE at the root directory.

About the name

We named the project ("BALEEN") after a family (or "parvorders" to be precise) of whales that are famous for migrating long distances. The humpback whale, for example, travels as far as 16,000 miles (25749.5 km) annually. That's about twice the earth's diameter.

About

Flexible migrations library with the goal of providing a solid foundation for more concrete (e.g. database-specific) implementations. I can also be run autonomously for simple tasks.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%