pm-connect/db-diff

A simple php based tool/application for comparing and generating a diff/comparison of any two given databases. Supports multiple database drivers.

DB Diff

A simple php based database structure diff tool that you can self host., _(*1)

Looking to build a diff tool your self? Check out db-diff-utils., _(*2)

, _(*3)

Installation

Installation can be done through either composer, or using docker., _(*4)

Using Composer

You will need to install the project using a web server using php7+., _(*5)

composer create-project --prefer-dist pm-connect/db-diff db-diff

Using Docker

There is an available docker image and docker file with this project that will give you a running application within seconds., _(*6)

Either create a machine from the jralph/db-diff docker image, or run the Dockerfile and create your own., _(*7)

Note: When using docker to run the diff application, diffs will be run using the sync queue. This means that you will only be able to run one diff at a time and may be limited to the http request duration., _(*8)

Docker Hub, _(*9)

Config

You will need to set a database configuration to save the diff logs, this is done in a .env file, which you will need to create. An example is provided below., _(*10)

Once done, you will also need to run the migrations., _(*11)

php artisan migrate

You can also optionally setup a queue to enable better performance for diff running., _(*12)

Example .env File

APP_ENV=local
APP_KEY=base64:1v0HsWYBr3Onmy5WNqIIs2/s3d0moHRg9IPK4ZD0/rY=
APP_DEBUG=true
APP_LOG_LEVEL=debug
APP_URL=http://db-diff.dev

DB_CONNECTION=sqlite

QUEUE_DRIVER=database

BROADCAST_DRIVER=log
CACHE_DRIVER=file
SESSION_DRIVER=file
QUEUE_DRIVER=sync

Queues

If you opt to use a queue driver that is not sync, you will need to run the build-in queue worker through the command line., _(*13)

php artisan queue:listen --queue=default --timeout=120

You may also want to set the timeout to a greater value, depending on the size of the databases you are planning to diff. Generally a 60 second timeout works well in most cases., _(*14)

For more information on running queue workers, please see here., _(*15)

Issues

Please submit any issues using GitHubs build in issue management., _(*16)