Maintainer's Corner

Readme for persistent-audit-0.2.0.0

persistent-audit

This package includes an executable that takes a Persistent models (tables) file and returns a Persistent models file with audit models (tables) for each individual table in the original file. It can optionally return a file with an implementation of the ToAudit class for each pair of model and its audit model. The automatically produced audit model files and ToAudit instances are a best attempt and will not necessarily compile without editing. If you are interested in having different styles of Audit models supported or find any bugs, please inform me. It currently supports Persistent >= 2.2 && <= 2.5.

The executable can be run like this:

cabal run -- -m models -a auditModels

It can also parse Haskell files that have Persist model QuasiQuoters [persistLowerCase||] and [persistUpperCase||]:

cabal run -- -m Models.hs -a auditModels

And if you want the optional ToAudit implementation:

cabal run -- -m models -a auditModels -i ToAuditInstances.hs

It can also help you build Audit Models that will be used in a separate database (MongoDB to SQL or SQL to MongoDB) by converting MongoDB keys to Bytestring or SQL keys to Int64.