git.iko.soy/rel8
on 3017f59 help sign in
rel8/src/Rel8.hs
370 lines 6.9 kB history raw
1{-# language DuplicateRecordFields #-}
3module Rel8
4 ( -- * Database types
5 -- ** @DBType@
6 DBType(..)
8 -- *** Deriving-via helpers
9 -- **** @JSONEncoded@
10 , JSONEncoded(..)
11 , JSONBEncoded(..)
13 -- **** @ReadShow@
14 , ReadShow(..)
16 -- **** Generic
17 , Composite(..), DBComposite(..), compose, decompose
18 , Enum(..), DBEnum(..), Enumable
20 -- *** @TypeInformation@
21 , TypeInformation(..)
22 , mapTypeInformation
23 , parseTypeInformation
25 -- ** The @DBType@ hierarchy
26 , DBSemigroup(..)
27 , DBMonoid(..)
28 , DBNum
29 , DBIntegral
30 , DBFractional
31 , DBFloating
33 -- * Tables and higher-kinded tables
34 , Rel8able, KRel8able
35 , Column, Field, Necessity( Required, Optional )
36 , Default
37 , HADT
38 , HEither
39 , HMaybe
40 , HList
41 , HNonEmpty
42 , HThese
43 , Lift
45 , Table(..)
46 , AltTable((<|>:))
47 , AlternativeTable( emptyTable )
48 , EqTable, (==:), (/=:)
49 , OrdTable, ascTable, descTable
50 , lit
51 , bool
52 , case_
54 -- ** @MaybeTable@
55 , MaybeTable
56 , maybeTable, ($?), nothingTable, justTable
57 , isNothingTable, isJustTable
58 , optional
59 , catMaybeTable
60 , bindMaybeTable
61 , traverseMaybeTable
62 , aggregateMaybeTable
63 , insertMaybeTable
64 , nameMaybeTable
66 -- ** @EitherTable@
67 , EitherTable
68 , eitherTable, leftTable, rightTable
69 , isLeftTable, isRightTable
70 , keepLeftTable
71 , keepRightTable
72 , bindEitherTable
73 , bitraverseEitherTable
74 , aggregateEitherTable
75 , insertEitherTable
76 , nameEitherTable
78 -- ** @TheseTable@
79 , TheseTable
80 , theseTable, thisTable, thatTable, thoseTable
81 , isThisTable, isThatTable, isThoseTable
82 , hasHereTable, hasThereTable
83 , justHereTable, justThereTable
84 , alignBy
85 , keepHereTable, loseHereTable
86 , keepThereTable, loseThereTable
87 , keepThisTable, loseThisTable
88 , keepThatTable, loseThatTable
89 , keepThoseTable, loseThoseTable
90 , bindTheseTable
91 , bitraverseTheseTable
92 , aggregateTheseTable
93 , insertTheseTable
94 , nameTheseTable
96 -- ** @ListTable@
97 , ListTable
98 , listTable
99 , insertListTable
100 , nameListTable
101 , many
102 , manyExpr
104 -- ** @NonEmptyTable@
105 , NonEmptyTable
106 , nonEmptyTable
107 , insertNonEmptyTable
108 , nameNonEmptyTable
109 , some
110 , someExpr
112 -- ** @ADT@
113 , ADT, ADTable, fromADT, toADT
114 , BuildADT, buildADT
115 , ConstructADT, constructADT
116 , DeconstructADT, deconstructADT
117 , InsertADT, insertADT
118 , NameADT, nameADT
119 , AggregateADT, aggregateADT
121 -- ** @HKD@
122 , HKD, HKDable, fromHKD, toHKD
123 , BuildHKD, buildHKD
124 , ConstructHKD, constructHKD
125 , DeconstructHKD, deconstructHKD
126 , InsertHKD, insertHKD
127 , NameHKD, nameHKD
128 , AggregateHKD, aggregateHKD
130 -- ** Table schemas
131 , TableSchema(..)
132 , Name
133 , namesFromLabels
134 , namesFromLabelsWith
136 -- * Expressions
137 , Expr
138 , Sql
139 , litExpr
140 , unsafeCastExpr
142 -- ** @null@
143 , null
144 , nullify
145 , nullable
146 , isNull
147 , isNonNull
148 , mapNull
149 , liftOpNull
150 , catNull
151 , coalesce
153 -- ** Boolean operations
154 , DBEq
155 , true, false, not_
156 , (&&.), and_
157 , (||.), or_
158 , (==.), (/=.), (==?), (/=?)
159 , in_
160 , boolExpr, caseExpr
162 -- ** Ordering
163 , DBOrd
164 , (<.), (<=.), (>.), (>=.)
165 , (<?), (<=?), (>?), (>=?)
166 , leastExpr, greatestExpr
168 -- ** Functions
169 , Function
170 , function
171 , nullaryFunction
172 , binaryOperator
174 -- * Queries
175 , Query
176 , showQuery
178 -- ** Selecting rows
179 , Selects
180 , each
181 , values
183 -- ** Filtering
184 , filter
185 , where_
186 , whereExists
187 , whereNotExists
188 , distinct
189 , distinctOn
190 , distinctOnBy
192 -- ** @LIMIT@/@OFFSET@
193 , limit
194 , offset
196 -- ** @UNION@
197 , union
198 , unionAll
200 -- ** @INTERSECT@
201 , intersect
202 , intersectAll
204 -- ** @EXCEPT@
205 , except
206 , exceptAll
208 -- ** @EXISTS@
209 , exists
210 , with
211 , withBy
212 , without
213 , withoutBy
215 -- ** Aggregation
216 , Aggregate
217 , aggregate
218 , countRows
219 , groupBy
220 , headAgg
221 , listAgg, listAggExpr
222 , nonEmptyAgg, nonEmptyAggExpr
223 , DBMax, max
224 , DBMin, min
225 , DBSum, sum, sumWhere
226 , DBString, stringAgg
227 , count
228 , countStar
229 , countDistinct
230 , countWhere
231 , and
232 , or
234 -- ** Ordering
235 , orderBy
236 , Order
237 , asc
238 , desc
239 , nullsFirst
240 , nullsLast
242 -- * IO
243 , Serializable
245 -- * Running statements
246 -- ** @SELECT@
247 , select
249 -- ** @INSERT@
250 , Insert(..)
251 , OnConflict(..)
252 , insert
253 , toInsert
254 , toInsertDefaults
256 -- ** @DELETE@
257 , Delete(..)
258 , delete
260 -- ** @UPDATE@
261 , update
262 , Update(..)
264 -- ** @.. RETURNING@
265 , Returning(..)
267 -- ** @CREATE VIEW@
268 , createView
270 -- * TODO
271 -- TODO
272 -- These need organizing, but are reachable from Rel8's documentation so we
273 -- do need to export and document them.
274 , Nullable
275 , NotNull
276 , HTable
277 , Labelable
278 , ToExprs(..)
279 , FromExprs
280 , Result
281 , HKDT(..)
282 ) where
284-- base
285import Prelude ()
287-- rel8
288import Rel8.Aggregate
289import Rel8.Column
290import Rel8.Column.ADT
291import Rel8.Column.Either
292import Rel8.Column.Field
293import Rel8.Column.Lift
294import Rel8.Column.List
295import Rel8.Column.Maybe
296import Rel8.Column.NonEmpty
297import Rel8.Column.These
298import Rel8.Expr
299import Rel8.Expr.Aggregate
300import Rel8.Expr.Bool
301import Rel8.Expr.Eq
302import Rel8.Expr.Function
303import Rel8.Expr.Null
304import Rel8.Expr.Opaleye (unsafeCastExpr)
305import Rel8.Expr.Ord
306import Rel8.Expr.Order
307import Rel8.Expr.Serialize
308import Rel8.Generic.Rel8able ( KRel8able, Rel8able )
309import Rel8.Kind.Necessity
310import Rel8.Order
311import Rel8.Query
312import Rel8.Query.Aggregate
313import Rel8.Query.Distinct
314import Rel8.Query.Each
315import Rel8.Query.Either
316import Rel8.Query.Exists
317import Rel8.Query.Filter
318import Rel8.Query.Limit
319import Rel8.Query.List
320import Rel8.Query.Maybe
321import Rel8.Query.Null
322import Rel8.Query.Order
323import Rel8.Query.SQL (showQuery)
324import Rel8.Query.Set
325import Rel8.Query.These
326import Rel8.Query.Values
327import Rel8.Schema.Context.Label
328import Rel8.Schema.HTable
329import Rel8.Schema.Name
330import Rel8.Schema.Null hiding ( nullable )
331import Rel8.Schema.Result ( Result )
332import Rel8.Schema.Table
333import Rel8.Statement.Delete
334import Rel8.Statement.Insert
335import Rel8.Statement.Returning
336import Rel8.Statement.Select
337import Rel8.Statement.Update
338import Rel8.Statement.View
339import Rel8.Table
340import Rel8.Table.ADT
341import Rel8.Table.Aggregate
342import Rel8.Table.Alternative
343import Rel8.Table.Bool
344import Rel8.Table.Either
345import Rel8.Table.Eq
346import Rel8.Table.HKD
347import Rel8.Table.Insert
348import Rel8.Table.List
349import Rel8.Table.Maybe
350import Rel8.Table.Name
351import Rel8.Table.NonEmpty
352import Rel8.Table.Ord
353import Rel8.Table.Order
354import Rel8.Table.Rel8able ()
355import Rel8.Table.Serialize
356import Rel8.Table.These
357import Rel8.Type
358import Rel8.Type.Composite
359import Rel8.Type.Eq
360import Rel8.Type.Enum
361import Rel8.Type.Information
362import Rel8.Type.JSONBEncoded
363import Rel8.Type.JSONEncoded
364import Rel8.Type.Monoid
365import Rel8.Type.Num
366import Rel8.Type.Ord
367import Rel8.Type.ReadShow
368import Rel8.Type.Semigroup
369import Rel8.Type.String
370import Rel8.Type.Sum