Database.Persist.Relational

This module works as a bridge between Haskell Relational Record and Persistent. It uses the persistent entities definition instead of obtaining schema from DB at compilation time.

See: https://github.com/himura/persistent-relational-record#readme

Documentation

runQuery

Arguments

:: (MonadResource m, MonadReader env m, HasPersistBackend env, BaseBackend env ~ SqlBackend, ToSql PersistValue p, ToPersistEntity a b)

=> Query p a

Query to get record type a requires parameter p

-> p

Parameter type

-> Source m b

Execute a HRR Query and return the stream of its results.

rawQuery :: (MonadResource m, MonadReader env m, HasPersistBackend env, BaseBackend env ~ SqlBackend, ToSql PersistValue p) => Query p a -> p -> Source m [PersistValue]

mkHrrInstances :: [EntityDef] -> Q [Dec]

Generate instances for haskell-relational-record.

defineTableFromPersistent

Arguments

:: Name

Name of the persistent record type corresponds to the table

-> [EntityDef]

EntityDef which is generated by persistent

-> Q [Dec]

Generate all templates about table from persistent table definition using default naming rule.

defineTableFromPersistentWithConfig

Arguments

:: Config

Configration for haskell relational record

-> String

Database schema name

-> Name

Name of the persistent record type corresponds to the table

-> [EntityDef]

EntityDef which is generated by persistent

-> Q [Dec]

Generate all templates about table from persistent table definition.

defineFromToSqlPersistValue :: TypeQ -> Q [Dec]

Generate FromSql PersistValue and ToSql PersistValue instances for PersistField types.

defaultConfig :: Config

Default configuration.

class ToPersistEntity a b | a -> b, b -> a where

Minimal complete definition

recordFromSql'

Methods

recordFromSql' :: RecordFromSql PersistValue b

Instances

ToPersistEntity () ()

Methods

recordFromSql' :: RecordFromSql PersistValue ()

(ToPersistEntity a c, ToPersistEntity b d) => ToPersistEntity (a, b) (c, d)

Methods

recordFromSql' :: RecordFromSql PersistValue (c, d)