Squeal.PostgreSQL.Session

Using Squeal in your application will come down to defining the DB :: SchemasType of your database and including PQ DB DB in your application's monad transformer stack, giving it an instance of MonadPQ DB.

Documentation

newtype PQ (db0 :: SchemasType) (db1 :: SchemasType) (m :: Type -> Type) (x :: Type)

We keep track of the schema via an Atkey indexed state monad transformer, PQ.

Constructors

PQ

Fields

• unPQ :: K Connection db0 -> m (K x db1)

Instances

IndexedMonadTransPQ PQ

Defined in Squeal.PostgreSQL.Session

Methods

define :: MonadIO io => Definition db0 db1 -> PQ db0 db1 io ()

IndexedMonadTrans PQ

Defined in Squeal.PostgreSQL.Session

Methods

pqAp :: Monad m => PQ i j m (x -> y) -> PQ j k m x -> PQ i k m y

pqJoin :: Monad m => PQ i j m (PQ j k m y) -> PQ i k m y

pqBind :: Monad m => (x -> PQ j k m y) -> PQ i j m x -> PQ i k m y

pqThen :: Monad m => PQ j k m y -> PQ i j m x -> PQ i k m y

pqAndThen :: Monad m => (y -> PQ j k m z) -> (x -> PQ i j m y) -> x -> PQ i k m z

Migratory Definition (Indexed PQ IO ())

pure migrations

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration Definition) db0 db1 -> Indexed PQ IO () db0 db1

db0 ~ db1 => MFunctor (PQ db0 db1 :: (Type -> Type) -> Type -> Type)

Defined in Squeal.PostgreSQL.Session

Methods

hoist :: Monad m => (forall a. m a -> n a) -> PQ db0 db1 m b -> PQ db0 db1 n b

Migratory (IsoQ Definition) (IsoQ (Indexed PQ IO ()))

pure rewindable migrations

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (IsoQ Definition)) db0 db1 -> IsoQ (Indexed PQ IO ()) db0 db1

Migratory (IsoQ (Indexed PQ IO ())) (IsoQ (Indexed PQ IO ()))

impure rewindable migrations

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (IsoQ (Indexed PQ IO ()))) db0 db1 -> IsoQ (Indexed PQ IO ()) db0 db1

MonadBase b m => MonadBase b (PQ schema schema m)

Defined in Squeal.PostgreSQL.Session

Methods

liftBase :: b α -> PQ schema schema m α

(MonadBaseControl b m, schema0 ~ schema1) => MonadBaseControl b (PQ schema0 schema1 m)

Defined in Squeal.PostgreSQL.Session

Associated Types

type StM (PQ schema0 schema1 m) a :: Type

Methods

liftBaseWith :: (RunInBase (PQ schema0 schema1 m) b -> b a) -> PQ schema0 schema1 m a

restoreM :: StM (PQ schema0 schema1 m) a -> PQ schema0 schema1 m a

(MonadIO io, db0 ~ db, db1 ~ db) => MonadPQ db (PQ db0 db1 io)

Defined in Squeal.PostgreSQL.Session

Methods

executeParams :: Statement db x y -> x -> PQ db0 db1 io (Result y)

executeParams_ :: Statement db x () -> x -> PQ db0 db1 io ()

execute :: Statement db () y -> PQ db0 db1 io (Result y)

execute_ :: Statement db () () -> PQ db0 db1 io ()

executePrepared :: Traversable list => Statement db x y -> list x -> PQ db0 db1 io (list (Result y))

executePrepared_ :: Foldable list => Statement db x () -> list x -> PQ db0 db1 io ()

Migratory (OpQ Definition) (OpQ (Indexed PQ IO ()))

pure rewinds

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (OpQ Definition)) db0 db1 -> OpQ (Indexed PQ IO ()) db0 db1

Migratory (OpQ (Indexed PQ IO ())) (OpQ (Indexed PQ IO ()))

impure rewinds

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (OpQ (Indexed PQ IO ()))) db0 db1 -> OpQ (Indexed PQ IO ()) db0 db1

Migratory (Indexed PQ IO ()) (Indexed PQ IO ())

impure migrations

Defined in Squeal.PostgreSQL.Session.Migration

Methods

runMigrations :: Path (Migration (Indexed PQ IO ())) db0 db1 -> Indexed PQ IO () db0 db1

db0 ~ db1 => MonadTrans (PQ db0 db1)

Defined in Squeal.PostgreSQL.Session

Methods

lift :: Monad m => m a -> PQ db0 db1 m a

db0 ~ db1 => MMonad (PQ db0 db1)

Defined in Squeal.PostgreSQL.Session

Methods

embed :: Monad n => (forall a. m a -> PQ db0 db1 n a) -> PQ db0 db1 m b -> PQ db0 db1 n b

db0 ~ db1 => MonadTransControl (PQ db0 db1)

Defined in Squeal.PostgreSQL.Session

Associated Types

type StT (PQ db0 db1) a :: Type

Methods

liftWith :: Monad m => (Run (PQ db0 db1) -> m a) -> PQ db0 db1 m a

restoreT :: Monad m => m (StT (PQ db0 db1) a) -> PQ db0 db1 m a

