Copyright	2013-2017 Kei Hibino
License	BSD3
Maintainer	[email protected]
Stability	experimental
Portability	unknown
Safe Haskell	Safe-Inferred
Language	Haskell2010

Database.Relational.Monad.Class

Contents

Query interface classes

Description

This module defines query building interface classes.

Synopsis

class (Functor q, Monad q, Functor m, Monad m) => MonadQualify q m where
- liftQualify :: q a -> m a
class (Functor m, Monad m) => MonadRestrict c m where
- restrict :: Predicate c -> m ()
class (Functor m, Monad m, MonadQualify ConfigureQuery m) => MonadQuery m where
- setDuplication :: Duplication -> m ()
- restrictJoin :: Predicate Flat -> m ()
- query' :: Relation p r -> m (PlaceHolders p, Record Flat r)
- queryMaybe' :: Relation p r -> m (PlaceHolders p, Record Flat (Maybe r))
class MonadQuery m => MonadAggregate m where
- groupBy :: Record Flat r -> m (Record Aggregated r)
- groupBy' :: AggregateKey (Record Aggregated r) -> m (Record Aggregated r)
class Monad m => MonadPartition c m where
- partitionBy :: Record c r -> m ()
all' :: MonadQuery m => m ()
distinct :: MonadQuery m => m ()
on :: MonadQuery m => Predicate Flat -> m ()
wheres :: MonadRestrict Flat m => Predicate Flat -> m ()
having :: MonadRestrict Aggregated m => Predicate Aggregated -> m ()

Query interface classes

class (Functor q, Monad q, Functor m, Monad m) => MonadQualify q m where Source #

Lift interface from base qualify monad.

Methods

liftQualify :: q a -> m a Source #

Lift from qualify monad q into MonadQuery m. Qualify monad qualifies table form SubQuery.

Instances

Instances details

MonadQualify ConfigureQuery QueryUnique Source #
Instance details Defined in Database.Relational.Monad.Unique Methods liftQualify :: ConfigureQuery a -> QueryUnique a Source #
(Functor q, Monad q) => MonadQualify q q Source #
Instance details Defined in Database.Relational.Monad.Class Methods liftQualify :: q a -> q a Source #
MonadQualify q m => MonadQualify q (AggregatingSetT m) Source #	Aggregated `MonadQualify`.
Instance details Defined in Database.Relational.Monad.Trans.Aggregating Methods liftQualify :: q a -> AggregatingSetT m a Source #
MonadQualify q m => MonadQualify q (QueryJoin m) Source #
Instance details Defined in Database.Relational.Monad.Trans.Join Methods liftQualify :: q a -> QueryJoin m a Source #
MonadQualify q m => MonadQualify q (Assignings r m) Source #	`MonadQualify` with assigning.
Instance details Defined in Database.Relational.Monad.Trans.Assigning Methods liftQualify :: q a -> Assignings r m a Source #
MonadQualify q m => MonadQualify q (Orderings c m) Source #	`MonadQualify` with ordering.
Instance details Defined in Database.Relational.Monad.Trans.Ordering Methods liftQualify :: q a -> Orderings c m a Source #
MonadQualify q m => MonadQualify q (Restrictings c m) Source #	Restricted `MonadQualify` instance.
Instance details Defined in Database.Relational.Monad.Trans.Restricting Methods liftQualify :: q a -> Restrictings c m a Source #

class (Functor m, Monad m) => MonadRestrict c m where Source #

Restrict context interface

Methods

restrict Source #

Arguments

:: Predicate c	`Record` which represent restriction
-> m ()	Restricted query context

Add restriction to this context.

Instances

Instances details

MonadRestrict c m => MonadRestrict c (AggregatingSetT m) Source #	Aggregated `MonadRestrict`.
Instance details Defined in Database.Relational.Monad.Trans.Aggregating Methods restrict :: Predicate c -> AggregatingSetT m () Source #
MonadRestrict Flat q => MonadRestrict Flat (Restrictings Aggregated q) Source #	Restricted `MonadRestrict` instance.
Instance details Defined in Database.Relational.Monad.Aggregate Methods restrict :: Predicate Flat -> Restrictings Aggregated q () Source #
MonadRestrict c m => MonadRestrict c (Assignings r m) Source #	`MonadRestrict` with assigning.
Instance details Defined in Database.Relational.Monad.Trans.Assigning Methods restrict :: Predicate c -> Assignings r m () Source #
(Monad q, Functor q) => MonadRestrict c (Restrictings c q) Source #	`MonadRestrict` instance.
Instance details Defined in Database.Relational.Monad.Trans.Restricting Methods restrict :: Predicate c -> Restrictings c q () Source #
MonadRestrict rc m => MonadRestrict rc (Orderings c m) Source #	`MonadRestrict` with ordering.
Instance details Defined in Database.Relational.Monad.Trans.Ordering Methods restrict :: Predicate rc -> Orderings c m () Source #

class (Functor m, Monad m, MonadQualify ConfigureQuery m) => MonadQuery m where Source #

Query building interface.

Methods

setDuplication :: Duplication -> m () Source #

Specify duplication.

restrictJoin Source #

Arguments

:: Predicate Flat	`Record` which represent restriction
-> m ()	Restricted query context

Add restriction to last join.

query' :: Relation p r -> m (PlaceHolders p, Record Flat r) Source #

Join sub-query with place-holder parameter p. query result is not Maybe.

queryMaybe' :: Relation p r -> m (PlaceHolders p, Record Flat (Maybe r)) Source #

Join sub-query with place-holder parameter p. Query result is Maybe.

Instances

