Parses a Persist Model file and produces Audit Models

Latest on Hackage:

This package is not currently in any snapshots. If you're interested in using it, we recommend adding it to Stackage Nightly. Doing so will make builds more reliable, and allow to host generated Haddocks.

BSD3 licensed by James M.C. Haver II
Maintained by


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.

cabal run -- -m models -a auditModels -i ToAuditInstances.hs -c mongoDbToSql
cabal run -- -m models -a auditModels -i ToAuditInstances.hs -c sqlToMongoDb

You can also use this as a library for the following purporses:

  • To parse Persistent model files
  • To generate Audit Models from other Models
  • To generate ToAudit instances
  • Use query functions from Database.Persist.Audit.Queries:insertAndAudit, deleteAndAudit, deleteWhereAndAudit, updateAndAudit, updateWhereAndAudit, insertUniqueAndAudit, deleteByAndAudit, repsertAndAudit, replaceAndAudit

This package is originally based on this article Maintaining a Log of Database Changes. Specifically, the first example: 'A Separate "History" Table for Each Table Being Audited'.


Revision history for persistent-audit -- 2016-09-08

  • Move parsing functions and types to their own package - persistent-parser.
  • Move Main.hs to its own directory.
  • Add tests for all audit queries. -- 2016-08-16

  • Add four queries: insertUniqueAndAudit, deleteByAndAudit, repsertAndAudit, replaceAndAudit -- 2016-08-11

  • Add ToJSON, FromJSON and Hashable instances for AuditAction.
  • Clean up some compiler warnings. -- 2016-05-03

  • Fix Haddock documentation. -- 2016-05-02

  • First version.
comments powered byDisqus