Database.Groundhog.TH.Settings

Documentation

data PersistDefinitions

Constructors

PersistDefinitions

Fields

• psEntities :: [PSEntityDef]
• psEmbeddeds :: [PSEmbeddedDef]
• psPrimitives :: [PSPrimitiveDef]

Instances

Show PersistDefinitions

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> PersistDefinitions -> ShowS

show :: PersistDefinitions -> String

showList :: [PersistDefinitions] -> ShowS

FromJSON PersistDefinitions

Defined in Database.Groundhog.TH.Settings

Methods

parseJSON :: Value -> Parser PersistDefinitions

parseJSONList :: Value -> Parser [PersistDefinitions]

Lift PersistDefinitions

Defined in Database.Groundhog.TH.Settings

Methods

lift :: PersistDefinitions -> Q Exp

liftTyped :: PersistDefinitions -> Q (TExp PersistDefinitions)

data THEntityDef

Constructors

THEntityDef

Fields

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

Instances

Eq THEntityDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: THEntityDef -> THEntityDef -> Bool

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

Show THEntityDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> THEntityDef -> ShowS

show :: THEntityDef -> String

showList :: [THEntityDef] -> ShowS

data THEmbeddedDef

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

Eq THEmbeddedDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: THEmbeddedDef -> THEmbeddedDef -> Bool

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

Show THEmbeddedDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> THEmbeddedDef -> ShowS

show :: THEmbeddedDef -> String

showList :: [THEmbeddedDef] -> ShowS

data THPrimitiveDef

Constructors

THPrimitiveDef

Fields

• thPrimitiveName :: Name
• thPrimitiveDbName :: String

  It is used only to set polymorphic part of name of its container

• thPrimitiveConverter :: Name

  Name of a pair of functions converting the value to and from a type that is an instance of PrimitivePersistField

Instances

Eq THPrimitiveDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: THPrimitiveDef -> THPrimitiveDef -> Bool

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

Show THPrimitiveDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> THPrimitiveDef -> ShowS

show :: THPrimitiveDef -> String

showList :: [THPrimitiveDef] -> ShowS

data THConstructorDef

Constructors

THConstructorDef

Fields

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

Instances

Eq THConstructorDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: THConstructorDef -> THConstructorDef -> Bool

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

Show THConstructorDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> THConstructorDef -> ShowS

show :: THConstructorDef -> String

showList :: [THConstructorDef] -> ShowS

data THFieldDef

Constructors

THFieldDef

Fields

• thFieldName :: String

  name in the record, bar

• thDbFieldName :: String

  column name, SQLbar

• thDbTypeName :: Maybe String

  column type, inet, NUMERIC(5, 2), VARCHAR(50), etc.

• thExprName :: String

  name of constructor in the Field GADT, BarField

• thFieldType :: Type
• thEmbeddedDef :: Maybe [PSFieldDef String]
• thDefaultValue :: Maybe String

  default value in the database

• thReferenceParent :: Maybe (Maybe ((Maybe String, String), [String]), Maybe ReferenceActionType, Maybe ReferenceActionType)
• thFieldConverter :: Maybe Name

  name of a pair of functions

Instances

Eq THFieldDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: THFieldDef -> THFieldDef -> Bool

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

Show THFieldDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> THFieldDef -> ShowS

show :: THFieldDef -> String

showList :: [THFieldDef] -> ShowS

data THUniqueDef

Constructors

THUniqueDef

Fields

• thUniqueName :: String
• thUniqueType :: UniqueType
• thUniqueFields :: [Either String String]

  Either name of field, i.e, thFieldName, or expression

Instances

Eq THUniqueDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: THUniqueDef -> THUniqueDef -> Bool

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

Show THUniqueDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> THUniqueDef -> ShowS

show :: THUniqueDef -> String

showList :: [THUniqueDef] -> ShowS

data THUniqueKeyDef

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

Eq THUniqueKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: THUniqueKeyDef -> THUniqueKeyDef -> Bool

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

Show THUniqueKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> THUniqueKeyDef -> ShowS

