Converts a quasi-quoted syntax into a list of entity definitions, to be used as input to the template haskell generation code (mkPersist).

Apply persistWith to upperCaseSettings.

Apply persistWith to lowerCaseSettings.

Same as persistWith, but uses an external file instead of a quasiquotation.

Create data types and appropriate PersistEntity instances for the given EntityDefs. Works well with the persist quasi-quoter.

Settings to be passed to the mkPersist function.

Which database backend we're using.

When generating data types, each type is given a generic version- which works with any backend- and a type synonym for the commonly used backend. This is where you specify that commonly used backend.

Create generic types that can be used with multiple backends. Good for reusable code, but makes error messages harder to understand. Default: True.

Prefix field names with the model name. Default: True.

Generate ToJSON/FromJSON instances for each model types. If it's Nothing, no instances will be generated. Default:

  Just EntityJSON
      { entityToJSON = 'keyValueEntityToJSON
      , entityFromJSON = 'keyValueEntityFromJSON
      }

Instead of generating normal field accessors, generator lens-style accessors.

Default: False

Since 1.3.1

Create an MkPersistSettings with default values.

Use the SqlPersist backend.

Same as sqlSettings, but set mpsGeneric to False.

Since 1.1.1

Creates a single function to perform all migrations for the entities defined here. One thing to be aware of is dependencies: if you have entities with foreign references, make sure to place those definitions after the entities they reference.

Save the EntityDefs passed in under the given name.

Generate a DeleteCascade instance for the given EntityDefs.

Apply the given list of functions to the same EntityDefs.

This function is useful for cases such as:

>>> share [mkSave "myDefs", mkPersist sqlSettings] [persistLowerCase|...|]

Automatically creates a valid PersistField instance for any datatype that has valid Show and Read instances. Can be very convenient for Enum types.

Automatically creates a valid PersistField instance for any datatype that has valid ToJSON and FromJSON instances. For a datatype T it generates instances similar to these:

    instance PersistField T where
        toPersistValue = PersistByteString . L.toStrict . encode
        fromPersistValue = (left T.pack) . eitherDecodeStrict' <=< fromPersistValue
    instance PersistFieldSql T where
        sqlType _ = SqlString

produce code similar to the following:

   instance PersistEntity e => PersistField e where
      toPersistValue = PersistMap $ zip columNames (map toPersistValue . toPersistFields)
      fromPersistValue (PersistMap o) = 
          let columns = HM.fromList o
          in fromPersistValues $ map (name ->
            case HM.lookup name columns of
              Just v -> v
              Nothing -> PersistNull
      fromPersistValue x = Left $ Expected PersistMap, received:  ++ show x
      sqlType _ = SqlString