Database.PostgreSQL.Query.Types

Query execution

class MonadBase IO m => HasPostgres m where

Instances of this typeclass can acquire connection and pass it to computation. It can be reader of pool of connections or just reader of connection

Minimal complete definition

withPGConnection

Methods

withPGConnection :: (Connection -> m a) -> m a

Instances

HasPostgres m => HasPostgres (MaybeT m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> MaybeT m a) -> MaybeT m a

MonadBase IO m => HasPostgres (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> PgMonadT m a) -> PgMonadT m a

(HasPostgres m, Monoid w) => HasPostgres (WriterT w m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> WriterT w m a) -> WriterT w m a

(HasPostgres m, Monoid w) => HasPostgres (WriterT w m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> WriterT w m a) -> WriterT w m a

HasPostgres m => HasPostgres (StateT s m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> StateT s m a) -> StateT s m a

HasPostgres m => HasPostgres (StateT s m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> StateT s m a) -> StateT s m a

HasPostgres m => HasPostgres (ExceptT e m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> ExceptT e m a) -> ExceptT e m a

(MonadBase IO m, MonadBaseControl IO m, HGettable els (Pool Connection)) => HasPostgres (HReaderT els m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> HReaderT els m a) -> HReaderT els m a

HasPostgres m => HasPostgres (IdentityT m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> IdentityT m a) -> IdentityT m a

HasPostgres m => HasPostgres (ReaderT r m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> ReaderT r m a) -> ReaderT r m a

HasPostgres m => HasPostgres (ContT r m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> ContT r m a) -> ContT r m a

type MonadPostgres m = (HasPostgres m, MonadLogger m)

class TransactionSafe (m :: * -> *)

Empty typeclass signing monad in which transaction is safe. i.e. PgMonadT have this instance, but some other monad giving connection from e.g. connection pool is not.

Instances

TransactionSafe m => TransactionSafe (MaybeT m)

Defined in Database.PostgreSQL.Query.Types