show :: THUniqueKeyDef -> String

showList :: [THUniqueKeyDef] -> ShowS

data THAutoKeyDef

Constructors

THAutoKeyDef

Fields

• thAutoKeyConstrName :: String
• thAutoKeyIsDef :: Bool

Instances

Eq THAutoKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: THAutoKeyDef -> THAutoKeyDef -> Bool

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

Show THAutoKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> THAutoKeyDef -> ShowS

show :: THAutoKeyDef -> String

showList :: [THAutoKeyDef] -> ShowS

data PSEntityDef

Constructors

PSEntityDef

Fields

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

Instances

Eq PSEntityDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: PSEntityDef -> PSEntityDef -> Bool

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

Show PSEntityDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> PSEntityDef -> ShowS

show :: PSEntityDef -> String

showList :: [PSEntityDef] -> ShowS

ToJSON PSEntityDef

Defined in Database.Groundhog.TH.Settings

Methods

toJSON :: PSEntityDef -> Value

toEncoding :: PSEntityDef -> Encoding

toJSONList :: [PSEntityDef] -> Value

toEncodingList :: [PSEntityDef] -> Encoding

FromJSON PSEntityDef

Defined in Database.Groundhog.TH.Settings

Methods

parseJSON :: Value -> Parser PSEntityDef

parseJSONList :: Value -> Parser [PSEntityDef]

Lift PSEntityDef

Defined in Database.Groundhog.TH.Settings

Methods

lift :: PSEntityDef -> Q Exp

liftTyped :: PSEntityDef -> Q (TExp PSEntityDef)

data PSEmbeddedDef

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

Eq PSEmbeddedDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: PSEmbeddedDef -> PSEmbeddedDef -> Bool

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

Show PSEmbeddedDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> PSEmbeddedDef -> ShowS

show :: PSEmbeddedDef -> String

showList :: [PSEmbeddedDef] -> ShowS

FromJSON PSEmbeddedDef

Defined in Database.Groundhog.TH.Settings

Methods

parseJSON :: Value -> Parser PSEmbeddedDef

parseJSONList :: Value -> Parser [PSEmbeddedDef]

Lift PSEmbeddedDef

Defined in Database.Groundhog.TH.Settings

Methods

lift :: PSEmbeddedDef -> Q Exp

liftTyped :: PSEmbeddedDef -> Q (TExp PSEmbeddedDef)

data PSPrimitiveDef

Constructors

PSPrimitiveDef

Fields

• psPrimitiveName :: String
• psPrimitiveDbName :: Maybe String

  It is used only to set polymorphic part of name of its container

• psPrimitiveConverter :: String

  Name of a pair of functions converting the value to and from a type that is an instance of PrimitivePersistField

Instances

Eq PSPrimitiveDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: PSPrimitiveDef -> PSPrimitiveDef -> Bool

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

Show PSPrimitiveDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> PSPrimitiveDef -> ShowS

show :: PSPrimitiveDef -> String

showList :: [PSPrimitiveDef] -> ShowS

FromJSON PSPrimitiveDef

Defined in Database.Groundhog.TH.Settings

Methods

parseJSON :: Value -> Parser PSPrimitiveDef

parseJSONList :: Value -> Parser [PSPrimitiveDef]

Lift PSPrimitiveDef

Defined in Database.Groundhog.TH.Settings

Methods

lift :: PSPrimitiveDef -> Q Exp

liftTyped :: PSPrimitiveDef -> Q (TExp PSPrimitiveDef)

data PSConstructorDef

Constructors

PSConstructorDef

Fields

• psConstrName :: String
• psPhantomConstrName :: Maybe String
• psDbConstrName :: Maybe String
• psDbAutoKeyName :: Maybe String
• psConstrFields :: Maybe [PSFieldDef String]
• psConstrUniques :: Maybe [PSUniqueDef]

Instances

Eq PSConstructorDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: PSConstructorDef -> PSConstructorDef -> Bool

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

Show PSConstructorDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> PSConstructorDef -> ShowS

