WIP

Description

Tool compares schemas defined in .sql files (CREATE TABLE statements) to live mysql server database.

USE ..., CREATE DATABASE..., DROP ... statements, single line and multiline comments are allowed in definitions and ignored.

Supported syntax/features

Mysql 5.x only atm.

• Tables
  • Columns with all data types
  • Indexes
  • Foreign keys
• Triggers
  • Whole body text compared
  • Body should be always enclosed in BEGIN ... END even if it is a single statement
  • Requires delimiter to be $$ (hardcoded in parser).
• Stored procedures
  • Whole body text compared
  • Requires delimiter to be $$ (hardcoded in parser).
• Views
  • Whole body text compared

Expected triggers and stored procedures bodies could contain comments. If they aren't present in target database they will be reported as differences. Make sure you import these objects to the db with --comments specified to preserve comments in target db. Like

mysql --host=localhost --port=3306 --user=root --password=root --database=db --comments < db-triggers.sql

CLI

$ mysql-schema-compare <options> <.sql files>

Database Options

| Parameter | Description | |-----------|-------------| | --db-host string | Database server host name | | --db-port string | Database server port (default 3306) | | --db-user string | User name for database connection (default root) | | --db-pass string | Password for database connection (default root) | | --db-name string | Schema name of database server | | --schema string | You can specify list of sql files explicitly with this parameter |

Processing options

| Parameter | Description | |-----------|-------------| | --err-extra true/false | Treat items not described in definitions but present in database as error (default false) |

Mics options

| Parameter | Description | |-----------|-------------| | --help | Displays this CLI usage help |

Same options are also configurable with environment variables or .env file

| Env variable name | Description | Default value | |---|---|---| | DB_HOST | Corresponds to --db-host option | | DB_PORT | Corresponds to --db-port option | | DB_USER | Corresponds to --db-user option | | DB_PASS | Corresponds to --db-pass option | | DB_NAME | Corresponds to --db-name option | | SCHEMA | Comma separate list of .sql files | | ERR_EXTRA | Corresponds to --err-extra option | | FULL_DIFFS | Include full body text in difference view when true | false | | IGNORE_COMMENTS | Ignores one line comment changes then true | true |

Error codes

| Code | Meaning | |------|---------| | 0 | Everything is fine, schemas match | | 1 | Schemas differ | | 5 | Definitions parsing error (could happen when parsing database actual schema if unsupported element encountered) | | 8 | Invalid configuration. Most probabl some required parameter is missing | | 10 | Exception. Please report this as issue |