Copyright	(c) 2016 Timo von Holtz <[email protected]> (c) 2014 Andreas Meingast <[email protected]>
License	BSD-style
Maintainer	[email protected]
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Hasql.Migration

Contents

Migration actions
Migration types
Migration result actions
Migration result types

Description

A migration library for hasql.

Synopsis

Migration actions

runMigration :: MigrationCommand -> Transaction (Maybe MigrationError) Source #

Executes a MigrationCommand.

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

loadMigrationFromFile :: ScriptName -> FilePath -> IO MigrationCommand Source #

load a migration from script located at the provided FilePath.

loadMigrationsFromDirectory :: FilePath -> IO [MigrationCommand] Source #

Load migrations from SQL scripts in the provided FilePath in alphabetical order.

Migration types

data MigrationCommand Source #

MigrationCommand determines the action of the runMigration script.

Constructors

MigrationInitialization	Initializes the database with a helper table containing meta information.
MigrationScript ScriptName ByteString	Executes a migration based on the provided bytestring.
MigrationValidation MigrationCommand	Validates the provided MigrationCommand.

Instances

Instances details

Read MigrationCommand Source #
Instance details Defined in Hasql.Migration Methods readsPrec :: Int -> ReadS MigrationCommand # readList :: ReadS [MigrationCommand] # readPrec :: ReadPrec MigrationCommand # readListPrec :: ReadPrec [MigrationCommand] #
Show MigrationCommand Source #
Instance details Defined in Hasql.Migration Methods showsPrec :: Int -> MigrationCommand -> ShowS # show :: MigrationCommand -> String # showList :: [MigrationCommand] -> ShowS #
Eq MigrationCommand Source #
Instance details Defined in Hasql.Migration Methods (==) :: MigrationCommand -> MigrationCommand -> Bool # (/=) :: MigrationCommand -> MigrationCommand -> Bool #
Ord MigrationCommand Source #
Instance details Defined in Hasql.Migration 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 #

data MigrationError Source #

Errors that could occur when a migration is validated or performed

Constructors

ScriptChanged String
NotInitialised
ScriptMissing String
ChecksumMismatch String

Instances

Instances details

Read MigrationError Source #
Instance details Defined in Hasql.Migration Methods readsPrec :: Int -> ReadS MigrationError # readList :: ReadS [MigrationError] # readPrec :: ReadPrec MigrationError # readListPrec :: ReadPrec [MigrationError] #
Show MigrationError Source #
Instance details Defined in Hasql.Migration Methods showsPrec :: Int -> MigrationError -> ShowS # show :: MigrationError -> String # showList :: [MigrationError] -> ShowS #
Eq MigrationError Source #
Instance details Defined in Hasql.Migration Methods (==) :: MigrationError -> MigrationError -> Bool # (/=) :: MigrationError -> MigrationError -> Bool #
Ord MigrationError Source #
Instance details Defined in Hasql.Migration Methods compare :: MigrationError -> MigrationError -> Ordering # (<) :: MigrationError -> MigrationError -> Bool # (<=) :: MigrationError -> MigrationError -> Bool # (>) :: MigrationError -> MigrationError -> Bool # (>=) :: MigrationError -> MigrationError -> Bool # max :: MigrationError -> MigrationError -> MigrationError # min :: MigrationError -> MigrationError -> MigrationError #

type ScriptName = String Source #

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

type Checksum = Text Source #

The checksum type of a migration script.

Migration result actions

getMigrations :: Transaction [SchemaMigration] Source #

Produces a list of all executed SchemaMigrations.

Migration result types

data SchemaMigration Source #

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

Instances details

Read SchemaMigration Source #
Instance details Defined in Hasql.Migration Methods readsPrec :: Int -> ReadS SchemaMigration # readList :: ReadS [SchemaMigration] # readPrec :: ReadPrec SchemaMigration # readListPrec :: ReadPrec [SchemaMigration] #
Show SchemaMigration Source #
Instance details Defined in Hasql.Migration Methods showsPrec :: Int -> SchemaMigration -> ShowS # show :: SchemaMigration -> String # showList :: [SchemaMigration] -> ShowS #
Eq SchemaMigration Source #
Instance details Defined in Hasql.Migration Methods (==) :: SchemaMigration -> SchemaMigration -> Bool # (/=) :: SchemaMigration -> SchemaMigration -> Bool #
Ord SchemaMigration Source #
Instance details Defined in Hasql.Migration 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 #