Database.Groundhog.Generic.Migration

This helper module is intended for use by the backend creators

Documentation

data Column

Constructors

Column

Fields

colName :: String

colNull :: Bool

colType :: DbType

colDefault :: Maybe String

Instances

Eq Column

Show Column

data UniqueDef'

Constructors

UniqueDef' String UniqueType [String]

Instances

Show UniqueDef'

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

Foreign table name and names of the corresponding columns

data TableInfo

Constructors

TableInfo

Fields

tablePrimaryKeyName :: Maybe String

tableColumns :: [Column]

tableUniques :: [UniqueDef']

tableReferences :: [(Maybe String, Reference)]

constraint name and reference

Instances

Show TableInfo

data AlterColumn

Constructors

Type DbType

IsNull

NotNull

Add Column

Drop

AddPrimaryKey

Default String

NoDefault

UpdateValue String

Instances

Show AlterColumn

type AlterColumn' = (String, AlterColumn)

data AlterTable

Constructors

AddUnique UniqueDef'

DropConstraint String

DropIndex String

AddReference Reference

DropReference String

AlterColumn AlterColumn'

Instances

Show AlterTable

data AlterDB

Constructors

AddTable String

AlterTable String String TableInfo TableInfo [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 AlterDB

data MigrationPack m

Constructors

MigrationPack

Fields

compareTypes :: DbType -> DbType -> Bool

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

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

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

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

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

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

escape :: String -> String

primaryKeyType :: String

foreignKeyType :: String

mainTableId :: String

defaultPriority :: Int

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 -> String

showAlterDb :: AlterDB -> SingleMigration

mkColumns :: (DbType -> DbType) -> String -> DbType -> ([Column], [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 => MigrationPack m -> EntityDef -> m SingleMigration

migrateList :: Monad m => MigrationPack m -> DbType -> m SingleMigration

getAlters :: MigrationPack m -> TableInfo -> TableInfo -> [AlterTable]

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