Database.Beam.Migrate.Types

Checked database entities

type CheckedDatabaseSettings be db = db (CheckedDatabaseEntity be db)

The type of a checked database descriptor. Conceptually, this is just a DatabaseSettings with a set of predicates. Use unCheckDatabase to get the regular DatabaseSettings object and collectChecks to access the predicates.

class IsDatabaseEntity be entity => IsCheckedDatabaseEntity be entity where

Like IsDatabaseEntity in beam-core, but for entities against which we can generate DatabasePredicates. Conceptually, this is the same as IsDatabaseEntity, but with one extra function to generate DatabasePredicates from the description.

Minimal complete definition

unChecked, collectEntityChecks, checkedDbEntityAuto

Associated Types

data CheckedDatabaseEntityDescriptor be entity :: *

The type of the descriptor for this checked entity. Usually this wraps the corresponding DatabaseEntityDescriptor from IsDatabaseEntity, along with some mechanism for generating DatabasePredicates.

type CheckedDatabaseEntityDefaultRequirements be entity :: Constraint

Like DatabaseEntityDefaultRequirements but for checked entities

Methods

unCheck :: CheckedDatabaseEntityDescriptor be entity -> DatabaseEntityDescriptor be entity

Produce the corresponding DatabaseEntityDescriptor

unChecked :: Lens' (CheckedDatabaseEntityDescriptor be entity) (DatabaseEntityDescriptor be entity)

A lens to access the internal unchecked descriptor

collectEntityChecks :: CheckedDatabaseEntityDescriptor be entity -> [SomeDatabasePredicate]

Produce the set of DatabasePredicates that apply to this entity

checkedDbEntityAuto :: CheckedDatabaseEntityDefaultRequirements be entity => Text -> CheckedDatabaseEntityDescriptor be entity

Like dbEntityAuto but for checked databases. Most often, this wraps dbEntityAuto and provides some means to generate DatabasePredicates

Instances

IsCheckedDatabaseEntity be (DomainTypeEntity ty)

Defined in Database.Beam.Migrate.Types.CheckedEntities

Associated Types

data CheckedDatabaseEntityDescriptor be (DomainTypeEntity ty)

type CheckedDatabaseEntityDefaultRequirements be (DomainTypeEntity ty)

Methods

unCheck :: CheckedDatabaseEntityDescriptor be (DomainTypeEntity ty) -> DatabaseEntityDescriptor be (DomainTypeEntity ty)

unChecked :: Lens' (CheckedDatabaseEntityDescriptor be (DomainTypeEntity ty)) (DatabaseEntityDescriptor be (DomainTypeEntity ty))

collectEntityChecks :: CheckedDatabaseEntityDescriptor be (DomainTypeEntity ty) -> [SomeDatabasePredicate]

checkedDbEntityAuto :: Text -> CheckedDatabaseEntityDescriptor be (DomainTypeEntity ty)

Beamable tbl => IsCheckedDatabaseEntity be (TableEntity tbl)

Defined in Database.Beam.Migrate.Types.CheckedEntities

Associated Types

data CheckedDatabaseEntityDescriptor be (TableEntity tbl)

type CheckedDatabaseEntityDefaultRequirements be (TableEntity tbl)

Methods

unCheck :: CheckedDatabaseEntityDescriptor be (TableEntity tbl) -> DatabaseEntityDescriptor be (TableEntity tbl)

unChecked :: Lens' (CheckedDatabaseEntityDescriptor be (TableEntity tbl)) (DatabaseEntityDescriptor be (TableEntity tbl))

collectEntityChecks :: CheckedDatabaseEntityDescriptor be (TableEntity tbl) -> [SomeDatabasePredicate]

checkedDbEntityAuto :: Text -> CheckedDatabaseEntityDescriptor be (TableEntity tbl)

data CheckedDatabaseEntity be (db :: (* -> *) -> *) entityType where

Like DatabaseEntity but for checked databases

Constructors

CheckedDatabaseEntity :: IsCheckedDatabaseEntity be entityType => CheckedDatabaseEntityDescriptor be entityType -> [SomeDatabasePredicate] -> CheckedDatabaseEntity be db entityType

unCheckDatabase :: forall be db. Database be db => CheckedDatabaseSettings be db -> DatabaseSettings be db

Convert a CheckedDatabaseSettings to a regular DatabaseSettings. The return value is suitable for use in any regular beam query or DML statement.

