Safe Haskell	None
Language	Haskell98

Database.Groundhog.Generic.Migration

Description

This helper module is intended for use by the backend creators

Synopsis

data Column = Column {
- colName :: String
- colNull :: Bool
- colType :: DbTypePrimitive
- colDefault :: Maybe String
}
data Reference = Reference {
- referencedTableName :: QualifiedName
- referencedColumns :: [(String, String)]
- referenceOnDelete :: Maybe ReferenceActionType
- referenceOnUpdate :: Maybe ReferenceActionType
}
type QualifiedName = (Maybe String, String)
data TableInfo = TableInfo {
- tableColumns :: [Column]
- tableUniques :: [UniqueDefInfo]
- tableReferences :: [(Maybe String, Reference)]
}
type UniqueDefInfo = UniqueDef' String (Either String String)
data AlterColumn
- = Type DbTypePrimitive
- | IsNull
- | NotNull
- | Default String
- | NoDefault
- | UpdateValue String
data AlterTable
- = AddUnique UniqueDefInfo
- | DropConstraint String
- | DropIndex String
- | AddReference Reference
- | DropReference String
- | DropColumn String
- | AddColumn Column
- | AlterColumn Column [AlterColumn]
data AlterDB
data MigrationPack conn = MigrationPack {
- 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])
- showSqlType :: DbTypePrimitive -> String
- showColumn :: Column -> String
- showAlterDb :: AlterDB -> SingleMigration
- defaultReferenceOnDelete :: ReferenceActionType
- defaultReferenceOnUpdate :: ReferenceActionType
}
class PersistBackendConn conn => SchemaAnalyzer conn where
- 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 :: (PersistBackend m, PersistEntity v) => (String -> m SingleMigration) -> (EntityDef -> m SingleMigration) -> (DbType -> m SingleMigration) -> v -> Migration m
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 :: MigrationPack m -> TableInfo -> TableInfo -> [AlterTable]
defaultMigConstr :: (SchemaAnalyzer conn, PersistBackendConn conn) => MigrationPack conn -> EntityDef -> ConstructorDef -> Action conn (Bool, SingleMigration)
showReferenceAction :: ReferenceActionType -> String
readReferenceAction :: String -> Maybe ReferenceActionType

Documentation

data Column Source #

Constructors

Column
Fields colName :: String colNull :: Bool colType :: DbTypePrimitive colDefault :: Maybe String

Instances

Eq Column Source #
Instance details Defined in Database.Groundhog.Generic.Migration Methods (==) :: Column -> Column -> Bool # (/=) :: Column -> Column -> Bool #
Show Column Source #
Instance details Defined in Database.Groundhog.Generic.Migration Methods showsPrec :: Int -> Column -> ShowS # show :: Column -> String # showList :: [Column] -> ShowS #

data Reference Source #

Constructors

Reference
Fields referencedTableName :: QualifiedName referencedColumns :: [(String, String)] child column, parent column referenceOnDelete :: Maybe ReferenceActionType referenceOnUpdate :: Maybe ReferenceActionType

Instances

Show Reference Source #
Instance details Defined in Database.Groundhog.Generic.Migration Methods showsPrec :: Int -> Reference -> ShowS # show :: Reference -> String # showList :: [Reference] -> ShowS #

type QualifiedName = (Maybe String, String) Source #

Schema-qualified name of a table of another database object

data TableInfo Source #

Constructors

TableInfo
Fields tableColumns :: [Column] tableUniques :: [UniqueDefInfo] tableReferences :: [(Maybe String, Reference)] constraint name and reference

Instances

Show TableInfo Source #
Instance details Defined in Database.Groundhog.Generic.Migration Methods showsPrec :: Int -> TableInfo -> ShowS # show :: TableInfo -> String # showList :: [TableInfo] -> ShowS #

type UniqueDefInfo = UniqueDef' String (Either String String) Source #

Either column name or expression

data AlterColumn Source #

Constructors

Type DbTypePrimitive
IsNull
NotNull
Default String
NoDefault
UpdateValue String

Instances

Show AlterColumn Source #
Instance details Defined in Database.Groundhog.Generic.Migration Methods showsPrec :: Int -> AlterColumn -> ShowS # show :: AlterColumn -> String # showList :: [AlterColumn] -> ShowS #

data AlterTable Source #

Constructors

AddUnique UniqueDefInfo
DropConstraint String
DropIndex String
AddReference Reference
DropReference String
DropColumn String
AddColumn Column
AlterColumn Column [AlterColumn]

Instances

Show AlterTable Source #
Instance details Defined in Database.Groundhog.Generic.Migration Methods showsPrec :: Int -> AlterTable -> ShowS # show :: AlterTable -> String # showList :: [AlterTable] -> ShowS #

data AlterDB Source #

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 Source #
Instance details Defined in Database.Groundhog.Generic.Migration Methods showsPrec :: Int -> AlterDB -> ShowS # show :: AlterDB -> String # showList :: [AlterDB] -> ShowS #

data MigrationPack conn Source #

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 Source #

Methods

schemaExists Source #

Arguments

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

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

listTables Source #

Arguments

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

listTableTriggers Source #

Arguments

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

analyzeTable Source #

Arguments

:: (PersistBackend m, Conn m ~ conn)
=> QualifiedName	Qualified table name
-> m (Maybe TableInfo)

analyzeTrigger Source #

Arguments

:: (PersistBackend m, Conn m ~ conn)
=> QualifiedName	Qualified trigger name
-> m (Maybe String)

analyzeFunction Source #

Arguments

:: (PersistBackend m, Conn m ~ conn)
=> QualifiedName	Qualified function name
-> m (Maybe (Maybe [DbTypePrimitive], Maybe DbTypePrimitive, String))	Argument types, return type, and body

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

migrateRecursively Source #

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 Source #

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

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

getAlters Source #

Arguments

:: MigrationPack m
-> TableInfo	From database
-> TableInfo	From datatype
-> [AlterTable]

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

showReferenceAction :: ReferenceActionType -> String Source #

readReferenceAction :: String -> Maybe ReferenceActionType Source #