on dev help sign in
some docs
commite6c80d14abe39097d2ee2c71f4835f3616ed9977 authorEitan Chatav <eitan.chatav@gmail.com> dateSat 24 Feb 2018, 13:38 (9 years ago) parentcd56288
1 file changed+6−6
squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+6−6
squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+6−6
@@ -532,7 +532,7 @@ from tables = TableExpression tables [] NoGroups NoHaving [] [] []
532532-- | A `where_` is an endomorphism of `TableExpression`s which adds a
533533-- search condition to the `whereClause`.
534534where_
535− :: Condition tables 'Ungrouped params
535+ :: Condition tables 'Ungrouped params -- ^ filtering condition
536536 -> TableExpression schema params tables grouping
537537 -> TableExpression schema params tables grouping
538538where_ wh tables = tables {whereClause = wh : whereClause tables}
@@ -542,7 +542,7 @@ where_ wh tables = tables {whereClause = wh : whereClause tables}
542542-- a "grand total" aggregation query.
543543group
544544 :: SListI bys
545− => NP (By tables) bys
545+ => NP (By tables) bys -- ^ grouped columns
546546 -> TableExpression schema params tables 'Ungrouped
547547 -> TableExpression schema params tables ('Grouped bys)
548548group bys tables = TableExpression
@@ -558,7 +558,7 @@ group bys tables = TableExpression
558558-- | A `having` is an endomorphism of `TableExpression`s which adds a
559559-- search condition to the `havingClause`.
560560having
561− :: Condition tables ('Grouped bys) params
561+ :: Condition tables ('Grouped bys) params -- ^ having condition
562562 -> TableExpression schema params tables ('Grouped bys)
563563 -> TableExpression schema params tables ('Grouped bys)
564564having hv tables = tables
@@ -567,7 +567,7 @@ having hv tables = tables
567567-- | An `orderBy` is an endomorphism of `TableExpression`s which appends an
568568-- ordering to the right of the `orderByClause`.
569569orderBy
570− :: [SortExpression tables grouping params]
570+ :: [SortExpression tables grouping params] -- ^ sort expressions
571571 -> TableExpression schema params tables grouping
572572 -> TableExpression schema params tables grouping
573573orderBy srts tables = tables {orderByClause = orderByClause tables ++ srts}
@@ -575,7 +575,7 @@ orderBy srts tables = tables {orderByClause = orderByClause tables ++ srts}
575575-- | A `limit` is an endomorphism of `TableExpression`s which adds to the
576576-- `limitClause`.
577577limit
578− :: Word64
578+ :: Word64 -- ^ limit parameter
579579 -> TableExpression schema params tables grouping
580580 -> TableExpression schema params tables grouping
581581limit lim tables = tables {limitClause = lim : limitClause tables}
@@ -583,7 +583,7 @@ limit lim tables = tables {limitClause = lim : limitClause tables}
583583-- | An `offset` is an endomorphism of `TableExpression`s which adds to the
584584-- `offsetClause`.
585585offset
586− :: Word64
586+ :: Word64 -- ^ offset parameter
587587 -> TableExpression schema params tables grouping
588588 -> TableExpression schema params tables grouping
589589offset off tables = tables {offsetClause = off : offsetClause tables}