show :: PSConstructorDef -> String

showList :: [PSConstructorDef] -> ShowS

ToJSON PSConstructorDef

Defined in Database.Groundhog.TH.Settings

Methods

toJSON :: PSConstructorDef -> Value

toEncoding :: PSConstructorDef -> Encoding

toJSONList :: [PSConstructorDef] -> Value

toEncodingList :: [PSConstructorDef] -> Encoding

FromJSON PSConstructorDef

Defined in Database.Groundhog.TH.Settings

Methods

parseJSON :: Value -> Parser PSConstructorDef

parseJSONList :: Value -> Parser [PSConstructorDef]

Lift PSConstructorDef

Defined in Database.Groundhog.TH.Settings

Methods

lift :: PSConstructorDef -> Q Exp

liftTyped :: PSConstructorDef -> Q (TExp PSConstructorDef)

data PSFieldDef str

Constructors

PSFieldDef

Fields

• psFieldName :: str

  name in the record, bar

• psDbFieldName :: Maybe str

  column name, SQLbar

• psDbTypeName :: Maybe str

  column type, inet, NUMERIC(5, 2), VARCHAR(50), etc.

• psExprName :: Maybe str

  name of constructor in the Field GADT, BarField

• psEmbeddedDef :: Maybe [PSFieldDef str]
• psDefaultValue :: Maybe str

  default value in the database

• psReferenceParent :: Maybe (Maybe ((Maybe str, str), [str]), Maybe ReferenceActionType, Maybe ReferenceActionType)
• psFieldConverter :: Maybe str

  name of a pair of functions

Instances

Lift a => Lift (PSFieldDef a :: Type)

Defined in Database.Groundhog.TH.Settings

Methods

lift :: PSFieldDef a -> Q Exp

liftTyped :: PSFieldDef a -> Q (TExp (PSFieldDef a))

Eq str => Eq (PSFieldDef str)

Defined in Database.Groundhog.Generic

Methods

(==) :: PSFieldDef str -> PSFieldDef str -> Bool

(/=) :: PSFieldDef str -> PSFieldDef str -> Bool

Show str => Show (PSFieldDef str)

Defined in Database.Groundhog.Generic

Methods

showsPrec :: Int -> PSFieldDef str -> ShowS

show :: PSFieldDef str -> String

showList :: [PSFieldDef str] -> ShowS

ToJSON (PSFieldDef String)

Defined in Database.Groundhog.TH.Settings

Methods

toJSON :: PSFieldDef String -> Value

toEncoding :: PSFieldDef String -> Encoding

toJSONList :: [PSFieldDef String] -> Value

toEncodingList :: [PSFieldDef String] -> Encoding

FromJSON (PSFieldDef String)

Defined in Database.Groundhog.TH.Settings

Methods

parseJSON :: Value -> Parser (PSFieldDef String)

parseJSONList :: Value -> Parser [PSFieldDef String]

data PSUniqueDef

Constructors

PSUniqueDef

Fields

• psUniqueName :: String
• psUniqueType :: Maybe UniqueType
• psUniqueFields :: [Either String String]

Instances

Eq PSUniqueDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: PSUniqueDef -> PSUniqueDef -> Bool

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

Show PSUniqueDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> PSUniqueDef -> ShowS

show :: PSUniqueDef -> String

showList :: [PSUniqueDef] -> ShowS

ToJSON PSUniqueDef

Defined in Database.Groundhog.TH.Settings

Methods

toJSON :: PSUniqueDef -> Value

toEncoding :: PSUniqueDef -> Encoding

toJSONList :: [PSUniqueDef] -> Value

toEncodingList :: [PSUniqueDef] -> Encoding

FromJSON PSUniqueDef

Defined in Database.Groundhog.TH.Settings

Methods

parseJSON :: Value -> Parser PSUniqueDef

parseJSONList :: Value -> Parser [PSUniqueDef]

Lift PSUniqueDef

Defined in Database.Groundhog.TH.Settings

Methods

lift :: PSUniqueDef -> Q Exp

