Modulepersistent-2.14.6.3Haskell2010

Database.Persist.EntityDef.Internal

The EntityDef type, fields, and constructor are exported from this module. Breaking changes to the EntityDef type are not reflected in the major version of the API. Please import from Database.Persist.EntityDef instead.

If you need this module, please file a GitHub issue why.

2 types
4 values

Packagepersistent-2.14.6.3
Exports6
LanguageHaskell2010
LicenceMIT
SourceInternal.hs

datadata EntityDef

An EntityDef represents the information that persistent knows about an Entity. It uses this information to generate the Haskell datatype, the SQL migrations, and other relevant conversions.

Constructors

EntityDef
- entityHaskell :: !EntityNameHS
  The name of the entity as Haskell understands it.
- entityDB :: !EntityNameDB
  The name of the database table corresponding to the entity.
- entityId :: !EntityIdDef
  The entity's primary key or identifier.
- entityAttrs :: ![Attr]
  The persistent entity syntax allows you to add arbitrary Attrs to an entity using the ! operator. Those attributes are stored in this list.
- entityFields :: ![FieldDef]
  The fields for this entity. Note that the ID field will not be present in this list. To get all of the fields for an entity, use keyAndEntityFields.
- entityUniques :: ![UniqueDef]
  The Uniqueness constraints for this entity.
- entityForeigns :: ![ForeignDef]
  The foreign key relationships that this entity has to other entities.
- entityDerives :: ![Text]
  A list of type classes that have been derived for this entity.
- entityExtra :: !Map Text [ExtraLine]
- entitySum :: !Bool
  Whether or not this entity represents a sum type in the database.
- entityComments :: !Maybe Text
  Optional comments on the entity.

Instances5Eq, Ord, Read, Show, Lift

Eq EntityDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base
Ord EntityDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base
Read EntityDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base
Show EntityDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base
Lift EntityDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base

valueentityPrimary :: EntityDef -> Maybe CompositeDef

valueentitiesPrimary :: EntityDef -> NonEmpty FieldDef

Return the [FieldDef] for the entity keys.

valuekeyAndEntityFields :: EntityDef -> NonEmpty FieldDef

Returns a NonEmpty list of FieldDef that correspond with the key columns for an EntityDef.

valuetoEmbedEntityDef :: EntityDef -> EmbedEntityDef

datadata EntityIdDef

The definition for the entity's primary key ID.

Constructors

EntityIdField !FieldDef
The entity has a single key column, and it is a surrogate key - that is, you can't go from rec -> Key rec.
EntityIdNaturalKey !CompositeDef
The entity has a natural key. This means you can write rec -> Key rec because all the key fields are present on the datatype.
A natural key can have one or more columns.

Instances5Eq, Ord, Read, Show, Lift

Eq EntityIdDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base
Ord EntityIdDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base
Read EntityIdDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base
Show EntityIdDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base
Lift EntityIdDefDefined in persistent-2.14.6.3 · Database.Persist.Types.Base