File: README.md

Recommend this page to a friend!
  Classes of Shabeer ALi M  >  PHP MySQL Scheman  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP MySQL Scheman
Make MySQL database schema changes generating SQL
Author: By
Last change:
Date: 2 months ago
Size: 1,760 bytes
 

Contents

Class file image Download

MySQL Scheman

MySQL schema, a simple MySQL schema synchronization utility. This will create an UPDATE/ADD query automatically based on the schema difference in the database and schema file.

Build

Why we use MySQL Scheman

Developers find it very hard to synchronize MySQL schema while developing any application. The current conventional method is to create an SQL file with all the changes & update it in the staging/production server. The main demerit of this method is if there are multiple people and multiple SQL changes on the same table the process is a bit hectic. In order to solve this, we developed a platform where you can update the schema in a file, and by running sync to database it will create the SQL Query for the changes and it will execute.

Installation

If you use Composer, you can install MySQL Scheman with the following command:


Or alternatively, include a dependency for MySQL Scheman in your composer.json file. For example

{

"require-dev": {
    "smart-php/mysql-scheman": "dev-master"
}

}


### Config

A database configuration file should be there to communicate with the database. Please see the sample files and create a copy in your working directory with your database credentials.

JSON: config.json
XML: config.xml

### Usage (CLI)

To CLI Help

./vendor/bin/scheman --help


Exporting Database to Schema File:

./vendor/bin/scheman --config config.json --export yourdatabase.json


Sync the file schema with your database

./vendor/bin/scheman --config config.json --sync yourdatabase.json


## License
See the `LICENSE` file.
For more information send a message to info at phpclasses dot org.