Database.Persist.GenericSql

This is a helper module for creating SQL backends. Regular users do not need to use this module.

Documentation

newtype SqlPersist m a

Constructors

SqlPersist

Fields

unSqlPersist :: ReaderT Connection m a

Instances

MonadTrans SqlPersist

Monad m => Monad (SqlPersist m)

Functor m => Functor (SqlPersist m)

Applicative m => Applicative (SqlPersist m)

MonadPeelIO m => MonadPeelIO (SqlPersist m)

MonadIO m => MonadIO (SqlPersist m)

MonadPeelIO m => PersistBackend (SqlPersist m)

data Connection

type ConnectionPool = Pool Connection

data Statement

runSqlConn :: MonadPeelIO m => SqlPersist m a -> Connection -> m a

runSqlPool :: MonadPeelIO m => SqlPersist m a -> Pool Connection -> m a

type Migration m = WriterT [String] (WriterT CautiousMigration m) ()

parseMigration :: Monad m => Migration m -> m (Either [String] CautiousMigration)

parseMigration' :: Monad m => Migration m -> m CautiousMigration

printMigration :: MonadPeelIO m => Migration (SqlPersist m) -> SqlPersist m ()

getMigration :: MonadPeelIO m => Migration (SqlPersist m) -> SqlPersist m [Sql]

runMigration :: MonadPeelIO m => Migration (SqlPersist m) -> SqlPersist m ()

runMigrationSilent :: MonadPeelIO m => Migration (SqlPersist m) -> SqlPersist m [String]

Same as runMigration, but returns a list of the SQL commands executed instead of printing them to stderr.

runMigrationUnsafe :: MonadPeelIO m => Migration (SqlPersist m) -> SqlPersist m ()

migrate :: (MonadPeelIO m, PersistEntity val) => val -> Migration (SqlPersist m)

mkMigrate :: String -> [EntityDef] -> Q [Dec]

Creates a single function to perform all migrations for the entities defined here. One thing to be aware of is dependencies: if you have entities with foreign references, make sure to place those definitions after the entities they reference.