Database.Persist.Audit.Generator

Documentation

data AuditGeneratorSettings

Five options for generating Audit Models and ToAudit Instances.

Constructors

AuditGeneratorSettings

Fields

• childSpacing :: Int

  The number of spaces to add for all items that appear under an EntityName.

• auditTag :: Text

  The tag that will be added to the original model name in the generated audit models. If auditTag is History then User will become UserHistory.

• keepEntityDerive :: Bool

  If True, the generated Audit Models will maintain the same derived Type Classes as the original file.

• keepComments :: Bool

  If True, the generated Audit Models will maintain the same comments as the original file.

• keepSpacing :: Bool

  If True, the generated Audit Models will maintain the same spacing as the original file.

• foreignKeyType :: ForeignKeyType

  Foreign Keys can be the original type, ByteString or Int64.

Instances

Eq AuditGeneratorSettings

Methods

(==) :: AuditGeneratorSettings -> AuditGeneratorSettings -> Bool

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

Read AuditGeneratorSettings

Methods

readsPrec :: Int -> ReadS AuditGeneratorSettings

readList :: ReadS [AuditGeneratorSettings]

readPrec :: ReadPrec AuditGeneratorSettings

readListPrec :: ReadPrec [AuditGeneratorSettings]

Show AuditGeneratorSettings

Methods

showsPrec :: Int -> AuditGeneratorSettings -> ShowS

show :: AuditGeneratorSettings -> String

showList :: [AuditGeneratorSettings] -> ShowS

data ForeignKeyType

All foreign keys are kept in the audit models but derefenced so the original models | can be deleted without affecting the audit models. This is a work around in case the | original models and the audit models are stored in different databases. | Persist cannot handle keys across SQL and Mongo.

Constructors

OriginalKey

Default setting. Link the ids as the original type with a "noreference" tag.

MongoKeyInSQL

Store Mongo Key as a ByteString in SQL.

SQLKeyInMongo

Store SQL Key as an Int64 in Mongo.

Instances

Eq ForeignKeyType

Methods

(==) :: ForeignKeyType -> ForeignKeyType -> Bool

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

Read ForeignKeyType

Methods

readsPrec :: Int -> ReadS ForeignKeyType

readList :: ReadS [ForeignKeyType]

readPrec :: ReadPrec ForeignKeyType

readListPrec :: ReadPrec [ForeignKeyType]

Show ForeignKeyType

Methods

showsPrec :: Int -> ForeignKeyType -> ShowS

show :: ForeignKeyType -> String

showList :: [ForeignKeyType] -> ShowS

defaultSettings :: AuditGeneratorSettings

Settings that the author assumed would be most common.

generateAuditModels :: AuditGeneratorSettings -> PersistModelFile -> Text

Convert a list of TopLevel to a list of Audit Models in Text.

printForeignKey :: ForeignKeyType -> Text -> (Text, Text)

Select the correct type from Audit Model to original Model. Used for cross database. | fst is the type and snd is the original type in comment for if using cross database.

printTopLevel :: AuditGeneratorSettings -> PersistModelFilePiece -> Text

Convert a TopLevel to an Audit Model, white space or comment in Text.

printEntityChild :: AuditGeneratorSettings -> EntityChild -> Text

Convert an EntityChild to a piece of an Audit Model in Text. | It does not generate anything for EntityUnique, EntityPrimary or EntityForeign | because Audits do not need to be unique, they will have an automatically produced Key | and should not have any foreign keys connecting back to the original model.

generateToAuditInstances :: AuditGeneratorSettings -> PersistModelFile -> Text

Convert a list of TopLevel to a to a list of ToAudit in Text.

printToAuditInstance :: AuditGeneratorSettings -> PersistModelFilePiece -> Text

Convert TopLevel to an instance of ToAudit in Text.

printModelAccessor :: AuditGeneratorSettings -> Text -> EntityChild -> Text

Convert EntityChild to a Model accessor.

printIfForeignKeyAlternate :: ForeignKeyType -> Text -> Text

Select the correct function for handling foreign keys.

printIfForeignKeyAlternate2 :: ForeignKeyType -> Text -> EntityFieldType -> Text

printEntityFieldTypeFunctionConnector :: EntityFieldType -> (Bool, Text)

If fst True then prefix the function with fmap

stringEndsInId :: String -> Bool

Return true if the last two characters are Id.

firstLetterToUpperCase :: String -> String

Convert the first letter of a String to the corresponding uppercase letter.

firstLetterToLowerCase :: String -> String

Convert the first letter of a String to the corresponsing lowercase letter.