Safe Haskell	None
Language	Haskell98

Database.Groundhog.TH.Settings

Documentation

data PersistDefinitions Source

Constructors

PersistDefinitions
Fields definitions :: [PersistDefinition]

Instances

Show PersistDefinitions
Lift PersistDefinitions
FromJSON PersistDefinitions

data PersistDefinition Source

Constructors

PSEntityDef' PSEntityDef
PSEmbeddedDef' PSEmbeddedDef
PSPrimitiveDef' PSPrimitiveDef

Instances

Show PersistDefinition
Lift PersistDefinition
FromJSON PersistDefinition

data THEntityDef Source

Constructors

THEntityDef
Fields thDataName :: Name thDbEntityName :: String thEntitySchema :: Maybe String thAutoKey :: Maybe THAutoKeyDef thUniqueKeys :: [THUniqueKeyDef] thTypeParams :: [TyVarBndr] thConstructors :: [THConstructorDef]

Instances

Show THEntityDef

data THEmbeddedDef Source

Constructors

THEmbeddedDef
Fields thEmbeddedName :: Name thEmbeddedConstructorName :: Name thDbEmbeddedName :: String It is used only to set polymorphic part of name of its container thEmbeddedTypeParams :: [TyVarBndr] thEmbeddedFields :: [THFieldDef]

Instances

Show THEmbeddedDef

data THPrimitiveDef Source

Constructors

THPrimitiveDef
Fields thPrimitiveName :: Name thPrimitiveDbName :: String It is used only to set polymorphic part of name of its container thPrimitiveStringEnumRepresentation :: Bool Store in database as string using Show/Read instances (True) or as integer using Enum instance (False).

Instances

Show THPrimitiveDef

data THConstructorDef Source

Constructors

THConstructorDef
Fields thConstrName :: Name thPhantomConstrName :: String thDbConstrName :: String thDbAutoKeyName :: Maybe String thConstrFields :: [THFieldDef] thConstrUniques :: [THUniqueDef]

Instances

Show THConstructorDef

data THFieldDef Source

Constructors

THFieldDef
Fields thFieldName :: String thDbFieldName :: String thDbTypeName :: Maybe String thExprName :: String thFieldType :: Type thEmbeddedDef :: Maybe [PSFieldDef String] thDefaultValue :: Maybe String thReferenceParent :: Maybe (Maybe (Maybe String, String, [String]), Maybe ReferenceActionType, Maybe ReferenceActionType)

Instances

Show THFieldDef

data THUniqueDef Source

Constructors

THUniqueDef
Fields thUniqueName :: String thUniqueType :: UniqueType thUniqueFields :: [Either String String] Either name of field, i.e, thFieldName, or expression

Instances

Show THUniqueDef

data THUniqueKeyDef Source

Constructors

THUniqueKeyDef

Fields

thUniqueKeyName :: String
thUniqueKeyPhantomName :: String
thUniqueKeyConstrName :: String
thUniqueKeyDbName :: String: It is used only to set polymorphic part of name of its container | It should repeat fields from THUniqueDef but it may give different settings for them. It is done to allow foreign key fields to be different from parent fields of the entity. These fields are used for creating a the key constructor and instances for it. For example, it can have a default value, or even a different type (INT8 may reference INT4).
thUniqueKeyFields :: [THFieldDef]
thUniqueKeyMakeEmbedded :: Bool: If True, make it an instance of Embedded
thUniqueKeyIsDef :: Bool

Instances

Show THUniqueKeyDef

data THAutoKeyDef Source

Constructors

THAutoKeyDef
Fields thAutoKeyConstrName :: String thAutoKeyIsDef :: Bool

Instances

Show THAutoKeyDef

data PSEntityDef Source

Constructors

PSEntityDef
Fields psDataName :: String psDbEntityName :: Maybe String psEntitySchema :: Maybe String psAutoKey :: Maybe (Maybe PSAutoKeyDef) psUniqueKeys :: Maybe [PSUniqueKeyDef] psConstructors :: Maybe [PSConstructorDef]

Instances

Show PSEntityDef
Lift PSEntityDef
FromJSON PSEntityDef

data PSEmbeddedDef Source

Constructors

PSEmbeddedDef
Fields psEmbeddedName :: String psDbEmbeddedName :: Maybe String It is used only to set polymorphic part of name of its container psEmbeddedFields :: Maybe [PSFieldDef String]

Instances

Show PSEmbeddedDef
Lift PSEmbeddedDef
FromJSON PSEmbeddedDef

data PSPrimitiveDef Source

Constructors

PSPrimitiveDef
Fields psPrimitiveName :: String psPrimitiveDbName :: Maybe String It is used only to set polymorphic part of name of its container psPrimitiveStringEnumRepresentation :: Maybe Bool Store in database as string using Show/Read instances (True) or as integer using Enum instance (False).

Instances

Show PSPrimitiveDef
Lift PSPrimitiveDef
FromJSON PSPrimitiveDef

data PSConstructorDef Source

Constructors

PSConstructorDef
Fields psConstrName :: String psPhantomConstrName :: Maybe String psDbConstrName :: Maybe String psDbAutoKeyName :: Maybe (Maybe String) psConstrFields :: Maybe [PSFieldDef String] psConstrUniques :: Maybe [PSUniqueDef]

Instances

Show PSConstructorDef
Lift PSConstructorDef
FromJSON PSConstructorDef

data PSFieldDef str :: * -> *

Constructors

PSFieldDef
Fields psFieldName :: str psDbFieldName :: Maybe str psDbTypeName :: Maybe str psExprName :: Maybe str psEmbeddedDef :: Maybe [PSFieldDef str] psDefaultValue :: Maybe str psReferenceParent :: Maybe (Maybe (Maybe str, str, [str]), Maybe ReferenceActionType, Maybe ReferenceActionType)

Instances

Show str => Show (PSFieldDef str)
Lift (PSFieldDef String)
FromJSON (PSFieldDef String)

data PSUniqueDef Source

Constructors

PSUniqueDef
Fields psUniqueName :: String psUniqueType :: Maybe UniqueType psUniqueFields :: [Either String String]

Instances

Show PSUniqueDef
Lift PSUniqueDef
FromJSON PSUniqueDef

data PSUniqueKeyDef Source

Constructors

PSUniqueKeyDef
Fields psUniqueKeyName :: String psUniqueKeyPhantomName :: Maybe String psUniqueKeyConstrName :: Maybe String psUniqueKeyDbName :: Maybe String psUniqueKeyFields :: Maybe [PSFieldDef String] psUniqueKeyMakeEmbedded :: Maybe Bool psUniqueKeyIsDef :: Maybe Bool

Instances

Show PSUniqueKeyDef
Lift PSUniqueKeyDef
FromJSON PSUniqueKeyDef

data PSAutoKeyDef Source

Constructors

PSAutoKeyDef
Fields psAutoKeyConstrName :: Maybe String psAutoKeyIsDef :: Maybe Bool

Instances

Show PSAutoKeyDef
Lift PSAutoKeyDef
FromJSON PSAutoKeyDef