Instances details

MonadQuery QueryUnique Source #
Instance details Defined in Database.Relational.Monad.Unique Methods setDuplication :: Duplication -> QueryUnique () Source # restrictJoin :: Predicate Flat -> QueryUnique () Source # query' :: Relation p r -> QueryUnique (PlaceHolders p, Record Flat r) Source # queryMaybe' :: Relation p r -> QueryUnique (PlaceHolders p, Record Flat (Maybe r)) Source #
MonadQuery m => MonadQuery (AggregatingSetT m) Source #	Aggregated `MonadQuery`.
Instance details Defined in Database.Relational.Monad.Trans.Aggregating Methods setDuplication :: Duplication -> AggregatingSetT m () Source # restrictJoin :: Predicate Flat -> AggregatingSetT m () Source # query' :: Relation p r -> AggregatingSetT m (PlaceHolders p, Record Flat r) Source # queryMaybe' :: Relation p r -> AggregatingSetT m (PlaceHolders p, Record Flat (Maybe r)) Source #
MonadQuery (QueryJoin ConfigureQuery) Source #	Joinable query instance.
Instance details Defined in Database.Relational.Monad.Trans.Join Methods setDuplication :: Duplication -> QueryJoin ConfigureQuery () Source # restrictJoin :: Predicate Flat -> QueryJoin ConfigureQuery () Source # query' :: Relation p r -> QueryJoin ConfigureQuery (PlaceHolders p, Record Flat r) Source # queryMaybe' :: Relation p r -> QueryJoin ConfigureQuery (PlaceHolders p, Record Flat (Maybe r)) Source #
MonadQuery m => MonadQuery (Orderings c m) Source #	`MonadQuery` with ordering.
Instance details Defined in Database.Relational.Monad.Trans.Ordering Methods setDuplication :: Duplication -> Orderings c m () Source # restrictJoin :: Predicate Flat -> Orderings c m () Source # query' :: Relation p r -> Orderings c m (PlaceHolders p, Record Flat r) Source # queryMaybe' :: Relation p r -> Orderings c m (PlaceHolders p, Record Flat (Maybe r)) Source #
MonadQuery q => MonadQuery (Restrictings c q) Source #	Restricted `MonadQuery` instance.
Instance details Defined in Database.Relational.Monad.Trans.Restricting Methods setDuplication :: Duplication -> Restrictings c q () Source # restrictJoin :: Predicate Flat -> Restrictings c q () Source # query' :: Relation p r -> Restrictings c q (PlaceHolders p, Record Flat r) Source # queryMaybe' :: Relation p r -> Restrictings c q (PlaceHolders p, Record Flat (Maybe r)) Source #

class MonadQuery m => MonadAggregate m where Source #

Aggregated query building interface extends MonadQuery.

Methods

groupBy Source #

Arguments

:: Record Flat r	Record to add into group by
-> m (Record Aggregated r)	Result context and aggregated record \| Add GROUP BY term into context and get aggregated record. Non-traditional group-by version.

Add GROUP BY term into context and get aggregated record.

groupBy' Source #

Arguments

:: AggregateKey (Record Aggregated r)	Key to aggretate for non-traditional group-by interface
-> m (Record Aggregated r)	Result context and aggregated record

Instances

Instances details

MonadQuery m => MonadAggregate (AggregatingSetT m) Source #	Aggregated query instance.
Instance details Defined in Database.Relational.Monad.Trans.Aggregating Methods groupBy :: Record Flat r -> AggregatingSetT m (Record Aggregated r) Source # groupBy' :: AggregateKey (Record Aggregated r) -> AggregatingSetT m (Record Aggregated r) Source #
MonadAggregate m => MonadAggregate (Orderings c m) Source #	`MonadAggregate` with ordering.
Instance details Defined in Database.Relational.Monad.Trans.Ordering Methods groupBy :: Record Flat r -> Orderings c m (Record Aggregated r) Source # groupBy' :: AggregateKey (Record Aggregated r) -> Orderings c m (Record Aggregated r) Source #
MonadAggregate m => MonadAggregate (Restrictings c m) Source #	Restricted `MonadAggregate` instance.
Instance details Defined in Database.Relational.Monad.Trans.Restricting Methods groupBy :: Record Flat r -> Restrictings c m (Record Aggregated r) Source # groupBy' :: AggregateKey (Record Aggregated r) -> Restrictings c m (Record Aggregated r) Source #

class Monad m => MonadPartition c m where Source #

Window specification building interface.

Methods

partitionBy :: Record c r -> m () Source #

Add PARTITION BY term into context.

Instances

Instances details

Monad m => MonadPartition c (PartitioningSetT c m) Source #	Partition clause instance
Instance details Defined in Database.Relational.Monad.Trans.Aggregating Methods partitionBy :: Record c r -> PartitioningSetT c m () Source #
MonadPartition c m => MonadPartition c (Orderings c m) Source #	`MonadPartition` with ordering.
Instance details Defined in Database.Relational.Monad.Trans.Ordering Methods partitionBy :: Record c r -> Orderings c m () Source #

all' :: MonadQuery m => m () Source #

Specify ALL attribute to query context.

distinct :: MonadQuery m => m () Source #

Specify DISTINCT attribute to query context.

on :: MonadQuery m => Predicate Flat -> m () Source #

Add restriction to last join. Record type version.

wheres :: MonadRestrict Flat m => Predicate Flat -> m () Source #

Add restriction to this not aggregated query.

having :: MonadRestrict Aggregated m => Predicate Aggregated -> m () Source #

Add restriction to this aggregated query. Aggregated Record type version.