What is Compalex?
Compalex is a lightweight script to compare two database schemas. It supports MySQL, MS SQL Server and PostgreSQL.
View project on https://github.com/dlevsha/compalex/
How to use
The easiest way to use Compalex is to use Docker.
You can build your own container using Dockerfile or use Docker Hub image:
docker run -it -e DATABASE_DRIVER='mysql' \
-e DATABASE_ENCODING='utf8' \
-e SAMPLE_DATA_LENGTH='100' \
-e DATABASE_HOST='host.docker.internal' \
-e DATABASE_PORT='3306' \
-e DATABASE_NAME='compalex_dev' \
-e DATABASE_USER='root' \
-e DATABASE_PASSWORD='password' \
-e DATABASE_DESCRIPTION='Developer database' \
-e DATABASE_HOST_SECONDARY='host.docker.internal' \
-e DATABASE_PORT_SECONDARY='3306' \
-e DATABASE_NAME_SECONDARY='compalex_prod' \
-e DATABASE_USER_SECONDARY='root' \
-e DATABASE_PASSWORD_SECONDARY='password' \
-e DATABASE_DESCRIPTION_SECONDARY='Production database' \
-p 8000:8000 dlevsha/compalex
You need to change variables for your own
DATABASE_DRIVER
- database driver, possible value
mysql
- for MySQL databasepgsql
- for PostgreSQL databasedblib
- for Microsoft SQL Server databaseoci
- for Oracle database[ Primary connection params ]
and [ Secondary connection params ]
sections describes settings for first and second databases.
Where
DATABASE_HOST
and DATABASE_HOST_SECONDARY
- database host name or IP for first and second server
DATABASE_PORT
and DATABASE_PORT_SECONDARY
- database port for first and second server
DATABASE_NAME
and DATABASE_NAME_SECONDARY
- first and second database name
DATABASE_USER
/ DATABASE_PASSWORD
and DATABASE_USER_SECONDARY
/ DATABASE_PASSWORD_SECONDARY
- login and password to access your databases
DATABASE_DESCRIPTION
and DATABASE_DESCRIPTION_SECONDARY
- server description (not necessary). For information only. These names will display as a database name.
Then you start container open the browser and go to http://localhost:8000
.
Why we use host.docker.internal
instead of localhost
in environment param (if your database run locally)?
Because we run script inside container we need to use Host machine IP for connection (for Mac and Windows user).
If you connect to external IP use: -e DATABASE_HOST='[Your external IP]'
.
You can also use docker-compose.yml
.
version: "3.7"
services:
compalex:
image: dlevsha/compalex
container_name: compalex
environment:
- DATABASE_DRIVER=mysql
- DATABASE_ENCODING=utf8
- SAMPLE_DATA_LENGTH=100
- DATABASE_HOST=host.docker.internal
- DATABASE_PORT=3306
- DATABASE_NAME=compalex_dev
- DATABASE_USER=root
- DATABASE_PASSWORD=password
- DATABASE_DESCRIPTION=Developer database
- DATABASE_HOST_SECONDARY=host.docker.internal
- DATABASE_PORT_SECONDARY=3306
- DATABASE_NAME_SECONDARY=compalex_prod
- DATABASE_USER_SECONDARY=root
- DATABASE_PASSWORD_SECONDARY=password
- DATABASE_DESCRIPTION_SECONDARY=Production database
ports:
- "8000:8000"
Requirements
If you prefer use Compalex as PHP script please read instruction bellow.
Compalex is only supported by PHP 5.4 and up with PDO extension.
Installation
$ git clone https://github.com/dlevsha/compalex.git $ cd compalex
or you can download latest version here.
Open .environment
. You'll see configuration params
[ Main settings ] ; Possible DATABASE_DRIVER: 'mysql', 'pgsql', 'dblib'. ; Please use 'dblib' for Microsoft SQL Server DATABASE_DRIVER = mysql DATABASE_ENCODING = utf8 SAMPLE_DATA_LENGTH = 100 [ Primary connection params ] DATABASE_HOST = localhost DATABASE_NAME = compalex_dev DATABASE_USER = root DATABASE_PASSWORD = DATABASE_DESCRIPTION = Developer database [ Secondary connection params ] DATABASE_HOST_SECONDARY = localhost DATABASE_NAME_SECONDARY = compalex_prod DATABASE_USER_SECONDARY = root DATABASE_PASSWORD_SECONDARY = DATABASE_DESCRIPTION_SECONDARY = Production database
where
DATABASE_DRIVER
- database driver, possible value
mysql
- for MySQL databasepgsql
- for PostgreSQL databasedblib
- for Microsoft SQL Server database[ Primary connection params ]
and [ Secondary connection params ]
sections describes settings for first and second databases.
Where
DATABASE_HOST
and DATABASE_HOST_SECONDARY
- database host name or IP for first and second server
DATABASE_NAME
and DATABASE_NAME_SECONDARY
- first and second database name
DATABASE_USER
/ DATABASE_PASSWORD
and DATABASE_USER_SECONDARY
/ DATABASE_PASSWORD_SECONDARY
- login and password to access your databases
DATABASE_DESCRIPTION
and DATABASE_DESCRIPTION_SECONDARY
- server description (not necessary). For information only. These names will display as a database name.
Inside compalex
directory run
$ php -S localhost:8000
Now open your browser and type http://localhost:8000/
You'll see database schema of two compared databases.
Run in terminal
You can run this script in terminal (for example, if you don't have direct connection to database).
I recommend eLinks (free text-based console web browser) because it supports HTML-formatting and colors.
Install the script and run web-server as described above on your server.
Then run:
$ elinks http://localhost:8000
You'll see database schema in your terminal