on dev help sign in
52 files changed+5530−3011
since splitsnapshots
unifiedsplit
.circleci/config.yml+1−1 README.md+59−70 RELEASE NOTES.md+400 squeal-postgresql/exe/Example.hs+9−7 squeal-postgresql/squeal-postgresql.cabal+41−11 squeal-postgresql/src/Squeal/PostgreSQL.hs+64−73 squeal-postgresql/src/Squeal/PostgreSQL/Alias.hs+14−10 squeal-postgresql/src/Squeal/PostgreSQL/Binary.hs+213−71 squeal-postgresql/src/Squeal/PostgreSQL/Definition.hs+12−1015 squeal-postgresql/src/Squeal/PostgreSQL/Definition/Function.hs+238 squeal-postgresql/src/Squeal/PostgreSQL/Definition/Index.hs+159 squeal-postgresql/src/Squeal/PostgreSQL/Definition/Schema.hs+96 squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table.hs+500 squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table/Constraint.hs+339 squeal-postgresql/src/Squeal/PostgreSQL/Definition/Type.hs+229 squeal-postgresql/src/Squeal/PostgreSQL/Definition/View.hs+104 squeal-postgresql/src/Squeal/PostgreSQL/Expression.hs+101−348 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Aggregate.hs+37−5 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Collection.hs+19−2 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Comparison.hs+48−40 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Json.hs+227−113 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Literal.hs+87 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Logic.hs+13−3 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Math.hs+14−7 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Null.hs+14−4 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Parameter.hs+80 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Range.hs+230 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Set.hs+139 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Sort.hs+24−14 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Subquery.hs+120 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Text.hs+13−4 squeal-postgresql/src/Squeal/PostgreSQL/Expression/TextSearch.hs+71−21 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Time.hs+18−12 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Type.hs+446 squeal-postgresql/src/Squeal/PostgreSQL/Expression/Window.hs+44−6 squeal-postgresql/src/Squeal/PostgreSQL/List.hs+40−51 squeal-postgresql/src/Squeal/PostgreSQL/Manipulation.hs+155−168 squeal-postgresql/src/Squeal/PostgreSQL/Migration.hs+53−57 squeal-postgresql/src/Squeal/PostgreSQL/PG.hs+98−92 squeal-postgresql/src/Squeal/PostgreSQL/PQ.hs+96−40 squeal-postgresql/src/Squeal/PostgreSQL/Pool.hs+67−99 squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+247−370 squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+164−62 squeal-postgresql/src/Squeal/PostgreSQL/Transaction.hs+76−44 squeal-postgresql/src/Squeal/PostgreSQL/Tutorial.hs−39 squeal-postgresql/test/Doc.hs+6 squeal-postgresql/test/DocTest.hs−18 squeal-postgresql/test/Property.hs+166 squeal-postgresql/test/Spec.hs+136 squeal-postgresql/test/Specs/ExceptionHandling.hs−126 squeal-postgresql/test/Specs/Specs.hs−7 stack.yaml+3−1
.circleci/config.yml+1−1
@@ -2,7 +2,7 @@ version: 2
22jobs:
33 build:
44 docker:
5− - image: haskell:8.6.3
5+ - image: haskell:8.6.5
66 - image: circleci/postgres:latest
77 environment:
88 POSTGRES_USER: root
README.md+59−70
@@ -46,7 +46,11 @@ composable and cover a large portion of SQL.
4646* transactions
4747* views
4848* array, composite and enumerated types
49−* json operations
49+* json functions and operations
50+* multischema support
51+* correlated subqueries
52+* window functions
53+* text search
5054
5155## installation
5256
@@ -72,19 +76,17 @@ First, we need some language extensions because Squeal uses modern GHC
7276features.
7377
7478```Haskell
75−>>> :set -XDataKinds -XDeriveGeneric -XOverloadedLabels
76−>>> :set -XOverloadedStrings -XTypeApplications -XTypeOperators
79+>>> :set -XDataKinds -XDeriveGeneric -XOverloadedLabels -XFlexibleContexts
80+>>> :set -XOverloadedStrings -XTypeApplications -XTypeOperators -XGADTs
7781```
7882
7983We'll need some imports.
8084
8185```Haskell
82−>>> import Control.Monad (void)
8386>>> import Control.Monad.IO.Class (liftIO)
8487>>> import Data.Int (Int32)
8588>>> import Data.Text (Text)
8689>>> import Squeal.PostgreSQL
87−>>> import Squeal.PostgreSQL.Render
8890```
8991
9092We'll use generics to easily convert between Haskell and PostgreSQL values.
@@ -99,27 +101,27 @@ we use `DataKinds` and `TypeOperators`.
99101
100102```Haskell
101103>>> :{
104+type UsersColumns =
105+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4
106+ , "name" ::: 'NoDef :=> 'NotNull 'PGtext ]
107+type UsersConstraints = '[ "pk_users" ::: 'PrimaryKey '["id"] ]
108+type EmailsColumns =
109+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4
110+ , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4
111+ , "email" ::: 'NoDef :=> 'Null 'PGtext ]
112+type EmailsConstraints =
113+ '[ "pk_emails" ::: 'PrimaryKey '["id"]
114+ , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"] ]
102115type Schema =
103− '[ "users" ::: 'Table (
104− '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>
105− '[ "id" ::: 'Def :=> 'NotNull 'PGint4
106− , "name" ::: 'NoDef :=> 'NotNull 'PGtext
107− ])
108− , "emails" ::: 'Table (
109− '[ "pk_emails" ::: 'PrimaryKey '["id"]
110− , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]
111− ] :=>
112− '[ "id" ::: 'Def :=> 'NotNull 'PGint4
113− , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4
114− , "email" ::: 'NoDef :=> 'Null 'PGtext
115− ])
116− ]
116+ '[ "users" ::: 'Table (UsersConstraints :=> UsersColumns)
117+ , "emails" ::: 'Table (EmailsConstraints :=> EmailsColumns) ]
118+type Schemas = Public Schema
117119:}
118120```
119121
120122Notice the use of type operators.
121123
122−`:::` is used to pair an alias `GHC.TypeLits.Symbol` with a `SchemumType`,
124+`:::` is used to pair an alias `Symbol` with a `SchemumType`,
123125a `TableConstraint` or a `ColumnType`. It is intended to connote Haskell's `::`
124126operator.
125127
@@ -137,7 +139,7 @@ labels to refer to named tables and columns in our schema.
137139```Haskell
138140>>> :{
139141let
140− setup :: Definition '[] Schema
142+ setup :: Definition (Public '[]) Schemas
141143 setup =
142144 createTable #users
143145 ( serial `as` #id :*
@@ -169,7 +171,7 @@ primary and foreign keys, making them somewhat complex. Our `teardown`
169171```Haskell
170172>>> :{
171173let
172− teardown :: Definition Schema '[]
174+ teardown :: Definition Schemas (Public '[])
173175 teardown = dropTable #emails >>> dropTable #users
174176:}
175177
@@ -178,54 +180,54 @@ DROP TABLE "emails";
178180DROP TABLE "users";
179181```
180182
181−Next, we'll write `Manipulation`s to insert data into our two tables.
182−A `Manipulation` like `insertRow`, `update` or `deleteFrom`
183−has three type parameters, the schema it refers to, a list of parameters
184−it can take as input, and a list of columns it produces as output. When
183+We'll need a Haskell type for `User`s. We give the type `SOP.Generic` and
184+`SOP.HasDatatypeInfo` instances so that we can encode and decode `User`s.
185+
186+```Haskell
187+>>> data User = User { userName :: Text, userEmail :: Maybe Text } deriving (Show, GHC.Generic)
188+>>> instance SOP.Generic User
189+>>> instance SOP.HasDatatypeInfo User
190+```
191+
192+Next, we'll write `Manipulation_`s to insert `User`s into our two tables.
193+A `Manipulation_` like `insertInto`, `update` or `deleteFrom`
194+has three type parameters, the schemas it refers to, input parameters
195+and an output row. When
185196we insert into the users table, we will need a parameter for the `name`
186197field but not for the `id` field. Since it's serial, we can use a default
187198value. However, since the emails table refers to the users table, we will
188199need to retrieve the user id that the insert generates and insert it into
189−the emails table. Take a careful look at the type and definition of both
190−of our inserts.
200+the emails table. We can do this in a single `Manipulation_` by using a
201+`with` statement.
191202
192203```Haskell
193204>>> :{
194205let
195− insertUser :: Manipulation Schema '[ 'NotNull 'PGtext ] '[ "fromOnly" ::: 'NotNull 'PGint4 ]
196− insertUser = insertRow #users
197− (Default `as` #id :* Set (param @1) `as` #name)
198− OnConflictDoNothing (Returning (#id `as` #fromOnly))
199−:}
200−
201−>>> :{
202−let
203− insertEmail :: Manipulation Schema '[ 'NotNull 'PGint4, 'Null 'PGtext] '[]
204− insertEmail = insertRow #emails
205− ( Default `as` #id :*
206− Set (param @1) `as` #user_id :*
207− Set (param @2) `as` #email )
208− OnConflictDoNothing (Returning Nil)
206+ insertUser :: Manipulation_ Schemas User ()
207+ insertUser = with (u `as` #u) e
208+ where
209+ u = insertInto #users
210+ (Values_ (Default `as` #id :* Set (param @1) `as` #name))
211+ OnConflictDoRaise (Returning_ (#id :* param @2 `as` #email))
212+ e = insertInto_ #emails $ Select
213+ (Default `as` #id :* Set (#u ! #id) `as` #user_id :* Set (#u ! #email) `as` #email)
214+ (from (common #u))
209215:}
210216
211217>>> printSQL insertUser
212−INSERT INTO "users" ("id", "name") VALUES (DEFAULT, ($1 :: text)) ON CONFLICT DO NOTHING RETURNING "id" AS "fromOnly"
213−>>> printSQL insertEmail
214−INSERT INTO "emails" ("id", "user_id", "email") VALUES (DEFAULT, ($1 :: int4), ($2 :: text)) ON CONFLICT DO NOTHING
218+WITH "u" AS (INSERT INTO "users" ("id", "name") VALUES (DEFAULT, ($1 :: text)) RETURNING "id" AS "id", ($2 :: text) AS "email") INSERT INTO "emails" ("user_id", "email") SELECT "u"."id", "u"."email" FROM "u" AS "u"
215219```
216220
217−Next we write a `Query` to retrieve users from the database. We're not
221+Next we write a `Query_` to retrieve users from the database. We're not
218222interested in the ids here, just the usernames and email addresses. We
219−need to use an inner join to get the right result. A `Query` is like a
220−`Manipulation` with the same kind of type parameters.
223+need to use an `innerJoin` to get the right result. A `Query_` is like a
224+`Manipulation_` with the same kind of type parameters.
221225
222226```Haskell
223227>>> :{
224228let
225− getUsers :: Query Schema '[]
226− '[ "userName" ::: 'NotNull 'PGtext
227− , "userEmail" ::: 'Null 'PGtext ]
228− getUsers = select
229+ getUsers :: Query_ Schemas () User
230+ getUsers = select_
229231 (#u ! #name `as` #userName :* #e ! #email `as` #userEmail)
230232 ( from (table (#users `as` #u)
231233 & innerJoin (table (#emails `as` #e))
@@ -236,19 +238,7 @@ let
236238SELECT "u"."name" AS "userName", "e"."email" AS "userEmail" FROM "users" AS "u" INNER JOIN "emails" AS "e" ON ("u"."id" = "e"."user_id")
237239```
238240
239−Now that we've defined the SQL side of things, we'll need a Haskell type
240−for users. We give the type `Generics.SOP.Generic` and
241−`Generics.SOP.HasDatatypeInfo` instances so that we can decode the rows
242−we receive when we run `getUsers`. Notice that the record fields of the
243−`User` type match the column names of `getUsers`.
244−
245−```Haskell
246−>>> data User = User { userName :: Text, userEmail :: Maybe Text } deriving (Show, GHC.Generic)
247−>>> instance SOP.Generic User
248−>>> instance SOP.HasDatatypeInfo User
249−```
250−
251−Let's also create some users to add to the database.
241+Let's create some users to add to the database.
252242
253243```Haskell
254244>>> :{
@@ -273,19 +263,18 @@ transformer and when the schema doesn't change we can use `Monad` and
273263```Haskell
274264>>> :{
275265let
276− session :: PQ Schema Schema IO ()
266+ session :: PQ Schemas Schemas IO ()
277267 session = do
278− idResults <- traversePrepared insertUser (Only . userName <$> users)
279− ids <- traverse (fmap fromOnly . getRow 0) idResults
280− traversePrepared_ insertEmail (zip (ids :: [Int32]) (userEmail <$> users))
268+ _ <- traversePrepared_ insertUser users
281269 usersResult <- runQuery getUsers
282270 usersRows <- getRows usersResult
283271 liftIO $ print (usersRows :: [User])
284272in
285− void . withConnection "host=localhost port=5432 dbname=exampledb" $
273+ withConnection "host=localhost port=5432 dbname=exampledb" $
286274 define setup
287275 & pqThen session
288276 & pqThen (define teardown)
289277:}
290278[User {userName = "Alice", userEmail = Just "alice@gmail.com"},User {userName = "Bob", userEmail = Nothing},User {userName = "Carole", userEmail = Just "carole@hotmail.com"}]
279+-}
291280```
RELEASE NOTES.md+400
@@ -1,5 +1,405 @@
11## RELEASE NOTES
22
3+### Version 0.5
4+
5+Version 0.5 makes a number of large changes and additions to Squeal.
6+I want to thank folks who contributed issues and pull requests;
7+Raveline, rimmington, ilyakooo0, chshersh, reygoch, and more.
8+
9+**Multi-schema support**
10+
11+Previous versions of Squeal only supported definitions in the "public"
12+schema. Squeal 0.5 adds support for multiple schemas with the new kind
13+
14+```Haskell
15+type SchemasType = [(Symbol,SchemaType)]
16+```
17+
18+In order to upgrade your queries, manipulations and definitions from
19+Squeal 0.4, you will have to apply the `Public` type family, which indicates
20+that your only schema is the "public" schema.
21+
22+```Haskell
23+-- Squeal 0.4
24+setup :: Definition '[] Schema
25+
26+-- Squeal 0.5
27+setup :: Definition (Public '[]) (Public Schema)
28+```
29+
30+You can create non-public schemas using `createSchema` and inversely
31+remove them using `dropSchema`. There is also an idempotent
32+`createSchemaIfNotExists`.
33+
34+In order to handle aliases which may refer to non-public schemas, Squeal 0.5
35+introduces `QualifiedAlias`es. A `QualifiedAlias` can be referred to using
36+the `(!)` operator from the `IsQualified` typeclass; but if you want to refer
37+to an alias from the "public" schema, you can continue to use a single
38+overloaded label, no need to write `#public ! #tab`, just write `#tab`.
39+
40+**Top-level statements**
41+
42+As a consequence of multi-schema support, common table expressions that
43+a `Query` or `Manipulation` may refer to had to be broken into a new parameter.
44+Additionally, `Query` gained another new parameter for its outer scope which
45+will be discussed in the next section.
46+
47+To simplify type signatures that you have to write for top-level queries
48+and manipulations, Squeal 0.5 introduces the `Query_` and `Manipulation_`
49+type families.
50+
51+```
52+type family Query_
53+ (schemas :: SchemasType)
54+ (parameters :: Type)
55+ (row :: Type) where
56+ Query_ schemas params row =
57+ Query '[] '[] schemas (TuplePG params) (RowPG row)
58+```
59+
60+As you see, a top-level `Query_` has no outer scope and no common
61+table expressions in scope, they are empty `'[]`. Moreover,
62+its parameters and row parameters are now `Type`s, which are
63+converted to corresponding Postgres types using the `TuplePG`
64+and `RowPG` type families. This means you can write the type signatures
65+for your top-level statements using the Haskell types that you
66+intend to input and retrieve when running the statements. Similar
67+to `Query_`, there is a `Manipulation_` type, the only difference
68+being that a general `Manipulation` doesn't have an outer scope,
69+only a scope for common table expressions.
70+
71+**Subquery expressions**
72+
73+Previous versions of Squeal offered subquery expression support
74+but there were issues. The common use case of using the `IN` operator
75+from SQL was overly complex. There was a proliferation of subquery
76+functions to handle different comparison operators, each with two versions
77+for comparing `ALL` or `ANY` of the query rows. And, most confoundedly,
78+there was no way to support the `EXISTS` subquery because the "outer scope"
79+for a query was not available.
80+
81+Squeal adds an outer scope to the `Query` type.
82+
83+```Haskell
84+newtype Query
85+ (outer :: FromType)
86+ (commons :: FromType)
87+ (schemas :: SchemasType)
88+ (params :: [NullityType])
89+ (row :: RowType)
90+ = UnsafeQuery { renderQuery :: ByteString }
91+```
92+
93+This enables a well-typed `exists` function.
94+
95+```Haskell
96+exists
97+ :: Query (Join outer from) commons schemas params row
98+ -> Condition outer commons grp schemas params from
99+```
100+
101+The `in_` and `notIn` functions were simplified to handle the most
102+common use case of comparing to a list of values.
103+
104+```Haskell
105+in_
106+ :: Expression outer commons grp schemas params from ty -- ^ expression
107+ -> [Expression outer commons grp schemas params from ty]
108+ -> Condition outer commons grp schemas params from
109+```
110+
111+Finally, general subquery comparisons were abstracted to work with
112+any comparison operators, using the `Operator` type which will be discussed in
113+the next section.
114+
115+```Haskell
116+subAll
117+ :: Expression outer commons grp schemas params from ty1
118+ -> Operator ty1 ty2 ('Null 'PGbool)
119+ -> Query (Join outer from) commons schemas params '[col ::: ty2]
120+ -> Condition outer commons grp schemas params from
121+
122+subAny
123+ :: Expression outer commons grp schemas params from ty1
124+ -> Operator ty1 ty2 ('Null 'PGbool)
125+ -> Query (Join outer from) commons schemas params '[col ::: ty2]
126+ -> Condition outer commons grp schemas params from
127+```
128+
129+**Expression RankNTypes**
130+
131+Squeal 0.5 introduces RankNType type synonyms for common expression patterns.
132+The simplest example is the `Expr` type, a type for "closed" expressions
133+that cannot reference any aliases or parameters.
134+
135+```Haskell
136+type Expr x
137+ = forall outer commons grp schemas params from
138+ . Expression outer commons grp schemas params from x
139+```
140+
141+There is also a function type `(-->)`, which is a subtype of the usual Haskell function
142+type `(->)`.
143+
144+```Haskell
145+type (-->) x y
146+ = forall outer commons grp schemas params from
147+ . Expression outer commons grp schemas params from x
148+ -> Expression outer commons grp schemas params from y
149+```
150+
151+We saw in the subquery section that there is an `Operator` type.
152+
153+```Haskell
154+type Operator x1 x2 y
155+ = forall outer commons grp schemas params from
156+ . Expression outer commons grp schemas params from x1
157+ -> Expression outer commons grp schemas params from x2
158+ -> Expression outer commons grp schemas params from y
159+```
160+
161+There are also types `FunctionN` and `FunctionVar` for n-ary functions
162+and variadic functions.
163+
164+```
165+type FunctionN xs y
166+ = forall outer commons grp schemas params from
167+ . NP (Expression outer commons grp schemas params from) xs
168+ -> Expression outer commons grp schemas params from y
169+```
170+
171+An n-ary function takes an `NP` list of `Expression`s as its argument.
172+Squeal 0.5 adds a helpful operator `(*:)`, to help scrap your `Nil`s.
173+You can construct an `NP` list now by using the operator `(:*)`,
174+until your last element, using `(*:)` there. For instance, the function
175+`atan2_` takes two arguments, `atan2_ (pi *: 2)`.
176+
177+**Selections**
178+
179+Previously, Squeal provided a couple versions of `SELECT` depending
180+on whether you wanted to select all columns of a unique table
181+in the from clause, i.e. `*`, all columns of a particular table
182+in the from clause, i.e. `.*`, or a list of columns from the from clause.
183+
184+Squeal 0.5 refactors this pattern into a `Selection` GADT type, allowing
185+for abstraction and combinations that were not possible before.
186+
187+```Haskell
188+data Selection outer commons grp schemas params from row where
189+ Star
190+ :: HasUnique tab from row
191+ => Selection outer commons 'Ungrouped schemas params from row
192+ DotStar
193+ :: Has tab from row
194+ => Alias tab
195+ -> Selection outer commons 'Ungrouped schemas params from row
196+ List
197+ :: SListI row
198+ => NP (Aliased (Expression outer commons grp schemas params from)) row
199+ -> Selection outer commons grp schemas params from row
200+ Over
201+ :: SListI row
202+ => NP (Aliased (WindowFunction outer commons grp schemas params from)) row
203+ -> WindowDefinition outer commons grp schemas params from
204+ -> Selection outer commons grp schemas params from row
205+ Also
206+ :: Selection outer commons grp schemas params from right
207+ -> Selection outer commons grp schemas params from left
208+ -> Selection outer commons grp schemas params from (Join left right)
209+```
210+
211+In addition to the `Star`, `DotStar` and `List` constructors, there is an
212+`Also` constructor combinator, which enables users to combine `Selection`s.
213+Additionally, there is an `Over` constructor that is used to enable
214+window functions, described in the next section.
215+
216+To upgrade from Squeal 0.4, you will replace `selectStar` with `select Star`,
217+replace `selectDotStar #tab` with `select (DotStar #tab)`. The `List`
218+selection is such a common use case that there is a function `select_` which
219+automatically applies it, so to upgrade from Squeal 0.4, replace `select`
220+with `select_`. There are also independent `selectDistinct` and `selectDistinct_`
221+functions to filter out duplicate rows.
222+
223+**Query clauses**
224+
225+Previously, Squeal provided a couple versions of `INSERT` depending
226+on whether you wanted to insert `VALUES` or a query.
227+
228+Squeal 0.5 refactors this pattern into a `QueryClause` GADT.
229+
230+```
231+-- Squeal 0.4
232+insertRow_ #tab (Set 2 `as` #col1 :* Default `as` #col2)
233+insertQuery_ #tab (selectStar (from (table #other_tab)))
234+
235+-- Squeal 0.5
236+insertInto_ #tab (Values_ (Set 2 `as` #col1 :* Default `as` #col2))
237+insertInto_ #tab (Subquery (select Star (from (table #other_tab))))
238+```
239+
240+**Window functions and aggregation**
241+
242+Previous versions of Squeal provided no support for window functions.
243+Squeal 0.5 adds support for window functions. We saw `Over` in the
244+previous section.
245+
246+```Haskell
247+Over
248+ :: SListI row
249+ => NP (Aliased (WindowFunction outer commons grp schemas params from)) row
250+ -> WindowDefinition outer commons grp schemas params from
251+ -> Selection outer commons grp schemas params from row
252+```
253+
254+`Over` combines window functions with window definitions. A `WindowDefinition`
255+is constructed using the `partitionBy` function, optionally with an `orderBy`
256+clause. For example,
257+
258+```Haskell
259+query :: Query_ (Public Schema) () (Row Int32 Int32)
260+query = select
261+ (#col1 & Also (rank `as` #col2 `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))
262+ (from (table #tab))
263+```
264+
265+Here the `rank` function is a `WindowFunction`
266+
267+```Haskell
268+rank :: WinFun0 ('NotNull 'PGint8)
269+rank = UnsafeWindowFunction "rank()"
270+```
271+
272+`WinFun0` is a RankNType, like `Expr` was, used for no argument window functions.
273+Similarly, there are also `WinFun1` and `WinFunN` types for
274+window functions and n-ary window functions.
275+
276+In order to use the same syntax for certain window functions and aggregate functions,
277+a new typeclass `Aggregate` was introduced. So for instance, `sum_` can be
278+either a `Distinction` `Expression` or a `WindowFunction`, used either with
279+a `groupBy` or with a `partitionBy` in the appropriate way.
280+
281+```
282+data Distinction (expr :: kind -> Type) (ty :: kind)
283+ = All (expr ty)
284+ | Distinct (expr ty)
285+```
286+
287+Aggregate functions can be run over all rows or only over distinct rows,
288+while window functions bear no such distinction.
289+
290+**Migrations**
291+
292+Thanks to [https://github.com/Raveline](Raveline) Squeal 0.5 introduces
293+a function `defaultMain` to easily create a command line program to
294+run or rewind your migrations.
295+
296+Previously, Squeal's migrations were impure, allowing in addition to
297+running `Definition`s to run arbitrary `IO` operations, such as inserting
298+data into the database or printing out status messages. In order to
299+provide compatibility with other migration systems, Squeal 0.5 introduces
300+pure migrations, that is migrations that are only `Definition`s.
301+
302+```Haskell
303+data Migration p schemas0 schemas1 = Migration
304+ { name :: Text -- ^ The `name` of a `Migration`.
305+ -- Each `name` in a `Migration` should be unique.
306+ , up :: p schemas0 schemas1 -- ^ The `up` instruction of a `Migration`.
307+ , down :: p schemas1 schemas0 -- ^ The `down` instruction of a `Migration`.
308+ } deriving (GHC.Generic)
309+```
310+
311+A pure migration is a `Migration Definition`, a pair of inverse
312+`Definition`s with a unique name. To recover impure migrations, Squeal 0.5
313+introduces the `Terminally` type.
314+
315+```Haskell
316+newtype Terminally trans monad x0 x1 = Terminally
317+ { runTerminally :: trans x0 x1 monad () }
318+```
319+
320+`Terminally` applies the indexed monad transformer and the monad it transforms
321+to the unit type `()`, thereby turning an indexed monad into a `Category`. An
322+impure migration is a `Migration (Terminally PQ IO)`. You can always cast
323+a pure migration into an impure migration with the functor, `pureMigration`.
324+
325+```Haskell
326+pureMigration
327+ :: Migration Definition schemas0 schemas1
328+ -> Migration (Terminally PQ IO) schemas0 schemas1
329+```
330+
331+To run either pure or impure migrations, Squeal 0.5 introduces
332+a typeclass, `Migratory`.
333+
334+```
335+class Category p => Migratory p where
336+
337+ migrateUp
338+ :: AlignedList (Migration p) schemas0 schemas1
339+ -> PQ schemas0 schemas1 IO ()
340+
341+ migrateDown
342+ :: AlignedList (Migration p) schemas0 schemas1
343+ -> PQ schemas1 schemas0 IO ()
344+```
345+
346+The signatures of `migrateUp` and `migrateDown` have been changed
347+to make them easier to compose with other `PQ` actions.
348+
349+**Transactions**
350+
351+You can now run transactions `ephemerally`, guaranteed to roll back,
352+but return the result or throw the exception that the transaction
353+would have generated. This is useful for testing. You can also
354+`transactionallyRetry` computations, retrying the transaction if
355+a [serialization failure](https://www.postgresql.org/docs/11/transaction-iso.html#XACT-REPEATABLE-READ) occurs.
356+
357+**Types**
358+
359+Squeal now supports money via a `Money` Haskell `Type` and a `'PGmoney`
360+`PGType`. Squeal 0.5 also adds support for creating domain types
361+with `createDomain`.
362+
363+**Time**
364+
365+Squeal 0.5 adds support for new functions; `now`, `makeDate`, `makeTime`,
366+, `makeTimestamp`, and `makeTimestamptz`, a function `interval_` for
367+constructing time intervals out multiples of `TimeUnit`s, and a new
368+`TimeOp` class, defining affine space operators for time types and their
369+differences.
370+
371+**Literals**
372+
373+Squeal allows you to include Haskell values in your statements using
374+out of line `parameter`s, but often you want to include them inline,
375+as a SQL `literal`. Squeal 0.5 enables this using the `Literal` class.
376+
377+**Set returning functions**
378+
379+Squeal 0.5 adds support for set returning functions such as `unnest`,
380+with the `RankNType` `SetOfFunction`, which can be used as as a `FromClause`.
381+
382+**Text search**
383+
384+Squeal 0.5 adds extensive support for text search types, functions and operators.
385+
386+**Much more**
387+
388+Lots more changes went into and under the hood of the new version.
389+The `Expression` module was split into coherent submodules since it
390+had grown to immense proportions. New modules `Alias`, `PG` and `List`
391+were added to relieve some of the burden that the `Schema` module
392+had been carrying. Rendering has been better unified with a new
393+`RenderSQL` typeclass. Type level list concatenation with the `Additional`
394+typeclass has been added. `Manipulation`s `update` and `delete`
395+were upgraded, so you can leave out fields you don't want to update and
396+use `USING` clauses in deletes. Upserts which were previously broken
397+now work. The `IO` typeclass hierarchy was changed from `MonadBase`
398+and `MonadBaseControl` to `MonadIO` and `MonadUnliftIO`. A new
399+`withRecursive` `Manipulation` was added. `SquealException`s were
400+refactored and a `trySqueal` function added. Arrays were refactored.
401+And there was probably more I've forgotten.
402+
3403### Version 0.4
4404
5405Version 0.4 strengthens Squeal's type system, adds
squeal-postgresql/exe/Example.hs+9−7
@@ -11,7 +11,6 @@
1111
1212module Main (main, main2) where
1313
14−import Control.Monad (void)
1514import Control.Monad.IO.Class (MonadIO (..))
1615import Data.Int (Int16, Int32)
1716import Data.Monoid ((<>))
@@ -39,6 +38,7 @@ type Schema =
3938 , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4
4039 , "email" ::: 'NoDef :=> 'Null 'PGtext
4140 ])
41+ , "positive" ::: 'Typedef 'PGfloat4
4242 ]
4343
4444type Schemas = Public Schema
@@ -53,23 +53,25 @@ setup =
5353 >>>
5454 createTable #emails
5555 ( serial `as` #id :*
56− (int & notNullable) `as` #user_id :*
57− (text & nullable) `as` #email )
56+ hask @Int32 `as` #user_id :*
57+ hask @(Maybe Text) `as` #email )
5858 ( primaryKey #id `as` #pk_emails :*
5959 foreignKey #user_id #users #id
6060 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )
61+ >>>
62+ createDomain #positive real (#value .> 0 .&& (#value & isNotNull))
6163
6264teardown :: Definition Schemas (Public '[])
63−teardown = dropTable #emails >>> dropTable #users
65+teardown = dropType #positive >>> dropTable #emails >>> dropTable #users
6466
6567insertUser :: Manipulation_ Schemas (Text, VarArray (Vector (Maybe Int16))) (Only Int32)
6668insertUser = insertInto #users
67− (Values_ (defaultAs #id :* param @1 `as` #name :* param @2 `as` #vec))
69+ (Values_ (Default `as` #id :* Set (param @1) `as` #name :* Set (param @2) `as` #vec))
6870 (OnConflict (OnConstraint #pk_users) DoNothing) (Returning_ (#id `as` #fromOnly))
6971
7072insertEmail :: Manipulation_ Schemas (Int32, Maybe Text) ()
7173insertEmail = insertInto_ #emails
72− (Values_ (defaultAs #id :* param @1 `as` #user_id :* param @2 `as` #email))
74+ (Values_ (Default `as` #id :* Set (param @1) `as` #user_id :* Set (param @2) `as` #email))
7375
7476getUsers :: Query_ Schemas () User
7577getUsers = select_
@@ -117,7 +119,7 @@ main = do
117119
118120main2 :: IO ()
119121main2 =
120− void . withConnection "host=localhost port=5432 dbname=exampledb" $
122+ withConnection "host=localhost port=5432 dbname=exampledb" $
121123 define setup
122124 & pqThen session
123125 & pqThen (define teardown)
squeal-postgresql/squeal-postgresql.cabal+41−11
@@ -1,5 +1,5 @@
11name: squeal-postgresql
2−version: 0.4.9.0
2+version: 0.5.1.0
33synopsis: Squeal PostgreSQL Library
44description: Squeal is a type-safe embedding of PostgreSQL in Haskell
55homepage: https://github.com/morphismtech/squeal
@@ -25,18 +25,31 @@ library
2525 Squeal.PostgreSQL.Alias
2626 Squeal.PostgreSQL.Binary
2727 Squeal.PostgreSQL.Definition
28+ Squeal.PostgreSQL.Definition.Function
29+ Squeal.PostgreSQL.Definition.Index
30+ Squeal.PostgreSQL.Definition.Table
31+ Squeal.PostgreSQL.Definition.Table.Constraint
32+ Squeal.PostgreSQL.Definition.Type
33+ Squeal.PostgreSQL.Definition.Schema
34+ Squeal.PostgreSQL.Definition.View
2835 Squeal.PostgreSQL.Expression
2936 Squeal.PostgreSQL.Expression.Aggregate
3037 Squeal.PostgreSQL.Expression.Collection
3138 Squeal.PostgreSQL.Expression.Comparison
3239 Squeal.PostgreSQL.Expression.Json
40+ Squeal.PostgreSQL.Expression.Literal
3341 Squeal.PostgreSQL.Expression.Logic
3442 Squeal.PostgreSQL.Expression.Math
3543 Squeal.PostgreSQL.Expression.Null
44+ Squeal.PostgreSQL.Expression.Parameter
45+ Squeal.PostgreSQL.Expression.Range
46+ Squeal.PostgreSQL.Expression.Set
3647 Squeal.PostgreSQL.Expression.Sort
48+ Squeal.PostgreSQL.Expression.Subquery
3749 Squeal.PostgreSQL.Expression.Text
3850 Squeal.PostgreSQL.Expression.TextSearch
3951 Squeal.PostgreSQL.Expression.Time
52+ Squeal.PostgreSQL.Expression.Type
4053 Squeal.PostgreSQL.Expression.Window
4154 Squeal.PostgreSQL.List
4255 Squeal.PostgreSQL.Manipulation
@@ -57,7 +70,8 @@ library
5770 , bytestring >= 0.10.8.2
5871 , bytestring-strict-builder >= 0.4.5
5972 , deepseq >= 1.4.3.0
60− , generics-sop >= 0.3.2.0
73+ , free-categories >= 0.1.0.0
74+ , generics-sop >= 0.3.2.0 && < 0.5.0.0
6175 , mmorph >= 1.1.1
6276 , mtl >= 2.2.2
6377 , network-ip >= 0.3.0.2
@@ -74,34 +88,50 @@ library
7488 , uuid-types >= 1.0.3
7589 , vector >= 0.12.0.1
7690
77−test-suite squeal-postgresql-doctest
91+test-suite doctest
7892 default-language: Haskell2010
7993 type: exitcode-stdio-1.0
8094 hs-source-dirs: test
8195 ghc-options: -Wall
82− main-is: DocTest.hs
96+ main-is: Doc.hs
8397 build-depends:
8498 base >= 4.10.0.0
8599 , doctest >= 0.11.4
100+ , squeal-postgresql
86101
87−test-suite squeal-postgresql-specs
102+test-suite properties
88103 default-language: Haskell2010
89104 type: exitcode-stdio-1.0
90− hs-source-dirs: test/Specs
91− ghc-options: -Wall -main-is Specs
92− main-is: Specs.hs
93− other-modules: ExceptionHandling
105+ hs-source-dirs: test
106+ ghc-options: -Wall
107+ main-is: Property.hs
94108 build-depends:
95109 base >= 4.10.0.0
96110 , bytestring >= 0.10.8.2
111+ , hedgehog >= 1.0
112+ , mtl >= 2.2.2
113+ , scientific >= 0.3.5.3
114+ , squeal-postgresql
115+ , time >= 1.8.0.2
116+
117+test-suite spec
118+ default-language: Haskell2010
119+ type: exitcode-stdio-1.0
120+ hs-source-dirs: test
121+ ghc-options: -Wall
122+ main-is: Spec.hs
123+ build-depends:
124+ base >= 4.10.0.0
125+ , async >= 2.2.2
126+ , bytestring >= 0.10.8.2
97127 , generics-sop >= 0.3.1.0
98128 , hspec >= 2.4.8
129+ , mtl >= 2.2.2
99130 , squeal-postgresql
100131 , text >= 1.2.2.2
101− , transformers >= 0.5.2.0
102132 , vector >= 0.12.0.1
103133
104−executable squeal-postgresql-example
134+executable example
105135 default-language: Haskell2010
106136 hs-source-dirs: exe
107137 ghc-options: -Wall
squeal-postgresql/src/Squeal/PostgreSQL.hs+64−73
@@ -1,7 +1,7 @@
11{-|
22Module: Squeal.PostgreSQL
33Description: Squeal export module
4−Copyright: (c) Eitan Chatav, 2017
4+Copyright: (c) Eitan Chatav, 2019
55Maintainer: eitan@morphism.tech
66Stability: experimental
77
@@ -11,17 +11,15 @@ Let's see an example!
1111First, we need some language extensions because Squeal uses modern GHC
1212features.
1313
14−>>> :set -XDataKinds -XDeriveGeneric -XOverloadedLabels
14+>>> :set -XDataKinds -XDeriveGeneric -XOverloadedLabels -XFlexibleContexts
1515>>> :set -XOverloadedStrings -XTypeApplications -XTypeOperators -XGADTs
1616
1717We'll need some imports.
1818
19−>>> import Control.Monad (void)
2019>>> import Control.Monad.IO.Class (liftIO)
2120>>> import Data.Int (Int32)
2221>>> import Data.Text (Text)
2322>>> import Squeal.PostgreSQL
24−>>> import Squeal.PostgreSQL.Render
2523
2624We'll use generics to easily convert between Haskell and PostgreSQL values.
2725
@@ -104,45 +102,44 @@ let
104102DROP TABLE "emails";
105103DROP TABLE "users";
106104
107−Next, we'll write `Manipulation`s to insert data into our two tables.
108−A `Manipulation` like `insertInto`, `update` or `deleteFrom`
109−has three type parameters, the schema it refers to, a list of parameters
110−it can take as input, and a list of columns it produces as output. When
111−we insert into the users table, we will need a parameter for the @name@
112−field but not for the @id@ field. Since it's serial, we can use a default
113−value. However, since the emails table refers to the users table, we will
114−need to retrieve the user id that the insert generates and insert it into
115−the emails table. Take a careful look at the type and definition of both
116−of our inserts.
117−
118−We'll need a Haskell type for users. We give the type `Generics.SOP.Generic` and
119−`Generics.SOP.HasDatatypeInfo` instances so that we can decode the rows
120−we receive when we run @getUsers@. Notice that the record fields of the
121−@User@ type match the column names of @getUsers@.
105+We'll need a Haskell type for @User@s. We give the type `Generics.SOP.Generic` and
106+`Generics.SOP.HasDatatypeInfo` instances so that we can encode and decode @User@s.
122107
123108>>> data User = User { userName :: Text, userEmail :: Maybe Text } deriving (Show, GHC.Generic)
124109>>> instance SOP.Generic User
125110>>> instance SOP.HasDatatypeInfo User
126111
112+Next, we'll write `Manipulation_`s to insert @User@s into our two tables.
113+A `Manipulation_` like `insertInto`, `update` or `deleteFrom`
114+has three type parameters, the schemas it refers to, input parameters
115+and an output row. When
116+we insert into the users table, we will need a parameter for the @name@
117+field but not for the @id@ field. Since it's serial, we can use a default
118+value. However, since the emails table refers to the users table, we will
119+need to retrieve the user id that the insert generates and insert it into
120+the emails table. We can do this in a single `Manipulation_` by using a
121+`with` statement.
122+
127123>>> :{
128124let
129125 insertUser :: Manipulation_ Schemas User ()
130126 insertUser = with (u `as` #u) e
131127 where
132128 u = insertInto #users
133− (Values_ (defaultAs #id :* param @1 `as` #name))
129+ (Values_ (Default `as` #id :* Set (param @1) `as` #name))
134130 OnConflictDoRaise (Returning_ (#id :* param @2 `as` #email))
135− e = insertInto_ #emails
136− (Select (defaultAs #id :* #u ! #id `as` #user_id :* #u ! #email) (from (common #u)))
131+ e = insertInto_ #emails $ Select
132+ (Default `as` #id :* Set (#u ! #id) `as` #user_id :* Set (#u ! #email) `as` #email)
133+ (from (common #u))
137134:}
138135
139136>>> printSQL insertUser
140137WITH "u" AS (INSERT INTO "users" ("id", "name") VALUES (DEFAULT, ($1 :: text)) RETURNING "id" AS "id", ($2 :: text) AS "email") INSERT INTO "emails" ("user_id", "email") SELECT "u"."id", "u"."email" FROM "u" AS "u"
141138
142−Next we write a `Query` to retrieve users from the database. We're not
139+Next we write a `Query_` to retrieve users from the database. We're not
143140interested in the ids here, just the usernames and email addresses. We
144−need to use an inner join to get the right result. A `Query` is like a
145−`Manipulation` with the same kind of type parameters.
141+need to use an `innerJoin` to get the right result. A `Query_` is like a
142+`Manipulation_` with the same kind of type parameters.
146143
147144>>> :{
148145let
@@ -186,57 +183,51 @@ let
186183 usersRows <- getRows usersResult
187184 liftIO $ print (usersRows :: [User])
188185in
189− void . withConnection "host=localhost port=5432 dbname=exampledb" $
186+ withConnection "host=localhost port=5432 dbname=exampledb" $
190187 define setup
191188 & pqThen session
192189 & pqThen (define teardown)
193190:}
194191[User {userName = "Alice", userEmail = Just "alice@gmail.com"},User {userName = "Bob", userEmail = Nothing},User {userName = "Carole", userEmail = Just "carole@hotmail.com"}]
195192-}
196−module Squeal.PostgreSQL
197− ( module Squeal.PostgreSQL.Alias
198− , module Squeal.PostgreSQL.Binary
199− , module Squeal.PostgreSQL.Definition
200− , module Squeal.PostgreSQL.Expression
201− , module Squeal.PostgreSQL.Expression.Aggregate
202− , module Squeal.PostgreSQL.Expression.Collection
203− , module Squeal.PostgreSQL.Expression.Comparison
204− , module Squeal.PostgreSQL.Expression.Json
205− , module Squeal.PostgreSQL.Expression.Logic
206− , module Squeal.PostgreSQL.Expression.Math
207− , module Squeal.PostgreSQL.Expression.Null
208− , module Squeal.PostgreSQL.Expression.Text
209− , module Squeal.PostgreSQL.Expression.TextSearch
210− , module Squeal.PostgreSQL.Expression.Time
211− , module Squeal.PostgreSQL.Expression.Window
212− , module Squeal.PostgreSQL.List
213− , module Squeal.PostgreSQL.Manipulation
214− , module Squeal.PostgreSQL.PG
215− , module Squeal.PostgreSQL.PQ
216− , module Squeal.PostgreSQL.Query
217− , module Squeal.PostgreSQL.Schema
218− , module Squeal.PostgreSQL.Transaction
219− ) where
220−
221−import Squeal.PostgreSQL.Alias
222−import Squeal.PostgreSQL.Binary
223−import Squeal.PostgreSQL.Definition
224−import Squeal.PostgreSQL.Expression
225−import Squeal.PostgreSQL.Expression.Aggregate
226−import Squeal.PostgreSQL.Expression.Collection
227−import Squeal.PostgreSQL.Expression.Comparison
228−import Squeal.PostgreSQL.Expression.Json
229−import Squeal.PostgreSQL.Expression.Logic
230−import Squeal.PostgreSQL.Expression.Math
231−import Squeal.PostgreSQL.Expression.Null
232−import Squeal.PostgreSQL.Expression.Text
233−import Squeal.PostgreSQL.Expression.TextSearch
234−import Squeal.PostgreSQL.Expression.Time
235−import Squeal.PostgreSQL.Expression.Window
236−import Squeal.PostgreSQL.List
237−import Squeal.PostgreSQL.Manipulation
238−import Squeal.PostgreSQL.PG
239−import Squeal.PostgreSQL.PQ
240−import Squeal.PostgreSQL.Query
241−import Squeal.PostgreSQL.Schema
242−import Squeal.PostgreSQL.Transaction
193+module Squeal.PostgreSQL (module X, RenderSQL(..), printSQL) where
194+
195+import Squeal.PostgreSQL.Alias as X
196+import Squeal.PostgreSQL.Binary as X
197+import Squeal.PostgreSQL.Definition as X
198+import Squeal.PostgreSQL.Definition.Function as X
199+import Squeal.PostgreSQL.Definition.Index as X
200+import Squeal.PostgreSQL.Definition.Schema as X
201+import Squeal.PostgreSQL.Definition.Table as X
202+import Squeal.PostgreSQL.Definition.Table.Constraint as X
203+import Squeal.PostgreSQL.Definition.Type as X
204+import Squeal.PostgreSQL.Definition.View as X
205+import Squeal.PostgreSQL.Expression as X
206+import Squeal.PostgreSQL.Expression.Aggregate as X
207+import Squeal.PostgreSQL.Expression.Collection as X
208+import Squeal.PostgreSQL.Expression.Comparison as X
209+import Squeal.PostgreSQL.Expression.Json as X
210+import Squeal.PostgreSQL.Expression.Literal as X
211+import Squeal.PostgreSQL.Expression.Logic as X
212+import Squeal.PostgreSQL.Expression.Math as X
213+import Squeal.PostgreSQL.Expression.Null as X
214+import Squeal.PostgreSQL.Expression.Parameter as X
215+import Squeal.PostgreSQL.Expression.Range as X
216+import Squeal.PostgreSQL.Expression.Set as X
217+import Squeal.PostgreSQL.Expression.Sort as X
218+import Squeal.PostgreSQL.Expression.Subquery as X
219+import Squeal.PostgreSQL.Expression.Text as X
220+import Squeal.PostgreSQL.Expression.TextSearch as X
221+import Squeal.PostgreSQL.Expression.Time as X
222+import Squeal.PostgreSQL.Expression.Type as X
223+import Squeal.PostgreSQL.Expression.Window as X
224+import Squeal.PostgreSQL.List as X
225+import Squeal.PostgreSQL.Manipulation as X
226+import Squeal.PostgreSQL.Migration as X
227+import Squeal.PostgreSQL.PG as X
228+import Squeal.PostgreSQL.Pool as X
229+import Squeal.PostgreSQL.PQ as X
230+import Squeal.PostgreSQL.Query as X
231+import Squeal.PostgreSQL.Render (RenderSQL(..), printSQL)
232+import Squeal.PostgreSQL.Schema as X
233+import Squeal.PostgreSQL.Transaction as X
squeal-postgresql/src/Squeal/PostgreSQL/Alias.hs+14−10
@@ -1,3 +1,15 @@
1+{-|
2+Module: Squeal.PostgreSQL.Alias
3+Description: Aliases
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+This module embeds Postgres's alias system in Haskell in
9+a typesafe fashion. Thanks to GHC's @OverloadedLabels@ extension,
10+Squeal can reference aliases by prepending with a @#@.
11+-}
12+
113{-# LANGUAGE
214 AllowAmbiguousTypes
315 , ConstraintKinds
@@ -34,7 +46,6 @@ module Squeal.PostgreSQL.Alias
3446 , HasIn
3547 , QualifiedAlias (..)
3648 , IsQualified (..)
37− , DefaultAliasable (..)
3849 -- * Grouping
3950 , Grouping (..)
4051 , GroupedBy
@@ -177,14 +188,6 @@ choose which subfields to update.
177188class HasIn fields field where
178189instance (Has alias fields field) => HasIn fields (alias ::: field) where
179190
180−{- |
181−The `DefaultAliasable` class is intended to help with Scrap your Nils
182−for default inserts and updates.
183−-}
184−class KnownSymbol alias
185− => DefaultAliasable alias aliased | aliased -> alias where
186− defaultAs :: Alias alias -> aliased
187−
188191-- | `HasAll` extends `Has` to take lists of @aliases@ and @fields@ and infer
189192-- a list of @subfields@.
190193class
@@ -208,7 +211,8 @@ class IsQualified table column expression where
208211instance IsQualified table column (Alias table, Alias column) where (!) = (,)
209212
210213{-| `QualifiedAlias`es enables multi-schema support by allowing a reference
211−to a `Table`, `Typedef` or `View` to be qualified by their schemas. By default,
214+to a `Squeal.PostgreSQL.Schema.Table`, `Squeal.PostgreSQL.Schema.Typedef`
215+or `Squeal.PostgreSQL.Schema.View` to be qualified by their schemas. By default,
212216a qualifier of @public@ is provided.
213217
214218>>> :{
squeal-postgresql/src/Squeal/PostgreSQL/Binary.hs+213−71
@@ -39,7 +39,7 @@ the input and output should be equal.
3939
4040>>> let input = Row 2 "hi" (Just True)
4141>>> :{
42−void . withConnection "host=localhost port=5432 dbname=exampledb" $ do
42+withConnection "host=localhost port=5432 dbname=exampledb" $ do
4343 result <- runQueryParams roundTrip input
4444 Just output <- firstRow result
4545 liftIO . print $ input == output
@@ -78,7 +78,7 @@ let
7878>>> :set -XOverloadedLists
7979>>> let input = Row (VarArray [1,2]) (FixArray (Just 1,Nothing)) (FixArray ((1,2),(3,4),(5,6)))
8080>>> :{
81−void . withConnection "host=localhost port=5432 dbname=exampledb" $ do
81+withConnection "host=localhost port=5432 dbname=exampledb" $ do
8282 result <- runQueryParams roundTrip input
8383 Just output <- firstRow result
8484 liftIO . print $ input == output
@@ -170,7 +170,7 @@ let
170170 Just output <- firstRow result
171171 liftIO . print $ input == output
172172in
173− void . withConnection "host=localhost port=5432 dbname=exampledb" $
173+ withConnection "host=localhost port=5432 dbname=exampledb" $
174174 define setup
175175 & pqThen session
176176 & pqThen (define teardown)
@@ -205,14 +205,20 @@ module Squeal.PostgreSQL.Binary
205205 ( -- * Encoding
206206 ToParam (..)
207207 , ToParams (..)
208− , ToNullityParam
209− , ToField
210− , ToFixArray
208+ , ToNullityParam (..)
209+ , ToField (..)
210+ , ToFixArray (..)
211211 -- * Decoding
212212 , FromValue (..)
213213 , FromRow (..)
214+ , FromField (..)
215+ , FromFixArray (..)
214216 -- * Only
215217 , Only (..)
218+ -- * Oid
219+ , OidOf (..)
220+ , OidOfParam (..)
221+ , OidOfField (..)
216222 ) where
217223
218224import BinaryParser
@@ -226,6 +232,7 @@ import Data.Time
226232import Data.UUID.Types
227233import Data.Vector (Vector)
228234import Data.Word
235+import Foreign.C.Types (CUInt(CUInt))
229236import Generics.SOP
230237import Generics.SOP.Record
231238import GHC.TypeLits
@@ -239,6 +246,7 @@ import qualified Data.Text.Lazy as Lazy (Text)
239246import qualified Data.Text as Strict (Text)
240247import qualified Data.Text as Strict.Text
241248import qualified Data.Vector as Vector
249+import qualified Database.PostgreSQL.LibPQ as LibPQ
242250import qualified GHC.Generics as GHC
243251import qualified PostgreSQL.Binary.Decoding as Decoding
244252import qualified PostgreSQL.Binary.Encoding as Encoding
@@ -269,11 +277,9 @@ class ToParam (x :: Type) (pg :: PGType) where
269277 toParam :: x -> K Encoding.Encoding pg
270278instance ToParam Bool 'PGbool where toParam = K . Encoding.bool
271279instance ToParam Int16 'PGint2 where toParam = K . Encoding.int2_int16
272−instance ToParam Word16 'PGint2 where toParam = K . Encoding.int2_word16
273280instance ToParam Int32 'PGint4 where toParam = K . Encoding.int4_int32
274−instance ToParam Word32 'PGint4 where toParam = K . Encoding.int4_word32
275281instance ToParam Int64 'PGint8 where toParam = K . Encoding.int8_int64
276−instance ToParam Word64 'PGint8 where toParam = K . Encoding.int8_word64
282+instance ToParam Oid 'PGoid where toParam = K . Encoding.int4_word32 . getOid
277283instance ToParam Float 'PGfloat4 where toParam = K . Encoding.float4
278284instance ToParam Double 'PGfloat8 where toParam = K . Encoding.float8
279285instance ToParam Scientific 'PGnumeric where toParam = K . Encoding.numeric
@@ -306,24 +312,26 @@ instance Aeson.ToJSON x => ToParam (Json x) 'PGjson where
306312instance Aeson.ToJSON x => ToParam (Jsonb x) 'PGjsonb where
307313 toParam = K . Encoding.jsonb_bytes
308314 . Lazy.ByteString.toStrict . Aeson.encode . getJsonb
309−instance (ToNullityParam x ty, ty ~ nullity pg, HasOid pg)
315+instance (ToNullityParam x ty, ty ~ nullity pg, OidOf pg)
310316 => ToParam (VarArray [x]) ('PGvararray ty) where
311317 toParam = K
312− . Encoding.array_foldable (oid @pg) (unK . toNullityParam @x @ty)
318+ . Encoding.array_foldable
319+ (getOid (oidOf @pg)) (unK . toNullityParam @x @ty)
313320 . getVarArray
314−instance (ToParam x pg, HasOid pg)
321+instance (ToParam x pg, OidOf pg)
315322 => ToParam (VarArray (Vector x)) ('PGvararray ('NotNull pg)) where
316323 toParam = K
317− . Encoding.array_vector (oid @pg) (unK . toParam @x @pg)
324+ . Encoding.array_vector (getOid (oidOf @pg)) (unK . toParam @x @pg)
318325 . getVarArray
319−instance (ToParam x pg, HasOid pg)
326+instance (ToParam x pg, OidOf pg)
320327 => ToParam (VarArray (Vector (Maybe x))) ('PGvararray ('Null pg)) where
321328 toParam = K
322− . Encoding.nullableArray_vector (oid @pg) (unK . toParam @x @pg)
329+ . Encoding.nullableArray_vector
330+ (getOid (oidOf @pg)) (unK . toParam @x @pg)
323331 . getVarArray
324−instance (ToFixArray x dims ty, ty ~ nullity pg, HasOid pg)
332+instance (ToFixArray x dims ty, ty ~ nullity pg, OidOf pg)
325333 => ToParam (FixArray x) ('PGfixarray dims ty) where
326− toParam = K . Encoding.array (oid @pg)
334+ toParam = K . Encoding.array (getOid (oidOf @pg))
327335 . unK . unK . toFixArray @x @dims @ty . getFixArray
328336instance
329337 ( IsEnumType x
@@ -348,7 +356,7 @@ instance
348356 ( SListI fields
349357 , IsRecord x xs
350358 , AllZip ToField xs fields
351− , All HasAliasedOid fields
359+ , All OidOfField fields
352360 ) => ToParam (Composite x) ('PGcomposite fields) where
353361 toParam =
354362 let
@@ -356,7 +364,7 @@ instance
356364 encoders = htrans (Proxy @ToField) toField
357365
358366 composite
359− :: All HasAliasedOid row
367+ :: All OidOfField row
360368 => NP (K (Maybe Encoding.Encoding)) row
361369 -> K Encoding.Encoding ('PGcomposite row)
362370 composite fields = K $
@@ -373,27 +381,142 @@ instance
373381 int32BE (fromIntegral (lengthSList (Proxy @xs))) <>
374382 let
375383 each
376− :: HasAliasedOid field
384+ :: OidOfField field
377385 => K (Maybe Encoding.Encoding) field
378386 -> Encoding.Encoding
379387 each (K field :: K (Maybe Encoding.Encoding) field) =
380− word32BE (aliasedOid @field)
388+ word32BE (getOid (oidOfField @field))
381389 <> case field of
382390 Nothing -> int64BE (-1)
383391 Just value ->
384392 int32BE (fromIntegral (builderLength value))
385393 <> value
386394 in
387− hcfoldMap (Proxy @HasAliasedOid) each fields
395+ hcfoldMap (Proxy @OidOfField) each fields
388396
389397 in
390398 composite . encoders . toRecord . getComposite
391399
392−class HasAliasedOid (field :: (Symbol, NullityType)) where
393− aliasedOid :: Word32
394−instance HasOid ty => HasAliasedOid (alias ::: nullity ty) where
395− aliasedOid = oid @ty
396−
400+-- | The object identifier of a `PGType`.
401+--
402+-- >>> :set -XTypeApplications
403+-- >>> oidOf @'PGbool
404+-- Oid 16
405+class OidOf (ty :: PGType) where oidOf :: LibPQ.Oid
406+instance OidOf 'PGbool where oidOf = LibPQ.Oid 16
407+instance OidOf ('PGfixarray ns (null 'PGbool)) where oidOf = LibPQ.Oid 1000
408+instance OidOf ('PGvararray (null 'PGbool)) where oidOf = LibPQ.Oid 1000
409+instance OidOf 'PGint2 where oidOf = LibPQ.Oid 21
410+instance OidOf ('PGfixarray ns (null 'PGint2)) where oidOf = LibPQ.Oid 1005
411+instance OidOf ('PGvararray (null 'PGint2)) where oidOf = LibPQ.Oid 1005
412+instance OidOf 'PGint4 where oidOf = LibPQ.Oid 23
413+instance OidOf ('PGfixarray ns (null 'PGint4)) where oidOf = LibPQ.Oid 1007
414+instance OidOf ('PGvararray (null 'PGint4)) where oidOf = LibPQ.Oid 1007
415+instance OidOf 'PGint8 where oidOf = LibPQ.Oid 20
416+instance OidOf ('PGfixarray ns (null 'PGint8)) where oidOf = LibPQ.Oid 1016
417+instance OidOf ('PGvararray (null 'PGint8)) where oidOf = LibPQ.Oid 1016
418+instance OidOf 'PGnumeric where oidOf = LibPQ.Oid 1700
419+instance OidOf ('PGfixarray ns (null 'PGnumeric)) where oidOf = LibPQ.Oid 1231
420+instance OidOf ('PGvararray (null 'PGnumeric)) where oidOf = LibPQ.Oid 1231
421+instance OidOf 'PGfloat4 where oidOf = LibPQ.Oid 700
422+instance OidOf ('PGfixarray ns (null 'PGfloat4)) where oidOf = LibPQ.Oid 1021
423+instance OidOf ('PGvararray (null 'PGfloat4)) where oidOf = LibPQ.Oid 1021
424+instance OidOf 'PGfloat8 where oidOf = LibPQ.Oid 701
425+instance OidOf ('PGfixarray ns (null 'PGfloat8)) where oidOf = LibPQ.Oid 1022
426+instance OidOf ('PGvararray (null 'PGfloat8)) where oidOf = LibPQ.Oid 1022
427+instance OidOf 'PGmoney where oidOf = LibPQ.Oid 790
428+instance OidOf ('PGfixarray ns (null 'PGmoney)) where oidOf = LibPQ.Oid 791
429+instance OidOf ('PGvararray (null 'PGmoney)) where oidOf = LibPQ.Oid 791
430+instance OidOf ('PGchar n) where oidOf = LibPQ.Oid 18
431+instance OidOf ('PGfixarray ns (null ('PGchar n))) where oidOf = LibPQ.Oid 1002
432+instance OidOf ('PGvararray (null ('PGchar n))) where oidOf = LibPQ.Oid 1002
433+instance OidOf ('PGvarchar n) where oidOf = LibPQ.Oid 1043
434+instance OidOf ('PGfixarray ns (null ('PGvarchar n))) where oidOf = LibPQ.Oid 1015
435+instance OidOf ('PGvararray (null ('PGvarchar n))) where oidOf = LibPQ.Oid 1015
436+instance OidOf 'PGtext where oidOf = LibPQ.Oid 25
437+instance OidOf ('PGfixarray ns (null 'PGtext)) where oidOf = LibPQ.Oid 1009
438+instance OidOf ('PGvararray (null 'PGtext)) where oidOf = LibPQ.Oid 1009
439+instance OidOf 'PGbytea where oidOf = LibPQ.Oid 17
440+instance OidOf ('PGfixarray ns (null 'PGbytea)) where oidOf = LibPQ.Oid 1001
441+instance OidOf ('PGvararray (null 'PGbytea)) where oidOf = LibPQ.Oid 1001
442+instance OidOf 'PGtimestamp where oidOf = LibPQ.Oid 1114
443+instance OidOf ('PGfixarray ns (null 'PGtimestamp)) where oidOf = LibPQ.Oid 1115
444+instance OidOf ('PGvararray (null 'PGtimestamp)) where oidOf = LibPQ.Oid 1115
445+instance OidOf 'PGtimestamptz where oidOf = LibPQ.Oid 1184
446+instance OidOf ('PGfixarray ns (null 'PGtimestamptz)) where oidOf = LibPQ.Oid 1185
447+instance OidOf ('PGvararray (null 'PGtimestamptz)) where oidOf = LibPQ.Oid 1185
448+instance OidOf 'PGdate where oidOf = LibPQ.Oid 1082
449+instance OidOf ('PGfixarray ns (null 'PGdate)) where oidOf = LibPQ.Oid 1182
450+instance OidOf ('PGvararray (null 'PGdate)) where oidOf = LibPQ.Oid 1182
451+instance OidOf 'PGtime where oidOf = LibPQ.Oid 1083
452+instance OidOf ('PGfixarray ns (null 'PGtime)) where oidOf = LibPQ.Oid 1183
453+instance OidOf ('PGvararray (null 'PGtime)) where oidOf = LibPQ.Oid 1183
454+instance OidOf 'PGtimetz where oidOf = LibPQ.Oid 1266
455+instance OidOf ('PGfixarray ns (null 'PGtimetz)) where oidOf = LibPQ.Oid 1270
456+instance OidOf ('PGvararray (null 'PGtimetz)) where oidOf = LibPQ.Oid 1270
457+instance OidOf 'PGinterval where oidOf = LibPQ.Oid 1186
458+instance OidOf ('PGfixarray ns (null 'PGinterval)) where oidOf = LibPQ.Oid 1187
459+instance OidOf ('PGvararray (null 'PGinterval)) where oidOf = LibPQ.Oid 1187
460+instance OidOf 'PGuuid where oidOf = LibPQ.Oid 2950
461+instance OidOf ('PGfixarray ns (null 'PGuuid)) where oidOf = LibPQ.Oid 2951
462+instance OidOf ('PGvararray (null 'PGuuid)) where oidOf = LibPQ.Oid 2951
463+instance OidOf 'PGinet where oidOf = LibPQ.Oid 869
464+instance OidOf ('PGfixarray ns (null 'PGinet)) where oidOf = LibPQ.Oid 1041
465+instance OidOf ('PGvararray (null 'PGinet)) where oidOf = LibPQ.Oid 1041
466+instance OidOf 'PGjson where oidOf = LibPQ.Oid 114
467+instance OidOf ('PGfixarray ns (null 'PGjson)) where oidOf = LibPQ.Oid 199
468+instance OidOf ('PGvararray (null 'PGjson)) where oidOf = LibPQ.Oid 199
469+instance OidOf 'PGjsonb where oidOf = LibPQ.Oid 3802
470+instance OidOf ('PGfixarray ns (null 'PGjsonb)) where oidOf = LibPQ.Oid 3807
471+instance OidOf ('PGvararray (null 'PGjsonb)) where oidOf = LibPQ.Oid 3807
472+instance OidOf 'PGtsvector where oidOf = LibPQ.Oid 3614
473+instance OidOf ('PGfixarray ns (null 'PGtsvector)) where oidOf = LibPQ.Oid 3643
474+instance OidOf ('PGvararray (null 'PGtsvector)) where oidOf = LibPQ.Oid 3643
475+instance OidOf 'PGtsquery where oidOf = LibPQ.Oid 3615
476+instance OidOf ('PGfixarray ns (null 'PGtsquery)) where oidOf = LibPQ.Oid 3645
477+instance OidOf ('PGvararray (null 'PGtsquery)) where oidOf = LibPQ.Oid 3645
478+instance OidOf 'PGoid where oidOf = LibPQ.Oid 26
479+instance OidOf ('PGfixarray ns (null 'PGoid)) where oidOf = LibPQ.Oid 1028
480+instance OidOf ('PGvararray (null 'PGoid)) where oidOf = LibPQ.Oid 1028
481+instance OidOf ('PGrange 'PGint4) where oidOf = LibPQ.Oid 3904
482+instance OidOf ('PGfixarray ns (null ('PGrange 'PGint4))) where oidOf = LibPQ.Oid 3905
483+instance OidOf ('PGvararray (null ('PGrange 'PGint4))) where oidOf = LibPQ.Oid 3905
484+instance OidOf ('PGrange 'PGint8) where oidOf = LibPQ.Oid 3926
485+instance OidOf ('PGfixarray ns (null ('PGrange 'PGint8))) where oidOf = LibPQ.Oid 3927
486+instance OidOf ('PGvararray (null ('PGrange 'PGint8))) where oidOf = LibPQ.Oid 3927
487+instance OidOf ('PGrange 'PGnumeric) where oidOf = LibPQ.Oid 3906
488+instance OidOf ('PGfixarray ns (null ('PGrange 'PGnumeric))) where oidOf = LibPQ.Oid 3907
489+instance OidOf ('PGvararray (null ('PGrange 'PGnumeric))) where oidOf = LibPQ.Oid 3907
490+instance OidOf ('PGrange 'PGtimestamp) where oidOf = LibPQ.Oid 3908
491+instance OidOf ('PGfixarray ns (null ('PGrange 'PGtimestamp))) where oidOf = LibPQ.Oid 3909
492+instance OidOf ('PGvararray (null ('PGrange 'PGtimestamp))) where oidOf = LibPQ.Oid 3909
493+instance OidOf ('PGrange 'PGtimestamptz) where oidOf = LibPQ.Oid 3910
494+instance OidOf ('PGfixarray ns (null ('PGrange 'PGtimestamptz))) where oidOf = LibPQ.Oid 3911
495+instance OidOf ('PGvararray (null ('PGrange 'PGtimestamptz))) where oidOf = LibPQ.Oid 3911
496+instance OidOf ('PGrange 'PGdate) where oidOf = LibPQ.Oid 3912
497+instance OidOf ('PGfixarray ns (null ('PGrange 'PGdate))) where oidOf = LibPQ.Oid 3913
498+instance OidOf ('PGvararray (null ('PGrange 'PGdate))) where oidOf = LibPQ.Oid 3913
499+instance {-# OVERLAPPABLE #-} OidOf ('PGrange ty) where oidOf = LibPQ.invalidOid
500+instance {-# OVERLAPPABLE #-} OidOf ('PGfixarray ns (null ('PGrange ty))) where oidOf = LibPQ.invalidOid
501+instance {-# OVERLAPPABLE #-} OidOf ('PGvararray (null ('PGrange ty))) where oidOf = LibPQ.invalidOid
502+instance {-# OVERLAPPABLE #-} OidOf ('PGcomposite row) where oidOf = LibPQ.invalidOid
503+instance {-# OVERLAPPABLE #-} OidOf ('PGfixarray ns (null ('PGcomposite row))) where oidOf = LibPQ.invalidOid
504+instance {-# OVERLAPPABLE #-} OidOf ('PGvararray (null ('PGcomposite row))) where oidOf = LibPQ.invalidOid
505+instance {-# OVERLAPPABLE #-} OidOf ('PGenum labels) where oidOf = LibPQ.invalidOid
506+instance {-# OVERLAPPABLE #-} OidOf ('PGfixarray ns (null ('PGenum labels))) where oidOf = LibPQ.invalidOid
507+instance {-# OVERLAPPABLE #-} OidOf ('PGvararray (null ('PGenum labels))) where oidOf = LibPQ.invalidOid
508+
509+class OidOfParam (ty :: NullityType) where oidOfParam :: Oid
510+instance OidOf ty => OidOfParam (null ty) where oidOfParam = oidOf @ty
511+
512+-- | Lifts a `OidOf` constraint to a field.
513+class OidOfField (field :: (Symbol, NullityType)) where
514+ oidOfField :: Oid
515+instance OidOf ty => OidOfField (alias ::: nullity ty) where
516+ oidOfField = oidOf @ty
517+
518+-- | A `ToNullityParam` constraint gives an encoding of a Haskell `Type` into
519+-- into the binary format of a PostgreSQL `NullityType`.
397520class ToNullityParam (x :: Type) (ty :: NullityType) where
398521 toNullityParam :: x -> K (Maybe Encoding.Encoding) ty
399522instance ToParam x pg => ToNullityParam x ('NotNull pg) where
@@ -401,11 +524,19 @@ instance ToParam x pg => ToNullityParam x ('NotNull pg) where
401524instance ToParam x pg => ToNullityParam (Maybe x) ('Null pg) where
402525 toNullityParam = K . fmap (unK . toParam @x @pg)
403526
527+-- | A `ToField` constraint lifts the `ToParam` parser
528+-- to an encoding of a @(Symbol, Type)@ to a @(Symbol, NullityType)@,
529+-- encoding `Null`s to `Maybe`s. You should not define instances for
530+-- `FromField`, just use the provided instances.
404531class ToField (x :: (Symbol, Type)) (field :: (Symbol, NullityType)) where
405532 toField :: P x -> K (Maybe Encoding.Encoding) field
406533instance ToNullityParam x ty => ToField (alias ::: x) (alias ::: ty) where
407534 toField (P x) = K . unK $ toNullityParam @x @ty x
408535
536+-- | A `ToFixArray` constraint gives an encoding of a Haskell `Type`
537+-- into the binary format of a PostgreSQL fixed-length array.
538+-- You should not define instances for
539+-- `ToFixArray`, just use the provided instances.
409540class ToFixArray (x :: Type) (dims :: [Nat]) (array :: NullityType) where
410541 toFixArray :: x -> K (K Encoding.Array dims) array
411542instance ToNullityParam x ty => ToFixArray x '[] ty where
@@ -451,6 +582,7 @@ instance FromValue 'PGbool Bool where fromValue = Decoding.bool
451582instance FromValue 'PGint2 Int16 where fromValue = Decoding.int
452583instance FromValue 'PGint4 Int32 where fromValue = Decoding.int
453584instance FromValue 'PGint8 Int64 where fromValue = Decoding.int
585+instance FromValue 'PGoid Word32 where fromValue = Decoding.int
454586instance FromValue 'PGfloat4 Float where fromValue = Decoding.float4
455587instance FromValue 'PGfloat8 Double where fromValue = Decoding.float8
456588instance FromValue 'PGnumeric Scientific where fromValue = Decoding.numeric
@@ -589,6 +721,10 @@ instance FromValue pg y
589721 K (Just bytestring) -> P . Just <$>
590722 Decoding.valueParser (fromValue @pg) bytestring
591723
724+-- | A `FromFixArray` constraint gives a decoding to a Haskell `Type`
725+-- from the binary format of a PostgreSQL fixed-length array.
726+-- You should not define instances for
727+-- `FromFixArray`, just use the provided instances.
592728class FromFixArray (dims :: [Nat]) (ty :: NullityType) (y :: Type) where
593729 fromFixArray :: Decoding.Array y
594730instance FromValue pg y => FromFixArray '[] ('NotNull pg) y where
@@ -633,50 +769,53 @@ instance
633769 = fmap fromRecord
634770 . hsequence'
635771 . htrans (Proxy @FromField) fromField
636−instance (FromField (col ::: pg) (col ::: hask))
637− => FromRow '[col ::: pg] (P (col ::: hask)) where
638− fromRow (pg :* Nil) = (unComp . fromField) pg
639−instance
640− ( row ~ Join row1 row2
641− , FromRow row1 hask1
642− , FromRow row2 hask2
643− , SListI row
644− ) => FromRow row (hask1, hask2) where
645− fromRow row = case disjoin @row1 @row2 row of
646− (row1, row2) -> (,) <$> fromRow row1 <*> fromRow row2
647−instance
648− ( row ~ Join row1 row23
649− , FromRow row1 hask1
650− , FromRow row23 (hask2, hask3)
651− , SListI row
652− ) => FromRow row (hask1, hask2, hask3) where
653− fromRow row = case disjoin @row1 @row23 row of
654− (row1, row23) -> do
655− hask1 <- fromRow row1
656− (hask2, hask3) <- fromRow row23
657− return (hask1, hask2, hask3)
658−instance
659− ( row ~ Join row1 row234
660− , FromRow row1 hask1
661− , FromRow row234 (hask2, hask3, hask4)
662− , SListI row
663− ) => FromRow row (hask1, hask2, hask3, hask4) where
664− fromRow row = case disjoin @row1 @row234 row of
665− (row1, row234) -> do
666− hask1 <- fromRow row1
667− (hask2, hask3, hask4) <- fromRow row234
668− return (hask1, hask2, hask3, hask4)
669−instance
670− ( row ~ Join row1 row2345
671− , FromRow row1 hask1
672− , FromRow row2345 (hask2, hask3, hask4, hask5)
673− , SListI row
674− ) => FromRow row (hask1, hask2, hask3, hask4, hask5) where
675− fromRow row = case disjoin @row1 @row2345 row of
676− (row1, row2345) -> do
677− hask1 <- fromRow row1
678− (hask2, hask3, hask4, hask5) <- fromRow row2345
679− return (hask1, hask2, hask3, hask4, hask5)
772+------------------------------------------------------
773+-- P records
774+------------------------------------------------------
775+-- instance (FromField (col ::: pg) (col ::: hask))
776+-- => FromRow '[col ::: pg] (P (col ::: hask)) where
777+-- fromRow (pg :* Nil) = (unComp . fromField) pg
778+-- instance
779+-- ( row ~ Join row1 row2
780+-- , FromRow row1 hask1
781+-- , FromRow row2 hask2
782+-- , SListI row
783+-- ) => FromRow row (hask1, hask2) where
784+-- fromRow row = case disjoin @row1 @row2 row of
785+-- (row1, row2) -> (,) <$> fromRow row1 <*> fromRow row2
786+-- instance
787+-- ( row ~ Join row1 row23
788+-- , FromRow row1 hask1
789+-- , FromRow row23 (hask2, hask3)
790+-- , SListI row
791+-- ) => FromRow row (hask1, hask2, hask3) where
792+-- fromRow row = case disjoin @row1 @row23 row of
793+-- (row1, row23) -> do
794+-- hask1 <- fromRow row1
795+-- (hask2, hask3) <- fromRow row23
796+-- return (hask1, hask2, hask3)
797+-- instance
798+-- ( row ~ Join row1 row234
799+-- , FromRow row1 hask1
800+-- , FromRow row234 (hask2, hask3, hask4)
801+-- , SListI row
802+-- ) => FromRow row (hask1, hask2, hask3, hask4) where
803+-- fromRow row = case disjoin @row1 @row234 row of
804+-- (row1, row234) -> do
805+-- hask1 <- fromRow row1
806+-- (hask2, hask3, hask4) <- fromRow row234
807+-- return (hask1, hask2, hask3, hask4)
808+-- instance
809+-- ( row ~ Join row1 row2345
810+-- , FromRow row1 hask1
811+-- , FromRow row2345 (hask2, hask3, hask4, hask5)
812+-- , SListI row
813+-- ) => FromRow row (hask1, hask2, hask3, hask4, hask5) where
814+-- fromRow row = case disjoin @row1 @row2345 row of
815+-- (row1, row2345) -> do
816+-- hask1 <- fromRow row1
817+-- (hask2, hask3, hask4, hask5) <- fromRow row2345
818+-- return (hask1, hask2, hask3, hask4, hask5)
680819
681820-- | `Only` is a 1-tuple type, useful for encoding a single parameter with
682821-- `toParams` or decoding a single value with `fromRow`.
@@ -704,3 +843,6 @@ replicateMN
704843 => m x -> m (NP I xs)
705844replicateMN mx = hsequence' $
706845 hcpure (Proxy :: Proxy ((~) x)) (Comp (I <$> mx))
846+
847+getOid :: LibPQ.Oid -> Word32
848+getOid (LibPQ.Oid (CUInt oid)) = oid
squeal-postgresql/src/Squeal/PostgreSQL/Definition.hs+12−1015
@@ -11,13 +11,15 @@ Squeal data definition language.
1111{-# LANGUAGE
1212 AllowAmbiguousTypes
1313 , ConstraintKinds
14+ , DeriveAnyClass
1415 , DeriveGeneric
16+ , DerivingStrategies
1517 , FlexibleContexts
1618 , FlexibleInstances
1719 , GADTs
18− , GeneralizedNewtypeDeriving
1920 , LambdaCase
2021 , MultiParamTypeClasses
22+ , OverloadedLabels
2123 , OverloadedStrings
2224 , RankNTypes
2325 , ScopedTypeVariables
@@ -25,82 +27,25 @@ Squeal data definition language.
2527 , TypeInType
2628 , TypeOperators
2729 , UndecidableSuperClasses
30+ , UndecidableInstances
2831#-}
2932
3033module Squeal.PostgreSQL.Definition
3134 ( -- * Definition
3235 Definition (..)
3336 , (>>>)
34− -- * Tables
35− -- ** Create
36− , createSchema
37− , createSchemaIfNotExists
38− , createTable
39− , createTableIfNotExists
40− , createView
41− , createTypeEnum
42− , createTypeEnumFrom
43− , createTypeComposite
44− , createTypeCompositeFrom
45− , createDomain
46− , TableConstraintExpression (..)
47− , check
48− , unique
49− , primaryKey
50− , foreignKey
51− , ForeignKeyed
52− , OnDeleteClause (..)
53− , OnUpdateClause (..)
54− -- ** Drop
55− , dropSchema
56− , dropTable
57− , dropView
58− , dropType
59− -- ** Alter
60− , alterTable
61− , alterTableRename
62− , AlterTable (..)
63− , addConstraint
64− , dropConstraint
65− , AddColumn (..)
66− , dropColumn
67− , renameColumn
68− , alterColumn
69− , AlterColumn (..)
70− , setDefault
71− , dropDefault
72− , setNotNull
73− , dropNotNull
74− , alterType
75− -- * Columns
76− , ColumnTypeExpression (..)
77− , nullable
78− , notNullable
79− , default_
80− , serial2
81− , smallserial
82− , serial4
83− , serial
84− , serial8
85− , bigserial
37+ , manipDefinition
8638 ) where
8739
8840import Control.Category
8941import Control.DeepSeq
9042import Data.ByteString
9143import Data.Monoid
92−import GHC.TypeLits
9344import Prelude hiding ((.), id)
9445
95−import qualified Generics.SOP as SOP
9646import qualified GHC.Generics as GHC
9747
98−import Squeal.PostgreSQL.Alias
99−import Squeal.PostgreSQL.Expression
100−import Squeal.PostgreSQL.Expression.Logic
101−import Squeal.PostgreSQL.List
102−import Squeal.PostgreSQL.PG
103−import Squeal.PostgreSQL.Query
48+import Squeal.PostgreSQL.Manipulation
10449import Squeal.PostgreSQL.Render
10550import Squeal.PostgreSQL.Schema
10651
@@ -128,958 +73,10 @@ instance Category Definition where
12873 ddl1 . ddl0 = UnsafeDefinition $
12974 renderSQL ddl0 <> "\n" <> renderSQL ddl1
13075
131−{-----------------------------------------
132−CREATE statements
133−-----------------------------------------}
134−
135−createSchema
136− :: KnownSymbol sch
137− => Alias sch
138− -> Definition schemas (Create sch '[] schemas)
139−createSchema sch = UnsafeDefinition $
140− "CREATE" <+> "SCHEMA" <+> renderSQL sch <> ";"
141−
142−createSchemaIfNotExists
143− :: (KnownSymbol sch, Has sch schemas schema)
144− => Alias sch
76+-- | A `Manipulation` without input or output can be run as a statement
77+-- along with other `Definition`s, by embedding it using `manipDefinition`.
78+manipDefinition
79+ :: Manipulation '[] schemas '[] '[]
80+ -- ^ no input or output
14581 -> Definition schemas schemas
146−createSchemaIfNotExists sch = UnsafeDefinition $
147− "CREATE" <+> "SCHEMA" <+> "IF" <+> "NOT" <+> "EXISTS"
148− <+> renderSQL sch <> ";"
149−
150−{- | `createTable` adds a table to the schema.
151−
152−>>> :set -XOverloadedLabels
153−>>> :{
154−type Table = '[] :=>
155− '[ "a" ::: 'NoDef :=> 'Null 'PGint4
156− , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]
157−:}
158−
159−>>> :{
160−let
161− setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table])
162− setup = createTable #tab
163− (nullable int `as` #a :* nullable real `as` #b) Nil
164−in printSQL setup
165−:}
166−CREATE TABLE "tab" ("a" int NULL, "b" real NULL);
167−-}
168−createTable
169− :: ( KnownSymbol sch
170− , KnownSymbol tab
171− , columns ~ (col ': cols)
172− , SOP.SListI columns
173− , SOP.SListI constraints
174− , Has sch schemas0 schema0
175− , schemas1 ~ Alter sch (Create tab ('Table (constraints :=> columns)) schema0) schemas0 )
176− => QualifiedAlias sch tab -- ^ the name of the table to add
177− -> NP (Aliased (ColumnTypeExpression schemas0)) columns
178− -- ^ the names and datatype of each column
179− -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints
180− -- ^ constraints that must hold for the table
181− -> Definition schemas0 schemas1
182−createTable tab columns constraints = UnsafeDefinition $
183− "CREATE TABLE" <+> renderCreation tab columns constraints
184−
185−{-| `createTableIfNotExists` creates a table if it doesn't exist, but does not add it to the schema.
186−Instead, the schema already has the table so if the table did not yet exist, the schema was wrong.
187−`createTableIfNotExists` fixes this. Interestingly, this property makes it an idempotent in
188−the `Category` of `Definition`s.
189−
190−>>> :set -XOverloadedLabels -XTypeApplications
191−>>> :{
192−type Table = '[] :=>
193− '[ "a" ::: 'NoDef :=> 'Null 'PGint4
194− , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]
195−:}
196−
197−>>> type Schemas = Public '["tab" ::: 'Table Table]
198−
199−>>> :{
200−let
201− setup :: Definition Schemas Schemas
202− setup = createTableIfNotExists #tab
203− (nullable int `as` #a :* nullable real `as` #b) Nil
204−in printSQL setup
205−:}
206−CREATE TABLE IF NOT EXISTS "tab" ("a" int NULL, "b" real NULL);
207−-}
208−createTableIfNotExists
209− :: ( Has sch schemas schema
210− , Has tab schema ('Table (constraints :=> columns))
211− , SOP.SListI columns
212− , SOP.SListI constraints )
213− => QualifiedAlias sch tab -- ^ the name of the table to add
214− -> NP (Aliased (ColumnTypeExpression schemas)) columns
215− -- ^ the names and datatype of each column
216− -> NP (Aliased (TableConstraintExpression sch tab schemas)) constraints
217− -- ^ constraints that must hold for the table
218− -> Definition schemas schemas
219−createTableIfNotExists tab columns constraints = UnsafeDefinition $
220− "CREATE TABLE IF NOT EXISTS"
221− <+> renderCreation tab columns constraints
222−
223−-- helper function for `createTable` and `createTableIfNotExists`
224−renderCreation
225− :: ( KnownSymbol sch
226− , KnownSymbol tab
227− , SOP.SListI columns
228− , SOP.SListI constraints )
229− => QualifiedAlias sch tab -- ^ the name of the table to add
230− -> NP (Aliased (ColumnTypeExpression schemas0)) columns
231− -- ^ the names and datatype of each column
232− -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints
233− -- ^ constraints that must hold for the table
234− -> ByteString
235−renderCreation tab columns constraints = renderSQL tab
236− <+> parenthesized
237− ( renderCommaSeparated renderColumnDef columns
238− <> ( case constraints of
239− Nil -> ""
240− _ -> ", " <>
241− renderCommaSeparated renderConstraint constraints ) )
242− <> ";"
243− where
244− renderColumnDef :: Aliased (ColumnTypeExpression schemas) x -> ByteString
245− renderColumnDef (ty `As` column) =
246− renderSQL column <+> renderColumnTypeExpression ty
247− renderConstraint
248− :: Aliased (TableConstraintExpression sch tab schemas) constraint
249− -> ByteString
250− renderConstraint (constraint `As` alias) =
251− "CONSTRAINT" <+> renderSQL alias <+> renderSQL constraint
252−
253−-- | Data types are a way to limit the kind of data that can be stored in a
254−-- table. For many applications, however, the constraint they provide is
255−-- too coarse. For example, a column containing a product price should
256−-- probably only accept positive values. But there is no standard data type
257−-- that accepts only positive numbers. Another issue is that you might want
258−-- to constrain column data with respect to other columns or rows.
259−-- For example, in a table containing product information,
260−-- there should be only one row for each product number.
261−-- `TableConstraint`s give you as much control over the data in your tables
262−-- as you wish. If a user attempts to store data in a column that would
263−-- violate a constraint, an error is raised. This applies
264−-- even if the value came from the default value definition.
265−newtype TableConstraintExpression
266− (sch :: Symbol)
267− (tab :: Symbol)
268− (schemas :: SchemasType)
269− (constraint :: TableConstraint)
270− = UnsafeTableConstraintExpression
271− { renderTableConstraintExpression :: ByteString }
272− deriving (GHC.Generic,Show,Eq,Ord,NFData)
273−instance RenderSQL
274− (TableConstraintExpression sch tab schemas constraint) where
275− renderSQL = renderTableConstraintExpression
276−
277−{-| A `check` constraint is the most generic `TableConstraint` type.
278−It allows you to specify that the value in a certain column must satisfy
279−a Boolean (truth-value) expression.
280−
281−>>> :{
282−type Schema = '[
283− "tab" ::: 'Table ('[ "inequality" ::: 'Check '["a","b"]] :=> '[
284− "a" ::: 'NoDef :=> 'NotNull 'PGint4,
285− "b" ::: 'NoDef :=> 'NotNull 'PGint4
286− ])]
287−:}
288−
289−>>> :{
290−let
291− definition :: Definition (Public '[]) (Public Schema)
292− definition = createTable #tab
293− ( (int & notNullable) `as` #a :*
294− (int & notNullable) `as` #b )
295− ( check (#a :* #b) (#a .> #b) `as` #inequality )
296−:}
297−
298−>>> printSQL definition
299−CREATE TABLE "tab" ("a" int NOT NULL, "b" int NOT NULL, CONSTRAINT "inequality" CHECK (("a" > "b")));
300−-}
301−check
302− :: ( Has sch schemas schema
303− , Has tab schema ('Table table)
304− , HasAll aliases (TableToRow table) subcolumns )
305− => NP Alias aliases
306− -- ^ specify the subcolumns which are getting checked
307− -> (forall t. Condition '[] '[] 'Ungrouped schemas '[] '[t ::: subcolumns])
308− -- ^ a closed `Condition` on those subcolumns
309− -> TableConstraintExpression sch tab schemas ('Check aliases)
310−check _cols condition = UnsafeTableConstraintExpression $
311− "CHECK" <+> parenthesized (renderSQL condition)
312−
313−{-| A `unique` constraint ensure that the data contained in a column,
314−or a group of columns, is unique among all the rows in the table.
315−
316−>>> :{
317−type Schema = '[
318− "tab" ::: 'Table( '[ "uq_a_b" ::: 'Unique '["a","b"]] :=> '[
319− "a" ::: 'NoDef :=> 'Null 'PGint4,
320− "b" ::: 'NoDef :=> 'Null 'PGint4
321− ])]
322−:}
323−
324−>>> :{
325−let
326− definition :: Definition (Public '[]) (Public Schema)
327− definition = createTable #tab
328− ( (int & nullable) `as` #a :*
329− (int & nullable) `as` #b )
330− ( unique (#a :* #b) `as` #uq_a_b )
331−:}
332−
333−>>> printSQL definition
334−CREATE TABLE "tab" ("a" int NULL, "b" int NULL, CONSTRAINT "uq_a_b" UNIQUE ("a", "b"));
335−-}
336−unique
337− :: ( Has sch schemas schema
338− , Has tab schema('Table table)
339− , HasAll aliases (TableToRow table) subcolumns )
340− => NP Alias aliases
341− -- ^ specify subcolumns which together are unique for each row
342− -> TableConstraintExpression sch tab schemas ('Unique aliases)
343−unique columns = UnsafeTableConstraintExpression $
344− "UNIQUE" <+> parenthesized (renderSQL columns)
345−
346−{-| A `primaryKey` constraint indicates that a column, or group of columns,
347−can be used as a unique identifier for rows in the table.
348−This requires that the values be both unique and not null.
349−
350−>>> :{
351−type Schema = '[
352− "tab" ::: 'Table ('[ "pk_id" ::: 'PrimaryKey '["id"]] :=> '[
353− "id" ::: 'Def :=> 'NotNull 'PGint4,
354− "name" ::: 'NoDef :=> 'NotNull 'PGtext
355− ])]
356−:}
357−
358−>>> :{
359−let
360− definition :: Definition (Public '[]) (Public Schema)
361− definition = createTable #tab
362− ( serial `as` #id :*
363− (text & notNullable) `as` #name )
364− ( primaryKey #id `as` #pk_id )
365−:}
366−
367−>>> printSQL definition
368−CREATE TABLE "tab" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_id" PRIMARY KEY ("id"));
369−-}
370−primaryKey
371− :: ( Has sch schemas schema
372− , Has tab schema ('Table table)
373− , HasAll aliases (TableToColumns table) subcolumns
374− , AllNotNull subcolumns )
375− => NP Alias aliases
376− -- ^ specify the subcolumns which together form a primary key.
377− -> TableConstraintExpression sch tab schemas ('PrimaryKey aliases)
378−primaryKey columns = UnsafeTableConstraintExpression $
379− "PRIMARY KEY" <+> parenthesized (renderSQL columns)
380−
381−{-| A `foreignKey` specifies that the values in a column
382−(or a group of columns) must match the values appearing in some row of
383−another table. We say this maintains the referential integrity
384−between two related tables.
385−
386−>>> :{
387−type Schema =
388− '[ "users" ::: 'Table (
389− '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>
390− '[ "id" ::: 'Def :=> 'NotNull 'PGint4
391− , "name" ::: 'NoDef :=> 'NotNull 'PGtext
392− ])
393− , "emails" ::: 'Table (
394− '[ "pk_emails" ::: 'PrimaryKey '["id"]
395− , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]
396− ] :=>
397− '[ "id" ::: 'Def :=> 'NotNull 'PGint4
398− , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4
399− , "email" ::: 'NoDef :=> 'Null 'PGtext
400− ])
401− ]
402−:}
403−
404−>>> :{
405−let
406− setup :: Definition (Public '[]) (Public Schema)
407− setup =
408− createTable #users
409− ( serial `as` #id :*
410− (text & notNullable) `as` #name )
411− ( primaryKey #id `as` #pk_users ) >>>
412− createTable #emails
413− ( serial `as` #id :*
414− (int & notNullable) `as` #user_id :*
415− (text & nullable) `as` #email )
416− ( primaryKey #id `as` #pk_emails :*
417− foreignKey #user_id #users #id
418− OnDeleteCascade OnUpdateCascade `as` #fk_user_id )
419−in printSQL setup
420−:}
421−CREATE TABLE "users" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_users" PRIMARY KEY ("id"));
422−CREATE TABLE "emails" ("id" serial, "user_id" int NOT NULL, "email" text NULL, CONSTRAINT "pk_emails" PRIMARY KEY ("id"), CONSTRAINT "fk_user_id" FOREIGN KEY ("user_id") REFERENCES "users" ("id") ON DELETE CASCADE ON UPDATE CASCADE);
423−
424−A `foreignKey` can even be a table self-reference.
425−
426−>>> :{
427−type Schema =
428− '[ "employees" ::: 'Table (
429− '[ "employees_pk" ::: 'PrimaryKey '["id"]
430− , "employees_employer_fk" ::: 'ForeignKey '["employer_id"] "employees" '["id"]
431− ] :=>
432− '[ "id" ::: 'Def :=> 'NotNull 'PGint4
433− , "name" ::: 'NoDef :=> 'NotNull 'PGtext
434− , "employer_id" ::: 'NoDef :=> 'Null 'PGint4
435− ])
436− ]
437−:}
438−
439−>>> :{
440−let
441− setup :: Definition (Public '[]) (Public Schema)
442− setup =
443− createTable #employees
444− ( serial `as` #id :*
445− (text & notNullable) `as` #name :*
446− (integer & nullable) `as` #employer_id )
447− ( primaryKey #id `as` #employees_pk :*
448− foreignKey #employer_id #employees #id
449− OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )
450−in printSQL setup
451−:}
452−CREATE TABLE "employees" ("id" serial, "name" text NOT NULL, "employer_id" integer NULL, CONSTRAINT "employees_pk" PRIMARY KEY ("id"), CONSTRAINT "employees_employer_fk" FOREIGN KEY ("employer_id") REFERENCES "employees" ("id") ON DELETE CASCADE ON UPDATE CASCADE);
453−-}
454−foreignKey
455− :: (ForeignKeyed schemas sch schema child parent
456− table reftable
457− columns refcolumns
458− constraints cols
459− reftys tys )
460− => NP Alias columns
461− -- ^ column or columns in the table
462− -> Alias parent
463− -- ^ reference table
464− -> NP Alias refcolumns
465− -- ^ reference column or columns in the reference table
466− -> OnDeleteClause
467− -- ^ what to do when reference is deleted
468− -> OnUpdateClause
469− -- ^ what to do when reference is updated
470− -> TableConstraintExpression sch child schemas
471− ('ForeignKey columns parent refcolumns)
472−foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $
473− "FOREIGN KEY" <+> parenthesized (renderSQL keys)
474− <+> "REFERENCES" <+> renderSQL parent
475− <+> parenthesized (renderSQL refs)
476− <+> renderSQL ondel
477− <+> renderSQL onupd
478−
479−-- | A constraint synonym between types involved in a foreign key constraint.
480−type ForeignKeyed schemas
481− sch
482− schema
483− child parent
484− table reftable
485− columns refcolumns
486− constraints cols
487− reftys tys =
488− ( Has sch schemas schema
489− , Has child schema ('Table table)
490− , Has parent schema ('Table reftable)
491− , HasAll columns (TableToColumns table) tys
492− , reftable ~ (constraints :=> cols)
493− , HasAll refcolumns cols reftys
494− , SOP.AllZip SamePGType tys reftys
495− , Uniquely refcolumns constraints )
496−
497−-- | `OnDeleteClause` indicates what to do with rows that reference a deleted row.
498−data OnDeleteClause
499− = OnDeleteNoAction
500− -- ^ if any referencing rows still exist when the constraint is checked,
501− -- an error is raised
502− | OnDeleteRestrict -- ^ prevents deletion of a referenced row
503− | OnDeleteCascade
504− -- ^ specifies that when a referenced row is deleted,
505− -- row(s) referencing it should be automatically deleted as well
506− deriving (GHC.Generic,Show,Eq,Ord)
507−instance NFData OnDeleteClause
508−-- | Render `OnDeleteClause`.
509−instance RenderSQL OnDeleteClause where
510− renderSQL = \case
511− OnDeleteNoAction -> "ON DELETE NO ACTION"
512− OnDeleteRestrict -> "ON DELETE RESTRICT"
513− OnDeleteCascade -> "ON DELETE CASCADE"
514−
515−-- | Analagous to `OnDeleteClause` there is also `OnUpdateClause` which is invoked
516−-- when a referenced column is changed (updated).
517−data OnUpdateClause
518− = OnUpdateNoAction
519− -- ^ if any referencing rows has not changed when the constraint is checked,
520− -- an error is raised
521− | OnUpdateRestrict -- ^ prevents update of a referenced row
522− | OnUpdateCascade
523− -- ^ the updated values of the referenced column(s) should be copied
524− -- into the referencing row(s)
525− deriving (GHC.Generic,Show,Eq,Ord)
526−instance NFData OnUpdateClause
527−
528−-- | Render `OnUpdateClause`.
529−instance RenderSQL OnUpdateClause where
530− renderSQL = \case
531− OnUpdateNoAction -> "ON UPDATE NO ACTION"
532− OnUpdateRestrict -> "ON UPDATE RESTRICT"
533− OnUpdateCascade -> "ON UPDATE CASCADE"
534−
535−{-----------------------------------------
536−DROP statements
537−-----------------------------------------}
538−
539−-- >>> :{
540−-- let
541−-- definition :: Definition '["muh_schema" ::: schema, "public" ::: public] '["public" ::: public]
542−-- definition = dropSchema #muh_schema
543−-- :}
544−--
545−-- >>> printSQL definition
546−-- DROP SCHEMA "muh_schema";
547−dropSchema
548− :: Has sch schemas schema
549− => Alias sch
550− -> Definition schemas (Drop sch schemas)
551−dropSchema sch = UnsafeDefinition $ "DROP SCHEMA" <+> renderSQL sch <> ";"
552−
553−-- | `dropTable` removes a table from the schema.
554−--
555−-- >>> :{
556−-- let
557−-- definition :: Definition '["public" ::: '["muh_table" ::: 'Table t]] (Public '[])
558−-- definition = dropTable #muh_table
559−-- :}
560−--
561−-- >>> printSQL definition
562−-- DROP TABLE "muh_table";
563−dropTable
564− :: ( Has sch schemas schema
565− , Has tab schema ('Table table))
566− => QualifiedAlias sch tab -- ^ table to remove
567− -> Definition schemas (Alter sch (Drop tab schema) schemas)
568−dropTable tab = UnsafeDefinition $ "DROP TABLE" <+> renderSQL tab <> ";"
569−
570−{-----------------------------------------
571−ALTER statements
572−-----------------------------------------}
573−
574−-- | `alterTable` changes the definition of a table from the schema.
575−alterTable
576− :: (Has sch schemas schema, Has tab schema ('Table table0))
577− => QualifiedAlias sch tab -- ^ table to alter
578− -> AlterTable sch tab schemas table1 -- ^ alteration to perform
579− -> Definition schemas (Alter sch (Alter tab ('Table table1) schema) schemas)
580−alterTable tab alteration = UnsafeDefinition $
581− "ALTER TABLE"
582− <+> renderSQL tab
583− <+> renderAlterTable alteration
584− <> ";"
585−
586−-- | `alterTableRename` changes the name of a table from the schema.
587−--
588−-- >>> printSQL $ alterTableRename #foo #bar
589−-- ALTER TABLE "foo" RENAME TO "bar";
590−alterTableRename
591− :: (KnownSymbol table0, KnownSymbol table1)
592− => Alias table0 -- ^ table to rename
593− -> Alias table1 -- ^ what to rename it
594− -> Definition schema (Rename table0 table1 schema)
595−alterTableRename table0 table1 = UnsafeDefinition $
596− "ALTER TABLE" <+> renderSQL table0
597− <+> "RENAME TO" <+> renderSQL table1 <> ";"
598−
599−-- | An `AlterTable` describes the alteration to perform on the columns
600−-- of a table.
601−newtype AlterTable
602− (sch :: Symbol)
603− (tab :: Symbol)
604− (schemas :: SchemasType)
605− (table :: TableType) =
606− UnsafeAlterTable {renderAlterTable :: ByteString}
607− deriving (GHC.Generic,Show,Eq,Ord,NFData)
608−
609−-- | An `addConstraint` adds a table constraint.
610−--
611−-- >>> :{
612−-- let
613−-- definition :: Definition
614−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
615−-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: 'Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
616−-- definition = alterTable #tab (addConstraint #positive (check #col (#col .> 0)))
617−-- in printSQL definition
618−-- :}
619−-- ALTER TABLE "tab" ADD CONSTRAINT "positive" CHECK (("col" > 0));
620−addConstraint
621− :: ( KnownSymbol alias
622− , Has sch schemas schema
623− , Has tab schema ('Table table0)
624− , table0 ~ (constraints :=> columns)
625− , table1 ~ (Create alias constraint constraints :=> columns) )
626− => Alias alias
627− -> TableConstraintExpression sch tab schemas constraint
628− -- ^ constraint to add
629− -> AlterTable sch tab schemas table1
630−addConstraint alias constraint = UnsafeAlterTable $
631− "ADD" <+> "CONSTRAINT" <+> renderSQL alias
632− <+> renderSQL constraint
633−
634−-- | A `dropConstraint` drops a table constraint.
635−--
636−-- >>> :{
637−-- let
638−-- definition :: Definition
639−-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
640−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
641−-- definition = alterTable #tab (dropConstraint #positive)
642−-- in printSQL definition
643−-- :}
644−-- ALTER TABLE "tab" DROP CONSTRAINT "positive";
645−dropConstraint
646− :: ( KnownSymbol constraint
647− , Has sch schemas schema
648− , Has tab schema ('Table table0)
649− , table0 ~ (constraints :=> columns)
650− , table1 ~ (Drop constraint constraints :=> columns) )
651− => Alias constraint
652− -- ^ constraint to drop
653− -> AlterTable sch tab schemas table1
654−dropConstraint constraint = UnsafeAlterTable $
655− "DROP" <+> "CONSTRAINT" <+> renderSQL constraint
656−
657−-- | An `AddColumn` is either @NULL@ or has @DEFAULT@.
658−class AddColumn ty where
659− -- | `addColumn` adds a new column, initially filled with whatever
660− -- default value is given or with @NULL@.
661− --
662− -- >>> :{
663− -- let
664− -- definition :: Definition
665− -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]
666− -- '["public" ::: '["tab" ::: 'Table ('[] :=>
667− -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4
668− -- , "col2" ::: 'Def :=> 'Null 'PGtext ])]]
669− -- definition = alterTable #tab (addColumn #col2 (text & nullable & default_ "foo"))
670− -- in printSQL definition
671− -- :}
672− -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL DEFAULT E'foo';
673− --
674− -- >>> :{
675− -- let
676− -- definition :: Definition
677− -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]
678− -- '["public" ::: '["tab" ::: 'Table ('[] :=>
679− -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4
680− -- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]
681− -- definition = alterTable #tab (addColumn #col2 (text & nullable))
682− -- in printSQL definition
683− -- :}
684− -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL;
685− addColumn
686− :: ( KnownSymbol column
687− , Has sch schemas schema
688− , Has tab schema ('Table table0)
689− , table0 ~ (constraints :=> columns) )
690− => Alias column -- ^ column to add
691− -> ColumnTypeExpression schemas ty -- ^ type of the new column
692− -> AlterTable sch tab schemas (constraints :=> Create column ty columns)
693− addColumn column ty = UnsafeAlterTable $
694− "ADD COLUMN" <+> renderSQL column <+> renderColumnTypeExpression ty
695−instance {-# OVERLAPPING #-} AddColumn ('Def :=> ty)
696−instance {-# OVERLAPPABLE #-} AddColumn ('NoDef :=> 'Null ty)
697−
698−-- | A `dropColumn` removes a column. Whatever data was in the column
699−-- disappears. Table constraints involving the column are dropped, too.
700−-- However, if the column is referenced by a foreign key constraint of
701−-- another table, PostgreSQL will not silently drop that constraint.
702−--
703−-- >>> :{
704−-- let
705−-- definition :: Definition
706−-- '["public" ::: '["tab" ::: 'Table ('[] :=>
707−-- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4
708−-- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]
709−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]
710−-- definition = alterTable #tab (dropColumn #col2)
711−-- in printSQL definition
712−-- :}
713−-- ALTER TABLE "tab" DROP COLUMN "col2";
714−dropColumn
715− :: ( KnownSymbol column
716− , Has sch schemas schema
717− , Has tab schema ('Table table0)
718− , table0 ~ (constraints :=> columns)
719− , table1 ~ (constraints :=> Drop column columns) )
720− => Alias column -- ^ column to remove
721− -> AlterTable sch tab schemas table1
722−dropColumn column = UnsafeAlterTable $
723− "DROP COLUMN" <+> renderSQL column
724−
725−-- | A `renameColumn` renames a column.
726−--
727−-- >>> :{
728−-- let
729−-- definition :: Definition
730−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["foo" ::: 'NoDef :=> 'Null 'PGint4])]]
731−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["bar" ::: 'NoDef :=> 'Null 'PGint4])]]
732−-- definition = alterTable #tab (renameColumn #foo #bar)
733−-- in printSQL definition
734−-- :}
735−-- ALTER TABLE "tab" RENAME COLUMN "foo" TO "bar";
736−renameColumn
737− :: ( KnownSymbol column0
738− , KnownSymbol column1
739− , Has sch schemas schema
740− , Has tab schema ('Table table0)
741− , table0 ~ (constraints :=> columns)
742− , table1 ~ (constraints :=> Rename column0 column1 columns) )
743− => Alias column0 -- ^ column to rename
744− -> Alias column1 -- ^ what to rename the column
745− -> AlterTable sch tab schemas table1
746−renameColumn column0 column1 = UnsafeAlterTable $
747− "RENAME COLUMN" <+> renderSQL column0 <+> "TO" <+> renderSQL column1
748−
749−-- | An `alterColumn` alters a single column.
750−alterColumn
751− :: ( KnownSymbol column
752− , Has sch schemas schema
753− , Has tab schema ('Table table0)
754− , table0 ~ (constraints :=> columns)
755− , Has column columns ty0
756− , table1 ~ (constraints :=> Alter column ty1 columns))
757− => Alias column -- ^ column to alter
758− -> AlterColumn schemas ty0 ty1 -- ^ alteration to perform
759− -> AlterTable sch tab schemas table1
760−alterColumn column alteration = UnsafeAlterTable $
761− "ALTER COLUMN" <+> renderSQL column <+> renderAlterColumn alteration
762−
763−-- | An `AlterColumn` describes the alteration to perform on a single column.
764−newtype AlterColumn (schemas :: SchemasType) (ty0 :: ColumnType) (ty1 :: ColumnType) =
765− UnsafeAlterColumn {renderAlterColumn :: ByteString}
766− deriving (GHC.Generic,Show,Eq,Ord,NFData)
767−
768−-- | A `setDefault` sets a new default for a column. Note that this doesn't
769−-- affect any existing rows in the table, it just changes the default for
770−-- future insert and update commands.
771−--
772−-- >>> :{
773−-- let
774−-- definition :: Definition
775−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]
776−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]
777−-- definition = alterTable #tab (alterColumn #col (setDefault 5))
778−-- in printSQL definition
779−-- :}
780−-- ALTER TABLE "tab" ALTER COLUMN "col" SET DEFAULT 5;
781−setDefault
782− :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty -- ^ default value to set
783− -> AlterColumn schemas (constraint :=> ty) ('Def :=> ty)
784−setDefault expression = UnsafeAlterColumn $
785− "SET DEFAULT" <+> renderExpression expression
786−
787−-- | A `dropDefault` removes any default value for a column.
788−--
789−-- >>> :{
790−-- let
791−-- definition :: Definition
792−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]
793−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]
794−-- definition = alterTable #tab (alterColumn #col dropDefault)
795−-- in printSQL definition
796−-- :}
797−-- ALTER TABLE "tab" ALTER COLUMN "col" DROP DEFAULT;
798−dropDefault :: AlterColumn schemas ('Def :=> ty) ('NoDef :=> ty)
799−dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"
800−
801−-- | A `setNotNull` adds a @NOT NULL@ constraint to a column.
802−-- The constraint will be checked immediately, so the table data must satisfy
803−-- the constraint before it can be added.
804−--
805−-- >>> :{
806−-- let
807−-- definition :: Definition
808−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]
809−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
810−-- definition = alterTable #tab (alterColumn #col setNotNull)
811−-- in printSQL definition
812−-- :}
813−-- ALTER TABLE "tab" ALTER COLUMN "col" SET NOT NULL;
814−setNotNull
815− :: AlterColumn schemas (constraint :=> 'Null ty) (constraint :=> 'NotNull ty)
816−setNotNull = UnsafeAlterColumn $ "SET NOT NULL"
817−
818−-- | A `dropNotNull` drops a @NOT NULL@ constraint from a column.
819−--
820−-- >>> :{
821−-- let
822−-- definition :: Definition
823−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
824−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]
825−-- definition = alterTable #tab (alterColumn #col dropNotNull)
826−-- in printSQL definition
827−-- :}
828−-- ALTER TABLE "tab" ALTER COLUMN "col" DROP NOT NULL;
829−dropNotNull
830− :: AlterColumn schemas (constraint :=> 'NotNull ty) (constraint :=> 'Null ty)
831−dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"
832−
833−-- | An `alterType` converts a column to a different data type.
834−-- This will succeed only if each existing entry in the column can be
835−-- converted to the new type by an implicit cast.
836−--
837−-- >>> :{
838−-- let
839−-- definition :: Definition
840−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
841−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGnumeric])]]
842−-- definition =
843−-- alterTable #tab (alterColumn #col (alterType (numeric & notNullable)))
844−-- in printSQL definition
845−-- :}
846−-- ALTER TABLE "tab" ALTER COLUMN "col" TYPE numeric NOT NULL;
847−alterType :: ColumnTypeExpression schemas ty -> AlterColumn schemas ty0 ty
848−alterType ty = UnsafeAlterColumn $ "TYPE" <+> renderColumnTypeExpression ty
849−
850−{- | Create a view.
851−>>> type ABC = '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4]
852−>>> type BC = '["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4]
853−>>> :{
854−let
855− definition :: Definition
856− '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC)]]
857− '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC), "bc" ::: 'View BC]]
858− definition =
859− createView #bc (select_ (#b :* #c) (from (table #abc)))
860−in printSQL definition
861−:}
862−CREATE VIEW "bc" AS SELECT "b" AS "b", "c" AS "c" FROM "abc" AS "abc";
863−-}
864−createView
865− :: (KnownSymbol sch, KnownSymbol vw, Has sch schemas schema)
866− => QualifiedAlias sch vw -- ^ the name of the view to add
867− -> Query '[] '[] schemas '[] view -- ^ query
868− -> Definition schemas (Alter sch (Create vw ('View view) schema) schemas)
869−createView alias query = UnsafeDefinition $
870− "CREATE" <+> "VIEW" <+> renderSQL alias <+> "AS"
871− <+> renderQuery query <> ";"
872−
873−-- | Drop a view.
874−--
875−-- >>> :{
876−-- let
877−-- definition :: Definition
878−-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])
879−-- , "bc" ::: 'View ('["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4])]]
880−-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])]]
881−-- definition = dropView #bc
882−-- in printSQL definition
883−-- :}
884−-- DROP VIEW "bc";
885−dropView
886− :: (Has sch schemas schema, Has vw schema ('View view))
887− => QualifiedAlias sch vw -- ^ view to remove
888− -> Definition schemas (Alter sch (Drop vw schema) schemas)
889−dropView vw = UnsafeDefinition $ "DROP VIEW" <+> renderSQL vw <> ";"
890−
891−-- | Enumerated types are created using the `createTypeEnum` command, for example
892−--
893−-- >>> printSQL $ (createTypeEnum #mood (label @"sad" :* label @"ok" :* label @"happy") :: Definition (Public '[]) '["public" ::: '["mood" ::: 'Typedef ('PGenum '["sad","ok","happy"])]])
894−-- CREATE TYPE "mood" AS ENUM ('sad', 'ok', 'happy');
895−createTypeEnum
896− :: (KnownSymbol enum, Has sch schemas schema, SOP.All KnownSymbol labels)
897− => QualifiedAlias sch enum
898− -- ^ name of the user defined enumerated type
899− -> NP PGlabel labels
900− -- ^ labels of the enumerated type
901− -> Definition schemas (Alter sch (Create enum ('Typedef ('PGenum labels)) schema) schemas)
902−createTypeEnum enum labels = UnsafeDefinition $
903− "CREATE" <+> "TYPE" <+> renderSQL enum <+> "AS" <+> "ENUM" <+>
904− parenthesized (renderSQL labels) <> ";"
905−
906−-- | Enumerated types can also be generated from a Haskell type, for example
907−--
908−-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic
909−-- >>> instance SOP.Generic Schwarma
910−-- >>> instance SOP.HasDatatypeInfo Schwarma
911−-- >>> :{
912−-- let
913−-- createSchwarma :: Definition (Public '[]) '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]]
914−-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma
915−-- in
916−-- printSQL createSchwarma
917−-- :}
918−-- CREATE TYPE "schwarma" AS ENUM ('Beef', 'Lamb', 'Chicken');
919−createTypeEnumFrom
920− :: forall hask sch enum schemas schema.
921− ( SOP.Generic hask
922− , SOP.All KnownSymbol (LabelsPG hask)
923− , KnownSymbol enum
924− , Has sch schemas schema )
925− => QualifiedAlias sch enum
926− -- ^ name of the user defined enumerated type
927− -> Definition schemas (Alter sch (Create enum ('Typedef (PG (Enumerated hask))) schema) schemas)
928−createTypeEnumFrom enum = createTypeEnum enum
929− (SOP.hpure label :: NP PGlabel (LabelsPG hask))
930−
931−{- | `createTypeComposite` creates a composite type. The composite type is
932−specified by a list of attribute names and data types.
933−
934−>>> :{
935−type PGcomplex = 'PGcomposite
936− '[ "real" ::: 'NotNull 'PGfloat8
937− , "imaginary" ::: 'NotNull 'PGfloat8 ]
938−:}
939−
940−>>> :{
941−let
942− setup :: Definition (Public '[]) '["public" ::: '["complex" ::: 'Typedef PGcomplex]]
943− setup = createTypeComposite #complex
944− (float8 `as` #real :* float8 `as` #imaginary)
945−in printSQL setup
946−:}
947−CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);
948−-}
949−createTypeComposite
950− :: (KnownSymbol ty, Has sch schemas schema, SOP.SListI fields)
951− => QualifiedAlias sch ty
952− -- ^ name of the user defined composite type
953− -> NP (Aliased (TypeExpression schemas)) fields
954− -- ^ list of attribute names and data types
955− -> Definition schemas (Alter sch (Create ty ('Typedef ('PGcomposite fields)) schema) schemas)
956−createTypeComposite ty fields = UnsafeDefinition $
957− "CREATE" <+> "TYPE" <+> renderSQL ty <+> "AS" <+> parenthesized
958− (renderCommaSeparated renderField fields) <> ";"
959− where
960− renderField :: Aliased (TypeExpression schemas) x -> ByteString
961− renderField (typ `As` alias) =
962− renderSQL alias <+> renderSQL typ
963−
964−-- | Composite types can also be generated from a Haskell type, for example
965−--
966−-- >>> data Complex = Complex {real :: Double, imaginary :: Double} deriving GHC.Generic
967−-- >>> instance SOP.Generic Complex
968−-- >>> instance SOP.HasDatatypeInfo Complex
969−-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]
970−-- >>> :{
971−-- let
972−-- createComplex :: Definition (Public '[]) (Public Schema)
973−-- createComplex = createTypeCompositeFrom @Complex #complex
974−-- in
975−-- printSQL createComplex
976−-- :}
977−-- CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);
978−createTypeCompositeFrom
979− :: forall hask sch ty schemas schema.
980− ( SOP.All (FieldTyped schemas) (RowPG hask)
981− , KnownSymbol ty
982− , Has sch schemas schema )
983− => QualifiedAlias sch ty
984− -- ^ name of the user defined composite type
985− -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)
986−createTypeCompositeFrom ty = createTypeComposite ty
987− (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype
988− :: NP (Aliased (TypeExpression schemas)) (RowPG hask))
989−
990−{-|
991−`createDomain` creates a new domain. A domain is essentially a data type
992−with constraints (restrictions on the allowed set of values).
993−
994−Domains are useful for abstracting common constraints on fields
995−into a single location for maintenance. For example, several tables might
996−contain email address columns, all requiring the same `check` constraint
997−to verify the address syntax. Define a domain rather than setting up
998−each table's constraint individually.
999−
1000−>>> :{
1001−let
1002− createPositive :: Definition (Public '[]) (Public '["positive" ::: 'Typedef 'PGfloat4])
1003− createPositive = createDomain #positive real (#value .> 0 .&& (#value & isNotNull))
1004−in printSQL createPositive
1005−:}
1006−CREATE DOMAIN "positive" AS real CHECK ((("value" > 0) AND "value" IS NOT NULL));
1007−-}
1008−createDomain
1009− :: (Has sch schemas schema, KnownSymbol dom)
1010− => QualifiedAlias sch dom
1011− -> (forall nullity. TypeExpression schemas (nullity ty))
1012− -> (forall tab. Condition '[] '[] 'Ungrouped schemas '[] '[tab ::: '["value" ::: 'Null ty]])
1013− -> Definition schemas (Alter sch (Create alias ('Typedef ty) schema) schemas)
1014−createDomain dom ty condition =
1015− UnsafeDefinition $ "CREATE DOMAIN" <+> renderSQL dom
1016− <+> "AS" <+> renderTypeExpression ty
1017− <+> "CHECK" <+> parenthesized (renderSQL condition) <> ";"
1018−
1019−class FieldTyped schemas ty where
1020− fieldtype :: Aliased (TypeExpression schemas) ty
1021−instance (KnownSymbol alias, PGTyped schemas ty)
1022− => FieldTyped schemas (alias ::: ty) where
1023− fieldtype = pgtype `As` Alias
1024−
1025−-- | Drop a type.
1026−--
1027−-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic
1028−-- >>> instance SOP.Generic Schwarma
1029−-- >>> instance SOP.HasDatatypeInfo Schwarma
1030−-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))
1031−-- DROP TYPE "schwarma";
1032−dropType
1033− :: (Has sch schemas schema, Has td schema ('Typedef ty))
1034− => QualifiedAlias sch td
1035− -- ^ name of the user defined type
1036− -> Definition schemas (Alter sch (Drop td schema) schemas)
1037−dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"
1038−
1039−-- | `ColumnTypeExpression`s are used in `createTable` commands.
1040−newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)
1041− = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }
1042− deriving (GHC.Generic,Show,Eq,Ord,NFData)
1043−instance RenderSQL (ColumnTypeExpression schemas ty) where
1044− renderSQL = renderColumnTypeExpression
1045−
1046−-- | used in `createTable` commands as a column constraint to note that
1047−-- @NULL@ may be present in a column
1048−nullable
1049− :: TypeExpression schemas (nullity ty)
1050− -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)
1051−nullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NULL"
1052−
1053−-- | used in `createTable` commands as a column constraint to ensure
1054−-- @NULL@ is not present in a column
1055−notNullable
1056− :: TypeExpression schemas (nullity ty)
1057− -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)
1058−notNullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NOT NULL"
1059−
1060−-- | used in `createTable` commands as a column constraint to give a default
1061−default_
1062− :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty
1063− -> ColumnTypeExpression schemas ('NoDef :=> ty)
1064− -> ColumnTypeExpression schemas ('Def :=> ty)
1065−default_ x ty = UnsafeColumnTypeExpression $
1066− renderSQL ty <+> "DEFAULT" <+> renderExpression x
1067−
1068−-- | not a true type, but merely a notational convenience for creating
1069−-- unique identifier columns with type `PGint2`
1070−serial2, smallserial
1071− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)
1072−serial2 = UnsafeColumnTypeExpression "serial2"
1073−smallserial = UnsafeColumnTypeExpression "smallserial"
1074−-- | not a true type, but merely a notational convenience for creating
1075−-- unique identifier columns with type `PGint4`
1076−serial4, serial
1077− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)
1078−serial4 = UnsafeColumnTypeExpression "serial4"
1079−serial = UnsafeColumnTypeExpression "serial"
1080−-- | not a true type, but merely a notational convenience for creating
1081−-- unique identifier columns with type `PGint8`
1082−serial8, bigserial
1083− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)
1084−serial8 = UnsafeColumnTypeExpression "serial8"
1085−bigserial = UnsafeColumnTypeExpression "bigserial"
82+manipDefinition = UnsafeDefinition . (<> ";") . renderSQL
squeal-postgresql/src/Squeal/PostgreSQL/Definition/Function.hsnew file+238
@@ -0,0 +1,238 @@
1+{-|
2+Module: Squeal.PostgreSQL.Definition.Function
3+Description: Create and drop function and operator definitions
4+Copyright: (c) Eitan Chatav, 2017
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Create and drop function and operator definitions.
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , ConstraintKinds
14+ , DeriveAnyClass
15+ , DeriveGeneric
16+ , DerivingStrategies
17+ , FlexibleContexts
18+ , FlexibleInstances
19+ , GADTs
20+ , LambdaCase
21+ , MultiParamTypeClasses
22+ , OverloadedLabels
23+ , OverloadedStrings
24+ , RankNTypes
25+ , ScopedTypeVariables
26+ , TypeApplications
27+ , TypeInType
28+ , TypeOperators
29+ , UndecidableSuperClasses
30+#-}
31+
32+module Squeal.PostgreSQL.Definition.Function
33+ ( createFunction
34+ , createOrReplaceFunction
35+ , createSetFunction
36+ , createOrReplaceSetFunction
37+ , createBinaryOp
38+ , createLeftOp
39+ , createRightOp
40+ , dropFunction
41+ , dropFunctionIfExists
42+ , dropOperator
43+ , dropOperatorIfExists
44+ , FunctionDefinition(..)
45+ , languageSqlExpr
46+ , languageSqlQuery
47+ ) where
48+
49+import Control.DeepSeq
50+import Data.ByteString
51+import GHC.TypeLits
52+
53+import qualified Generics.SOP as SOP
54+import qualified GHC.Generics as GHC
55+
56+import Squeal.PostgreSQL.Alias
57+import Squeal.PostgreSQL.Definition
58+import Squeal.PostgreSQL.Expression
59+import Squeal.PostgreSQL.Expression.Type
60+import Squeal.PostgreSQL.List
61+import Squeal.PostgreSQL.Query
62+import Squeal.PostgreSQL.Render
63+import Squeal.PostgreSQL.Schema
64+
65+-- $setup
66+-- >>> import Squeal.PostgreSQL
67+
68+createFunction
69+ :: ( Has sch schemas schema
70+ , KnownSymbol fun
71+ , SOP.SListI args )
72+ => QualifiedAlias sch fun
73+ -> NP (TypeExpression schemas) args
74+ -> TypeExpression schemas ret
75+ -> FunctionDefinition schemas args ('Returns ret)
76+ -> Definition schemas (Alter sch (Create fun ('Function (args :=> 'Returns ret)) schema) schemas)
77+createFunction fun args ret fundef = UnsafeDefinition $
78+ "CREATE" <+> "FUNCTION" <+> renderSQL fun
79+ <+> parenthesized (renderCommaSeparated renderSQL args)
80+ <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"
81+
82+createOrReplaceFunction
83+ :: ( Has sch schemas schema
84+ , KnownSymbol fun
85+ , SOP.SListI args )
86+ => QualifiedAlias sch fun
87+ -> NP (TypeExpression schemas) args
88+ -> TypeExpression schemas ret
89+ -> FunctionDefinition schemas args ('Returns ret)
90+ -> Definition schemas (Alter sch (CreateOrReplace fun ('Function (args :=> 'Returns ret)) schema) schemas)
91+createOrReplaceFunction fun args ret fundef = UnsafeDefinition $
92+ "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun
93+ <+> parenthesized (renderCommaSeparated renderSQL args)
94+ <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"
95+
96+languageSqlExpr
97+ :: Expression '[] '[] 'Ungrouped schemas args '[] ret
98+ -> FunctionDefinition schemas args ('Returns ret)
99+languageSqlExpr expr = UnsafeFunctionDefinition $
100+ "language sql as"
101+ <+> "$$" <+> renderSQL (values_ (expr `as` #ret)) <+> "$$"
102+
103+languageSqlQuery
104+ :: Query '[] '[] schemas args rets
105+ -> FunctionDefinition schemas args ('ReturnsTable rets)
106+languageSqlQuery qry = UnsafeFunctionDefinition $
107+ "language sql as" <+> "$$" <+> renderSQL qry <+> "$$"
108+
109+createSetFunction
110+ :: ( Has sch schemas schema
111+ , KnownSymbol fun
112+ , SOP.SListI args
113+ , SOP.SListI rets )
114+ => QualifiedAlias sch fun
115+ -> NP (TypeExpression schemas) args
116+ -> NP (Aliased (TypeExpression schemas)) rets
117+ -> FunctionDefinition schemas args ('ReturnsTable rets)
118+ -> Definition schemas (Alter sch (Create fun ('Function (args :=> 'ReturnsTable rets)) schema) schemas)
119+createSetFunction fun args rets fundef = UnsafeDefinition $
120+ "CREATE" <+> "FUNCTION" <+> renderSQL fun
121+ <+> parenthesized (renderCommaSeparated renderSQL args)
122+ <+> "RETURNS" <+> "TABLE"
123+ <+> parenthesized (renderCommaSeparated renderRet rets)
124+ <+> renderSQL fundef <> ";"
125+ where
126+ renderRet :: Aliased (TypeExpression s) r -> ByteString
127+ renderRet (ty `As` col) = renderSQL col <+> renderSQL ty
128+
129+createOrReplaceSetFunction
130+ :: ( Has sch schemas schema
131+ , KnownSymbol fun
132+ , SOP.SListI args
133+ , SOP.SListI rets )
134+ => QualifiedAlias sch fun
135+ -> NP (TypeExpression schemas) args
136+ -> NP (Aliased (TypeExpression schemas)) rets
137+ -> FunctionDefinition schemas args ('ReturnsTable rets)
138+ -> Definition schemas (Alter sch (CreateOrReplace fun ('Function (args :=> 'ReturnsTable rets)) schema) schemas)
139+createOrReplaceSetFunction fun args rets fundef = UnsafeDefinition $
140+ "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun
141+ <+> parenthesized (renderCommaSeparated renderSQL args)
142+ <+> "RETURNS" <+> "TABLE"
143+ <+> parenthesized (renderCommaSeparated renderRet rets)
144+ <+> renderSQL fundef <> ";"
145+ where
146+ renderRet :: Aliased (TypeExpression s) r -> ByteString
147+ renderRet (ty `As` col) = renderSQL col <+> renderSQL ty
148+
149+createBinaryOp
150+ :: forall op fun sch schemas schema x y z.
151+ ( Has sch schemas schema
152+ , Has fun schema ('Function ('[x,y] :=> 'Returns z))
153+ , KnownSymbol op )
154+ => QualifiedAlias sch fun
155+ -> TypeExpression schemas x
156+ -> TypeExpression schemas y
157+ -> Definition schemas
158+ (Alter sch (Create op ('Operator ('BinaryOp x y z)) schema) schemas)
159+createBinaryOp fun x y = UnsafeDefinition $
160+ "CREATE" <+> "OPERATOR" <+> renderSymbol @op
161+ <+> parenthesized (commaSeparated opdef)
162+ where
163+ opdef =
164+ [ "FUNCTION" <+> "=" <+> renderSQL fun
165+ , "LEFTARG" <+> "=" <+> renderSQL x
166+ , "RIGHTARG" <+> "=" <+> renderSQL y ]
167+
168+createLeftOp
169+ :: forall op fun sch schemas schema x y.
170+ ( Has sch schemas schema
171+ , Has fun schema ('Function ('[x] :=> 'Returns y))
172+ , KnownSymbol op )
173+ => QualifiedAlias sch fun
174+ -> TypeExpression schemas x
175+ -> Definition schemas
176+ (Alter sch (Create op ('Operator ('LeftOp x y)) schema) schemas)
177+createLeftOp fun x = UnsafeDefinition $
178+ "CREATE" <+> "OPERATOR" <+> renderSymbol @op
179+ <+> parenthesized (commaSeparated opdef)
180+ where
181+ opdef =
182+ [ "FUNCTION" <+> "=" <+> renderSQL fun
183+ , "RIGHTARG" <+> "=" <+> renderSQL x ]
184+
185+createRightOp
186+ :: forall op fun sch schemas schema x y.
187+ ( Has sch schemas schema
188+ , Has fun schema ('Function ('[x] :=> 'Returns y))
189+ , KnownSymbol op )
190+ => QualifiedAlias sch fun
191+ -> TypeExpression schemas x
192+ -> Definition schemas
193+ (Alter sch (Create op ('Operator ('RightOp x y)) schema) schemas)
194+createRightOp fun x = UnsafeDefinition $
195+ "CREATE" <+> "OPERATOR" <+> renderSymbol @op
196+ <+> parenthesized (commaSeparated opdef)
197+ where
198+ opdef =
199+ [ "FUNCTION" <+> "=" <+> renderSQL fun
200+ , "LEFTARG" <+> "=" <+> renderSQL x ]
201+
202+dropFunction
203+ :: (Has sch schemas schema, KnownSymbol fun)
204+ => QualifiedAlias sch fun
205+ -- ^ name of the user defined function
206+ -> Definition schemas (Alter sch (DropSchemum fun 'Function schema) schemas)
207+dropFunction fun = UnsafeDefinition $
208+ "DROP" <+> "FUNCTION" <+> renderSQL fun <> ";"
209+
210+dropFunctionIfExists
211+ :: (Has sch schemas schema, KnownSymbol fun)
212+ => QualifiedAlias sch fun
213+ -- ^ name of the user defined function
214+ -> Definition schemas (Alter sch (DropSchemumIfExists fun 'Function schema) schemas)
215+dropFunctionIfExists fun = UnsafeDefinition $
216+ "DROP FUNCTION IF EXISTS" <+> renderSQL fun <> ";"
217+
218+dropOperator
219+ :: (Has sch schemas schema, KnownSymbol op)
220+ => QualifiedAlias sch op
221+ -- ^ name of the user defined operator
222+ -> Definition schemas (Alter sch (DropSchemum op 'Operator schema) schemas)
223+dropOperator op = UnsafeDefinition $
224+ "DROP" <+> "OPERATOR" <+> renderSQL op <> ";"
225+
226+dropOperatorIfExists
227+ :: (Has sch schemas schema, KnownSymbol op)
228+ => QualifiedAlias sch op
229+ -- ^ name of the user defined operator
230+ -> Definition schemas (Alter sch (DropSchemumIfExists op 'Operator schema) schemas)
231+dropOperatorIfExists op = UnsafeDefinition $
232+ "DROP OPERATOR IF EXISTS" <+> renderSQL op <> ";"
233+
234+newtype FunctionDefinition schemas args ret = UnsafeFunctionDefinition
235+ { renderFunctionDefinition :: ByteString }
236+ deriving (Eq,Show,GHC.Generic,NFData)
237+instance RenderSQL (FunctionDefinition schemas args ret) where
238+ renderSQL = renderFunctionDefinition
squeal-postgresql/src/Squeal/PostgreSQL/Definition/Index.hsnew file+159
@@ -0,0 +1,159 @@
1+{-|
2+Module: Squeal.PostgreSQL.Definition.Index
3+Description: Create and drop index definitions
4+Copyright: (c) Eitan Chatav, 2017
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Create and drop index definitions.
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , ConstraintKinds
14+ , DeriveAnyClass
15+ , DeriveGeneric
16+ , DerivingStrategies
17+ , FlexibleContexts
18+ , FlexibleInstances
19+ , GADTs
20+ , LambdaCase
21+ , MultiParamTypeClasses
22+ , OverloadedLabels
23+ , OverloadedStrings
24+ , RankNTypes
25+ , ScopedTypeVariables
26+ , TypeApplications
27+ , TypeInType
28+ , TypeOperators
29+ , UndecidableSuperClasses
30+#-}
31+
32+module Squeal.PostgreSQL.Definition.Index
33+ ( createIndex
34+ , createIndexIfNotExists
35+ , dropIndex
36+ , dropIndexIfExists
37+ , IndexMethod (..)
38+ , btree
39+ , hash
40+ , gist
41+ , spgist
42+ , gin
43+ , brin
44+ ) where
45+
46+import Data.ByteString
47+import GHC.TypeLits
48+
49+import qualified GHC.Generics as GHC
50+
51+import Squeal.PostgreSQL.Alias
52+import Squeal.PostgreSQL.Definition
53+import Squeal.PostgreSQL.Expression.Sort
54+import Squeal.PostgreSQL.Render
55+import Squeal.PostgreSQL.Schema
56+
57+-- $setup
58+-- >>> import Squeal.PostgreSQL
59+
60+{- |
61+>>> :{
62+type Table = '[] :=>
63+ '[ "a" ::: 'NoDef :=> 'Null 'PGint4
64+ , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]
65+:}
66+
67+>>> :{
68+let
69+ setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table, "ix" ::: 'Index 'Btree])
70+ setup =
71+ createTable #tab (nullable int `as` #a :* nullable real `as` #b) Nil >>>
72+ createIndex #ix #tab btree [#a & AscNullsFirst, #b & AscNullsLast]
73+in printSQL setup
74+:}
75+CREATE TABLE "tab" ("a" int NULL, "b" real NULL);
76+CREATE INDEX "ix" ON "tab" USING btree (("a") ASC NULLS FIRST, ("b") ASC NULLS LAST);
77+-}
78+createIndex
79+ :: (Has sch schemas schema, Has tab schema ('Table table), KnownSymbol ix)
80+ => Alias ix
81+ -> QualifiedAlias sch tab
82+ -> IndexMethod method
83+ -> [SortExpression '[] '[] 'Ungrouped schemas '[] '[tab ::: TableToRow table]]
84+ -> Definition schemas (Alter sch (Create ix ('Index method) schema) schemas)
85+createIndex ix tab method cols = UnsafeDefinition $
86+ "CREATE" <+> "INDEX" <+> renderSQL ix <+> "ON" <+> renderSQL tab
87+ <+> "USING" <+> renderSQL method
88+ <+> parenthesized (commaSeparated (renderIndex <$> cols))
89+ <> ";"
90+ where
91+ renderIndex = \case
92+ Asc expression -> parenthesized (renderSQL expression) <+> "ASC"
93+ Desc expression -> parenthesized (renderSQL expression) <+> "DESC"
94+ AscNullsFirst expression -> parenthesized (renderSQL expression)
95+ <+> "ASC NULLS FIRST"
96+ DescNullsFirst expression -> parenthesized (renderSQL expression)
97+ <+> "DESC NULLS FIRST"
98+ AscNullsLast expression -> parenthesized (renderSQL expression)
99+ <+> "ASC NULLS LAST"
100+ DescNullsLast expression -> parenthesized (renderSQL expression)
101+ <+> "DESC NULLS LAST"
102+
103+createIndexIfNotExists
104+ :: (Has sch schemas schema, Has tab schema ('Table table), KnownSymbol ix)
105+ => Alias ix
106+ -> QualifiedAlias sch tab
107+ -> IndexMethod method
108+ -> [SortExpression '[] '[] 'Ungrouped schemas '[] '[tab ::: TableToRow table]]
109+ -> Definition schemas (Alter sch (CreateIfNotExists ix ('Index method) schema) schemas)
110+createIndexIfNotExists ix tab method cols = UnsafeDefinition $
111+ "CREATE INDEX IF NOT EXISTS" <+> renderSQL ix <+> "ON" <+> renderSQL tab
112+ <+> "USING" <+> renderSQL method
113+ <+> parenthesized (commaSeparated (renderIndex <$> cols))
114+ <> ";"
115+ where
116+ renderIndex = \case
117+ Asc expression -> parenthesized (renderSQL expression) <+> "ASC"
118+ Desc expression -> parenthesized (renderSQL expression) <+> "DESC"
119+ AscNullsFirst expression -> parenthesized (renderSQL expression)
120+ <+> "ASC NULLS FIRST"
121+ DescNullsFirst expression -> parenthesized (renderSQL expression)
122+ <+> "DESC NULLS FIRST"
123+ AscNullsLast expression -> parenthesized (renderSQL expression)
124+ <+> "ASC NULLS LAST"
125+ DescNullsLast expression -> parenthesized (renderSQL expression)
126+ <+> "DESC NULLS LAST"
127+
128+newtype IndexMethod ty = UnsafeIndexMethod {renderIndexMethod :: ByteString}
129+ deriving stock (Eq, Ord, Show, GHC.Generic)
130+instance RenderSQL (IndexMethod ty) where renderSQL = renderIndexMethod
131+btree :: IndexMethod 'Btree
132+btree = UnsafeIndexMethod "btree"
133+hash :: IndexMethod 'Hash
134+hash = UnsafeIndexMethod "hash"
135+gist :: IndexMethod 'Gist
136+gist = UnsafeIndexMethod "gist"
137+spgist :: IndexMethod 'Spgist
138+spgist = UnsafeIndexMethod "spgist"
139+gin :: IndexMethod 'Gin
140+gin = UnsafeIndexMethod "gin"
141+brin :: IndexMethod 'Brin
142+brin = UnsafeIndexMethod "brin"
143+
144+-- |
145+-- >>> printSQL (dropIndex #ix :: Definition (Public '["ix" ::: 'Index 'Btree]) (Public '[]))
146+-- DROP INDEX "ix";
147+dropIndex
148+ :: (Has sch schemas schema, KnownSymbol ix)
149+ => QualifiedAlias sch ix
150+ -- ^ name of the user defined index
151+ -> Definition schemas (Alter sch (DropSchemum ix 'Index schema) schemas)
152+dropIndex ix = UnsafeDefinition $ "DROP" <+> "INDEX" <+> renderSQL ix <> ";"
153+
154+dropIndexIfExists
155+ :: (Has sch schemas schema, KnownSymbol ix)
156+ => QualifiedAlias sch ix
157+ -- ^ name of the user defined index
158+ -> Definition schemas (Alter sch (DropSchemumIfExists ix 'Index schema) schemas)
159+dropIndexIfExists ix = UnsafeDefinition $ "DROP INDEX IF EXISTS" <+> renderSQL ix <> ";"
squeal-postgresql/src/Squeal/PostgreSQL/Definition/Schema.hsnew file+96
@@ -0,0 +1,96 @@
1+{-|
2+Module: Squeal.PostgreSQL.Definition.Schema
3+Description: Create and drop schema definitions
4+Copyright: (c) Eitan Chatav, 2017
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Create and drop schema definitions.
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , ConstraintKinds
14+ , DeriveAnyClass
15+ , DeriveGeneric
16+ , DerivingStrategies
17+ , FlexibleContexts
18+ , FlexibleInstances
19+ , GADTs
20+ , LambdaCase
21+ , MultiParamTypeClasses
22+ , OverloadedLabels
23+ , OverloadedStrings
24+ , RankNTypes
25+ , ScopedTypeVariables
26+ , TypeApplications
27+ , TypeInType
28+ , TypeOperators
29+ , UndecidableSuperClasses
30+#-}
31+
32+module Squeal.PostgreSQL.Definition.Schema
33+ ( createSchema
34+ , createSchemaIfNotExists
35+ , dropSchema
36+ , dropSchemaIfExists
37+ ) where
38+
39+import GHC.TypeLits
40+
41+import Squeal.PostgreSQL.Alias
42+import Squeal.PostgreSQL.Definition
43+import Squeal.PostgreSQL.Render
44+import Squeal.PostgreSQL.Schema
45+
46+-- $setup
47+-- >>> import Squeal.PostgreSQL
48+
49+{- |
50+`createSchema` enters a new schema into the current database.
51+The schema name must be distinct from the name of any existing schema
52+in the current database.
53+
54+A schema is essentially a namespace: it contains named objects
55+(tables, data types, functions, and operators) whose names
56+can duplicate those of other objects existing in other schemas.
57+Named objects are accessed by `QualifiedAlias`es with the schema
58+name as a prefix.
59+-}
60+createSchema
61+ :: KnownSymbol sch
62+ => Alias sch
63+ -> Definition schemas (Create sch '[] schemas)
64+createSchema sch = UnsafeDefinition $
65+ "CREATE" <+> "SCHEMA" <+> renderSQL sch <> ";"
66+
67+{- | Idempotent version of `createSchema`. -}
68+createSchemaIfNotExists
69+ :: (KnownSymbol sch, Has sch schemas schema)
70+ => Alias sch
71+ -> Definition schemas (CreateIfNotExists sch '[] schemas)
72+createSchemaIfNotExists sch = UnsafeDefinition $
73+ "CREATE" <+> "SCHEMA" <+> "IF" <+> "NOT" <+> "EXISTS"
74+ <+> renderSQL sch <> ";"
75+
76+-- | >>> :{
77+-- let
78+-- definition :: Definition '["muh_schema" ::: schema, "public" ::: public] '["public" ::: public]
79+-- definition = dropSchema #muh_schema
80+-- :}
81+--
82+-- >>> printSQL definition
83+-- DROP SCHEMA "muh_schema";
84+dropSchema
85+ :: KnownSymbol sch
86+ => Alias sch
87+ -- ^ user defined schema
88+ -> Definition schemas (Drop sch schemas)
89+dropSchema sch = UnsafeDefinition $ "DROP SCHEMA" <+> renderSQL sch <> ";"
90+
91+dropSchemaIfExists
92+ :: KnownSymbol sch
93+ => Alias sch
94+ -- ^ user defined schema
95+ -> Definition schemas (DropIfExists sch schemas)
96+dropSchemaIfExists sch = UnsafeDefinition $ "DROP SCHEMA" <+> renderSQL sch <> ";"
squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table.hsnew file+500
@@ -0,0 +1,500 @@
1+{-|
2+Module: Squeal.PostgreSQL.Definition.Table
3+Description: Create, drop and alter table definitions
4+Copyright: (c) Eitan Chatav, 2017
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Create, drop and alter table definitions.
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , ConstraintKinds
14+ , DeriveAnyClass
15+ , DeriveGeneric
16+ , DerivingStrategies
17+ , FlexibleContexts
18+ , FlexibleInstances
19+ , GADTs
20+ , LambdaCase
21+ , MultiParamTypeClasses
22+ , OverloadedLabels
23+ , OverloadedStrings
24+ , RankNTypes
25+ , ScopedTypeVariables
26+ , TypeApplications
27+ , TypeInType
28+ , TypeOperators
29+ , UndecidableSuperClasses
30+#-}
31+
32+module Squeal.PostgreSQL.Definition.Table
33+ ( createTable
34+ , createTableIfNotExists
35+ , dropTable
36+ , dropTableIfExists
37+ , alterTable
38+ , alterTableIfExists
39+ , alterTableRename
40+ , alterTableIfExistsRename
41+ , AlterTable (..)
42+ , addConstraint
43+ , dropConstraint
44+ , AddColumn (..)
45+ , dropColumn
46+ , renameColumn
47+ , alterColumn
48+ , AlterColumn (..)
49+ , setDefault
50+ , dropDefault
51+ , setNotNull
52+ , dropNotNull
53+ , alterType
54+ ) where
55+
56+import Control.DeepSeq
57+import Data.ByteString
58+import GHC.TypeLits
59+
60+import qualified Generics.SOP as SOP
61+import qualified GHC.Generics as GHC
62+
63+import Squeal.PostgreSQL.Alias
64+import Squeal.PostgreSQL.Definition
65+import Squeal.PostgreSQL.Definition.Table.Constraint
66+import Squeal.PostgreSQL.Expression
67+import Squeal.PostgreSQL.Expression.Type
68+import Squeal.PostgreSQL.List
69+import Squeal.PostgreSQL.Render
70+import Squeal.PostgreSQL.Schema
71+
72+-- $setup
73+-- >>> import Squeal.PostgreSQL
74+
75+{- | `createTable` adds a table to the schema.
76+
77+>>> :set -XOverloadedLabels
78+>>> :{
79+type Table = '[] :=>
80+ '[ "a" ::: 'NoDef :=> 'Null 'PGint4
81+ , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]
82+:}
83+
84+>>> :{
85+let
86+ setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table])
87+ setup = createTable #tab
88+ (nullable int `as` #a :* nullable real `as` #b) Nil
89+in printSQL setup
90+:}
91+CREATE TABLE "tab" ("a" int NULL, "b" real NULL);
92+-}
93+createTable
94+ :: ( KnownSymbol sch
95+ , KnownSymbol tab
96+ , columns ~ (col ': cols)
97+ , SOP.SListI columns
98+ , SOP.SListI constraints
99+ , Has sch schemas0 schema0
100+ , schemas1 ~ Alter sch (Create tab ('Table (constraints :=> columns)) schema0) schemas0 )
101+ => QualifiedAlias sch tab -- ^ the name of the table to add
102+ -> NP (Aliased (ColumnTypeExpression schemas0)) columns
103+ -- ^ the names and datatype of each column
104+ -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints
105+ -- ^ constraints that must hold for the table
106+ -> Definition schemas0 schemas1
107+createTable tab columns constraints = UnsafeDefinition $
108+ "CREATE TABLE" <+> renderCreation tab columns constraints
109+
110+{-| `createTableIfNotExists` creates a table if it doesn't exist, but does not add it to the schema.
111+Instead, the schema already has the table so if the table did not yet exist, the schema was wrong.
112+`createTableIfNotExists` fixes this. Interestingly, this property makes it an idempotent in
113+the `Category` of `Definition`s.
114+
115+>>> :set -XOverloadedLabels -XTypeApplications
116+>>> :{
117+type Table = '[] :=>
118+ '[ "a" ::: 'NoDef :=> 'Null 'PGint4
119+ , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]
120+:}
121+
122+>>> type Schemas = Public '["tab" ::: 'Table Table]
123+
124+>>> :{
125+let
126+ setup :: Definition Schemas Schemas
127+ setup = createTableIfNotExists #tab
128+ (nullable int `as` #a :* nullable real `as` #b) Nil
129+in printSQL setup
130+:}
131+CREATE TABLE IF NOT EXISTS "tab" ("a" int NULL, "b" real NULL);
132+-}
133+createTableIfNotExists
134+ :: ( KnownSymbol sch
135+ , KnownSymbol tab
136+ , columns ~ (col ': cols)
137+ , SOP.SListI columns
138+ , SOP.SListI constraints
139+ , Has sch schemas0 schema0
140+ , schemas1 ~ Alter sch (CreateIfNotExists tab ('Table (constraints :=> columns)) schema0) schemas0 )
141+ => QualifiedAlias sch tab -- ^ the name of the table to add
142+ -> NP (Aliased (ColumnTypeExpression schemas0)) columns
143+ -- ^ the names and datatype of each column
144+ -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints
145+ -- ^ constraints that must hold for the table
146+ -> Definition schemas0 schemas1
147+createTableIfNotExists tab columns constraints = UnsafeDefinition $
148+ "CREATE TABLE IF NOT EXISTS"
149+ <+> renderCreation tab columns constraints
150+
151+-- helper function for `createTable` and `createTableIfNotExists`
152+renderCreation
153+ :: ( KnownSymbol sch
154+ , KnownSymbol tab
155+ , SOP.SListI columns
156+ , SOP.SListI constraints )
157+ => QualifiedAlias sch tab -- ^ the name of the table to add
158+ -> NP (Aliased (ColumnTypeExpression schemas0)) columns
159+ -- ^ the names and datatype of each column
160+ -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints
161+ -- ^ constraints that must hold for the table
162+ -> ByteString
163+renderCreation tab columns constraints = renderSQL tab
164+ <+> parenthesized
165+ ( renderCommaSeparated renderColumnDef columns
166+ <> ( case constraints of
167+ Nil -> ""
168+ _ -> ", " <>
169+ renderCommaSeparated renderConstraint constraints ) )
170+ <> ";"
171+ where
172+ renderColumnDef :: Aliased (ColumnTypeExpression schemas) x -> ByteString
173+ renderColumnDef (ty `As` column) =
174+ renderSQL column <+> renderColumnTypeExpression ty
175+ renderConstraint
176+ :: Aliased (TableConstraintExpression sch tab schemas) constraint
177+ -> ByteString
178+ renderConstraint (constraint `As` alias) =
179+ "CONSTRAINT" <+> renderSQL alias <+> renderSQL constraint
180+
181+-- | `dropTable` removes a table from the schema.
182+--
183+-- >>> :{
184+-- let
185+-- definition :: Definition '["public" ::: '["muh_table" ::: 'Table t]] (Public '[])
186+-- definition = dropTable #muh_table
187+-- :}
188+--
189+-- >>> printSQL definition
190+-- DROP TABLE "muh_table";
191+dropTable
192+ :: ( Has sch schemas schema
193+ , KnownSymbol tab )
194+ => QualifiedAlias sch tab -- ^ table to remove
195+ -> Definition schemas (Alter sch (DropSchemum tab 'Table schema) schemas)
196+dropTable tab = UnsafeDefinition $ "DROP TABLE" <+> renderSQL tab <> ";"
197+
198+dropTableIfExists
199+ :: ( Has sch schemas schema
200+ , KnownSymbol tab)
201+ => QualifiedAlias sch tab -- ^ table to remove
202+ -> Definition schemas (Alter sch (DropSchemumIfExists tab 'Table schema) schemas)
203+dropTableIfExists tab = UnsafeDefinition $ "DROP TABLE IF EXISTS" <+> renderSQL tab <> ";"
204+
205+-- | `alterTable` changes the definition of a table from the schema.
206+alterTable
207+ :: (Has sch schemas schema, KnownSymbol tab)
208+ => QualifiedAlias sch tab -- ^ table to alter
209+ -> AlterTable sch tab schemas table -- ^ alteration to perform
210+ -> Definition schemas (Alter sch (Alter tab ('Table table) schema) schemas)
211+alterTable tab alteration = UnsafeDefinition $
212+ "ALTER TABLE"
213+ <+> renderSQL tab
214+ <+> renderAlterTable alteration
215+ <> ";"
216+
217+-- | `alterTable` changes the definition of a table from the schema.
218+alterTableIfExists
219+ :: (Has sch schemas schema, KnownSymbol tab)
220+ => QualifiedAlias sch tab -- ^ table to alter
221+ -> AlterTable sch tab schemas table -- ^ alteration to perform
222+ -> Definition schemas (Alter sch (AlterIfExists tab ('Table table) schema) schemas)
223+alterTableIfExists tab alteration = UnsafeDefinition $
224+ "ALTER TABLE IF EXISTS"
225+ <+> renderSQL tab
226+ <+> renderAlterTable alteration
227+ <> ";"
228+
229+-- | `alterTableRename` changes the name of a table from the schema.
230+--
231+-- >>> printSQL $ alterTableRename #foo #bar
232+-- ALTER TABLE "foo" RENAME TO "bar";
233+alterTableRename
234+ :: (KnownSymbol tab0, KnownSymbol tab1)
235+ => Alias tab0 -- ^ table to rename
236+ -> Alias tab1 -- ^ what to rename it
237+ -> Definition schema (Rename tab0 tab1 schema)
238+alterTableRename tab0 tab1 = UnsafeDefinition $
239+ "ALTER TABLE" <+> renderSQL tab0
240+ <+> "RENAME TO" <+> renderSQL tab1 <> ";"
241+
242+alterTableIfExistsRename
243+ :: (KnownSymbol tab0, KnownSymbol tab1)
244+ => Alias tab0 -- ^ table to rename
245+ -> Alias tab1 -- ^ what to rename it
246+ -> Definition schema (RenameIfExists tab0 tab1 schema)
247+alterTableIfExistsRename tab0 tab1 = UnsafeDefinition $
248+ "ALTER TABLE IF EXISTS" <+> renderSQL tab0
249+ <+> "RENAME TO" <+> renderSQL tab1 <> ";"
250+
251+-- | An `AlterTable` describes the alteration to perform on the columns
252+-- of a table.
253+newtype AlterTable
254+ (sch :: Symbol)
255+ (tab :: Symbol)
256+ (schemas :: SchemasType)
257+ (table :: TableType) =
258+ UnsafeAlterTable {renderAlterTable :: ByteString}
259+ deriving (GHC.Generic,Show,Eq,Ord,NFData)
260+
261+-- | An `addConstraint` adds a table constraint.
262+--
263+-- >>> :{
264+-- let
265+-- definition :: Definition
266+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
267+-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: 'Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
268+-- definition = alterTable #tab (addConstraint #positive (check #col (#col .> 0)))
269+-- in printSQL definition
270+-- :}
271+-- ALTER TABLE "tab" ADD CONSTRAINT "positive" CHECK (("col" > 0));
272+addConstraint
273+ :: ( KnownSymbol alias
274+ , Has sch schemas schema
275+ , Has tab schema ('Table table0)
276+ , table0 ~ (constraints :=> columns)
277+ , table1 ~ (Create alias constraint constraints :=> columns) )
278+ => Alias alias
279+ -> TableConstraintExpression sch tab schemas constraint
280+ -- ^ constraint to add
281+ -> AlterTable sch tab schemas table1
282+addConstraint alias constraint = UnsafeAlterTable $
283+ "ADD" <+> "CONSTRAINT" <+> renderSQL alias
284+ <+> renderSQL constraint
285+
286+-- | A `dropConstraint` drops a table constraint.
287+--
288+-- >>> :{
289+-- let
290+-- definition :: Definition
291+-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
292+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
293+-- definition = alterTable #tab (dropConstraint #positive)
294+-- in printSQL definition
295+-- :}
296+-- ALTER TABLE "tab" DROP CONSTRAINT "positive";
297+dropConstraint
298+ :: ( KnownSymbol constraint
299+ , Has sch schemas schema
300+ , Has tab schema ('Table table0)
301+ , table0 ~ (constraints :=> columns)
302+ , table1 ~ (Drop constraint constraints :=> columns) )
303+ => Alias constraint
304+ -- ^ constraint to drop
305+ -> AlterTable sch tab schemas table1
306+dropConstraint constraint = UnsafeAlterTable $
307+ "DROP" <+> "CONSTRAINT" <+> renderSQL constraint
308+
309+-- | An `AddColumn` is either @NULL@ or has @DEFAULT@.
310+class AddColumn ty where
311+ -- | `addColumn` adds a new column, initially filled with whatever
312+ -- default value is given or with @NULL@.
313+ --
314+ -- >>> :{
315+ -- let
316+ -- definition :: Definition
317+ -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]
318+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>
319+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4
320+ -- , "col2" ::: 'Def :=> 'Null 'PGtext ])]]
321+ -- definition = alterTable #tab (addColumn #col2 (text & nullable & default_ "foo"))
322+ -- in printSQL definition
323+ -- :}
324+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL DEFAULT E'foo';
325+ --
326+ -- >>> :{
327+ -- let
328+ -- definition :: Definition
329+ -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]
330+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>
331+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4
332+ -- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]
333+ -- definition = alterTable #tab (addColumn #col2 (text & nullable))
334+ -- in printSQL definition
335+ -- :}
336+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL;
337+ addColumn
338+ :: ( KnownSymbol column
339+ , Has sch schemas schema
340+ , Has tab schema ('Table table0)
341+ , table0 ~ (constraints :=> columns) )
342+ => Alias column -- ^ column to add
343+ -> ColumnTypeExpression schemas ty -- ^ type of the new column
344+ -> AlterTable sch tab schemas (constraints :=> Create column ty columns)
345+ addColumn column ty = UnsafeAlterTable $
346+ "ADD COLUMN" <+> renderSQL column <+> renderColumnTypeExpression ty
347+instance {-# OVERLAPPING #-} AddColumn ('Def :=> ty)
348+instance {-# OVERLAPPABLE #-} AddColumn ('NoDef :=> 'Null ty)
349+
350+-- | A `dropColumn` removes a column. Whatever data was in the column
351+-- disappears. Table constraints involving the column are dropped, too.
352+-- However, if the column is referenced by a foreign key constraint of
353+-- another table, PostgreSQL will not silently drop that constraint.
354+--
355+-- >>> :{
356+-- let
357+-- definition :: Definition
358+-- '["public" ::: '["tab" ::: 'Table ('[] :=>
359+-- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4
360+-- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]
361+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]
362+-- definition = alterTable #tab (dropColumn #col2)
363+-- in printSQL definition
364+-- :}
365+-- ALTER TABLE "tab" DROP COLUMN "col2";
366+dropColumn
367+ :: ( KnownSymbol column
368+ , Has sch schemas schema
369+ , Has tab schema ('Table table0)
370+ , table0 ~ (constraints :=> columns)
371+ , table1 ~ (constraints :=> Drop column columns) )
372+ => Alias column -- ^ column to remove
373+ -> AlterTable sch tab schemas table1
374+dropColumn column = UnsafeAlterTable $
375+ "DROP COLUMN" <+> renderSQL column
376+
377+-- | A `renameColumn` renames a column.
378+--
379+-- >>> :{
380+-- let
381+-- definition :: Definition
382+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["foo" ::: 'NoDef :=> 'Null 'PGint4])]]
383+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["bar" ::: 'NoDef :=> 'Null 'PGint4])]]
384+-- definition = alterTable #tab (renameColumn #foo #bar)
385+-- in printSQL definition
386+-- :}
387+-- ALTER TABLE "tab" RENAME COLUMN "foo" TO "bar";
388+renameColumn
389+ :: ( KnownSymbol column0
390+ , KnownSymbol column1
391+ , Has sch schemas schema
392+ , Has tab schema ('Table table0)
393+ , table0 ~ (constraints :=> columns)
394+ , table1 ~ (constraints :=> Rename column0 column1 columns) )
395+ => Alias column0 -- ^ column to rename
396+ -> Alias column1 -- ^ what to rename the column
397+ -> AlterTable sch tab schemas table1
398+renameColumn column0 column1 = UnsafeAlterTable $
399+ "RENAME COLUMN" <+> renderSQL column0 <+> "TO" <+> renderSQL column1
400+
401+-- | An `alterColumn` alters a single column.
402+alterColumn
403+ :: ( KnownSymbol column
404+ , Has sch schemas schema
405+ , Has tab schema ('Table table0)
406+ , table0 ~ (constraints :=> columns)
407+ , Has column columns ty0
408+ , table1 ~ (constraints :=> Alter column ty1 columns))
409+ => Alias column -- ^ column to alter
410+ -> AlterColumn schemas ty0 ty1 -- ^ alteration to perform
411+ -> AlterTable sch tab schemas table1
412+alterColumn column alteration = UnsafeAlterTable $
413+ "ALTER COLUMN" <+> renderSQL column <+> renderAlterColumn alteration
414+
415+-- | An `AlterColumn` describes the alteration to perform on a single column.
416+newtype AlterColumn (schemas :: SchemasType) (ty0 :: ColumnType) (ty1 :: ColumnType) =
417+ UnsafeAlterColumn {renderAlterColumn :: ByteString}
418+ deriving (GHC.Generic,Show,Eq,Ord,NFData)
419+
420+-- | A `setDefault` sets a new default for a column. Note that this doesn't
421+-- affect any existing rows in the table, it just changes the default for
422+-- future insert and update commands.
423+--
424+-- >>> :{
425+-- let
426+-- definition :: Definition
427+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]
428+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]
429+-- definition = alterTable #tab (alterColumn #col (setDefault 5))
430+-- in printSQL definition
431+-- :}
432+-- ALTER TABLE "tab" ALTER COLUMN "col" SET DEFAULT 5;
433+setDefault
434+ :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty -- ^ default value to set
435+ -> AlterColumn schemas (constraint :=> ty) ('Def :=> ty)
436+setDefault expression = UnsafeAlterColumn $
437+ "SET DEFAULT" <+> renderExpression expression
438+
439+-- | A `dropDefault` removes any default value for a column.
440+--
441+-- >>> :{
442+-- let
443+-- definition :: Definition
444+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]
445+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]
446+-- definition = alterTable #tab (alterColumn #col dropDefault)
447+-- in printSQL definition
448+-- :}
449+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP DEFAULT;
450+dropDefault :: AlterColumn schemas ('Def :=> ty) ('NoDef :=> ty)
451+dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"
452+
453+-- | A `setNotNull` adds a @NOT NULL@ constraint to a column.
454+-- The constraint will be checked immediately, so the table data must satisfy
455+-- the constraint before it can be added.
456+--
457+-- >>> :{
458+-- let
459+-- definition :: Definition
460+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]
461+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
462+-- definition = alterTable #tab (alterColumn #col setNotNull)
463+-- in printSQL definition
464+-- :}
465+-- ALTER TABLE "tab" ALTER COLUMN "col" SET NOT NULL;
466+setNotNull
467+ :: AlterColumn schemas (constraint :=> 'Null ty) (constraint :=> 'NotNull ty)
468+setNotNull = UnsafeAlterColumn $ "SET NOT NULL"
469+
470+-- | A `dropNotNull` drops a @NOT NULL@ constraint from a column.
471+--
472+-- >>> :{
473+-- let
474+-- definition :: Definition
475+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
476+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]
477+-- definition = alterTable #tab (alterColumn #col dropNotNull)
478+-- in printSQL definition
479+-- :}
480+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP NOT NULL;
481+dropNotNull
482+ :: AlterColumn schemas (constraint :=> 'NotNull ty) (constraint :=> 'Null ty)
483+dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"
484+
485+-- | An `alterType` converts a column to a different data type.
486+-- This will succeed only if each existing entry in the column can be
487+-- converted to the new type by an implicit cast.
488+--
489+-- >>> :{
490+-- let
491+-- definition :: Definition
492+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]
493+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGnumeric])]]
494+-- definition =
495+-- alterTable #tab (alterColumn #col (alterType (numeric & notNullable)))
496+-- in printSQL definition
497+-- :}
498+-- ALTER TABLE "tab" ALTER COLUMN "col" TYPE numeric NOT NULL;
499+alterType :: ColumnTypeExpression schemas ty -> AlterColumn schemas ty0 ty
500+alterType ty = UnsafeAlterColumn $ "TYPE" <+> renderColumnTypeExpression ty
squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table/Constraint.hsnew file+339
@@ -0,0 +1,339 @@
1+{-|
2+Module: Squeal.PostgreSQL.Definition.Table.Constraint
3+Description: Table constraint expressions
4+Copyright: (c) Eitan Chatav, 2017
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Table constraint expressions.
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , ConstraintKinds
14+ , DeriveAnyClass
15+ , DeriveGeneric
16+ , DerivingStrategies
17+ , FlexibleContexts
18+ , FlexibleInstances
19+ , GADTs
20+ , LambdaCase
21+ , MultiParamTypeClasses
22+ , OverloadedLabels
23+ , OverloadedStrings
24+ , RankNTypes
25+ , ScopedTypeVariables
26+ , TypeApplications
27+ , TypeInType
28+ , TypeOperators
29+ , UndecidableSuperClasses
30+#-}
31+
32+module Squeal.PostgreSQL.Definition.Table.Constraint
33+ ( TableConstraintExpression (..)
34+ , check
35+ , unique
36+ , primaryKey
37+ , foreignKey
38+ , ForeignKeyed
39+ , OnDeleteClause (..)
40+ , OnUpdateClause (..)
41+ ) where
42+
43+import Control.DeepSeq
44+import Data.ByteString
45+import GHC.TypeLits
46+
47+import qualified Generics.SOP as SOP
48+import qualified GHC.Generics as GHC
49+
50+import Squeal.PostgreSQL.Alias
51+import Squeal.PostgreSQL.Expression.Logic
52+import Squeal.PostgreSQL.List
53+import Squeal.PostgreSQL.Render
54+import Squeal.PostgreSQL.Schema
55+
56+-- $setup
57+-- >>> import Squeal.PostgreSQL
58+
59+-- | Data types are a way to limit the kind of data that can be stored in a
60+-- table. For many applications, however, the constraint they provide is
61+-- too coarse. For example, a column containing a product price should
62+-- probably only accept positive values. But there is no standard data type
63+-- that accepts only positive numbers. Another issue is that you might want
64+-- to constrain column data with respect to other columns or rows.
65+-- For example, in a table containing product information,
66+-- there should be only one row for each product number.
67+-- `TableConstraint`s give you as much control over the data in your tables
68+-- as you wish. If a user attempts to store data in a column that would
69+-- violate a constraint, an error is raised. This applies
70+-- even if the value came from the default value definition.
71+newtype TableConstraintExpression
72+ (sch :: Symbol)
73+ (tab :: Symbol)
74+ (schemas :: SchemasType)
75+ (constraint :: TableConstraint)
76+ = UnsafeTableConstraintExpression
77+ { renderTableConstraintExpression :: ByteString }
78+ deriving (GHC.Generic,Show,Eq,Ord,NFData)
79+instance RenderSQL
80+ (TableConstraintExpression sch tab schemas constraint) where
81+ renderSQL = renderTableConstraintExpression
82+
83+{-| A `check` constraint is the most generic `TableConstraint` type.
84+It allows you to specify that the value in a certain column must satisfy
85+a Boolean (truth-value) expression.
86+
87+>>> :{
88+type Schema = '[
89+ "tab" ::: 'Table ('[ "inequality" ::: 'Check '["a","b"]] :=> '[
90+ "a" ::: 'NoDef :=> 'NotNull 'PGint4,
91+ "b" ::: 'NoDef :=> 'NotNull 'PGint4
92+ ])]
93+:}
94+
95+>>> :{
96+let
97+ definition :: Definition (Public '[]) (Public Schema)
98+ definition = createTable #tab
99+ ( (int & notNullable) `as` #a :*
100+ (int & notNullable) `as` #b )
101+ ( check (#a :* #b) (#a .> #b) `as` #inequality )
102+:}
103+
104+>>> printSQL definition
105+CREATE TABLE "tab" ("a" int NOT NULL, "b" int NOT NULL, CONSTRAINT "inequality" CHECK (("a" > "b")));
106+-}
107+check
108+ :: ( Has sch schemas schema
109+ , Has tab schema ('Table table)
110+ , HasAll aliases (TableToRow table) subcolumns )
111+ => NP Alias aliases
112+ -- ^ specify the subcolumns which are getting checked
113+ -> (forall t. Condition '[] '[] 'Ungrouped schemas '[] '[t ::: subcolumns])
114+ -- ^ a closed `Condition` on those subcolumns
115+ -> TableConstraintExpression sch tab schemas ('Check aliases)
116+check _cols condition = UnsafeTableConstraintExpression $
117+ "CHECK" <+> parenthesized (renderSQL condition)
118+
119+{-| A `unique` constraint ensure that the data contained in a column,
120+or a group of columns, is unique among all the rows in the table.
121+
122+>>> :{
123+type Schema = '[
124+ "tab" ::: 'Table( '[ "uq_a_b" ::: 'Unique '["a","b"]] :=> '[
125+ "a" ::: 'NoDef :=> 'Null 'PGint4,
126+ "b" ::: 'NoDef :=> 'Null 'PGint4
127+ ])]
128+:}
129+
130+>>> :{
131+let
132+ definition :: Definition (Public '[]) (Public Schema)
133+ definition = createTable #tab
134+ ( (int & nullable) `as` #a :*
135+ (int & nullable) `as` #b )
136+ ( unique (#a :* #b) `as` #uq_a_b )
137+:}
138+
139+>>> printSQL definition
140+CREATE TABLE "tab" ("a" int NULL, "b" int NULL, CONSTRAINT "uq_a_b" UNIQUE ("a", "b"));
141+-}
142+unique
143+ :: ( Has sch schemas schema
144+ , Has tab schema('Table table)
145+ , HasAll aliases (TableToRow table) subcolumns )
146+ => NP Alias aliases
147+ -- ^ specify subcolumns which together are unique for each row
148+ -> TableConstraintExpression sch tab schemas ('Unique aliases)
149+unique columns = UnsafeTableConstraintExpression $
150+ "UNIQUE" <+> parenthesized (renderSQL columns)
151+
152+{-| A `primaryKey` constraint indicates that a column, or group of columns,
153+can be used as a unique identifier for rows in the table.
154+This requires that the values be both unique and not null.
155+
156+>>> :{
157+type Schema = '[
158+ "tab" ::: 'Table ('[ "pk_id" ::: 'PrimaryKey '["id"]] :=> '[
159+ "id" ::: 'Def :=> 'NotNull 'PGint4,
160+ "name" ::: 'NoDef :=> 'NotNull 'PGtext
161+ ])]
162+:}
163+
164+>>> :{
165+let
166+ definition :: Definition (Public '[]) (Public Schema)
167+ definition = createTable #tab
168+ ( serial `as` #id :*
169+ (text & notNullable) `as` #name )
170+ ( primaryKey #id `as` #pk_id )
171+:}
172+
173+>>> printSQL definition
174+CREATE TABLE "tab" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_id" PRIMARY KEY ("id"));
175+-}
176+primaryKey
177+ :: ( Has sch schemas schema
178+ , Has tab schema ('Table table)
179+ , HasAll aliases (TableToColumns table) subcolumns
180+ , AllNotNull subcolumns )
181+ => NP Alias aliases
182+ -- ^ specify the subcolumns which together form a primary key.
183+ -> TableConstraintExpression sch tab schemas ('PrimaryKey aliases)
184+primaryKey columns = UnsafeTableConstraintExpression $
185+ "PRIMARY KEY" <+> parenthesized (renderSQL columns)
186+
187+{-| A `foreignKey` specifies that the values in a column
188+(or a group of columns) must match the values appearing in some row of
189+another table. We say this maintains the referential integrity
190+between two related tables.
191+
192+>>> :{
193+type Schema =
194+ '[ "users" ::: 'Table (
195+ '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>
196+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4
197+ , "name" ::: 'NoDef :=> 'NotNull 'PGtext
198+ ])
199+ , "emails" ::: 'Table (
200+ '[ "pk_emails" ::: 'PrimaryKey '["id"]
201+ , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]
202+ ] :=>
203+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4
204+ , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4
205+ , "email" ::: 'NoDef :=> 'Null 'PGtext
206+ ])
207+ ]
208+:}
209+
210+>>> :{
211+let
212+ setup :: Definition (Public '[]) (Public Schema)
213+ setup =
214+ createTable #users
215+ ( serial `as` #id :*
216+ (text & notNullable) `as` #name )
217+ ( primaryKey #id `as` #pk_users ) >>>
218+ createTable #emails
219+ ( serial `as` #id :*
220+ (int & notNullable) `as` #user_id :*
221+ (text & nullable) `as` #email )
222+ ( primaryKey #id `as` #pk_emails :*
223+ foreignKey #user_id #users #id
224+ OnDeleteCascade OnUpdateCascade `as` #fk_user_id )
225+in printSQL setup
226+:}
227+CREATE TABLE "users" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_users" PRIMARY KEY ("id"));
228+CREATE TABLE "emails" ("id" serial, "user_id" int NOT NULL, "email" text NULL, CONSTRAINT "pk_emails" PRIMARY KEY ("id"), CONSTRAINT "fk_user_id" FOREIGN KEY ("user_id") REFERENCES "users" ("id") ON DELETE CASCADE ON UPDATE CASCADE);
229+
230+A `foreignKey` can even be a table self-reference.
231+
232+>>> :{
233+type Schema =
234+ '[ "employees" ::: 'Table (
235+ '[ "employees_pk" ::: 'PrimaryKey '["id"]
236+ , "employees_employer_fk" ::: 'ForeignKey '["employer_id"] "employees" '["id"]
237+ ] :=>
238+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4
239+ , "name" ::: 'NoDef :=> 'NotNull 'PGtext
240+ , "employer_id" ::: 'NoDef :=> 'Null 'PGint4
241+ ])
242+ ]
243+:}
244+
245+>>> :{
246+let
247+ setup :: Definition (Public '[]) (Public Schema)
248+ setup =
249+ createTable #employees
250+ ( serial `as` #id :*
251+ (text & notNullable) `as` #name :*
252+ (integer & nullable) `as` #employer_id )
253+ ( primaryKey #id `as` #employees_pk :*
254+ foreignKey #employer_id #employees #id
255+ OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )
256+in printSQL setup
257+:}
258+CREATE TABLE "employees" ("id" serial, "name" text NOT NULL, "employer_id" integer NULL, CONSTRAINT "employees_pk" PRIMARY KEY ("id"), CONSTRAINT "employees_employer_fk" FOREIGN KEY ("employer_id") REFERENCES "employees" ("id") ON DELETE CASCADE ON UPDATE CASCADE);
259+-}
260+foreignKey
261+ :: (ForeignKeyed schemas sch schema child parent
262+ table reftable
263+ columns refcolumns
264+ constraints cols
265+ reftys tys )
266+ => NP Alias columns
267+ -- ^ column or columns in the table
268+ -> Alias parent
269+ -- ^ reference table
270+ -> NP Alias refcolumns
271+ -- ^ reference column or columns in the reference table
272+ -> OnDeleteClause
273+ -- ^ what to do when reference is deleted
274+ -> OnUpdateClause
275+ -- ^ what to do when reference is updated
276+ -> TableConstraintExpression sch child schemas
277+ ('ForeignKey columns parent refcolumns)
278+foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $
279+ "FOREIGN KEY" <+> parenthesized (renderSQL keys)
280+ <+> "REFERENCES" <+> renderSQL parent
281+ <+> parenthesized (renderSQL refs)
282+ <+> renderSQL ondel
283+ <+> renderSQL onupd
284+
285+-- | A constraint synonym between types involved in a foreign key constraint.
286+type ForeignKeyed schemas
287+ sch
288+ schema
289+ child parent
290+ table reftable
291+ columns refcolumns
292+ constraints cols
293+ reftys tys =
294+ ( Has sch schemas schema
295+ , Has child schema ('Table table)
296+ , Has parent schema ('Table reftable)
297+ , HasAll columns (TableToColumns table) tys
298+ , reftable ~ (constraints :=> cols)
299+ , HasAll refcolumns cols reftys
300+ , SOP.AllZip SamePGType tys reftys
301+ , Uniquely refcolumns constraints )
302+
303+-- | `OnDeleteClause` indicates what to do with rows that reference a deleted row.
304+data OnDeleteClause
305+ = OnDeleteNoAction
306+ -- ^ if any referencing rows still exist when the constraint is checked,
307+ -- an error is raised
308+ | OnDeleteRestrict -- ^ prevents deletion of a referenced row
309+ | OnDeleteCascade
310+ -- ^ specifies that when a referenced row is deleted,
311+ -- row(s) referencing it should be automatically deleted as well
312+ deriving (GHC.Generic,Show,Eq,Ord)
313+instance NFData OnDeleteClause
314+-- | Render `OnDeleteClause`.
315+instance RenderSQL OnDeleteClause where
316+ renderSQL = \case
317+ OnDeleteNoAction -> "ON DELETE NO ACTION"
318+ OnDeleteRestrict -> "ON DELETE RESTRICT"
319+ OnDeleteCascade -> "ON DELETE CASCADE"
320+
321+-- | Analagous to `OnDeleteClause` there is also `OnUpdateClause` which is invoked
322+-- when a referenced column is changed (updated).
323+data OnUpdateClause
324+ = OnUpdateNoAction
325+ -- ^ if any referencing rows has not changed when the constraint is checked,
326+ -- an error is raised
327+ | OnUpdateRestrict -- ^ prevents update of a referenced row
328+ | OnUpdateCascade
329+ -- ^ the updated values of the referenced column(s) should be copied
330+ -- into the referencing row(s)
331+ deriving (GHC.Generic,Show,Eq,Ord)
332+instance NFData OnUpdateClause
333+
334+-- | Render `OnUpdateClause`.
335+instance RenderSQL OnUpdateClause where
336+ renderSQL = \case
337+ OnUpdateNoAction -> "ON UPDATE NO ACTION"
338+ OnUpdateRestrict -> "ON UPDATE RESTRICT"
339+ OnUpdateCascade -> "ON UPDATE CASCADE"
squeal-postgresql/src/Squeal/PostgreSQL/Definition/Type.hsnew file+229
@@ -0,0 +1,229 @@
1+{-|
2+Module: Squeal.PostgreSQL.Definition.Type
3+Description: Create and drop type definitions
4+Copyright: (c) Eitan Chatav, 2017
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Create and drop type definitions.
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , ConstraintKinds
14+ , DeriveAnyClass
15+ , DeriveGeneric
16+ , DerivingStrategies
17+ , FlexibleContexts
18+ , FlexibleInstances
19+ , GADTs
20+ , LambdaCase
21+ , MultiParamTypeClasses
22+ , OverloadedLabels
23+ , OverloadedStrings
24+ , RankNTypes
25+ , ScopedTypeVariables
26+ , TypeApplications
27+ , TypeInType
28+ , TypeOperators
29+ , UndecidableSuperClasses
30+#-}
31+
32+module Squeal.PostgreSQL.Definition.Type
33+ ( createTypeEnum
34+ , createTypeEnumFrom
35+ , createTypeComposite
36+ , createTypeCompositeFrom
37+ , createTypeRange
38+ , createDomain
39+ , dropType
40+ , dropTypeIfExists
41+ ) where
42+
43+import Data.ByteString
44+import Data.Monoid
45+import GHC.TypeLits
46+import Prelude hiding ((.), id)
47+
48+import qualified Generics.SOP as SOP
49+
50+import Squeal.PostgreSQL.Alias
51+import Squeal.PostgreSQL.Expression.Logic
52+import Squeal.PostgreSQL.Expression.Type
53+import Squeal.PostgreSQL.Definition
54+import Squeal.PostgreSQL.List
55+import Squeal.PostgreSQL.PG
56+import Squeal.PostgreSQL.Render
57+import Squeal.PostgreSQL.Schema
58+
59+-- $setup
60+-- >>> import Squeal.PostgreSQL
61+-- >>> import qualified GHC.Generics as GHC
62+-- >>> import qualified Generics.SOP as SOP
63+
64+-- | Enumerated types are created using the `createTypeEnum` command, for example
65+--
66+-- >>> printSQL $ (createTypeEnum #mood (label @"sad" :* label @"ok" :* label @"happy") :: Definition (Public '[]) '["public" ::: '["mood" ::: 'Typedef ('PGenum '["sad","ok","happy"])]])
67+-- CREATE TYPE "mood" AS ENUM ('sad', 'ok', 'happy');
68+createTypeEnum
69+ :: (KnownSymbol enum, Has sch schemas schema, SOP.All KnownSymbol labels)
70+ => QualifiedAlias sch enum
71+ -- ^ name of the user defined enumerated type
72+ -> NP PGlabel labels
73+ -- ^ labels of the enumerated type
74+ -> Definition schemas (Alter sch (Create enum ('Typedef ('PGenum labels)) schema) schemas)
75+createTypeEnum enum labels = UnsafeDefinition $
76+ "CREATE" <+> "TYPE" <+> renderSQL enum <+> "AS" <+> "ENUM" <+>
77+ parenthesized (renderSQL labels) <> ";"
78+
79+-- | Enumerated types can also be generated from a Haskell type, for example
80+--
81+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic
82+-- >>> instance SOP.Generic Schwarma
83+-- >>> instance SOP.HasDatatypeInfo Schwarma
84+-- >>> :{
85+-- let
86+-- createSchwarma :: Definition (Public '[]) '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]]
87+-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma
88+-- in
89+-- printSQL createSchwarma
90+-- :}
91+-- CREATE TYPE "schwarma" AS ENUM ('Beef', 'Lamb', 'Chicken');
92+createTypeEnumFrom
93+ :: forall hask sch enum schemas schema.
94+ ( SOP.Generic hask
95+ , SOP.All KnownSymbol (LabelsPG hask)
96+ , KnownSymbol enum
97+ , Has sch schemas schema )
98+ => QualifiedAlias sch enum
99+ -- ^ name of the user defined enumerated type
100+ -> Definition schemas (Alter sch (Create enum ('Typedef (PG (Enumerated hask))) schema) schemas)
101+createTypeEnumFrom enum = createTypeEnum enum
102+ (SOP.hpure label :: NP PGlabel (LabelsPG hask))
103+
104+{- | `createTypeComposite` creates a composite type. The composite type is
105+specified by a list of attribute names and data types.
106+
107+>>> :{
108+type PGcomplex = 'PGcomposite
109+ '[ "real" ::: 'NotNull 'PGfloat8
110+ , "imaginary" ::: 'NotNull 'PGfloat8 ]
111+:}
112+
113+>>> :{
114+let
115+ setup :: Definition (Public '[]) '["public" ::: '["complex" ::: 'Typedef PGcomplex]]
116+ setup = createTypeComposite #complex
117+ (float8 `as` #real :* float8 `as` #imaginary)
118+in printSQL setup
119+:}
120+CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);
121+-}
122+createTypeComposite
123+ :: (KnownSymbol ty, Has sch schemas schema, SOP.SListI fields)
124+ => QualifiedAlias sch ty
125+ -- ^ name of the user defined composite type
126+ -> NP (Aliased (TypeExpression schemas)) fields
127+ -- ^ list of attribute names and data types
128+ -> Definition schemas (Alter sch (Create ty ('Typedef ('PGcomposite fields)) schema) schemas)
129+createTypeComposite ty fields = UnsafeDefinition $
130+ "CREATE" <+> "TYPE" <+> renderSQL ty <+> "AS" <+> parenthesized
131+ (renderCommaSeparated renderField fields) <> ";"
132+ where
133+ renderField :: Aliased (TypeExpression schemas) x -> ByteString
134+ renderField (typ `As` alias) =
135+ renderSQL alias <+> renderSQL typ
136+
137+-- | Composite types can also be generated from a Haskell type, for example
138+--
139+-- >>> data Complex = Complex {real :: Double, imaginary :: Double} deriving GHC.Generic
140+-- >>> instance SOP.Generic Complex
141+-- >>> instance SOP.HasDatatypeInfo Complex
142+-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]
143+-- >>> :{
144+-- let
145+-- createComplex :: Definition (Public '[]) (Public Schema)
146+-- createComplex = createTypeCompositeFrom @Complex #complex
147+-- in
148+-- printSQL createComplex
149+-- :}
150+-- CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);
151+createTypeCompositeFrom
152+ :: forall hask sch ty schemas schema.
153+ ( SOP.All (FieldTyped schemas) (RowPG hask)
154+ , KnownSymbol ty
155+ , Has sch schemas schema )
156+ => QualifiedAlias sch ty
157+ -- ^ name of the user defined composite type
158+ -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)
159+createTypeCompositeFrom ty = createTypeComposite ty
160+ (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype
161+ :: NP (Aliased (TypeExpression schemas)) (RowPG hask))
162+
163+{-|
164+`createDomain` creates a new domain. A domain is essentially a data type
165+with constraints (restrictions on the allowed set of values).
166+
167+Domains are useful for abstracting common constraints on fields
168+into a single location for maintenance. For example, several tables might
169+contain email address columns, all requiring the same `check` constraint
170+to verify the address syntax. Define a domain rather than setting up
171+each table's constraint individually.
172+
173+>>> :{
174+let
175+ createPositive :: Definition (Public '[]) (Public '["positive" ::: 'Typedef 'PGfloat4])
176+ createPositive = createDomain #positive real (#value .> 0 .&& (#value & isNotNull))
177+in printSQL createPositive
178+:}
179+CREATE DOMAIN "positive" AS real CHECK ((("value" > 0) AND "value" IS NOT NULL));
180+-}
181+createDomain
182+ :: (Has sch schemas schema, KnownSymbol dom)
183+ => QualifiedAlias sch dom
184+ -> (forall null. TypeExpression schemas (null ty))
185+ -> (forall tab. Condition '[] '[] 'Ungrouped schemas '[] '[tab ::: '["value" ::: 'Null ty]])
186+ -> Definition schemas (Alter sch (Create dom ('Typedef ty) schema) schemas)
187+createDomain dom ty condition =
188+ UnsafeDefinition $ "CREATE DOMAIN" <+> renderSQL dom
189+ <+> "AS" <+> renderTypeExpression ty
190+ <+> "CHECK" <+> parenthesized (renderSQL condition) <> ";"
191+
192+{- |
193+>>> :{
194+let
195+ createSmallIntRange :: Definition (Public '[]) (Public '["int2range" ::: 'Typedef ('PGrange 'PGint2)])
196+ createSmallIntRange = createTypeRange #int2range int2
197+in printSQL createSmallIntRange
198+:}
199+CREATE TYPE "int2range" AS RANGE (subtype = int2);
200+-}
201+createTypeRange
202+ :: (Has sch schemas schema, KnownSymbol range)
203+ => QualifiedAlias sch range
204+ -> (forall null. TypeExpression schemas (null ty))
205+ -> Definition schemas (Alter sch (Create range ('Typedef ('PGrange ty)) schema) schemas)
206+createTypeRange range ty = UnsafeDefinition $
207+ "CREATE" <+> "TYPE" <+> renderSQL range <+> "AS" <+> "RANGE" <+>
208+ parenthesized ("subtype" <+> "=" <+> renderTypeExpression ty) <> ";"
209+
210+-- | Drop a type.
211+--
212+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic
213+-- >>> instance SOP.Generic Schwarma
214+-- >>> instance SOP.HasDatatypeInfo Schwarma
215+-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))
216+-- DROP TYPE "schwarma";
217+dropType
218+ :: (Has sch schemas schema, KnownSymbol td)
219+ => QualifiedAlias sch td
220+ -- ^ name of the user defined type
221+ -> Definition schemas (Alter sch (DropSchemum td 'Typedef schema) schemas)
222+dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"
223+
224+dropTypeIfExists
225+ :: (Has sch schemas schema, KnownSymbol td)
226+ => QualifiedAlias sch td
227+ -- ^ name of the user defined type
228+ -> Definition schemas (Alter sch (DropSchemumIfExists td 'Typedef schema) schemas)
229+dropTypeIfExists tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"
squeal-postgresql/src/Squeal/PostgreSQL/Definition/View.hsnew file+104
@@ -0,0 +1,104 @@
1+{-|
2+Module: Squeal.PostgreSQL.Definition.View
3+Description: Create and drop view definitions
4+Copyright: (c) Eitan Chatav, 2017
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Create and drop view definitions.
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , ConstraintKinds
14+ , DeriveAnyClass
15+ , DeriveGeneric
16+ , DerivingStrategies
17+ , FlexibleContexts
18+ , FlexibleInstances
19+ , GADTs
20+ , LambdaCase
21+ , MultiParamTypeClasses
22+ , OverloadedLabels
23+ , OverloadedStrings
24+ , RankNTypes
25+ , ScopedTypeVariables
26+ , TypeApplications
27+ , TypeInType
28+ , TypeOperators
29+ , UndecidableSuperClasses
30+#-}
31+
32+module Squeal.PostgreSQL.Definition.View
33+ ( createView
34+ , createOrReplaceView
35+ , dropView
36+ , dropViewIfExists
37+ ) where
38+
39+import GHC.TypeLits
40+
41+import Squeal.PostgreSQL.Alias
42+import Squeal.PostgreSQL.Definition
43+import Squeal.PostgreSQL.Query
44+import Squeal.PostgreSQL.Render
45+import Squeal.PostgreSQL.Schema
46+
47+-- $setup
48+-- >>> import Squeal.PostgreSQL
49+
50+{- | Create a view.
51+>>> type ABC = '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4]
52+>>> type BC = '["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4]
53+>>> :{
54+let
55+ definition :: Definition
56+ '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC)]]
57+ '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC), "bc" ::: 'View BC]]
58+ definition =
59+ createView #bc (select_ (#b :* #c) (from (table #abc)))
60+in printSQL definition
61+:}
62+CREATE VIEW "bc" AS SELECT "b" AS "b", "c" AS "c" FROM "abc" AS "abc";
63+-}
64+createView
65+ :: (Has sch schemas schema, KnownSymbol vw)
66+ => QualifiedAlias sch vw -- ^ the name of the view to add
67+ -> Query '[] '[] schemas '[] view -- ^ query
68+ -> Definition schemas (Alter sch (Create vw ('View view) schema) schemas)
69+createView alias query = UnsafeDefinition $
70+ "CREATE" <+> "VIEW" <+> renderSQL alias <+> "AS"
71+ <+> renderQuery query <> ";"
72+
73+createOrReplaceView
74+ :: (Has sch schemas schema, KnownSymbol vw)
75+ => QualifiedAlias sch vw -- ^ the name of the view to add
76+ -> Query '[] '[] schemas '[] view -- ^ query
77+ -> Definition schemas (Alter sch (CreateOrReplace vw ('View view) schema) schemas)
78+createOrReplaceView alias query = UnsafeDefinition $
79+ "CREATE OR REPLACE VIEW" <+> renderSQL alias <+> "AS"
80+ <+> renderQuery query <> ";"
81+
82+-- | Drop a view.
83+--
84+-- >>> :{
85+-- let
86+-- definition :: Definition
87+-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])
88+-- , "bc" ::: 'View ('["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4])]]
89+-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])]]
90+-- definition = dropView #bc
91+-- in printSQL definition
92+-- :}
93+-- DROP VIEW "bc";
94+dropView
95+ :: (Has sch schemas schema, KnownSymbol vw)
96+ => QualifiedAlias sch vw -- ^ view to remove
97+ -> Definition schemas (Alter sch (DropSchemum vw 'View schema) schemas)
98+dropView vw = UnsafeDefinition $ "DROP VIEW" <+> renderSQL vw <> ";"
99+
100+dropViewIfExists
101+ :: (Has sch schemas schema, KnownSymbol vw)
102+ => QualifiedAlias sch vw -- ^ view to remove
103+ -> Definition schemas (Alter sch (DropIfExists vw schema) schemas)
104+dropViewIfExists vw = UnsafeDefinition $ "DROP VIEW IF EXISTS" <+> renderSQL vw <> ";"
squeal-postgresql/src/Squeal/PostgreSQL/Expression.hs+101−348
@@ -1,14 +1,13 @@
11{-|
22Module: Squeal.PostgreSQL.Expression
33Description: Squeal expressions
4−Copyright: (c) Eitan Chatav, 2017
4+Copyright: (c) Eitan Chatav, 2019
55Maintainer: eitan@morphism.tech
66Stability: experimental
77
88Squeal expressions are the atoms used to build statements.
99-}
1010
11−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
1211{-# LANGUAGE
1312 AllowAmbiguousTypes
1413 , ConstraintKinds
@@ -35,94 +34,48 @@ module Squeal.PostgreSQL.Expression
3534 ( -- * Expression
3635 Expression (..)
3736 , Expr
38− , (:-->)
37+ , type (-->)
38+ , FunctionDB
3939 , unsafeFunction
40− , unsafeUnaryOpL
41− , unsafeUnaryOpR
40+ , function
41+ , unsafeLeftOp
42+ , leftOp
43+ , unsafeRightOp
44+ , rightOp
4245 , Operator
46+ , OperatorDB
4347 , unsafeBinaryOp
48+ , binaryOp
4449 , FunctionVar
4550 , unsafeFunctionVar
46− , FunctionN
51+ , type (--->)
52+ , FunctionNDB
4753 , unsafeFunctionN
48− , Literal (..)
49− , HasParameter (parameter)
50− , param
54+ , functionN
5155 , PGSubset (..)
52− -- * Types
53− , TypeExpression (..)
54− , cast
55− , PGTyped (..)
56− , typedef
57− , typetable
58− , typeview
59− , bool
60− , int2
61− , smallint
62− , int4
63− , int
64− , integer
65− , int8
66− , bigint
67− , numeric
68− , float4
69− , real
70− , float8
71− , doublePrecision
72− , money
73− , text
74− , char
75− , character
76− , varchar
77− , characterVarying
78− , bytea
79− , timestamp
80− , timestampWithTimeZone
81− , date
82− , time
83− , timeWithTimeZone
84− , interval
85− , uuid
86− , inet
87− , json
88− , jsonb
89− , vararray
90− , fixarray
91− , tsvector
92− , tsquery
56+ , PGIntersect (..)
9357 -- * Re-export
9458 , (&)
9559 , K (..)
60+ , unK
9661 ) where
9762
9863import Control.Category
9964import Control.DeepSeq
10065import Data.ByteString (ByteString)
101−import Data.ByteString.Lazy (toStrict)
102−import ByteString.StrictBuilder (builderBytes)
10366import Data.Function ((&))
10467import Data.Semigroup hiding (All)
105−import qualified Data.Aeson as JSON
106−import Data.Int
10768import Data.String
108−import Data.Text (Text)
10969import Generics.SOP hiding (All, from)
11070import GHC.OverloadedLabels
11171import GHC.TypeLits
11272import Numeric
11373import Prelude hiding (id, (.))
11474
115−import qualified Data.ByteString as ByteString
116−import qualified Data.Text as Text
117−import qualified Data.Text.Lazy as Lazy (Text)
118−import qualified Data.Text.Lazy as Lazy.Text
11975import qualified GHC.Generics as GHC
120−import qualified Generics.SOP as SOP
12176
12277import Squeal.PostgreSQL.Alias
123−import Squeal.PostgreSQL.Binary
12478import Squeal.PostgreSQL.List
125−import Squeal.PostgreSQL.PG
12679import Squeal.PostgreSQL.Render
12780import Squeal.PostgreSQL.Schema
12881
@@ -138,7 +91,7 @@ such as in the target `Squeal.PostgreSQL.Query.List` of the
13891`Squeal.PostgreSQL.Query.select` command,
13992as new column values in `Squeal.PostgreSQL.Manipulation.insertRow` or
14093`Squeal.PostgreSQL.Manipulation.update`,
141−or in search `Condition`s in a number of commands.
94+or in search `Squeal.PostgreSQL.Logic.Condition`s in a number of commands.
14295
14396The expression syntax allows the calculation of
14497values from primitive expression using arithmetic, logical,
@@ -172,7 +125,7 @@ instance RenderSQL (Expression outer commons grp schemas params from ty) where
172125 renderSQL = renderExpression
173126
174127-- | An `Expr` is a closed `Expression`.
175−-- It is a F`RankNType` but don't be scared.
128+-- It is a F@RankNType@ but don't be scared.
176129-- Think of it as an expression which sees no
177130-- namespaces, so you can't use parameters
178131-- or alias references. It can be used as
@@ -182,7 +135,7 @@ type Expr x
182135 . Expression outer commons grp schemas params from x
183136 -- ^ cannot reference aliases
184137
185−-- | A `RankNType` for binary operators.
138+-- | A @RankNType@ for binary operators.
186139type Operator x1 x2 y
187140 = forall outer commons grp schemas params from
188141 . Expression outer commons grp schemas params from x1
@@ -192,32 +145,55 @@ type Operator x1 x2 y
192145 -> Expression outer commons grp schemas params from y
193146 -- ^ output
194147
195−-- | A `RankNType` for functions with a single argument.
148+type OperatorDB schemas x1 x2 y
149+ = forall outer commons grp params from
150+ . Expression outer commons grp schemas params from x1
151+ -- ^ left input
152+ -> Expression outer commons grp schemas params from x2
153+ -- ^ right input
154+ -> Expression outer commons grp schemas params from y
155+ -- ^ output
156+
157+-- | A @RankNType@ for functions with a single argument.
196158-- These could be either function calls or unary operators.
197159-- This is a subtype of the usual Haskell function type `Prelude.->`,
198160-- indeed a subcategory as it is closed under the usual
199161-- `Prelude..` and `Prelude.id`.
200−type (:-->) x y
162+type (-->) x y
201163 = forall outer commons grp schemas params from
202164 . Expression outer commons grp schemas params from x
203165 -- ^ input
204166 -> Expression outer commons grp schemas params from y
205167 -- ^ output
206168
207−{- | A `RankNType` for functions with a fixed-length list of heterogeneous arguments.
169+type FunctionDB schemas x y
170+ = forall outer commons grp params from
171+ . Expression outer commons grp schemas params from x
172+ -- ^ input
173+ -> Expression outer commons grp schemas params from y
174+ -- ^ output
175+
176+{- | A @RankNType@ for functions with a fixed-length list of heterogeneous arguments.
208177Use the `*:` operator to end your argument lists, like so.
209178
210179>>> printSQL (unsafeFunctionN "fun" (true :* false :* localTime *: true))
211180fun(TRUE, FALSE, LOCALTIME, TRUE)
212181-}
213−type FunctionN xs y
182+type (--->) xs y
214183 = forall outer commons grp schemas params from
215184 . NP (Expression outer commons grp schemas params from) xs
216185 -- ^ inputs
217186 -> Expression outer commons grp schemas params from y
218187 -- ^ output
219188
220−{- | A `RankNType` for functions with a variable-length list of
189+type FunctionNDB schemas xs y
190+ = forall outer commons grp params from
191+ . NP (Expression outer commons grp schemas params from) xs
192+ -- ^ inputs
193+ -> Expression outer commons grp schemas params from y
194+ -- ^ output
195+
196+{- | A @RankNType@ for functions with a variable-length list of
221197homogeneous arguments and at least 1 more argument.
222198-}
223199type FunctionVar x0 x1 y
@@ -236,46 +212,6 @@ unsafeFunctionVar :: ByteString -> FunctionVar x0 x1 y
236212unsafeFunctionVar fun xs x = UnsafeExpression $ fun <> parenthesized
237213 (commaSeparated (renderSQL <$> xs) <> ", " <> renderSQL x)
238214
239−{- | A `HasParameter` constraint is used to indicate a value that is
240−supplied externally to a SQL statement.
241−`Squeal.PostgreSQL.PQ.manipulateParams`,
242−`Squeal.PostgreSQL.PQ.queryParams` and
243−`Squeal.PostgreSQL.PQ.traversePrepared` support specifying data values
244−separately from the SQL command string, in which case `param`s are used to
245−refer to the out-of-line data values.
246−-}
247−class KnownNat n => HasParameter
248− (n :: Nat)
249− (params :: [NullityType])
250− (ty :: NullityType)
251− | n params -> ty where
252− -- | `parameter` takes a `Nat` using type application and a `TypeExpression`.
253− --
254− -- >>> let expr = parameter @1 int4 :: Expression outer '[] grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)
255− -- >>> printSQL expr
256− -- ($1 :: int4)
257− parameter
258− :: TypeExpression schemas ty
259− -> Expression outer commons grp schemas params from ty
260− parameter ty = UnsafeExpression $ parenthesized $
261− "$" <> renderNat @n <+> "::"
262− <+> renderSQL ty
263−instance {-# OVERLAPPING #-} HasParameter 1 (ty1:tys) ty1
264−instance {-# OVERLAPPABLE #-} (KnownNat n, HasParameter (n-1) params ty)
265− => HasParameter n (ty' : params) ty
266−
267−-- | `param` takes a `Nat` using type application and for basic types,
268−-- infers a `TypeExpression`.
269−--
270−-- >>> let expr = param @1 :: Expression outer commons grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)
271−-- >>> printSQL expr
272−-- ($1 :: int4)
273−param
274− :: forall n outer commons schemas params from grp ty
275− . (PGTyped schemas ty, HasParameter n params ty)
276− => Expression outer commons grp schemas params from ty -- ^ param
277−param = parameter @n (pgtype @schemas)
278−
279215instance (HasUnique tab (Join outer from) row, Has col row ty)
280216 => IsLabel col (Expression outer commons 'Ungrouped schemas params from ty) where
281217 fromLabel = UnsafeExpression $ renderSQL (Alias @col)
@@ -382,28 +318,63 @@ unsafeBinaryOp :: ByteString -> Operator ty0 ty1 ty2
382318unsafeBinaryOp op x y = UnsafeExpression $ parenthesized $
383319 renderSQL x <+> op <+> renderSQL y
384320
385−-- | >>> printSQL $ unsafeUnaryOpL "NOT" true
321+binaryOp
322+ :: forall op sch schemas schema x y z.
323+ ( Has sch schemas schema
324+ , Has op schema ('Operator ('BinaryOp x y z)) )
325+ => OperatorDB schemas x y z
326+binaryOp = unsafeBinaryOp $ renderSymbol @op
327+
328+-- | >>> printSQL $ unsafeLeftOp "NOT" true
386329-- (NOT TRUE)
387−unsafeUnaryOpL :: ByteString -> x :--> y
388−unsafeUnaryOpL op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x
330+unsafeLeftOp :: ByteString -> x --> y
331+unsafeLeftOp op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x
389332
390−-- | >>> printSQL $ true & unsafeUnaryOpR "IS NOT TRUE"
333+leftOp
334+ :: forall op sch schemas schema x y.
335+ ( Has sch schemas schema
336+ , Has op schema ('Operator ('LeftOp x y)) )
337+ => FunctionDB schemas x y
338+leftOp = unsafeLeftOp $ renderSymbol @op
339+
340+-- | >>> printSQL $ true & unsafeRightOp "IS NOT TRUE"
391341-- (TRUE IS NOT TRUE)
392−unsafeUnaryOpR :: ByteString -> x :--> y
393−unsafeUnaryOpR op x = UnsafeExpression $ parenthesized $ renderSQL x <+> op
342+unsafeRightOp :: ByteString -> x --> y
343+unsafeRightOp op x = UnsafeExpression $ parenthesized $ renderSQL x <+> op
344+
345+rightOp
346+ :: forall op sch schemas schema x y.
347+ ( Has sch schemas schema
348+ , Has op schema ('Operator ('RightOp x y)) )
349+ => FunctionDB schemas x y
350+rightOp = unsafeRightOp $ renderSymbol @op
394351
395352-- | >>> printSQL $ unsafeFunction "f" true
396353-- f(TRUE)
397−unsafeFunction :: ByteString -> x :--> y
354+unsafeFunction :: ByteString -> x --> y
398355unsafeFunction fun x = UnsafeExpression $
399356 fun <> parenthesized (renderSQL x)
400357
358+function
359+ :: (Has sch schemas schema, Has fun schema ('Function ('[x] :=> 'Returns y)))
360+ => QualifiedAlias sch fun
361+ -> FunctionDB schemas x y
362+function = unsafeFunction . renderSQL
363+
401364-- | >>> printSQL $ unsafeFunctionN "f" (currentTime :* localTimestamp :* false *: literal 'a')
402365-- f(CURRENT_TIME, LOCALTIMESTAMP, FALSE, E'a')
403−unsafeFunctionN :: SListI xs => ByteString -> FunctionN xs y
366+unsafeFunctionN :: SListI xs => ByteString -> xs ---> y
404367unsafeFunctionN fun xs = UnsafeExpression $
405368 fun <> parenthesized (renderCommaSeparated renderSQL xs)
406369
370+functionN
371+ :: ( Has sch schemas schema
372+ , Has fun schema ('Function (xs :=> 'Returns y))
373+ , SListI xs )
374+ => QualifiedAlias sch fun
375+ -> FunctionNDB schemas xs y
376+functionN = unsafeFunctionN . renderSQL
377+
407378instance ty `In` PGNum
408379 => Num (Expression outer commons grp schemas params from (null ty)) where
409380 (+) = unsafeBinaryOp "+"
@@ -448,33 +419,22 @@ instance (ty `In` PGNum, ty `In` PGFloating) => Floating
448419 acosh x = log (x + sqrt (x*x - 1))
449420 atanh x = log ((1 + x) / (1 - x)) / 2
450421
451−class PGSubset container where
452− (@>) :: Operator (null0 container) (null1 container) ('Null 'PGbool)
422+-- | Contained by operators
423+class PGSubset ty where
424+ (@>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)
453425 (@>) = unsafeBinaryOp "@>"
454− (<@) :: Operator (null0 container) (null1 container) ('Null 'PGbool)
426+ (<@) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)
455427 (<@) = unsafeBinaryOp "<@"
456428instance PGSubset 'PGjsonb
457429instance PGSubset 'PGtsquery
458430instance PGSubset ('PGvararray ty)
431+instance PGSubset ('PGrange ty)
459432
460−-- When a `cast` is applied to an `Expression` of a known type, it
461−-- represents a run-time type conversion. The cast will succeed only if a
462−-- suitable type conversion operation has been defined.
463−--
464−-- | >>> printSQL $ true & cast int4
465−-- (TRUE :: int4)
466−cast
467− :: TypeExpression schemas ty1
468− -- ^ type to cast as
469− -> Expression outer commons grp schemas params from ty0
470− -- ^ value to convert
471− -> Expression outer commons grp schemas params from ty1
472−cast ty x = UnsafeExpression $ parenthesized $
473− renderSQL x <+> "::" <+> renderSQL ty
474−
475−{-----------------------------------------
476−text
477−-----------------------------------------}
433+class PGIntersect ty where
434+ (@&&) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)
435+ (@&&) = unsafeBinaryOp "&&"
436+instance PGIntersect ('PGvararray ty)
437+instance PGIntersect ('PGrange ty)
478438
479439instance IsString
480440 (Expression outer commons grp schemas params from (null 'PGtext)) where
@@ -482,11 +442,11 @@ instance IsString
482442 "E\'" <> fromString (escape =<< str) <> "\'"
483443instance IsString
484444 (Expression outer commons grp schemas params from (null 'PGtsvector)) where
485− fromString str = cast tsvector . UnsafeExpression $
445+ fromString str = UnsafeExpression . parenthesized . (<> " :: tsvector") $
486446 "E\'" <> fromString (escape =<< str) <> "\'"
487447instance IsString
488448 (Expression outer commons grp schemas params from (null 'PGtsquery)) where
489− fromString str = cast tsquery . UnsafeExpression $
449+ fromString str = UnsafeExpression . parenthesized . (<> " :: tsquery") $
490450 "E\'" <> fromString (escape =<< str) <> "\'"
491451
492452instance Semigroup
@@ -510,210 +470,3 @@ instance Monoid
510470 (Expression outer commons grp schemas params from (null 'PGtsvector)) where
511471 mempty = fromString ""
512472 mappend = (<>)
513−
514−{-----------------------------------------
515−type expressions
516−-----------------------------------------}
517−
518−-- | `TypeExpression`s are used in `cast`s and
519−-- `Squeal.PostgreSQL.Definition.createTable` commands.
520−newtype TypeExpression (schemas :: SchemasType) (ty :: NullityType)
521− = UnsafeTypeExpression { renderTypeExpression :: ByteString }
522− deriving (GHC.Generic,Show,Eq,Ord,NFData)
523−instance RenderSQL (TypeExpression schemas ty) where
524− renderSQL = renderTypeExpression
525−
526−-- | The enum or composite type in a `Typedef` can be expressed by its alias.
527−typedef
528− :: (Has sch schemas schema, Has td schema ('Typedef ty))
529− => QualifiedAlias sch td
530− -> TypeExpression schemas (null ty)
531−typedef = UnsafeTypeExpression . renderSQL
532−
533−-- | The composite type corresponding to a `Table` definition can be expressed
534−-- by its alias.
535−typetable
536− :: (Has sch schemas schema, Has tab schema ('Table table))
537− => QualifiedAlias sch tab
538− -> TypeExpression schemas (null ('PGcomposite (TableToRow table)))
539−typetable = UnsafeTypeExpression . renderSQL
540−
541−-- | The composite type corresponding to a `View` definition can be expressed
542−-- by its alias.
543−typeview
544− :: (Has sch schemas schema, Has vw schema ('View view))
545− => QualifiedAlias sch vw
546− -> TypeExpression schemas (null ('PGcomposite view))
547−typeview = UnsafeTypeExpression . renderSQL
548−
549−-- | logical Boolean (true/false)
550−bool :: TypeExpression schemas (null 'PGbool)
551−bool = UnsafeTypeExpression "bool"
552−-- | signed two-byte integer
553−int2, smallint :: TypeExpression schemas (null 'PGint2)
554−int2 = UnsafeTypeExpression "int2"
555−smallint = UnsafeTypeExpression "smallint"
556−-- | signed four-byte integer
557−int4, int, integer :: TypeExpression schemas (null 'PGint4)
558−int4 = UnsafeTypeExpression "int4"
559−int = UnsafeTypeExpression "int"
560−integer = UnsafeTypeExpression "integer"
561−-- | signed eight-byte integer
562−int8, bigint :: TypeExpression schemas (null 'PGint8)
563−int8 = UnsafeTypeExpression "int8"
564−bigint = UnsafeTypeExpression "bigint"
565−-- | arbitrary precision numeric type
566−numeric :: TypeExpression schemas (null 'PGnumeric)
567−numeric = UnsafeTypeExpression "numeric"
568−-- | single precision floating-point number (4 bytes)
569−float4, real :: TypeExpression schemas (null 'PGfloat4)
570−float4 = UnsafeTypeExpression "float4"
571−real = UnsafeTypeExpression "real"
572−-- | double precision floating-point number (8 bytes)
573−float8, doublePrecision :: TypeExpression schemas (null 'PGfloat8)
574−float8 = UnsafeTypeExpression "float8"
575−doublePrecision = UnsafeTypeExpression "double precision"
576−-- | currency amount
577−money :: TypeExpression schema (null 'PGmoney)
578−money = UnsafeTypeExpression "money"
579−-- | variable-length character string
580−text :: TypeExpression schemas (null 'PGtext)
581−text = UnsafeTypeExpression "text"
582−-- | fixed-length character string
583−char, character
584− :: forall n schemas null. (KnownNat n, 1 <= n)
585− => TypeExpression schemas (null ('PGchar n))
586−char = UnsafeTypeExpression $ "char(" <> renderNat @n <> ")"
587−character = UnsafeTypeExpression $ "character(" <> renderNat @n <> ")"
588−-- | variable-length character string
589−varchar, characterVarying
590− :: forall n schemas null. (KnownNat n, 1 <= n)
591− => TypeExpression schemas (null ('PGvarchar n))
592−varchar = UnsafeTypeExpression $ "varchar(" <> renderNat @n <> ")"
593−characterVarying = UnsafeTypeExpression $
594− "character varying(" <> renderNat @n <> ")"
595−-- | binary data ("byte array")
596−bytea :: TypeExpression schemas (null 'PGbytea)
597−bytea = UnsafeTypeExpression "bytea"
598−-- | date and time (no time zone)
599−timestamp :: TypeExpression schemas (null 'PGtimestamp)
600−timestamp = UnsafeTypeExpression "timestamp"
601−-- | date and time, including time zone
602−timestampWithTimeZone :: TypeExpression schemas (null 'PGtimestamptz)
603−timestampWithTimeZone = UnsafeTypeExpression "timestamp with time zone"
604−-- | calendar date (year, month, day)
605−date :: TypeExpression schemas (null 'PGdate)
606−date = UnsafeTypeExpression "date"
607−-- | time of day (no time zone)
608−time :: TypeExpression schemas (null 'PGtime)
609−time = UnsafeTypeExpression "time"
610−-- | time of day, including time zone
611−timeWithTimeZone :: TypeExpression schemas (null 'PGtimetz)
612−timeWithTimeZone = UnsafeTypeExpression "time with time zone"
613−-- | time span
614−interval :: TypeExpression schemas (null 'PGinterval)
615−interval = UnsafeTypeExpression "interval"
616−-- | universally unique identifier
617−uuid :: TypeExpression schemas (null 'PGuuid)
618−uuid = UnsafeTypeExpression "uuid"
619−-- | IPv4 or IPv6 host address
620−inet :: TypeExpression schemas (null 'PGinet)
621−inet = UnsafeTypeExpression "inet"
622−-- | textual JSON data
623−json :: TypeExpression schemas (null 'PGjson)
624−json = UnsafeTypeExpression "json"
625−-- | binary JSON data, decomposed
626−jsonb :: TypeExpression schemas (null 'PGjsonb)
627−jsonb = UnsafeTypeExpression "jsonb"
628−-- | variable length array
629−vararray
630− :: TypeExpression schemas pg
631− -> TypeExpression schemas (null ('PGvararray pg))
632−vararray ty = UnsafeTypeExpression $ renderSQL ty <> "[]"
633−-- | fixed length array
634−--
635−-- >>> renderSQL (fixarray @'[2] json)
636−-- "json[2]"
637−fixarray
638− :: forall dims schemas null pg. SOP.All KnownNat dims
639− => TypeExpression schemas pg
640− -> TypeExpression schemas (null ('PGfixarray dims pg))
641−fixarray ty = UnsafeTypeExpression $
642− renderSQL ty <> renderDims @dims
643− where
644− renderDims :: forall ns. SOP.All KnownNat ns => ByteString
645− renderDims =
646− ("[" <>)
647− . (<> "]")
648− . ByteString.intercalate "]["
649− . hcollapse
650− $ hcmap (SOP.Proxy @KnownNat)
651− (K . fromString . show . natVal)
652− (hpure SOP.Proxy :: NP SOP.Proxy ns)
653−tsvector :: TypeExpression schemas (null 'PGtsvector)
654−tsvector = UnsafeTypeExpression "tsvector"
655−tsquery :: TypeExpression schemas (null 'PGtsquery)
656−tsquery = UnsafeTypeExpression "tsquery"
657−
658−-- | `pgtype` is a demoted version of a `PGType`
659−class PGTyped schemas (ty :: NullityType) where
660− pgtype :: TypeExpression schemas ty
661−instance PGTyped schemas (null 'PGbool) where pgtype = bool
662−instance PGTyped schemas (null 'PGint2) where pgtype = int2
663−instance PGTyped schemas (null 'PGint4) where pgtype = int4
664−instance PGTyped schemas (null 'PGint8) where pgtype = int8
665−instance PGTyped schemas (null 'PGnumeric) where pgtype = numeric
666−instance PGTyped schemas (null 'PGfloat4) where pgtype = float4
667−instance PGTyped schemas (null 'PGfloat8) where pgtype = float8
668−instance PGTyped schemas (null 'PGmoney) where pgtype = money
669−instance PGTyped schemas (null 'PGtext) where pgtype = text
670−instance (KnownNat n, 1 <= n)
671− => PGTyped schemas (null ('PGchar n)) where pgtype = char @n
672−instance (KnownNat n, 1 <= n)
673− => PGTyped schemas (null ('PGvarchar n)) where pgtype = varchar @n
674−instance PGTyped schemas (null 'PGbytea) where pgtype = bytea
675−instance PGTyped schemas (null 'PGtimestamp) where pgtype = timestamp
676−instance PGTyped schemas (null 'PGtimestamptz) where pgtype = timestampWithTimeZone
677−instance PGTyped schemas (null 'PGdate) where pgtype = date
678−instance PGTyped schemas (null 'PGtime) where pgtype = time
679−instance PGTyped schemas (null 'PGtimetz) where pgtype = timeWithTimeZone
680−instance PGTyped schemas (null 'PGinterval) where pgtype = interval
681−instance PGTyped schemas (null 'PGuuid) where pgtype = uuid
682−instance PGTyped schemas (null 'PGjson) where pgtype = json
683−instance PGTyped schemas (null 'PGjsonb) where pgtype = jsonb
684−instance PGTyped schemas ty
685− => PGTyped schemas (null ('PGvararray ty)) where
686− pgtype = vararray (pgtype @schemas @ty)
687−instance (SOP.All KnownNat dims, PGTyped schemas ty)
688− => PGTyped schemas (null ('PGfixarray dims ty)) where
689− pgtype = fixarray @dims (pgtype @schemas @ty)
690−instance PGTyped schemas (null 'PGtsvector) where pgtype = tsvector
691−instance PGTyped schemas (null 'PGtsquery) where pgtype = tsquery
692−
693−class Literal hask where
694− literal :: hask -> Expr (null (PG hask))
695−instance JSON.ToJSON hask => Literal (Json hask) where
696− literal = cast json . UnsafeExpression
697− . singleQuotedUtf8 . toStrict . JSON.encode . getJson
698−instance JSON.ToJSON hask => Literal (Jsonb hask) where
699− literal = cast jsonb . UnsafeExpression
700− . singleQuotedUtf8 . toStrict . JSON.encode . getJsonb
701−instance Literal Char where
702− literal chr = UnsafeExpression $
703− "E\'" <> fromString (escape chr) <> "\'"
704−instance Literal String where literal = fromString
705−instance Literal Int16 where literal = fromIntegral
706−instance Literal Int32 where literal = fromIntegral
707−instance Literal Int64 where literal = fromIntegral
708−instance Literal Float where literal = fromRational . toRational
709−instance Literal Double where literal = fromRational . toRational
710−instance Literal Text where literal = fromString . Text.unpack
711−instance Literal Lazy.Text where literal = fromString . Lazy.Text.unpack
712−instance ToParam (Enumerated enum) (PG (Enumerated enum))
713− => Literal (Enumerated enum) where
714− literal
715− = UnsafeExpression
716− . singleQuotedUtf8
717− . builderBytes
718− . unK
719− . toParam @(Enumerated enum) @(PG (Enumerated enum))
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Aggregate.hs+37−5
@@ -1,3 +1,13 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Aggregate
3+Description: Aggregate functions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Aggregate functions
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , DeriveGeneric
@@ -16,6 +26,7 @@
1626module Squeal.PostgreSQL.Expression.Aggregate
1727 ( Aggregate (..)
1828 , Distinction (..)
29+ , PGSum
1930 , PGAvg
2031 ) where
2132
@@ -39,7 +50,7 @@ import Squeal.PostgreSQL.Schema
3950{- |
4051`Aggregate` functions compute a single result from a set of input values.
4152`Aggregate` functions can be used as `GroupedBy` `Expression`s as well
42−as `WindowFunction`s.
53+as `Squeal.PostgreSQL.Expression.Window.WindowFunction`s.
4354-}
4455class Aggregate expr1 exprN aggr
4556 | aggr -> expr1, aggr -> exprN where
@@ -69,15 +80,14 @@ class Aggregate expr1 exprN aggr
6980
7081 -- | >>> :{
7182 -- let
72− -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('NotNull 'PGnumeric)
83+ -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('Null 'PGnumeric)
7384 -- expression = sum_ (Distinct #col)
7485 -- in printSQL expression
7586 -- :}
7687 -- sum(DISTINCT "col")
7788 sum_
78− :: ty `In` PGNum
79− => expr1 (null ty)
80− -> aggr ('NotNull ty)
89+ :: expr1 (null ty)
90+ -> aggr ('Null (PGSum ty))
8191
8292 -- | input values, including nulls, concatenated into an array
8393 arrayAgg
@@ -96,6 +106,7 @@ class Aggregate expr1 exprN aggr
96106
97107 {- |
98108 the bitwise AND of all non-null input values, or null if none
109+
99110 >>> :{
100111 let
101112 expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)
@@ -194,6 +205,7 @@ class Aggregate expr1 exprN aggr
194205 -> aggr ('Null (PGAvg ty))
195206
196207 {- | correlation coefficient
208+
197209 >>> :{
198210 let
199211 expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)
@@ -207,6 +219,7 @@ class Aggregate expr1 exprN aggr
207219 -> aggr ('Null 'PGfloat8)
208220
209221 {- | population covariance
222+
210223 >>> :{
211224 let
212225 expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)
@@ -220,6 +233,7 @@ class Aggregate expr1 exprN aggr
220233 -> aggr ('Null 'PGfloat8)
221234
222235 {- | sample covariance
236+
223237 >>> :{
224238 let
225239 winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)
@@ -233,6 +247,7 @@ class Aggregate expr1 exprN aggr
233247 -> aggr ('Null 'PGfloat8)
234248
235249 {- | average of the independent variable (sum(X)/N)
250+
236251 >>> :{
237252 let
238253 expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)
@@ -246,6 +261,7 @@ class Aggregate expr1 exprN aggr
246261 -> aggr ('Null 'PGfloat8)
247262
248263 {- | average of the dependent variable (sum(Y)/N)
264+
249265 >>> :{
250266 let
251267 winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)
@@ -259,6 +275,7 @@ class Aggregate expr1 exprN aggr
259275 -> aggr ('Null 'PGfloat8)
260276
261277 {- | number of input rows in which both expressions are nonnull
278+
262279 >>> :{
263280 let
264281 winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGint8)
@@ -417,6 +434,21 @@ unsafeAggregateN
417434 -> Expression outer commons ('Grouped bys) schemas params from y
418435unsafeAggregateN fun xs = UnsafeExpression $ fun <> parenthesized (renderSQL xs)
419436
437+-- | A type family that calculates `PGSum``PGType` of
438+-- a given argument `PGType`.
439+type family PGSum ty where
440+ PGSum 'PGint2 = 'PGint8
441+ PGSum 'PGint4 = 'PGint8
442+ PGSum 'PGint8 = 'PGnumeric
443+ PGSum 'PGfloat4 = 'PGfloat4
444+ PGSum 'PGfloat8 = 'PGfloat8
445+ PGSum 'PGnumeric = 'PGnumeric
446+ PGSum 'PGinterval = 'PGinterval
447+ PGSum 'PGmoney = 'PGmoney
448+ PGSum pg = TypeError
449+ ( 'Text "Squeal type error: Cannot sum with argument type "
450+ ':<>: 'ShowType pg )
451+
420452-- | A type family that calculates `PGAvg` type of a `PGType`.
421453type family PGAvg ty where
422454 PGAvg 'PGint2 = 'PGnumeric
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Collection.hs+19−2
@@ -1,9 +1,20 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Collection
3+Description: Array and composite functions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Array and composite functions
9+-}
10+
111{-# LANGUAGE
212 AllowAmbiguousTypes
313 , DataKinds
414 , FlexibleContexts
515 , FlexibleInstances
616 , MultiParamTypeClasses
17+ , OverloadedLabels
718 , OverloadedStrings
819 , RankNTypes
920 , ScopedTypeVariables
@@ -19,6 +30,7 @@ module Squeal.PostgreSQL.Expression.Collection
1930 , array2
2031 , cardinality
2132 , index
33+ , unnest
2234 , row
2335 , field
2436 ) where
@@ -30,6 +42,7 @@ import qualified Generics.SOP as SOP
3042
3143import Squeal.PostgreSQL.Alias
3244import Squeal.PostgreSQL.Expression
45+import Squeal.PostgreSQL.Expression.Set
3346import Squeal.PostgreSQL.List
3447import Squeal.PostgreSQL.Render
3548import Squeal.PostgreSQL.Schema
@@ -98,17 +111,21 @@ array2 xss = UnsafeExpression $ "ARRAY" <>
98111
99112-- | >>> printSQL $ cardinality (array [null_, false, true])
100113-- cardinality(ARRAY[NULL, FALSE, TRUE])
101−cardinality :: null ('PGvararray ty) :--> null 'PGint8
114+cardinality :: null ('PGvararray ty) --> null 'PGint8
102115cardinality = unsafeFunction "cardinality"
103116
104117-- | >>> printSQL $ array [null_, false, true] & index 2
105118-- (ARRAY[NULL, FALSE, TRUE])[2]
106119index
107120 :: Word64 -- ^ index
108− -> null ('PGvararray ty) :--> NullifyType ty
121+ -> null ('PGvararray ty) --> NullifyType ty
109122index n expr = UnsafeExpression $
110123 parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"
111124
125+-- | Expand an array to a set of rows
126+unnest :: SetFunction "unnest" (null ('PGvararray ty)) '["unnest" ::: ty]
127+unnest = unsafeSetFunction
128+
112129-- | A row constructor is an expression that builds a row value
113130-- (also called a composite value) using values for its member fields.
114131--
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Comparison.hs+48−40
@@ -1,5 +1,16 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Comparison
3+Description: Comparison expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Comparison functions and operators
9+-}
10+
111{-# LANGUAGE
212 OverloadedStrings
13+ , RankNTypes
314 , TypeInType
415 , TypeOperators
516#-}
@@ -13,6 +24,7 @@ module Squeal.PostgreSQL.Expression.Comparison
1324 , (.>)
1425 , greatest
1526 , least
27+ , BetweenExpr
1628 , between
1729 , notBetween
1830 , betweenSymmetric
@@ -27,6 +39,8 @@ module Squeal.PostgreSQL.Expression.Comparison
2739 , isNotUnknown
2840 ) where
2941
42+import Data.ByteString
43+
3044import Squeal.PostgreSQL.Expression
3145import Squeal.PostgreSQL.Expression.Logic
3246import Squeal.PostgreSQL.Render
@@ -85,53 +99,47 @@ greatest = unsafeFunctionVar "GREATEST"
8599least :: FunctionVar ty ty ty
86100least = unsafeFunctionVar "LEAST"
87101
102+{- |
103+A @RankNType@ for comparison expressions like `between`.
104+-}
105+type BetweenExpr
106+ = forall outer commons grp schemas params from ty
107+ . Expression outer commons grp schemas params from ty
108+ -> ( Expression outer commons grp schemas params from ty
109+ , Expression outer commons grp schemas params from ty ) -- ^ bounds
110+ -> Condition outer commons grp schemas params from
111+
112+unsafeBetweenExpr :: ByteString -> BetweenExpr
113+unsafeBetweenExpr fun a (x,y) = UnsafeExpression $
114+ renderSQL a <+> fun <+> renderSQL x <+> "AND" <+> renderSQL y
115+
88116{- | >>> printSQL $ true `between` (null_, false)
89117TRUE BETWEEN NULL AND FALSE
90118-}
91−between
92− :: Expression outer commons grp schemas params from (null ty)
93− -> ( Expression outer commons grp schemas params from (null ty)
94− , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds
95− -> Condition outer commons grp schemas params from
96−between a (x,y) = UnsafeExpression $ renderSQL a <+> "BETWEEN"
97− <+> renderSQL x <+> "AND" <+> renderSQL y
119+between :: BetweenExpr
120+between = unsafeBetweenExpr "BETWEEN"
98121
99122{- | >>> printSQL $ true `notBetween` (null_, false)
100123TRUE NOT BETWEEN NULL AND FALSE
101124-}
102−notBetween
103− :: Expression outer commons grp schemas params from (null ty)
104− -> ( Expression outer commons grp schemas params from (null ty)
105− , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds
106− -> Condition outer commons grp schemas params from
107−notBetween a (x,y) = UnsafeExpression $ renderSQL a <+> "NOT BETWEEN"
108− <+> renderSQL x <+> "AND" <+> renderSQL y
125+notBetween :: BetweenExpr
126+notBetween = unsafeBetweenExpr "NOT BETWEEN"
109127
110128{- | between, after sorting the comparison values
111129
112130>>> printSQL $ true `betweenSymmetric` (null_, false)
113131TRUE BETWEEN SYMMETRIC NULL AND FALSE
114132-}
115−betweenSymmetric
116− :: Expression outer commons grp schemas params from (null ty)
117− -> ( Expression outer commons grp schemas params from (null ty)
118− , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds
119− -> Condition outer commons grp schemas params from
120−betweenSymmetric a (x,y) = UnsafeExpression $ renderSQL a
121− <+> "BETWEEN SYMMETRIC" <+> renderSQL x <+> "AND" <+> renderSQL y
133+betweenSymmetric :: BetweenExpr
134+betweenSymmetric = unsafeBetweenExpr "BETWEEN SYMMETRIC"
122135
123136{- | not between, after sorting the comparison values
124137
125138>>> printSQL $ true `notBetweenSymmetric` (null_, false)
126139TRUE NOT BETWEEN SYMMETRIC NULL AND FALSE
127140-}
128−notBetweenSymmetric
129− :: Expression outer commons grp schemas params from (null ty)
130− -> ( Expression outer commons grp schemas params from (null ty)
131− , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds
132− -> Condition outer commons grp schemas params from
133−notBetweenSymmetric a (x,y) = UnsafeExpression $ renderSQL a
134− <+> "NOT BETWEEN SYMMETRIC" <+> renderSQL x <+> "AND" <+> renderSQL y
141+notBetweenSymmetric :: BetweenExpr
142+notBetweenSymmetric = unsafeBetweenExpr "NOT BETWEEN SYMMETRIC"
135143
136144{- | not equal, treating null like an ordinary value
137145
@@ -154,45 +162,45 @@ isNotDistinctFrom = unsafeBinaryOp "IS NOT DISTINCT FROM"
154162>>> printSQL $ true & isTrue
155163(TRUE IS TRUE)
156164-}
157−isTrue :: null0 'PGbool :--> null1 'PGbool
158−isTrue = unsafeUnaryOpR "IS TRUE"
165+isTrue :: null0 'PGbool --> null1 'PGbool
166+isTrue = unsafeRightOp "IS TRUE"
159167
160168{- | is false or unknown
161169
162170>>> printSQL $ true & isNotTrue
163171(TRUE IS NOT TRUE)
164172-}
165−isNotTrue :: null0 'PGbool :--> null1 'PGbool
166−isNotTrue = unsafeUnaryOpR "IS NOT TRUE"
173+isNotTrue :: null0 'PGbool --> null1 'PGbool
174+isNotTrue = unsafeRightOp "IS NOT TRUE"
167175
168176{- | is false
169177
170178>>> printSQL $ true & isFalse
171179(TRUE IS FALSE)
172180-}
173−isFalse :: null0 'PGbool :--> null1 'PGbool
174−isFalse = unsafeUnaryOpR "IS FALSE"
181+isFalse :: null0 'PGbool --> null1 'PGbool
182+isFalse = unsafeRightOp "IS FALSE"
175183
176184{- | is true or unknown
177185
178186>>> printSQL $ true & isNotFalse
179187(TRUE IS NOT FALSE)
180188-}
181−isNotFalse :: null0 'PGbool :--> null1 'PGbool
182−isNotFalse = unsafeUnaryOpR "IS NOT FALSE"
189+isNotFalse :: null0 'PGbool --> null1 'PGbool
190+isNotFalse = unsafeRightOp "IS NOT FALSE"
183191
184192{- | is unknown
185193
186194>>> printSQL $ true & isUnknown
187195(TRUE IS UNKNOWN)
188196-}
189−isUnknown :: null0 'PGbool :--> null1 'PGbool
190−isUnknown = unsafeUnaryOpR "IS UNKNOWN"
197+isUnknown :: null0 'PGbool --> null1 'PGbool
198+isUnknown = unsafeRightOp "IS UNKNOWN"
191199
192200{- | is true or false
193201
194202>>> printSQL $ true & isNotUnknown
195203(TRUE IS NOT UNKNOWN)
196204-}
197−isNotUnknown :: null0 'PGbool :--> null1 'PGbool
198−isNotUnknown = unsafeUnaryOpR "IS NOT UNKNOWN"
205+isNotUnknown :: null0 'PGbool --> null1 'PGbool
206+isNotUnknown = unsafeRightOp "IS NOT UNKNOWN"
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Json.hs+227−113
@@ -1,11 +1,27 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Json
3+Description: Json and Jsonb functions and operators
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Json and Jsonb functions and operators
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , FlexibleContexts
414 , FlexibleInstances
15+ , GADTs
16+ , OverloadedLabels
517 , OverloadedStrings
618 , PolyKinds
19+ , RankNTypes
20+ , ScopedTypeVariables
21+ , TypeApplications
722 , TypeOperators
823 , UndecidableInstances
24+ , UndecidableSuperClasses
925#-}
1026
1127module Squeal.PostgreSQL.Expression.Json
@@ -27,19 +43,13 @@ module Squeal.PostgreSQL.Expression.Json
2743 , rowToJson
2844 , jsonBuildArray
2945 , jsonbBuildArray
30− , PGBuildObject
31− , jsonBuildObject
32− , jsonbBuildObject
46+ , JsonBuildObject (..)
3347 , jsonObject
3448 , jsonbObject
3549 , jsonZipObject
3650 , jsonbZipObject
3751 , jsonArrayLength
3852 , jsonbArrayLength
39− , jsonExtractPath
40− , jsonbExtractPath
41− , jsonExtractPathAsText
42− , jsonbExtractPathAsText
4353 , jsonTypeof
4454 , jsonbTypeof
4555 , jsonStripNulls
@@ -47,14 +57,43 @@ module Squeal.PostgreSQL.Expression.Json
4757 , jsonbSet
4858 , jsonbInsert
4959 , jsonbPretty
60+ -- * Json and Jsonb set returning functions
61+ , jsonEach
62+ , jsonbEach
63+ , jsonEachText
64+ , jsonbEachText
65+ , jsonObjectKeys
66+ , jsonbObjectKeys
67+ , JsonPopulateFunction
68+ , jsonPopulateRecord
69+ , jsonbPopulateRecord
70+ , jsonPopulateRecordSet
71+ , jsonbPopulateRecordSet
72+ , JsonToRecordFunction
73+ , jsonToRecord
74+ , jsonbToRecord
75+ , jsonToRecordSet
76+ , jsonbToRecordSet
5077 ) where
5178
79+import Data.ByteString (ByteString)
80+import GHC.TypeLits
81+
82+import Squeal.PostgreSQL.Alias
5283import Squeal.PostgreSQL.Expression
84+import Squeal.PostgreSQL.Expression.Set
85+import Squeal.PostgreSQL.Expression.Type
5386import Squeal.PostgreSQL.List
87+import Squeal.PostgreSQL.Query
88+import Squeal.PostgreSQL.Render
5489import Squeal.PostgreSQL.Schema
5590
5691import qualified Generics.SOP as SOP
5792
93+-- $setup
94+-- >>> import Squeal.PostgreSQL
95+-- >>> import Data.Aeson
96+
5897{-----------------------------------------
5998 -- json and jsonb support
6099
@@ -117,18 +156,18 @@ infixl 9 .?&
117156
118157-- | Delete a key or keys from a JSON object, or remove an array element.
119158--
120−-- If the right operand is..
159+-- If the right operand is
121160--
122−-- @ text @: Delete key/value pair or string element from left operand. Key/value pairs
123−-- are matched based on their key value.
161+-- @ text @: Delete key / value pair or string element from left operand.
162+-- Key / value pairs are matched based on their key value,
124163--
125−-- @ text[] @: Delete multiple key/value pairs or string elements
126−-- from left operand. Key/value pairs are matched based on their key value.
164+-- @ text[] @: Delete multiple key / value pairs or string elements
165+-- from left operand. Key / value pairs are matched based on their key value,
127166--
128167-- @ integer @: Delete the array element with specified index (Negative integers
129168-- count from the end). Throws an error if top level container is not an array.
130169(.-.)
131− :: (key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]) -- hlint error without parens here
170+ :: key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]
132171 => Operator (null 'PGjsonb) (null key) (null 'PGjsonb)
133172infixl 6 .-.
134173(.-.) = unsafeBinaryOp "-"
@@ -149,7 +188,7 @@ Table 9.45: JSON creation functions
149188-- otherwise, a scalar value is produced. For any scalar type other than a
150189-- number, a Boolean, or a null value, the text representation will be used, in
151190-- such a fashion that it is a valid json value.
152−toJson :: null ty :--> null 'PGjson
191+toJson :: null ty --> null 'PGjson
153192toJson = unsafeFunction "to_json"
154193
155194-- | Returns the value as jsonb. Arrays and composites are converted
@@ -158,48 +197,42 @@ toJson = unsafeFunction "to_json"
158197-- otherwise, a scalar value is produced. For any scalar type other than a
159198-- number, a Boolean, or a null value, the text representation will be used, in
160199-- such a fashion that it is a valid jsonb value.
161−toJsonb :: null ty :--> null 'PGjsonb
200+toJsonb :: null ty --> null 'PGjsonb
162201toJsonb = unsafeFunction "to_jsonb"
163202
164203-- | Returns the array as a JSON array. A PostgreSQL multidimensional array
165204-- becomes a JSON array of arrays.
166−arrayToJson :: null ('PGvararray ty) :--> null 'PGjson
205+arrayToJson :: null ('PGvararray ty) --> null 'PGjson
167206arrayToJson = unsafeFunction "array_to_json"
168207
169208-- | Returns the row as a JSON object.
170−rowToJson :: null ('PGcomposite ty) :--> null 'PGjson
209+rowToJson :: null ('PGcomposite ty) --> null 'PGjson
171210rowToJson = unsafeFunction "row_to_json"
172211
173212-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic
174213-- argument list.
175−jsonBuildArray :: SOP.SListI tuple => FunctionN tuple (null 'PGjson)
214+jsonBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjson
176215jsonBuildArray = unsafeFunctionN "json_build_array"
177216
178217-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a
179218-- variadic argument list.
180−jsonbBuildArray :: SOP.SListI tuple => FunctionN tuple (null 'PGjsonb)
219+jsonbBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjsonb
181220jsonbBuildArray = unsafeFunctionN "jsonb_build_array"
182221
183−class PGBuildObject tys where
184−instance PGBuildObject '[]
185−instance (PGBuildObject tys, key `In` PGJsonKey)
186− => PGBuildObject ('NotNull key ': value ': tys)
187−
188222-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic
189223-- argument list. The elements of the argument list must alternate between text
190224-- and values.
191−jsonBuildObject
192− :: (SOP.SListI elems, PGBuildObject elems)
193− => FunctionN elems (null 'PGjson)
194−jsonBuildObject = unsafeFunctionN "json_build_object"
195−
196−-- | Builds a possibly-heterogeneously-typed (binary) JSON object out of a
197−-- variadic argument list. The elements of the argument list must alternate
198−-- between keys and values.
199−jsonbBuildObject
200− :: (SOP.SListI elems, PGBuildObject elems)
201− => FunctionN elems (null 'PGjsonb)
202−jsonbBuildObject = unsafeFunctionN "jsonb_build_object"
225+class SOP.SListI tys => JsonBuildObject tys where
226+
227+ jsonBuildObject :: tys ---> null 'PGjson
228+ jsonBuildObject = unsafeFunctionN "json_build_object"
229+
230+ jsonbBuildObject :: tys ---> null 'PGjsonb
231+ jsonbBuildObject = unsafeFunctionN "jsonb_build_object"
232+
233+instance JsonBuildObject '[]
234+instance (JsonBuildObject tys, key `In` PGJsonKey)
235+ => JsonBuildObject ('NotNull key ': value ': tys)
203236
204237-- | Builds a JSON object out of a text array.
205238-- The array must have two dimensions
@@ -207,7 +240,7 @@ jsonbBuildObject = unsafeFunctionN "jsonb_build_object"
207240-- which are taken as a key/value pair.
208241jsonObject
209242 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))
210− :--> null 'PGjson
243+ --> null 'PGjson
211244jsonObject = unsafeFunction "json_object"
212245
213246-- | Builds a binary JSON object out of a text array.
@@ -216,24 +249,24 @@ jsonObject = unsafeFunction "json_object"
216249-- which are taken as a key/value pair.
217250jsonbObject
218251 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))
219− :--> null 'PGjsonb
252+ --> null 'PGjsonb
220253jsonbObject = unsafeFunction "jsonb_object"
221254
222255-- | This is an alternate form of 'jsonObject' that takes two arrays; one for
223256-- keys and one for values, that are zipped pairwise to create a JSON object.
224−jsonZipObject :: FunctionN
257+jsonZipObject ::
225258 '[ null ('PGvararray ('NotNull 'PGtext))
226259 , null ('PGvararray ('NotNull 'PGtext)) ]
227− ( null 'PGjson )
260+ ---> null 'PGjson
228261jsonZipObject = unsafeFunctionN "json_object"
229262
230263-- | This is an alternate form of 'jsonbObject' that takes two arrays; one for
231264-- keys and one for values, that are zipped pairwise to create a binary JSON
232265-- object.
233−jsonbZipObject :: FunctionN
266+jsonbZipObject ::
234267 '[ null ('PGvararray ('NotNull 'PGtext))
235268 , null ('PGvararray ('NotNull 'PGtext)) ]
236− ( null 'PGjsonb )
269+ ---> null 'PGjsonb
237270jsonbZipObject = unsafeFunctionN "jsonb_object"
238271
239272{-----------------------------------------
@@ -241,108 +274,189 @@ Table 9.46: JSON processing functions
241274-----------------------------------------}
242275
243276-- | Returns the number of elements in the outermost JSON array.
244−jsonArrayLength :: null 'PGjson :--> null 'PGint4
277+jsonArrayLength :: null 'PGjson --> null 'PGint4
245278jsonArrayLength = unsafeFunction "json_array_length"
246279
247280-- | Returns the number of elements in the outermost binary JSON array.
248−jsonbArrayLength :: null 'PGjsonb :--> null 'PGint4
281+jsonbArrayLength :: null 'PGjsonb --> null 'PGint4
249282jsonbArrayLength = unsafeFunction "jsonb_array_length"
250283
251−-- | Returns JSON value pointed to by the given path (equivalent to #>
252−-- operator).
253−jsonExtractPath
254− :: SOP.SListI elems
255− => Expression outer commons grp schemas params from (null 'PGjson)
256− -> NP (Expression outer commons grp schemas params from) elems
257− -> Expression outer commons grp schemas params from (null 'PGjsonb)
258−jsonExtractPath x xs =
259− unsafeFunctionN "json_extract_path" (x :* xs)
260−
261−-- | Returns JSON value pointed to by the given path (equivalent to #>
262−-- operator).
263−jsonbExtractPath
264− :: SOP.SListI elems
265− => Expression outer commons grp schemas params from (null 'PGjsonb)
266− -> NP (Expression outer commons grp schemas params from) elems
267− -> Expression outer commons grp schemas params from (null 'PGjsonb)
268−jsonbExtractPath x xs =
269− unsafeFunctionN "jsonb_extract_path" (x :* xs)
270−
271−-- | Returns JSON value pointed to by the given path (equivalent to #>
272−-- operator), as text.
273−jsonExtractPathAsText
274− :: SOP.SListI elems
275− => Expression outer commons grp schemas params from (null 'PGjson)
276− -> NP (Expression outer commons grp schemas params from) elems
277− -> Expression outer commons grp schemas params from (null 'PGjson)
278−jsonExtractPathAsText x xs =
279− unsafeFunctionN "json_extract_path_text" (x :* xs)
280−
281−-- | Returns JSON value pointed to by the given path (equivalent to #>
282−-- operator), as text.
283−jsonbExtractPathAsText
284− :: SOP.SListI elems
285− => Expression outer commons grp schemas params from (null 'PGjsonb)
286− -> NP (Expression outer commons grp schemas params from) elems
287− -> Expression outer commons grp schemas params from (null 'PGjsonb)
288−jsonbExtractPathAsText x xs =
289− unsafeFunctionN "jsonb_extract_path_text" (x :* xs)
290−
291284-- | Returns the type of the outermost JSON value as a text string. Possible
292285-- types are object, array, string, number, boolean, and null.
293−jsonTypeof :: null 'PGjson :--> null 'PGtext
286+jsonTypeof :: null 'PGjson --> null 'PGtext
294287jsonTypeof = unsafeFunction "json_typeof"
295288
296289-- | Returns the type of the outermost binary JSON value as a text string.
297290-- Possible types are object, array, string, number, boolean, and null.
298−jsonbTypeof :: null 'PGjsonb :--> null 'PGtext
291+jsonbTypeof :: null 'PGjsonb --> null 'PGtext
299292jsonbTypeof = unsafeFunction "jsonb_typeof"
300293
301294-- | Returns its argument with all object fields that have null values omitted.
302295-- Other null values are untouched.
303−jsonStripNulls :: null 'PGjson :--> null 'PGjson
296+jsonStripNulls :: null 'PGjson --> null 'PGjson
304297jsonStripNulls = unsafeFunction "json_strip_nulls"
305298
306299-- | Returns its argument with all object fields that have null values omitted.
307300-- Other null values are untouched.
308−jsonbStripNulls :: null 'PGjsonb :--> null 'PGjsonb
301+jsonbStripNulls :: null 'PGjsonb --> null 'PGjsonb
309302jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"
310303
311304-- | @ jsonbSet target path new_value create_missing @
312305--
313−-- Returns target with the section designated by path replaced by new_value,
314−-- or with new_value added if create_missing is true ( default is true) and the
306+-- Returns target with the section designated by path replaced by @new_value@,
307+-- or with @new_value@ added if create_missing is
308+-- `Squeal.PostgreSQL.Expression.Logic.true` and the
315309-- item designated by path does not exist. As with the path orientated
316310-- operators, negative integers that appear in path count from the end of JSON
317311-- arrays.
318−jsonbSet
319− :: Expression outer commons grp schemas params from (null 'PGjsonb)
320− -> Expression outer commons grp schemas params from (null ('PGvararray ('NotNull 'PGtext)))
321− -> Expression outer commons grp schemas params from (null 'PGjsonb)
322− -> Maybe (Expression outer commons grp schemas params from (null 'PGbool))
323− -> Expression outer commons grp schemas params from (null 'PGjsonb)
324−jsonbSet tgt path val createMissing = case createMissing of
325− Just m -> unsafeFunctionN "jsonb_set" (tgt :* path :* val :* m :* Nil)
326− Nothing -> unsafeFunctionN "jsonb_set" (tgt :* path :* val :* Nil)
312+jsonbSet ::
313+ '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))
314+ , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb
315+jsonbSet = unsafeFunctionN "jsonbSet"
327316
328317-- | @ jsonbInsert target path new_value insert_after @
329318--
330−-- Returns target with new_value inserted. If target section designated by
331−-- path is in a JSONB array, new_value will be inserted before target or after
332−-- if insert_after is true (default is false). If target section designated by
333−-- path is in JSONB object, new_value will be inserted only if target does not
319+-- Returns target with @new_value@ inserted. If target section designated by
320+-- path is in a JSONB array, @new_value@ will be inserted before target or after
321+-- if @insert_after@ is `Squeal.PostgreSQL.Expression.Logic.true`.
322+-- If target section designated by
323+-- path is in JSONB object, @new_value@ will be inserted only if target does not
334324-- exist. As with the path orientated operators, negative integers that appear
335325-- in path count from the end of JSON arrays.
336−jsonbInsert
337− :: Expression outer commons grp schemas params from (null 'PGjsonb)
338− -> Expression outer commons grp schemas params from (null ('PGvararray ('NotNull 'PGtext)))
339− -> Expression outer commons grp schemas params from (null 'PGjsonb)
340− -> Maybe (Expression outer commons grp schemas params from (null 'PGbool))
341− -> Expression outer commons grp schemas params from (null 'PGjsonb)
342−jsonbInsert tgt path val insertAfter = case insertAfter of
343− Just i -> unsafeFunctionN "jsonb_insert" (tgt :* path :* val :* i :* Nil)
344− Nothing -> unsafeFunctionN "jsonb_insert" (tgt :* path :* val :* Nil)
326+jsonbInsert ::
327+ '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))
328+ , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb
329+jsonbInsert = unsafeFunctionN "jsonb_insert"
345330
346331-- | Returns its argument as indented JSON text.
347−jsonbPretty :: null 'PGjsonb :--> null 'PGtext
332+jsonbPretty :: null 'PGjsonb --> null 'PGtext
348333jsonbPretty = unsafeFunction "jsonb_pretty"
334+
335+{- | Expands the outermost JSON object into a set of key/value pairs.
336+
337+>>> printSQL (select Star (from (jsonEach (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))
338+SELECT * FROM json_each(('{"a":"foo","b":"bar"}' :: json))
339+-}
340+jsonEach :: SetFunction "json_each" (null 'PGjson)
341+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]
342+jsonEach = unsafeSetFunction
343+
344+{- | Expands the outermost binary JSON object into a set of key/value pairs.
345+
346+>>> printSQL (select Star (from (jsonbEach (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))
347+SELECT * FROM jsonb_each(('{"a":"foo","b":"bar"}' :: jsonb))
348+-}
349+jsonbEach
350+ :: SetFunction "jsonb_each" (nullity 'PGjsonb)
351+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]
352+jsonbEach = unsafeSetFunction
353+
354+{- | Expands the outermost JSON object into a set of key/value pairs.
355+
356+>>> printSQL (select Star (from (jsonEachText (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))
357+SELECT * FROM json_each_text(('{"a":"foo","b":"bar"}' :: json))
358+-}
359+jsonEachText
360+ :: SetFunction "json_each_text" (null 'PGjson)
361+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]
362+jsonEachText = unsafeSetFunction
363+
364+{- | Expands the outermost binary JSON object into a set of key/value pairs.
365+
366+>>> printSQL (select Star (from (jsonbEachText (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))
367+SELECT * FROM jsonb_each_text(('{"a":"foo","b":"bar"}' :: jsonb))
368+-}
369+jsonbEachText
370+ :: SetFunction "jsonb_each_text" (null 'PGjsonb)
371+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]
372+jsonbEachText = unsafeSetFunction
373+
374+{- | Returns set of keys in the outermost JSON object.
375+
376+>>> printSQL (jsonObjectKeys (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))
377+json_object_keys(('{"a":"foo","b":"bar"}' :: json))
378+-}
379+jsonObjectKeys
380+ :: SetFunction "json_object_keys" (nullity 'PGjson)
381+ '["json_object_keys" ::: 'NotNull 'PGtext]
382+jsonObjectKeys = unsafeSetFunction
383+
384+{- | Returns set of keys in the outermost JSON object.
385+
386+>>> printSQL (jsonbObjectKeys (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))
387+jsonb_object_keys(('{"a":"foo","b":"bar"}' :: jsonb))
388+-}
389+jsonbObjectKeys
390+ :: SetFunction "jsonb_object_keys" (null 'PGjsonb)
391+ '["jsonb_object_keys" ::: 'NotNull 'PGtext]
392+jsonbObjectKeys = unsafeSetFunction
393+
394+-- | Build rows from Json types.
395+type JsonPopulateFunction fun json
396+ = forall schemas row outer commons params
397+ . json `In` PGJsonType
398+ => TypeExpression schemas ('NotNull ('PGcomposite row)) -- ^ row type
399+ -> Expression outer commons 'Ungrouped schemas params '[] ('NotNull json)
400+ -- ^ json type
401+ -> FromClause outer commons schemas params '[fun ::: row]
402+
403+unsafePopulateFunction
404+ :: forall fun ty
405+ . KnownSymbol fun => Alias fun -> JsonPopulateFunction fun ty
406+unsafePopulateFunction _fun ty expr = UnsafeFromClause $ renderSymbol @fun
407+ <> parenthesized ("null::" <> renderSQL ty <> ", " <> renderSQL expr)
408+
409+-- | Expands the JSON expression to a row whose columns match the record
410+-- type defined by the given table.
411+jsonPopulateRecord :: JsonPopulateFunction "json_populate_record" 'PGjson
412+jsonPopulateRecord = unsafePopulateFunction #json_populate_record
413+
414+-- | Expands the binary JSON expression to a row whose columns match the record
415+-- type defined by the given table.
416+jsonbPopulateRecord :: JsonPopulateFunction "jsonb_populate_record" 'PGjsonb
417+jsonbPopulateRecord = unsafePopulateFunction #jsonb_populate_record
418+
419+-- | Expands the outermost array of objects in the given JSON expression to a
420+-- set of rows whose columns match the record type defined by the given table.
421+jsonPopulateRecordSet :: JsonPopulateFunction "json_populate_record_set" 'PGjson
422+jsonPopulateRecordSet = unsafePopulateFunction #json_populate_record_set
423+
424+-- | Expands the outermost array of objects in the given binary JSON expression
425+-- to a set of rows whose columns match the record type defined by the given
426+-- table.
427+jsonbPopulateRecordSet :: JsonPopulateFunction "jsonb_populate_record_set" 'PGjsonb
428+jsonbPopulateRecordSet = unsafePopulateFunction #jsonb_populate_record_set
429+
430+-- | Build rows from Json types.
431+type JsonToRecordFunction json
432+ = forall outer commons schemas params tab row
433+ . (SOP.SListI row, json `In` PGJsonType)
434+ => Expression outer commons 'Ungrouped schemas params '[] ('NotNull json)
435+ -- ^ json type
436+ -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: row)
437+ -- ^ row type
438+ -> FromClause outer commons schemas params '[tab ::: row]
439+
440+unsafeRecordFunction :: ByteString -> JsonToRecordFunction json
441+unsafeRecordFunction fun expr (types `As` tab) = UnsafeFromClause $
442+ fun <> parenthesized (renderSQL expr) <+> "AS" <+> renderSQL tab
443+ <> parenthesized (renderCommaSeparated renderTy types)
444+ where
445+ renderTy :: Aliased (TypeExpression schemas) ty -> ByteString
446+ renderTy (ty `As` alias) = renderSQL alias <+> renderSQL ty
447+
448+-- | Builds an arbitrary record from a JSON object.
449+jsonToRecord :: JsonToRecordFunction 'PGjson
450+jsonToRecord = unsafeRecordFunction "json_to_record"
451+
452+-- | Builds an arbitrary record from a binary JSON object.
453+jsonbToRecord :: JsonToRecordFunction 'PGjsonb
454+jsonbToRecord = unsafeRecordFunction "jsonb_to_record"
455+
456+-- | Builds an arbitrary set of records from a JSON array of objects.
457+jsonToRecordSet :: JsonToRecordFunction 'PGjson
458+jsonToRecordSet = unsafeRecordFunction "json_to_record_set"
459+
460+-- | Builds an arbitrary set of records from a binary JSON array of objects.
461+jsonbToRecordSet :: JsonToRecordFunction 'PGjsonb
462+jsonbToRecordSet = unsafeRecordFunction "jsonb_to_record_set"
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Literal.hsnew file+87
@@ -0,0 +1,87 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Literal
3+Description: Literal expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Literal expressions
9+-}
10+
11+{-# LANGUAGE
12+ FlexibleContexts
13+ , FlexibleInstances
14+ , LambdaCase
15+ , OverloadedStrings
16+ , RankNTypes
17+ , ScopedTypeVariables
18+ , TypeApplications
19+ , TypeSynonymInstances
20+ , UndecidableInstances
21+#-}
22+
23+module Squeal.PostgreSQL.Expression.Literal (Literal (..)) where
24+
25+import ByteString.StrictBuilder (builderBytes)
26+import Data.ByteString.Lazy (toStrict)
27+import Data.Int
28+import Data.String
29+import Data.Text (Text)
30+
31+import qualified Data.Aeson as JSON
32+import qualified Data.Text as Text
33+import qualified Data.Text.Lazy as Lazy (Text)
34+import qualified Data.Text.Lazy as Lazy.Text
35+
36+import Squeal.PostgreSQL.Binary
37+import Squeal.PostgreSQL.Expression
38+import Squeal.PostgreSQL.Expression.Logic
39+import Squeal.PostgreSQL.PG
40+import Squeal.PostgreSQL.Render
41+
42+{- |
43+The `Literal` class allows embedding a Haskell value directly
44+as an `Expression` using `literal`.
45+
46+>>> printSQL (literal 'a')
47+E'a'
48+
49+>>> printSQL (literal (1 :: Double))
50+1.0
51+
52+>>> printSQL (literal (Json [1 :: Double, 2]))
53+('[1.0,2.0]' :: json)
54+
55+>>> printSQL (literal (Enumerated GT))
56+'GT'
57+-}
58+class Literal hask where literal :: hask -> Expr (null (PG hask))
59+instance Literal Bool where
60+ literal = \case
61+ True -> true
62+ False -> false
63+instance JSON.ToJSON hask => Literal (Json hask) where
64+ literal = UnsafeExpression . parenthesized . (<> " :: json")
65+ . singleQuotedUtf8 . toStrict . JSON.encode . getJson
66+instance JSON.ToJSON hask => Literal (Jsonb hask) where
67+ literal = UnsafeExpression . parenthesized . (<> " :: jsonb")
68+ . singleQuotedUtf8 . toStrict . JSON.encode . getJsonb
69+instance Literal Char where
70+ literal chr = UnsafeExpression $
71+ "E\'" <> fromString (escape chr) <> "\'"
72+instance Literal String where literal = fromString
73+instance Literal Int16 where literal = fromIntegral
74+instance Literal Int32 where literal = fromIntegral
75+instance Literal Int64 where literal = fromIntegral
76+instance Literal Float where literal = fromRational . toRational
77+instance Literal Double where literal = fromRational . toRational
78+instance Literal Text where literal = fromString . Text.unpack
79+instance Literal Lazy.Text where literal = fromString . Lazy.Text.unpack
80+instance ToParam (Enumerated enum) (PG (Enumerated enum))
81+ => Literal (Enumerated enum) where
82+ literal
83+ = UnsafeExpression
84+ . singleQuotedUtf8
85+ . builderBytes
86+ . unK
87+ . toParam @(Enumerated enum) @(PG (Enumerated enum))
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Logic.hs+13−3
@@ -1,3 +1,13 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Logic
3+Description: Logical expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Logical expressions and operators
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , OverloadedStrings
@@ -20,7 +30,7 @@ import Squeal.PostgreSQL.Render
2030import Squeal.PostgreSQL.Schema
2131
2232-- | A `Condition` is an `Expression`, which can evaluate
23−-- to `true`, `false` or `null_`. This is because SQL uses
33+-- to `true`, `false` or `Squeal.PostgreSQL.Null.null_`. This is because SQL uses
2434-- a three valued logic.
2535type Condition outer commons grp schemas params from =
2636 Expression outer commons grp schemas params from ('Null 'PGbool)
@@ -37,8 +47,8 @@ false = UnsafeExpression "FALSE"
3747
3848-- | >>> printSQL $ not_ true
3949-- (NOT TRUE)
40−not_ :: null 'PGbool :--> null 'PGbool
41−not_ = unsafeUnaryOpL "NOT"
50+not_ :: null 'PGbool --> null 'PGbool
51+not_ = unsafeLeftOp "NOT"
4252
4353-- | >>> printSQL $ true .&& false
4454-- (TRUE AND FALSE)
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Math.hs+14−7
@@ -1,3 +1,13 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Math
3+Description: Math expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Mathematical functions and operators
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , OverloadedStrings
@@ -19,7 +29,6 @@ import Squeal.PostgreSQL.Schema
1929
2030-- $setup
2131-- >>> import Squeal.PostgreSQL
22−-- >>> import Squeal.PostgreSQL.Render
2332
2433-- | >>> :{
2534-- let
@@ -28,9 +37,7 @@ import Squeal.PostgreSQL.Schema
2837-- in printSQL expression
2938-- :}
3039-- atan2(pi(), 2)
31−atan2_
32− :: float `In` PGFloating
33− => FunctionN '[ null float, null float] (null float)
40+atan2_ :: float `In` PGFloating => '[ null float, null float] ---> null float
3441atan2_ = unsafeFunctionN "atan2"
3542
3643
@@ -69,7 +76,7 @@ rem_ = unsafeBinaryOp "%"
6976-- in printSQL expression
7077-- :}
7178-- trunc(pi())
72−trunc :: frac `In` PGFloating => null frac :--> null frac
79+trunc :: frac `In` PGFloating => null frac --> null frac
7380trunc = unsafeFunction "trunc"
7481
7582-- | >>> :{
@@ -79,7 +86,7 @@ trunc = unsafeFunction "trunc"
7986-- in printSQL expression
8087-- :}
8188-- round(pi())
82−round_ :: frac `In` PGFloating => null frac :--> null frac
89+round_ :: frac `In` PGFloating => null frac --> null frac
8390round_ = unsafeFunction "round"
8491
8592-- | >>> :{
@@ -89,5 +96,5 @@ round_ = unsafeFunction "round"
8996-- in printSQL expression
9097-- :}
9198-- ceiling(pi())
92−ceiling_ :: frac `In` PGFloating => null frac :--> null frac
99+ceiling_ :: frac `In` PGFloating => null frac --> null frac
93100ceiling_ = unsafeFunction "ceiling"
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Null.hs+14−4
@@ -1,3 +1,13 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Null
3+Description: Null
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Null values and null handling functions
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , OverloadedStrings
@@ -34,7 +44,7 @@ null_ = UnsafeExpression "NULL"
3444--
3545-- >>> printSQL $ notNull true
3646-- TRUE
37−notNull :: 'NotNull ty :--> 'Null ty
47+notNull :: 'NotNull ty --> 'Null ty
3848notNull = UnsafeExpression . renderSQL
3949
4050-- | return the leftmost value which is not NULL
@@ -59,12 +69,12 @@ fromNull notNullx nullx = coalesce [nullx] notNullx
5969
6070-- | >>> printSQL $ null_ & isNull
6171-- NULL IS NULL
62−isNull :: 'Null ty :--> null 'PGbool
72+isNull :: 'Null ty --> null 'PGbool
6373isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"
6474
6575-- | >>> printSQL $ null_ & isNotNull
6676-- NULL IS NOT NULL
67−isNotNull :: 'Null ty :--> null 'PGbool
77+isNotNull :: 'Null ty --> null 'PGbool
6878isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"
6979
7080-- | analagous to `maybe` using @IS NULL@
@@ -90,5 +100,5 @@ matchNull y f x = ifThenElse (isNull x) y
90100>>> printSQL expr
91101NULLIF(FALSE, ($1 :: bool))
92102-}
93−nullIf :: FunctionN '[ 'NotNull ty, 'NotNull ty] ('Null ty)
103+nullIf :: '[ 'NotNull ty, 'NotNull ty] ---> 'Null ty
94104nullIf = unsafeFunctionN "NULLIF"
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Parameter.hsnew file+80
@@ -0,0 +1,80 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Parameter
3+Description: Parameters
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Parameters, out-of-line data values
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , DataKinds
14+ , FlexibleContexts
15+ , FlexibleInstances
16+ , FunctionalDependencies
17+ , KindSignatures
18+ , MultiParamTypeClasses
19+ , OverloadedStrings
20+ , RankNTypes
21+ , ScopedTypeVariables
22+ , TypeApplications
23+ , TypeOperators
24+ , UndecidableInstances
25+#-}
26+
27+module Squeal.PostgreSQL.Expression.Parameter
28+ ( HasParameter (parameter)
29+ , param
30+ ) where
31+
32+import GHC.TypeLits
33+
34+import Squeal.PostgreSQL.Expression
35+import Squeal.PostgreSQL.Expression.Type
36+import Squeal.PostgreSQL.Render
37+import Squeal.PostgreSQL.Schema
38+
39+-- $setup
40+-- >>> import Squeal.PostgreSQL
41+
42+{- | A `HasParameter` constraint is used to indicate a value that is
43+supplied externally to a SQL statement.
44+`Squeal.PostgreSQL.PQ.manipulateParams`,
45+`Squeal.PostgreSQL.PQ.queryParams` and
46+`Squeal.PostgreSQL.PQ.traversePrepared` support specifying data values
47+separately from the SQL command string, in which case `param`s are used to
48+refer to the out-of-line data values.
49+-}
50+class KnownNat n => HasParameter
51+ (n :: Nat)
52+ (params :: [NullityType])
53+ (ty :: NullityType)
54+ | n params -> ty where
55+ -- | `parameter` takes a `Nat` using type application and a `TypeExpression`.
56+ --
57+ -- >>> let expr = parameter @1 int4 :: Expression outer '[] grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)
58+ -- >>> printSQL expr
59+ -- ($1 :: int4)
60+ parameter
61+ :: TypeExpression schemas ty
62+ -> Expression outer commons grp schemas params from ty
63+ parameter ty = UnsafeExpression $ parenthesized $
64+ "$" <> renderNat @n <+> "::"
65+ <+> renderSQL ty
66+instance {-# OVERLAPPING #-} HasParameter 1 (ty1:tys) ty1
67+instance {-# OVERLAPPABLE #-} (KnownNat n, HasParameter (n-1) params ty)
68+ => HasParameter n (ty' : params) ty
69+
70+-- | `param` takes a `Nat` using type application and for basic types,
71+-- infers a `TypeExpression`.
72+--
73+-- >>> let expr = param @1 :: Expression outer commons grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)
74+-- >>> printSQL expr
75+-- ($1 :: int4)
76+param
77+ :: forall n outer commons schemas params from grp ty
78+ . (PGTyped schemas ty, HasParameter n params ty)
79+ => Expression outer commons grp schemas params from ty -- ^ param
80+param = parameter @n (pgtype @schemas)
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Range.hsnew file+230
@@ -0,0 +1,230 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Range
3+Description: range types and functions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Range types and functions
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , DataKinds
14+ , DeriveAnyClass
15+ , DeriveGeneric
16+ , DeriveFoldable
17+ , DerivingStrategies
18+ , DeriveTraversable
19+ , FlexibleContexts
20+ , FlexibleInstances
21+ , LambdaCase
22+ , MultiParamTypeClasses
23+ , OverloadedLabels
24+ , OverloadedStrings
25+ , PatternSynonyms
26+ , RankNTypes
27+ , ScopedTypeVariables
28+ , TypeApplications
29+ , TypeFamilies
30+ , TypeOperators
31+ , UndecidableInstances
32+#-}
33+
34+module Squeal.PostgreSQL.Expression.Range
35+ ( range
36+ , Range (..)
37+ , (<=..<=), (<..<), (<=..<), (<..<=)
38+ , moreThan, atLeast, lessThan, atMost
39+ , singleton, whole
40+ , Bound (..)
41+ , (.<@)
42+ , (@>.)
43+ , (<<@)
44+ , (@>>)
45+ , (&<)
46+ , (&>)
47+ , (-|-)
48+ , (@+)
49+ , (@*)
50+ , (@-)
51+ , lowerBound
52+ , upperBound
53+ , isEmpty
54+ , lowerInc
55+ , lowerInf
56+ , upperInc
57+ , upperInf
58+ , rangeMerge
59+ ) where
60+
61+import BinaryParser
62+import ByteString.StrictBuilder
63+import Data.Bits
64+import qualified GHC.Generics as GHC
65+import qualified Generics.SOP as SOP
66+import qualified PostgreSQL.Binary.Decoding as Decoding
67+
68+import Squeal.PostgreSQL.Binary
69+import Squeal.PostgreSQL.Expression
70+import Squeal.PostgreSQL.Expression.Type hiding (bool)
71+import Squeal.PostgreSQL.PG
72+import Squeal.PostgreSQL.Render
73+import Squeal.PostgreSQL.Schema
74+
75+-- $setup
76+-- >>> import Squeal.PostgreSQL
77+
78+-- | Construct a `range`
79+--
80+-- >>> printSQL $ range tstzrange (atLeast now)
81+-- tstzrange(now(), NULL, '[)')
82+-- >>> printSQL $ range numrange (0 <=..< 2*pi)
83+-- numrange(0, (2 * pi()), '[)')
84+-- >>> printSQL $ range int4range Empty
85+-- ('empty' :: int4range)
86+range
87+ :: TypeExpression schemas (null ('PGrange ty))
88+ -> Range (Expression outer commons grp schemas params from ('NotNull ty))
89+ -> Expression outer commons grp schemas params from (null ('PGrange ty))
90+range ty = \case
91+ Empty -> UnsafeExpression $ parenthesized
92+ (emp <+> "::" <+> renderSQL ty)
93+ NonEmpty l u -> UnsafeExpression $ renderSQL ty <> parenthesized
94+ (commaSeparated (args l u))
95+ where
96+ emp = singleQuote <> "empty" <> singleQuote
97+ args l u = [arg l, arg u, singleQuote <> bra l <> ket u <> singleQuote]
98+ singleQuote = "\'"
99+ arg = \case
100+ Infinite -> "NULL"; Closed x -> renderSQL x; Open x -> renderSQL x
101+ bra = \case Infinite -> "("; Closed _ -> "["; Open _ -> "("
102+ ket = \case Infinite -> ")"; Closed _ -> "]"; Open _ -> ")"
103+
104+data Bound x = Infinite | Closed x | Open x
105+ deriving
106+ ( Eq, Ord, Show, Read, GHC.Generic
107+ , Functor, Foldable, Traversable )
108+
109+data Range x = Empty | NonEmpty (Bound x) (Bound x)
110+ deriving
111+ ( Eq, Ord, Show, Read, GHC.Generic
112+ , Functor, Foldable, Traversable )
113+ deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)
114+type instance PG (Range x) = 'PGrange (PG x)
115+instance ToParam x pg => ToParam (Range x) ('PGrange pg) where
116+ toParam rng = K $
117+ word8 (setFlags rng 0) <>
118+ case rng of
119+ Empty -> mempty
120+ NonEmpty lower upper -> putBound lower <> putBound upper
121+ where
122+ putBound = \case
123+ Infinite -> mempty
124+ Closed value -> putValue (unK (toParam @x @pg value))
125+ Open value -> putValue (unK (toParam @x @pg value))
126+ putValue value = int32BE (fromIntegral (builderLength value)) <> value
127+ setFlags = \case
128+ Empty -> (`setBit` 0)
129+ NonEmpty lower upper ->
130+ setLowerFlags lower . setUpperFlags upper
131+ setLowerFlags = \case
132+ Infinite -> (`setBit` 3)
133+ Closed _ -> (`setBit` 1)
134+ Open _ -> id
135+ setUpperFlags = \case
136+ Infinite -> (`setBit` 4)
137+ Closed _ -> (`setBit` 2)
138+ Open _ -> id
139+instance FromValue pg y => FromValue ('PGrange pg) (Range y) where
140+ fromValue = do
141+ flag <- byte
142+ if testBit flag 0 then return Empty else do
143+ lower <-
144+ if testBit flag 3
145+ then return Infinite
146+ else do
147+ len <- sized 4 Decoding.int
148+ l <- sized len (fromValue @pg)
149+ return $ if testBit flag 1 then Closed l else Open l
150+ upper <-
151+ if testBit flag 4
152+ then return Infinite
153+ else do
154+ len <- sized 4 Decoding.int
155+ l <- sized len (fromValue @pg)
156+ return $ if testBit flag 2 then Closed l else Open l
157+ return $ NonEmpty lower upper
158+
159+(<=..<=), (<..<), (<=..<), (<..<=) :: x -> x -> Range x
160+infix 4 <=..<=, <..<, <=..<, <..<=
161+x <=..<= y = NonEmpty (Closed x) (Closed y)
162+x <..< y = NonEmpty (Open x) (Open y)
163+x <=..< y = NonEmpty (Closed x) (Open y)
164+x <..<= y = NonEmpty (Open x) (Closed y)
165+
166+moreThan, atLeast, lessThan, atMost :: x -> Range x
167+moreThan x = NonEmpty (Open x) Infinite
168+atLeast x = NonEmpty (Closed x) Infinite
169+lessThan x = NonEmpty Infinite (Open x)
170+atMost x = NonEmpty Infinite (Closed x)
171+
172+singleton :: x -> Range x
173+singleton x = x <=..<= x
174+
175+whole :: Range x
176+whole = NonEmpty Infinite Infinite
177+
178+(.<@) :: Operator ('NotNull ty) (null ('PGrange ty)) ('Null 'PGbool)
179+(.<@) = unsafeBinaryOp "<@"
180+
181+(@>.) :: Operator (null ('PGrange ty)) ('NotNull ty) ('Null 'PGbool)
182+(@>.) = unsafeBinaryOp "<@"
183+
184+(<<@) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)
185+(<<@) = unsafeBinaryOp "<<"
186+
187+(@>>) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)
188+(@>>) = unsafeBinaryOp ">>"
189+
190+(&<) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)
191+(&<) = unsafeBinaryOp "&<"
192+
193+(&>) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)
194+(&>) = unsafeBinaryOp "&>"
195+
196+(-|-) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)
197+(-|-) = unsafeBinaryOp "-|-"
198+
199+(@+) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))
200+(@+) = unsafeBinaryOp "+"
201+
202+(@*) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))
203+(@*) = unsafeBinaryOp "*"
204+
205+(@-) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))
206+(@-) = unsafeBinaryOp "-"
207+
208+lowerBound :: null ('PGrange ty) --> 'Null ty
209+lowerBound = unsafeFunction "lower"
210+
211+upperBound :: null ('PGrange ty) --> 'Null ty
212+upperBound = unsafeFunction "upper"
213+
214+isEmpty :: null ('PGrange ty) --> 'Null 'PGbool
215+isEmpty = unsafeFunction "isempty"
216+
217+lowerInc :: null ('PGrange ty) --> 'Null 'PGbool
218+lowerInc = unsafeFunction "lower_inc"
219+
220+lowerInf :: null ('PGrange ty) --> 'Null 'PGbool
221+lowerInf = unsafeFunction "lower_inf"
222+
223+upperInc :: null ('PGrange ty) --> 'Null 'PGbool
224+upperInc = unsafeFunction "upper_inc"
225+
226+upperInf :: null ('PGrange ty) --> 'Null 'PGbool
227+upperInf = unsafeFunction "upper_inf"
228+
229+rangeMerge :: '[null ('PGrange ty), null ('PGrange ty)] ---> null ('PGrange ty)
230+rangeMerge = unsafeFunctionN "range_merge"
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Set.hsnew file+139
@@ -0,0 +1,139 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Set
3+Description: Set returning functions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Set returning functions
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , DataKinds
14+ , FlexibleContexts
15+ , OverloadedStrings
16+ , PolyKinds
17+ , RankNTypes
18+ , ScopedTypeVariables
19+ , TypeApplications
20+ , TypeOperators
21+#-}
22+
23+module Squeal.PostgreSQL.Expression.Set
24+ ( generateSeries
25+ , generateSeriesStep
26+ , generateSeriesTimestamp
27+ , SetFunction
28+ , unsafeSetFunction
29+ , SetFunctionDB
30+ , setFunction
31+ , SetFunctionN
32+ , unsafeSetFunctionN
33+ , SetFunctionNDB
34+ , setFunctionN
35+ ) where
36+
37+import GHC.TypeLits
38+
39+import qualified Generics.SOP as SOP
40+
41+import Squeal.PostgreSQL.Alias
42+import Squeal.PostgreSQL.Expression
43+import Squeal.PostgreSQL.List
44+import Squeal.PostgreSQL.Render
45+import Squeal.PostgreSQL.Query
46+import Squeal.PostgreSQL.Schema
47+
48+{- |
49+A @RankNType@ for set returning functions with 1 argument.
50+-}
51+type SetFunction fun ty row
52+ = forall outer commons schemas params
53+ . Expression outer commons 'Ungrouped schemas params '[] ty
54+ -- ^ input
55+ -> FromClause outer commons schemas params '[fun ::: row]
56+ -- ^ output
57+
58+type SetFunctionDB fun schemas ty row
59+ = forall outer commons params
60+ . Expression outer commons 'Ungrouped schemas params '[] ty
61+ -- ^ input
62+ -> FromClause outer commons schemas params '[fun ::: row]
63+ -- ^ output
64+
65+-- | Escape hatch for a set returning function with 1 argument.
66+unsafeSetFunction
67+ :: forall fun ty row. KnownSymbol fun
68+ => SetFunction fun ty row -- ^ set returning function
69+unsafeSetFunction x = UnsafeFromClause $
70+ renderSymbol @fun <> parenthesized (renderSQL x)
71+
72+setFunction
73+ :: ( Has sch schemas schema
74+ , Has fun schema ('Function ('[ty] :=> 'ReturnsTable row)) )
75+ => QualifiedAlias sch fun
76+ -> SetFunctionDB fun schemas ty row
77+setFunction _ = unsafeSetFunction
78+
79+{- |
80+A @RankNType@ for set returning functions with multiple argument.
81+-}
82+type SetFunctionN fun tys row
83+ = forall outer commons schemas params
84+ . NP (Expression outer commons 'Ungrouped schemas params '[]) tys
85+ -- ^ inputs
86+ -> FromClause outer commons schemas params '[fun ::: row]
87+ -- ^ output
88+
89+-- | Escape hatch for a set returning function with multiple argument.
90+unsafeSetFunctionN
91+ :: forall fun tys row. (SOP.SListI tys, KnownSymbol fun)
92+ => SetFunctionN fun tys row -- ^ set returning function
93+unsafeSetFunctionN xs = UnsafeFromClause $
94+ renderSymbol @fun <> parenthesized (renderCommaSeparated renderSQL xs)
95+
96+type SetFunctionNDB fun schemas tys row
97+ = forall outer commons params
98+ . NP (Expression outer commons 'Ungrouped schemas params '[]) tys
99+ -- ^ inputs
100+ -> FromClause outer commons schemas params '[fun ::: row]
101+ -- ^ output
102+
103+setFunctionN
104+ :: ( Has sch schemas schema
105+ , Has fun schema ('Function (tys :=> 'ReturnsTable row))
106+ , SOP.SListI tys )
107+ => QualifiedAlias sch fun
108+ -> SetFunctionNDB fun schemas tys row
109+setFunctionN _ = unsafeSetFunctionN
110+
111+{- | @generateSeries (start *: stop)@
112+
113+Generate a series of values, from @start@ to @stop@ with a step size of one
114+-}
115+generateSeries
116+ :: ty `In` '[ 'PGint4, 'PGint8, 'PGnumeric]
117+ => SetFunctionN "generate_series" '[ null ty, null ty]
118+ '["generate_series" ::: null ty] -- ^ set returning function
119+generateSeries = unsafeSetFunctionN
120+
121+{- | @generateSeries (start :* stop *: step)@
122+
123+Generate a series of values, from @start@ to @stop@ with a step size of @step@
124+-}
125+generateSeriesStep
126+ :: ty `In` '[ 'PGint4, 'PGint8, 'PGnumeric]
127+ => SetFunctionN "generate_series" '[null ty, null ty, null ty]
128+ '["generate_series" ::: null ty] -- ^ set returning function
129+generateSeriesStep = unsafeSetFunctionN
130+
131+{- | @generateSeries (start :* stop *: step)@
132+
133+Generate a series of values, from @start@ to @stop@ with a step size of @step@
134+-}
135+generateSeriesTimestamp
136+ :: ty `In` '[ 'PGtimestamp, 'PGtimestamptz]
137+ => SetFunctionN "generate_series" '[null ty, null ty, null 'PGinterval]
138+ '["generate_series" ::: null ty] -- ^ set returning function
139+generateSeriesTimestamp = unsafeSetFunctionN
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Sort.hs+24−14
@@ -1,3 +1,13 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Sort
3+Description: Sort expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Sort expressions
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , GADTs
@@ -19,8 +29,10 @@ import Squeal.PostgreSQL.Schema
1929-- of a `Squeal.PostgreSQL.Query.Query`. `Asc` or `Desc`
2030-- set the sort direction of a `NotNull` result
2131-- column to ascending or descending. Ascending order puts smaller values
22−-- first, where "smaller" is defined in terms of the `.<` operator. Similarly,
23−-- descending order is determined with the `.>` operator. `AscNullsFirst`,
32+-- first, where "smaller" is defined in terms of the
33+-- `Squeal.PostgreSQL.Expression.Comparison..<` operator. Similarly,
34+-- descending order is determined with the
35+-- `Squeal.PostgreSQL.Expression.Comparison..>` operator. `AscNullsFirst`,
2436-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to
2537-- determine whether nulls appear before or after non-null values in the sort
2638-- ordering of a `Null` result column.
@@ -44,6 +56,16 @@ data SortExpression outer commons grp schemas params from where
4456 :: Expression outer commons grp schemas params from ('Null ty)
4557 -> SortExpression outer commons grp schemas params from
4658deriving instance Show (SortExpression outer commons grp schemas params from)
59+instance RenderSQL (SortExpression outer commons grp schemas params from) where
60+ renderSQL = \case
61+ Asc expression -> renderSQL expression <+> "ASC"
62+ Desc expression -> renderSQL expression <+> "DESC"
63+ AscNullsFirst expression -> renderSQL expression
64+ <+> "ASC NULLS FIRST"
65+ DescNullsFirst expression -> renderSQL expression
66+ <+> "DESC NULLS FIRST"
67+ AscNullsLast expression -> renderSQL expression <+> "ASC NULLS LAST"
68+ DescNullsLast expression -> renderSQL expression <+> "DESC NULLS LAST"
4769
4870{- |
4971The `orderBy` clause causes the result rows of a `Squeal.PostgreSQL.Query.TableExpression`
@@ -61,15 +83,3 @@ class OrderBy expr where
6183 :: [SortExpression outer commons grp schemas params from]
6284 -> expr outer commons grp schemas params from
6385 -> expr outer commons grp schemas params from
64−
65−-- | Render a `SortExpression`.
66−instance RenderSQL (SortExpression outer commons grp schemas params from) where
67− renderSQL = \case
68− Asc expression -> renderSQL expression <+> "ASC"
69− Desc expression -> renderSQL expression <+> "DESC"
70− AscNullsFirst expression -> renderSQL expression
71− <+> "ASC NULLS FIRST"
72− DescNullsFirst expression -> renderSQL expression
73− <+> "DESC NULLS FIRST"
74− AscNullsLast expression -> renderSQL expression <+> "ASC NULLS LAST"
75− DescNullsLast expression -> renderSQL expression <+> "DESC NULLS LAST"
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Subquery.hsnew file+120
@@ -0,0 +1,120 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Subquery
3+Description: Subquery expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Subquery expressions
9+-}
10+
11+{-# LANGUAGE
12+ DataKinds
13+ , OverloadedStrings
14+ , RankNTypes
15+ , TypeOperators
16+#-}
17+
18+module Squeal.PostgreSQL.Expression.Subquery
19+ ( exists
20+ , in_
21+ , notIn
22+ , subAll
23+ , subAny
24+ ) where
25+
26+import Squeal.PostgreSQL.Alias
27+import Squeal.PostgreSQL.Expression
28+import Squeal.PostgreSQL.Expression.Logic
29+import Squeal.PostgreSQL.List
30+import Squeal.PostgreSQL.Query
31+import Squeal.PostgreSQL.Render
32+import Squeal.PostgreSQL.Schema
33+
34+-- $setup
35+-- >>> import Squeal.PostgreSQL
36+
37+{- |
38+The argument of `exists` is an arbitrary subquery. The subquery is evaluated
39+to determine whether it returns any rows. If it returns at least one row,
40+the result of `exists` is `true`; if the subquery returns no rows,
41+the result of `exists` is `false`.
42+
43+The subquery can refer to variables from the surrounding query,
44+which will act as constants during any one evaluation of the subquery.
45+
46+The subquery will generally only be executed long enough to determine whether
47+at least one row is returned, not all the way to completion.
48+-}
49+exists
50+ :: Query (Join outer from) commons schemas params row
51+ -> Condition outer commons grp schemas params from
52+exists query = UnsafeExpression $ "EXISTS" <+> parenthesized (renderSQL query)
53+
54+{- |
55+The right-hand side is a parenthesized subquery, which must return
56+exactly one column. The left-hand expression is evaluated and compared to each
57+row of the subquery result using the given `Operator`,
58+which must yield a Boolean result. The result of `subAll` is `true`
59+if all rows yield true (including the case where the subquery returns no rows).
60+The result is `false` if any `false` result is found.
61+The result is `Squeal.PostgreSQL.Expression.Null.null_` if
62+ no comparison with a subquery row returns `false`,
63+and at least one comparison returns `Squeal.PostgreSQL.Expression.Null.null_`.
64+
65+>>> printSQL $ subAll true (.==) (values_ (true `as` #foo))
66+(TRUE = ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo")))
67+-}
68+subAll
69+ :: Expression outer commons grp schemas params from ty1 -- ^ expression
70+ -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator
71+ -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery
72+ -> Condition outer commons grp schemas params from
73+subAll expr (?) qry = expr ?
74+ (UnsafeExpression $ "ALL" <+> parenthesized (renderSQL qry))
75+
76+{- |
77+The right-hand side is a parenthesized subquery, which must return exactly one column.
78+The left-hand expression is evaluated and compared to each row of the subquery result
79+using the given `Operator`, which must yield a Boolean result. The result of `subAny` is `true`
80+if any `true` result is obtained. The result is `false` if no true result is found
81+(including the case where the subquery returns no rows).
82+
83+>>> printSQL $ subAny "foo" like (values_ ("foobar" `as` #foo))
84+(E'foo' LIKE ANY (SELECT * FROM (VALUES (E'foobar')) AS t ("foo")))
85+-}
86+subAny
87+ :: Expression outer commons grp schemas params from ty1 -- ^ expression
88+ -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator
89+ -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery
90+ -> Condition outer commons grp schemas params from
91+subAny expr (?) qry = expr ?
92+ (UnsafeExpression $ "ANY" <+> parenthesized (renderSQL qry))
93+
94+{- |
95+The result is `true` if the left-hand expression's result is equal
96+to any of the right-hand expressions.
97+
98+>>> printSQL $ true `in_` [true, false, null_]
99+TRUE IN (TRUE, FALSE, NULL)
100+-}
101+in_
102+ :: Expression outer commons grp schemas params from ty -- ^ expression
103+ -> [Expression outer commons grp schemas params from ty]
104+ -> Condition outer commons grp schemas params from
105+expr `in_` exprs = UnsafeExpression $ renderSQL expr <+> "IN"
106+ <+> parenthesized (commaSeparated (renderSQL <$> exprs))
107+
108+{- |
109+The result is `true` if the left-hand expression's result is not equal
110+to any of the right-hand expressions.
111+
112+>>> printSQL $ true `notIn` [false, null_]
113+TRUE NOT IN (FALSE, NULL)
114+-}
115+notIn
116+ :: Expression outer commons grp schemas params from ty -- ^ expression
117+ -> [Expression outer commons grp schemas params from ty]
118+ -> Condition outer commons grp schemas params from
119+expr `notIn` exprs = UnsafeExpression $ renderSQL expr <+> "NOT IN"
120+ <+> parenthesized (commaSeparated (renderSQL <$> exprs))
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Text.hs+13−4
@@ -1,3 +1,13 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Text
3+Description: Text expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+String functions and operators
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , OverloadedStrings
@@ -17,21 +27,20 @@ import Squeal.PostgreSQL.Schema
1727
1828-- $setup
1929-- >>> import Squeal.PostgreSQL
20−-- >>> import Squeal.PostgreSQL.Render
2130
2231-- | >>> printSQL $ lower "ARRRGGG"
2332-- lower(E'ARRRGGG')
24−lower :: null 'PGtext :--> null 'PGtext
33+lower :: null 'PGtext --> null 'PGtext
2534lower = unsafeFunction "lower"
2635
2736-- | >>> printSQL $ upper "eeee"
2837-- upper(E'eeee')
29−upper :: null 'PGtext :--> null 'PGtext
38+upper :: null 'PGtext --> null 'PGtext
3039upper = unsafeFunction "upper"
3140
3241-- | >>> printSQL $ charLength "four"
3342-- char_length(E'four')
34−charLength :: null 'PGtext :--> null 'PGint4
43+charLength :: null 'PGtext --> null 'PGint4
3544charLength = unsafeFunction "char_length"
3645
3746-- | The `like` expression returns true if the @string@ matches
squeal-postgresql/src/Squeal/PostgreSQL/Expression/TextSearch.hs+71−21
@@ -1,3 +1,13 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.TextSearch
3+Description: Text search expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Text search functions and operators
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , OverloadedStrings
@@ -32,76 +42,116 @@ import Squeal.PostgreSQL.Expression
3242import Squeal.PostgreSQL.List
3343import Squeal.PostgreSQL.Schema
3444
45+-- | `Squeal.PostgreSQL.Expression.Type.tsvector` matches tsquery ?
3546(@@) :: Operator (null 'PGtsvector) (null 'PGtsquery) ('Null 'PGbool)
3647(@@) = unsafeBinaryOp "@@"
3748
49+-- | AND `Squeal.PostgreSQL.Expression.Type.tsquery`s together
3850(.&) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)
3951(.&) = unsafeBinaryOp "&&"
4052
53+-- | OR `Squeal.PostgreSQL.Expression.Type.tsquery`s together
4154(.|) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)
4255(.|) = unsafeBinaryOp "||"
4356
44−(.!) :: null 'PGtsquery :--> null 'PGtsquery
45−(.!) = unsafeUnaryOpL "!!"
57+-- | negate a `Squeal.PostgreSQL.Expression.Type.tsquery`
58+(.!) :: null 'PGtsquery --> null 'PGtsquery
59+(.!) = unsafeLeftOp "!!"
4660
61+-- | `Squeal.PostgreSQL.Expression.Type.tsquery` followed by
62+-- `Squeal.PostgreSQL.Expression.Type.tsquery`
4763(<->) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)
4864(<->) = unsafeBinaryOp "<->"
4965
66+-- | convert array of lexemes to `Squeal.PostgreSQL.Expression.Type.tsvector`
5067arrayToTSvector
5168 :: null ('PGvararray ('NotNull 'PGtext))
52− :--> null 'PGtsvector
69+ --> null 'PGtsvector
5370arrayToTSvector = unsafeFunction "array_to_tsvector"
5471
55−tsvectorLength :: null 'PGtsvector :--> null 'PGint4
72+-- | number of lexemes in `Squeal.PostgreSQL.Expression.Type.tsvector`
73+tsvectorLength :: null 'PGtsvector --> null 'PGint4
5674tsvectorLength = unsafeFunction "length"
5775
58−numnode :: null 'PGtsquery :--> null 'PGint4
76+-- | number of lexemes plus operators in `Squeal.PostgreSQL.Expression.Type.tsquery`
77+numnode :: null 'PGtsquery --> null 'PGint4
5978numnode = unsafeFunction "numnode"
6079
61−plainToTSquery :: null 'PGtext :--> null 'PGtsquery
80+-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` ignoring punctuation
81+plainToTSquery :: null 'PGtext --> null 'PGtsquery
6282plainToTSquery = unsafeFunction "plainto_tsquery"
6383
64−phraseToTSquery :: null 'PGtext :--> null 'PGtsquery
84+-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` that searches for a phrase,
85+-- ignoring punctuation
86+phraseToTSquery :: null 'PGtext --> null 'PGtsquery
6587phraseToTSquery = unsafeFunction "phraseto_tsquery"
6688
67−websearchToTSquery :: null 'PGtext :--> null 'PGtsquery
89+-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` from a web search style query
90+websearchToTSquery :: null 'PGtext --> null 'PGtsquery
6891websearchToTSquery = unsafeFunction "websearch_to_tsquery"
6992
70−queryTree :: null 'PGtsquery :--> null 'PGtext
93+-- | get indexable part of a `Squeal.PostgreSQL.Expression.Type.tsquery`
94+queryTree :: null 'PGtsquery --> null 'PGtext
7195queryTree = unsafeFunction "query_tree"
7296
73−toTSquery :: null 'PGtext :--> null 'PGtsquery
97+-- | normalize words and convert to `Squeal.PostgreSQL.Expression.Type.tsquery`
98+toTSquery :: null 'PGtext --> null 'PGtsquery
7499toTSquery = unsafeFunction "to_tsquery"
75100
101+-- | reduce document text to `Squeal.PostgreSQL.Expression.Type.tsvector`
76102toTSvector
77103 :: ty `In` '[ 'PGtext, 'PGjson, 'PGjsonb]
78− => null ty :--> null 'PGtsvector
104+ => null ty --> null 'PGtsvector
79105toTSvector = unsafeFunction "to_tsvector"
80106
81−setWeight
82− :: FunctionN '[null 'PGtsvector, null ('PGchar 1)] (null 'PGtsvector)
107+-- | assign weight to each element of `Squeal.PostgreSQL.Expression.Type.tsvector`
108+setWeight :: '[null 'PGtsvector, null ('PGchar 1)] ---> null 'PGtsvector
83109setWeight = unsafeFunctionN "set_weight"
84110
85−strip :: null 'PGtsvector :--> null 'PGtsvector
111+-- | remove positions and weights from `Squeal.PostgreSQL.Expression.Type.tsvector`
112+strip :: null 'PGtsvector --> null 'PGtsvector
86113strip = unsafeFunction "strip"
87114
88−jsonToTSvector :: FunctionN '[null 'PGjson, null 'PGjson] (null 'PGtsvector)
115+-- | @jsonToTSvector (document *: filter)@
116+-- reduce each value in the document, specified by filter to a `Squeal.PostgreSQL.Expression.Type.tsvector`,
117+-- and then concatenate those in document order to produce a single `Squeal.PostgreSQL.Expression.Type.tsvector`.
118+-- filter is a `Squeal.PostgreSQL.Expression.Type.json` array, that enumerates what kind of elements
119+-- need to be included into the resulting `Squeal.PostgreSQL.Expression.Type.tsvector`.
120+-- Possible values for filter are "string" (to include all string values),
121+-- "numeric" (to include all numeric values in the string format),
122+-- "boolean" (to include all Boolean values in the string format "true"/"false"),
123+-- "key" (to include all keys) or "all" (to include all above).
124+-- These values can be combined together to include, e.g. all string and numeric values.
125+jsonToTSvector :: '[null 'PGjson, null 'PGjson] ---> null 'PGtsvector
89126jsonToTSvector = unsafeFunctionN "json_to_tsvector"
90127
91−jsonbToTSvector :: FunctionN '[null 'PGjsonb, null 'PGjsonb] (null 'PGtsvector)
128+-- | @jsonbToTSvector (document *: filter)@
129+-- reduce each value in the document, specified by filter to a `Squeal.PostgreSQL.Expression.Type.tsvector`,
130+-- and then concatenate those in document order to produce a single `Squeal.PostgreSQL.Expression.Type.tsvector`.
131+-- filter is a `Squeal.PostgreSQL.Expression.Type.jsonb` array, that enumerates what kind of elements
132+-- need to be included into the resulting `Squeal.PostgreSQL.Expression.Type.tsvector`.
133+-- Possible values for filter are "string" (to include all string values),
134+-- "numeric" (to include all numeric values in the string format),
135+-- "boolean" (to include all Boolean values in the string format "true"/"false"),
136+-- "key" (to include all keys) or "all" (to include all above).
137+-- These values can be combined together to include, e.g. all string and numeric values.
138+jsonbToTSvector :: '[null 'PGjsonb, null 'PGjsonb] ---> null 'PGtsvector
92139jsonbToTSvector = unsafeFunctionN "jsonb_to_tsvector"
93140
94−tsDelete :: FunctionN
141+-- | remove given lexeme from `Squeal.PostgreSQL.Expression.Type.tsvector`
142+tsDelete ::
95143 '[null 'PGtsvector, null ('PGvararray ('NotNull 'PGtext))]
96− (null 'PGtsvector)
144+ ---> null 'PGtsvector
97145tsDelete = unsafeFunctionN "ts_delete"
98146
99−tsFilter :: FunctionN
147+-- | select only elements with given weights from `Squeal.PostgreSQL.Expression.Type.tsvector`
148+tsFilter ::
100149 '[null 'PGtsvector, null ('PGvararray ('NotNull ('PGchar 1)))]
101− (null 'PGtsvector)
150+ ---> null 'PGtsvector
102151tsFilter = unsafeFunctionN "ts_filter"
103152
153+-- | display a `Squeal.PostgreSQL.Expression.Type.tsquery` match
104154tsHeadline
105155 :: document `In` '[ 'PGtext, 'PGjson, 'PGjsonb]
106− => FunctionN '[null document, null 'PGtsquery] (null 'PGtext)
156+ => '[null document, null 'PGtsquery] ---> null 'PGtext
107157tsHeadline = unsafeFunctionN "ts_headline"
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Time.hs+18−12
@@ -1,3 +1,13 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Time
3+Description: Date/Time expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Date/Time functions and operators
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , DeriveGeneric
@@ -7,6 +17,7 @@
717 , OverloadedStrings
818 , PolyKinds
919 , RankNTypes
20+ , TypeOperators
1021#-}
1122
1223module Squeal.PostgreSQL.Expression.Time
@@ -75,9 +86,7 @@ Create date from year, month and day fields
7586>>> printSQL (makeDate (1984 :* 7 *: 3))
7687make_date(1984, 7, 3)
7788-}
78−makeDate :: FunctionN
79− '[ null 'PGint4, null 'PGint4, null 'PGint4 ]
80− ( null 'PGdate )
89+makeDate :: '[ null 'PGint4, null 'PGint4, null 'PGint4 ] ---> null 'PGdate
8190makeDate = unsafeFunctionN "make_date"
8291
8392{-|
@@ -86,9 +95,7 @@ Create time from hour, minute and seconds fields
8695>>> printSQL (makeTime (8 :* 15 *: 23.5))
8796make_time(8, 15, 23.5)
8897-}
89−makeTime :: FunctionN
90− '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ]
91− ( null 'PGtime )
98+makeTime :: '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtime
9299makeTime = unsafeFunctionN "make_time"
93100
94101{-|
@@ -97,10 +104,9 @@ Create timestamp from year, month, day, hour, minute and seconds fields
97104>>> printSQL (makeTimestamp (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))
98105make_timestamp(2013, 7, 15, 8, 15, 23.5)
99106-}
100−makeTimestamp :: FunctionN
107+makeTimestamp ::
101108 '[ null 'PGint4, null 'PGint4, null 'PGint4
102− , null 'PGint4, null 'PGint4, null 'PGfloat8 ]
103− ( null 'PGtimestamp )
109+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamp
104110makeTimestamp = unsafeFunctionN "make_timestamp"
105111
106112{-|
@@ -111,10 +117,9 @@ the current time zone is used
111117>>> printSQL (makeTimestamptz (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))
112118make_timestamptz(2013, 7, 15, 8, 15, 23.5)
113119-}
114−makeTimestamptz :: FunctionN
120+makeTimestamptz ::
115121 '[ null 'PGint4, null 'PGint4, null 'PGint4
116− , null 'PGint4, null 'PGint4, null 'PGfloat8 ]
117− ( null 'PGtimestamptz )
122+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamptz
118123makeTimestamptz = unsafeFunctionN "make_timestamptz"
119124
120125{-|
@@ -156,6 +161,7 @@ infixl 6 +!
156161infixl 6 !-
157162infixl 6 !-!
158163
164+-- | A `TimeUnit` to use in `interval_` construction.
159165data TimeUnit
160166 = Years | Months | Weeks | Days
161167 | Hours | Minutes | Seconds
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Type.hsnew file+446
@@ -0,0 +1,446 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression
3+Description: Type expressions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Type expressions.
9+-}
10+
11+{-# LANGUAGE
12+ AllowAmbiguousTypes
13+ , DataKinds
14+ , DeriveGeneric
15+ , FlexibleContexts
16+ , FlexibleInstances
17+ , GADTs
18+ , GeneralizedNewtypeDeriving
19+ , KindSignatures
20+ , MultiParamTypeClasses
21+ , OverloadedStrings
22+ , RankNTypes
23+ , ScopedTypeVariables
24+ , TypeApplications
25+ , TypeOperators
26+ , UndecidableInstances
27+#-}
28+
29+module Squeal.PostgreSQL.Expression.Type
30+ ( -- * type casting
31+ cast
32+ , astype
33+ , inferredtype
34+ -- * type expressions
35+ , TypeExpression (..)
36+ , typedef
37+ , typetable
38+ , typeview
39+ , bool
40+ , int2
41+ , smallint
42+ , int4
43+ , int
44+ , integer
45+ , int8
46+ , bigint
47+ , numeric
48+ , float4
49+ , real
50+ , float8
51+ , doublePrecision
52+ , money
53+ , text
54+ , char
55+ , character
56+ , varchar
57+ , characterVarying
58+ , bytea
59+ , timestamp
60+ , timestampWithTimeZone
61+ , timestamptz
62+ , date
63+ , time
64+ , timeWithTimeZone
65+ , timetz
66+ , interval
67+ , uuid
68+ , inet
69+ , json
70+ , jsonb
71+ , vararray
72+ , fixarray
73+ , tsvector
74+ , tsquery
75+ , oid
76+ , int4range
77+ , int8range
78+ , numrange
79+ , tsrange
80+ , tstzrange
81+ , daterange
82+ -- * column type definitions
83+ , ColumnTypeExpression (..)
84+ , nullable
85+ , notNullable
86+ , default_
87+ , serial2
88+ , smallserial
89+ , serial4
90+ , serial
91+ , serial8
92+ , bigserial
93+ , hask
94+ -- * type inference
95+ , PGTyped (..)
96+ , PGNullityTyped (..)
97+ , FieldTyped (..)
98+ ) where
99+
100+import Control.DeepSeq
101+import Data.ByteString
102+import Data.String
103+import GHC.TypeLits
104+
105+import qualified Data.ByteString as ByteString
106+import qualified GHC.Generics as GHC
107+import qualified Generics.SOP as SOP
108+
109+import Squeal.PostgreSQL.Alias
110+import Squeal.PostgreSQL.Expression
111+import Squeal.PostgreSQL.PG
112+import Squeal.PostgreSQL.Render
113+import Squeal.PostgreSQL.Schema
114+
115+-- $setup
116+-- >>> import Squeal.PostgreSQL
117+
118+-- When a `cast` is applied to an `Expression` of a known type, it
119+-- represents a run-time type conversion. The cast will succeed only if a
120+-- suitable type conversion operation has been defined.
121+--
122+-- | >>> printSQL $ true & cast int4
123+-- (TRUE :: int4)
124+cast
125+ :: TypeExpression schemas ty1
126+ -- ^ type to cast as
127+ -> Expression outer commons grp schemas params from ty0
128+ -- ^ value to convert
129+ -> Expression outer commons grp schemas params from ty1
130+cast ty x = UnsafeExpression $ parenthesized $
131+ renderSQL x <+> "::" <+> renderSQL ty
132+
133+-- | A safe version of `cast` which just matches a value with its type.
134+--
135+-- >>> printSQL (1 & astype int)
136+-- (1 :: int)
137+astype
138+ :: TypeExpression schemas ty
139+ -- ^ type to specify as
140+ -> Expression outer commons grp schemas params from ty
141+ -- ^ value
142+ -> Expression outer commons grp schemas params from ty
143+astype = cast
144+
145+-- | `inferredtype` will add a type annotation to an `Expression`
146+-- which can be useful for fixing the storage type of a value.
147+--
148+-- >>> printSQL (inferredtype true)
149+-- (TRUE :: bool)
150+inferredtype
151+ :: PGTyped schemas ty
152+ => Expression outer common grp schemas params from ty
153+ -- ^ value
154+ -> Expression outer common grp schemas params from ty
155+inferredtype = astype pgtype
156+
157+{-----------------------------------------
158+type expressions
159+-----------------------------------------}
160+
161+-- | `TypeExpression`s are used in `cast`s and
162+-- `Squeal.PostgreSQL.Definition.createTable` commands.
163+newtype TypeExpression (schemas :: SchemasType) (ty :: NullityType)
164+ = UnsafeTypeExpression { renderTypeExpression :: ByteString }
165+ deriving (GHC.Generic,Show,Eq,Ord,NFData)
166+instance RenderSQL (TypeExpression schemas ty) where
167+ renderSQL = renderTypeExpression
168+
169+-- | The enum or composite type in a `Typedef` can be expressed by its alias.
170+typedef
171+ :: (Has sch schemas schema, Has td schema ('Typedef ty))
172+ => QualifiedAlias sch td
173+ -- ^ type alias
174+ -> TypeExpression schemas (null ty)
175+typedef = UnsafeTypeExpression . renderSQL
176+
177+-- | The composite type corresponding to a `Table` definition can be expressed
178+-- by its alias.
179+typetable
180+ :: (Has sch schemas schema, Has tab schema ('Table table))
181+ => QualifiedAlias sch tab
182+ -- ^ table alias
183+ -> TypeExpression schemas (null ('PGcomposite (TableToRow table)))
184+typetable = UnsafeTypeExpression . renderSQL
185+
186+-- | The composite type corresponding to a `View` definition can be expressed
187+-- by its alias.
188+typeview
189+ :: (Has sch schemas schema, Has vw schema ('View view))
190+ => QualifiedAlias sch vw
191+ -- ^ view alias
192+ -> TypeExpression schemas (null ('PGcomposite view))
193+typeview = UnsafeTypeExpression . renderSQL
194+
195+-- | logical Boolean (true/false)
196+bool :: TypeExpression schemas (null 'PGbool)
197+bool = UnsafeTypeExpression "bool"
198+-- | signed two-byte integer
199+int2, smallint :: TypeExpression schemas (null 'PGint2)
200+int2 = UnsafeTypeExpression "int2"
201+smallint = UnsafeTypeExpression "smallint"
202+-- | signed four-byte integer
203+int4, int, integer :: TypeExpression schemas (null 'PGint4)
204+int4 = UnsafeTypeExpression "int4"
205+int = UnsafeTypeExpression "int"
206+integer = UnsafeTypeExpression "integer"
207+-- | signed eight-byte integer
208+int8, bigint :: TypeExpression schemas (null 'PGint8)
209+int8 = UnsafeTypeExpression "int8"
210+bigint = UnsafeTypeExpression "bigint"
211+-- | arbitrary precision numeric type
212+numeric :: TypeExpression schemas (null 'PGnumeric)
213+numeric = UnsafeTypeExpression "numeric"
214+-- | single precision floating-point number (4 bytes)
215+float4, real :: TypeExpression schemas (null 'PGfloat4)
216+float4 = UnsafeTypeExpression "float4"
217+real = UnsafeTypeExpression "real"
218+-- | double precision floating-point number (8 bytes)
219+float8, doublePrecision :: TypeExpression schemas (null 'PGfloat8)
220+float8 = UnsafeTypeExpression "float8"
221+doublePrecision = UnsafeTypeExpression "double precision"
222+-- | currency amount
223+money :: TypeExpression schema (null 'PGmoney)
224+money = UnsafeTypeExpression "money"
225+-- | variable-length character string
226+text :: TypeExpression schemas (null 'PGtext)
227+text = UnsafeTypeExpression "text"
228+-- | fixed-length character string
229+char, character
230+ :: forall n schemas null. (KnownNat n, 1 <= n)
231+ => TypeExpression schemas (null ('PGchar n))
232+char = UnsafeTypeExpression $ "char(" <> renderNat @n <> ")"
233+character = UnsafeTypeExpression $ "character(" <> renderNat @n <> ")"
234+-- | variable-length character string
235+varchar, characterVarying
236+ :: forall n schemas null. (KnownNat n, 1 <= n)
237+ => TypeExpression schemas (null ('PGvarchar n))
238+varchar = UnsafeTypeExpression $ "varchar(" <> renderNat @n <> ")"
239+characterVarying = UnsafeTypeExpression $
240+ "character varying(" <> renderNat @n <> ")"
241+-- | binary data ("byte array")
242+bytea :: TypeExpression schemas (null 'PGbytea)
243+bytea = UnsafeTypeExpression "bytea"
244+-- | date and time (no time zone)
245+timestamp :: TypeExpression schemas (null 'PGtimestamp)
246+timestamp = UnsafeTypeExpression "timestamp"
247+-- | date and time, including time zone
248+timestampWithTimeZone, timestamptz :: TypeExpression schemas (null 'PGtimestamptz)
249+timestampWithTimeZone = UnsafeTypeExpression "timestamp with time zone"
250+timestamptz = UnsafeTypeExpression "timestamptz"
251+-- | calendar date (year, month, day)
252+date :: TypeExpression schemas (null 'PGdate)
253+date = UnsafeTypeExpression "date"
254+-- | time of day (no time zone)
255+time :: TypeExpression schemas (null 'PGtime)
256+time = UnsafeTypeExpression "time"
257+-- | time of day, including time zone
258+timeWithTimeZone, timetz :: TypeExpression schemas (null 'PGtimetz)
259+timeWithTimeZone = UnsafeTypeExpression "time with time zone"
260+timetz = UnsafeTypeExpression "timetz"
261+-- | time span
262+interval :: TypeExpression schemas (null 'PGinterval)
263+interval = UnsafeTypeExpression "interval"
264+-- | universally unique identifier
265+uuid :: TypeExpression schemas (null 'PGuuid)
266+uuid = UnsafeTypeExpression "uuid"
267+-- | IPv4 or IPv6 host address
268+inet :: TypeExpression schemas (null 'PGinet)
269+inet = UnsafeTypeExpression "inet"
270+-- | textual JSON data
271+json :: TypeExpression schemas (null 'PGjson)
272+json = UnsafeTypeExpression "json"
273+-- | binary JSON data, decomposed
274+jsonb :: TypeExpression schemas (null 'PGjsonb)
275+jsonb = UnsafeTypeExpression "jsonb"
276+-- | variable length array
277+vararray
278+ :: TypeExpression schemas pg
279+ -> TypeExpression schemas (null ('PGvararray pg))
280+vararray ty = UnsafeTypeExpression $ renderSQL ty <> "[]"
281+-- | fixed length array
282+--
283+-- >>> renderSQL (fixarray @'[2] json)
284+-- "json[2]"
285+fixarray
286+ :: forall dims schemas null pg. SOP.All KnownNat dims
287+ => TypeExpression schemas pg
288+ -> TypeExpression schemas (null ('PGfixarray dims pg))
289+fixarray ty = UnsafeTypeExpression $
290+ renderSQL ty <> renderDims @dims
291+ where
292+ renderDims :: forall ns. SOP.All KnownNat ns => ByteString
293+ renderDims =
294+ ("[" <>)
295+ . (<> "]")
296+ . ByteString.intercalate "]["
297+ . SOP.hcollapse
298+ $ SOP.hcmap (SOP.Proxy @KnownNat)
299+ (K . fromString . show . natVal)
300+ (SOP.hpure SOP.Proxy :: SOP.NP SOP.Proxy ns)
301+-- | text search query
302+tsvector :: TypeExpression schemas (null 'PGtsvector)
303+tsvector = UnsafeTypeExpression "tsvector"
304+-- | text search document
305+tsquery :: TypeExpression schemas (null 'PGtsquery)
306+tsquery = UnsafeTypeExpression "tsquery"
307+-- | Object identifiers (OIDs) are used internally by PostgreSQL
308+-- as primary keys for various system tables.
309+oid :: TypeExpression schemas (null 'PGoid)
310+oid = UnsafeTypeExpression "oid"
311+-- | Range of integer
312+int4range :: TypeExpression schemas (null ('PGrange 'PGint4))
313+int4range = UnsafeTypeExpression "int4range"
314+-- | Range of bigint
315+int8range :: TypeExpression schemas (null ('PGrange 'PGint8))
316+int8range = UnsafeTypeExpression "int8range"
317+-- | Range of numeric
318+numrange :: TypeExpression schemas (null ('PGrange 'PGnumeric))
319+numrange = UnsafeTypeExpression "numrange"
320+-- | Range of timestamp without time zone
321+tsrange :: TypeExpression schemas (null ('PGrange 'PGtimestamp))
322+tsrange = UnsafeTypeExpression "tsrange"
323+-- | Range of timestamp with time zone
324+tstzrange :: TypeExpression schemas (null ('PGrange 'PGtimestamptz))
325+tstzrange = UnsafeTypeExpression "tstzrange"
326+-- | Range of date
327+daterange :: TypeExpression schemas (null ('PGrange 'PGdate))
328+daterange = UnsafeTypeExpression "daterange"
329+
330+-- | `pgtype` is a demoted version of a `PGType`
331+class PGTyped schemas (ty :: NullityType) where
332+ pgtype :: TypeExpression schemas ty
333+instance PGTyped schemas (null 'PGbool) where pgtype = bool
334+instance PGTyped schemas (null 'PGint2) where pgtype = int2
335+instance PGTyped schemas (null 'PGint4) where pgtype = int4
336+instance PGTyped schemas (null 'PGint8) where pgtype = int8
337+instance PGTyped schemas (null 'PGnumeric) where pgtype = numeric
338+instance PGTyped schemas (null 'PGfloat4) where pgtype = float4
339+instance PGTyped schemas (null 'PGfloat8) where pgtype = float8
340+instance PGTyped schemas (null 'PGmoney) where pgtype = money
341+instance PGTyped schemas (null 'PGtext) where pgtype = text
342+instance (KnownNat n, 1 <= n)
343+ => PGTyped schemas (null ('PGchar n)) where pgtype = char @n
344+instance (KnownNat n, 1 <= n)
345+ => PGTyped schemas (null ('PGvarchar n)) where pgtype = varchar @n
346+instance PGTyped schemas (null 'PGbytea) where pgtype = bytea
347+instance PGTyped schemas (null 'PGtimestamp) where pgtype = timestamp
348+instance PGTyped schemas (null 'PGtimestamptz) where pgtype = timestampWithTimeZone
349+instance PGTyped schemas (null 'PGdate) where pgtype = date
350+instance PGTyped schemas (null 'PGtime) where pgtype = time
351+instance PGTyped schemas (null 'PGtimetz) where pgtype = timeWithTimeZone
352+instance PGTyped schemas (null 'PGinterval) where pgtype = interval
353+instance PGTyped schemas (null 'PGuuid) where pgtype = uuid
354+instance PGTyped schemas (null 'PGjson) where pgtype = json
355+instance PGTyped schemas (null 'PGjsonb) where pgtype = jsonb
356+instance PGTyped schemas ty
357+ => PGTyped schemas (null ('PGvararray ty)) where
358+ pgtype = vararray (pgtype @schemas @ty)
359+instance (SOP.All KnownNat dims, PGTyped schemas ty)
360+ => PGTyped schemas (null ('PGfixarray dims ty)) where
361+ pgtype = fixarray @dims (pgtype @schemas @ty)
362+instance PGTyped schemas (null 'PGtsvector) where pgtype = tsvector
363+instance PGTyped schemas (null 'PGtsquery) where pgtype = tsquery
364+instance PGTyped schemas (null 'PGoid) where pgtype = oid
365+instance PGTyped schemas (null ('PGrange 'PGint4)) where pgtype = int4range
366+instance PGTyped schemas (null ('PGrange 'PGint8)) where pgtype = int8range
367+instance PGTyped schemas (null ('PGrange 'PGnumeric)) where pgtype = numrange
368+instance PGTyped schemas (null ('PGrange 'PGtimestamp)) where pgtype = tsrange
369+instance PGTyped schemas (null ('PGrange 'PGtimestamptz)) where pgtype = tstzrange
370+instance PGTyped schemas (null ('PGrange 'PGdate)) where pgtype = daterange
371+
372+-- | Lift `PGTyped` to a field
373+class FieldTyped schemas ty where
374+ fieldtype :: Aliased (TypeExpression schemas) ty
375+instance (KnownSymbol alias, PGTyped schemas ty)
376+ => FieldTyped schemas (alias ::: ty) where
377+ fieldtype = pgtype `As` Alias
378+
379+-- | `ColumnTypeExpression`s are used in `createTable` commands.
380+newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)
381+ = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }
382+ deriving (GHC.Generic,Show,Eq,Ord,NFData)
383+instance RenderSQL (ColumnTypeExpression schemas ty) where
384+ renderSQL = renderColumnTypeExpression
385+
386+-- | used in `createTable` commands as a column constraint to note that
387+-- @NULL@ may be present in a column
388+nullable
389+ :: TypeExpression schemas (nullity ty)
390+ -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)
391+nullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NULL"
392+
393+-- | used in `createTable` commands as a column constraint to ensure
394+-- @NULL@ is not present in a column
395+notNullable
396+ :: TypeExpression schemas (nullity ty)
397+ -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)
398+notNullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NOT NULL"
399+
400+-- | used in `createTable` commands as a column constraint to give a default
401+default_
402+ :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty
403+ -> ColumnTypeExpression schemas ('NoDef :=> ty)
404+ -> ColumnTypeExpression schemas ('Def :=> ty)
405+default_ x ty = UnsafeColumnTypeExpression $
406+ renderSQL ty <+> "DEFAULT" <+> renderExpression x
407+
408+-- | not a true type, but merely a notational convenience for creating
409+-- unique identifier columns with type `PGint2`
410+serial2, smallserial
411+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)
412+serial2 = UnsafeColumnTypeExpression "serial2"
413+smallserial = UnsafeColumnTypeExpression "smallserial"
414+-- | not a true type, but merely a notational convenience for creating
415+-- unique identifier columns with type `PGint4`
416+serial4, serial
417+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)
418+serial4 = UnsafeColumnTypeExpression "serial4"
419+serial = UnsafeColumnTypeExpression "serial"
420+-- | not a true type, but merely a notational convenience for creating
421+-- unique identifier columns with type `PGint8`
422+serial8, bigserial
423+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)
424+serial8 = UnsafeColumnTypeExpression "serial8"
425+bigserial = UnsafeColumnTypeExpression "bigserial"
426+
427+-- | Like @PGTyped@ but also accounts for nullity.
428+class PGNullityTyped schemas (nullty :: NullityType) where
429+ pgNullityType :: ColumnTypeExpression schemas ('NoDef :=> nullty)
430+
431+instance PGTyped schemas ('Null ty) => PGNullityTyped schemas ('Null ty) where
432+ pgNullityType = nullable (pgtype @_ @('Null ty))
433+
434+instance PGTyped schemas ('NotNull ty) => PGNullityTyped schemas ('NotNull ty) where
435+ pgNullityType = notNullable (pgtype @_ @('NotNull ty))
436+
437+-- | Allow you to specify pg column types in relation to haskell types.
438+-- >>> printSQL $ hask @(Maybe String)
439+-- text NULL
440+--
441+-- >>> printSQL $ hask @Double
442+-- float8 NOT NULL
443+hask
444+ :: forall hask schemas. PGNullityTyped schemas (NullPG hask)
445+ => ColumnTypeExpression schemas ('NoDef :=> NullPG hask)
446+hask = pgNullityType
squeal-postgresql/src/Squeal/PostgreSQL/Expression/Window.hs+44−6
@@ -1,3 +1,13 @@
1+{-|
2+Module: Squeal.PostgreSQL.Expression.Window
3+Description: Window functions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Window functions and definitions
9+-}
10+
111{-# LANGUAGE
212 DataKinds
313 , DeriveGeneric
@@ -13,9 +23,8 @@
1323#-}
1424
1525module Squeal.PostgreSQL.Expression.Window
16− ( WindowDefinition (..)
17− , partitionBy
18− , WindowFunction (..)
26+ ( -- * functions
27+ partitionBy
1928 , rank
2029 , rowNumber
2130 , denseRank
@@ -27,6 +36,14 @@ module Squeal.PostgreSQL.Expression.Window
2736 , firstValue
2837 , lastValue
2938 , nthValue
39+ , unsafeWindowFunction1
40+ , unsafeWindowFunctionN
41+ -- * types
42+ , WindowFunction (..)
43+ , WindowDefinition (..)
44+ , WinFun0
45+ , WinFun1
46+ , WinFunN
3047 ) where
3148
3249import Control.DeepSeq
@@ -80,14 +97,15 @@ instance Aggregate
8097 varPop = unsafeWindowFunction1 "var_pop"
8198 varSamp = unsafeWindowFunction1 "var_samp"
8299
83−
84100-- | A `WindowDefinition` is a set of table rows that are somehow related
85101-- to the current row
86102data WindowDefinition outer commons grp schemas params from where
87103 WindowDefinition
88104 :: SOP.SListI bys
89105 => NP (Expression outer commons grp schemas params from) bys
106+ -- ^ `partitionBy` clause
90107 -> [SortExpression outer commons grp schemas params from]
108+ -- ^ `Squeal.PostgreSQL.Expression.Sort.orderBy` clause
91109 -> WindowDefinition outer commons grp schemas params from
92110
93111instance OrderBy WindowDefinition where
@@ -114,7 +132,7 @@ the same partition as the current row.
114132-}
115133partitionBy
116134 :: SOP.SListI bys
117− => NP (Expression outer commons grp schemas params from) bys
135+ => NP (Expression outer commons grp schemas params from) bys -- ^ partitions
118136 -> WindowDefinition outer commons grp schemas params from
119137partitionBy bys = WindowDefinition bys []
120138
@@ -142,11 +160,17 @@ newtype WindowFunction
142160instance RenderSQL (WindowFunction outer commons grp schemas params from ty) where
143161 renderSQL = renderWindowFunction
144162
163+{- |
164+A @RankNType@ for window functions with no arguments.
165+-}
145166type WinFun0 x
146167 = forall outer commons grp schemas params from
147168 . WindowFunction outer commons grp schemas params from x
148169 -- ^ cannot reference aliases
149170
171+{- |
172+A @RankNType@ for window functions with 1 argument.
173+-}
150174type WinFun1 x y
151175 = forall outer commons grp schemas params from
152176 . Expression outer commons grp schemas params from x
@@ -154,6 +178,10 @@ type WinFun1 x y
154178 -> WindowFunction outer commons grp schemas params from y
155179 -- ^ output
156180
181+{- | A @RankNType@ for window functions with a fixed-length
182+list of heterogeneous arguments.
183+Use the `*:` operator to end your argument lists.
184+-}
157185type WinFunN xs y
158186 = forall outer commons grp schemas params from
159187 . NP (Expression outer commons grp schemas params from) xs
@@ -161,15 +189,18 @@ type WinFunN xs y
161189 -> WindowFunction outer commons grp schemas params from y
162190 -- ^ output
163191
192+-- | escape hatch for defining window functions
164193unsafeWindowFunction1 :: ByteString -> WinFun1 x y
165194unsafeWindowFunction1 fun x
166195 = UnsafeWindowFunction $ fun <> parenthesized (renderSQL x)
167196
197+-- | escape hatch for defining multi-argument window functions
168198unsafeWindowFunctionN :: SOP.SListI xs => ByteString -> WinFunN xs y
169199unsafeWindowFunctionN fun xs = UnsafeWindowFunction $ fun <>
170200 parenthesized (renderCommaSeparated renderSQL xs)
171201
172202{- | rank of the current row with gaps; same as `rowNumber` of its first peer
203+
173204>>> printSQL rank
174205rank()
175206-}
@@ -177,6 +208,7 @@ rank :: WinFun0 ('NotNull 'PGint8)
177208rank = UnsafeWindowFunction "rank()"
178209
179210{- | number of the current row within its partition, counting from 1
211+
180212>>> printSQL rowNumber
181213row_number()
182214-}
@@ -184,6 +216,7 @@ rowNumber :: WinFun0 ('NotNull 'PGint8)
184216rowNumber = UnsafeWindowFunction "row_number()"
185217
186218{- | rank of the current row without gaps; this function counts peer groups
219+
187220>>> printSQL denseRank
188221dense_rank()
189222-}
@@ -191,6 +224,7 @@ denseRank :: WinFun0 ('NotNull 'PGint8)
191224denseRank = UnsafeWindowFunction "dense_rank()"
192225
193226{- | relative rank of the current row: (rank - 1) / (total partition rows - 1)
227+
194228>>> printSQL percentRank
195229percent_rank()
196230-}
@@ -199,6 +233,7 @@ percentRank = UnsafeWindowFunction "percent_rank()"
199233
200234{- | cumulative distribution: (number of partition rows
201235preceding or peer with current row) / total partition rows
236+
202237>>> printSQL cumeDist
203238cume_dist()
204239-}
@@ -207,6 +242,9 @@ cumeDist = UnsafeWindowFunction "cume_dist()"
207242
208243{- | integer ranging from 1 to the argument value,
209244dividing the partition as equally as possible
245+
246+>>> printSQL $ ntile 5
247+ntile(5)
210248-}
211249ntile :: WinFun1 ('NotNull 'PGint4) ('NotNull 'PGint4)
212250ntile = unsafeWindowFunction1 "ntile"
@@ -225,7 +263,7 @@ row within the partition; if there is no such row, instead return default
225263evaluated with respect to the current row.
226264-}
227265lead :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty
228−lead = unsafeWindowFunctionN "lag"
266+lead = unsafeWindowFunctionN "lead"
229267
230268{- | returns value evaluated at the row that is the
231269first row of the window frame
squeal-postgresql/src/Squeal/PostgreSQL/List.hs+40−51
@@ -1,3 +1,15 @@
1+{-|
2+Module: Squeal.PostgreSQL.List
3+Description: List related types and functions
4+Copyright: (c) Eitan Chatav, 2019
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+Haskell singly-linked lists are very powerful. This module
9+provides functionality for type-level lists, heterogeneous
10+lists and type aligned lists.
11+-}
12+
113{-# LANGUAGE
214 DataKinds
315 , FlexibleContexts
@@ -19,39 +31,31 @@ module Squeal.PostgreSQL.List
1931 ( SOP.NP (..)
2032 , (*:)
2133 , Join
22− , (+++)
2334 , disjoin
24− , AlignedList (..)
25− , single
26− , extractList
27− , alignedMap
35+ , Additional (..)
36+ , Path (..)
37+ , CFunctor (..)
38+ , CFoldable (..)
39+ , CFree (..)
2840 , Elem
2941 , In
3042 , Length
3143 ) where
3244
33−import Control.Category
45+import Control.Category.Free
46+import Data.Function ((&))
3447import Data.Kind
3548import Data.Type.Bool
3649import GHC.TypeLits
3750
3851import Generics.SOP as SOP
3952
40−import Squeal.PostgreSQL.Render
41−
4253-- | `Join` is simply promoted `++` and is used in @JOIN@s in
4354-- `Squeal.PostgreSQL.Query.FromClause`s.
4455type family Join xs ys where
4556 Join '[] ys = ys
4657 Join (x ': xs) ys = x ': Join xs ys
4758
48−-- | Concatenate `NP` lists.
49−(+++) :: NP f xs -> NP f ys -> NP f (Join xs ys)
50−xs +++ ys = case xs of
51− Nil -> ys
52− x :* xs' -> x :* (xs' +++ ys)
53−infixr 5 +++
54−
5559-- | `disjoin` is a utility function for splitting an `NP` list into pieces.
5660disjoin
5761 :: forall xs ys expr. SListI xs
@@ -62,39 +66,15 @@ disjoin = case sList @xs of
6266 SCons -> \(x :* xsys) ->
6367 case disjoin xsys of (xs,ys) -> (x :* xs, ys)
6468
65−-- | An `AlignedList` is a type-aligned list or free category.
66−data AlignedList p x0 x1 where
67− Done :: AlignedList p x x
68− (:>>) :: p x0 x1 -> AlignedList p x1 x2 -> AlignedList p x0 x2
69−infixr 7 :>>
70−instance Category (AlignedList p) where
71− id = Done
72− (.) list = \case
73− Done -> list
74− step :>> steps -> step :>> (steps >>> list)
75−instance (forall t0 t1. RenderSQL (p t0 t1))
76− => RenderSQL (AlignedList p x0 x1) where
77− renderSQL = \case
78− Done -> ""
79− step :>> Done -> renderSQL step
80− step :>> steps -> renderSQL step <> ", " <> renderSQL steps
81−
82−extractList :: (forall a0 a1. p a0 a1 -> b) -> AlignedList p x0 x1 -> [b]
83−extractList f = \case
84− Done -> []
85− step :>> steps -> (f step):extractList f steps
86−
87−alignedMap
88− :: (forall z0 z1. p z0 z1 -> q z0 z1)
89− -> AlignedList p x0 x1
90− -> AlignedList q x0 x1
91−alignedMap f = \case
92− Done -> Done
93− x :>> xs -> f x :>> alignedMap f xs
94−
95−-- | A `single` step.
96−single :: p x0 x1 -> AlignedList p x0 x1
97−single step = step :>> Done
69+-- | The `Additional` class is for appending
70+-- type-level list parameterized constructors such as `NP`,
71+-- `Squeal.PostgreSQL.Query.Selection`, and `Squeal.PostgreSQL.Query.FromClause`.
72+class Additional expr where
73+ also :: expr ys -> expr xs -> expr (Join xs ys)
74+instance Additional (NP expr) where
75+ also ys = \case
76+ Nil -> ys
77+ x :* xs -> x :* (xs & also ys)
9878
9979-- | A useful operator for ending an `NP` list of length at least 2 without `Nil`.
10080(*:) :: f x -> f y -> NP f '[x,y]
@@ -104,13 +84,18 @@ infixl 9 *:
10484-- | @Elem@ is a promoted `Data.List.elem`.
10585type family Elem x xs where
10686 Elem x '[] = 'False
107− Elem x (x ': xs) = 'True
87+ Elem x (x ': _) = 'True
88+ Elem x (_ ': x ': _) = 'True
89+ Elem x (_ ': _ ': x ': _) = 'True
90+ Elem x (_ ': _ ': _ ': x ': _) = 'True
91+ Elem x (_ ': _ ': _ ': _ ': x ': _) = 'True
92+ Elem x (_ ': _ ': _ ': _ ': _ ': x ': _) = 'True
10893 Elem x (_ ': xs) = Elem x xs
10994
11095-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.
11196type family In x xs :: Constraint where
11297 In x xs = If (Elem x xs) (() :: Constraint)
113− (TypeError ('ShowType x ':<>: 'Text "is not in " ':<>: 'ShowType xs))
98+ (TypeError ('ShowType x ':<>: 'Text " is not in " ':<>: 'ShowType xs))
11499
115100{- | Calculate the `Length` of a type level list
116101
@@ -119,5 +104,9 @@ Length '[Char,String,Bool,Double] :: Nat
119104= 4
120105-}
121106type family Length (xs :: [k]) :: Nat where
122− Length (x : xs) = 1 + Length xs
107+ Length (_ ': _ ': _ ': _ ': _ : xs) = 5 + Length xs
108+ Length (_ ': _ ': _ ': _ : xs) = 4 + Length xs
109+ Length (_ ': _ ': _ : xs) = 3 + Length xs
110+ Length (_ ': _ : xs) = 2 + Length xs
111+ Length (_ : xs) = 1 + Length xs
123112 Length '[] = 0
squeal-postgresql/src/Squeal/PostgreSQL/Manipulation.hs+155−168
@@ -18,6 +18,7 @@ Squeal data manipulation language.
1818 , MultiParamTypeClasses
1919 , OverloadedStrings
2020 , PatternSynonyms
21+ , QuantifiedConstraints
2122 , RankNTypes
2223 , ScopedTypeVariables
2324 , TypeApplications
@@ -29,19 +30,9 @@ Squeal data manipulation language.
2930
3031module Squeal.PostgreSQL.Manipulation
3132 ( -- * Manipulation
32− Manipulation (..)
33− , Manipulation_
33+ Manipulation_
34+ , Manipulation (..)
3435 , queryStatement
35− , QueryClause (..)
36− , pattern Values_
37− , DefaultAliasable (..)
38− , ColumnExpression (..)
39− , ReturningClause (..)
40− , pattern Returning_
41− , ConflictClause (..)
42− , ConflictTarget (..)
43− , ConflictAction (..)
44− , UsingClause (..)
4536 -- * Insert
4637 , insertInto
4738 , insertInto_
@@ -51,13 +42,21 @@ module Squeal.PostgreSQL.Manipulation
5142 -- * Delete
5243 , deleteFrom
5344 , deleteFrom_
54− , also
45+ -- * Clauses
46+ , Optional (..)
47+ , QueryClause (..)
48+ , pattern Values_
49+ , ReturningClause (..)
50+ , pattern Returning_
51+ , ConflictClause (..)
52+ , ConflictTarget (..)
53+ , ConflictAction (..)
54+ , UsingClause (..)
5555 ) where
5656
5757import Control.DeepSeq
5858import Data.ByteString hiding (foldr)
5959import Data.Kind (Type)
60−import GHC.TypeLits (KnownSymbol)
6160
6261import qualified Generics.SOP as SOP
6362import qualified GHC.Generics as GHC
@@ -73,21 +72,65 @@ import Squeal.PostgreSQL.Schema
7372
7473-- $setup
7574-- >>> import Squeal.PostgreSQL
75+-- >>> import Data.Int
76+-- >>> import Data.Time
7677
7778{- |
7879A `Manipulation` is a statement which may modify data in the database,
7980but does not alter its schemas. Examples are inserts, updates and deletes.
8081A `Query` is also considered a `Manipulation` even though it does not modify data.
8182
83+The general `Manipulation` type is parameterized by
84+
85+* @commons :: FromType@ - scope for all `common` table expressions,
86+* @schemas :: SchemasType@ - scope for all `table`s and `view`s,
87+* @params :: [NullityType]@ - scope for all `Squeal.Expression.Parameter.parameter`s,
88+* @row :: RowType@ - return type of the `Query`.
89+-}
90+newtype Manipulation
91+ (commons :: FromType)
92+ (schemas :: SchemasType)
93+ (params :: [NullityType])
94+ (columns :: RowType)
95+ = UnsafeManipulation { renderManipulation :: ByteString }
96+ deriving (GHC.Generic,Show,Eq,Ord,NFData)
97+instance RenderSQL (Manipulation commons schemas params columns) where
98+ renderSQL = renderManipulation
99+instance With Manipulation where
100+ with Done manip = manip
101+ with ctes manip = UnsafeManipulation $
102+ "WITH" <+> commaSeparated (ctoList renderSQL ctes) <+> renderSQL manip
103+
104+{- |
105+The top level `Manipulation_` type is parameterized by a @schemas@ `SchemasType`,
106+against which the query is type-checked, an input @parameters@ Haskell `Type`,
107+and an ouput row Haskell `Type`.
108+
109+A top-level `Manipulation_` can be run
110+using `Squeal.PostgreSQL.PQ.manipulateParams`, or if @parameters = ()@
111+using `Squeal.PostgreSQL.PQ.manipulate`.
112+
113+Generally, @parameters@ will be a Haskell tuple or record whose entries
114+may be referenced using positional
115+`Squeal.PostgreSQL.Expression.Parameter.parameter`s and @row@ will be a
116+Haskell record, whose entries will be targeted using overloaded labels.
117+
118+>>> :set -XDeriveAnyClass -XDerivingStrategies
119+>>> :{
120+data Row a b = Row { col1 :: a, col2 :: b }
121+ deriving stock (GHC.Generic)
122+ deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)
123+:}
124+
82125simple insert:
83126
84127>>> type Columns = '["col1" ::: 'NoDef :=> 'Null 'PGint4, "col2" ::: 'Def :=> 'NotNull 'PGint4]
85128>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]
86129>>> :{
87130let
88− manipulation :: Manipulation '[] (Public Schema) '[] '[]
131+ manipulation :: Manipulation_ (Public Schema) () ()
89132 manipulation =
90− insertInto_ #tab (Values_ (2 `as` #col1 :* defaultAs #col2))
133+ insertInto_ #tab (Values_ (Set 2 `as` #col1 :* Default `as` #col2))
91134in printSQL manipulation
92135:}
93136INSERT INTO "tab" ("col1", "col2") VALUES (2, DEFAULT)
@@ -98,9 +141,9 @@ parameterized insert:
98141>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]
99142>>> :{
100143let
101− manipulation :: Manipulation '[] (Public Schema) '[ 'NotNull 'PGint4, 'NotNull 'PGint4 ] '[]
144+ manipulation :: Manipulation_ (Public Schema) (Int32, Int32) ()
102145 manipulation =
103− insertInto_ #tab (Values_ (param @1 `as` #col1 :* param @2 `as` #col2))
146+ insertInto_ #tab (Values_ (Set (param @1) `as` #col1 :* Set (param @2) `as` #col2))
104147in printSQL manipulation
105148:}
106149INSERT INTO "tab" ("col1", "col2") VALUES (($1 :: int4), ($2 :: int4))
@@ -109,9 +152,9 @@ returning insert:
109152
110153>>> :{
111154let
112− manipulation :: Manipulation '[] (Public Schema) '[] '["fromOnly" ::: 'NotNull 'PGint4]
155+ manipulation :: Manipulation_ (Public Schema) () (Only Int32)
113156 manipulation =
114− insertInto #tab (Values_ (2 `as` #col1 :* 3 `as` #col2))
157+ insertInto #tab (Values_ (Set 2 `as` #col1 :* Set 3 `as` #col2))
115158 OnConflictDoRaise (Returning (#col1 `as` #fromOnly))
116159in printSQL manipulation
117160:}
@@ -124,12 +167,12 @@ upsert:
124167>>> type CustomersSchema = '["customers" ::: 'Table (CustomersConstraints :=> CustomersColumns)]
125168>>> :{
126169let
127− manipulation :: Manipulation '[] (Public CustomersSchema) '[] '[]
170+ manipulation :: Manipulation_ (Public CustomersSchema) () ()
128171 manipulation =
129172 insertInto #customers
130− (Values_ ("John Smith" `as` #name :* "john@smith.com" `as` #email))
173+ (Values_ (Set "John Smith" `as` #name :* Set "john@smith.com" `as` #email))
131174 (OnConflict (OnConstraint #uq)
132− (DoUpdate (((#excluded ! #email) <> "; " <> (#customers ! #email)) `as` #email) []))
175+ (DoUpdate (Set (#excluded ! #email <> "; " <> #customers ! #email) `as` #email) []))
133176 (Returning_ Nil)
134177in printSQL manipulation
135178:}
@@ -139,7 +182,7 @@ query insert:
139182
140183>>> :{
141184let
142− manipulation :: Manipulation '[] (Public Schema) '[] '[]
185+ manipulation :: Manipulation_ (Public Schema) () ()
143186 manipulation = insertInto_ #tab (Subquery (select Star (from (table #tab))))
144187in printSQL manipulation
145188:}
@@ -149,8 +192,8 @@ update:
149192
150193>>> :{
151194let
152− manipulation :: Manipulation '[] (Public Schema) '[] '[]
153− manipulation = update_ #tab (2 `as` #col1) (#col1 ./= #col2)
195+ manipulation :: Manipulation_ (Public Schema) () ()
196+ manipulation = update_ #tab (Set 2 `as` #col1) (#col1 ./= #col2)
154197in printSQL manipulation
155198:}
156199UPDATE "tab" SET "col1" = 2 WHERE ("col1" <> "col2")
@@ -159,9 +202,7 @@ delete:
159202
160203>>> :{
161204let
162− manipulation :: Manipulation '[] (Public Schema) '[]
163− '[ "col1" ::: 'NotNull 'PGint4
164− , "col2" ::: 'NotNull 'PGint4 ]
205+ manipulation :: Manipulation_ (Public Schema) () (Row Int32 Int32)
165206 manipulation = deleteFrom #tab NoUsing (#col1 .== #col2) (Returning Star)
166207in printSQL manipulation
167208:}
@@ -172,13 +213,13 @@ delete and using clause:
172213>>> :{
173214type Schema3 =
174215 '[ "tab" ::: 'Table ('[] :=> Columns)
175− , "other_tab" ::: 'Table ('[] :=> Columns)
176− , "third_tab" ::: 'Table ('[] :=> Columns) ]
216+ , "other_tab" ::: 'Table ('[] :=> Columns)
217+ , "third_tab" ::: 'Table ('[] :=> Columns) ]
177218:}
178219
179220>>> :{
180221let
181− manipulation :: Manipulation '[] (Public Schema3) '[] '[]
222+ manipulation :: Manipulation_ (Public Schema3) () ()
182223 manipulation =
183224 deleteFrom #tab (Using (table #other_tab & also (table #third_tab)))
184225 ( (#tab ! #col2 .== #other_tab ! #col2)
@@ -194,7 +235,7 @@ with manipulation:
194235>>> type ProductsSchema = '["products" ::: 'Table ('[] :=> ProductsColumns), "products_deleted" ::: 'Table ('[] :=> ProductsColumns)]
195236>>> :{
196237let
197− manipulation :: Manipulation '[] (Public ProductsSchema) '[ 'NotNull 'PGdate] '[]
238+ manipulation :: Manipulation_ (Public ProductsSchema) (Only Day) ()
198239 manipulation = with
199240 (deleteFrom #products NoUsing (#date .< param @1) (Returning Star) `as` #del)
200241 (insertInto_ #products_deleted (Subquery (select Star (from (common #del)))))
@@ -202,26 +243,13 @@ in printSQL manipulation
202243:}
203244WITH "del" AS (DELETE FROM "products" WHERE ("date" < ($1 :: date)) RETURNING *) INSERT INTO "products_deleted" SELECT * FROM "del" AS "del"
204245-}
205−newtype Manipulation
206− (commons :: FromType)
207− (schemas :: SchemasType)
208− (params :: [NullityType])
209− (columns :: RowType)
210− = UnsafeManipulation { renderManipulation :: ByteString }
211− deriving (GHC.Generic,Show,Eq,Ord,NFData)
212−instance RenderSQL (Manipulation commons schemas params columns) where
213− renderSQL = renderManipulation
214−instance With Manipulation where
215− with Done manip = manip
216− with ctes manip = UnsafeManipulation $
217− "WITH" <+> renderSQL ctes <+> renderSQL manip
218−
219246type family Manipulation_ (schemas :: SchemasType) (params :: Type) (row :: Type) where
220247 Manipulation_ schemas params row = Manipulation '[] schemas (TuplePG params) (RowPG row)
221248
222249-- | Convert a `Query` into a `Manipulation`.
223250queryStatement
224251 :: Query '[] commons schemas params columns
252+ -- ^ `Query` to embed as a `Manipulation`
225253 -> Manipulation commons schemas params columns
226254queryStatement q = UnsafeManipulation $ renderSQL q
227255
@@ -244,9 +272,13 @@ insertInto
244272 , SOP.SListI columns
245273 , SOP.SListI row1 )
246274 => QualifiedAlias sch tab
275+ -- ^ table
247276 -> QueryClause commons schemas params columns
277+ -- ^ what to insert
248278 -> ConflictClause tab commons schemas params table
279+ -- ^ what to do in case of conflict
249280 -> ReturningClause commons schemas params '[tab ::: row0] row1
281+ -- ^ what to return
250282 -> Manipulation commons schemas params row1
251283insertInto tab qry conflict ret = UnsafeManipulation $
252284 "INSERT" <+> "INTO" <+> renderSQL tab
@@ -254,6 +286,7 @@ insertInto tab qry conflict ret = UnsafeManipulation $
254286 <> renderSQL conflict
255287 <> renderSQL ret
256288
289+-- | Like `insertInto` but with `OnConflictDoRaise` and `no` `ReturningClause`.
257290insertInto_
258291 :: ( Has sch schemas schema
259292 , Has tab schema ('Table table)
@@ -261,25 +294,33 @@ insertInto_
261294 , row ~ TableToRow table
262295 , SOP.SListI columns )
263296 => QualifiedAlias sch tab
297+ -- ^ table
264298 -> QueryClause commons schemas params columns
299+ -- ^ what to insert
265300 -> Manipulation commons schemas params '[]
266301insertInto_ tab qry =
267302 insertInto tab qry OnConflictDoRaise (Returning_ Nil)
268303
304+-- | A `QueryClause` describes what to `insertInto` a table.
269305data QueryClause commons schemas params columns where
270306 Values
271307 :: SOP.SListI columns
272− => NP (ColumnExpression 'Ungrouped schemas params '[]) columns
273− -> [NP (ColumnExpression 'Ungrouped schemas params '[]) columns]
308+ => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns
309+ -- ^ row of values
310+ -> [NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns]
311+ -- ^ additional rows of values
274312 -> QueryClause commons schemas params columns
275313 Select
276314 :: SOP.SListI columns
277− => NP (ColumnExpression grp schemas params from) columns
315+ => NP (Aliased (Optional (Expression '[] commons grp schemas params from))) columns
316+ -- ^ row of values
278317 -> TableExpression '[] commons grp schemas params from
318+ -- ^ from a table expression
279319 -> QueryClause commons schemas params columns
280320 Subquery
281321 :: ColumnsToRow columns ~ row
282322 => Query '[] commons schemas params row
323+ -- ^ subquery to insert
283324 -> QueryClause commons schemas params columns
284325
285326instance RenderSQL (QueryClause commons schemas params columns) where
@@ -298,109 +339,41 @@ instance RenderSQL (QueryClause commons schemas params columns) where
298339 Subquery qry -> renderQuery qry
299340 where
300341 renderSQLPartMaybe, renderValuePartMaybe
301− :: ColumnExpression grp schemas params from column -> Maybe ByteString
342+ :: Aliased (Optional (Expression '[] commons grp schemas params from)) column
343+ -> Maybe ByteString
302344 renderSQLPartMaybe = \case
303− DefaultAs _ -> Nothing
304− Specific (_ `As` name) -> Just $ renderSQL name
345+ Default `As` _ -> Nothing
346+ Set _ `As` name -> Just $ renderSQL name
305347 renderValuePartMaybe = \case
306− DefaultAs _ -> Nothing
307− Specific (value `As` _) -> Just $ renderExpression value
348+ Default `As` _ -> Nothing
349+ Set value `As` _ -> Just $ renderExpression value
308350 renderSQLPart, renderValuePart
309− :: ColumnExpression grp schemas params from column -> ByteString
310− renderSQLPart = \case
311− DefaultAs name -> renderSQL name
312− Specific (_ `As` name) -> renderSQL name
313− renderValuePart = \case
314− DefaultAs _ -> "DEFAULT"
315− Specific (value `As` _) -> renderExpression value
351+ :: Aliased (Optional (Expression '[] commons grp schemas params from)) column
352+ -> ByteString
353+ renderSQLPart (_ `As` name) = renderSQL name
354+ renderValuePart (value `As` _) = renderSQL value
316355
356+-- | `Values_` describes a single `NP` list of `Aliased` `Optional` `Expression`s
357+-- whose `ColumnsType` must match the tables'.
317358pattern Values_
318359 :: SOP.SListI columns
319− => NP (ColumnExpression 'Ungrouped schemas params '[]) columns
360+ => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns
361+ -- ^ row of values
320362 -> QueryClause commons schemas params columns
321363pattern Values_ vals = Values vals []
322364
323−data ColumnExpression grp schemas params from column where
324− DefaultAs
325− :: KnownSymbol col
326− => Alias col
327− -> ColumnExpression grp schemas params from (col ::: 'Def :=> ty)
328− Specific
329− :: Aliased (Expression '[] '[] grp schemas params from) (col ::: ty)
330− -> ColumnExpression grp schemas params from (col ::: defness :=> ty)
331−
332−instance (KnownSymbol col, column ~ (col ::: defness :=> ty))
333− => Aliasable col
334− (Expression '[] '[] grp schemas params from ty)
335− (ColumnExpression grp schemas params from column) where
336− expression `as` col = Specific (expression `As` col)
337−instance (KnownSymbol col, columns ~ '[col ::: defness :=> ty])
338− => Aliasable col
339− (Expression '[] '[] grp schemas params from ty)
340− (NP (ColumnExpression grp schemas params from) columns) where
341− expression `as` col = expression `as` col :* Nil
342−instance (KnownSymbol col, column ~ (col ::: 'Def :=> ty))
343− => DefaultAliasable col (ColumnExpression grp schemas params from column) where
344− defaultAs = DefaultAs
345−instance (KnownSymbol col, columns ~ '[col ::: 'Def :=> ty])
346− => DefaultAliasable col (NP (ColumnExpression grp schemas params from) columns) where
347− defaultAs col = defaultAs col :* Nil
348−
349−instance (HasUnique tab from row, Has col row ty, column ~ (col ::: defness :=> ty))
350− => IsLabel col (ColumnExpression 'Ungrouped schemas params from column) where
351− fromLabel = fromLabel @col `as` Alias
352−instance (HasUnique tab from row, Has col row ty, columns ~ '[col ::: defness :=> ty])
353− => IsLabel col
354− (NP (ColumnExpression 'Ungrouped schemas params from) columns) where
355− fromLabel = fromLabel @col `as` Alias
356−
357−instance (Has tab from row, Has col row ty, column ~ (col ::: defness :=> ty))
358− => IsQualified tab col (ColumnExpression 'Ungrouped schemas params from column) where
359− tab ! col = tab ! col `as` col
360−instance (Has tab from row, Has col row ty, columns ~ '[col ::: defness :=> ty])
361− => IsQualified tab col (NP (ColumnExpression 'Ungrouped schemas params from) columns) where
362− tab ! col = tab ! col `as` col
363−
364−instance
365− ( HasUnique tab from row
366− , Has col row ty
367− , GroupedBy tab col bys
368− , column ~ (col ::: defness :=> ty)
369− ) => IsLabel col
370− (ColumnExpression ('Grouped bys) schemas params from column) where
371− fromLabel = fromLabel @col `as` Alias
372−instance
373− ( HasUnique tab from row
374− , Has col row ty
375− , GroupedBy tab col bys
376− , columns ~ '[col ::: defness :=> ty]
377− ) => IsLabel col
378− (NP (ColumnExpression ('Grouped bys) schemas params from) columns) where
379− fromLabel = fromLabel @col `as` Alias
380−
381−instance
382− ( Has tab from row
383− , Has col row ty
384− , GroupedBy tab col bys
385− , column ~ (col ::: defness :=> ty)
386− ) => IsQualified tab col
387− (ColumnExpression ('Grouped bys) schemas params from column) where
388− tab ! col = tab ! col `as` col
389−instance
390− ( Has tab from row
391− , Has col row ty
392− , GroupedBy tab col bys
393− , columns ~ '[col ::: defness :=> ty]
394− ) => IsQualified tab col
395− (NP (ColumnExpression ('Grouped bys) schemas params from) columns) where
396− tab ! col = tab ! col :* Nil
397−
398−instance RenderSQL (ColumnExpression grp schemas params from column) where
365+-- | `Optional` is either `Default` or a value, parameterized by an appropriate
366+-- `ColumnConstraint`.
367+data Optional expr ty where
368+ -- | Use the `Default` value for a column.
369+ Default :: Optional expr ('Def :=> ty)
370+ -- | `Set` a value for a column.
371+ Set :: expr ty -> Optional expr (def :=> ty)
372+
373+instance (forall x. RenderSQL (expr x)) => RenderSQL (Optional expr ty) where
399374 renderSQL = \case
400− DefaultAs col ->
401− renderSQL col <+> "=" <+> "DEFAULT"
402− Specific (expression `As` col) ->
403− renderSQL col <+> "=" <+> renderSQL expression
375+ Default -> "DEFAULT"
376+ Set expr -> renderSQL expr
404377
405378-- | A `ReturningClause` computes and return value(s) based
406379-- on each row actually inserted, updated or deleted. This is primarily
@@ -410,7 +383,7 @@ instance RenderSQL (ColumnExpression grp schemas params from column) where
410383-- deleted will be returned. For example, if a row was locked
411384-- but not updated because an `OnConflict` `DoUpdate` condition was not satisfied,
412385-- the row will not be returned. `Returning` `Star` will return all columns
413−-- in the row. Use @Returning Nil@ in the common case where no return
386+-- in the row. Use `Returning` `Nil` in the common case where no return
414387-- values are desired.
415388newtype ReturningClause commons schemas params from row =
416389 Returning (Selection '[] commons 'Ungrouped schemas params from row)
@@ -420,9 +393,11 @@ instance RenderSQL (ReturningClause commons schemas params from row) where
420393 Returning (List Nil) -> ""
421394 Returning selection -> " RETURNING" <+> renderSQL selection
422395
396+-- | `Returning` a `List`
423397pattern Returning_
424398 :: SOP.SListI row
425399 => NP (Aliased (Expression '[] commons 'Ungrouped schemas params from)) row
400+ -- ^ row of values
426401 -> ReturningClause commons schemas params from row
427402pattern Returning_ list = Returning (List list)
428403
@@ -435,7 +410,9 @@ data ConflictClause tab commons schemas params table where
435410 OnConflictDoRaise :: ConflictClause tab commons schemas params table
436411 OnConflict
437412 :: ConflictTarget constraints
413+ -- ^ conflict target
438414 -> ConflictAction tab commons schemas params columns
415+ -- ^ conflict action
439416 -> ConflictClause tab commons schemas params (constraints :=> columns)
440417
441418-- | Render a `ConflictClause`.
@@ -446,6 +423,17 @@ instance SOP.SListI (TableToColumns table)
446423 OnConflict target action -> " ON CONFLICT"
447424 <+> renderSQL target <+> renderSQL action
448425
426+{- |
427+`ConflictAction` specifies an alternative `OnConflict` action.
428+It can be either `DoNothing`, or a `DoUpdate` clause specifying
429+the exact details of the `update` action to be performed in case of a conflict.
430+The `Set` and WHERE `Condition`s in `OnConflict` `DoUpdate` have access to the
431+existing row using the table's name (or an alias), and to rows proposed
432+for insertion using the special @#excluded@ table.
433+`OnConflict` `DoNothing` simply avoids inserting a row as its alternative action.
434+`OnConflict` `DoUpdate` updates the existing row that conflicts
435+with the row proposed for insertion as its alternative action.
436+-}
449437data ConflictAction tab commons schemas params columns where
450438 DoNothing :: ConflictAction tab commons schemas params columns
451439 DoUpdate
@@ -454,8 +442,9 @@ data ConflictAction tab commons schemas params columns where
454442 , columns ~ (col0 ': cols)
455443 , SOP.All (HasIn columns) subcolumns
456444 , AllUnique subcolumns )
457− => NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]) subcolumns
445+ => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]))) subcolumns
458446 -> [Condition '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]]
447+ -- ^ WHERE `Condition`s
459448 -> ConflictAction tab commons schemas params columns
460449
461450instance RenderSQL (ConflictAction tab commons schemas params columns) where
@@ -463,11 +452,17 @@ instance RenderSQL (ConflictAction tab commons schemas params columns) where
463452 DoNothing -> "DO NOTHING"
464453 DoUpdate updates whs'
465454 -> "DO UPDATE SET"
466− <+> renderCommaSeparated renderSQL updates
455+ <+> renderCommaSeparated renderUpdate updates
467456 <> case whs' of
468457 [] -> ""
469458 wh:whs -> " WHERE" <+> renderSQL (foldr (.&&) wh whs)
470459
460+renderUpdate
461+ :: (forall x. RenderSQL (expr x))
462+ => Aliased (Optional expr) ty
463+ -> ByteString
464+renderUpdate (expr `As` col) = renderSQL col <+> "=" <+> renderSQL expr
465+
471466-- | A `ConflictTarget` specifies the constraint violation that triggers a
472467-- `ConflictAction`.
473468data ConflictTarget constraints where
@@ -490,7 +485,6 @@ UPDATE statements
490485update
491486 :: ( SOP.SListI columns
492487 , SOP.SListI row1
493− , db ~ (commons :=> schemas)
494488 , Has sch schemas schema
495489 , Has tab schema ('Table table)
496490 , row0 ~ TableToRow table
@@ -498,7 +492,7 @@ update
498492 , SOP.All (HasIn columns) subcolumns
499493 , AllUnique subcolumns )
500494 => QualifiedAlias sch tab -- ^ table to update
501− -> NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row0]) subcolumns
495+ -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row0]))) subcolumns
502496 -- ^ modified values to replace old values
503497 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row0]
504498 -- ^ condition under which to perform update on a row
@@ -508,14 +502,13 @@ update tab columns wh returning = UnsafeManipulation $
508502 "UPDATE"
509503 <+> renderSQL tab
510504 <+> "SET"
511− <+> renderCommaSeparated renderSQL columns
505+ <+> renderCommaSeparated renderUpdate columns
512506 <+> "WHERE" <+> renderSQL wh
513507 <> renderSQL returning
514508
515509-- | Update a row returning `Nil`.
516510update_
517511 :: ( SOP.SListI columns
518− , db ~ (commons :=> schemas)
519512 , Has sch schemas schema
520513 , Has tab schema ('Table table)
521514 , row ~ TableToRow table
@@ -523,7 +516,7 @@ update_
523516 , SOP.All (HasIn columns) subcolumns
524517 , AllUnique subcolumns )
525518 => QualifiedAlias sch tab -- ^ table to update
526− -> NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row]) subcolumns
519+ -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row]))) subcolumns
527520 -- ^ modified values to replace old values
528521 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]
529522 -- ^ condition under which to perform update on a row
@@ -534,16 +527,25 @@ update_ tab columns wh = update tab columns wh (Returning_ Nil)
534527DELETE statements
535528-----------------------------------------}
536529
530+-- | Specify additional tables with `Using`
531+-- an `also` list of table expressions, allowing columns
532+-- from other tables to appear in the WHERE condition.
533+-- This is similar to the list of tables that can be specified
534+-- in the FROM Clause of a SELECT statement;
535+-- for example, an alias for the table name can be specified.
536+-- Do not repeat the target table in the `Using` list,
537+-- unless you wish to set up a self-join.
538+-- `NoUsing` if no additional tables are to be used.
537539data UsingClause commons schemas params from where
538540 NoUsing :: UsingClause commons schemas params '[]
539541 Using
540542 :: FromClause '[] commons schemas params from
543+ -- ^ what to use
541544 -> UsingClause commons schemas params from
542545
543546-- | Delete rows from a table.
544547deleteFrom
545548 :: ( SOP.SListI row1
546− , db ~ (commons :=> schemas)
547549 , Has sch schemas schema
548550 , Has tab schema ('Table table)
549551 , row0 ~ TableToRow table
@@ -565,8 +567,7 @@ deleteFrom tab using wh returning = UnsafeManipulation $
565567
566568-- | Delete rows returning `Nil`.
567569deleteFrom_
568− :: ( db ~ (commons :=> schemas)
569− , Has sch schemas schema
570+ :: ( Has sch schemas schema
570571 , Has tab schema ('Table table)
571572 , row ~ TableToRow table
572573 , columns ~ TableToColumns table )
@@ -575,17 +576,3 @@ deleteFrom_
575576 -- ^ condition under which to delete a row
576577 -> Manipulation commons schemas params '[]
577578deleteFrom_ tab wh = deleteFrom tab NoUsing wh (Returning_ Nil)
578−
579−-- | This has the behaviour of a cartesian product, taking all
580−-- possible combinations between @left@ and @right@ - exactly like a
581−-- `crossJoin`. Used when no `crossJoin` syntax is required but simply
582−-- a comma separated list of tables. Typical case is the `UsingClause`
583−-- of a `deleteFrom` query.
584−also
585− :: FromClause outer commons schemas params right
586− -- ^ right
587− -> FromClause outer commons schemas params left
588− -- ^ left
589− -> FromClause outer commons schemas params (Join left right)
590−also right left = UnsafeFromClause $
591− renderSQL left <> "," <+> renderSQL right
squeal-postgresql/src/Squeal/PostgreSQL/Migration.hs+53−57
@@ -66,7 +66,7 @@ let
6666 }
6767:}
6868
69−Now that we have a couple migrations we can chain them together into an `AlignedList`.
69+Now that we have a couple migrations we can chain them together into a `Path`.
7070
7171>>> let migrations = makeUsers :>> makeEmails :>> Done
7272
@@ -156,7 +156,6 @@ import Data.Function ((&))
156156import Data.List ((\\))
157157import Data.Text (Text)
158158import Data.Time (UTCTime)
159−import Generics.SOP (K (..))
160159import Prelude hiding ((.), id)
161160import System.Environment
162161import UnliftIO (MonadIO (..))
@@ -165,7 +164,21 @@ import qualified Data.Text.IO as Text (putStrLn)
165164import qualified Generics.SOP as SOP
166165import qualified GHC.Generics as GHC
167166
168−import Squeal.PostgreSQL
167+import Squeal.PostgreSQL.Alias
168+import Squeal.PostgreSQL.Binary
169+import Squeal.PostgreSQL.Definition
170+import Squeal.PostgreSQL.Definition.Table
171+import Squeal.PostgreSQL.Definition.Table.Constraint
172+import Squeal.PostgreSQL.Expression.Comparison
173+import Squeal.PostgreSQL.Expression.Parameter
174+import Squeal.PostgreSQL.Expression.Time
175+import Squeal.PostgreSQL.Expression.Type
176+import Squeal.PostgreSQL.List
177+import Squeal.PostgreSQL.Manipulation
178+import Squeal.PostgreSQL.PQ
179+import Squeal.PostgreSQL.Query
180+import Squeal.PostgreSQL.Schema
181+import Squeal.PostgreSQL.Transaction
169182
170183-- | A `Migration` is a named "isomorphism" over a given category.
171184-- It should contain an inverse pair of `up` and `down`
@@ -179,34 +192,34 @@ data Migration p schemas0 schemas1 = Migration
179192
180193{- |
181194A `Migratory` @p@ is a `Category` for which one can execute or rewind
182−an `AlignedList` of `Migration`s over @p@. This includes the category of pure
195+a `Path` of `Migration`s over @p@. This includes the category of pure
183196SQL `Definition`s and the category of impure `Terminally` `PQ` `IO` actions.
184197-}
185198class Category p => Migratory p where
186199
187200 {- |
188− Run an `AlignedList` of `Migration`s.
201+ Run a `Path` of `Migration`s.
189202 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.
190− In a transaction for each each `Migration`, query to see if the `Migration` has been executed;
191− if not, execute the `Migration` and insert a row in the `MigrationsTable`.
203+ In one transaction, for each each `Migration` query to see if the `Migration` has been executed;
204+ if not, `up` the `Migration` and insert its `name` in the `MigrationsTable`.
192205 -}
193206 migrateUp
194− :: AlignedList (Migration p) schemas0 schemas1
207+ :: Path (Migration p) schemas0 schemas1
195208 -> PQ schemas0 schemas1 IO ()
196209
197210 {- |
198− Rewind an `AlignedList` of `Migration`s.
211+ Rewind a `Path` of `Migration`s.
199212 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.
200− In a transaction for each each `Migration`, query to see if the `Migration` has been executed;
201− if so, rewind the `Migration` and delete its row in the `MigrationsTable`.
213+ In one transaction, for each each `Migration` query to see if the `Migration` has been executed;
214+ if so, `down` the `Migration` and delete its `name` in the `MigrationsTable`.
202215 -}
203216 migrateDown
204− :: AlignedList (Migration p) schemas0 schemas1
217+ :: Path (Migration p) schemas0 schemas1
205218 -> PQ schemas1 schemas0 IO ()
206219
207220instance Migratory Definition where
208− migrateUp = migrateUp . alignedMap pureMigration
209− migrateDown = migrateDown . alignedMap pureMigration
221+ migrateUp = migrateUp . cmap pureMigration
222+ migrateDown = migrateDown . cmap pureMigration
210223
211224{- | `Terminally` turns an indexed monad transformer and the monad it transforms
212225into a category by restricting the return type to @()@ and permuting the type variables.
@@ -238,8 +251,8 @@ terminally = Terminally . void
238251-- | A `pureMigration` turns a `Migration` involving only pure SQL
239252-- `Definition`s into a `Migration` that may be combined with arbitrary `IO`.
240253pureMigration
241− :: Migration Definition schema0 schema1
242− -> Migration (Terminally PQ IO) schema0 schema1
254+ :: Migration Definition schemas0 schemas1
255+ -> Migration (Terminally PQ IO) schemas0 schemas1
243256pureMigration migration = Migration
244257 { name = name migration
245258 , up = terminally . define $ up migration
@@ -248,81 +261,64 @@ pureMigration migration = Migration
248261
249262instance Migratory (Terminally PQ IO) where
250263
251− migrateUp migration = unsafePQ $
264+ migrateUp migration = unsafePQ . transactionally_ $ do
252265 define createMigrations
253− & pqBind okResult
254− & pqThen (transactionallySchema_ (upMigrations migration))
266+ upMigrations migration
255267
256268 where
257269
258270 upMigrations
259− :: AlignedList (Migration (Terminally PQ IO)) schemas0 schemas1
271+ :: Path (Migration (Terminally PQ IO)) schemas0 schemas1
260272 -> PQ MigrationsSchemas MigrationsSchemas IO ()
261273 upMigrations = \case
262274 Done -> return ()
263− step :>> steps -> upMigration step & pqThen (upMigrations steps)
275+ step :>> steps -> upMigration step >> upMigrations steps
264276
265277 upMigration
266278 :: Migration (Terminally PQ IO) schemas0 schemas1
267279 -> PQ MigrationsSchemas MigrationsSchemas IO ()
268− upMigration step =
269− queryExecuted step
270− & pqBind ( \ executed -> unless (executed == 1)
271− $ unsafePQ (runTerminally (up step))
272− & pqThen (manipulateParams insertMigration (Only (name step)))
273− -- insert execution record
274− & pqBind okResult )
280+ upMigration step = do
281+ executed <- queryExecuted step
282+ unless (executed == 1) $ do
283+ unsafePQ . runTerminally $ up step
284+ manipulateParams_ insertMigration (Only (name step))
275285
276286 queryExecuted
277287 :: Migration (Terminally PQ IO) schemas0 schemas1
278288 -> PQ MigrationsSchemas MigrationsSchemas IO Row
279289 queryExecuted step = do
280290 result <- runQueryParams selectMigration (Only (name step))
281− okResult result
282291 ntuples result
283292
284− migrateDown migrations = unsafePQ $
293+ migrateDown migrations = unsafePQ . transactionally_ $ do
285294 define createMigrations
286− & pqBind okResult
287− & pqThen (transactionallySchema_ (downMigrations migrations))
295+ downMigrations migrations
288296
289297 where
290298
291299 downMigrations
292− :: AlignedList (Migration (Terminally PQ IO)) schemas0 schemas1
300+ :: Path (Migration (Terminally PQ IO)) schemas0 schemas1
293301 -> PQ MigrationsSchemas MigrationsSchemas IO ()
294302 downMigrations = \case
295303 Done -> return ()
296− step :>> steps -> downMigrations steps & pqThen (downMigration step)
304+ step :>> steps -> downMigrations steps >> downMigration step
297305
298306 downMigration
299307 :: Migration (Terminally PQ IO) schemas0 schemas1
300308 -> PQ MigrationsSchemas MigrationsSchemas IO ()
301− downMigration step =
302− queryExecuted step
303− & pqBind ( \ executed -> unless (executed == 0)
304− $ unsafePQ (runTerminally (down step))
305− & pqThen (manipulateParams deleteMigration (Only (name step)))
306− -- delete execution record
307− & pqBind okResult )
309+ downMigration step = do
310+ executed <- queryExecuted step
311+ unless (executed == 0) $ do
312+ unsafePQ . runTerminally $ down step
313+ manipulateParams_ deleteMigration (Only (name step))
308314
309315 queryExecuted
310316 :: Migration (Terminally PQ IO) schemas0 schemas1
311317 -> PQ MigrationsSchemas MigrationsSchemas IO Row
312318 queryExecuted step = do
313319 result <- runQueryParams selectMigration (Only (name step))
314− okResult result
315320 ntuples result
316321
317−okResult :: K Result results -> PQ schema schema IO ()
318−okResult result = do
319− status <- resultStatus result
320− when (not (status `elem` [CommandOk, TuplesOk])) $ do
321− errorMessageMaybe <- resultErrorMessage result
322− case errorMessageMaybe of
323− Nothing -> error "migration: unknown error"
324− Just msg -> error ("migration: " <> show msg)
325−
326322unsafePQ :: (Functor m) => PQ db0 db1 m x -> PQ db0' db1' m x
327323unsafePQ (PQ pq) = PQ $ fmap (SOP.K . SOP.unK) . pq . SOP.K . SOP.unK
328324
@@ -357,7 +353,7 @@ createMigrations =
357353-- the time at which it was inserted.
358354insertMigration :: Manipulation_ MigrationsSchemas (Only Text) ()
359355insertMigration = insertInto_ #schema_migrations
360− (Values_ ((param @1) `as` #name :* defaultAs #executed_at))
356+ (Values_ (Set (param @1) `as` #name :* Default `as` #executed_at))
361357
362358-- | Deletes a `Migration` from the `MigrationsTable`, returning
363359-- the time at which it was inserted.
@@ -367,8 +363,8 @@ deleteMigration = deleteFrom_ #schema_migrations (#name .== param @1)
367363-- | Selects a `Migration` from the `MigrationsTable`, returning
368364-- the time at which it was inserted.
369365selectMigration
370− :: Query_ MigrationsSchemas (Only Text) (P ("executed_at" ::: UTCTime))
371−selectMigration = select_ #executed_at
366+ :: Query_ MigrationsSchemas (Only Text) (Only UTCTime)
367+selectMigration = select_ (#executed_at `as` #fromOnly)
372368 $ from (table (#schema_migrations))
373369 & where_ (#name .== param @1)
374370
@@ -388,7 +384,7 @@ defaultMain
388384 :: Migratory p
389385 => ByteString
390386 -- ^ connection string
391− -> AlignedList (Migration p) db0 db1
387+ -> Path (Migration p) db0 db1
392388 -- ^ migrations
393389 -> IO ()
394390defaultMain connectTo migrations = do
@@ -409,12 +405,12 @@ defaultMain connectTo migrations = do
409405 migrateStatus :: PQ schema schema IO ()
410406 migrateStatus = unsafePQ $ do
411407 runNames <- getRunMigrationNames
412− let names = extractList name migrations
408+ let names = ctoList name migrations
413409 unrunNames = names \\ runNames
414410 liftIO $ displayRunned runNames >> displayUnrunned unrunNames
415411
416412 suppressNotices :: PQ schema schema IO ()
417− suppressNotices = void . manipulate $
413+ suppressNotices = manipulate_ $
418414 UnsafeManipulation "SET client_min_messages TO WARNING;"
419415
420416 readCommandFromArgs :: IO (Maybe MigrateCommand)
squeal-postgresql/src/Squeal/PostgreSQL/PG.hs+98−92
@@ -1,18 +1,29 @@
1−
1+{-|
2+Module: Squeal.PostgreSQL.PG
3+Description: Embedding of Haskell types into Postgres's type system
4+Copyright: (c) Eitan Chatav, 2010
5+Maintainer: eitan@morphism.tech
6+Stability: experimental
7+
8+`Squeal.PostgreSQL.PG` provides type families for turning Haskell
9+`Type`s into corresponding Postgres types.
10+-}
211{-# LANGUAGE
312 AllowAmbiguousTypes
13+ , DeriveAnyClass
414 , DeriveFoldable
515 , DeriveFunctor
616 , DeriveGeneric
717 , DeriveTraversable
18+ , DerivingStrategies
819 , DefaultSignatures
920 , FlexibleContexts
1021 , FlexibleInstances
1122 , FunctionalDependencies
1223 , GADTs
1324 , LambdaCase
14− , OverloadedStrings
1525 , MultiParamTypeClasses
26+ , OverloadedStrings
1627 , ScopedTypeVariables
1728 , TypeApplications
1829 , TypeFamilies
@@ -28,7 +39,6 @@ module Squeal.PostgreSQL.PG
2839 , NullPG
2940 , TuplePG
3041 , RowPG
31− , Entity
3242 -- * Storage newtypes
3343 , Money (..)
3444 , Json (..)
@@ -37,13 +47,14 @@ module Squeal.PostgreSQL.PG
3747 , Enumerated (..)
3848 , VarArray (..)
3949 , FixArray (..)
40− , SOP.P (..)
50+ , LibPQ.Oid (..)
4151 -- * Type families
4252 , LabelsPG
4353 , DimPG
4454 , FixPG
4555 , TupleOf
4656 , TupleCodeOf
57+ , RowOf
4758 , ConstructorsOf
4859 , ConstructorNameOf
4960 , ConstructorNamesOf
@@ -55,7 +66,6 @@ import Data.Int (Int16, Int32, Int64)
5566import Data.Scientific (Scientific)
5667import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime)
5768import Data.Vector (Vector)
58−import Data.Word (Word16, Word32, Word64)
5969import Data.UUID.Types (UUID)
6070import GHC.TypeLits
6171import Network.IP.Addr (NetAddr, IP)
@@ -64,13 +74,13 @@ import qualified Data.ByteString.Lazy as Lazy (ByteString)
6474import qualified Data.ByteString as Strict (ByteString)
6575import qualified Data.Text.Lazy as Lazy (Text)
6676import qualified Data.Text as Strict (Text)
77+import qualified Database.PostgreSQL.LibPQ as LibPQ
6778import qualified GHC.Generics as GHC
6879import qualified Generics.SOP as SOP
6980import qualified Generics.SOP.Record as SOP
7081import qualified Generics.SOP.Type.Metadata as Type
7182
7283import Squeal.PostgreSQL.Alias
73−import Squeal.PostgreSQL.List
7484import Squeal.PostgreSQL.Schema
7585
7686-- $setup
@@ -89,30 +99,51 @@ PG LocalTime :: PGType
8999>>> type instance PG MyDouble = 'PGfloat8
90100-}
91101type family PG (hask :: Type) :: PGType
102+-- | `PGbool`
92103type instance PG Bool = 'PGbool
104+-- | `PGint2`
93105type instance PG Int16 = 'PGint2
106+-- | `PGint4`
94107type instance PG Int32 = 'PGint4
108+-- | `PGint8`
95109type instance PG Int64 = 'PGint8
96−type instance PG Word16 = 'PGint2
97−type instance PG Word32 = 'PGint4
98−type instance PG Word64 = 'PGint8
110+-- | `PGint2`
111+type instance PG LibPQ.Oid = 'PGoid
112+-- | `PGnumeric`
99113type instance PG Scientific = 'PGnumeric
114+-- | `PGfloat4`
100115type instance PG Float = 'PGfloat4
116+-- | `PGfloat8`
101117type instance PG Double = 'PGfloat8
118+-- | `PGchar` @1@
102119type instance PG Char = 'PGchar 1
120+-- | `PGtext`
103121type instance PG Strict.Text = 'PGtext
122+-- | `PGtext`
104123type instance PG Lazy.Text = 'PGtext
124+-- | `PGtext`
105125type instance PG String = 'PGtext
126+-- | `PGbytea`
106127type instance PG Strict.ByteString = 'PGbytea
128+-- | `PGbytea`
107129type instance PG Lazy.ByteString = 'PGbytea
130+-- | `PGtimestamp`
108131type instance PG LocalTime = 'PGtimestamp
132+-- | `PGtimestamptz`
109133type instance PG UTCTime = 'PGtimestamptz
134+-- | `PGdate`
110135type instance PG Day = 'PGdate
136+-- | `PGtime`
111137type instance PG TimeOfDay = 'PGtime
138+-- | `PGtimetz`
112139type instance PG (TimeOfDay, TimeZone) = 'PGtimetz
140+-- | `PGinterval`
113141type instance PG DiffTime = 'PGinterval
142+-- | `PGuuid`
114143type instance PG UUID = 'PGuuid
144+-- | `PGinet`
115145type instance PG (NetAddr IP) = 'PGinet
146+-- | `PGjson`
116147type instance PG Value = 'PGjson
117148
118149{-| The `LabelsPG` type family calculates the constructors of a
@@ -133,7 +164,7 @@ type family LabelsPG (hask :: Type) :: [Type.ConstructorName] where
133164`RowPG` turns a Haskell `Type` into a `RowType`.
134165
135166`RowPG` may be applied to normal Haskell record types provided they
136−have the `SOP.Generic` and `SOP.HasDatatypeInfo` instances;
167+have `SOP.Generic` and `SOP.HasDatatypeInfo` instances;
137168
138169>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic
139170>>> instance SOP.Generic Person
@@ -141,84 +172,22 @@ have the `SOP.Generic` and `SOP.HasDatatypeInfo` instances;
141172>>> :kind! RowPG Person
142173RowPG Person :: [(Symbol, NullityType)]
143174= '["name" ::: 'NotNull 'PGtext, "age" ::: 'NotNull 'PGint4]
144−
145−Or to tuples of `SOP.P` types;
146−
147−>>> :kind! RowPG (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32))
148−RowPG (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,
149− NullityType)]
150−= '[ '("id", 'NotNull 'PGint4), "foreign_id" ::: 'NotNull 'PGint4]
151−
152−Or to tuples which mix `SOP.P` types and record types.
153−
154−>>> :kind! RowPG (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32))
155−RowPG (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,
156− NullityType)]
157−= '[ '("id", 'NotNull 'PGint4), '("name", 'NotNull 'PGtext),
158− '("age", 'NotNull 'PGint4), "foreign_id" ::: 'NotNull 'PGint4]
159175-}
160176type family RowPG (hask :: Type) :: RowType where
161− RowPG (hask1, hask2) = Join (RowPG hask1) (RowPG hask2)
162− RowPG (hask1, hask2, hask3) =
163− Join (RowPG hask1) (RowPG (hask2, hask3))
164− RowPG (hask1, hask2, hask3, hask4) =
165− Join (RowPG hask1) (RowPG (hask2, hask3, hask4))
166− RowPG (hask1, hask2, hask3, hask4, hask5) =
167− Join (RowPG hask1) (RowPG (hask2, hask3, hask4, hask5))
168− RowPG (SOP.P (col ::: ty)) = '[col ::: NullPG ty]
169177 RowPG hask = RowOf (SOP.RecordCodeOf hask)
170178
179+-- | `RowOf` applies `NullPG` to the fields of a list.
171180type family RowOf (record :: [(Symbol, Type)]) :: RowType where
172− RowOf '[] = '[]
181+ RowOf (col ::: ty ': col1 ::: ty1 ': col2 ::: ty2 ': col3 ::: ty3 ': col4 ::: ty4 ': record) =
182+ col ::: NullPG ty ': col1 ::: NullPG ty1 ': col2 ::: NullPG ty2 ': col3 ::: NullPG ty3 ': col4 ::: NullPG ty4 ': RowOf record
183+ RowOf (col ::: ty ': col1 ::: ty1 ': col2 ::: ty2 ': col3 ::: ty3 ': record) =
184+ col ::: NullPG ty ': col1 ::: NullPG ty1 ': col2 ::: NullPG ty2 ': col3 ::: NullPG ty3 ': RowOf record
185+ RowOf (col ::: ty ': col1 ::: ty1 ': col2 ::: ty2 ': record) =
186+ col ::: NullPG ty ': col1 ::: NullPG ty1 ': col2 ::: NullPG ty2 ': RowOf record
187+ RowOf (col ::: ty ': col1 ::: ty1 ': record) =
188+ col ::: NullPG ty ': col1::: NullPG ty1 ': RowOf record
173189 RowOf (col ::: ty ': record) = col ::: NullPG ty ': RowOf record
174−
175−type family ColumnsOf (record :: [(Symbol, Type)]) :: ColumnsType where
176− ColumnsOf '[] = '[]
177− ColumnsOf (col ::: ty ': record) =
178− col ::: 'NoDef :=> NullPG ty ': ColumnsOf record
179−
180−{- |
181−`Entity` turns a Haskell `Type` into a `ColumnsType`.
182−
183−`Entity` may be applied to normal Haskell record types provided they
184−have the `SOP.Generic` and `SOP.HasDatatypeInfo` instances;
185−
186−>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic
187−>>> instance SOP.Generic Person
188−>>> instance SOP.HasDatatypeInfo Person
189−>>> :kind! Entity Person
190−Entity Person :: [(Symbol, (ColumnConstraint, NullityType))]
191−= '["name" ::: ('NoDef :=> 'NotNull 'PGtext),
192− "age" ::: ('NoDef :=> 'NotNull 'PGint4)]
193−
194−Or to tuples of `SOP.P` types;
195−
196−>>> :kind! Entity (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32))
197−Entity (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,
198− ColumnType)]
199−= '[ '("id", 'Def :=> 'NotNull 'PGint4),
200− "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]
201−
202−Or to tuples which mix `SOP.P` types and record types.
203−
204−>>> :kind! Entity (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32))
205−Entity (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,
206− ColumnType)]
207−= '[ '("id", 'Def :=> 'NotNull 'PGint4),
208− '("name", 'NoDef :=> 'NotNull 'PGtext),
209− '("age", 'NoDef :=> 'NotNull 'PGint4),
210− "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]
211−-}
212−type family Entity (hask :: Type) :: ColumnsType where
213− Entity (hask1, hask2) = Join (Entity hask1) (Entity hask2)
214− Entity (hask1, hask2, hask3) =
215− Join (Entity hask1) (Entity (hask2, hask3))
216− Entity (hask1, hask2, hask3, hask4) =
217− Join (Entity hask1) (Entity (hask2, hask3, hask4))
218− Entity (hask1, hask2, hask3, hask4, hask5) =
219− Join (Entity hask1) (Entity (hask2, hask3, hask4, hask5))
220− Entity (SOP.P (col ::: ty)) = '[col ::: 'Def :=> NullPG ty]
221− Entity hask = ColumnsOf (SOP.RecordCodeOf hask)
190+ RowOf '[] = '[]
222191
223192{- | `NullPG` turns a Haskell type into a `NullityType`.
224193
@@ -243,10 +212,22 @@ TuplePG (Double, Maybe Char) :: [NullityType]
243212type family TuplePG (hask :: Type) :: [NullityType] where
244213 TuplePG hask = TupleOf (TupleCodeOf hask (SOP.Code hask))
245214
215+-- | `TupleOf` turns a list of Haskell `Type`s into a list of `NullityType`s.
246216type family TupleOf (tuple :: [Type]) :: [NullityType] where
247− TupleOf '[] = '[]
217+ TupleOf (hask ': hask1 ': hask2 ': hask3 ': hask4 ': hask5 ': tuple) =
218+ NullPG hask ': NullPG hask1 ': NullPG hask2 ': NullPG hask3 ': NullPG hask4 ': NullPG hask5 ': TupleOf tuple
219+ TupleOf (hask ': hask1 ': hask2 ': hask3 ': hask4 ': tuple) =
220+ NullPG hask ': NullPG hask1 ': NullPG hask2 ': NullPG hask3 ': NullPG hask4 ': TupleOf tuple
221+ TupleOf (hask ': hask1 ': hask2 ': hask3 ': tuple) =
222+ NullPG hask ': NullPG hask1 ': NullPG hask2 ': NullPG hask3 ': TupleOf tuple
223+ TupleOf (hask ': hask1 ': hask2 ': tuple) =
224+ NullPG hask ': NullPG hask1 ': NullPG hask2 ': TupleOf tuple
225+ TupleOf (hask ': hask1 ': tuple) = NullPG hask ': NullPG hask1 ': TupleOf tuple
248226 TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple
227+ TupleOf '[] = '[]
249228
229+-- | `TupleCodeOf` takes the `SOP.Code` of a haskell `Type`
230+-- and if it's a simple product returns it, otherwise giving a `TypeError`.
250231type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where
251232 TupleCodeOf hask '[tuple] = tuple
252233 TupleCodeOf hask '[] =
@@ -287,6 +268,7 @@ type family ConstructorNamesOf (constructors :: [Type.ConstructorInfo])
287268 ConstructorNamesOf (constructor ': constructors) =
288269 ConstructorNameOf constructor ': ConstructorNamesOf constructors
289270
271+-- | `DimPG` turns Haskell nested homogeneous tuples into a list of lengths.
290272type family DimPG (hask :: Type) :: [Nat] where
291273 DimPG (x,x) = 2 ': DimPG x
292274 DimPG (x,x,x) = 3 ': DimPG x
@@ -299,6 +281,7 @@ type family DimPG (hask :: Type) :: [Nat] where
299281 DimPG (x,x,x,x,x,x,x,x,x,x) = 10 ': DimPG x
300282 DimPG x = '[]
301283
284+-- | `FixPG` extracts `NullPG` of the base type of nested homogeneous tuples.
302285type family FixPG (hask :: Type) :: NullityType where
303286 FixPG (x,x) = FixPG x
304287 FixPG (x,x,x) = FixPG x
@@ -328,7 +311,7 @@ let
328311>>> let input = Only (Money 20020)
329312
330313>>> :{
331−void . withConnection "host=localhost port=5432 dbname=exampledb" $ do
314+withConnection "host=localhost port=5432 dbname=exampledb" $ do
332315 result <- runQueryParams roundTrip input
333316 Just output <- firstRow result
334317 liftIO . print $ input == output
@@ -336,47 +319,70 @@ void . withConnection "host=localhost port=5432 dbname=exampledb" $ do
336319True
337320-}
338321newtype Money = Money { cents :: Int64 }
339− deriving (Eq, Ord, Show, Read, GHC.Generic)
322+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)
323+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)
324+-- | `PGmoney`
340325type instance PG Money = 'PGmoney
341326
342327{- | The `Json` newtype is an indication that the Haskell
343328type it's applied to should be stored as a `PGjson`.
344329-}
345330newtype Json hask = Json {getJson :: hask}
346− deriving (Eq, Ord, Show, Read, GHC.Generic)
331+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)
332+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)
333+-- | `PGjson`
347334type instance PG (Json hask) = 'PGjson
348335
349336{- | The `Jsonb` newtype is an indication that the Haskell
350337type it's applied to should be stored as a `PGjsonb`.
351338-}
352339newtype Jsonb hask = Jsonb {getJsonb :: hask}
353− deriving (Eq, Ord, Show, Read, GHC.Generic)
340+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)
341+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)
342+-- | `PGjsonb`
354343type instance PG (Jsonb hask) = 'PGjsonb
355344
356345{- | The `Composite` newtype is an indication that the Haskell
357346type it's applied to should be stored as a `PGcomposite`.
358347-}
359348newtype Composite record = Composite {getComposite :: record}
360− deriving (Eq, Ord, Show, Read, GHC.Generic)
349+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)
350+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)
351+-- | `PGcomposite` @(@`RowPG` @hask)@
361352type instance PG (Composite hask) = 'PGcomposite (RowPG hask)
362353
363354{- | The `Enumerated` newtype is an indication that the Haskell
364355type it's applied to should be stored as a `PGenum`.
365356-}
366357newtype Enumerated enum = Enumerated {getEnumerated :: enum}
367− deriving (Eq, Ord, Show, Read, GHC.Generic)
358+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)
359+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)
360+-- | `PGenum` @(@`LabelsPG` @hask)@
368361type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)
369362
370363{- | The `VarArray` newtype is an indication that the Haskell
371364type it's applied to should be stored as a `PGvararray`.
365+
366+>>> :kind! PG (VarArray (Vector Double))
367+PG (VarArray (Vector Double)) :: PGType
368+= 'PGvararray ('NotNull 'PGfloat8)
372369-}
373370newtype VarArray arr = VarArray {getVarArray :: arr}
374− deriving (Eq, Ord, Show, Read, GHC.Generic)
371+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)
372+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)
373+-- | `PGvararray` @(@`NullPG` @hask)@
375374type instance PG (VarArray (Vector hask)) = 'PGvararray (NullPG hask)
375+type instance PG (VarArray [hask]) = 'PGvararray (NullPG hask)
376376
377377{- | The `FixArray` newtype is an indication that the Haskell
378378type it's applied to should be stored as a `PGfixarray`.
379+
380+>>> :kind! PG (FixArray ((Double, Double), (Double, Double)))
381+PG (FixArray ((Double, Double), (Double, Double))) :: PGType
382+= 'PGfixarray '[2, 2] ('NotNull 'PGfloat8)
379383-}
380384newtype FixArray arr = FixArray {getFixArray :: arr}
381− deriving (Eq, Ord, Show, Read, GHC.Generic)
382−type instance PG (FixArray x) = 'PGfixarray (DimPG x) (FixPG x)
385+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)
386+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)
387+-- | `PGfixarray` @(@`DimPG` @hask) (@`FixPG` @hask)@
388+type instance PG (FixArray hask) = 'PGfixarray (DimPG hask) (FixPG hask)
squeal-postgresql/src/Squeal/PostgreSQL/PQ.hs+96−40
@@ -64,17 +64,21 @@ module Squeal.PostgreSQL.PQ
6464 , resultErrorCode
6565 -- * Exceptions
6666 , SquealException (..)
67+ , PQState (..)
68+ , okResult
6769 , catchSqueal
6870 , handleSqueal
71+ , trySqueal
6972 ) where
7073
7174import Control.Exception (Exception, throw)
7275import Control.Monad.Except
7376import Control.Monad.Morph
74−import UnliftIO (MonadUnliftIO (..), bracket, catch, handle)
77+import UnliftIO (MonadUnliftIO (..), bracket, catch, handle, try)
7578import Data.ByteString (ByteString)
7679import Data.Foldable
7780import Data.Function ((&))
81+import Data.Functor ((<&>))
7882import Data.Kind
7983import Data.Text (pack, Text)
8084import Data.Traversable
@@ -83,6 +87,7 @@ import PostgreSQL.Binary.Encoding (encodingBytes)
8387
8488import qualified Control.Monad.Fail as Fail
8589import qualified Database.PostgreSQL.LibPQ as LibPQ
90+import qualified PostgreSQL.Binary.Encoding as Encoding
8691
8792import Squeal.PostgreSQL.Binary
8893import Squeal.PostgreSQL.Definition
@@ -243,13 +248,16 @@ class IndexedMonadTransPQ pq where
243248 -> x -> pq schemas0 schemas2 m z
244249 pqAndThen g f x = pqBind g (f x)
245250
246− -- | Run a `Definition` with `LibPQ.exec`, we expect that libpq obeys the law
251+ -- | Run a `Definition` with `LibPQ.exec`.
247252 --
248− -- @define statement1 & pqThen (define statement2) = define (statement1 >>> statement2)@
253+ -- It should be functorial in effect.
254+ --
255+ -- @define id = return ()@
256+ -- @define (statement1 >>> statement2) = define statement1 & pqThen (define statement2)@
249257 define
250258 :: MonadIO io
251259 => Definition schemas0 schemas1
252− -> pq schemas0 schemas1 io (K LibPQ.Result '[])
260+ -> pq schemas0 schemas1 io ()
253261
254262instance IndexedMonadTransPQ PQ where
255263
@@ -267,7 +275,7 @@ instance IndexedMonadTransPQ PQ where
267275 case resultMaybe of
268276 Nothing -> throw $ ResultException
269277 "define: LibPQ.exec returned no results"
270− Just result -> return $ K (K result)
278+ Just result -> K <$> okResult_ result
271279
272280{- | `MonadPQ` is an @mtl@ style constraint, similar to
273281`Control.Monad.State.Class.MonadState`, for using `Database.PostgreSQL.LibPQ` to
@@ -276,8 +284,12 @@ instance IndexedMonadTransPQ PQ where
276284 with a `ToParams` constraint. It calls `LibPQ.execParams` and
277285 doesn't afraid of anything.
278286
287+* `manipulateParams_` is like `manipulateParams` for a returning-free statement.
288+
279289* `manipulate` is like `manipulateParams` for a parameter-free statement.
280290
291+* `manipulate_` is like `manipulate` for a returning-free statement.
292+
281293* `runQueryParams` is like `manipulateParams` for query statements.
282294
283295* `runQuery` is like `runQueryParams` for a parameter-free statement.
@@ -291,7 +303,7 @@ instance IndexedMonadTransPQ PQ where
291303* `forPrepared` is a flipped `traversePrepared`
292304
293305* `traversePrepared_` is like `traversePrepared` but works on `Foldable`
294− containers and returns unit.
306+ containers for a returning-free statement.
295307
296308* `forPrepared_` is a flipped `traversePrepared_`.
297309
@@ -305,24 +317,34 @@ a default instance.
305317-}
306318class Monad pq => MonadPQ schemas pq | pq -> schemas where
307319 manipulateParams
308− :: ToParams x params
320+ :: (ToParams x params, All OidOfParam params)
309321 => Manipulation '[] schemas params ys
310322 -- ^ `insertInto`, `update` or `deleteFrom`
311323 -> x -> pq (K LibPQ.Result ys)
312324 default manipulateParams
313325 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)
314− => ToParams x params
326+ => (ToParams x params, All OidOfParam params)
315327 => Manipulation '[] schemas params ys
316328 -- ^ `insertInto`, `update` or `deleteFrom`
317329 -> x -> pq (K LibPQ.Result ys)
318330 manipulateParams manipulation params = lift $
319331 manipulateParams manipulation params
320332
333+ manipulateParams_
334+ :: (ToParams x params, All OidOfParam params)
335+ => Manipulation '[] schemas params '[]
336+ -- ^ `insertInto`, `update` or `deleteFrom`
337+ -> x -> pq ()
338+ manipulateParams_ q x = void $ manipulateParams q x
339+
321340 manipulate :: Manipulation '[] schemas '[] ys -> pq (K LibPQ.Result ys)
322341 manipulate statement = manipulateParams statement ()
323342
343+ manipulate_ :: Manipulation '[] schemas '[] '[] -> pq ()
344+ manipulate_ = void . manipulate
345+
324346 runQueryParams
325− :: ToParams x params
347+ :: (ToParams x params, All OidOfParam params)
326348 => Query '[] '[] schemas params ys
327349 -- ^ `select` and friends
328350 -> x -> pq (K LibPQ.Result ys)
@@ -335,19 +357,19 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where
335357 runQuery q = runQueryParams q ()
336358
337359 traversePrepared
338− :: (ToParams x params, Traversable list)
360+ :: (ToParams x params, Traversable list, All OidOfParam params)
339361 => Manipulation '[] schemas params ys
340362 -- ^ `insertInto`, `update`, or `deleteFrom`, and friends
341363 -> list x -> pq (list (K LibPQ.Result ys))
342364 default traversePrepared
343365 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)
344− => (ToParams x params, Traversable list)
366+ => (ToParams x params, Traversable list, All OidOfParam params)
345367 => Manipulation '[] schemas params ys -> list x -> pq (list (K LibPQ.Result ys))
346368 traversePrepared manipulation params = lift $
347369 traversePrepared manipulation params
348370
349371 forPrepared
350− :: (ToParams x params, Traversable list)
372+ :: (ToParams x params, Traversable list, All OidOfParam params)
351373 => list x
352374 -> Manipulation '[] schemas params ys
353375 -- ^ `insertInto`, `update` or `deleteFrom`
@@ -355,13 +377,13 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where
355377 forPrepared = flip traversePrepared
356378
357379 traversePrepared_
358− :: (ToParams x params, Foldable list)
380+ :: (ToParams x params, Foldable list, All OidOfParam params)
359381 => Manipulation '[] schemas params '[]
360382 -- ^ `insertInto`, `update` or `deleteFrom`
361383 -> list x -> pq ()
362384 default traversePrepared_
363385 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)
364− => (ToParams x params, Foldable list)
386+ => (ToParams x params, Foldable list, All OidOfParam params)
365387 => Manipulation '[] schemas params '[]
366388 -- ^ `insertInto`, `update` or `deleteFrom`
367389 -> list x -> pq ()
@@ -369,7 +391,7 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where
369391 traversePrepared_ manipulation params
370392
371393 forPrepared_
372− :: (ToParams x params, Foldable list)
394+ :: (ToParams x params, Foldable list, All OidOfParam params)
373395 => list x
374396 -> Manipulation '[] schemas params '[]
375397 -- ^ `insertInto`, `update` or `deleteFrom`
@@ -389,54 +411,76 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)
389411 (UnsafeManipulation q :: Manipulation '[] schemas ps ys) (params :: x) =
390412 PQ $ \ (K conn) -> do
391413 let
392− toParam' encoding =
393− (LibPQ.invalidOid, encodingBytes encoding, LibPQ.Binary)
394− params' = fmap (fmap toParam') (hcollapse (toParams @x @ps params))
414+ paramSet
415+ :: forall param. OidOfParam param
416+ => K (Maybe Encoding.Encoding) param
417+ -> K (Maybe (LibPQ.Oid, ByteString, LibPQ.Format)) param
418+ paramSet (K maybeEncoding) = K $
419+ maybeEncoding <&> \encoding ->
420+ (oidOfParam @param, encodingBytes encoding, LibPQ.Binary)
421+ params'
422+ = hcollapse
423+ . hcmap (Proxy @OidOfParam) paramSet
424+ $ toParams @x @ps params
395425 q' = q <> ";"
396426 resultMaybe <- liftIO $ LibPQ.execParams conn q' params' LibPQ.Binary
397427 case resultMaybe of
398428 Nothing -> throw $ ResultException
399429 "manipulateParams: LibPQ.execParams returned no results"
400430 Just result -> do
401− tryResult result
431+ okResult_ result
402432 return $ K (K result)
403433
404434 traversePrepared
405435 (UnsafeManipulation q :: Manipulation '[] schemas xs ys) (list :: list x) =
406436 PQ $ \ (K conn) -> liftIO $ do
407− let temp = "temporary_statement"
408− prepResultMaybe <- LibPQ.prepare conn temp q Nothing
437+ let
438+ temp = "temporary_statement"
439+ paramOid :: forall p. OidOfParam p => K LibPQ.Oid p
440+ paramOid = K (oidOfParam @p)
441+ paramOids :: NP (K LibPQ.Oid) xs
442+ paramOids = hcpure (Proxy @OidOfParam) paramOid
443+ paramOids' :: [LibPQ.Oid]
444+ paramOids' = hcollapse paramOids
445+ prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')
409446 case prepResultMaybe of
410447 Nothing -> throw $ ResultException
411448 "traversePrepared: LibPQ.prepare returned no results"
412− Just prepResult -> tryResult prepResult
449+ Just prepResult -> okResult_ prepResult
413450 results <- for list $ \ params -> do
414451 let
415− toParam' encoding = (encodingBytes encoding,LibPQ.Binary)
452+ toParam' encoding = (encodingBytes encoding, LibPQ.Binary)
416453 params' = fmap (fmap toParam') (hcollapse (toParams @x @xs params))
417454 resultMaybe <- LibPQ.execPrepared conn temp params' LibPQ.Binary
418455 case resultMaybe of
419456 Nothing -> throw $ ResultException
420457 "traversePrepared: LibPQ.execParams returned no results"
421458 Just result -> do
422− tryResult result
459+ okResult_ result
423460 return $ K result
424461 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")
425462 case deallocResultMaybe of
426463 Nothing -> throw $ ResultException
427464 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"
428− Just deallocResult -> tryResult deallocResult
465+ Just deallocResult -> okResult_ deallocResult
429466 return (K results)
430467
431468 traversePrepared_
432469 (UnsafeManipulation q :: Manipulation '[] schemas xs '[]) (list :: list x) =
433470 PQ $ \ (K conn) -> liftIO $ do
434− let temp = "temporary_statement"
435− prepResultMaybe <- LibPQ.prepare conn temp q Nothing
471+ let
472+ temp = "temporary_statement"
473+ paramOid :: forall p. OidOfParam p => K LibPQ.Oid p
474+ paramOid = K (oidOfParam @p)
475+ paramOids :: NP (K LibPQ.Oid) xs
476+ paramOids = hcpure (Proxy @OidOfParam) paramOid
477+ paramOids' :: [LibPQ.Oid]
478+ paramOids' = hcollapse paramOids
479+ prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')
436480 case prepResultMaybe of
437481 Nothing -> throw $ ResultException
438482 "traversePrepared_: LibPQ.prepare returned no results"
439− Just prepResult -> tryResult prepResult
483+ Just prepResult -> okResult_ prepResult
440484 for_ list $ \ params -> do
441485 let
442486 toParam' encoding = (encodingBytes encoding, LibPQ.Binary)
@@ -445,12 +489,12 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)
445489 case resultMaybe of
446490 Nothing -> throw $ ResultException
447491 "traversePrepared_: LibPQ.execParams returned no results"
448− Just result -> tryResult result
492+ Just result -> okResult_ result
449493 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")
450494 case deallocResultMaybe of
451495 Nothing -> throw $ ResultException
452496 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"
453− Just deallocResult -> tryResult deallocResult
497+ Just deallocResult -> okResult_ deallocResult
454498 return (K ())
455499
456500 liftPQ pq = PQ $ \ (K conn) -> do
@@ -613,24 +657,24 @@ resultErrorCode
613657 -> io (Maybe ByteString)
614658resultErrorCode = liftResult (flip LibPQ.resultErrorField LibPQ.DiagSqlstate)
615659
616−-- | `Exception`s that can be thrown by Squeal.
617−data SquealException
618− = PQException
660+-- | the state of LibPQ
661+data PQState = PQState
619662 { sqlExecStatus :: LibPQ.ExecStatus
620663 , sqlStateCode :: Maybe ByteString
621664 -- ^ https://www.postgresql.org/docs/current/static/errcodes-appendix.html
622665 , sqlErrorMessage :: Maybe ByteString
623− }
666+ } deriving (Eq, Show)
667+
668+-- | `Exception`s that can be thrown by Squeal.
669+data SquealException
670+ = PQException PQState
624671 | ResultException Text
625672 | ParseException Text
626673 deriving (Eq, Show)
627674instance Exception SquealException
628675
629−tryResult
630− :: MonadIO io
631− => LibPQ.Result
632− -> io ()
633−tryResult result = liftIO $ do
676+okResult_ :: MonadIO io => LibPQ.Result -> io ()
677+okResult_ result = liftIO $ do
634678 status <- LibPQ.resultStatus result
635679 case status of
636680 LibPQ.CommandOk -> return ()
@@ -638,7 +682,12 @@ tryResult result = liftIO $ do
638682 _ -> do
639683 stateCode <- LibPQ.resultErrorField result LibPQ.DiagSqlstate
640684 msg <- LibPQ.resultErrorMessage result
641− throw $ PQException status stateCode msg
685+ throw . PQException $ PQState status stateCode msg
686+
687+-- | Check if a `LibPQ.Result`'s status is either `LibPQ.CommandOk`
688+-- or `LibPQ.TuplesOk` otherwise `throw` a `PQException`.
689+okResult :: MonadIO io => K LibPQ.Result row -> io ()
690+okResult = okResult_ . unK
642691
643692-- | Catch `SquealException`s.
644693catchSqueal
@@ -654,3 +703,10 @@ handleSqueal
654703 => (SquealException -> io a) -- ^ handler
655704 -> io a -> io a
656705handleSqueal = handle
706+
707+-- | `Either` return a `SquealException` or a result.
708+trySqueal
709+ :: MonadUnliftIO io
710+ => io a
711+ -> io (Either SquealException a)
712+trySqueal = try
squeal-postgresql/src/Squeal/PostgreSQL/Pool.hs+67−99
@@ -1,11 +1,33 @@
11{-|
2−Module: Squeal.PostgreSQL.Definition
3−Description: Pooled connections
2+Module: Squeal.PostgreSQL.Pool
3+Description: Connection pools
44Copyright: (c) Eitan Chatav, 2017
55Maintainer: eitan@morphism.tech
66Stability: experimental
77
8−A `MonadPQ` for pooled connections.
8+Connection pools.
9+
10+Typical use case would be to create your pool using `createConnectionPool`
11+and run anything that requires the pool connection with `usingConnectionPool`.
12+
13+Here's a simplified example:
14+
15+>>> import Squeal.PostgreSQL
16+
17+>>> :{
18+do
19+ let
20+ query :: Query_ (Public '[]) () (Only Char)
21+ query = values_ (literal 'a' `as` #fromOnly)
22+ pool <- createConnectionPool "host=localhost port=5432 dbname=exampledb" 1 0.5 10
23+ chr <- usingConnectionPool pool $ do
24+ result <- runQuery query
25+ Just (Only a) <- firstRow result
26+ return a
27+ destroyConnectionPool pool
28+ putChar chr
29+:}
30+a
931-}
1032
1133{-# LANGUAGE
@@ -23,51 +45,19 @@ A `MonadPQ` for pooled connections.
2345
2446module Squeal.PostgreSQL.Pool
2547 ( -- * Pools
26− PoolPQ (..)
48+ Pool
2749 , createConnectionPool
28− , Pool
29− , destroyAllResources
50+ , usingConnectionPool
51+ , destroyConnectionPool
3052 ) where
3153
32−import Control.Monad.Trans
3354import Data.ByteString
3455import Data.Time
35−import Generics.SOP (K(..))
56+import Generics.SOP (K(..), unK)
3657import UnliftIO (MonadUnliftIO (..))
3758import UnliftIO.Pool (Pool, createPool, destroyAllResources, withResource)
3859
39−import qualified Control.Monad.Fail as Fail
40−
4160import Squeal.PostgreSQL.PQ
42−import Squeal.PostgreSQL.Schema
43−
44−{- | `PoolPQ` @schemas@ should be a drop-in replacement for `PQ` @schemas schemas@.
45−
46−Typical use case would be to create your pool using `createConnectionPool` and run anything that requires the pool connection with it.
47−
48−Here's a simplified example:
49−
50−>>> import Squeal.PostgreSQL
51−>>> :{
52−do
53− let
54− query :: Query_ (Public '[]) () (Only Char)
55− query = values_ $ literal 'a' `as` #fromOnly
56− session :: PoolPQ (Public '[]) IO Char
57− session = do
58− result <- runQuery query
59− Just (Only chr) <- firstRow result
60− return chr
61− pool <- createConnectionPool "host=localhost port=5432 dbname=exampledb" 1 0.5 10
62− chr <- runPoolPQ session pool
63− destroyAllResources pool
64− putChar chr
65−:}
66−a
67−-}
68−newtype PoolPQ (schemas :: SchemasType) m x =
69− PoolPQ { runPoolPQ :: Pool (K Connection schemas) -> m x }
70− deriving Functor
7161
7262-- | Create a striped pool of connections.
7363-- Although the garbage collector will destroy all idle connections when the pool is garbage collected it's recommended to manually `destroyAllResources` when you're done with the pool so that the connections are freed up as soon as possible.
@@ -92,63 +82,41 @@ createConnectionPool
9282createConnectionPool conninfo stripes idle maxResrc =
9383 createPool (connectdb conninfo) finish stripes idle maxResrc
9484
95−-- | `Applicative` instance for `PoolPQ`.
96−instance Monad m => Applicative (PoolPQ schemas m) where
97− pure x = PoolPQ $ \ _ -> pure x
98− PoolPQ f <*> PoolPQ x = PoolPQ $ \ pool -> do
99− f' <- f pool
100− x' <- x pool
101− return $ f' x'
102−
103−-- | `Monad` instance for `PoolPQ`.
104−instance Monad m => Monad (PoolPQ schemas m) where
105− return = pure
106− PoolPQ x >>= f = PoolPQ $ \ pool -> do
107− x' <- x pool
108− runPoolPQ (f x') pool
109−
110−-- | `Fail.MonadFail` instance for `PoolPQ`.
111−instance Monad m => Fail.MonadFail (PoolPQ schemas m) where
112− fail = Fail.fail
113−
114−-- | `MonadTrans` instance for `PoolPQ`.
115−instance MonadTrans (PoolPQ schemas) where
116− lift m = PoolPQ $ \ _pool -> m
117−
118−-- | `MonadPQ` instance for `PoolPQ`.
119−instance MonadUnliftIO io => MonadPQ schemas (PoolPQ schemas io) where
120− manipulateParams manipulation params = PoolPQ $ \ pool -> do
121− withResource pool $ \ conn -> do
122− (K result :: K (K Result ys) schemas) <- flip unPQ conn $
123− manipulateParams manipulation params
124− return result
125− traversePrepared manipulation params = PoolPQ $ \ pool ->
126− withResource pool $ \ conn -> do
127− (K result :: K (list (K Result ys)) schemas) <- flip unPQ conn $
128− traversePrepared manipulation params
129− return result
130− traversePrepared_ manipulation params = PoolPQ $ \ pool -> do
131− withResource pool $ \ conn -> do
132− (_ :: K () schemas) <- flip unPQ conn $
133− traversePrepared_ manipulation params
134− return ()
135− liftPQ m = PoolPQ $ \ pool ->
136− withResource pool $ \ conn -> do
137− (K result :: K result schemas) <- flip unPQ conn $
138− liftPQ m
139− return result
140−
141−-- | 'MonadIO' instance for 'PoolPQ'.
142−instance (MonadIO m)
143− => MonadIO (PoolPQ schemas m) where
144− liftIO = lift . liftIO
145−
146−-- | 'MonadUnliftIO' instance for 'PoolPQ'.
147−instance (MonadUnliftIO m)
148− => MonadUnliftIO (PoolPQ schemas m) where
149− withRunInIO
150− :: ((forall a . PoolPQ schemas m a -> IO a) -> IO b)
151− -> PoolPQ schemas m b
152− withRunInIO inner = PoolPQ $ \pool ->
153− withRunInIO $ \(run :: (forall x . m x -> IO x)) ->
154− inner (\poolpq -> run $ runPoolPQ poolpq pool)
85+{-|
86+Temporarily take a connection from a `Pool`, perform an action with it,
87+and return it to the pool afterwards.
88+
89+If the pool has an idle connection available, it is used immediately.
90+Otherwise, if the maximum number of connections has not yet been reached,
91+a new connection is created and used.
92+If the maximum number of connections has been reached, this function blocks
93+until a connection becomes available.
94+-}
95+usingConnectionPool
96+ :: MonadUnliftIO io
97+ => Pool (K Connection schemas) -- ^ pool
98+ -> PQ schemas schemas io x -- ^ session
99+ -> io x
100+usingConnectionPool pool (PQ session) = unK <$> withResource pool session
101+
102+{- |
103+Destroy all connections in all stripes in the pool.
104+Note that this will ignore any exceptions in the destroy function.
105+
106+This function is useful when you detect that all connections
107+in the pool are broken. For example after a database has been
108+restarted all connections opened before the restart will be broken.
109+In that case it's better to close those connections so that
110+`usingConnectionPool` won't take a broken connection from the pool
111+but will open a new connection instead.
112+
113+Another use-case for this function is that when you know you are done
114+with the pool you can destroy all idle connections immediately
115+instead of waiting on the garbage collector to destroy them,
116+thus freeing up those connections sooner.
117+-}
118+destroyConnectionPool
119+ :: MonadUnliftIO io
120+ => Pool (K Connection schemas) -- ^ pool
121+ -> io ()
122+destroyConnectionPool = destroyAllResources
squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+247−370
@@ -1,7 +1,7 @@
11{-|
22Module: Squeal.PostgreSQL.Query
33Description: Squeal queries
4−Copyright: (c) Eitan Chatav, 2017
4+Copyright: (c) Eitan Chatav, 2019
55Maintainer: eitan@morphism.tech
66Stability: experimental
77
@@ -32,13 +32,15 @@ Squeal queries.
3232
3333module Squeal.PostgreSQL.Query
3434 ( -- * Queries
35− Query (..)
36− , Query_
35+ Query_
36+ , Query (..)
3737 -- ** Select
3838 , select
3939 , select_
4040 , selectDistinct
4141 , selectDistinct_
42+ , selectDistinctOn
43+ , selectDistinctOn_
4244 , Selection (..)
4345 -- ** Values
4446 , values
@@ -53,23 +55,7 @@ module Squeal.PostgreSQL.Query
5355 -- ** With
5456 , With (..)
5557 , CommonTableExpression (..)
56− -- ** Unnest
57− , unnest
58− -- ** Json
59− , jsonEach
60− , jsonbEach
61− , jsonEachText
62− , jsonbEachText
63− , jsonObjectKeys
64− , jsonbObjectKeys
65− , jsonPopulateRecord
66− , jsonbPopulateRecord
67− , jsonPopulateRecordSet
68− , jsonbPopulateRecordSet
69− , jsonToRecord
70− , jsonbToRecord
71− , jsonToRecordSet
72− , jsonbToRecordSet
58+ , withRecursive
7359 -- * Table Expressions
7460 , TableExpression (..)
7561 , from
@@ -93,13 +79,6 @@ module Squeal.PostgreSQL.Query
9379 , By (..)
9480 , GroupByClause (..)
9581 , HavingClause (..)
96− -- * Subquery Expressions
97− , exists
98− , in_
99− , notIn
100− , Operator
101− , subAll
102− , subAny
10382 ) where
10483
10584import Control.DeepSeq
@@ -124,10 +103,55 @@ import Squeal.PostgreSQL.Schema
124103
125104-- $setup
126105-- >>> import Squeal.PostgreSQL
106+-- >>> import Data.Int (Int32, Int64)
107+-- >>> import Data.Monoid (Sum (..))
108+-- >>> import Data.Text (Text)
109+-- >>> import qualified Generics.SOP as SOP
127110
128111{- |
129−The process of retrieving or the command to retrieve data from a database
130−is called a `Query`. Let's see some examples of queries.
112+The process of retrieving or the command to retrieve data from
113+a database is called a `Query`.
114+
115+The general `Query` type is parameterized by
116+
117+* @outer :: FromType@ - outer scope for a correlated subquery,
118+* @commons :: FromType@ - scope for all `common` table expressions,
119+* @schemas :: SchemasType@ - scope for all `table`s and `view`s,
120+* @params :: [NullityType]@ - scope for all `Squeal.Expression.Parameter.parameter`s,
121+* @row :: RowType@ - return type of the `Query`.
122+-}
123+newtype Query
124+ (outer :: FromType)
125+ (commons :: FromType)
126+ (schemas :: SchemasType)
127+ (params :: [NullityType])
128+ (row :: RowType)
129+ = UnsafeQuery { renderQuery :: ByteString }
130+ deriving (GHC.Generic,Show,Eq,Ord,NFData)
131+instance RenderSQL (Query outer commons schemas params row) where renderSQL = renderQuery
132+
133+{- |
134+The top level `Query_` type is parameterized by a @schemas@ `SchemasType`,
135+against which the query is type-checked, an input @parameters@ Haskell `Type`,
136+and an ouput row Haskell `Type`.
137+
138+A top-level query can be run
139+using `Squeal.PostgreSQL.PQ.runQueryParams`, or if @parameters = ()@
140+using `Squeal.PostgreSQL.PQ.runQuery`.
141+
142+Generally, @parameters@ will be a Haskell tuple or record whose entries
143+may be referenced using positional
144+`Squeal.PostgreSQL.Expression.Parameter.parameter`s and @row@ will be a
145+Haskell record, whose entries will be targeted using overloaded labels.
146+
147+Let's see some examples of queries.
148+
149+>>> :set -XDeriveAnyClass -XDerivingStrategies
150+>>> :{
151+data Row a b = Row { col1 :: a, col2 :: b }
152+ deriving stock (GHC.Generic)
153+ deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)
154+:}
131155
132156simple query:
133157
@@ -135,7 +159,7 @@ simple query:
135159>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]
136160>>> :{
137161let
138− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]
162+ query :: Query_ (Public Schema) () (Row Int32 Int32)
139163 query = select Star (from (table #tab))
140164in printSQL query
141165:}
@@ -145,21 +169,21 @@ restricted query:
145169
146170>>> :{
147171let
148− query :: Query '[] '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4]
172+ query :: Query_ (Public Schema) () (Row Int32 Int32)
149173 query =
150− select_ ((#col1 + #col2) `as` #sum :* #col1)
174+ select_ ((#col1 + #col2) `as` #col1 :* #col1 `as` #col2)
151175 ( from (table #tab)
152176 & where_ (#col1 .> #col2)
153177 & where_ (#col2 .> 0) )
154178in printSQL query
155179:}
156−SELECT ("col1" + "col2") AS "sum", "col1" AS "col1" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))
180+SELECT ("col1" + "col2") AS "col1", "col1" AS "col2" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))
157181
158182subquery:
159183
160184>>> :{
161185let
162− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]
186+ query :: Query_ (Public Schema) () (Row Int32 Int32)
163187 query = select Star (from (subquery (select Star (from (table #tab)) `as` #sub)))
164188in printSQL query
165189:}
@@ -169,7 +193,7 @@ limits and offsets:
169193
170194>>> :{
171195let
172− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]
196+ query :: Query_ (Public Schema) () (Row Int32 Int32)
173197 query = select Star (from (table #tab) & limit 100 & offset 2 & limit 50 & offset 2)
174198in printSQL query
175199:}
@@ -179,7 +203,7 @@ parameterized query:
179203
180204>>> :{
181205let
182− query :: Query '[] '[] (Public Schema) '[ 'NotNull 'PGint4] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]
206+ query :: Query_ (Public Schema) (Only Int32) (Row Int32 Int32)
183207 query = select Star (from (table #tab) & where_ (#col1 .> param @1))
184208in printSQL query
185209:}
@@ -189,21 +213,21 @@ aggregation query:
189213
190214>>> :{
191215let
192− query :: Query '[] '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4 ]
216+ query :: Query_ (Public Schema) () (Row Int64 Int32)
193217 query =
194− select_ (sum_ (All #col2) `as` #sum :* #col1)
218+ select_ ((fromNull 0 (sum_ (All #col2))) `as` #col1 :* #col1 `as` #col2)
195219 ( from (table (#tab `as` #table1))
196220 & groupBy #col1
197− & having (#col1 + sum_ (Distinct #col2) .> 1) )
221+ & having (sum_ (Distinct #col2) .> 1) )
198222in printSQL query
199223:}
200−SELECT sum(ALL "col2") AS "sum", "col1" AS "col1" FROM "tab" AS "table1" GROUP BY "col1" HAVING (("col1" + sum(DISTINCT "col2")) > 1)
224+SELECT COALESCE(sum(ALL "col2"), 0) AS "col1", "col1" AS "col2" FROM "tab" AS "table1" GROUP BY "col1" HAVING (sum(DISTINCT "col2") > 1)
201225
202226sorted query:
203227
204228>>> :{
205229let
206− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]
230+ query :: Query_ (Public Schema) () (Row Int32 Int32)
207231 query = select Star (from (table #tab) & orderBy [#col1 & Asc])
208232in printSQL query
209233:}
@@ -211,14 +235,12 @@ SELECT * FROM "tab" AS "tab" ORDER BY "col1" ASC
211235
212236joins:
213237
214−>>> :set -XFlexibleContexts
215238>>> :{
216239type OrdersColumns =
217240 '[ "id" ::: 'NoDef :=> 'NotNull 'PGint4
218− , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4
219− , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4
220− , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4
221− ]
241+ , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4
242+ , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4
243+ , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4 ]
222244:}
223245
224246>>> :{
@@ -234,22 +256,27 @@ type OrdersConstraints =
234256>>> :{
235257type OrdersSchema =
236258 '[ "orders" ::: 'Table (OrdersConstraints :=> OrdersColumns)
237− , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)
238− , "shippers" ::: 'Table (ShippersConstraints :=> NamesColumns) ]
259+ , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)
260+ , "shippers" ::: 'Table (ShippersConstraints :=> NamesColumns) ]
261+:}
262+
263+>>> :{
264+data Order = Order
265+ { price :: Float
266+ , customerName :: Text
267+ , shipperName :: Text
268+ } deriving GHC.Generic
269+instance SOP.Generic Order
270+instance SOP.HasDatatypeInfo Order
239271:}
240272
241273>>> :{
242274let
243− query :: Query '[] '[] (Public OrdersSchema)
244− '[]
245− '[ "order_price" ::: 'NotNull 'PGfloat4
246− , "customer_name" ::: 'NotNull 'PGtext
247− , "shipper_name" ::: 'NotNull 'PGtext
248− ]
275+ query :: Query_ (Public OrdersSchema) () Order
249276 query = select_
250− ( #o ! #price `as` #order_price :*
251− #c ! #name `as` #customer_name :*
252− #s ! #name `as` #shipper_name )
277+ ( #o ! #price `as` #price :*
278+ #c ! #name `as` #customerName :*
279+ #s ! #name `as` #shipperName )
253280 ( from (table (#orders `as` #o)
254281 & innerJoin (table (#customers `as` #c))
255282 (#o ! #customer_id .== #c ! #id)
@@ -257,14 +284,16 @@ let
257284 (#o ! #shipper_id .== #s ! #id)) )
258285in printSQL query
259286:}
260−SELECT "o"."price" AS "order_price", "c"."name" AS "customer_name", "s"."name" AS "shipper_name" FROM "orders" AS "o" INNER JOIN "customers" AS "c" ON ("o"."customer_id" = "c"."id") INNER JOIN "shippers" AS "s" ON ("o"."shipper_id" = "s"."id")
287+SELECT "o"."price" AS "price", "c"."name" AS "customerName", "s"."name" AS "shipperName" FROM "orders" AS "o" INNER JOIN "customers" AS "c" ON ("o"."customer_id" = "c"."id") INNER JOIN "shippers" AS "s" ON ("o"."shipper_id" = "s"."id")
261288
262289self-join:
263290
264291>>> :{
265292let
266− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]
267− query = select (#t1 & DotStar) (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))
293+ query :: Query_ (Public Schema) () (Row Int32 Int32)
294+ query = select
295+ (#t1 & DotStar)
296+ (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))
268297in printSQL query
269298:}
270299SELECT "t1".* FROM "tab" AS "t1" CROSS JOIN "tab" AS "t2"
@@ -273,17 +302,19 @@ value queries:
273302
274303>>> :{
275304let
276− query :: Query '[] commons schemas '[] '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]
277− query = values (1 `as` #foo :* true `as` #bar) [2 `as` #foo :* false `as` #bar]
305+ query :: Query_ schemas () (Row String Bool)
306+ query = values
307+ ("true" `as` #col1 :* true `as` #col2)
308+ ["false" `as` #col1 :* false `as` #col2]
278309in printSQL query
279310:}
280−SELECT * FROM (VALUES (1, TRUE), (2, FALSE)) AS t ("foo", "bar")
311+SELECT * FROM (VALUES (E'true', TRUE), (E'false', FALSE)) AS t ("col1", "col2")
281312
282313set operations:
283314
284315>>> :{
285316let
286− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]
317+ query :: Query_ (Public Schema) () (Row Int32 Int32)
287318 query = select Star (from (table #tab)) `unionAll` select Star (from (table #tab))
288319in printSQL query
289320:}
@@ -293,7 +324,7 @@ with queries:
293324
294325>>> :{
295326let
296− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]
327+ query :: Query_ (Public Schema) () (Row Int32 Int32)
297328 query = with (
298329 select Star (from (table #tab)) `as` #cte1 :>>
299330 select Star (from (common #cte1)) `as` #cte2
@@ -306,40 +337,35 @@ window function queries
306337
307338>>> :{
308339let
309− query :: Query '[] '[] (Public Schema) '[] ["col1" ::: 'NotNull 'PGint4, "rank" ::: 'NotNull 'PGint8]
340+ query :: Query_ (Public Schema) () (Row Int32 Int64)
310341 query = select
311− (#col1 & Also (rank `as` #rank `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))
342+ (#col1 & Also (rank `as` #col2 `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))
312343 (from (table #tab))
313344in printSQL query
314345:}
315−SELECT "col1" AS "col1", rank() OVER (PARTITION BY "col1" ORDER BY "col2" ASC) AS "rank" FROM "tab" AS "tab"
346+SELECT "col1" AS "col1", rank() OVER (PARTITION BY "col1" ORDER BY "col2" ASC) AS "col2" FROM "tab" AS "tab"
316347
317348correlated subqueries
318349
319350>>> :{
320351let
321− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4]
352+ query :: Query_ (Public Schema) () (Only Int32)
322353 query =
323− select #col1 (from (table (#tab `as` #t1))
354+ select (#col1 `as` #fromOnly) (from (table (#tab `as` #t1))
324355 & where_ (exists (
325356 select Star (from (table (#tab `as` #t2))
326357 & where_ (#t2 ! #col2 .== #t1 ! #col1)))))
327358in printSQL query
328359:}
329−SELECT "col1" AS "col1" FROM "tab" AS "t1" WHERE EXISTS (SELECT * FROM "tab" AS "t2" WHERE ("t2"."col2" = "t1"."col1"))
360+SELECT "col1" AS "fromOnly" FROM "tab" AS "t1" WHERE EXISTS (SELECT * FROM "tab" AS "t2" WHERE ("t2"."col2" = "t1"."col1"))
361+
330362-}
331−newtype Query
332− (outer :: FromType)
333− (commons :: FromType)
363+type family Query_
334364 (schemas :: SchemasType)
335− (params :: [NullityType])
336− (row :: RowType)
337− = UnsafeQuery { renderQuery :: ByteString }
338− deriving (GHC.Generic,Show,Eq,Ord,NFData)
339−instance RenderSQL (Query outer commons schemas params row) where renderSQL = renderQuery
340−
341−type family Query_ (schemas :: SchemasType) (params :: Type) (row :: Type) where
342− Query_ schemas params row = Query '[] '[] schemas (TuplePG params) (RowPG row)
365+ (parameters :: Type)
366+ (row :: Type) where
367+ Query_ schemas params row =
368+ Query '[] '[] schemas (TuplePG params) (RowPG row)
343369
344370-- | The results of two queries can be combined using the set operation
345371-- `union`. Duplicate rows are eliminated.
@@ -411,27 +437,40 @@ q1 `exceptAll` q2 = UnsafeQuery $
411437SELECT queries
412438-----------------------------------------}
413439
440+{- | The simplest kinds of `Selection` are `Star` and `DotStar` which
441+emits all columns that a `TableExpression` produces. A select `List`
442+is a list of `Expression`s. A `Selection` could be a list of
443+`WindowFunction`s `Over` `WindowDefinition`. `Additional` `Selection`s can
444+be selected with `Also`.
445+-}
414446data Selection outer commons grp schemas params from row where
415− List
416− :: SListI row
417− => NP (Aliased (Expression outer commons grp schemas params from)) row
418− -> Selection outer commons grp schemas params from row
419447 Star
420448 :: HasUnique tab from row
421449 => Selection outer commons 'Ungrouped schemas params from row
450+ -- ^ `HasUnique` table in the `FromClause`
422451 DotStar
423452 :: Has tab from row
424453 => Alias tab
454+ -- ^ `Has` table with `Alias`
425455 -> Selection outer commons 'Ungrouped schemas params from row
426− Also
427− :: Selection outer commons grp schemas params from right
428− -> Selection outer commons grp schemas params from left
429− -> Selection outer commons grp schemas params from (Join left right)
456+ List
457+ :: SListI row
458+ => NP (Aliased (Expression outer commons grp schemas params from)) row
459+ -- ^ `NP` list of `Aliased` `Expression`s
460+ -> Selection outer commons grp schemas params from row
430461 Over
431462 :: SListI row
432463 => NP (Aliased (WindowFunction outer commons grp schemas params from)) row
464+ -- ^ `NP` list of `Aliased` `WindowFunction`s
433465 -> WindowDefinition outer commons grp schemas params from
434466 -> Selection outer commons grp schemas params from row
467+ Also
468+ :: Selection outer commons grp schemas params from right
469+ -- ^ `Additional` `Selection`
470+ -> Selection outer commons grp schemas params from left
471+ -> Selection outer commons grp schemas params from (Join left right)
472+instance Additional (Selection outer commons grp schemas params from) where
473+ also = Also
435474instance (KnownSymbol col, row ~ '[col ::: ty])
436475 => Aliasable col
437476 (Expression outer commons grp schemas params from ty)
@@ -491,7 +530,7 @@ instance IsString
491530select
492531 :: (SListI row, row ~ (x ': xs))
493532 => Selection outer commons grp schemas params from row
494− -- ^ select list
533+ -- ^ selection
495534 -> TableExpression outer commons grp schemas params from
496535 -- ^ intermediate virtual table
497536 -> Query outer commons schemas params row
@@ -500,20 +539,24 @@ select selection tabexpr = UnsafeQuery $
500539 <+> renderSQL selection
501540 <+> renderSQL tabexpr
502541
542+-- | Like `select` but takes an `NP` list of `Expression`s instead
543+-- of a general `Selection`.
503544select_
504545 :: (SListI row, row ~ (x ': xs))
505546 => NP (Aliased (Expression outer commons grp schemas params from)) row
547+ -- ^ select list
506548 -> TableExpression outer commons grp schemas params from
549+ -- ^ intermediate virtual table
507550 -> Query outer commons schemas params row
508−select_ list = select (List list)
551+select_ = select . List
509552
510553-- | After the select list has been processed, the result table can
511554-- be subject to the elimination of duplicate rows using `selectDistinct`.
512555selectDistinct
513556 :: (SListI columns, columns ~ (col ': cols))
514− => Selection outer commons 'Ungrouped schemas params from columns
515− -- ^ select list
516− -> TableExpression outer commons 'Ungrouped schemas params from
557+ => Selection outer commons grp schemas params from columns
558+ -- ^ selection
559+ -> TableExpression outer commons grp schemas params from
517560 -- ^ intermediate virtual table
518561 -> Query outer commons schemas params columns
519562selectDistinct selection tabexpr = UnsafeQuery $
@@ -521,14 +564,65 @@ selectDistinct selection tabexpr = UnsafeQuery $
521564 <+> renderSQL selection
522565 <+> renderSQL tabexpr
523566
567+-- | Like `selectDistinct` but takes an `NP` list of `Expression`s instead
568+-- of a general `Selection`.
524569selectDistinct_
525570 :: (SListI columns, columns ~ (col ': cols))
526− => NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns
571+ => NP (Aliased (Expression outer commons grp schemas params from)) columns
527572 -- ^ select list
528− -> TableExpression outer commons 'Ungrouped schemas params from
573+ -> TableExpression outer commons grp schemas params from
529574 -- ^ intermediate virtual table
530575 -> Query outer commons schemas params columns
531−selectDistinct_ list = select (List list)
576+selectDistinct_ = selectDistinct . List
577+
578+{-|
579+`selectDistinctOn` keeps only the first row of each set of rows where
580+the given expressions evaluate to equal. The DISTINCT ON expressions are
581+interpreted using the same rules as for ORDER BY. ORDER BY is used to
582+ensure that the desired row appears first.
583+
584+The DISTINCT ON expression(s) must match the leftmost ORDER BY expression(s).
585+The ORDER BY clause will normally contain additional expression(s) that
586+determine the desired precedence of rows within each DISTINCT ON group.
587+
588+In order to guarantee they match and reduce redundancy, this function
589+will prepend the The DISTINCT ON expressions to the ORDER BY clause.
590+-}
591+selectDistinctOn
592+ :: (SListI columns, columns ~ (col ': cols))
593+ => [SortExpression outer commons grp schemas params from]
594+ -- ^ DISTINCT ON expression(s) and prepended to ORDER BY clause
595+ -> Selection outer commons grp schemas params from columns
596+ -- ^ selection
597+ -> TableExpression outer commons grp schemas params from
598+ -- ^ intermediate virtual table
599+ -> Query outer commons schemas params columns
600+selectDistinctOn distincts selection tab = UnsafeQuery $
601+ "SELECT DISTINCT ON"
602+ <+> parenthesized (commaSeparated (renderDistinctOn <$> distincts))
603+ <+> renderSQL selection
604+ <+> renderSQL (tab {orderByClause = distincts <> orderByClause tab})
605+ where
606+ renderDistinctOn = \case
607+ Asc expression -> renderSQL expression
608+ Desc expression -> renderSQL expression
609+ AscNullsFirst expression -> renderSQL expression
610+ DescNullsFirst expression -> renderSQL expression
611+ AscNullsLast expression -> renderSQL expression
612+ DescNullsLast expression -> renderSQL expression
613+
614+-- | Like `selectDistinctOn` but takes an `NP` list of `Expression`s instead
615+-- of a general `Selection`.
616+selectDistinctOn_
617+ :: (SListI columns, columns ~ (col ': cols))
618+ => [SortExpression outer commons grp schemas params from]
619+ -- ^ distinct on and return the first row in ordering
620+ -> NP (Aliased (Expression outer commons grp schemas params from)) columns
621+ -- ^ selection
622+ -> TableExpression outer commons grp schemas params from
623+ -- ^ intermediate virtual table
624+ -> Query outer commons schemas params columns
625+selectDistinctOn_ distincts = selectDistinctOn distincts . List
532626
533627-- | `values` computes a row value or set of row values
534628-- specified by value expressions. It is most commonly used
@@ -663,7 +757,7 @@ instance RenderSQL (TableExpression outer commons grp schemas params from) where
663757from
664758 :: FromClause outer commons schemas params from -- ^ table reference
665759 -> TableExpression outer commons 'Ungrouped schemas params from
666−from tab = TableExpression tab [] NoGroups NoHaving [] [] []
760+from tab = TableExpression tab [] noGroups NoHaving [] [] []
667761
668762-- | A `where_` is an endomorphism of `TableExpression`s which adds a
669763-- search condition to the `whereClause`.
@@ -684,7 +778,7 @@ groupBy
684778groupBy bys rels = TableExpression
685779 { fromClause = fromClause rels
686780 , whereClause = whereClause rels
687− , groupByClause = Group bys
781+ , groupByClause = group bys
688782 , havingClause = Having []
689783 , orderByClause = []
690784 , limitClause = limitClause rels
@@ -719,170 +813,6 @@ offset
719813 -> TableExpression outer commons grp schemas params from
720814offset off rels = rels {offsetClause = off : offsetClause rels}
721815
722−{-----------------------------------------
723−JSON stuff
724−-----------------------------------------}
725−
726−unsafeSetOfFunction
727− :: ByteString
728− -> Expression outer commons 'Ungrouped schemas params '[] ty
729− -> FromClause outer commons schemas params from
730−unsafeSetOfFunction fun expr = UnsafeFromClause $
731− fun <> "(" <> renderSQL expr <> ")"
732−
733−-- | Expand an array to a set of rows
734−unnest
735− :: Expression outer commons 'Ungrouped schemas params '[] (nullity ('PGvararray ty))
736− -> FromClause outer commons schemas params '["unnest" ::: '["unnest" ::: ty]]
737−unnest = unsafeSetOfFunction "unnest"
738−
739−-- | Expands the outermost JSON object into a set of key/value pairs.
740−-- >>> import Data.Aeson
741−-- >>> printSQL (select Star (from (jsonEach (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))
742−-- SELECT * FROM json_each(('{"a":"foo","b":"bar"}' :: json))
743−jsonEach
744− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object
745− -> FromClause outer commons schemas params
746− '["json_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]]
747−jsonEach = unsafeSetOfFunction "json_each"
748−
749−-- | Expands the outermost binary JSON object into a set of key/value pairs.
750−-- >>> import Data.Aeson
751−-- >>> printSQL (select Star (from (jsonbEach (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))
752−-- SELECT * FROM jsonb_each(('{"a":"foo","b":"bar"}' :: jsonb))
753−jsonbEach
754− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object
755− -> FromClause outer commons schemas params
756− '["jsonb_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]]
757−jsonbEach = unsafeSetOfFunction "jsonb_each"
758−
759−-- | Expands the outermost JSON object into a set of key/value pairs.-- | Expands the outermost binary JSON object into a set of key/value pairs.
760−-- >>> import Data.Aeson
761−-- >>> printSQL (select Star (from (jsonEachText (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))
762−-- SELECT * FROM json_each_text(('{"a":"foo","b":"bar"}' :: json))
763−jsonEachText
764− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object
765− -> FromClause outer commons schemas params
766− '["json_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]]
767−jsonEachText = unsafeSetOfFunction "json_each_text"
768−
769−-- | Expands the outermost binary JSON object into a set of key/value pairs.
770−-- >>> import Data.Aeson
771−-- >>> printSQL (select Star (from (jsonbEachText (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))
772−-- SELECT * FROM jsonb_each_text(('{"a":"foo","b":"bar"}' :: jsonb))
773−jsonbEachText
774− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object
775− -> FromClause outer commons schemas params
776− '["jsonb_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]]
777−jsonbEachText = unsafeSetOfFunction "jsonb_each_text"
778−
779−-- | Returns set of keys in the outermost JSON object.
780−-- >>> import Data.Aeson
781−-- >>> printSQL (jsonObjectKeys (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))
782−-- json_object_keys(('{"a":"foo","b":"bar"}' :: json))
783−jsonObjectKeys
784− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object
785− -> FromClause outer commons schemas params
786− '["json_object_keys" ::: '["json_object_keys" ::: 'NotNull 'PGtext]]
787−jsonObjectKeys = unsafeSetOfFunction "json_object_keys"
788−
789−-- | Returns set of keys in the outermost JSON object.
790−-- >>> import Data.Aeson
791−-- >>> printSQL (jsonbObjectKeys (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))
792−-- jsonb_object_keys(('{"a":"foo","b":"bar"}' :: jsonb))
793−jsonbObjectKeys
794− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object
795− -> FromClause outer commons schemas params
796− '["jsonb_object_keys" ::: '["jsonb_object_keys" ::: 'NotNull 'PGtext]]
797−jsonbObjectKeys = unsafeSetOfFunction "jsonb_object_keys"
798−
799−unsafePopulateFunction
800− :: KnownSymbol fun
801− => Alias fun
802− -> TypeExpression schemas (nullity ('PGcomposite row))
803− -> Expression outer commons 'Ungrouped schemas params '[] ty
804− -> FromClause outer commons schemas params '[fun ::: row]
805−unsafePopulateFunction fun ty expr = UnsafeFromClause $ renderSQL fun
806− <> parenthesized ("null::" <> renderSQL ty <> ", " <> renderSQL expr)
807−
808−-- | Expands the JSON expression to a row whose columns match the record
809−-- type defined by the given table.
810−jsonPopulateRecord
811− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type
812− -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object
813− -> FromClause outer commons schemas params '["json_populate_record" ::: row]
814−jsonPopulateRecord = unsafePopulateFunction #json_populate_record
815−
816−-- | Expands the binary JSON expression to a row whose columns match the record
817−-- type defined by the given table.
818−jsonbPopulateRecord
819− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type
820− -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object
821− -> FromClause outer commons schemas params '["jsonb_populate_record" ::: row]
822−jsonbPopulateRecord = unsafePopulateFunction #jsonb_populate_record
823−
824−-- | Expands the outermost array of objects in the given JSON expression to a
825−-- set of rows whose columns match the record type defined by the given table.
826−jsonPopulateRecordSet
827− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type
828− -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json array
829− -> FromClause outer commons schemas params '["json_populate_record_set" ::: row]
830−jsonPopulateRecordSet = unsafePopulateFunction #json_populate_record_set
831−
832−-- | Expands the outermost array of objects in the given binary JSON expression
833−-- to a set of rows whose columns match the record type defined by the given
834−-- table.
835−jsonbPopulateRecordSet
836− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type
837− -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb array
838− -> FromClause outer commons schemas params '["jsonb_populate_record_set" ::: row]
839−jsonbPopulateRecordSet = unsafePopulateFunction #jsonb_populate_record_set
840−
841−unsafeRecordFunction
842− :: (SListI record, json `In` PGJsonType)
843− => ByteString
844− -> Expression outer commons 'Ungrouped schemas params '[] (nullity json)
845− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)
846− -> FromClause outer commons schemas params '[tab ::: record]
847−unsafeRecordFunction fun expr (types `As` tab) = UnsafeFromClause $
848− fun <> parenthesized (renderSQL expr) <+> "AS" <+> renderSQL tab
849− <> parenthesized (renderCommaSeparated renderTy types)
850− where
851− renderTy :: Aliased (TypeExpression schemas) ty -> ByteString
852− renderTy (ty `As` alias) = renderSQL alias <+> renderSQL ty
853−
854−-- | Builds an arbitrary record from a JSON object.
855−jsonToRecord
856− :: SListI record
857− => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object
858− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)
859− -> FromClause outer commons schemas params '[tab ::: record]
860−jsonToRecord = unsafeRecordFunction "json_to_record"
861−
862−-- | Builds an arbitrary record from a binary JSON object.
863−jsonbToRecord
864− :: SListI record
865− => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object
866− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)
867− -> FromClause outer commons schemas params '[tab ::: record]
868−jsonbToRecord = unsafeRecordFunction "jsonb_to_record"
869−
870−-- | Builds an arbitrary set of records from a JSON array of objects.
871−jsonToRecordSet
872− :: SListI record
873− => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json array
874− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)
875− -> FromClause outer commons schemas params '[tab ::: record]
876−jsonToRecordSet = unsafeRecordFunction "json_to_record_set"
877−
878−-- | Builds an arbitrary set of records from a binary JSON array of objects.
879−jsonbToRecordSet
880− :: SListI record
881− => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb array
882− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)
883− -> FromClause outer commons schemas params '[tab ::: record]
884−jsonbToRecordSet = unsafeRecordFunction "jsonb_to_record_set"
885−
886816{-----------------------------------------
887817FROM clauses
888818-----------------------------------------}
@@ -909,7 +839,7 @@ table (tab `As` alias) = UnsafeFromClause $
909839subquery
910840 :: Aliased (Query outer commons schemas params) query
911841 -> FromClause outer commons schemas params '[query]
912−subquery = UnsafeFromClause . renderAliased (parenthesized . renderQuery)
842+subquery = UnsafeFromClause . renderAliased (parenthesized . renderSQL)
913843
914844-- | `view` derives a table from a `View`.
915845view
@@ -927,11 +857,16 @@ common
927857common (cte `As` alias) = UnsafeFromClause $
928858 renderSQL cte <+> "AS" <+> renderSQL alias
929859
930−{- | @left & crossJoin right@. For every possible combination of rows from
931− @left@ and @right@ (i.e., a Cartesian product), the joined table will contain
932− a row consisting of all columns in @left@ followed by all columns in @right@.
933− If the tables have @n@ and @m@ rows respectively, the joined table will
934− have @n * m@ rows.
860+instance Additional (FromClause outer commons schemas params) where
861+ also right left = UnsafeFromClause $
862+ renderSQL left <> ", " <> renderSQL right
863+
864+{- |
865+@left & crossJoin right@. For every possible combination of rows from
866+@left@ and @right@ (i.e., a Cartesian product), the joined table will contain
867+a row consisting of all columns in @left@ followed by all columns in @right@.
868+If the tables have @n@ and @m@ rows respectively, the joined table will
869+have @n * m@ rows.
935870-}
936871crossJoin
937872 :: FromClause outer commons schemas params right
@@ -1057,19 +992,20 @@ instance (Has rel rels cols, Has col cols ty, bys ~ '[ '(rel, col)])
1057992-- done on @NoGroups@ while all output `Expression`s must be aggregated
1058993-- in @Group Nil@. In general, all output `Expression`s in the
1059994-- complement of @bys@ must be aggregated in @Group bys@.
1060−data GroupByClause grp from where
1061− NoGroups :: GroupByClause 'Ungrouped from
1062− Group
1063− :: SListI bys
1064− => NP (By from) bys
1065− -> GroupByClause ('Grouped bys) from
1066−
1067−-- | Renders a `GroupByClause`.
995+newtype GroupByClause grp from = UnsafeGroupByClause
996+ { renderGroupByClause :: ByteString }
997+ deriving (GHC.Generic,Show,Eq,Ord,NFData)
1068998instance RenderSQL (GroupByClause grp from) where
1069− renderSQL = \case
1070− NoGroups -> ""
1071− Group Nil -> ""
1072− Group bys -> " GROUP BY" <+> renderCommaSeparated renderSQL bys
999+ renderSQL = renderGroupByClause
1000+noGroups :: GroupByClause 'Ungrouped from
1001+noGroups = UnsafeGroupByClause ""
1002+group
1003+ :: SListI bys
1004+ => NP (By from) bys
1005+ -> GroupByClause ('Grouped bys) from
1006+group bys = UnsafeGroupByClause $ case bys of
1007+ Nil -> ""
1008+ bys' -> " GROUP BY" <+> renderCommaSeparated renderSQL bys'
10731009
10741010-- | A `HavingClause` is used to eliminate groups that are not of interest.
10751011-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`
@@ -1092,90 +1028,6 @@ instance RenderSQL (HavingClause outer commons grp schemas params from) where
10921028 Having conditions ->
10931029 " HAVING" <+> commaSeparated (renderSQL <$> conditions)
10941030
1095−{- |
1096−The argument of `exists` is an arbitrary subquery. The subquery is evaluated
1097−to determine whether it returns any rows. If it returns at least one row,
1098−the result of `exists` is `true`; if the subquery returns no rows,
1099−the result of `exists` is `false`.
1100−
1101−The subquery can refer to variables from the surrounding query,
1102−which will act as constants during any one evaluation of the subquery.
1103−
1104−The subquery will generally only be executed long enough to determine whether
1105−at least one row is returned, not all the way to completion.
1106−-}
1107−exists
1108− :: Query (Join outer from) commons schemas params row
1109− -> Condition outer commons grp schemas params from
1110−exists query = UnsafeExpression $ "EXISTS" <+> parenthesized (renderSQL query)
1111−
1112−{- |
1113−The right-hand side is a parenthesized subquery, which must return
1114−exactly one column. The left-hand expression is evaluated and compared to each
1115−row of the subquery result using the given `Operator`,
1116−which must yield a Boolean result. The result of `subAll` is `true`
1117−if all rows yield true (including the case where the subquery returns no rows).
1118−The result is `false` if any `false` result is found.
1119−The result is `null_` if no comparison with a subquery row returns `false`,
1120−and at least one comparison returns `null_`.
1121−
1122−>>> printSQL $ subAll true (.==) (values_ (true `as` #foo))
1123−(TRUE = ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo")))
1124−-}
1125−subAll
1126− :: Expression outer commons grp schemas params from ty1 -- ^ expression
1127− -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator
1128− -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery
1129− -> Condition outer commons grp schemas params from
1130−subAll expr (?) qry = expr ?
1131− (UnsafeExpression $ "ALL" <+> parenthesized (renderSQL qry))
1132−
1133−{- |
1134−The right-hand side is a parenthesized subquery, which must return exactly one column.
1135−The left-hand expression is evaluated and compared to each row of the subquery result
1136−using the given `Operator`, which must yield a Boolean result. The result of `subAny` is `true`
1137−if any `true` result is obtained. The result is `false` if no true result is found
1138−(including the case where the subquery returns no rows).
1139−
1140−>>> printSQL $ subAll "foo" like (values_ ("foobar" `as` #foo))
1141−(E'foo' LIKE ALL (SELECT * FROM (VALUES (E'foobar')) AS t ("foo")))
1142−-}
1143−subAny
1144− :: Expression outer commons grp schemas params from ty1 -- ^ expression
1145− -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator
1146− -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery
1147− -> Condition outer commons grp schemas params from
1148−subAny expr (?) qry = expr ?
1149− (UnsafeExpression $ "ANY" <+> parenthesized (renderSQL qry))
1150−
1151−{- |
1152−The result is `true` if the left-hand expression's result is equal
1153−to any of the right-hand expressions.
1154−
1155−>>> printSQL $ true `in_` [true, false, null_]
1156−TRUE IN (TRUE, FALSE, NULL)
1157−-}
1158−in_
1159− :: Expression outer commons grp schemas params from ty -- ^ expression
1160− -> [Expression outer commons grp schemas params from ty]
1161− -> Condition outer commons grp schemas params from
1162−expr `in_` exprs = UnsafeExpression $ renderSQL expr <+> "IN"
1163− <+> parenthesized (commaSeparated (renderSQL <$> exprs))
1164−
1165−{- |
1166−The result is `true` if the left-hand expression's result is not equal
1167−to any of the right-hand expressions.
1168−
1169−>>> printSQL $ true `notIn` [false, null_]
1170−TRUE NOT IN (FALSE, NULL)
1171−-}
1172−notIn
1173− :: Expression outer commons grp schemas params from ty -- ^ expression
1174− -> [Expression outer commons grp schemas params from ty]
1175− -> Condition outer commons grp schemas params from
1176−expr `notIn` exprs = UnsafeExpression $ renderSQL expr <+> "NOT IN"
1177− <+> parenthesized (commaSeparated (renderSQL <$> exprs))
1178−
11791031-- | A `CommonTableExpression` is an auxiliary statement in a `with` clause.
11801032data CommonTableExpression statement
11811033 (schemas :: SchemasType)
@@ -1197,8 +1049,8 @@ instance
11971049 , commons1 ~ (cte ::: common ': commons)
11981050 ) => Aliasable cte
11991051 (statement commons schemas params common)
1200− (AlignedList (CommonTableExpression statement schemas params) commons commons1) where
1201− statement `as` cte = single (statement `as` cte)
1052+ (Path (CommonTableExpression statement schemas params) commons commons1) where
1053+ statement `as` cte = csingleton (statement `as` cte)
12021054
12031055instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL
12041056 (CommonTableExpression statement schemas params commons0 commons1) where
@@ -1210,7 +1062,7 @@ instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL
12101062-- defining temporary tables that exist just for one query.
12111063class With statement where
12121064 with
1213− :: AlignedList (CommonTableExpression statement schemas params) commons0 commons1
1065+ :: Path (CommonTableExpression statement schemas params) commons0 commons1
12141066 -- ^ common table expressions
12151067 -> statement commons1 schemas params row
12161068 -- ^ larger query
@@ -1218,4 +1070,29 @@ class With statement where
12181070instance With (Query outer) where
12191071 with Done query = query
12201072 with ctes query = UnsafeQuery $
1221− "WITH" <+> renderSQL ctes <+> renderSQL query
1073+ "WITH" <+> commaSeparated (ctoList renderSQL ctes) <+> renderSQL query
1074+
1075+{- |
1076+>>> import Data.Monoid (Sum (..))
1077+>>> import Data.Int (Int64)
1078+>>> :{
1079+ let
1080+ query :: Query_ schema () (Sum Int64)
1081+ query = withRecursive
1082+ ( values_ ((1 & astype int) `as` #n)
1083+ `unionAll`
1084+ select_ ((#n + 1) `as` #n)
1085+ (from (common #t) & where_ (#n .< 100)) `as` #t )
1086+ ( select_ (fromNull 0 (sum_ (All #n)) `as` #getSum) (from (common #t) & groupBy Nil))
1087+ in printSQL query
1088+:}
1089+WITH RECURSIVE "t" AS ((SELECT * FROM (VALUES ((1 :: int))) AS t ("n")) UNION ALL (SELECT ("n" + 1) AS "n" FROM "t" AS "t" WHERE ("n" < 100))) SELECT COALESCE(sum(ALL "n"), 0) AS "getSum" FROM "t" AS "t"
1090+-}
1091+withRecursive
1092+ :: Aliased (Query outer (recursive ': commons) schemas params) recursive
1093+ -> Query outer (recursive ': commons) schemas params row
1094+ -> Query outer commons schemas params row
1095+withRecursive (recursive `As` cte) query = UnsafeQuery $
1096+ "WITH RECURSIVE" <+> renderSQL cte
1097+ <+> "AS" <+> parenthesized (renderSQL recursive)
1098+ <+> renderSQL query
squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+164−62
@@ -1,11 +1,11 @@
11{-|
22Module: Squeal.PostgreSQL.Schema
33Description: Embedding of PostgreSQL type and alias system
4−Copyright: (c) Eitan Chatav, 2017
4+Copyright: (c) Eitan Chatav, 2019
55Maintainer: eitan@morphism.tech
66Stability: experimental
77
8−This module provides a type-level DSL for kinds of Postgres types,
8+`Squeal.PostgreSQL.Schema` provides a type-level DSL for kinds of Postgres types,
99tables, schema, constraints, aliases, enumerated labels, and groupings.
1010It also defines useful type families to operate on these. Finally,
1111it defines an embedding of Haskell types into Postgres types.
@@ -44,6 +44,10 @@ module Squeal.PostgreSQL.Schema
4444 , ColumnsType
4545 , TableType
4646 , SchemumType (..)
47+ , IndexType (..)
48+ , FunctionType
49+ , OperatorType (..)
50+ , ReturnsType (..)
4751 , SchemaType
4852 , SchemasType
4953 , Public
@@ -58,15 +62,21 @@ module Squeal.PostgreSQL.Schema
5862 , PGlabel (..)
5963 -- * Data Definitions
6064 , Create
65+ , CreateIfNotExists
66+ , CreateOrReplace
6167 , Drop
68+ , DropSchemum
69+ , DropIfExists
70+ , DropSchemumIfExists
6271 , Alter
72+ , AlterIfExists
6373 , Rename
74+ , RenameIfExists
6475 , ConstraintInvolves
6576 , DropIfConstraintsInvolve
6677 , IsNotElem
6778 , AllUnique
6879 -- * Type Classifications
69− , HasOid (..)
7080 , PGNum
7181 , PGIntegral
7282 , PGFloating
@@ -90,17 +100,19 @@ import Control.Category
90100import Data.Kind
91101import Data.Monoid hiding (All)
92102import Data.Type.Bool
93−import Data.Word (Word32)
94103import Generics.SOP
95104import GHC.TypeLits
96105import Prelude hiding (id, (.))
97106
98107import Squeal.PostgreSQL.Alias
108+import Squeal.PostgreSQL.List
99109import Squeal.PostgreSQL.Render
100110
111+-- $setup
112+-- >>> import Squeal.PostgreSQL
113+
101114-- | `PGType` is the promoted datakind of PostgreSQL types.
102115--
103−-- >>> import Squeal.PostgreSQL.Schema
104116-- >>> :kind 'PGbool
105117-- 'PGbool :: PGType
106118data PGType
@@ -131,37 +143,11 @@ data PGType
131143 | PGenum [Symbol] -- ^ enumerated (enum) types are data types that comprise a static, ordered set of values.
132144 | PGcomposite RowType -- ^ a composite type represents the structure of a row or record; it is essentially just a list of field names and their data types.
133145 | PGtsvector -- ^ A tsvector value is a sorted list of distinct lexemes, which are words that have been normalized to merge different variants of the same word.
134− | PGtsquery -- ^ A tsquery value stores lexemes that are to be searched for
146+ | PGtsquery -- ^ A tsquery value stores lexemes that are to be searched for.
147+ | PGoid -- Object identifiers (OIDs) are used internally by PostgreSQL as primary keys for various system tables.
148+ | PGrange PGType -- ^ Range types are data types representing a range of values of some element type (called the range's subtype).
135149 | UnsafePGType Symbol -- ^ an escape hatch for unsupported PostgreSQL types
136150
137−-- | The object identifier of a `PGType`.
138−--
139−-- >>> :set -XTypeApplications
140−-- >>> oid @'PGbool
141−-- 16
142−class HasOid (ty :: PGType) where oid :: Word32
143−instance HasOid 'PGbool where oid = 16
144−instance HasOid 'PGint2 where oid = 21
145−instance HasOid 'PGint4 where oid = 23
146−instance HasOid 'PGint8 where oid = 20
147−instance HasOid 'PGnumeric where oid = 1700
148−instance HasOid 'PGfloat4 where oid = 700
149−instance HasOid 'PGfloat8 where oid = 701
150−instance HasOid ('PGchar n) where oid = 18
151−instance HasOid ('PGvarchar n) where oid = 1043
152−instance HasOid 'PGtext where oid = 25
153−instance HasOid 'PGbytea where oid = 17
154−instance HasOid 'PGtimestamp where oid = 1114
155−instance HasOid 'PGtimestamptz where oid = 1184
156−instance HasOid 'PGdate where oid = 1082
157−instance HasOid 'PGtime where oid = 1083
158−instance HasOid 'PGtimetz where oid = 1266
159−instance HasOid 'PGinterval where oid = 1186
160−instance HasOid 'PGuuid where oid = 2950
161−instance HasOid 'PGinet where oid = 869
162−instance HasOid 'PGjson where oid = 114
163−instance HasOid 'PGjsonb where oid = 3802
164−
165151-- | `NullityType` encodes the potential presence or definite absence of a
166152-- @NULL@ allowing operations which are sensitive to such to be well typed.
167153--
@@ -274,9 +260,19 @@ type FromType = [(Symbol,RowType)]
274260
275261-- | `ColumnsToRow` removes column constraints.
276262type family ColumnsToRow (columns :: ColumnsType) :: RowType where
277− ColumnsToRow '[] = '[]
278− ColumnsToRow (column ::: constraint :=> ty ': columns) =
263+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': column4 ::: _ :=> ty4 ': column5 ::: _ :=> ty5 ': columns) =
264+ column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': column5 ::: ty5 ': ColumnsToRow columns
265+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': column4 ::: _ :=> ty4 ': columns) =
266+ column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': ColumnsToRow columns
267+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': columns) =
268+ column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': ColumnsToRow columns
269+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': columns) =
270+ column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': ColumnsToRow columns
271+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': columns) =
272+ column ::: ty ': column1 ::: ty1 ': ColumnsToRow columns
273+ ColumnsToRow (column ::: _ :=> ty ': columns) =
279274 column ::: ty ': ColumnsToRow columns
275+ ColumnsToRow '[] = '[]
280276
281277-- | `TableToColumns` removes table constraints.
282278type family TableToColumns (table :: TableType) :: ColumnsType where
@@ -286,15 +282,6 @@ type family TableToColumns (table :: TableType) :: ColumnsType where
286282type family TableToRow (table :: TableType) :: RowType where
287283 TableToRow tab = ColumnsToRow (TableToColumns tab)
288284
289−-- | @Elem@ is a promoted `Data.List.elem`.
290−type family Elem x xs where
291− Elem x '[] = 'False
292− Elem x (x ': xs) = 'True
293− Elem x (_ ': xs) = Elem x xs
294−
295−-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.
296−type family In x xs :: Constraint where In x xs = Elem x xs ~ 'True
297−
298285-- | Numeric Postgres types.
299286type PGNum =
300287 '[ 'PGint2, 'PGint4, 'PGint8, 'PGnumeric, 'PGfloat4, 'PGfloat8]
@@ -318,14 +305,24 @@ instance ty0 ~ ty1 => SamePGType
318305
319306-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.
320307type family AllNotNull (columns :: ColumnsType) :: Constraint where
308+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns
309+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns
310+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns
311+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns
312+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns
313+ AllNotNull (_ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns
321314 AllNotNull '[] = ()
322− AllNotNull (column ::: def :=> 'NotNull ty ': columns) = AllNotNull columns
323315
324316-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some
325317-- @NOT NULL@.
326318type family NotAllNull (columns :: ColumnsType) :: Constraint where
327− NotAllNull (column ::: def :=> 'NotNull ty ': columns) = ()
328− NotAllNull (column ::: def :=> 'Null ty ': columns) = NotAllNull columns
319+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()
320+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()
321+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()
322+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()
323+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()
324+ NotAllNull (_ ::: _ :=> 'NotNull _ ': _) = ()
325+ NotAllNull (_ ::: _ :=> 'Null _ ': columns) = NotAllNull columns
329326
330327-- | `NullifyType` is an idempotent that nullifies a `NullityType`.
331328type family NullifyType (ty :: NullityType) :: NullityType where
@@ -334,17 +331,37 @@ type family NullifyType (ty :: NullityType) :: NullityType where
334331
335332-- | `NullifyRow` is an idempotent that nullifies a `RowType`.
336333type family NullifyRow (columns :: RowType) :: RowType where
337− NullifyRow '[] = '[]
334+ NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': column5 ::: ty5 ': columns) =
335+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': column4 ::: NullifyType ty4 ': column5 ::: NullifyType ty5 ': NullifyRow columns
336+ NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': columns) =
337+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': column4 ::: NullifyType ty4 ': NullifyRow columns
338+ NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': columns) =
339+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': NullifyRow columns
340+ NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': columns) =
341+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': NullifyRow columns
342+ NullifyRow (column ::: ty ': column1 ::: ty1 ': columns) =
343+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': NullifyRow columns
338344 NullifyRow (column ::: ty ': columns) =
339345 column ::: NullifyType ty ': NullifyRow columns
346+ NullifyRow '[] = '[]
340347
341348-- | `NullifyFrom` is an idempotent that nullifies a `FromType`
342349-- used to nullify the left or right hand side of an outer join
343350-- in a `Squeal.PostgreSQL.Query.FromClause`.
344351type family NullifyFrom (tables :: FromType) :: FromType where
345− NullifyFrom '[] = '[]
352+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': table4 ::: columns4 ': table5 ::: columns5 ': tables) =
353+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': table4 ::: NullifyRow columns5 ': table5 ::: NullifyRow columns4 ': NullifyFrom tables
354+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': table4 ::: columns4 ': tables) =
355+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': table4 ::: NullifyRow columns4 ': NullifyFrom tables
356+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': tables) =
357+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': NullifyFrom tables
358+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': tables) =
359+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': NullifyFrom tables
360+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': tables) =
361+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': NullifyFrom tables
346362 NullifyFrom (table ::: columns ': tables) =
347363 table ::: NullifyRow columns ': NullifyFrom tables
364+ NullifyFrom '[] = '[]
348365
349366-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in
350367-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@
@@ -354,30 +371,101 @@ type family Create alias x xs where
354371 Create alias x (alias ::: y ': xs) = TypeError
355372 ('Text "Create: alias "
356373 ':<>: 'ShowType alias
357− ':<>: 'Text "already in use")
374+ ':<>: 'Text "already exists")
358375 Create alias y (x ': xs) = x ': Create alias y xs
359376
377+type family CreateIfNotExists alias x xs where
378+ CreateIfNotExists alias x '[] = '[alias ::: x]
379+ CreateIfNotExists alias x (alias ::: y ': xs) = alias ::: y ': xs
380+ CreateIfNotExists alias y (x ': xs) = x ': CreateIfNotExists alias y xs
381+
382+type family CreateOrReplace alias x xs where
383+ CreateOrReplace alias x '[] = '[alias ::: x]
384+ CreateOrReplace alias x (alias ::: x ': xs) = alias ::: x ': xs
385+ CreateOrReplace alias x (alias ::: y ': xs) = TypeError
386+ ('Text "CreateOrReplace: expected type "
387+ ':<>: 'ShowType x
388+ ':<>: 'Text " but alias "
389+ ':<>: 'ShowType alias
390+ ':<>: 'Text " has type "
391+ ':<>: 'ShowType y)
392+ CreateOrReplace alias y (x ': xs) = x ': CreateOrReplace alias y xs
393+
360394-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@
361395-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements
362396-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.
363397type family Drop alias xs where
364− Drop alias ((alias ::: x) ': xs) = xs
398+ Drop alias '[] = TypeError
399+ ('Text "Drop: alias "
400+ ':<>: 'ShowType alias
401+ ':<>: 'Text " does not exist" )
402+ Drop alias (alias ::: x ': xs) = xs
365403 Drop alias (x ': xs) = x ': Drop alias xs
366404
405+type family DropSchemum alias sch xs where
406+ DropSchemum alias sch '[] = TypeError
407+ ('Text "DropSchemum: alias "
408+ ':<>: 'ShowType alias
409+ ':<>: 'Text " does not exist" )
410+ DropSchemum alias sch (alias ::: sch x ': xs) = xs
411+ DropSchemum alias sch0 (alias ::: sch1 x ': xs) = TypeError
412+ ('Text "DropSchemum: expected schemum "
413+ ':<>: 'ShowType sch0
414+ ':<>: 'Text " but alias "
415+ ':<>: 'ShowType alias
416+ ':<>: 'Text " has schemum "
417+ ':<>: 'ShowType sch1)
418+ DropSchemum alias sch (x ': xs) = x ': DropSchemum alias sch xs
419+
420+type family DropIfExists alias xs where
421+ DropIfExists alias '[] = '[]
422+ DropIfExists alias (alias ::: x ': xs) = xs
423+ DropIfExists alias (x ': xs) = x ': DropIfExists alias xs
424+
425+type family DropSchemumIfExists alias sch xs where
426+ DropSchemumIfExists alias sch '[] = '[]
427+ DropSchemumIfExists alias sch (alias ::: sch x ': xs) = xs
428+ DropSchemumIfExists alias sch0 (alias ::: sch1 x ': xs) = TypeError
429+ ('Text "DropSchemumIfExists: expected schemum "
430+ ':<>: 'ShowType sch1
431+ ':<>: 'Text " but alias "
432+ ':<>: 'ShowType alias
433+ ':<>: 'Text " has schemum "
434+ ':<>: 'ShowType sch0)
435+ DropSchemumIfExists alias sch (x ': xs) = x ': DropSchemumIfExists alias sch xs
436+
367437-- | @Alter alias x xs@ replaces the type associated with an @alias@ in @xs@
368438-- with the type @x@ and is used in `Squeal.PostgreSQL.Definition.alterTable`
369439-- and `Squeal.PostgreSQL.Definition.alterColumn`.
370440type family Alter alias x xs where
441+ Alter alias x '[] = TypeError
442+ ('Text "Alter: alias "
443+ ':<>: 'ShowType alias
444+ ':<>: 'Text " does not exist" )
371445 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs
372446 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs
373447
448+type family AlterIfExists alias x xs where
449+ AlterIfExists alias x '[] = '[]
450+ AlterIfExists alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs
451+ AlterIfExists alias x1 (x0 ': xs) = x0 ': AlterIfExists alias x1 xs
452+
374453-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@
375454-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and
376455-- `Squeal.PostgreSQL.Definition.renameColumn`.
377456type family Rename alias0 alias1 xs where
457+ Rename alias0 alias1 '[] = TypeError
458+ ('Text "Rename: alias "
459+ ':<>: 'ShowType alias0
460+ ':<>: 'Text " does not exist" )
378461 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs
379462 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs
380463
464+type family RenameIfExists alias0 alias1 xs where
465+ RenameIfExists alias x '[] = '[]
466+ RenameIfExists alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs
467+ RenameIfExists alias0 alias1 (x ': xs) = x ': RenameIfExists alias0 alias1 xs
468+
381469-- | Check if a `TableConstraint` involves a column
382470type family ConstraintInvolves column constraint where
383471 ConstraintInvolves column ('Check columns) = column `Elem` columns
@@ -394,22 +482,35 @@ type family DropIfConstraintsInvolve column constraints where
394482 (DropIfConstraintsInvolve column constraints)
395483 (alias ::: constraint ': DropIfConstraintsInvolve column constraints)
396484
397−{- | Calculate the `Length` of a type level list
398−
399−>>> :kind! Length '[Char,String,Bool,Double]
400−Length '[Char,String,Bool,Double] :: Nat
401−= 4
402−-}
403−type family Length (xs :: [k]) :: Nat where
404− Length (x : xs) = 1 + Length xs
405− Length '[] = 0
406−
407485-- | A `SchemumType` is a user-defined type, either a `Table`,
408486-- `View` or `Typedef`.
409487data SchemumType
410488 = Table TableType
411489 | View RowType
412490 | Typedef PGType
491+ | Index IndexType
492+ | Function FunctionType
493+ | Operator OperatorType
494+ | UnsafeSchemum Symbol
495+
496+type FunctionType = ([NullityType], ReturnsType)
497+
498+data IndexType
499+ = Btree
500+ | Hash
501+ | Gist
502+ | Spgist
503+ | Gin
504+ | Brin
505+
506+data ReturnsType
507+ = Returns NullityType
508+ | ReturnsTable RowType
509+
510+data OperatorType
511+ = BinaryOp NullityType NullityType NullityType
512+ | LeftOp NullityType NullityType
513+ | RightOp NullityType NullityType
413514
414515{- | The schema of a database consists of a list of aliased,
415516user-defined `SchemumType`s.
@@ -452,6 +553,7 @@ There are several reasons why one might want to use schemas:
452553-}
453554type SchemasType = [(Symbol,SchemaType)]
454555
556+-- | A type family to use for a single schema database.
455557type family Public (schema :: SchemaType) :: SchemasType
456558 where Public schema = '["public" ::: schema]
457559
squeal-postgresql/src/Squeal/PostgreSQL/Transaction.hs+76−44
@@ -1,7 +1,7 @@
11{-|
22Module: Squeal.PostgreSQL.Transaction
33Description: Squeal transaction control language
4−Copyright: (c) Eitan Chatav, 2017
4+Copyright: (c) Eitan Chatav, 2019
55Maintainer: eitan@morphism.tech
66Stability: experimental
77
@@ -20,11 +20,12 @@ module Squeal.PostgreSQL.Transaction
2020 ( -- * Transaction
2121 transactionally
2222 , transactionally_
23+ , transactionallyRetry
24+ , ephemerally
25+ , ephemerally_
2326 , begin
2427 , commit
2528 , rollback
26− , transactionallySchema
27− , transactionallySchema_
2829 -- * Transaction Mode
2930 , TransactionMode (..)
3031 , defaultMode
@@ -34,68 +35,99 @@ module Squeal.PostgreSQL.Transaction
3435 , DeferrableMode (..)
3536 ) where
3637
37−import Generics.SOP
38−import UnliftIO (MonadUnliftIO, liftIO, mask, onException)
39−
40−import qualified Database.PostgreSQL.LibPQ as LibPQ
38+import UnliftIO
4139
4240import Squeal.PostgreSQL.Manipulation
4341import Squeal.PostgreSQL.Render
4442import Squeal.PostgreSQL.PQ
45−import Squeal.PostgreSQL.Schema
4643
47−-- | Run a schema invariant computation `transactionally`.
44+{- | Run a computation `transactionally`;
45+first `begin`,
46+then run the computation,
47+`onException` `rollback` and rethrow the exception,
48+otherwise `commit` and `return` the result.
49+-}
4850transactionally
4951 :: (MonadUnliftIO tx, MonadPQ schemas tx)
5052 => TransactionMode
5153 -> tx x -- ^ run inside a transaction
5254 -> tx x
5355transactionally mode tx = mask $ \restore -> do
54− _ <- begin mode
55− result <- restore tx `onException` rollback
56− _ <- commit
56+ manipulate_ $ begin mode
57+ result <- restore tx `onException` (manipulate_ rollback)
58+ manipulate_ commit
5759 return result
5860
59−-- | Run a schema invariant computation `transactionally_` in `defaultMode`.
61+-- | Run a computation `transactionally_`, in `defaultMode`.
6062transactionally_
6163 :: (MonadUnliftIO tx, MonadPQ schemas tx)
6264 => tx x -- ^ run inside a transaction
6365 -> tx x
6466transactionally_ = transactionally defaultMode
6567
66−-- | @BEGIN@ a transaction.
67−begin :: MonadPQ schemas tx => TransactionMode -> tx (K Result ('[] :: RowType))
68−begin mode = manipulate . UnsafeManipulation $
69− "BEGIN" <+> renderSQL mode <> ";"
68+{- |
69+`transactionallyRetry` a computation;
7070
71−-- | @COMMIT@ a schema invariant transaction.
72−commit :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))
73−commit = manipulate $ UnsafeManipulation "COMMIT;"
71+* first `begin`,
72+* then `try` the computation,
73+ - if it raises a serialization failure then `rollback` and restart the transaction,
74+ - if it raises any other exception then `rollback` and rethrow the exception,
75+ - otherwise `commit` and `return` the result.
76+-}
77+transactionallyRetry
78+ :: (MonadUnliftIO tx, MonadPQ schemas tx)
79+ => TransactionMode
80+ -> tx x -- ^ run inside a transaction
81+ -> tx x
82+transactionallyRetry mode tx = mask $ \restore ->
83+ loop . try $ do
84+ x <- restore tx
85+ manipulate_ commit
86+ return x
87+ where
88+ loop attempt = do
89+ manipulate_ $ begin mode
90+ attempt >>= \case
91+ Left (PQException (PQState _ (Just "40001") _)) -> do
92+ manipulate_ rollback
93+ loop attempt
94+ Left err -> do
95+ manipulate_ rollback
96+ throwIO err
97+ Right x -> return x
98+
99+{- | Run a computation `ephemerally`;
100+Like `transactionally` but always `rollback`, useful in testing.
101+-}
102+ephemerally
103+ :: (MonadUnliftIO tx, MonadPQ schemas tx)
104+ => TransactionMode
105+ -> tx x -- ^ run inside an ephemeral transaction
106+ -> tx x
107+ephemerally mode tx = mask $ \restore -> do
108+ manipulate_ $ begin mode
109+ result <- restore tx `onException` (manipulate_ rollback)
110+ manipulate_ rollback
111+ return result
74112
75−-- | @ROLLBACK@ a schema invariant transaction.
76−rollback :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))
77−rollback = manipulate $ UnsafeManipulation "ROLLBACK;"
113+{- | Run a computation `ephemerally` in `defaultMode`. -}
114+ephemerally_
115+ :: (MonadUnliftIO tx, MonadPQ schemas tx)
116+ => tx x -- ^ run inside an ephemeral transaction
117+ -> tx x
118+ephemerally_ = ephemerally defaultMode
78119
79−-- | Run a schema changing computation `transactionallySchema`.
80−transactionallySchema
81− :: MonadUnliftIO io
82− => TransactionMode
83− -> PQ schemas0 schemas1 io x
84− -> PQ schemas0 schemas1 io x
85−transactionallySchema mode u = PQ $ \ conn -> mask $ \ restore -> do
86− _ <- liftIO . LibPQ.exec (unK conn) $
87− "BEGIN" <+> renderSQL mode <> ";"
88− x <- restore (unPQ u conn)
89− `onException` (liftIO (LibPQ.exec (unK conn) "ROLLBACK"))
90− _ <- liftIO $ LibPQ.exec (unK conn) "COMMIT"
91− return x
92−
93−-- | Run a schema changing computation `transactionallySchema_` in `defaultMode`.
94−transactionallySchema_
95− :: MonadUnliftIO io
96− => PQ schemas0 schemas1 io x
97− -> PQ schemas0 schemas1 io x
98−transactionallySchema_ = transactionallySchema defaultMode
120+-- | @BEGIN@ a transaction.
121+begin :: TransactionMode -> Manipulation_ schemas () ()
122+begin mode = UnsafeManipulation $ "BEGIN" <+> renderSQL mode
123+
124+-- | @COMMIT@ a transaction.
125+commit :: Manipulation_ schemas () ()
126+commit = UnsafeManipulation "COMMIT"
127+
128+-- | @ROLLBACK@ a transaction.
129+rollback :: Manipulation_ schemas () ()
130+rollback = UnsafeManipulation "ROLLBACK"
99131
100132-- | The available transaction characteristics are the transaction `IsolationLevel`,
101133-- the transaction `AccessMode` (`ReadWrite` or `ReadOnly`), and the `DeferrableMode`.
@@ -108,7 +140,7 @@ data TransactionMode = TransactionMode
108140-- | `TransactionMode` with a `Serializable` `IsolationLevel`,
109141-- `ReadWrite` `AccessMode` and `NotDeferrable` `DeferrableMode`.
110142defaultMode :: TransactionMode
111−defaultMode = TransactionMode Serializable ReadWrite NotDeferrable
143+defaultMode = TransactionMode ReadCommitted ReadWrite NotDeferrable
112144
113145-- | `TransactionMode` with a `Serializable` `IsolationLevel`,
114146-- `ReadOnly` `AccessMode` and `Deferrable` `DeferrableMode`.
squeal-postgresql/src/Squeal/PostgreSQL/Tutorial.hsdeleted−39
@@ -1,39 +0,0 @@
1−{-|
2−Module: Squeal.PostgreSQL.Tutorail
3−Description: Squeal tutorial module
4−Copyright: (c) Eitan Chatav, 2017
5−Maintainer: eitan@morphism.tech
6−Stability: experimental
7−
8−== `P` records
9−
10−A `P` record is an ad-hoc, anonymous record constructed
11−as a tuple of `P`s, a datatype from `Generics.SOP.Record`, like so:
12−
13−>>> type Rec = (P ("foo" ::: Double), P ("bar" ::: Char))
14−
15−Let's see what the image of `Rec` is under the `RowPG` type family.
16−
17−>>> :kind! RowPG Rec
18−RowPG Rec :: [(Symbol, NullityType)]
19−= '[ '("foo", 'NotNull 'PGfloat8), "bar" ::: 'NotNull ('PGchar 1)]
20−
21−`P` records are ad-hoc, anonymous records so unlike Haskell records
22−you don't have to define them outside of their use site, for instance
23−in the row type parameter of a `Query_` type family.
24−
25−>>> :{
26−let
27− query :: Query_ schemas () (P ("foo" ::: Double))
28− query = values_ (1 `as` #foo)
29−in printSQL query
30−:}
31−SELECT * FROM (VALUES (1)) AS t ("foo")
32−
33−You can even mix `P` records with normal Haskell records, which is very
34−useful for creating entity types, Haskell records with associated ids.
35−
36−>>> data Row = Row {foo :: Double, bar :: Char} deriving (GHC.Generic)
37−-}
38−
39−module Squeal.PostgreSQL.Tutorial where
squeal-postgresql/test/Doc.hsnew file+6
@@ -0,0 +1,6 @@
1+module Main (main) where
2+
3+import Test.DocTest
4+
5+main :: IO ()
6+main = doctest [ "-isrc", "src" ]
squeal-postgresql/test/DocTest.hsdeleted−18
@@ -1,18 +0,0 @@
1−module Main (main) where
2−
3−import Test.DocTest
4−
5−main :: IO ()
6−main = doctest
7− [ "-isrc"
8− , "src/Squeal/PostgreSQL.hs"
9− , "src/Squeal/PostgreSQL/Binary.hs"
10− , "src/Squeal/PostgreSQL/Definition.hs"
11− , "src/Squeal/PostgreSQL/Manipulation.hs"
12− , "src/Squeal/PostgreSQL/Query.hs"
13− , "src/Squeal/PostgreSQL/Expression.hs"
14− , "src/Squeal/PostgreSQL/PQ.hs"
15− , "src/Squeal/PostgreSQL/Migration.hs"
16− , "src/Squeal/PostgreSQL/Transaction.hs"
17− , "src/Squeal/PostgreSQL/Pool.hs"
18− ]
squeal-postgresql/test/Property.hsnew file+166
@@ -0,0 +1,166 @@
1+{-# LANGUAGE
2+ DataKinds
3+ , GADTs
4+ , LambdaCase
5+ , OverloadedLabels
6+ , OverloadedStrings
7+ , TypeApplications
8+ , TypeOperators
9+#-}
10+
11+module Main (main) where
12+
13+import Control.Monad.Trans
14+import Data.ByteString (ByteString)
15+import Data.ByteString.Char8 (unpack)
16+import Data.Scientific (fromFloatDigits)
17+import Data.Fixed (Fixed(MkFixed), Micro, Pico)
18+import Data.String (IsString(fromString))
19+import Data.Time
20+import Squeal.PostgreSQL hiding (check, defaultMain, Group)
21+import Hedgehog hiding (Range)
22+import qualified Hedgehog.Gen as Gen
23+import qualified Hedgehog.Main as Main
24+import qualified Hedgehog.Range as Range
25+
26+main :: IO ()
27+main = Main.defaultMain [checkSequential roundtrips]
28+
29+roundtrips :: Group
30+roundtrips = Group "roundtrips"
31+ [ roundtrip int2 genInt16
32+ , roundtrip int4 genInt32
33+ , roundtrip int8 genInt64
34+ , roundtrip bool Gen.bool
35+ , roundtrip numeric genScientific
36+ , roundtrip float4 genFloat
37+ , roundtrip float8 genDouble
38+ , roundtripOn normalizeTimeOfDay time genTimeOfDay
39+ -- , roundtrip timetz genTimeWithZone normalizeTimeWithZone
40+ , roundtripOn normalizeLocalTime timestamp genLocalTime
41+ , roundtrip timestamptz genUTCTime
42+ , roundtrip date genDay
43+ , roundtrip interval genDiffTime
44+ , roundtripOn normalizeIntRange int4range (genRange genInt32)
45+ , roundtripOn normalizeIntRange int8range (genRange genInt64)
46+ , roundtrip numrange (genRange genScientific)
47+ , roundtripOn (fmap normalizeLocalTime) tsrange (genRange genLocalTime)
48+ , roundtrip tstzrange (genRange genUTCTime)
49+ , roundtripOn normalizeIntRange daterange (genRange genDay)
50+ ]
51+ where
52+ genInt16 = Gen.int16 Range.exponentialBounded
53+ genInt32 = Gen.int32 Range.exponentialBounded
54+ genInt64 = Gen.int64 Range.exponentialBounded
55+ genScientific = fromFloatDigits <$> genFloat
56+ genPosFloat = Gen.float
57+ (Range.exponentialFloatFrom 1 minPosFloat maxPosFloat)
58+ genFloat = Gen.prune $ Gen.choice
59+ [ genPosFloat
60+ , negate <$> genPosFloat
61+ , Gen.element [0,1/0] ]
62+ genPosDouble = Gen.double
63+ (Range.exponentialFloatFrom 1 minPosFloat maxPosFloat)
64+ genDouble = Gen.prune $ Gen.choice
65+ [ genPosDouble
66+ , negate <$> genPosDouble
67+ , Gen.element [0,1/0] ]
68+ genRange gen = do
69+ lb <- gen
70+ ub <- Gen.filter (lb <) gen
71+ Gen.element
72+ [ Empty, singleton lb, whole
73+ , lb <=..<= ub , lb <=..< ub, lb <..<= ub, lb <..< ub
74+ , atLeast lb, moreThan lb, atMost ub, lessThan ub ]
75+ genDay = do
76+ y <- toInteger <$> Gen.int (Range.constant 2000 2019)
77+ m <- Gen.int (Range.constant 1 12)
78+ d <- Gen.int (Range.constant 1 28)
79+ return $ fromGregorian y m d
80+ genDiffTime = secondsToDiffTime . toInteger <$>
81+ Gen.int (Range.constant 0 86401)
82+ genUTCTime = UTCTime <$> genDay <*> genDiffTime
83+ genTimeOfDay = do
84+ h <- Gen.int (Range.constant 0 23)
85+ m <- Gen.int (Range.constant 0 59)
86+ s <- MkFixed . toInteger <$> Gen.int (Range.constant 0 59)
87+ return $ TimeOfDay h m s
88+ genLocalTime = LocalTime <$> genDay <*> genTimeOfDay
89+ -- genTimeZone = Gen.element $ map (read @TimeZone)
90+ -- [ "UTC", "UT", "GMT", "EST", "EDT", "CST"
91+ -- , "CDT", "MST", "MDT", "PST", "PDT" ]
92+ -- genTimeWithZone = (,) <$> genTimeOfDay <*> genTimeZone
93+
94+roundtrip
95+ :: (OidOf ty, ToParam x ty, FromValue ty x, Show x, Eq x)
96+ => TypeExpression schemas ('NotNull ty)
97+ -> Gen x
98+ -> (PropertyName, Property)
99+roundtrip = roundtripOn id
100+
101+roundtripOn
102+ :: (OidOf ty, ToParam x ty, FromValue ty x, Show x, Eq x)
103+ => (x -> x)
104+ -> TypeExpression schemas ('NotNull ty)
105+ -> Gen x
106+ -> (PropertyName, Property)
107+roundtripOn norm ty gen = propertyWithName $ do
108+ x <- forAll gen
109+ Just (Only y) <- lift . withConnection connectionString $
110+ firstRow =<< runQueryParams
111+ (values_ (parameter @1 ty `as` #fromOnly)) (Only x)
112+ norm x === y
113+ where
114+ propertyWithName prop =
115+ (fromString (unpack (renderSQL ty)), property prop)
116+
117+maxPosFloat :: RealFloat a => a
118+maxPosFloat = x
119+ where
120+ n = floatDigits x
121+ b = floatRadix x
122+ (_, u) = floatRange x
123+ x = encodeFloat (b^n - 1) (u - n)
124+
125+minPosFloat :: RealFloat a => a
126+minPosFloat = x
127+ where
128+ n = floatDigits x
129+ b = floatRadix x
130+ (l, _) = floatRange x
131+ x = encodeFloat (b^n - 1) (l - n - 1)
132+
133+connectionString :: ByteString
134+connectionString = "host=localhost port=5432 dbname=exampledb"
135+
136+normalizeIntRange :: (Enum int, Ord int) => Range int -> Range int
137+normalizeIntRange = \case
138+ Empty -> Empty
139+ NonEmpty l u ->
140+ let
141+ l' = normalizeL l
142+ u' = normalizeU u
143+ in if emptyNormalized l' u' then Empty else NonEmpty l' u'
144+ where
145+ normalizeL = \case
146+ Open l -> Closed (succ l)
147+ normalized -> normalized
148+ normalizeU = \case
149+ Closed u -> Open (succ u)
150+ normalized -> normalized
151+ emptyNormalized (Closed l) (Open u) = l >= u
152+ emptyNormalized _ _ = False
153+
154+normalizeTimeOfDay :: TimeOfDay -> TimeOfDay
155+normalizeTimeOfDay (TimeOfDay h m s) = TimeOfDay h m
156+ . fromRational @Pico
157+ . toRational @Micro
158+ . fromRational @Micro
159+ . toRational @Pico
160+ $ s
161+
162+normalizeLocalTime :: LocalTime -> LocalTime
163+normalizeLocalTime (LocalTime d t) = LocalTime d (normalizeTimeOfDay t)
164+
165+-- normalizeTimeWithZone :: (TimeOfDay, TimeZone) -> (TimeOfDay, TimeZone)
166+-- normalizeTimeWithZone (t, z) = (normalizeTimeOfDay t, z)
squeal-postgresql/test/Spec.hsnew file+136
@@ -0,0 +1,136 @@
1+{-# LANGUAGE
2+ DataKinds
3+ , DeriveAnyClass
4+ , DeriveGeneric
5+ , DerivingStrategies
6+ , DuplicateRecordFields
7+ , FlexibleContexts
8+ , OverloadedLabels
9+ , OverloadedLists
10+ , OverloadedStrings
11+ , TypeApplications
12+ , TypeFamilies
13+ , TypeInType
14+ , TypeOperators
15+#-}
16+
17+module Main (main) where
18+
19+import Control.Concurrent.Async (replicateConcurrently)
20+import Data.ByteString (ByteString)
21+import Data.Int (Int32)
22+import Data.Text (Text)
23+import Test.Hspec
24+
25+import qualified Generics.SOP as SOP
26+import qualified GHC.Generics as GHC
27+
28+import Squeal.PostgreSQL
29+
30+main :: IO ()
31+main = hspec spec
32+
33+type Schemas = Public
34+ '[ "users" ::: 'Table (
35+ '[ "pk_users" ::: 'PrimaryKey '["id"]
36+ , "unique_names" ::: 'Unique '["name"]
37+ ] :=>
38+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4
39+ , "name" ::: 'NoDef :=> 'NotNull 'PGtext ] ) ]
40+
41+data User = User
42+ { userName :: Text
43+ } deriving stock (Eq, Show, GHC.Generic)
44+ deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)
45+
46+insertUser :: Manipulation_ Schemas User ()
47+insertUser = insertInto_ #users
48+ (Values_ (Default `as` #id :* Set (param @1) `as` #name))
49+
50+setup :: Definition (Public '[]) Schemas
51+setup =
52+ createTable #users
53+ ( serial `as` #id :*
54+ notNullable text `as` #name )
55+ ( primaryKey #id `as` #pk_users :*
56+ unique #name `as` #unique_names )
57+
58+teardown :: Definition Schemas (Public '[])
59+teardown = dropTable #users
60+
61+silence :: MonadPQ schemas pq => pq ()
62+silence = manipulate_ $
63+ UnsafeManipulation "SET client_min_messages TO WARNING;"
64+
65+setupDB :: IO ()
66+setupDB = withConnection connectionString $
67+ silence & pqThen (define setup)
68+
69+dropDB :: IO ()
70+dropDB = withConnection connectionString $
71+ silence & pqThen (define teardown)
72+
73+connectionString :: ByteString
74+connectionString = "host=localhost port=5432 dbname=exampledb"
75+
76+spec :: Spec
77+spec = before_ setupDB . after_ dropDB $ do
78+
79+ describe "Exceptions" $ do
80+
81+ let
82+ testUser = User "TestUser"
83+ newUser = manipulateParams_ insertUser
84+ insertUserTwice = newUser testUser >> newUser testUser
85+ err23505 = PQException $ PQState FatalError (Just "23505")
86+ (Just "ERROR: duplicate key value violates unique constraint \"unique_names\"\nDETAIL: Key (name)=(TestUser) already exists.\n")
87+
88+ it "should be thrown for constraint violation" $
89+ withConnection connectionString insertUserTwice
90+ `shouldThrow` (== err23505)
91+
92+ it "should be rethrown for constraint violation in a transaction" $
93+ withConnection connectionString (transactionally_ insertUserTwice)
94+ `shouldThrow` (== err23505)
95+
96+ describe "Pools" $
97+
98+ it "should manage concurrent transactions" $ do
99+ pool <- createConnectionPool
100+ "host=localhost port=5432 dbname=exampledb" 1 0.5 10
101+ let
102+ query :: Query_ (Public '[]) () (Only Char)
103+ query = values_ (literal 'a' `as` #fromOnly)
104+ session = usingConnectionPool pool . transactionally_ $ do
105+ result <- runQuery query
106+ Just (Only chr) <- firstRow result
107+ return chr
108+ chrs <- replicateConcurrently 10 session
109+ chrs `shouldSatisfy` all (== 'a')
110+
111+ describe "Ranges" $
112+
113+ it "should correctly decode ranges" $ do
114+
115+ rangesOut <- withConnection connectionString $ do
116+ let
117+ query :: Query_ (Public '[]) () (Only (Range Int32))
118+ query = values
119+ ( range int4range (atLeast 3) `as` #fromOnly )
120+ [ range int4range (3 <=..< 5) `as` #fromOnly
121+ , range int4range Empty `as` #fromOnly
122+ , range int4range whole `as` #fromOnly ]
123+ getRows =<< runQuery query
124+ (fromOnly <$> rangesOut :: [Range Int32]) `shouldBe`
125+ [ atLeast 3, 3 <=..< 5, Empty, whole ]
126+
127+ describe "Parameters" $ do
128+
129+ it "should run queries that don't reference all their parameters" $ do
130+
131+ out <- withConnection connectionString $ do
132+ let
133+ query :: Query_ (Public '[]) (Char,Int32) (Only Int32)
134+ query = values_ (param @2 `as` #fromOnly)
135+ firstRow =<< runQueryParams query ('a', 3 :: Int32)
136+ (fromOnly <$> out :: Maybe Int32) `shouldBe` Just 3
squeal-postgresql/test/Specs/ExceptionHandling.hsdeleted−126
@@ -1,126 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE DeriveGeneric #-}
3−{-# LANGUAGE DuplicateRecordFields #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE OverloadedLabels #-}
6−{-# LANGUAGE OverloadedLists #-}
7−{-# LANGUAGE OverloadedStrings #-}
8−{-# LANGUAGE TypeApplications #-}
9−{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeInType #-}
11−{-# LANGUAGE TypeOperators #-}
12−module ExceptionHandling
13− ( specs
14− , User (..)
15− )
16−where
17−
18−import Control.Monad (void)
19−import Control.Monad.IO.Class (MonadIO (..))
20−import qualified Data.ByteString.Char8 as Char8
21−import Data.Int (Int16)
22−import Data.Text (Text)
23−import Data.Vector (Vector)
24−import qualified Generics.SOP as SOP
25−import qualified GHC.Generics as GHC
26−import Squeal.PostgreSQL
27−import Squeal.PostgreSQL.Migration
28−import Test.Hspec
29−
30−type Schema =
31− '[ "users" ::: 'Table (
32− '[ "pk_users" ::: 'PrimaryKey '["id"]
33− , "unique_names" ::: 'Unique '["name"]
34− ] :=>
35− '[ "id" ::: 'Def :=> 'NotNull 'PGint4
36− , "name" ::: 'NoDef :=> 'NotNull 'PGtext
37− , "vec" ::: 'NoDef :=> 'NotNull ('PGvararray ('Null 'PGint2))
38− ])
39− , "emails" ::: 'Table (
40− '[ "pk_emails" ::: 'PrimaryKey '["id"]
41− , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]
42− ] :=>
43− '[ "id" ::: 'Def :=> 'NotNull 'PGint4
44− , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4
45− , "email" ::: 'NoDef :=> 'Null 'PGtext
46− ])
47− ]
48−
49−type Schemas = Public Schema
50−
51−data User =
52− User { userName :: Text
53− , userEmail :: Maybe Text
54− , userVec :: VarArray (Vector (Maybe Int16)) }
55− deriving (Show, GHC.Generic)
56−instance SOP.Generic User
57−instance SOP.HasDatatypeInfo User
58−
59−insertUser :: Manipulation '[] Schemas '[ 'NotNull 'PGtext, 'NotNull ('PGvararray ('Null 'PGint2))]
60− '[ "fromOnly" ::: 'NotNull 'PGint4 ]
61−insertUser = insertInto #users
62− (Values_ (defaultAs #id :* param @1 `as` #name :* param @2 `as` #vec))
63− OnConflictDoRaise (Returning (#id `as` #fromOnly))
64−
65−setup :: Definition (Public '[]) Schemas
66−setup =
67− createTable #users
68− ( serial `as` #id :*
69− (text & notNullable) `as` #name :*
70− (vararray int2 & notNullable) `as` #vec )
71− ( primaryKey #id `as` #pk_users
72− :* unique #name `as` #unique_names )
73− >>>
74− createTable #emails
75− ( serial `as` #id :*
76− (int & notNullable) `as` #user_id :*
77− (text & nullable) `as` #email )
78− ( primaryKey #id `as` #pk_emails :*
79− foreignKey #user_id #users #id
80− OnDeleteCascade OnUpdateCascade `as` #fk_user_id )
81−
82−teardown :: Definition Schemas (Public '[])
83−teardown = dropTable #emails >>> dropTable #users
84−
85−migration :: Migration Definition (Public '[]) Schemas
86−migration = Migration { name = "test"
87− , up = setup
88− , down = teardown }
89−
90−setupDB :: IO ()
91−setupDB = void . withConnection connectionString $
92− manipulate (UnsafeManipulation "SET client_min_messages TO WARNING;")
93− & pqThen (migrateUp (single migration))
94−
95−dropDB :: IO ()
96−dropDB = void . withConnection connectionString $
97− manipulate (UnsafeManipulation "SET client_min_messages TO WARNING;")
98− & pqThen (migrateDown (single migration))
99−
100−connectionString :: Char8.ByteString
101−connectionString = "host=localhost port=5432 dbname=exampledb"
102−
103−testUser :: User
104−testUser = User "TestUser" Nothing (VarArray [])
105−
106−newUser :: (MonadIO m, MonadPQ Schemas m) => User -> m ()
107−newUser u = void $ manipulateParams insertUser (userName u, userVec u)
108−
109−insertUserTwice :: (MonadIO m, MonadPQ Schemas m) => m ()
110−insertUserTwice = newUser testUser >> newUser testUser
111−
112−specs :: SpecWith ()
113−specs = before_ setupDB $ after_ dropDB $
114− describe "Exceptions" $ do
115−
116− let
117− dupKeyErr = PQException FatalError (Just "23505")
118− (Just "ERROR: duplicate key value violates unique constraint \"unique_names\"\nDETAIL: Key (name)=(TestUser) already exists.\n")
119−
120− it "should be thrown for unique constraint violation in a manipulation" $
121− withConnection connectionString insertUserTwice
122− `shouldThrow` (== dupKeyErr)
123−
124− it "should be rethrown for unique constraint violation in a manipulation by a transaction" $
125− withConnection connectionString (transactionally_ insertUserTwice)
126− `shouldThrow` (== dupKeyErr)
squeal-postgresql/test/Specs/Specs.hsdeleted−7
@@ -1,7 +0,0 @@
1−module Specs where
2−
3−import Test.Hspec
4−import qualified ExceptionHandling
5−
6−main :: IO ()
7−main = hspec ExceptionHandling.specs
stack.yaml+3−1
@@ -1,6 +1,8 @@
1−resolver: lts-13.8
1+resolver: nightly-2019-07-14
22packages:
33- squeal-postgresql
44
55extra-deps:
66- unliftio-pool-0.2.1.0
7+- github: morphismtech/free-categories
8+ commit: c0e555fbefb5c21619e532264c4dfeac556d0630