Fields

• psToDBName :: !(Text -> Text)

  Modify the Haskell-style name into a database-style name.

• psToFKName :: !(EntityNameHS -> ConstraintNameHS -> Text)

  A function for generating the constraint name, with access to the entity and constraint names. Default value: mappend

  Since: 2.13.0.0

• psStrictFields :: !Bool

  Whether fields are by default strict. Default value: True.

  Since: 1.2

• psIdName :: !Text

  The name of the id column. Default value: id The name of the id column can also be changed on a per-model basis https://github.com/yesodweb/persistent/wiki/Persistent-entity-syntax

  Since: 2.0

Fields

• lineIndent :: Int
   
• tokens :: NonEmpty Token
   

Fields

• lwcLines :: NonEmpty Line
   
• lwcComments :: [Text]
   

Fields

• unboundForeignDefs :: [UnboundForeignDef]

  A list of foreign definitions on the parsed entity.

  Since: 2.13.0.0

• unboundPrimarySpec :: PrimarySpec

  The specification for the primary key of the unbound entity.

  Since: 2.13.0.0

• unboundEntityDef :: EntityDef

  The incomplete and partial EntityDef that we're defining. We re-use the type here to prevent duplication, but several of the fields are unset and left to defaults.

  Since: 2.13.0.0

• unboundEntityFields :: [UnboundFieldDef]

  The list of fields for the entity. We're not capable of knowing information like "is this a reference?" or "what's the underlying type of the field?" yet, so we defer those to the Template Haskell execution.

  Since: 2.13.0.0

Fields

• unboundForeignFields :: UnboundForeignFieldList

  Fields in the source entity.

  Since: 2.13.0.0

• unboundForeignDef :: ForeignDef

  The ForeignDef which needs information filled in.

  This value is unreliable. See the parsing code to see what data is filled in here.

  Since: 2.13.0.0

Fields

• unboundFieldNameHS :: FieldNameHS

  The Haskell name of the field. This is parsed directly from the definition, and is used to generate the Haskell record field and the EntityField definition.

  Since: 2.13.0.0

• unboundFieldNameDB :: FieldNameDB

  The database name of the field. By default, this is determined by the PersistSettings record at parse time. You can customize this with a sql= attribute:

      name Text  sql=foo_name
  

  Since: 2.13.0.0

• unboundFieldAttrs :: [FieldAttr]

  The attributes present on the field. For rules on parsing and utility, see the comments on the datatype.

  Since: 2.13.0.0

• unboundFieldStrict :: Bool

  Whether or not the field should be strict in the generated Haskell code.

  Since: 2.13.0.0

• unboundFieldType :: FieldType

  The type of the field, as far as is known at parse time.

  The TemplateHaskell code will reconstruct a Type out of this, but the names will be imported as-is.

  Since: 2.13.0.0

• unboundFieldCascade :: FieldCascade

  We parse if there's a FieldCascade on the field. If the field is not a reference, this information is ignored.

  Post
     user UserId OnDeleteCascade
  

  Since: 2.13.0.0

• unboundFieldGenerated :: Maybe Text

  Contains an expression to generate the column. If this is present, then the column will not be written to the database, but generated by the expression every time.

  Item
      subtotal Int
      taxRate  Rational
      total    Int      generated="subtotal * tax_rate"
  

  Since: 2.13.0.0

• unboundFieldComments :: Maybe Text

  Any comments present on the field. Documentation comments use a Haskell-like syntax, and must be present before the field in question.

  Post
      -- | This is the blog post title.
      title Text
      -- | You can have multi-line comments.
      -- | But each line must have the pipe character.
      author UserId
  

  Since: 2.13.0.0

Fields

• unboundCompositeCols :: [FieldNameHS]

  The field names for the primary key.

  Since: 2.13.0.0

• unboundCompositeAttrs :: [Attr]

  A list of attributes defined on the primary key. This is anything that occurs after a ! character.

  Since: 2.13.0.0

Fields

• unboundIdEntityName :: EntityNameHS
   
• unboundIdDBName :: !FieldNameDB
   
• unboundIdAttrs :: [FieldAttr]
   
• unboundIdCascade :: FieldCascade
   
• unboundIdType :: Maybe FieldType
   

Fields

• ffrSourceField :: FieldNameHS

  The column on the source table.

  Since: 2.13.0.0

• ffrTargetField :: FieldNameHS

  The column on the target table.

  Since: 2.13.0.0