Module documentation for 1.1.1
This package contains a library and program for the creation, management, and installation of schema updates (called “migrations”) for a relational database. In particular, this package lets the migration author express explicit dependencies between migrations and the management tool automatically installs or reverts migrations accordingly, using transactions for safety.
This package operates on two logical entities:
The “backend”, which is the relational database whose schema you want to manage.
The “migration store” (or simply “store”), which is the collection of schema changes you want to apply to the database. These migrations are expressed using plain text files collected together in a single directory, although the library is general enough to permit easy implementation of other storage backends for migrations.
Getting started with dbmigrations
This package includes one program, “moo”. See MOO.TXT for details on how to use this tool to manage your database migrations.
If you’ve obtained this package in source form and would like to
install it, you’ll need the “cabal” program. To install this package
from the source directory, run
I’ll gladly consider accepting patches to this package; please do not hesitate to submit GitHub pull requests. I’ll be more likely to accept a patch if you can follow these guidelines where appropriate:
Keep patches small; a single patch should make a single logical change with minimal scope.
If possible, include tests with your patch.
If possible, include haddock with your patch.