persistent-migration-0.1.0: Manual migrations for the persistent library

Maintainer	Brandon Chinn <brandonchinn178@gmail.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Database.Persist.Migration.Core

Description

Defines a migration framework for the persistent library.

Synopsis

newtype MigrateSettings = MigrateSettings {
- versionToLabel :: Version -> Maybe String
}
defaultSettings :: MigrateSettings
validateMigration :: Migration -> Either String ()
runMigration :: MonadIO m => MigrateBackend -> MigrateSettings -> Migration -> SqlPersistT m ()
getMigration :: MonadIO m => MigrateBackend -> MigrateSettings -> Migration -> SqlPersistT m [MigrateSql]

Documentation

newtype MigrateSettings Source #

Settings to customize migration steps.

Constructors

MigrateSettings
Fields versionToLabel :: Version -> Maybe String A function to optionally label certain versions

defaultSettings :: MigrateSettings Source #

Default migration settings.

validateMigration :: Migration -> Either String () Source #

Validate the given migration.

runMigration :: MonadIO m => MigrateBackend -> MigrateSettings -> Migration -> SqlPersistT m () Source #

Run the given migration. After successful completion, saves the migration to the database.

getMigration :: MonadIO m => MigrateBackend -> MigrateSettings -> Migration -> SqlPersistT m [MigrateSql] Source #

Get the SQL queries for the given migration.