module Opaleye.Window
       (
         -- * Window queries
         W.window
       , W.Window
       , W.over
       , W.Partition
       , W.partitionBy
       , W.orderPartitionBy

         -- ** Specific window functions
       , W.cumulative
       , rowNumber
       , rank
       , denseRank
       , percentRank
       , cumeDist
       , ntile
       , lag
       , lead
       , firstValue
       , lastValue
       , nthValue
       ) where

import qualified Opaleye.Internal.Column as IC
import qualified Opaleye.Internal.HaskellDB.PrimQuery as HPQ
import qualified Opaleye.Internal.Window as W

import qualified Opaleye.Field as F
import qualified Opaleye.SqlTypes as T

-- This page of Postgres documentation tell us what window
-- functions are available
--
--   https://www.postgresql.org/docs/devel/functions-window.html


-- | [@row_number()@](https://www.postgresql.org/docs/current/functions-window.html)
rowNumber :: W.Window (F.Field T.SqlInt8)
rowNumber :: Window (Field SqlInt8)
rowNumber = WndwOp -> Window (Field SqlInt8)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw WndwOp
HPQ.WndwRowNumber


-- | [@rank()@](https://www.postgresql.org/docs/current/functions-window.html)
rank :: W.Window (F.Field T.SqlInt8)
rank :: Window (Field SqlInt8)
rank = WndwOp -> Window (Field SqlInt8)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw WndwOp
HPQ.WndwRank


-- | [@dense_rank()@](https://www.postgresql.org/docs/current/functions-window.html)
denseRank :: W.Window (F.Field T.SqlInt8)
denseRank :: Window (Field SqlInt8)
denseRank = WndwOp -> Window (Field SqlInt8)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw WndwOp
HPQ.WndwDenseRank


-- | [@percent_rank()@](https://www.postgresql.org/docs/current/functions-window.html)
percentRank :: W.Window (F.Field T.SqlFloat8)
percentRank :: Window (Field SqlFloat8)
percentRank = WndwOp -> Window (Field SqlFloat8)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw WndwOp
HPQ.WndwPercentRank


-- | [@cume_dist()@](https://www.postgresql.org/docs/current/functions-window.html)
cumeDist :: W.Window (F.Field T.SqlFloat8)
cumeDist :: Window (Field SqlFloat8)
cumeDist = WndwOp -> Window (Field SqlFloat8)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw WndwOp
HPQ.WndwCumeDist


-- | [@ntile(num_buckets)@](https://www.postgresql.org/docs/current/functions-window.html)
ntile :: F.Field T.SqlInt4 -> W.Window (F.Field T.SqlInt4)
ntile :: Field SqlInt4 -> Window (Field SqlInt4)
ntile (IC.Column PrimExpr
buckets) = WndwOp -> Window (Field SqlInt4)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw (WndwOp -> Window (Field SqlInt4))
-> WndwOp -> Window (Field SqlInt4)
forall a b. (a -> b) -> a -> b
$ PrimExpr -> WndwOp
HPQ.WndwNtile PrimExpr
buckets


-- | [@lag(value, offset, default)@](https://www.postgresql.org/docs/current/functions-window.html)
lag :: F.Field_ n a -> F.Field T.SqlInt4 -> F.Field_ n a -> W.Window (F.Field_ n a)
lag :: Field_ n a -> Field SqlInt4 -> Field_ n a -> Window (Field_ n a)
lag (IC.Column PrimExpr
a) (IC.Column PrimExpr
offset) (IC.Column PrimExpr
def) =
  WndwOp -> Window (Field_ n a)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw (WndwOp -> Window (Field_ n a)) -> WndwOp -> Window (Field_ n a)
forall a b. (a -> b) -> a -> b
$ PrimExpr -> PrimExpr -> PrimExpr -> WndwOp
HPQ.WndwLag PrimExpr
a PrimExpr
offset PrimExpr
def


-- | [@lead(value, offset, default)@](https://www.postgresql.org/docs/current/functions-window.html)
lead :: F.Field_ n a -> F.Field T.SqlInt4 -> F.Field_ n a -> W.Window (F.Field_ n a)
lead :: Field_ n a -> Field SqlInt4 -> Field_ n a -> Window (Field_ n a)
lead (IC.Column PrimExpr
a) (IC.Column PrimExpr
offset) (IC.Column PrimExpr
def) =
  WndwOp -> Window (Field_ n a)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw (WndwOp -> Window (Field_ n a)) -> WndwOp -> Window (Field_ n a)
forall a b. (a -> b) -> a -> b
$ PrimExpr -> PrimExpr -> PrimExpr -> WndwOp
HPQ.WndwLead PrimExpr
a PrimExpr
offset PrimExpr
def


-- | [@first_value(value)@](https://www.postgresql.org/docs/current/functions-window.html)
firstValue :: F.Field_ n a -> W.Window (F.Field_ n a)
firstValue :: Field_ n a -> Window (Field_ n a)
firstValue (IC.Column PrimExpr
a) = WndwOp -> Window (Field_ n a)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw (WndwOp -> Window (Field_ n a)) -> WndwOp -> Window (Field_ n a)
forall a b. (a -> b) -> a -> b
$ PrimExpr -> WndwOp
HPQ.WndwFirstValue PrimExpr
a


-- | [@last_value(value)@](https://www.postgresql.org/docs/current/functions-window.html)
lastValue :: F.Field_ n a -> W.Window (F.Field_ n a)
lastValue :: Field_ n a -> Window (Field_ n a)
lastValue (IC.Column PrimExpr
a) = WndwOp -> Window (Field_ n a)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw (WndwOp -> Window (Field_ n a)) -> WndwOp -> Window (Field_ n a)
forall a b. (a -> b) -> a -> b
$ PrimExpr -> WndwOp
HPQ.WndwLastValue PrimExpr
a


-- | [@nth_value(value, n)@](https://www.postgresql.org/docs/current/functions-window.html)
nthValue :: F.Field_ n a -> F.Field T.SqlInt4 -> W.Window (F.FieldNullable a)
nthValue :: Field_ n a -> Field SqlInt4 -> Window (FieldNullable a)
nthValue (IC.Column PrimExpr
a) (IC.Column PrimExpr
n) = WndwOp -> Window (FieldNullable a)
forall (n :: Nullability) a. WndwOp -> Window (Field_ n a)
W.makeWndw (WndwOp -> Window (FieldNullable a))
-> WndwOp -> Window (FieldNullable a)
forall a b. (a -> b) -> a -> b
$ PrimExpr -> PrimExpr -> WndwOp
HPQ.WndwNthValue PrimExpr
a PrimExpr
n