liftTyped :: PSUniqueDef -> Q (TExp PSUniqueDef)

data PSUniqueKeyDef

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

Eq PSUniqueKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: PSUniqueKeyDef -> PSUniqueKeyDef -> Bool

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

Show PSUniqueKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> PSUniqueKeyDef -> ShowS

show :: PSUniqueKeyDef -> String

showList :: [PSUniqueKeyDef] -> ShowS

ToJSON PSUniqueKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

toJSON :: PSUniqueKeyDef -> Value

toEncoding :: PSUniqueKeyDef -> Encoding

toJSONList :: [PSUniqueKeyDef] -> Value

toEncodingList :: [PSUniqueKeyDef] -> Encoding

FromJSON PSUniqueKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

parseJSON :: Value -> Parser PSUniqueKeyDef

parseJSONList :: Value -> Parser [PSUniqueKeyDef]

Lift PSUniqueKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

lift :: PSUniqueKeyDef -> Q Exp

liftTyped :: PSUniqueKeyDef -> Q (TExp PSUniqueKeyDef)

data PSAutoKeyDef

Constructors

PSAutoKeyDef

Fields

• psAutoKeyConstrName :: Maybe String
• psAutoKeyIsDef :: Maybe Bool

Instances

Eq PSAutoKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

(==) :: PSAutoKeyDef -> PSAutoKeyDef -> Bool

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

Show PSAutoKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

showsPrec :: Int -> PSAutoKeyDef -> ShowS

show :: PSAutoKeyDef -> String

showList :: [PSAutoKeyDef] -> ShowS

ToJSON PSAutoKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

toJSON :: PSAutoKeyDef -> Value

toEncoding :: PSAutoKeyDef -> Encoding

toJSONList :: [PSAutoKeyDef] -> Value

toEncodingList :: [PSAutoKeyDef] -> Encoding

FromJSON PSAutoKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

parseJSON :: Value -> Parser PSAutoKeyDef

parseJSONList :: Value -> Parser [PSAutoKeyDef]

Lift PSAutoKeyDef

Defined in Database.Groundhog.TH.Settings

Methods

lift :: PSAutoKeyDef -> Q Exp

liftTyped :: PSAutoKeyDef -> Q (TExp PSAutoKeyDef)

Orphan instances

ToJSON UniqueType

Methods

toJSON :: UniqueType -> Value

toEncoding :: UniqueType -> Encoding

toJSONList :: [UniqueType] -> Value

toEncodingList :: [UniqueType] -> Encoding

ToJSON ReferenceActionType

Methods

toJSON :: ReferenceActionType -> Value

toEncoding :: ReferenceActionType -> Encoding

toJSONList :: [ReferenceActionType] -> Value

toEncodingList :: [ReferenceActionType] -> Encoding

FromJSON UniqueType

Methods

parseJSON :: Value -> Parser UniqueType

parseJSONList :: Value -> Parser [UniqueType]

FromJSON ReferenceActionType

Methods

parseJSON :: Value -> Parser ReferenceActionType

parseJSONList :: Value -> Parser [ReferenceActionType]

Lift UniqueType

Methods

lift :: UniqueType -> Q Exp

liftTyped :: UniqueType -> Q (TExp UniqueType)

Lift ReferenceActionType

Methods

lift :: ReferenceActionType -> Q Exp

liftTyped :: ReferenceActionType -> Q (TExp ReferenceActionType)

Lift a => Lift (PSFieldDef a :: Type)

Methods

lift :: PSFieldDef a -> Q Exp

liftTyped :: PSFieldDef a -> Q (TExp (PSFieldDef a))

ToJSON (PSFieldDef String)

Methods

toJSON :: PSFieldDef String -> Value

toEncoding :: PSFieldDef String -> Encoding

toJSONList :: [PSFieldDef String] -> Value

toEncodingList :: [PSFieldDef String] -> Encoding

FromJSON (PSFieldDef String)

Methods

parseJSON :: Value -> Parser (PSFieldDef String)

parseJSONList :: Value -> Parser [PSFieldDef String]