Database.Relational.Query.Monad.Trans.Ordering

This module defines monad transformer which lift from query into query with ordering.

Transformer into query with ordering

data Orderings c m a

Type to accumulate ordering context. Type c is ordering term projection context type.

Instances

MonadQualify ConfigureQuery QueryAggregate

Instance to lift from qualified table forms into QueryAggregate.

MonadQualify ConfigureQuery (Orderings Flat QueryCore)

Instance to lift from qualified table forms into QuerySimple.

MonadRestrict rc m => MonadRestrict rc (Orderings c m)

MonadRestrict with ordering.

MonadTrans (Orderings c)

Monad m => Monad (Orderings c m)

Functor m => Functor (Orderings c m)

Applicative m => Applicative (Orderings c m)

MonadPartition m => MonadPartition (Orderings c m)

MonadPartition with ordering.

MonadAggregate m => MonadAggregate (Orderings c m)

MonadAggregate with ordering.

MonadQuery m => MonadQuery (Orderings c m)

MonadQuery with ordering.

orderings :: Monad m => m a -> Orderings c m a

Lift to Orderings.

type OrderedQuery c m r = Orderings c m (Projection c r)

OrderedQuery type synonym. Projection must be the same as Orderings type parameter p

type OrderingTerms = [OrderingTerm]

Type for order-by terms

API of query with ordering

orderBy

Arguments

:: (Monad m, ProjectableOrdering (Projection c))

=> Projection c t

Ordering terms to add

-> Order

Order direction

-> Orderings c m ()

Result context with ordering

Add ordering terms.

asc

Arguments

:: (Monad m, ProjectableOrdering (Projection c))

=> Projection c t

Ordering terms to add

-> Orderings c m ()

Result context with ordering

Add ascendant ordering term.

desc

Arguments

:: (Monad m, ProjectableOrdering (Projection c))

=> Projection c t

Ordering terms to add

-> Orderings c m ()

Result context with ordering

Add descendant ordering term.

Result

extractOrderingTerms :: (Monad m, Functor m) => Orderings c m a -> m (a, OrderingTerms)

Run Orderings to get OrderingTerms