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

Methods

(==) :: Column -> Column -> Bool

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

Show Column

Methods

showsPrec :: Int -> Column -> ShowS

show :: Column -> String

showList :: [Column] -> ShowS

data Reference

Constructors

Reference

Fields

• referencedTableName :: QualifiedName
• referencedColumns :: [(String, String)]

  child column, parent column

• referenceOnDelete :: Maybe ReferenceActionType
• referenceOnUpdate :: Maybe ReferenceActionType

Instances

Show Reference

Methods

showsPrec :: Int -> Reference -> ShowS

show :: Reference -> String

showList :: [Reference] -> ShowS

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

Methods

showsPrec :: Int -> TableInfo -> ShowS

show :: TableInfo -> String

showList :: [TableInfo] -> ShowS

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

Methods

showsPrec :: Int -> AlterColumn -> ShowS

show :: AlterColumn -> String

showList :: [AlterColumn] -> ShowS

data AlterTable

Constructors

AddUnique UniqueDefInfo

DropConstraint String

DropIndex String

AddReference Reference

DropReference String

DropColumn String

AddColumn Column

AlterColumn Column [AlterColumn]

Instances

Show AlterTable

Methods

showsPrec :: Int -> AlterTable -> ShowS

show :: AlterTable -> String

showList :: [AlterTable] -> ShowS

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

Methods

showsPrec :: Int -> AlterDB -> ShowS

show :: AlterDB -> String

showList :: [AlterDB] -> ShowS

data MigrationPack conn

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)] -> Action conn (Bool, [AlterDB])
• migTriggerOnUpdate :: QualifiedName -> [(String, String)] -> Action conn [(Bool, [AlterDB])]
• migConstr :: EntityDef -> ConstructorDef -> Action conn (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 PersistBackendConn conn => SchemaAnalyzer conn where

Minimal complete definition

schemaExists, getCurrentSchema, listTables, listTableTriggers, analyzeTable, analyzeTrigger, analyzeFunction, getMigrationPack

Methods

schemaExists :: (PersistBackend m, Conn m ~ conn) => String -> m Bool

getCurrentSchema :: (PersistBackend m, Conn m ~ conn) => m (Maybe String)

listTables :: (PersistBackend m, Conn m ~ conn) => Maybe String -> m [String]

listTableTriggers :: (PersistBackend m, Conn m ~ conn) => QualifiedName -> m [String]

analyzeTable :: (PersistBackend m, Conn m ~ conn) => QualifiedName -> m (Maybe TableInfo)

analyzeTrigger :: (PersistBackend m, Conn m ~ conn) => QualifiedName -> m (Maybe String)

analyzeFunction :: (PersistBackend m, Conn m ~ conn) => QualifiedName -> m (Maybe (Maybe [DbTypePrimitive], Maybe DbTypePrimitive, String))

getMigrationPack :: (PersistBackend m, Conn m ~ conn) => m (MigrationPack conn)

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 conn => MigrationPack conn -> String -> Action conn SingleMigration

migrateEntity :: (SchemaAnalyzer conn, PersistBackendConn conn) => MigrationPack conn -> EntityDef -> Action conn SingleMigration

migrateList :: (SchemaAnalyzer conn, PersistBackendConn conn) => MigrationPack conn -> DbType -> Action conn SingleMigration

getAlters

Arguments

:: MigrationPack m

-> TableInfo

From database

-> TableInfo

From datatype

-> [AlterTable]

defaultMigConstr :: (SchemaAnalyzer conn, PersistBackendConn conn) => MigrationPack conn -> EntityDef -> ConstructorDef -> Action conn (Bool, SingleMigration)

showReferenceAction :: ReferenceActionType -> String

readReferenceAction :: String -> Maybe ReferenceActionType