collectChecks :: forall be db. Database be db => CheckedDatabaseSettings be db -> [SomeDatabasePredicate]

A beam-migrate database schema is defined completely by the set of predicates that apply to it. This function allows you to access this definition for a CheckedDatabaseSettings object.

renameCheckedEntity :: (Text -> Text) -> EntityModification (CheckedDatabaseEntity be db) be ent

Modifyinging checked entities

data CheckedFieldModification tbl a

Purposefully opaque type describing how to modify a table field. Used to parameterize the second argument to modifyCheckedTable. For now, the only way to construct a value is the IsString instance, which allows you to rename the field.

Instances

Beamable tbl => RenamableWithRule (tbl (CheckedFieldModification tbl))

Defined in Database.Beam.Migrate.Types.CheckedEntities

Methods

renamingFields :: (NonEmpty Text -> Text) -> tbl (CheckedFieldModification tbl)

IsString (CheckedFieldModification tbl a)

Defined in Database.Beam.Migrate.Types.CheckedEntities

Methods

fromString :: String -> CheckedFieldModification tbl a

checkedFieldNamed :: Text -> CheckedFieldModification tbl a

modifyCheckedTable :: (Text -> Text) -> tbl (CheckedFieldModification tbl) -> EntityModification (CheckedDatabaseEntity be db) be (TableEntity tbl)

Modify a checked table.

The first argument is a function that takes the original table name as input and produces a new table name.

The second argument gives instructions on how to rename each field in the table. Use checkedTableModification to create a value of this type which does no renaming. Each field in the table supplied here has the type CheckedFieldModification. Most commonly, the programmer will use the OverloadedStrings instance to provide a new name.

Examples

Rename a table, without renaming any of its fields:

modifyCheckedTable (_ -> NewTblNm) checkedTableModification

Modify a table, renaming the field called _field1 in Haskell to FirstName. Note that below, FirstName represents a CheckedFieldModification object.

modifyCheckedTable id (checkedTableModification { _field1 = FirstName })

checkedTableModification :: forall tbl. Beamable tbl => tbl (CheckedFieldModification tbl)

Produce a table field modification that does nothing

Most commonly supplied as the second argument to modifyCheckedTable when you just want to rename the table, not the fields.

Predicates

class (Typeable p, Hashable p, Eq p) => DatabasePredicate p where

A predicate is a type that describes some condition that the database schema must meet. Beam represents database schemas as the set of all predicates that apply to a database schema. The Hashable and Eq instances allow us to build HashSets of predicates to represent schemas in this way.

Minimal complete definition

englishDescription, predicateSpecificity, serializePredicate

Methods

englishDescription :: p -> String

An english language description of this predicate. For example, "There is a table named TableName"

predicateSpecificity :: proxy p -> PredicateSpecificity

Whether or not this predicate applies to all backends or only one backend. This is used when attempting to translate schemas between backends. If you are unsure, provide PredicateSpecificityOnlyBackend along with an identifier unique to your backend.

serializePredicate :: p -> Value

Serialize a predicate to a JSON Value.

predicateCascadesDropOn :: DatabasePredicate p' => p -> p' -> Bool

Some predicates require other predicates to be true. For example, in order for a table to have a column, that table must exist. This function takes in the current predicate and another arbitrary database predicate. It should return True if this predicate needs the other predicate to be true in order to exist.

By default, this simply returns False, which makes sense for many predicates.

Instances

DatabasePredicate TableExistsPredicate

Defined in Database.Beam.Migrate.Checks

Methods

englishDescription :: TableExistsPredicate -> String

predicateSpecificity :: proxy TableExistsPredicate -> PredicateSpecificity

serializePredicate :: TableExistsPredicate -> Value

predicateCascadesDropOn :: DatabasePredicate p' => TableExistsPredicate -> p' -> Bool

DatabasePredicate TableHasPrimaryKey

Defined in Database.Beam.Migrate.Checks

Methods

englishDescription :: TableHasPrimaryKey -> String

predicateSpecificity :: proxy TableHasPrimaryKey -> PredicateSpecificity

serializePredicate :: TableHasPrimaryKey -> Value

predicateCascadesDropOn :: DatabasePredicate p' => TableHasPrimaryKey -> p' -> Bool

