GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02
Modulepostgresql-simple-migration-0.1.15.0Haskell2010
A migration library for postgresql-simple.
For usage, see Readme.markdown.
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.
runMigrations :: BoolRun in verbose mode
-> ConnectionThe postgres connection to use
-> [MigrationCommand]The commands to run
-> IO (MigrationResult String)Execute a sequence of migrations
Returns MigrationSuccess if all of the provided MigrationCommands execute without error. If an error occurs, execution is stopped and the MigrationError is returned.
It is recommended to wrap runMigrations inside a database transaction.
Run a sequence of contexts, stopping on the first failure
The MigrationContext provides an execution context for migrations.
MigrationContextmigrationContextCommand :: MigrationCommandThe action that will be performed by runMigration
migrationContextVerbose :: BoolVerbosity of the library.
migrationContextConnection :: ConnectionThe PostgreSQL connection to use for migrations.
MigrationCommand determines the action of the runMigration script.
MigrationInitializationInitializes the database with a helper table containing meta information.
MigrationDirectory FilePathExecutes migrations based on SQL scripts in the provided FilePath in alphabetical order.
MigrationFile ScriptName FilePathExecutes a migration based on script located at the provided FilePath.
MigrationScript ScriptName ByteStringExecutes a migration based on the provided bytestring.
MigrationValidation MigrationCommandValidates that the provided MigrationCommand has been executed.
MigrationCommands [MigrationCommand]Performs a series of MigrationCommands in sequence.
Eq MigrationCommandDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationOrd MigrationCommandDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationRead MigrationCommandDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationShow MigrationCommandDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationSemigroup MigrationCommandDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationMonoid MigrationCommandDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationA sum-type denoting the result of a migration.
MigrationError aThere was an error in script migration.
MigrationSuccessAll scripts have been executed successfully.
Functor MigrationResultDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationFoldable MigrationResultDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationTraversable MigrationResultDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationEq a => Eq (MigrationResult a)Defined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationOrd a => Ord (MigrationResult a)Defined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationRead a => Read (MigrationResult a)Defined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationShow a => Show (MigrationResult a)Defined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationThe 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.
SchemaMigrationschemaMigrationName :: ByteStringThe name of the executed migration.
schemaMigrationChecksum :: ChecksumThe calculated MD5 checksum of the executed script.
schemaMigrationExecutedAt :: LocalTimeA timestamp without timezone of the date of execution of the script.
Eq SchemaMigrationDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationOrd SchemaMigrationDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationRead SchemaMigrationDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationShow SchemaMigrationDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationFromRow SchemaMigrationDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.MigrationToRow SchemaMigrationDefined in postgresql-simple-migration-0.1.15.0 · Database.PostgreSQL.Simple.Migration