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

colDefault :: Maybe String

Instances

Eq Column

Show Column

data Reference

Constructors

Reference

Fields

referencedTableName :: QualifiedName

referencedColumns :: [(String, String)]

child column, parent column

referenceOnDelete :: Maybe ReferenceActionType

referenceOnUpdate :: Maybe ReferenceActionType

Instances

Show Reference

type QualifiedName = (Maybe String, String)

Schema-qualified name of a table of another database object

data TableInfo

Constructors

TableInfo

Fields

tableColumns :: [Column]

tableUniques :: [UniqueDefInfo]

tableReferences :: [(Maybe String, Reference)]

constraint name and reference

Instances

Show TableInfo

type UniqueDefInfo = UniqueDef' String (Either String String)

Either column name or expression

data AlterColumn

Constructors

Type DbTypePrimitive

IsNull

NotNull

Default String

NoDefault

UpdateValue String

Instances

Show AlterColumn

data AlterTable

Constructors

AddUnique UniqueDefInfo

DropConstraint String

DropIndex String

AddReference Reference

DropReference String

DropColumn String

AddColumn Column

AlterColumn Column [AlterColumn]

Instances

Show AlterTable

data AlterDB

Constructors

AddTable String

AlterTable QualifiedName String TableInfo TableInfo [AlterTable]

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

DropTrigger QualifiedName QualifiedName

Qualified trigger name, qualified table name

AddTriggerOnDelete QualifiedName QualifiedName String

Qualified trigger name, qualified table name, body

AddTriggerOnUpdate QualifiedName QualifiedName (Maybe String) String

Qualified trigger name, qualified table name, field name, body

CreateOrReplaceFunction String

Statement which creates the function

DropFunction QualifiedName

Qualified function name

CreateSchema String Bool

Schema name, if not exists

Instances

Show AlterDB

data MigrationPack m

Constructors

MigrationPack

Fields

compareTypes :: DbTypePrimitive -> DbTypePrimitive -> Bool

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

compareUniqs :: UniqueDefInfo -> UniqueDefInfo -> Bool

compareDefaults :: String -> String -> Bool

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

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

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

escape :: String -> String

autoincrementedKeyTypeName :: String

mainTableId :: String

defaultPriority :: Int

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

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

showSqlType :: DbTypePrimitive -> String

showColumn :: Column -> String

showAlterDb :: AlterDB -> SingleMigration

defaultReferenceOnDelete :: ReferenceActionType

defaultReferenceOnUpdate :: ReferenceActionType

class (Applicative m, Monad m) => SchemaAnalyzer m where

Methods

schemaExists

Arguments

:: String

Schema name

-> m Bool

getCurrentSchema :: m (Maybe String)

listTables

Arguments

:: Maybe String

Schema name

-> m [String]

listTableTriggers

Arguments

:: QualifiedName

Qualified table name

-> m [String]

analyzeTable

Arguments

:: QualifiedName

Qualified table name

-> m (Maybe TableInfo)

analyzeTrigger

Arguments

:: QualifiedName

Qualified trigger name

-> m (Maybe String)

analyzeFunction

Arguments

:: QualifiedName

Qualified function name

-> m (Maybe (Maybe [DbTypePrimitive], Maybe DbTypePrimitive, String))

Argument types, return type, and body

getMigrationPack :: m (MigrationPack m)

migrateRecursively

Arguments

:: (PersistBackend m, PersistEntity v)

=> (String -> m SingleMigration)

migrate schema

-> (EntityDef -> m SingleMigration)

migrate entity

-> (DbType -> m SingleMigration)

migrate list

-> v

initial entity

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

migrateSchema :: SchemaAnalyzer m => MigrationPack m -> String -> m SingleMigration

migrateEntity :: (SchemaAnalyzer m, PersistBackend m) => MigrationPack m -> EntityDef -> m SingleMigration

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

getAlters

Arguments

:: MigrationPack m

-> TableInfo

From database

-> TableInfo

From datatype

-> [AlterTable]

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

showReferenceAction :: ReferenceActionType -> String

readReferenceAction :: String -> Maybe ReferenceActionType