soong/soong

Common interface for data migration

0.7.0 2019-06-25 10:11 UTC

This package is auto-updated.

Last update: 2020-10-09 21:53:10 UTC


README

Latest Version on Packagist Software License Coverage Status Quality Score Total Downloads

Soong is a framework for building robust Extract-Transform-Load (ETL) applications for performing data migration. It is designed to be record-oriented and configuration-driven - most applications will require little or no custom PHP code, and tools can easily customize (or create) data migration processes implemented by Soong.

Documentation is at https://soong-etl.readthedocs.io/.

This project adheres to Semantic Versioning. For major version 0, we will increment the minor version for backward-incompatible changes. At this pre-release point, the interfaces are still changing regularly - if you develop any applications using Soong be sure to pin them to the minor release.

soong/soong began as a standalone repository, containing all components developed for soong so far as well as sample migrations (see Demos below). The component implementations are now being broken out into separate smaller libraries - soong/soong itself may end up containing only the interfaces (contracts), or (more likely) also basic implementations for the most widely-needed components.

Install

Soong is best installed using Composer. Since as noted above while in major version 0 minor versions will contain backward-incompatible changes, and at this point the interfaces are still changing regularly, if you develop any applications using Soong be sure to pin them to the minor release you implemented them with. E.g., "~0.5.0" which will get the latest release with major.minor version 0.5 and prevent updating to a 0.6.x release which may break your application.

$ composer require soong/soong "~0.5.0"

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

There's still a lot of refinement to be done to Soong - this is your opportunity to get involved with a new framework (and community) on the ground floor! As mentioned above, the plan is ultimately to break out components into small well-contained libraries - these will be excellent opportunities to get your feet wet maintaining your own open-source project.

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email soong@virtuoso-performance.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.