Awesome
Persistent
![Join the chat at https://gitter.im/yesodweb/persistent](https://badges.gitter.im/Join%20Chat.svg)
A Haskell datastore. Datastores are often referred to as "ORM"s. While 'O' traditionally means object, the concept can be generalized as:
avoidance of boilerplate serialization
In addition , the ORM concept is a way to make what is usually an un-typed driver type-safe. In dynamic languages rather than compile time errors, safety comes from creating specific dynamic errors rather than sending nonsense queries to the database.
Persistent's goal is to catch every possible error at compile-time, and it comes close to that.
Quickstart
<details> <summary> Click to show package.yaml part. Learn more at <a href="https://www.yesodweb.com/book/persistent" target="_blank">http://www.yesodweb.com/book/persistent.</a> </summary>dependencies:
- base ^>= 4.17
- text ^>= 2
- persistent ^>= 2.14
- persistent-sqlite ^>= 2.13
</details>
<p></p>
{-# LANGUAGE EmptyDataDecls #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE QuasiQuotes #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TypeFamilies #-}
import Control.Monad.IO.Class (liftIO)
import Database.Persist
import Database.Persist.Sqlite
import Database.Persist.TH
import Data.Text
share [mkPersist sqlSettings, mkMigrate "migrateAll"] [persistLowerCase|
Person
name Text
age Int Maybe
deriving Show
|]
main :: IO ()
main = runSqlite ":memory:" $ do
-- setup db schema
runMigration migrateAll
-- write to db
insert $ Person "Jane Doe" Nothing
johnId <- insert $ Person "John Doe" $ Just 35
-- read from db
john1 <- selectList [PersonId ==. johnId] [LimitTo 1]
john2 <- get johnId
liftIO $ print (john1 :: [Entity Person])
liftIO $ print (john2 :: Maybe Person)
-- delete from db
delete johnId
deleteWhere [PersonId ==. johnId]
Backend agnostic
Supports PostgreSql, Sqlite, MongoDB, Redis, ZooKeeper, and many other databases via persistent-odbc. The MySQL backend is in need of a maintainer. Currently there are issues with migrations and support for composite and primary keys is lacking.
Persistent is designed to be adaptable to any datastore, and to allow multiple datastores to be used simultaneously. The serialization layer should be adaptable to any datastore.
Providing a universal query layer will always be limiting. A major limitation for SQL databases is that the persistent library does not directly provide joins. However, you can use Esqueleto with Persistent's serialization to write type-safe SQL queries. Key-value stores such as Redis can be used with persistent, but only fill out the key-value portion of the API (PersistStore) rather than the query portion (PersistQuery).
Persistent provides several hooks to create backend-specific functionality. One can always fall back to using the raw database driver or other lower-level or less type-safe libraries and can utilize Persistent for un-serializing the database response to a Haskell record.
Help improve Persistent
To install from source clone the repo and run stack build
to build all targets. Persistent
supports many backends. If you have only some of these installed the
development doc shows how to build against a subset of
targets.
For more information on how to hack on the persistent
set of libraries, see
the development.md
file.