Database.Groundhog.Generic.Migration

This helper module is intended for use by the backend creators

Documentation

data Column typ

Constructors

Column

Fields

colName :: String

colNull :: Bool

colType :: typ

colDefault :: Maybe String

Instances

Eq typ => Eq (Column typ)

Show typ => Show (Column typ)

data UniqueDef'

Constructors

UniqueDef' String [String]

Instances

Show UniqueDef'

type Reference = (String, [(String, String)])

Foreign table name and names of the corresponding columns

data TableInfo typ

Constructors

TableInfo

Fields

tablePrimaryKeyName :: Maybe String

tableColumns :: [Column typ]

tableUniques :: [UniqueDef']

tableReferences :: [(Maybe String, Reference)]

constraint name and reference

Instances

Show typ => Show (TableInfo typ)

data AlterColumn

Constructors

Type DbType

IsNull

NotNull

Add (Column DbType)

Drop

AddPrimaryKey

Default String

NoDefault

UpdateValue String

Instances

Show AlterColumn

type AlterColumn' = (String, AlterColumn)

data AlterTable

Constructors

AddUniqueConstraint String [String]

DropConstraint String

AddReference Reference

DropReference String

AlterColumn AlterColumn'

Instances

Show AlterTable

data AlterDB typ

Constructors

AddTable String

AlterTable String String (TableInfo typ) (TableInfo DbType) [AlterTable]

Table name, create statement, structure of table from DB, structure of table from datatype, alters

DropTrigger String String

Trigger name, table name

AddTriggerOnDelete String String String

Trigger name, table name, body

AddTriggerOnUpdate String String String String

Trigger name, table name, field name, body

CreateOrReplaceFunction String

DropFunction String

Instances

Show typ => Show (AlterDB typ)

data MigrationPack m typ

Constructors

MigrationPack

Fields

compareColumns :: Column typ -> Column DbType -> Bool

compareRefs :: (Maybe String, Reference) -> (Maybe String, Reference) -> Bool

compareUniqs :: UniqueDef' -> UniqueDef' -> Bool

checkTable :: String -> m (Maybe (Either [String] (TableInfo typ)))

migTriggerOnDelete :: String -> [(String, String)] -> m (Bool, [AlterDB typ])

migTriggerOnUpdate :: String -> String -> String -> m (Bool, [AlterDB typ])

migConstr :: MigrationPack m typ -> Bool -> String -> ConstructorDef -> m (Bool, SingleMigration)

escape :: String -> String

primaryKeyType :: String

foreignKeyType :: String

mainTableId :: String

defaultPriority :: Int

convertType :: DbType -> typ

addUniquesReferences :: [UniqueDef'] -> [Reference] -> ([String], [AlterTable])

Sql pieces for the create table statement that add constraints and alterations for running after the table is created

showColumn :: Column DbType -> String

showAlterDb :: AlterDB typ -> SingleMigration

mkColumns :: (DbType -> typ) -> String -> DbType -> ([Column typ], [Reference])

migrateRecursively

Arguments

:: (Monad m, PersistEntity v)

=> (EntityDef -> m SingleMigration)

migrate entity

-> (DbType -> m SingleMigration)

migrate list

-> v

initial entity

-> StateT NamedMigrations m ()

Create migration for a given entity and all entities it depends on. The stateful Map is used to avoid duplicate migrations when an entity type occurs several times in a datatype

migrateEntity :: (Monad m, Show typ) => MigrationPack m typ -> EntityDef -> m SingleMigration

migrateList :: (Monad m, Show typ) => MigrationPack m typ -> DbType -> m SingleMigration

getAlters :: (Eq typ, Show typ) => MigrationPack m typ -> TableInfo typ -> TableInfo DbType -> [AlterTable]

defaultMigConstr :: (Monad m, Eq typ, Show typ) => MigrationPack m typ -> Bool -> String -> ConstructorDef -> m (Bool, SingleMigration)