Database.Persist.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.

Retrieve the Haskell name of the given entity.

Return the database name for the given entity.

Retrieve the list of FieldDef that makes up the fields of the entity.

This does not return the fields for an Id column or an implicit id. It will return the key columns if you used the Primary syntax for defining the primary key.

This does not return fields that are marked SafeToRemove or MigrationOnly - so it only returns fields that are represented in the Haskell type. If you need those fields, use getEntityFieldsDatabase.

This returns all of the FieldDef defined for the EntityDef, including those fields that are marked as MigrationOnly (and therefore only present in the database) or SafeToRemove (and a migration will drop the column if it exists in the database).

For all the fields that are present on the Haskell-type, see getEntityFields.

Retrieve the list of UniqueDef from an EntityDef. As of version 2.14, this will also include the primary key on the entity, if one is defined. If you do not want the primary key, see getEntityUniquesNoPrimaryKey.

Retrieve the list of UniqueDef from an EntityDef. This does not include a Primary key, if one is defined. A future version of persistent will include a Primary key among the Unique constructors for the Entity.

Gets the Source of the definition of the entity.

Note that as of this writing the span covers the entire file or quasiquote where the item is defined due to parsing limitations. This may be changed in a future release to be more accurate.

Return the [FieldDef] for the entity keys.

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

Returns a NonEmpty list of FieldDef that correspond with the key columns for an EntityDef including those fields that are marked as MigrationOnly (and therefore only present in the database) or SafeToRemove (and a migration will drop the column if it exists in the database).

For fields on the Haskell type use keyAndEntityFieldsDatabase

Set an entityId to be the given FieldDef.

Perform a mapping function over all of the entity fields, as determined by getEntityFieldsDatabase.

The definition for the entity's primary key ID.