TransactionSafe (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

(TransactionSafe m, Monoid w) => TransactionSafe (WriterT w m)

Defined in Database.PostgreSQL.Query.Types

(TransactionSafe m, Monoid w) => TransactionSafe (WriterT w m)

Defined in Database.PostgreSQL.Query.Types

TransactionSafe m => TransactionSafe (StateT s m)

Defined in Database.PostgreSQL.Query.Types

TransactionSafe m => TransactionSafe (StateT s m)

Defined in Database.PostgreSQL.Query.Types

TransactionSafe m => TransactionSafe (ExceptT e m)

Defined in Database.PostgreSQL.Query.Types

TransactionSafe m => TransactionSafe (IdentityT m)

Defined in Database.PostgreSQL.Query.Types

TransactionSafe m => TransactionSafe (ReaderT r m)

Defined in Database.PostgreSQL.Query.Types

TransactionSafe m => TransactionSafe (ContT r m)

Defined in Database.PostgreSQL.Query.Types

newtype PgMonadT m a

Reader of connection. Has instance of HasPostgres. So if you have a connection you can run queries in this monad using runPgMonadT. Or you can use this transformer to run sequence of queries using same connection with launchPG.

Constructors

PgMonadT

Fields

• unPgMonadT :: ReaderT Connection m a

Instances

MonadTrans PgMonadT

Defined in Database.PostgreSQL.Query.Types

Methods

lift :: Monad m => m a -> PgMonadT m a

MonadTransControl PgMonadT

Defined in Database.PostgreSQL.Query.Types

Associated Types

type StT PgMonadT a :: *

Methods

liftWith :: Monad m => (Run PgMonadT -> m a) -> PgMonadT m a

restoreT :: Monad m => m (StT PgMonadT a) -> PgMonadT m a

MonadBase b m => MonadBase b (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

liftBase :: b α -> PgMonadT m α

MonadBaseControl b m => MonadBaseControl b (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Associated Types

type StM (PgMonadT m) a :: *

Methods

liftBaseWith :: (RunInBase (PgMonadT m) b -> b a) -> PgMonadT m a

restoreM :: StM (PgMonadT m) a -> PgMonadT m a

MonadWriter w m => MonadWriter w (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

writer :: (a, w) -> PgMonadT m a

tell :: w -> PgMonadT m ()

listen :: PgMonadT m a -> PgMonadT m (a, w)

pass :: PgMonadT m (a, w -> w) -> PgMonadT m a

MonadState s m => MonadState s (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

get :: PgMonadT m s

put :: s -> PgMonadT m ()

state :: (s -> (a, s)) -> PgMonadT m a

MonadReader r m => MonadReader r (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

ask :: PgMonadT m r

local :: (r -> r) -> PgMonadT m a -> PgMonadT m a

reader :: (r -> a) -> PgMonadT m a

MonadError e m => MonadError e (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

throwError :: e -> PgMonadT m a

catchError :: PgMonadT m a -> (e -> PgMonadT m a) -> PgMonadT m a

Monad m => Monad (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

(>>=) :: PgMonadT m a -> (a -> PgMonadT m b) -> PgMonadT m b

(>>) :: PgMonadT m a -> PgMonadT m b -> PgMonadT m b

return :: a -> PgMonadT m a

fail :: String -> PgMonadT m a

Functor m => Functor (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

fmap :: (a -> b) -> PgMonadT m a -> PgMonadT m b

(<$) :: a -> PgMonadT m b -> PgMonadT m a

MonadFix m => MonadFix (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

mfix :: (a -> PgMonadT m a) -> PgMonadT m a

Applicative m => Applicative (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

pure :: a -> PgMonadT m a

(<*>) :: PgMonadT m (a -> b) -> PgMonadT m a -> PgMonadT m b

liftA2 :: (a -> b -> c) -> PgMonadT m a -> PgMonadT m b -> PgMonadT m c

(*>) :: PgMonadT m a -> PgMonadT m b -> PgMonadT m b

(<*) :: PgMonadT m a -> PgMonadT m b -> PgMonadT m a

Alternative m => Alternative (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

empty :: PgMonadT m a

(<|>) :: PgMonadT m a -> PgMonadT m a -> PgMonadT m a

some :: PgMonadT m a -> PgMonadT m [a]

many :: PgMonadT m a -> PgMonadT m [a]

MonadPlus m => MonadPlus (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

mzero :: PgMonadT m a

mplus :: PgMonadT m a -> PgMonadT m a -> PgMonadT m a

MonadIO m => MonadIO (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

liftIO :: IO a -> PgMonadT m a

MonadThrow m => MonadThrow (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

throwM :: Exception e => e -> PgMonadT m a

MonadCatch m => MonadCatch (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

catch :: Exception e => PgMonadT m a -> (e -> PgMonadT m a) -> PgMonadT m a

MonadMask m => MonadMask (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

mask :: ((forall a. PgMonadT m a -> PgMonadT m a) -> PgMonadT m b) -> PgMonadT m b

uninterruptibleMask :: ((forall a. PgMonadT m a -> PgMonadT m a) -> PgMonadT m b) -> PgMonadT m b

generalBracket :: PgMonadT m a -> (a -> ExitCase b -> PgMonadT m c) -> (a -> PgMonadT m b) -> PgMonadT m (b, c)

MonadHReader m => MonadHReader (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Associated Types

type MHRElements (PgMonadT m) :: [*]

Methods

askHSet :: PgMonadT m (HSet (MHRElements (PgMonadT m)))

hlocal :: (HSet (MHRElements (PgMonadT m)) -> HSet (MHRElements (PgMonadT m))) -> PgMonadT m a -> PgMonadT m a

MonadLogger m => MonadLogger (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> PgMonadT m ()

MonadCont m => MonadCont (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

callCC :: ((a -> PgMonadT m b) -> PgMonadT m a) -> PgMonadT m a

TransactionSafe (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

MonadBase IO m => HasPostgres (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

Methods

withPGConnection :: (Connection -> PgMonadT m a) -> PgMonadT m a

type StT PgMonadT a

Defined in Database.PostgreSQL.Query.Types

type StT PgMonadT a = StT (ReaderT Connection :: (* -> *) -> * -> *) a

type MHRElements (PgMonadT m)

Defined in Database.PostgreSQL.Query.Types

type MHRElements (PgMonadT m) = MHRElements m

type StM (PgMonadT m) a

Defined in Database.PostgreSQL.Query.Types

type StM (PgMonadT m) a = StM (ReaderT Connection m) a

runPgMonadT :: Connection -> PgMonadT m a -> m a

launchPG :: HasPostgres m => PgMonadT m a -> m a

If your monad have instance of HasPostgres you maybe dont need this function, unless your instance use withPGPool which acquires connection from pool for each query. If you want to run sequence of queries using same connection you need this function

Auxiliary types

data Qp

Special constructor to perform old-style query interpolation

Constructors

ToRow row => Qp Query row

Instances

ToSqlBuilder Qp

Defined in Database.PostgreSQL.Query.Types

Methods

toSqlBuilder :: Qp -> SqlBuilder

newtype InetText

type to put and get from db inet and cidr typed postgresql fields. This should be in postgresql-simple in fact.

Constructors

InetText

Fields

• unInetText :: Text

Instances

Eq InetText

Defined in Database.PostgreSQL.Query.Types

Methods

(==) :: InetText -> InetText -> Bool

(/=) :: InetText -> InetText -> Bool

Ord InetText

Defined in Database.PostgreSQL.Query.Types

Methods

compare :: InetText -> InetText -> Ordering

(<) :: InetText -> InetText -> Bool

(<=) :: InetText -> InetText -> Bool

(>) :: InetText -> InetText -> Bool

(>=) :: InetText -> InetText -> Bool

max :: InetText -> InetText -> InetText

min :: InetText -> InetText -> InetText

Read InetText

Defined in Database.PostgreSQL.Query.Types

Methods

readsPrec :: Int -> ReadS InetText

readList :: ReadS [InetText]

readPrec :: ReadPrec InetText

readListPrec :: ReadPrec [InetText]

Show InetText

Defined in Database.PostgreSQL.Query.Types

Methods

showsPrec :: Int -> InetText -> ShowS

show :: InetText -> String

showList :: [InetText] -> ShowS

IsString InetText

Defined in Database.PostgreSQL.Query.Types

Methods

fromString :: String -> InetText

Semigroup InetText

Defined in Database.PostgreSQL.Query.Types

Methods

(<>) :: InetText -> InetText -> InetText

sconcat :: NonEmpty InetText -> InetText

stimes :: Integral b => b -> InetText -> InetText

Monoid InetText

Defined in Database.PostgreSQL.Query.Types

Methods

mempty :: InetText

mappend :: InetText -> InetText -> InetText

mconcat :: [InetText] -> InetText

FromField InetText

Defined in Database.PostgreSQL.Query.Types

Methods

fromField :: FieldParser InetText

ToField InetText

Defined in Database.PostgreSQL.Query.Types

Methods

toField :: InetText -> Action

newtype FN

Dot-separated field name. Each element in nested list will be properly quoted and separated by dot. It also have instance of ToSqlBuilder and IsString so you can:

>>> let a = "hello" :: FN
>>> a
FN ["hello"]

>>> let b = "user.name" :: FN
>>> b
FN ["user","name"]

>>> let n = "u.name" :: FN
>>> runSqlBuilder c $ toSqlBuilder n
"\"u\".\"name\""

>>> ("user" <> "name") :: FN
FN ["user","name"]

>>> let a = "name" :: FN
>>> let b = "email" :: FN
>>> runSqlBuilder c [sqlExp|^{"u" <> a} = 'name', ^{"e" <> b} = 'email'|]
"\"u\".\"name\" = 'name', \"e\".\"email\" = 'email'"

Constructors

FN [Text]

Instances

Eq FN

Defined in Database.PostgreSQL.Query.Types

Methods

(==) :: FN -> FN -> Bool

(/=) :: FN -> FN -> Bool

Ord FN

Defined in Database.PostgreSQL.Query.Types

Methods

compare :: FN -> FN -> Ordering

(<) :: FN -> FN -> Bool

(<=) :: FN -> FN -> Bool

(>) :: FN -> FN -> Bool

(>=) :: FN -> FN -> Bool

max :: FN -> FN -> FN

min :: FN -> FN -> FN

Show FN

Defined in Database.PostgreSQL.Query.Types

Methods

showsPrec :: Int -> FN -> ShowS

show :: FN -> String

showList :: [FN] -> ShowS

IsString FN

Defined in Database.PostgreSQL.Query.Types

Methods

fromString :: String -> FN

Generic FN

Defined in Database.PostgreSQL.Query.Types

Associated Types

type Rep FN :: * -> *

Methods

from :: FN -> Rep FN x

to :: Rep FN x -> FN

Semigroup FN

Defined in Database.PostgreSQL.Query.Types

Methods

(<>) :: FN -> FN -> FN

sconcat :: NonEmpty FN -> FN

stimes :: Integral b => b -> FN -> FN

Monoid FN

Defined in Database.PostgreSQL.Query.Types

Methods

mempty :: FN

mappend :: FN -> FN -> FN

mconcat :: [FN] -> FN

Lift FN

Defined in Database.PostgreSQL.Query.Types

Methods

lift :: FN -> Q Exp

ToSqlBuilder FN

Defined in Database.PostgreSQL.Query.Types

Methods

toSqlBuilder :: FN -> SqlBuilder

type Rep FN

Defined in Database.PostgreSQL.Query.Types

type Rep FN = D1 (MetaData "FN" "Database.PostgreSQL.Query.Types" "postgresql-query-3.5.0-1AbagAFOSyg4vQytTFD1c" True) (C1 (MetaCons "FN" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

textFN :: Text -> FN

Single field to FN

>>> textFN "hello"
FN ["hello"]

>>> textFN "user.name"
FN ["user.name"]

Note that it does not split string to parts by point like instance of IsString does

newtype MarkedRow

Marked row is list of pairs of field name and some sql expression. Used to generate queries like:

name = name AND size = 10 AND length = 20

or

UPDATE tbl SET name = name, size = 10, lenght = 20

Constructors

MR

Fields

• unMR :: [(FN, SqlBuilder)]

Instances

Generic MarkedRow

Defined in Database.PostgreSQL.Query.Types

Associated Types

type Rep MarkedRow :: * -> *

Methods

from :: MarkedRow -> Rep MarkedRow x

to :: Rep MarkedRow x -> MarkedRow

Semigroup MarkedRow

Defined in Database.PostgreSQL.Query.Types

Methods

(<>) :: MarkedRow -> MarkedRow -> MarkedRow

sconcat :: NonEmpty MarkedRow -> MarkedRow

stimes :: Integral b => b -> MarkedRow -> MarkedRow

Monoid MarkedRow

Defined in Database.PostgreSQL.Query.Types

Methods

mempty :: MarkedRow

mappend :: MarkedRow -> MarkedRow -> MarkedRow

mconcat :: [MarkedRow] -> MarkedRow

ToMarkedRow MarkedRow

Defined in Database.PostgreSQL.Query.Types

Methods

toMarkedRow :: MarkedRow -> MarkedRow

type Rep MarkedRow

Defined in Database.PostgreSQL.Query.Types

type Rep MarkedRow = D1 (MetaData "MarkedRow" "Database.PostgreSQL.Query.Types" "postgresql-query-3.5.0-1AbagAFOSyg4vQytTFD1c" True) (C1 (MetaCons "MR" PrefixI True) (S1 (MetaSel (Just "unMR") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(FN, SqlBuilder)])))

mrToBuilder

Arguments

:: SqlBuilder

Builder to intercalate with

-> MarkedRow

-> SqlBuilder

Turns marked row to query intercalating it with other builder

>>> runSqlBuilder c $ mrToBuilder "AND" $ MR [("name", mkValue "petr"), ("email", mkValue "[e-mail]")]
" \"name\" = 'petr' AND \"email\" = '[e-mail]' "

class ToMarkedRow a where

Minimal complete definition

toMarkedRow

Methods

toMarkedRow :: a -> MarkedRow

generate list of pairs (field name, field value)

Instances

ToMarkedRow MarkedRow

Defined in Database.PostgreSQL.Query.Types

Methods

toMarkedRow :: MarkedRow -> MarkedRow