Welcome to pg-entity's documentation.

Read the Tutorial to learn how to use the library.

Read the Guides to learn more about specific usecases and patterns.

See also these resources to understand the library's underlying mechanisms:

  • postgresql-simple: The library that provies the Query primitives and the database connection

  • pg-transact: The library that provides the transaction monad transformer in which our queries run

  • Oliver Charles' 24 Days of GHC Extensions series if you want to understand the underlying derivation mechanisms that enable us to write less code:

  • Richard Eisenberg's Avoid boilerplate instances with -XDerivingVia is most helpful to understand how the GenericEntity mechanism

    works, as well as a showcase for other deriving strategies.