(Typeable be, BeamMigrateOnlySqlBackend be, Hashable (BeamSqlBackendColumnConstraintDefinitionSyntax be)) => DatabasePredicate (TableColumnHasConstraint be)

Defined in Database.Beam.Migrate.Checks

Methods

englishDescription :: TableColumnHasConstraint be -> String

predicateSpecificity :: proxy (TableColumnHasConstraint be) -> PredicateSpecificity

serializePredicate :: TableColumnHasConstraint be -> Value

predicateCascadesDropOn :: DatabasePredicate p' => TableColumnHasConstraint be -> p' -> Bool

(Typeable be, BeamMigrateOnlySqlBackend be, Hashable (BeamMigrateSqlBackendDataTypeSyntax be)) => DatabasePredicate (TableHasColumn be)

Defined in Database.Beam.Migrate.Checks

Methods

englishDescription :: TableHasColumn be -> String

predicateSpecificity :: proxy (TableHasColumn be) -> PredicateSpecificity

serializePredicate :: TableHasColumn be -> Value

predicateCascadesDropOn :: DatabasePredicate p' => TableHasColumn be -> p' -> Bool

data SomeDatabasePredicate where

A Database predicate is a value of any type which satisfies DatabasePredicate. We often want to store these in lists and sets, so we need a monomorphic container that can store these polymorphic values.

Constructors

SomeDatabasePredicate :: DatabasePredicate p => p -> SomeDatabasePredicate

Instances

Show SomeDatabasePredicate

Defined in Database.Beam.Migrate.Types.Predicates

Methods

showsPrec :: Int -> SomeDatabasePredicate -> ShowS

show :: SomeDatabasePredicate -> String

showList :: [SomeDatabasePredicate] -> ShowS

NFData SomeDatabasePredicate

Defined in Database.Beam.Migrate.Types.Predicates

Methods

rnf :: SomeDatabasePredicate -> ()

Eq SomeDatabasePredicate

Defined in Database.Beam.Migrate.Types.Predicates

Methods

(==) :: SomeDatabasePredicate -> SomeDatabasePredicate -> Bool

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

Hashable SomeDatabasePredicate

Defined in Database.Beam.Migrate.Types.Predicates

Methods

hashWithSalt :: Int -> SomeDatabasePredicate -> Int

hash :: SomeDatabasePredicate -> Int

data PredicateSpecificity

Some predicates make sense in any backend. Others only make sense in one. This denotes the difference.

Constructors

PredicateSpecificityOnlyBackend String

PredicateSpecificityAllBackends

Instances

FromJSON PredicateSpecificity

Defined in Database.Beam.Migrate.Types.Predicates

Methods

parseJSON :: Value -> Parser PredicateSpecificity

parseJSONList :: Value -> Parser [PredicateSpecificity]

ToJSON PredicateSpecificity

Defined in Database.Beam.Migrate.Types.Predicates

Methods

toJSON :: PredicateSpecificity -> Value

toEncoding :: PredicateSpecificity -> Encoding

toJSONList :: [PredicateSpecificity] -> Value

toEncodingList :: [PredicateSpecificity] -> Encoding

Generic PredicateSpecificity

Defined in Database.Beam.Migrate.Types.Predicates

Associated Types

type Rep PredicateSpecificity :: Type -> Type

Methods

from :: PredicateSpecificity -> Rep PredicateSpecificity x

to :: Rep PredicateSpecificity x -> PredicateSpecificity

Show PredicateSpecificity

Defined in Database.Beam.Migrate.Types.Predicates

Methods

showsPrec :: Int -> PredicateSpecificity -> ShowS

show :: PredicateSpecificity -> String

showList :: [PredicateSpecificity] -> ShowS

Eq PredicateSpecificity

Defined in Database.Beam.Migrate.Types.Predicates

Methods

(==) :: PredicateSpecificity -> PredicateSpecificity -> Bool

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

Hashable PredicateSpecificity

Defined in Database.Beam.Migrate.Types.Predicates

Methods

hashWithSalt :: Int -> PredicateSpecificity -> Int

hash :: PredicateSpecificity -> Int

type Rep PredicateSpecificity

Defined in Database.Beam.Migrate.Types.Predicates

