git.iko.soy/rel8
on 137ebed help sign in
rel8/src/Rel8/Table/Aggregate.hs
81 lines 2.7 kB history raw
1{-# language FlexibleContexts #-}
2{-# language NamedFieldPuns #-}
3{-# language ScopedTypeVariables #-}
4{-# language TypeApplications #-}
5{-# language TypeFamilies #-}
6{-# language ViewPatterns #-}
8module Rel8.Table.Aggregate
9 ( groupBy, hgroupBy
10 , listAgg, nonEmptyAgg
11 )
12where
14-- base
15import Data.Functor.Identity ( Identity( Identity ) )
16import Prelude
18-- rel8
19import Rel8.Aggregate ( Aggregate, Aggregates, Col( A ) )
20import Rel8.Expr ( Expr, Col( E ) )
21import Rel8.Expr.Aggregate
22 ( groupByExpr
23 , slistAggExpr
24 , snonEmptyAggExpr
25 )
26import Rel8.Schema.Dict ( Dict( Dict ) )
27import Rel8.Schema.HTable ( HTable, hfield, htabulate )
28import Rel8.Schema.HTable.Vectorize ( hvectorize )
29import Rel8.Schema.Spec ( SSpec( SSpec, info ) )
30import Rel8.Schema.Spec.ConstrainDBType ( ConstrainDBType )
31import Rel8.Table ( toColumns, fromColumns )
32import Rel8.Table.Eq ( EqTable, eqTable )
33import Rel8.Table.List ( ListTable )
34import Rel8.Table.NonEmpty ( NonEmptyTable )
35import Rel8.Type.Eq ( DBEq )
38-- | Group equal tables together. This works by aggregating each column in the
39-- given table with 'groupByExpr'.
40groupBy :: forall exprs aggregates. (EqTable exprs, Aggregates aggregates exprs)
41 => exprs -> aggregates
42groupBy = fromColumns . hgroupBy (eqTable @exprs) . toColumns
45hgroupBy :: HTable t
46 => t (Dict (ConstrainDBType DBEq)) -> t (Col Expr) -> t (Col Aggregate)
47hgroupBy eqs exprs = fromColumns $ htabulate $ \field ->
48 case hfield eqs field of
49 Dict -> case hfield exprs field of
50 E expr -> A $ groupByExpr expr
53-- | Aggregate rows into a single row containing an array of all aggregated
54-- rows. This can be used to associate multiple rows with a single row, without
55-- changing the over cardinality of the query. This allows you to essentially
56-- return a tree-like structure from queries.
57--
58-- For example, if we have a table of orders and each orders contains multiple
59-- items, we could aggregate the table of orders, pairing each order with its
60-- items:
61--
62-- @
63-- ordersWithItems :: Query (Order Expr, ListTable (Item Expr))
64-- ordersWithItems = do
65-- order <- each orderSchema
66-- items <- aggregate $ listAgg <$> itemsFromOrder order
67-- return (order, items)
68-- @
69listAgg :: Aggregates aggregates exprs => exprs -> ListTable aggregates
70listAgg (toColumns -> exprs) = fromColumns $
71 hvectorize
72 (\SSpec {info} (Identity (E a)) -> A $ slistAggExpr info a)
73 (pure exprs)
76-- | Like 'listAgg', but the result is guaranteed to be a non-empty list.
77nonEmptyAgg :: Aggregates aggregates exprs => exprs -> NonEmptyTable aggregates
78nonEmptyAgg (toColumns -> exprs) = fromColumns $
79 hvectorize
80 (\SSpec {info} (Identity (E a)) -> A $ snonEmptyAggExpr info a)
81 (pure exprs)