Refurb.Store

Module containing definition of and functions for maintaining the in-database state storage for Refurb.

Documentation

data MigrationResult

Result of running a migration, either success or failure.

Constructors

MigrationSuccess

MigrationFailure

Instances

Eq MigrationResult

Methods

(==) :: MigrationResult -> MigrationResult -> Bool

(/=) :: MigrationResult -> MigrationResult -> Bool

Show MigrationResult

Methods

showsPrec :: Int -> MigrationResult -> ShowS

show :: MigrationResult -> String

showList :: [MigrationResult] -> ShowS

FromField MigrationResult

Methods

fromField :: FieldParser MigrationResult

QueryRunnerColumnDefault PGMigrationResult MigrationResult

Methods

queryRunnerColumnDefault :: QueryRunnerColumn PGMigrationResult MigrationResult

Default Constant MigrationResult (Column PGMigrationResult)

Methods

def :: Constant MigrationResult (Column PGMigrationResult)

data PGMigrationResult

Instances

QueryRunnerColumnDefault PGMigrationResult MigrationResult

Methods

queryRunnerColumnDefault :: QueryRunnerColumn PGMigrationResult MigrationResult

Default Constant MigrationResult (Column PGMigrationResult)

Methods

def :: Constant MigrationResult (Column PGMigrationResult)

type FId = (:->) "id" Int32

type FIdMay = (:->) "id" (Maybe Int32)

type CId = (:->) "id" (Column PGInt4)

type CIdMay = (:->) "id" (Maybe (Column PGInt4))

type FQualifiedKey = (:->) "qualified_key" Text

type CQualifiedKey = (:->) "qualified_key" (Column PGText)

type FApplied = (:->) "applied" UTCTime

type CApplied = (:->) "applied" (Column PGTimestamptz)

type FOutput = (:->) "output" Text

type COutput = (:->) "output" (Column PGText)

type FResult = (:->) "result" MigrationResult

type CResult = (:->) "result" (Column PGMigrationResult)

type FDuration = (:->) "duration" Double

type CDuration = (:->) "duration" (Column PGFloat8)

type FProdSystem = (:->) "prod_system" Bool

type CProdSystem = (:->) "prod_system" (Column PGBool)

cProdSystem :: forall f rs. (Functor f, RElem CProdSystem rs (RIndex CProdSystem rs)) => (Column PGBool -> f (Column PGBool)) -> Record rs -> f (Record rs)

fProdSystem :: forall f rs. (Functor f, RElem FProdSystem rs (RIndex FProdSystem rs)) => (Bool -> f Bool) -> Record rs -> f (Record rs)

cDuration :: forall f rs. (Functor f, RElem CDuration rs (RIndex CDuration rs)) => (Column PGFloat8 -> f (Column PGFloat8)) -> Record rs -> f (Record rs)

fDuration :: forall f rs. (Functor f, RElem FDuration rs (RIndex FDuration rs)) => (Double -> f Double) -> Record rs -> f (Record rs)

cResult :: forall f rs. (Functor f, RElem CResult rs (RIndex CResult rs)) => (Column PGMigrationResult -> f (Column PGMigrationResult)) -> Record rs -> f (Record rs)

fResult :: forall f rs. (Functor f, RElem FResult rs (RIndex FResult rs)) => (MigrationResult -> f MigrationResult) -> Record rs -> f (Record rs)

cOutput :: forall f rs. (Functor f, RElem COutput rs (RIndex COutput rs)) => (Column PGText -> f (Column PGText)) -> Record rs -> f (Record rs)

fOutput :: forall f rs. (Functor f, RElem FOutput rs (RIndex FOutput rs)) => (Text -> f Text) -> Record rs -> f (Record rs)

cApplied :: forall f rs. (Functor f, RElem CApplied rs (RIndex CApplied rs)) => (Column PGTimestamptz -> f (Column PGTimestamptz)) -> Record rs -> f (Record rs)

fApplied :: forall f rs. (Functor f, RElem FApplied rs (RIndex FApplied rs)) => (UTCTime -> f UTCTime) -> Record rs -> f (Record rs)

