Database.PostgreSQL.Simple.Migration

Migration library for postgresql-simple.

Documentation

runMigration :: MigrationContext -> IO (MigrationResult String)

Executes migrations inside the provided MigrationContext.

data MigrationContext

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.

data MigrationCommand

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.

Instances

Eq MigrationCommand

Ord MigrationCommand

Read MigrationCommand

Show MigrationCommand

data MigrationResult a

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)

Ord a => Ord (MigrationResult a)

Read a => Read (MigrationResult a)

Show a => Show (MigrationResult a)

type ScriptName = String

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