type Rep PredicateSpecificity = D1 ('MetaData "PredicateSpecificity" "Database.Beam.Migrate.Types.Predicates" "beam-migrate-0.5.2.0-inplace" 'False) (C1 ('MetaCons "PredicateSpecificityOnlyBackend" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "PredicateSpecificityAllBackends" 'PrefixI 'False) (U1 :: Type -> Type))

data QualifiedName

A name in a schema

Constructors

QualifiedName (Maybe Text) Text

Instances

FromJSON QualifiedName

Defined in Database.Beam.Migrate.Types.Predicates

Methods

parseJSON :: Value -> Parser QualifiedName

parseJSONList :: Value -> Parser [QualifiedName]

ToJSON QualifiedName

Defined in Database.Beam.Migrate.Types.Predicates

Methods

toJSON :: QualifiedName -> Value

toEncoding :: QualifiedName -> Encoding

toJSONList :: [QualifiedName] -> Value

toEncodingList :: [QualifiedName] -> Encoding

Show QualifiedName

Defined in Database.Beam.Migrate.Types.Predicates

Methods

showsPrec :: Int -> QualifiedName -> ShowS

show :: QualifiedName -> String

showList :: [QualifiedName] -> ShowS

Eq QualifiedName

Defined in Database.Beam.Migrate.Types.Predicates

Methods

(==) :: QualifiedName -> QualifiedName -> Bool

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

Ord QualifiedName

Defined in Database.Beam.Migrate.Types.Predicates

Methods

compare :: QualifiedName -> QualifiedName -> Ordering

(<) :: QualifiedName -> QualifiedName -> Bool

(<=) :: QualifiedName -> QualifiedName -> Bool

(>) :: QualifiedName -> QualifiedName -> Bool

(>=) :: QualifiedName -> QualifiedName -> Bool

max :: QualifiedName -> QualifiedName -> QualifiedName

min :: QualifiedName -> QualifiedName -> QualifiedName

Hashable QualifiedName

Defined in Database.Beam.Migrate.Types.Predicates

Methods

hashWithSalt :: Int -> QualifiedName -> Int

hash :: QualifiedName -> Int

p :: DatabasePredicate p => p -> SomeDatabasePredicate

Convenience synonym for SomeDatabasePredicate

Entity checks

newtype TableCheck

An optional predicate that depends on the name of a table as well as its fields

Constructors

TableCheck (forall tbl. Table tbl => QualifiedName -> tbl (TableField tbl) -> Maybe SomeDatabasePredicate)

newtype DomainCheck

A predicate that depends on the name of a domain type

Constructors

DomainCheck (QualifiedName -> SomeDatabasePredicate)

newtype FieldCheck

A predicate that depends on the name of a table and one of its fields

Constructors

FieldCheck (QualifiedName -> Text -> SomeDatabasePredicate)

Migrations

data MigrationStep be next where

Represents a particular step in a migration

Constructors

MigrationStep :: Text -> Migration be a -> (a -> next) -> MigrationStep be next

Instances

Functor (MigrationStep be)

Defined in Database.Beam.Migrate.Types

Methods

fmap :: (a -> b) -> MigrationStep be a -> MigrationStep be b

(<$) :: a -> MigrationStep be b -> MigrationStep be a

newtype MigrationSteps be from to

A series of MigrationSteps that take a database from the schema in from to the one in to. Use the migrationStep function and the arrow interface to sequence MigrationSteps.

Constructors

MigrationSteps (Kleisli (F (MigrationStep be)) from to)

Instances

Arrow (MigrationSteps be)

Defined in Database.Beam.Migrate.Types

Methods

arr :: (b -> c) -> MigrationSteps be b c

first :: MigrationSteps be b c -> MigrationSteps be (b, d) (c, d)

second :: MigrationSteps be b c -> MigrationSteps be (d, b) (d, c)

(***) :: MigrationSteps be b c -> MigrationSteps be b' c' -> MigrationSteps be (b, b') (c, c')

(&&&) :: MigrationSteps be b c -> MigrationSteps be b c' -> MigrationSteps be b (c, c')

Category (MigrationSteps be :: Type -> Type -> Type)

Defined in Database.Beam.Migrate.Types

Methods

id :: forall (a :: k). MigrationSteps be a a

(.) :: forall (b :: k) (c :: k) (a :: k). MigrationSteps be b c -> MigrationSteps be a b -> MigrationSteps be a c

type Migration be = F (MigrationF be)

A sequence of potentially reversible schema update commands

data MigrationF be next where

Free monadic function for Migrations

Constructors

MigrationRunCommand

Fields

• :: { _migrationUpCommand :: BeamSqlBackendSyntax be

  What to execute when applying the migration

•    , _migrationDownCommand :: Maybe (BeamSqlBackendSyntax be)

  What to execute when unapplying the migration

•    , _migrationNext :: next
•    } -> MigrationF be next

Instances

Functor (MigrationF be)

Defined in Database.Beam.Migrate.Types

Methods

fmap :: (a -> b) -> MigrationF be a -> MigrationF be b

(<$) :: a -> MigrationF be b -> MigrationF be a

data MigrationCommand be

A migration command along with metadata on whether the command can lose data

Constructors

MigrationCommand

Fields

• migrationCommand :: BeamSqlBackendSyntax be

  The command to run

• migrationCommandDataLossPossible :: MigrationDataLoss

  Information on whether the migration loses data

Instances

Show (BeamSqlBackendSyntax be) => Show (MigrationCommand be)

Defined in Database.Beam.Migrate.Types

Methods

showsPrec :: Int -> MigrationCommand be -> ShowS

show :: MigrationCommand be -> String

showList :: [MigrationCommand be] -> ShowS

data MigrationDataLoss

Information on whether a MigrationCommand loses data. You can monoidally combine these to get the potential data loss for a sequence of commands.

Constructors

MigrationLosesData

The command loses data

MigrationKeepsData

The command keeps all data

Instances

Monoid MigrationDataLoss

Defined in Database.Beam.Migrate.Types

Methods

mempty :: MigrationDataLoss

mappend :: MigrationDataLoss -> MigrationDataLoss -> MigrationDataLoss

mconcat :: [MigrationDataLoss] -> MigrationDataLoss

Semigroup MigrationDataLoss

Defined in Database.Beam.Migrate.Types

Methods

(<>) :: MigrationDataLoss -> MigrationDataLoss -> MigrationDataLoss

sconcat :: NonEmpty MigrationDataLoss -> MigrationDataLoss

stimes :: Integral b => b -> MigrationDataLoss -> MigrationDataLoss

Show MigrationDataLoss

Defined in Database.Beam.Migrate.Types

Methods

showsPrec :: Int -> MigrationDataLoss -> ShowS

show :: MigrationDataLoss -> String

showList :: [MigrationDataLoss] -> ShowS

runMigrationSteps

Arguments

:: Monad m

=> Int

Zero-based index of the first step to run

-> Maybe Int

Index of the last step to run, or Nothing to run every step

-> MigrationSteps be () a

The set of steps to run

-> (forall a'. Int -> Text -> Migration be a' -> m a')

Callback for each step. Called with the step index, the step description and the migration.

-> m a

Run the migration steps between the given indices, using a custom execution function.

runMigrationSilenced :: Migration be a -> a

Get the result of a migration, without running any steps

executeMigration :: Applicative m => (BeamSqlBackendSyntax be -> m ()) -> Migration be a -> m a

Execute a given migration, provided a command to execute arbitrary syntax. You usually use this with runNoReturn.

eraseMigrationType :: a -> MigrationSteps be a a' -> MigrationSteps be () ()

Remove the explicit source and destination schemas from a MigrationSteps object

migrationStep :: Text -> (a -> Migration be a') -> MigrationSteps be a a'

Create a MigrationSteps from the given description and migration function.

upDown :: BeamSqlBackendSyntax be -> Maybe (BeamSqlBackendSyntax be) -> Migration be ()

Given a command in the forward direction, and an optional one in the reverse direction, construct a Migration that performs the given command. Multiple commands can be sequenced monadically.

migrationDataLoss :: Migration be a -> MigrationDataLoss

Given a migration, get the potential data loss, if it's run top-down

migrateScript

Arguments

:: forall be m a. (Monoid m, Semigroup m, BeamSqlBackend be)

=> (Text -> m)

Called at the beginning of each MigrationStep with the step description

-> (BeamSqlBackendSyntax be -> m)

Called for each command in the migration step

-> MigrationSteps be () a

The set of steps to run

-> m

Given functions to render a migration step description and the underlying syntax, create a script for the given MigrationSteps.

evaluateDatabase :: forall be a. MigrationSteps be () a -> a

Run a MigrationSteps without executing any of the commands against a database.

stepNames :: forall be a. MigrationSteps be () a -> [Text]

Collect the names of all steps in hte given MigrationSteps