Opaleye.Aggregate

Perform aggregation on Querys. To aggregate a Query you should construct an Aggregator encoding how you want the aggregation to proceed, then call aggregate on it. The Aggregator should be constructed from the basic Aggregators below by using the combining operations from Data.Profunctor.Product.

Aggregation

aggregate :: Aggregator a b -> Query a -> Query b

Given a Query producing rows of type a and an Aggregator accepting rows of type a, apply the aggregator to the results of the query.

If you simply want to count the number of rows in a query you might find the countRows function more convenient.

By design there is no aggregation function of type Aggregator b b' -> QueryArr a b -> QueryArr a b'. Such a function would allow violation of SQL's scoping rules and lead to invalid queries.

Please note that when aggregating an empty query with no GROUP BY clause, Opaleye's behaviour differs from Postgres's behaviour. Postgres returns a single row whereas Opaleye returns zero rows. Opaleye's behaviour is consistent with the meaning of aggregating over groups of rows and Postgres's behaviour is inconsistent. When a query has zero rows it has zero groups, and thus zero rows in the result of an aggregation.

data Aggregator a b

An Aggregator takes a collection of rows of type a, groups them, and transforms each group into a single row of type b. This corresponds to aggregators using GROUP BY in SQL.

You should combine basic Aggregators into Aggregators on compound types by using the operations in Data.Profunctor.Product.

An Aggregator corresponds closely to a Fold from the foldl package. Whereas an Aggregator a b takes each group of type a to a single row of type b, a Fold a b takes a list of a and returns a single row of type b.

Instances

SumProfunctor Aggregator

Methods

(+++!) :: Aggregator a b -> Aggregator a' b' -> Aggregator (Either a a') (Either b b')

ProductProfunctor Aggregator

Methods

purePP :: b -> Aggregator a b

(****) :: Aggregator a (b -> c) -> Aggregator a b -> Aggregator a c

empty :: Aggregator () ()

(***!) :: Aggregator a b -> Aggregator a' b' -> Aggregator (a, a') (b, b')

Profunctor Aggregator

Methods

dimap :: (a -> b) -> (c -> d) -> Aggregator b c -> Aggregator a d

lmap :: (a -> b) -> Aggregator b c -> Aggregator a c

rmap :: (b -> c) -> Aggregator a b -> Aggregator a c

(#.) :: Coercible * c b => (b -> c) -> Aggregator a b -> Aggregator a c

(.#) :: Coercible * b a => Aggregator b c -> (a -> b) -> Aggregator a c

Functor (Aggregator a)

Methods

fmap :: (a -> b) -> Aggregator a a -> Aggregator a b

(<$) :: a -> Aggregator a b -> Aggregator a a

Applicative (Aggregator a)

Methods

pure :: a -> Aggregator a a

(<*>) :: Aggregator a (a -> b) -> Aggregator a a -> Aggregator a b

(*>) :: Aggregator a a -> Aggregator a b -> Aggregator a b

(<*) :: Aggregator a a -> Aggregator a b -> Aggregator a a

Basic Aggregators

groupBy :: Aggregator (Column a) (Column a)

Group the aggregation by equality on the input to groupBy.

sum :: Aggregator (Column a) (Column a)

Sum all rows in a group.

count :: Aggregator (Column a) (Column PGInt8)

Count the number of non-null rows in a group.

countStar :: Aggregator a (Column PGInt8)

Count the number of rows in a group. This Aggregator is named countStar after SQL's COUNT(*) aggregation function.

avg :: Aggregator (Column PGFloat8) (Column PGFloat8)

Average of a group

max :: PGOrd a => Aggregator (Column a) (Column a)

Maximum of a group

min :: PGOrd a => Aggregator (Column a) (Column a)

Maximum of a group

boolOr :: Aggregator (Column PGBool) (Column PGBool)

boolAnd :: Aggregator (Column PGBool) (Column PGBool)

arrayAgg :: Aggregator (Column a) (Column (PGArray a))

stringAgg :: Column PGText -> Aggregator (Column PGText) (Column PGText)

Counting rows

countRows :: Query a -> Query (Column PGInt8)

Count the number of rows in a query. This is different from aggregate count because it always returns exactly one row, even when the input query is empty.

Entire module

aggregate :: Aggregator a b -> Query a -> Query b

Given a Query producing rows of type a and an Aggregator accepting rows of type a, apply the aggregator to the results of the query.

If you simply want to count the number of rows in a query you might find the countRows function more convenient.

By design there is no aggregation function of type Aggregator b b' -> QueryArr a b -> QueryArr a b'. Such a function would allow violation of SQL's scoping rules and lead to invalid queries.

Please note that when aggregating an empty query with no GROUP BY clause, Opaleye's behaviour differs from Postgres's behaviour. Postgres returns a single row whereas Opaleye returns zero rows. Opaleye's behaviour is consistent with the meaning of aggregating over groups of rows and Postgres's behaviour is inconsistent. When a query has zero rows it has zero groups, and thus zero rows in the result of an aggregation.

aggregateOrdered :: Order a -> Aggregator a b -> Query a -> Query b

Order the values within each aggregation in Aggregator using the given ordering. This is only relevant for aggregations that depend on the order they get their elements, like arrayAgg and stringAgg.

Note that this orders all aggregations with the same ordering. If you need different orderings for different aggregations, use orderAggregate.

distinctAggregator :: Aggregator a b -> Aggregator a b

Aggregate only distinct values

groupBy :: Aggregator (Column a) (Column a)

Group the aggregation by equality on the input to groupBy.

sum :: Aggregator (Column a) (Column a)

Sum all rows in a group.

count :: Aggregator (Column a) (Column PGInt8)

Count the number of non-null rows in a group.

countStar :: Aggregator a (Column PGInt8)

Count the number of rows in a group. This Aggregator is named countStar after SQL's COUNT(*) aggregation function.

avg :: Aggregator (Column PGFloat8) (Column PGFloat8)

Average of a group

max :: PGOrd a => Aggregator (Column a) (Column a)

Maximum of a group

min :: PGOrd a => Aggregator (Column a) (Column a)

Maximum of a group

boolOr :: Aggregator (Column PGBool) (Column PGBool)

boolAnd :: Aggregator (Column PGBool) (Column PGBool)

arrayAgg :: Aggregator (Column a) (Column (PGArray a))

stringAgg :: Column PGText -> Aggregator (Column PGText) (Column PGText)

countRows :: Query a -> Query (Column PGInt8)

Count the number of rows in a query. This is different from aggregate count because it always returns exactly one row, even when the input query is empty.