Copyright	(c) 2014 Andreas Meingast <ameingast@gmail.com>
License	BSD-style
Maintainer	ameingast@gmail.com
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Database.PostgreSQL.Simple.Migration

Contents

Description

A migration library for postgresql-simple.

For usage, see Readme.markdown.

Synopsis

Migration actions

Executes migrations inside the provided MigrationContext.

Returns MigrationSuccess if the provided MigrationCommand executes without error. If an error occurs, execution is stopped and a MigrationError is returned.

It is recommended to wrap runMigration inside a database transaction.

Migration types

The MigrationContext provides an execution context for migrations.

Constructors

MigrationContext
Fields migrationContextCommand :: MigrationCommand The action that will be performed by `runMigration` migrationContextVerbose :: Bool Verbosity of the library. migrationContextConnection :: Connection The PostgreSQL connection to use for migrations.

MigrationCommand determines the action of the runMigration script.

Constructors

MigrationInitialization	Initializes the database with a helper table containing meta information.
MigrationDirectory FilePath	Executes migrations based on SQL scripts in the provided `FilePath` in alphabetical order.
MigrationFile ScriptName FilePath	Executes a migration based on script located at the provided `FilePath`.
MigrationScript ScriptName ByteString	Executes a migration based on the provided bytestring.
MigrationValidation MigrationCommand	Validates the provided MigrationCommand.

Instances

Eq MigrationCommand Source #
Methods (==) :: MigrationCommand -> MigrationCommand -> Bool # (/=) :: MigrationCommand -> MigrationCommand -> Bool #
Ord MigrationCommand Source #
Methods compare :: MigrationCommand -> MigrationCommand -> Ordering # (<) :: MigrationCommand -> MigrationCommand -> Bool # (<=) :: MigrationCommand -> MigrationCommand -> Bool # (>) :: MigrationCommand -> MigrationCommand -> Bool # (>=) :: MigrationCommand -> MigrationCommand -> Bool # max :: MigrationCommand -> MigrationCommand -> MigrationCommand # min :: MigrationCommand -> MigrationCommand -> MigrationCommand #
Read MigrationCommand Source #
Methods readsPrec :: Int -> ReadS MigrationCommand # readList :: ReadS [MigrationCommand] # readPrec :: ReadPrec MigrationCommand # readListPrec :: ReadPrec [MigrationCommand] #
Show MigrationCommand Source #
Methods showsPrec :: Int -> MigrationCommand -> ShowS # show :: MigrationCommand -> String # showList :: [MigrationCommand] -> ShowS #

A sum-type denoting the result of a migration.

Constructors

MigrationError a	There was an error in script migration.
MigrationSuccess	All scripts have been executed successfully.

Instances

Eq a => Eq (MigrationResult a) Source #
Methods (==) :: MigrationResult a -> MigrationResult a -> Bool # (/=) :: MigrationResult a -> MigrationResult a -> Bool #
Ord a => Ord (MigrationResult a) Source #
Methods compare :: MigrationResult a -> MigrationResult a -> Ordering # (<) :: MigrationResult a -> MigrationResult a -> Bool # (<=) :: MigrationResult a -> MigrationResult a -> Bool # (>) :: MigrationResult a -> MigrationResult a -> Bool # (>=) :: MigrationResult a -> MigrationResult a -> Bool # max :: MigrationResult a -> MigrationResult a -> MigrationResult a # min :: MigrationResult a -> MigrationResult a -> MigrationResult a #
Read a => Read (MigrationResult a) Source #
Methods readsPrec :: Int -> ReadS (MigrationResult a) # readList :: ReadS [MigrationResult a] # readPrec :: ReadPrec (MigrationResult a) # readListPrec :: ReadPrec [MigrationResult a] #
Show a => Show (MigrationResult a) Source #
Methods showsPrec :: Int -> MigrationResult a -> ShowS # show :: MigrationResult a -> String # showList :: [MigrationResult a] -> ShowS #

The name of a script. Typically the filename or a custom name when using Haskell migrations.

The checksum type of a migration script.

Produces a list of all executed SchemaMigrations.

A product type representing a single, executed SchemaMigration.

Constructors

SchemaMigration
Fields schemaMigrationName :: ByteString The name of the executed migration. schemaMigrationChecksum :: Checksum The calculated MD5 checksum of the executed script. schemaMigrationExecutedAt :: LocalTime A timestamp without timezone of the date of execution of the script.

Instances

Eq SchemaMigration Source #
Methods (==) :: SchemaMigration -> SchemaMigration -> Bool # (/=) :: SchemaMigration -> SchemaMigration -> Bool #
Ord SchemaMigration Source #
Methods compare :: SchemaMigration -> SchemaMigration -> Ordering # (<) :: SchemaMigration -> SchemaMigration -> Bool # (<=) :: SchemaMigration -> SchemaMigration -> Bool # (>) :: SchemaMigration -> SchemaMigration -> Bool # (>=) :: SchemaMigration -> SchemaMigration -> Bool # max :: SchemaMigration -> SchemaMigration -> SchemaMigration # min :: SchemaMigration -> SchemaMigration -> SchemaMigration #
Read SchemaMigration Source #
Methods readsPrec :: Int -> ReadS SchemaMigration # readList :: ReadS [SchemaMigration] # readPrec :: ReadPrec SchemaMigration # readListPrec :: ReadPrec [SchemaMigration] #
Show SchemaMigration Source #
Methods showsPrec :: Int -> SchemaMigration -> ShowS # show :: SchemaMigration -> String # showList :: [SchemaMigration] -> ShowS #
ToRow SchemaMigration Source #
Methods toRow :: SchemaMigration -> [Action] #
FromRow SchemaMigration Source #
Methods fromRow :: RowParser SchemaMigration #