tworzenieweb/sql-provisioner

Simple CLI tool for validating SQL files before inserting them into DB.

, _(*1)

, _(*2)

SQL Provisioner

Simple CLI tool for database changes deploying. It allows to review each dbdeploy file before executution., _(*3)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system., _(*4)

Prerequisites

To use this library, you would need to have composer installed and have a table for storing already performed DB deploys. Lastly, you would need to provide .env file with connection information and table and column name for checks, _(*5)

DATABASE_USER=[user]
DATABASE_PASSWORD=[password]
DATABASE_HOST=[host]
DATABASE_PORT=[port]
DATABASE_NAME=[database]
PROVISIONING_TABLE=changelog_database_deployments
PROVISIONING_TABLE_CANDIDATE_NUMBER_COLUMN=deploy_script_number

Installing

It installs just like any other composer project, _(*6)

composer require tworzenieweb/sql-provisioner

Then you should be able to run command from vendor/bin/sql-provisioner, _(*7)

vendor/bin/sql-provisioner /location/to/your/sql/files

Using

The vendor/bin/sql-provisioner [path-to-folder] command will scan the content of [path-to-folder] directory., _(*8)

The script will look for .env file containing connection information in format:, _(*9)

DATABASE_USER=[user]
DATABASE_PASSWORD=[password]
DATABASE_HOST=[host]
DATABASE_PORT=[port]
DATABASE_NAME=[database]
PROVISIONING_TABLE=changelog_database_deployments
PROVISIONING_TABLE_CANDIDATE_NUMBER_COLUMN=deploy_script_number

If you want to create initial .env use --init, _(*10)

vendor/bin/sql-provisioner --init [path-to-folder], _(*11)

The next step is searching for sql files and trying to queue them in numerical order. First n-th digits of a filename will be treated as candidate number. This will be used then to check in database if a certain file was already deployed (PROVISIONING_TABLE_CANDIDATE_NUMBER_COLUMN). Before the insert, it will print the formatted output of a file and result of internal syntax check. Then you can either skip or execute each., _(*12)

If you would like to skip already provisioned candidates use --skip-provisioned If you would like to skip syntax checking (for speed purpose) of candidates use --skip-syntax-check, _(*13)

Demo

This is cinerama demo of usage, _(*14)

, _(*15)

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository., _(*16)

Authors

• Luke Adamczewski - Initial work - tworzenieweb

License

This project is licensed under the MIT License - see the LICENSE.md file for details, _(*17)