Skip to content
Deckard is a framework agnostic tool for running database migrations.
Branch: master
Clone or download
Latest commit 8a787b6 Jun 18, 2019

README.md

Deckard

Build Status Maintainability

A framework agnostic tool for running database migrations.

Currently, Deckard only supports MySQL & Postgres. More databases coming soon!

Usage

deckard create add_login_date_to_users
# modify the created files
deckard up --host=localhost --port=5432 --user=user --password=pass --database=app
deckard down --host=localhost --port=5432 --user=user --password=pass --database=app

TODO LIST:

  • Up Migrations for Postgres
  • Down Migrations for Postgres
  • Verify integrity for Postgres
  • Create new migrations from Deckard
  • Allow reading from Config file instead of cmd flags
  • Support for MySQL

Managing your databases via YAML config.

Deckard also supports managing your databases via YAML. Instead of writing

deckard up --host=localhost --port=5432 --user=user --password=pass --database=app

You can simply write

deckard up --key=prod

provided you have a a .deckard.yml in your home directory. In this instance, your YAML should look like this:

prod:
    host: localhost
    port: 5432
    user: user
    password: pass
    database: app
    driver: postgres

Alternatively, you can provide deckard the path to the configuration value you want to use.

deckard up --config=/usr/app/deckard.yml --key=prod

Verifying a migration was ran against the database.

Sometimes, you may find yourself curious if the migration was ran against the DB. You certainly can fire up your favorite database client and query for the metadata entry (or the schema change!), but Deckard also allows you to verify that a given migration has been ran against a given database. Simply use deckard verify ~/path/to/my/migration.up.sql and deckard will verify that that migration has been ran. A word of warning: We simply check to ensure the metadata table contains a matching entry for the migration. Basically, deckard is only verifying that the migration has been applied in the "UP" position. It won't verify that the schema is currently matching the changes that were introduced in that migration.

The Ups and Downs of Deckard

Before we ever run an up or a down migration, we have to verify that a metadata table exists and create it if it does not.

Deckard uses this metadata to keep track of what has and has not been ran via Deckard. Deckard works best when all schema changes are ran via migrations, and can not infer changes made outside of the Deckard toolchain.

When we run an up migration, we validate our database state against our metadata to figure out which migrations need to be ran. The same goes with down migrations as well. Finally, the up and down migrations additionally create or remove a row in the metadata table. If, for some reason, Deckard was to blow up after running a query but before successfully modifying the metadata table, you'll be able to get deckard back on the right path with a 1 row update. I say this as a caveat, but I've not yet ran into this issue.

Running a select number of migrations

Often times, especially with Down migrations, you'll only want to run 1 migration, or maybe a set number of migrations. To do so, you can use the steps flag. For example, If I only want to run the down query for the last migration ran, I can run:

deckard down --config=myconfig.deckard.yml --key=myDbKey --steps=1

Issues on Deckard

I use Github issues to track small improvements and work for Deckard. Additionally, issues are a great place for questions to be asked. Please check there if you have questions, concerns or are running into issues with the tool.

Contributing

More to come soon.

For now, throwaway DBs can be created via the following docker commands:

Postgres
docker run -e "POSTGRES_USER=test" -e "POSTGRES_PASSWORD=test" -e "POSTGRES_DB=test_db" -p "5432:5432" postgres
MySQL
docker run --name mysql -p "3306:3306" -e MYSQL_ROOT_PASSWORD=test -e MYSQL_DATABASE=test_db mysql:8
You can’t perform that action at this time.