Database.Beam.Migrate.Log

Contains a schema for beam migration tools. Used by the CLI and the managed migrations support here.

Documentation

data LogEntryT f

Constructors

LogEntry

Fields

• _logEntryId :: C f Int
• _logEntryCommitId :: C f Text
• _logEntryDate :: C f LocalTime

Instances

Table LogEntryT

Associated Types

data PrimaryKey (LogEntryT :: (* -> *) -> *) (column :: * -> *) :: *

Methods

primaryKey :: LogEntryT column -> PrimaryKey LogEntryT column

Beamable LogEntryT

Methods

zipBeamFieldsM :: Applicative m => (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> LogEntryT f -> LogEntryT g -> m (LogEntryT h)

tblSkeleton :: TableSkeleton LogEntryT

Show (LogEntryT Identity)

Methods

showsPrec :: Int -> LogEntryT Identity -> ShowS

show :: LogEntryT Identity -> String

showList :: [LogEntryT Identity] -> ShowS

Generic (LogEntryT f)

Associated Types

type Rep (LogEntryT f) :: * -> *

Methods

from :: LogEntryT f -> Rep (LogEntryT f) x

to :: Rep (LogEntryT f) x -> LogEntryT f

Beamable (PrimaryKey LogEntryT)

Methods

zipBeamFieldsM :: Applicative m => (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> PrimaryKey LogEntryT f -> PrimaryKey LogEntryT g -> m (PrimaryKey LogEntryT h)

tblSkeleton :: TableSkeleton (PrimaryKey LogEntryT)

Show (PrimaryKey LogEntryT Identity)

Methods

showsPrec :: Int -> PrimaryKey LogEntryT Identity -> ShowS

show :: PrimaryKey LogEntryT Identity -> String

showList :: [PrimaryKey LogEntryT Identity] -> ShowS

Generic (PrimaryKey LogEntryT f)

Associated Types

type Rep (PrimaryKey LogEntryT f) :: * -> *

Methods

from :: PrimaryKey LogEntryT f -> Rep (PrimaryKey LogEntryT f) x

to :: Rep (PrimaryKey LogEntryT f) x -> PrimaryKey LogEntryT f

data PrimaryKey LogEntryT

data PrimaryKey LogEntryT = LogEntryKey (C f Int)

type Rep (LogEntryT f)

type Rep (LogEntryT f) = D1 * (MetaData "LogEntryT" "Database.Beam.Migrate.Log" "beam-migrate-0.3.0.0-80nQ9E1UCic3KDYlVkYGFx" False) (C1 * (MetaCons "LogEntry" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_logEntryId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (C f Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_logEntryCommitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (C f Text))) (S1 * (MetaSel (Just Symbol "_logEntryDate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (C f LocalTime))))))

type Rep (PrimaryKey LogEntryT f)

type Rep (PrimaryKey LogEntryT f) = D1 * (MetaData "PrimaryKey" "Database.Beam.Migrate.Log" "beam-migrate-0.3.0.0-80nQ9E1UCic3KDYlVkYGFx" False) (C1 * (MetaCons "LogEntryKey" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (C f Int))))

type LogEntry = LogEntryT Identity

type LogEntryKey = PrimaryKey LogEntryT Identity

newtype BeamMigrateVersionT f

Constructors

BeamMigrateVersion

Fields

• _beamMigrateVersion :: C f Int

Instances

Table BeamMigrateVersionT

Associated Types

data PrimaryKey (BeamMigrateVersionT :: (* -> *) -> *) (column :: * -> *) :: *

Methods

primaryKey :: BeamMigrateVersionT column -> PrimaryKey BeamMigrateVersionT column

Beamable BeamMigrateVersionT

Methods

zipBeamFieldsM :: Applicative m => (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> BeamMigrateVersionT f -> BeamMigrateVersionT g -> m (BeamMigrateVersionT h)

tblSkeleton :: TableSkeleton BeamMigrateVersionT

Show (BeamMigrateVersionT Identity)

Methods

showsPrec :: Int -> BeamMigrateVersionT Identity -> ShowS

show :: BeamMigrateVersionT Identity -> String

showList :: [BeamMigrateVersionT Identity] -> ShowS

Generic (BeamMigrateVersionT f)

Associated Types

type Rep (BeamMigrateVersionT f) :: * -> *

Methods

from :: BeamMigrateVersionT f -> Rep (BeamMigrateVersionT f) x

to :: Rep (BeamMigrateVersionT f) x -> BeamMigrateVersionT f

Beamable (PrimaryKey BeamMigrateVersionT)

Methods

zipBeamFieldsM :: Applicative m => (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> PrimaryKey BeamMigrateVersionT f -> PrimaryKey BeamMigrateVersionT g -> m (PrimaryKey BeamMigrateVersionT h)

tblSkeleton :: TableSkeleton (PrimaryKey BeamMigrateVersionT)

Show (PrimaryKey BeamMigrateVersionT Identity)

Methods

showsPrec :: Int -> PrimaryKey BeamMigrateVersionT Identity -> ShowS

show :: PrimaryKey BeamMigrateVersionT Identity -> String

showList :: [PrimaryKey BeamMigrateVersionT Identity] -> ShowS

Generic (PrimaryKey BeamMigrateVersionT f)

Associated Types

type Rep (PrimaryKey BeamMigrateVersionT f) :: * -> *

Methods

from :: PrimaryKey BeamMigrateVersionT f -> Rep (PrimaryKey BeamMigrateVersionT f) x

to :: Rep (PrimaryKey BeamMigrateVersionT f) x -> PrimaryKey BeamMigrateVersionT f

data PrimaryKey BeamMigrateVersionT

data PrimaryKey BeamMigrateVersionT = BeamMigrateVersionKey (C f Int)

type Rep (BeamMigrateVersionT f)

type Rep (BeamMigrateVersionT f) = D1 * (MetaData "BeamMigrateVersionT" "Database.Beam.Migrate.Log" "beam-migrate-0.3.0.0-80nQ9E1UCic3KDYlVkYGFx" True) (C1 * (MetaCons "BeamMigrateVersion" PrefixI True) (S1 * (MetaSel (Just Symbol "_beamMigrateVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (C f Int))))

type Rep (PrimaryKey BeamMigrateVersionT f)

type Rep (PrimaryKey BeamMigrateVersionT f) = D1 * (MetaData "PrimaryKey" "Database.Beam.Migrate.Log" "beam-migrate-0.3.0.0-80nQ9E1UCic3KDYlVkYGFx" False) (C1 * (MetaCons "BeamMigrateVersionKey" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (C f Int))))

type BeamMigrateVersion = BeamMigrateVersionT Identity

type BeamMigrateVersionKey = PrimaryKey BeamMigrateVersionT Identity

data BeamMigrateDb entity

Constructors

BeamMigrateDb

Fields

• _beamMigrateVersionTbl :: entity (TableEntity BeamMigrateVersionT)
• _beamMigrateLogEntries :: entity (TableEntity LogEntryT)

Instances

Database be BeamMigrateDb

Methods

zipTables :: Monad m => Proxy * be -> (forall tbl. (IsDatabaseEntity be tbl, DatabaseEntityRegularRequirements be tbl) => f tbl -> g tbl -> m (h tbl)) -> BeamMigrateDb f -> BeamMigrateDb g -> m (BeamMigrateDb h)

Generic (BeamMigrateDb entity)

Associated Types

type Rep (BeamMigrateDb entity) :: * -> *

Methods

from :: BeamMigrateDb entity -> Rep (BeamMigrateDb entity) x

to :: Rep (BeamMigrateDb entity) x -> BeamMigrateDb entity

type Rep (BeamMigrateDb entity)

type Rep (BeamMigrateDb entity) = D1 * (MetaData "BeamMigrateDb" "Database.Beam.Migrate.Log" "beam-migrate-0.3.0.0-80nQ9E1UCic3KDYlVkYGFx" False) (C1 * (MetaCons "BeamMigrateDb" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_beamMigrateVersionTbl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (entity (TableEntity BeamMigrateVersionT)))) (S1 * (MetaSel (Just Symbol "_beamMigrateLogEntries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (entity (TableEntity LogEntryT))))))

beamMigratableDb :: forall cmd be hdl m. (Sql92SaneDdlCommandSyntax cmd, Sql92SerializableDataTypeSyntax (Sql92DdlCommandDataTypeSyntax cmd), MonadBeam cmd be hdl m) => CheckedDatabaseSettings be BeamMigrateDb

beamMigrateDb :: forall be cmd hdl m. (Sql92SaneDdlCommandSyntax cmd, Sql92SerializableDataTypeSyntax (Sql92DdlCommandDataTypeSyntax cmd), MonadBeam cmd be hdl m) => DatabaseSettings be BeamMigrateDb

beamMigrateDbMigration :: forall cmd be hdl m. (Sql92SaneDdlCommandSyntax cmd, Sql92SerializableDataTypeSyntax (Sql92DdlCommandDataTypeSyntax cmd), MonadBeam cmd be hdl m) => Migration cmd (CheckedDatabaseSettings be BeamMigrateDb)

beamMigrateSchemaVersion :: Int

getLatestLogEntry :: forall be cmd hdl m. (IsSql92Syntax cmd, HasQBuilder (Sql92SelectSyntax cmd), Sql92ReasonableMarshaller be, Sql92SanityCheck cmd, Sql92SaneDdlCommandSyntax cmd, Sql92SerializableDataTypeSyntax (Sql92DdlCommandDataTypeSyntax cmd), MonadBeam cmd be hdl m) => m (Maybe LogEntry)

updateSchemaToCurrent :: forall be cmd hdl m. (IsSql92Syntax cmd, Sql92SanityCheck cmd, Sql92ReasonableMarshaller be, Sql92SaneDdlCommandSyntax cmd, Sql92SerializableDataTypeSyntax (Sql92DdlCommandDataTypeSyntax cmd), MonadBeam cmd be hdl m) => m ()

recordCommit :: forall be cmd hdl m. (IsSql92Syntax cmd, Sql92SanityCheck cmd, Sql92SaneDdlCommandSyntax cmd, HasQBuilder (Sql92SelectSyntax cmd), Sql92SerializableDataTypeSyntax (Sql92DdlCommandDataTypeSyntax cmd), HasSqlValueSyntax (Sql92ValueSyntax cmd) Text, Sql92ReasonableMarshaller be, MonadBeam cmd be hdl m) => UUID -> m ()

ensureBackendTables :: forall be cmd hdl m. BeamMigrationBackend cmd be hdl m -> m ()

checkForBackendTables :: BeamMigrationBackend cmd be hdl m -> m Bool