(Monad m, db0 ~ db1) => Monad (PQ db0 db1 m)

Defined in Squeal.PostgreSQL.Session

Methods

(>>=) :: PQ db0 db1 m a -> (a -> PQ db0 db1 m b) -> PQ db0 db1 m b

(>>) :: PQ db0 db1 m a -> PQ db0 db1 m b -> PQ db0 db1 m b

return :: a -> PQ db0 db1 m a

fail :: String -> PQ db0 db1 m a

Monad m => Functor (PQ db0 db1 m)

Defined in Squeal.PostgreSQL.Session

Methods

fmap :: (a -> b) -> PQ db0 db1 m a -> PQ db0 db1 m b

(<$) :: a -> PQ db0 db1 m b -> PQ db0 db1 m a

(Monad m, db0 ~ db1) => MonadFail (PQ db0 db1 m)

Defined in Squeal.PostgreSQL.Session

Methods

fail :: String -> PQ db0 db1 m a

(Monad m, db0 ~ db1) => Applicative (PQ db0 db1 m)

Defined in Squeal.PostgreSQL.Session

Methods

pure :: a -> PQ db0 db1 m a

(<*>) :: PQ db0 db1 m (a -> b) -> PQ db0 db1 m a -> PQ db0 db1 m b

liftA2 :: (a -> b -> c) -> PQ db0 db1 m a -> PQ db0 db1 m b -> PQ db0 db1 m c

(*>) :: PQ db0 db1 m a -> PQ db0 db1 m b -> PQ db0 db1 m b

(<*) :: PQ db0 db1 m a -> PQ db0 db1 m b -> PQ db0 db1 m a

(MonadIO m, schema0 ~ schema1) => MonadIO (PQ schema0 schema1 m)

Defined in Squeal.PostgreSQL.Session

Methods

liftIO :: IO a -> PQ schema0 schema1 m a

(MonadThrow m, db0 ~ db1) => MonadThrow (PQ db0 db1 m)

Defined in Squeal.PostgreSQL.Session

Methods

throwM :: Exception e => e -> PQ db0 db1 m a

(MonadCatch m, db0 ~ db1) => MonadCatch (PQ db0 db1 m)

Defined in Squeal.PostgreSQL.Session

Methods

catch :: Exception e => PQ db0 db1 m a -> (e -> PQ db0 db1 m a) -> PQ db0 db1 m a

(MonadMask m, db0 ~ db1) => MonadMask (PQ db0 db1 m)

Defined in Squeal.PostgreSQL.Session

Methods

mask :: ((forall a. PQ db0 db1 m a -> PQ db0 db1 m a) -> PQ db0 db1 m b) -> PQ db0 db1 m b

uninterruptibleMask :: ((forall a. PQ db0 db1 m a -> PQ db0 db1 m a) -> PQ db0 db1 m b) -> PQ db0 db1 m b

generalBracket :: PQ db0 db1 m a -> (a -> ExitCase b -> PQ db0 db1 m c) -> (a -> PQ db0 db1 m b) -> PQ db0 db1 m (b, c)

(MonadUnliftIO m, db0 ~ db1) => MonadUnliftIO (PQ db0 db1 m)

Defined in Squeal.PostgreSQL.Session

Methods

withRunInIO :: ((forall a. PQ db0 db1 m a -> IO a) -> IO b) -> PQ db0 db1 m b

(Monad m, Semigroup r, db0 ~ db1) => Semigroup (PQ db0 db1 m r)

Defined in Squeal.PostgreSQL.Session

Methods

(<>) :: PQ db0 db1 m r -> PQ db0 db1 m r -> PQ db0 db1 m r

sconcat :: NonEmpty (PQ db0 db1 m r) -> PQ db0 db1 m r

stimes :: Integral b => b -> PQ db0 db1 m r -> PQ db0 db1 m r

(Monad m, Monoid r, db0 ~ db1) => Monoid (PQ db0 db1 m r)

Defined in Squeal.PostgreSQL.Session

Methods

mempty :: PQ db0 db1 m r

mappend :: PQ db0 db1 m r -> PQ db0 db1 m r -> PQ db0 db1 m r

mconcat :: [PQ db0 db1 m r] -> PQ db0 db1 m r

type StT (PQ db0 db1) a

Defined in Squeal.PostgreSQL.Session

type StT (PQ db0 db1) a = a

type StM (PQ schema0 schema1 m) x

Defined in Squeal.PostgreSQL.Session

type StM (PQ schema0 schema1 m) x = StM m (K x schema0)

runPQ :: Functor m => PQ db0 db1 m x -> K Connection db0 -> m (x, K Connection db1)

Run a PQ and keep the result and the Connection.

execPQ :: Functor m => PQ db0 db1 m x -> K Connection db0 -> m (K Connection db1)

Execute a PQ and discard the result but keep the Connection.

evalPQ :: Functor m => PQ db0 db1 m x -> K Connection db0 -> m x

Evaluate a PQ and discard the Connection but keep the result.

withConnection :: forall db0 db1 io x. MonadUnliftIO io => ByteString -> PQ db0 db1 io x -> io x

Do connectdb and finish before and after a computation.