cQualifiedKey :: forall f rs. (Functor f, RElem CQualifiedKey rs (RIndex CQualifiedKey rs)) => (Column PGText -> f (Column PGText)) -> Record rs -> f (Record rs)

fQualifiedKey :: forall f rs. (Functor f, RElem FQualifiedKey rs (RIndex FQualifiedKey rs)) => (Text -> f Text) -> Record rs -> f (Record rs)

cIdMay :: forall f rs. (Functor f, RElem CIdMay rs (RIndex CIdMay rs)) => (Maybe (Column PGInt4) -> f (Maybe (Column PGInt4))) -> Record rs -> f (Record rs)

cId :: forall f rs. (Functor f, RElem CId rs (RIndex CId rs)) => (Column PGInt4 -> f (Column PGInt4)) -> Record rs -> f (Record rs)

fIdMay :: forall f rs. (Functor f, RElem FIdMay rs (RIndex FIdMay rs)) => (Maybe Int32 -> f (Maybe Int32)) -> Record rs -> f (Record rs)

fId :: forall f rs. (Functor f, RElem FId rs (RIndex FId rs)) => (Int32 -> f Int32) -> Record rs -> f (Record rs)

cProdSystem_ :: Proxy CProdSystem

fProdSystem_ :: Proxy FProdSystem

cDuration_ :: Proxy CDuration

fDuration_ :: Proxy FDuration

cResult_ :: Proxy CResult

fResult_ :: Proxy FResult

cOutput_ :: Proxy COutput

fOutput_ :: Proxy FOutput

cApplied_ :: Proxy CApplied

fApplied_ :: Proxy FApplied

cQualifiedKey_ :: Proxy CQualifiedKey

fQualifiedKey_ :: Proxy FQualifiedKey

cIdMay_ :: Proxy CIdMay

cId_ :: Proxy CId

fIdMay_ :: Proxy FIdMay

fId_ :: Proxy FId

type MigrationLog = '[FId, FQualifiedKey, FApplied, FOutput, FResult, FDuration]

Fields of a migration log entry in memory fetched from the database (with ID)

type MigrationLogW = '[FIdMay, FQualifiedKey, FApplied, FOutput, FResult, FDuration]

Fields of a migration log entry to insert in the database (with the ID column optional)

type MigrationLogColsR = '[CId, CQualifiedKey, CApplied, COutput, CResult, CDuration]

Columns of a migration log when reading from the database (with ID)

type MigrationLogColsW = '[CIdMay, CQualifiedKey, CApplied, COutput, CResult, CDuration]

Columns of a migration log when inserting into the database (with ID column optional)

type RefurbConfig = '[FProdSystem]

Fields of the Refurb config in memory

type RefurbConfigCols = '[CProdSystem]

Columns of the Refurb config in the database

migrationLog :: Table (Record MigrationLogColsW) (Record MigrationLogColsR)

The migration log table which records all executed migrations and their results

refurbConfig :: Table (Record RefurbConfigCols) (Record RefurbConfigCols)

The refurb config table which controls whether this database is considered a production one or not

isSchemaPresent :: (MonadBaseControl IO m, MonadMask m, MonadLogger m) => Connection -> m Bool

Test to see if the schema seems to be installed by looking for an existing refurb_config table

isProdSystem :: (MonadBaseControl IO m, MonadLogger m) => Connection -> m Bool

Check if this database is configured as a production database by reading the refurb config table

initializeSchema :: (MonadBaseControl IO m, MonadLogger m) => Connection -> m ()

Create the refurb schema elements. Will fail if they already exist.

readMigrationStatus :: (MonadBaseControl IO m, MonadLogger m) => Connection -> [Migration] -> QueryArr (Record MigrationLogColsR) () -> m [These Migration (Record MigrationLog)]

Read the migration log and stitch it together with the expected migration list, forming a list in the same order as the known migrations but with These representing whether the migration log for the known migration is present or not.

• This migration represents a known migration that has no log entry.
• That migrationLog represents an unknown migration that was applied in the past.
• These migration migrationLog represents a migration that has an attempted application in the log.