startx/sqlup repository overview

sqlup for sql upgrade is an an open-source job container who apply sql patch to a database following a sequentially versionned plan. Very light (application less than 100Ko, full container stack for less than 30Mo) application configured with a single json file, to deploy and follow update lifecycle of a database stored in mysql, posgresql or dynamodb backend.

⁠Getting Started

• container image⁠ published in dockerhub public registry. The simplest and fastest way to execute a sqlup job is to use the public docker image. For more information on how to run your first sqlup job using sqlup docker image, please read the docker image user guide⁠
• npm module⁠ published in npm public database. If you plan to sqlup into another application, you should be more interested by the npm method. For more information on how to run your first sqlup job using sqlup npm module, please read the npm module user guide⁠
• source code⁠ published in github. If you plan to extend sqlup capabilities with your own component, change default software design, extend core functinalities or more globaly improve this application, please read the source code user guide⁠

⁠Want to try ?

• Docker user guide⁠
• NodJS user guide⁠
• Source code user guide⁠

⁠Documentation

If you want to have more information on how to install, develop and run this framework and use it in your project, please read the full documentation⁠ or our user guides⁠ and execute the following steps :

1. Install sqlup⁠
2. Configure sqlup⁠
3. Run your job⁠

⁠Troubleshooting

If you run into difficulties installing or running sqlup, you can create an issue⁠.

⁠Built With

• docker⁠ - Container plateform
• alpine⁠ - OS envelop
• nodejs⁠ - Application server

⁠Contributing

Read the contributing guide⁠ for details on our code of conduct, and the process for submitting pull requests to us.

⁠Authors

This project is mainly developped by the startx⁠ dev team. You can see the complete list of contributors who participated in this project by reading CONTRIBUTORS.md⁠.

⁠License

This project is licensed under the GPL Version 3 - see the LICENSE.md⁠ file for details