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

contains DbType that maps to one column (no DbEmbedded)

colDefault :: Maybe String

Instances

Eq Column

Show Column

data UniqueDef'

Constructors

UniqueDef'

Fields

uniqueDefName :: Maybe String

uniqueDefType :: UniqueType

uniqueDefColumns :: [String]

Instances

Show UniqueDef'

data Reference

Constructors

Reference

Fields

referencedTableSchema :: Maybe String

referencedTableName :: String

referencedColumns :: [(String, String)]

child column, parent column

referenceOnDelete :: Maybe ReferenceActionType

referenceOnUpdate :: Maybe ReferenceActionType

Instances

Show Reference

data TableInfo

Constructors

TableInfo

Fields

tableColumns :: [Column]

tableUniques :: [UniqueDef']

tableReferences :: [(Maybe String, Reference)]

constraint name and reference

Instances

Show TableInfo

data AlterColumn

Constructors

Type DbType

IsNull

NotNull

Default String

NoDefault

UpdateValue String

Instances

Show AlterColumn

data AlterTable

Constructors

AddUnique UniqueDef'

DropConstraint String

DropIndex String

AddReference Reference

DropReference String

DropColumn String

AddColumn Column

AlterColumn Column [AlterColumn]

Instances

Show AlterTable

data AlterDB

Constructors

AddTable String

AlterTable (Maybe String) String String TableInfo TableInfo [AlterTable]

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

DropTrigger (Maybe String) String (Maybe String) String

Trigger schema, trigger name, table schema, table name

AddTriggerOnDelete (Maybe String) String (Maybe String) String String

Trigger schema, trigger name, table schema, table name, body

AddTriggerOnUpdate (Maybe String) String (Maybe String) String (Maybe String) String

Trigger schema, trigger name, table schema, table name, field name, body

CreateOrReplaceFunction String

Statement which creates the function

DropFunction (Maybe String) String

Function schema, function name

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

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

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

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

escape :: String -> String

primaryKeyType :: DbType

primaryKeyTypeName :: String

foreignKeyTypeName :: 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

class SchemaAnalyzer m where

Methods

listTables

Arguments

:: Maybe String

Schema name

-> m [String]

listTableTriggers

Arguments

:: Maybe String

Schema name

-> String

Table name

-> m [String]

analyzeTable

Arguments

:: Maybe String

Schema name

-> String

Table name

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

analyzeTrigger

Arguments

:: Maybe String

Schema name

-> String

Trigger name

-> m (Maybe String)

analyzeFunction

Arguments

:: Maybe String

Schema name

-> String

Function name

-> m (Maybe String)

mkColumns :: 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, SchemaAnalyzer m) => MigrationPack m -> EntityDef -> m SingleMigration

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

getAlters

Arguments

:: MigrationPack m

-> TableInfo

From database

-> TableInfo

From datatype

-> [AlterTable]

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

showReferenceAction :: ReferenceActionType -> String

readReferenceAction :: String -> Maybe ReferenceActionType