Safe Haskell	Safe-Inferred
Language	Haskell2010

Relocant.Applied

Description

This module deals with applied migrations and their records in the DB.

Synopsis

data Applied = Applied {
- id :: ID
- name :: Name
- content :: Content
- appliedAt :: At
- durationS :: Duration
}
getApplied :: Table -> Connection -> IO [Applied]
getAppliedByID :: ID -> Table -> Connection -> IO (Maybe Applied)
record :: Applied -> Table -> Connection -> IO ()
deleteAll :: Table -> Connection -> IO ()
deleteByID :: ID -> Table -> Connection -> IO Bool

Documentation

data Applied Source #

An applied migration. Generally, it's created be either running a migration Script with apply or getting the records from the DB with getApplied or getAppliedByID.

Constructors

Applied
Fields id :: ID name :: Name content :: Content appliedAt :: At durationS :: Duration how long it took to apply the migration script

Instances

Instances details

ToJSON Applied Source #	The content (as in actual bytes) is skipped.
Instance details Defined in Relocant.Applied Methods toJSON :: Applied -> Value # toEncoding :: Applied -> Encoding # toJSONList :: [Applied] -> Value # toEncodingList :: [Applied] -> Encoding #
Show Applied Source #
Instance details Defined in Relocant.Applied Methods showsPrec :: Int -> Applied -> ShowS # show :: Applied -> String # showList :: [Applied] -> ShowS #
Eq Applied Source #
Instance details Defined in Relocant.Applied Methods (==) :: Applied -> Applied -> Bool # (/=) :: Applied -> Applied -> Bool #
HasField "bytes" Applied ByteString Source #
Instance details Defined in Relocant.Applied Methods getField :: Applied -> ByteString #

getApplied :: Table -> Connection -> IO [Applied] Source #

Retrieve all Applied migrations' records from the DB.

getAppliedByID :: ID -> Table -> Connection -> IO (Maybe Applied) Source #

Retrieve the specific Applied migration's record from the DB.

record :: Applied -> Table -> Connection -> IO () Source #

Record a successfully Applied migration.

Note: You probably want to run this together with apply in a single transaction.

deleteAll :: Table -> Connection -> IO () Source #

Delete all Applied migrations' records from the DB.

deleteByID :: ID -> Table -> Connection -> IO Bool Source #

Delete the specific Applied migration's record from the DB.