Safe Haskell	None
Language	Haskell2010

Drifter

Contents

Managing Migrations
Types

Synopsis

resolveDependencyOrder :: [Change a] -> [Change a]
changeSequence :: [Change a] -> [Change a]
migrate :: Drifter a => DBConnection a -> [Change a] -> IO (Either String ())
class Drifter a where
- migrateSingle :: DBConnection a -> Change a -> IO (Either String ())
newtype ChangeName = ChangeName {
- changeNameText :: Text
}
data Change a = Change {
- changeName :: ChangeName
- changeDescription :: Maybe Description
- changeDependencies :: [ChangeName]
- changeMethod :: Method a
}
type Description = Text
data family Method a
data family DBConnection a

Managing Migrations

resolveDependencyOrder :: [Change a] -> [Change a] Source #

Take an unordered list of changes and put them in dependency order. migrate will do this automatically.

changeSequence :: [Change a] -> [Change a] Source #

This is a helper for the common case of where you just want dependencies to run in list order. This will take the input list and set their dependencies to run in the given sequence.

migrate :: Drifter a => DBConnection a -> [Change a] -> IO (Either String ()) Source #

Runs a list of changes. They will automatically be sorted and run in dependency order. Will terminate early on error.

Types

class Drifter a where Source #

Methods

migrateSingle :: DBConnection a -> Change a -> IO (Either String ()) Source #

How to run a single, isolated migration.

newtype ChangeName Source #

Constructors

ChangeName
Fields changeNameText :: Text

Instances

Instances details

Eq ChangeName Source #
Instance details Defined in Drifter.Types Methods (==) :: ChangeName -> ChangeName -> Bool # (/=) :: ChangeName -> ChangeName -> Bool #
Ord ChangeName Source #
Instance details Defined in Drifter.Types Methods compare :: ChangeName -> ChangeName -> Ordering # (<) :: ChangeName -> ChangeName -> Bool # (<=) :: ChangeName -> ChangeName -> Bool # (>) :: ChangeName -> ChangeName -> Bool # (>=) :: ChangeName -> ChangeName -> Bool # max :: ChangeName -> ChangeName -> ChangeName # min :: ChangeName -> ChangeName -> ChangeName #
Show ChangeName Source #
Instance details Defined in Drifter.Types Methods showsPrec :: Int -> ChangeName -> ShowS # show :: ChangeName -> String # showList :: [ChangeName] -> ShowS #

data Change a Source #

Constructors

Change
Fields changeName :: ChangeName changeDescription :: Maybe Description changeDependencies :: [ChangeName] changeMethod :: Method a

type Description = Text Source #

data family Method a Source #

data family DBConnection a Source #