212174e..dev · squeal · git.iko.soy

git.iko.soy/squeal

on dev help sign in

.circleci/config.yml+1−1

since splitsnapshots

unifiedsplit

@@ -2,7 +2,7 @@ version: 2

2jobs:

3 build:

4 docker:

5− - image: haskell:8.6.3

5+ - image: haskell:8.6.5

6 - image: circleci/postgres:latest

7 environment:

8 POSTGRES_USER: root

README.md+59−70

@@ -46,7 +46,11 @@ composable and cover a large portion of SQL.

46* transactions

47* views

48* 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

51## installation

55## installation

@@ -72,19 +76,17 @@ First, we need some language extensions because Squeal uses modern GHC

72features.

76features.

74```Haskell

78```Haskell

75−>>> :set -XDataKinds -XDeriveGeneric -XOverloadedLabels

79+>>> :set -XDataKinds -XDeriveGeneric -XOverloadedLabels -XFlexibleContexts

76−>>> :set -XOverloadedStrings -XTypeApplications -XTypeOperators

80+>>> :set -XOverloadedStrings -XTypeApplications -XTypeOperators -XGADTs

77```

81```

79We'll need some imports.

83We'll need some imports.

81```Haskell

85```Haskell

82−>>> import Control.Monad (void)

83>>> import Control.Monad.IO.Class (liftIO)

86>>> import Control.Monad.IO.Class (liftIO)

84>>> import Data.Int (Int32)

87>>> import Data.Int (Int32)

85>>> import Data.Text (Text)

88>>> import Data.Text (Text)

86>>> import Squeal.PostgreSQL

89>>> import Squeal.PostgreSQL

87−>>> import Squeal.PostgreSQL.Render

88```

90```

90We'll use generics to easily convert between Haskell and PostgreSQL values.

92We'll use generics to easily convert between Haskell and PostgreSQL values.

@@ -99,27 +101,27 @@ we use `DataKinds` and `TypeOperators`.

101

100```Haskell

102```Haskell

101>>> :{

103>>> :{

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"] ]

102type Schema =

115type Schema =

103− '[ "users" ::: 'Table (

116+ '[ "users" ::: 'Table (UsersConstraints :=> UsersColumns)

104− '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>

105− '[ "id" ::: 'Def :=> 'NotNull 'PGint4

106− , "name" ::: 'NoDef :=> 'NotNull 'PGtext

107− ])

108− , "emails" ::: 'Table (

117+ , "emails" ::: 'Table (EmailsConstraints :=> EmailsColumns) ]

109− '[ "pk_emails" ::: 'PrimaryKey '["id"]

118+type Schemas = Public Schema

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− ]

117:}

119:}

118```

120```

119

121

120Notice the use of type operators.

122Notice the use of type operators.

121

123

122−`:::` is used to pair an alias `GHC.TypeLits.Symbol` with a `SchemumType`,

124+`:::` is used to pair an alias `Symbol` with a `SchemumType`,

123a `TableConstraint` or a `ColumnType`. It is intended to connote Haskell's `::`

125a `TableConstraint` or a `ColumnType`. It is intended to connote Haskell's `::`

124operator.

126operator.

125

127

@@ -137,7 +139,7 @@ labels to refer to named tables and columns in our schema.

137```Haskell

139```Haskell

138>>> :{

140>>> :{

139let

141let

140− setup :: Definition '[] Schema

142+ setup :: Definition (Public '[]) Schemas

141 setup =

143 setup =

142 createTable #users

144 createTable #users

143 ( serial `as` #id :*

145 ( serial `as` #id :*

@@ -169,7 +171,7 @@ primary and foreign keys, making them somewhat complex. Our `teardown`

169```Haskell

171```Haskell

170>>> :{

172>>> :{

171let

173let

172− teardown :: Definition Schema '[]

174+ teardown :: Definition Schemas (Public '[])

173 teardown = dropTable #emails >>> dropTable #users

175 teardown = dropTable #emails >>> dropTable #users

174:}

176:}

175

177

@@ -178,54 +180,54 @@ DROP TABLE "emails";

178DROP TABLE "users";

180DROP TABLE "users";

179```

181```

180

182

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+

181−Next, we'll write `Manipulation`s to insert data into our two tables.

192+Next, we'll write `Manipulation_`s to insert `User`s into our two tables.

182−A `Manipulation` like `insertRow`, `update` or `deleteFrom`

193+A `Manipulation_` like `insertInto`, `update` or `deleteFrom`

183−has three type parameters, the schema it refers to, a list of parameters

194+has three type parameters, the schemas it refers to, input parameters

184−it can take as input, and a list of columns it produces as output. When

195+and an output row. When

185we insert into the users table, we will need a parameter for the `name`

196we insert into the users table, we will need a parameter for the `name`

186field but not for the `id` field. Since it's serial, we can use a default

197field but not for the `id` field. Since it's serial, we can use a default

187value. However, since the emails table refers to the users table, we will

198value. However, since the emails table refers to the users table, we will

188need to retrieve the user id that the insert generates and insert it into

199need 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

200+the emails table. We can do this in a single `Manipulation_` by using a

190−of our inserts.

201+`with` statement.

191

202

192```Haskell

203```Haskell

193>>> :{

204>>> :{

194let

205let

195− insertUser :: Manipulation Schema '[ 'NotNull 'PGtext ] '[ "fromOnly" ::: 'NotNull 'PGint4 ]

206+ insertUser :: Manipulation_ Schemas User ()

196− insertUser = insertRow #users

207+ insertUser = with (u `as` #u) e

208+ where

209+ u = insertInto #users

197− (Default `as` #id :* Set (param @1) `as` #name)

210+ (Values_ (Default `as` #id :* Set (param @1) `as` #name))

198− OnConflictDoNothing (Returning (#id `as` #fromOnly))

211+ OnConflictDoRaise (Returning_ (#id :* param @2 `as` #email))

199−:}

212+ e = insertInto_ #emails $ Select

200−

201−>>> :{

202−let

203− insertEmail :: Manipulation Schema '[ 'NotNull 'PGint4, 'Null 'PGtext] '[]

204− insertEmail = insertRow #emails

205− ( Default `as` #id :*

213+ (Default `as` #id :* Set (#u ! #id) `as` #user_id :* Set (#u ! #email) `as` #email)

206− Set (param @1) `as` #user_id :*

214+ (from (common #u))

207− Set (param @2) `as` #email )

208− OnConflictDoNothing (Returning Nil)

209:}

215:}

210

216

211>>> printSQL insertUser

217>>> printSQL insertUser

212−INSERT INTO "users" ("id", "name") VALUES (DEFAULT, ($1 :: text)) ON CONFLICT DO NOTHING RETURNING "id" AS "fromOnly"

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"

213−>>> printSQL insertEmail

214−INSERT INTO "emails" ("id", "user_id", "email") VALUES (DEFAULT, ($1 :: int4), ($2 :: text)) ON CONFLICT DO NOTHING

215```

219```

216

220

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

218interested in the ids here, just the usernames and email addresses. We

222interested 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

223+need to use an `innerJoin` to get the right result. A `Query_` is like a

220−`Manipulation` with the same kind of type parameters.

224+`Manipulation_` with the same kind of type parameters.

221

225

222```Haskell

226```Haskell

223>>> :{

227>>> :{

224let

228let

225− getUsers :: Query Schema '[]

229+ getUsers :: Query_ Schemas () User

226− '[ "userName" ::: 'NotNull 'PGtext

227− , "userEmail" ::: 'Null 'PGtext ]

228− getUsers = select

230+ getUsers = select_

229 (#u ! #name `as` #userName :* #e ! #email `as` #userEmail)

231 (#u ! #name `as` #userName :* #e ! #email `as` #userEmail)

230 ( from (table (#users `as` #u)

232 ( from (table (#users `as` #u)

231 & innerJoin (table (#emails `as` #e))

233 & innerJoin (table (#emails `as` #e))

@@ -236,19 +238,7 @@ let

236SELECT "u"."name" AS "userName", "e"."email" AS "userEmail" FROM "users" AS "u" INNER JOIN "emails" AS "e" ON ("u"."id" = "e"."user_id")

238SELECT "u"."name" AS "userName", "e"."email" AS "userEmail" FROM "users" AS "u" INNER JOIN "emails" AS "e" ON ("u"."id" = "e"."user_id")

237```

239```

238

240

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.

252

242

253```Haskell

243```Haskell

254>>> :{

244>>> :{

@@ -273,19 +263,18 @@ transformer and when the schema doesn't change we can use `Monad` and

273```Haskell

263```Haskell

274>>> :{

264>>> :{

275let

265let

276− session :: PQ Schema Schema IO ()

266+ session :: PQ Schemas Schemas IO ()

277 session = do

267 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

281 usersResult <- runQuery getUsers

269 usersResult <- runQuery getUsers

282 usersRows <- getRows usersResult

270 usersRows <- getRows usersResult

283 liftIO $ print (usersRows :: [User])

271 liftIO $ print (usersRows :: [User])

284in

272in

285− void . withConnection "host=localhost port=5432 dbname=exampledb" $

273+ withConnection "host=localhost port=5432 dbname=exampledb" $

286 define setup

274 define setup

287 & pqThen session

275 & pqThen session

288 & pqThen (define teardown)

276 & pqThen (define teardown)

289:}

277:}

290[User {userName = "Alice", userEmail = Just "alice@gmail.com"},User {userName = "Bob", userEmail = Nothing},User {userName = "Carole", userEmail = Just "carole@hotmail.com"}]

278[User {userName = "Alice", userEmail = Just "alice@gmail.com"},User {userName = "Bob", userEmail = Nothing},User {userName = "Carole", userEmail = Just "carole@hotmail.com"}]

279+-}

291```

280```

RELEASE NOTES.md+400

@@ -1,5 +1,405 @@

1## RELEASE NOTES

3+### Version 0.5

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.

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+

3### Version 0.4

403### Version 0.4

404

5Version 0.4 strengthens Squeal's type system, adds

405Version 0.4 strengthens Squeal's type system, adds

squeal-postgresql/exe/Example.hs+9−7

@@ -11,7 +11,6 @@

12module Main (main, main2) where

14−import Control.Monad (void)

15import Control.Monad.IO.Class (MonadIO (..))

14import Control.Monad.IO.Class (MonadIO (..))

16import Data.Int (Int16, Int32)

15import Data.Int (Int16, Int32)

17import Data.Monoid ((<>))

16import Data.Monoid ((<>))

@@ -39,6 +38,7 @@ type Schema =

39 , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4

38 , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4

40 , "email" ::: 'NoDef :=> 'Null 'PGtext

39 , "email" ::: 'NoDef :=> 'Null 'PGtext

41 ])

40 ])

41+ , "positive" ::: 'Typedef 'PGfloat4

42 ]

44type Schemas = Public Schema

@@ -53,23 +53,25 @@ setup =

53 >>>

54 createTable #emails

55 ( serial `as` #id :*

56− (int & notNullable) `as` #user_id :*

56+ hask @Int32 `as` #user_id :*

57− (text & nullable) `as` #email )

57+ hask @(Maybe Text) `as` #email )

58 ( primaryKey #id `as` #pk_emails :*

59 foreignKey #user_id #users #id

60 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

61+ >>>

62+ createDomain #positive real (#value .> 0 .&& (#value & isNotNull))

62teardown :: Definition Schemas (Public '[])

64teardown :: Definition Schemas (Public '[])

63−teardown = dropTable #emails >>> dropTable #users

65+teardown = dropType #positive >>> dropTable #emails >>> dropTable #users

65insertUser :: Manipulation_ Schemas (Text, VarArray (Vector (Maybe Int16))) (Only Int32)

67insertUser :: Manipulation_ Schemas (Text, VarArray (Vector (Maybe Int16))) (Only Int32)

66insertUser = insertInto #users

68insertUser = 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))

68 (OnConflict (OnConstraint #pk_users) DoNothing) (Returning_ (#id `as` #fromOnly))

70 (OnConflict (OnConstraint #pk_users) DoNothing) (Returning_ (#id `as` #fromOnly))

70insertEmail :: Manipulation_ Schemas (Int32, Maybe Text) ()

72insertEmail :: Manipulation_ Schemas (Int32, Maybe Text) ()

71insertEmail = insertInto_ #emails

73insertEmail = 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))

74getUsers :: Query_ Schemas () User

76getUsers :: Query_ Schemas () User

75getUsers = select_

77getUsers = select_

@@ -117,7 +119,7 @@ main = do

117

119

118main2 :: IO ()

120main2 :: IO ()

119main2 =

121main2 =

120− void . withConnection "host=localhost port=5432 dbname=exampledb" $

122+ withConnection "host=localhost port=5432 dbname=exampledb" $

121 define setup

123 define setup

122 & pqThen session

124 & pqThen session

123 & pqThen (define teardown)

125 & pqThen (define teardown)

squeal-postgresql/squeal-postgresql.cabal+53−11

@@ -1,5 +1,5 @@

1name: squeal-postgresql

2−version: 0.4.9.0

2+version: 0.5.1.0

3synopsis: Squeal PostgreSQL Library

4description: Squeal is a type-safe embedding of PostgreSQL in Haskell

5homepage: https://github.com/morphismtech/squeal

@@ -25,7 +25,32 @@ library

25 Squeal.PostgreSQL.Alias

26 Squeal.PostgreSQL.Binary

27 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

28 Squeal.PostgreSQL.Expression

35 Squeal.PostgreSQL.Expression

36+ Squeal.PostgreSQL.Expression.Aggregate

37+ Squeal.PostgreSQL.Expression.Collection

38+ Squeal.PostgreSQL.Expression.Comparison

39+ Squeal.PostgreSQL.Expression.Json

40+ Squeal.PostgreSQL.Expression.Literal

41+ Squeal.PostgreSQL.Expression.Logic

42+ Squeal.PostgreSQL.Expression.Math

43+ Squeal.PostgreSQL.Expression.Null

44+ Squeal.PostgreSQL.Expression.Parameter

45+ Squeal.PostgreSQL.Expression.Range

46+ Squeal.PostgreSQL.Expression.Set

47+ Squeal.PostgreSQL.Expression.Sort

48+ Squeal.PostgreSQL.Expression.Subquery

49+ Squeal.PostgreSQL.Expression.Text

50+ Squeal.PostgreSQL.Expression.TextSearch

51+ Squeal.PostgreSQL.Expression.Time

52+ Squeal.PostgreSQL.Expression.Type

53+ Squeal.PostgreSQL.Expression.Window

29 Squeal.PostgreSQL.List

54 Squeal.PostgreSQL.List

30 Squeal.PostgreSQL.Manipulation

55 Squeal.PostgreSQL.Manipulation

31 Squeal.PostgreSQL.Migration

56 Squeal.PostgreSQL.Migration

@@ -45,7 +70,8 @@ library

45 , bytestring >= 0.10.8.2

70 , bytestring >= 0.10.8.2

46 , bytestring-strict-builder >= 0.4.5

71 , bytestring-strict-builder >= 0.4.5

47 , deepseq >= 1.4.3.0

72 , deepseq >= 1.4.3.0

73+ , free-categories >= 0.1.0.0

48− , generics-sop >= 0.3.2.0

74+ , generics-sop >= 0.3.2.0 && < 0.5.0.0

49 , mmorph >= 1.1.1

75 , mmorph >= 1.1.1

50 , mtl >= 2.2.2

76 , mtl >= 2.2.2

51 , network-ip >= 0.3.0.2

77 , network-ip >= 0.3.0.2

@@ -62,34 +88,50 @@ library

62 , uuid-types >= 1.0.3

88 , uuid-types >= 1.0.3

63 , vector >= 0.12.0.1

89 , vector >= 0.12.0.1

65−test-suite squeal-postgresql-doctest

91+test-suite doctest

66 default-language: Haskell2010

92 default-language: Haskell2010

67 type: exitcode-stdio-1.0

93 type: exitcode-stdio-1.0

68 hs-source-dirs: test

94 hs-source-dirs: test

69 ghc-options: -Wall

95 ghc-options: -Wall

70− main-is: DocTest.hs

96+ main-is: Doc.hs

71 build-depends:

97 build-depends:

72 base >= 4.10.0.0

98 base >= 4.10.0.0

73 , doctest >= 0.11.4

99 , doctest >= 0.11.4

100+ , squeal-postgresql

101

75−test-suite squeal-postgresql-specs

102+test-suite properties

76 default-language: Haskell2010

103 default-language: Haskell2010

77 type: exitcode-stdio-1.0

104 type: exitcode-stdio-1.0

78− hs-source-dirs: test/Specs

105+ hs-source-dirs: test

79− ghc-options: -Wall -main-is Specs

106+ ghc-options: -Wall

80− main-is: Specs.hs

107+ main-is: Property.hs

81− other-modules: ExceptionHandling

82 build-depends:

108 build-depends:

83 base >= 4.10.0.0

109 base >= 4.10.0.0

84 , bytestring >= 0.10.8.2

110 , 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

85 , generics-sop >= 0.3.1.0

127 , generics-sop >= 0.3.1.0

86 , hspec >= 2.4.8

128 , hspec >= 2.4.8

129+ , mtl >= 2.2.2

87 , squeal-postgresql

130 , squeal-postgresql

88 , text >= 1.2.2.2

131 , text >= 1.2.2.2

89− , transformers >= 0.5.2.0

90 , vector >= 0.12.0.1

132 , vector >= 0.12.0.1

133

92−executable squeal-postgresql-example

134+executable example

93 default-language: Haskell2010

135 default-language: Haskell2010

94 hs-source-dirs: exe

136 hs-source-dirs: exe

95 ghc-options: -Wall

137 ghc-options: -Wall

squeal-postgresql/src/Squeal/PostgreSQL.hs+64−51

@@ -1,7 +1,7 @@

1{-|

2Module: Squeal.PostgreSQL

3Description: Squeal export module

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

@@ -11,17 +11,15 @@ Let's see an example!

11First, we need some language extensions because Squeal uses modern GHC

12features.

14−>>> :set -XDataKinds -XDeriveGeneric -XOverloadedLabels

14+>>> :set -XDataKinds -XDeriveGeneric -XOverloadedLabels -XFlexibleContexts

15>>> :set -XOverloadedStrings -XTypeApplications -XTypeOperators -XGADTs

17We'll need some imports.

19−>>> import Control.Monad (void)

20>>> import Control.Monad.IO.Class (liftIO)

19>>> import Control.Monad.IO.Class (liftIO)

21>>> import Data.Int (Int32)

20>>> import Data.Int (Int32)

22>>> import Data.Text (Text)

21>>> import Data.Text (Text)

23>>> import Squeal.PostgreSQL

22>>> import Squeal.PostgreSQL

24−>>> import Squeal.PostgreSQL.Render

26We'll use generics to easily convert between Haskell and PostgreSQL values.

24We'll use generics to easily convert between Haskell and PostgreSQL values.

@@ -104,45 +102,44 @@ let

104DROP TABLE "emails";

102DROP TABLE "emails";

105DROP TABLE "users";

103DROP TABLE "users";

106

104

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

105+We'll need a Haskell type for @User@s. We give the type `Generics.SOP.Generic` and

119−`Generics.SOP.HasDatatypeInfo` instances so that we can decode the rows

106+`Generics.SOP.HasDatatypeInfo` instances so that we can encode and decode @User@s.

120−we receive when we run @getUsers@. Notice that the record fields of the

121−@User@ type match the column names of @getUsers@.

122

107

123>>> data User = User { userName :: Text, userEmail :: Maybe Text } deriving (Show, GHC.Generic)

108>>> data User = User { userName :: Text, userEmail :: Maybe Text } deriving (Show, GHC.Generic)

124>>> instance SOP.Generic User

109>>> instance SOP.Generic User

125>>> instance SOP.HasDatatypeInfo User

110>>> instance SOP.HasDatatypeInfo User

126

111

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+

127>>> :{

123>>> :{

128let

124let

129 insertUser :: Manipulation_ Schemas User ()

125 insertUser :: Manipulation_ Schemas User ()

130 insertUser = with (u `as` #u) e

126 insertUser = with (u `as` #u) e

131 where

127 where

132 u = insertInto #users

128 u = insertInto #users

133− (Values_ (defaultAs #id :* param @1 `as` #name))

129+ (Values_ (Default `as` #id :* Set (param @1) `as` #name))

134 OnConflictDoRaise (Returning_ (#id :* param @2 `as` #email))

130 OnConflictDoRaise (Returning_ (#id :* param @2 `as` #email))

135− e = insertInto_ #emails

131+ e = insertInto_ #emails $ Select

136− (Select (defaultAs #id :* #u ! #id `as` #user_id :* #u ! #email) (from (common #u)))

132+ (Default `as` #id :* Set (#u ! #id) `as` #user_id :* Set (#u ! #email) `as` #email)

133+ (from (common #u))

137:}

134:}

138

135

139>>> printSQL insertUser

136>>> printSQL insertUser

140WITH "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"

137WITH "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"

141

138

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

143interested in the ids here, just the usernames and email addresses. We

140interested 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

141+need to use an `innerJoin` to get the right result. A `Query_` is like a

145−`Manipulation` with the same kind of type parameters.

142+`Manipulation_` with the same kind of type parameters.

146

143

147>>> :{

144>>> :{

148let

145let

@@ -186,35 +183,51 @@ let

186 usersRows <- getRows usersResult

183 usersRows <- getRows usersResult

187 liftIO $ print (usersRows :: [User])

184 liftIO $ print (usersRows :: [User])

188in

185in

189− void . withConnection "host=localhost port=5432 dbname=exampledb" $

186+ withConnection "host=localhost port=5432 dbname=exampledb" $

190 define setup

187 define setup

191 & pqThen session

188 & pqThen session

192 & pqThen (define teardown)

189 & pqThen (define teardown)

193:}

190:}

194[User {userName = "Alice", userEmail = Just "alice@gmail.com"},User {userName = "Bob", userEmail = Nothing},User {userName = "Carole", userEmail = Just "carole@hotmail.com"}]

191[User {userName = "Alice", userEmail = Just "alice@gmail.com"},User {userName = "Bob", userEmail = Nothing},User {userName = "Carole", userEmail = Just "carole@hotmail.com"}]

195-}

192-}

196−module Squeal.PostgreSQL

193+module Squeal.PostgreSQL (module X, RenderSQL(..), printSQL) where

197− ( module Squeal.PostgreSQL.Alias

194+

198− , module Squeal.PostgreSQL.Binary

199− , module Squeal.PostgreSQL.Definition

200− , module Squeal.PostgreSQL.Expression

201− , module Squeal.PostgreSQL.List

202− , module Squeal.PostgreSQL.Manipulation

203− , module Squeal.PostgreSQL.PG

204− , module Squeal.PostgreSQL.PQ

205− , module Squeal.PostgreSQL.Query

206− , module Squeal.PostgreSQL.Schema

207− , module Squeal.PostgreSQL.Transaction

208− ) where

209−

210−import Squeal.PostgreSQL.Alias

195+import Squeal.PostgreSQL.Alias as X

211−import Squeal.PostgreSQL.Binary

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

212−import Squeal.PostgreSQL.Definition

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

213−import Squeal.PostgreSQL.Expression

210+import Squeal.PostgreSQL.Expression.Literal as X

214−import Squeal.PostgreSQL.List

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

215−import Squeal.PostgreSQL.Manipulation

225+import Squeal.PostgreSQL.Manipulation as X

216−import Squeal.PostgreSQL.PG

226+import Squeal.PostgreSQL.Migration as X

227+import Squeal.PostgreSQL.PG as X

217−import Squeal.PostgreSQL.PQ

228+import Squeal.PostgreSQL.Pool as X

229+import Squeal.PostgreSQL.PQ as X

218−import Squeal.PostgreSQL.Query

230+import Squeal.PostgreSQL.Query as X

219−import Squeal.PostgreSQL.Schema

231+import Squeal.PostgreSQL.Render (RenderSQL(..), printSQL)

232+import Squeal.PostgreSQL.Schema as X

220−import Squeal.PostgreSQL.Transaction

233+import Squeal.PostgreSQL.Transaction as X

squeal-postgresql/src/Squeal/PostgreSQL/Alias.hs+26−19

@@ -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

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+

1{-# LANGUAGE

13{-# LANGUAGE

2 AllowAmbiguousTypes

14 AllowAmbiguousTypes

3 , ConstraintKinds

15 , ConstraintKinds

@@ -34,7 +46,6 @@ module Squeal.PostgreSQL.Alias

34 , HasIn

46 , HasIn

35 , QualifiedAlias (..)

47 , QualifiedAlias (..)

36 , IsQualified (..)

48 , IsQualified (..)

37− , DefaultAliasable (..)

38 -- * Grouping

49 -- * Grouping

39 , Grouping (..)

50 , Grouping (..)

40 , GroupedBy

51 , GroupedBy

@@ -49,8 +60,12 @@ import GHC.TypeLits

49import qualified Generics.SOP as SOP

60import qualified Generics.SOP as SOP

50import qualified GHC.Generics as GHC

61import qualified GHC.Generics as GHC

63+import Squeal.PostgreSQL.List

52import Squeal.PostgreSQL.Render

64import Squeal.PostgreSQL.Render

66+-- $setup

67+-- >>> import Squeal.PostgreSQL

68+

54-- | The alias operator `:::` is like a promoted version of `As`,

69-- | The alias operator `:::` is like a promoted version of `As`,

55-- a type level pair between an alias and some type.

70-- a type level pair between an alias and some type.

56type (:::) (alias :: Symbol) ty = '(alias,ty)

71type (:::) (alias :: Symbol) ty = '(alias,ty)

@@ -88,17 +103,16 @@ data Alias (alias :: Symbol) = Alias

88 deriving (Eq,GHC.Generic,Ord,Show,NFData)

103 deriving (Eq,GHC.Generic,Ord,Show,NFData)

89instance alias1 ~ alias2 => IsLabel alias1 (Alias alias2) where

104instance alias1 ~ alias2 => IsLabel alias1 (Alias alias2) where

90 fromLabel = Alias

105 fromLabel = Alias

91−instance aliases ~ '[alias] => IsLabel alias (SOP.NP Alias aliases) where

106+instance aliases ~ '[alias] => IsLabel alias (NP Alias aliases) where

92− fromLabel = fromLabel SOP.:* SOP.Nil

107+ fromLabel = fromLabel SOP.:* Nil

93-- | >>> printSQL (#jimbob :: Alias "jimbob")

108-- | >>> printSQL (#jimbob :: Alias "jimbob")

94-- "jimbob"

109-- "jimbob"

95instance KnownSymbol alias => RenderSQL (Alias alias) where

110instance KnownSymbol alias => RenderSQL (Alias alias) where

96 renderSQL = doubleQuoted . fromString . symbolVal

111 renderSQL = doubleQuoted . fromString . symbolVal

112

98−-- | >>> import Generics.SOP (SOP.NP(..))

99−-- >>> printSQL (#jimbob SOP.:* #kandi :: SOP.NP Alias '["jimbob", "kandi"])

113+-- >>> printSQL (#jimbob :* #kandi :: NP Alias '["jimbob", "kandi"])

100-- "jimbob", "kandi"

114-- "jimbob", "kandi"

101−instance SOP.All KnownSymbol aliases => RenderSQL (SOP.NP Alias aliases) where

115+instance SOP.All KnownSymbol aliases => RenderSQL (NP Alias aliases) where

102 renderSQL

116 renderSQL

103 = commaSeparated

117 = commaSeparated

104 . SOP.hcollapse

118 . SOP.hcollapse

@@ -125,8 +139,8 @@ instance (alias0 ~ alias1, alias0 ~ alias2, KnownSymbol alias2)

125 => IsLabel alias0 (Aliased Alias (alias1 ::: alias2)) where

139 => IsLabel alias0 (Aliased Alias (alias1 ::: alias2)) where

126 fromLabel = fromLabel @alias2 `As` fromLabel @alias1

140 fromLabel = fromLabel @alias2 `As` fromLabel @alias1

127

141

128−-- | The `Aliasable` class provides a way to scrap your `SOP.Nil`s

142+-- | The `Aliasable` class provides a way to scrap your `Nil`s

129−-- in an `SOP.NP` list of `Aliased` expressions.

143+-- in an `NP` list of `Aliased` expressions.

130class KnownSymbol alias => Aliasable alias expression aliased

144class KnownSymbol alias => Aliasable alias expression aliased

131 | aliased -> expression

145 | aliased -> expression

132 , aliased -> alias

146 , aliased -> alias

@@ -138,9 +152,9 @@ instance (KnownSymbol alias, aliased ~ (alias ::: ty)) => Aliasable alias

138 as = As

152 as = As

139instance (KnownSymbol alias, tys ~ '[alias ::: ty]) => Aliasable alias

153instance (KnownSymbol alias, tys ~ '[alias ::: ty]) => Aliasable alias

140 (expression ty)

154 (expression ty)

141− (SOP.NP (Aliased expression) tys)

155+ (NP (Aliased expression) tys)

142 where

156 where

143− expression `as` alias = expression `As` alias SOP.:* SOP.Nil

157+ expression `as` alias = expression `As` alias SOP.:* Nil

144

158

145-- | >>> let renderMaybe = fromString . maybe "Nothing" (const "Just")

159-- | >>> let renderMaybe = fromString . maybe "Nothing" (const "Just")

146-- >>> renderAliased renderMaybe (Just (3::Int) `As` #an_int)

160-- >>> renderAliased renderMaybe (Just (3::Int) `As` #an_int)

@@ -174,14 +188,6 @@ choose which subfields to update.

174class HasIn fields field where

188class HasIn fields field where

175instance (Has alias fields field) => HasIn fields (alias ::: field) where

189instance (Has alias fields field) => HasIn fields (alias ::: field) where

176

190

177−{- |

178−The `DefaultAliasable` class is intended to help with Scrap your SOP.Nils

179−for default inserts and updates.

180−-}

181−class KnownSymbol alias

182− => DefaultAliasable alias aliased | aliased -> alias where

183− defaultAs :: Alias alias -> aliased

184−

185-- | `HasAll` extends `Has` to take lists of @aliases@ and @fields@ and infer

191-- | `HasAll` extends `Has` to take lists of @aliases@ and @fields@ and infer

186-- a list of @subfields@.

192-- a list of @subfields@.

187class

193class

@@ -205,7 +211,8 @@ class IsQualified table column expression where

205instance IsQualified table column (Alias table, Alias column) where (!) = (,)

211instance IsQualified table column (Alias table, Alias column) where (!) = (,)

206

212

207{-| `QualifiedAlias`es enables multi-schema support by allowing a reference

213{-| `QualifiedAlias`es enables multi-schema support by allowing a reference

214+to a `Squeal.PostgreSQL.Schema.Table`, `Squeal.PostgreSQL.Schema.Typedef`

208−to a `Table`, `Typedef` or `View` to be qualified by their schemas. By default,

215+or `Squeal.PostgreSQL.Schema.View` to be qualified by their schemas. By default,

209a qualifier of @public@ is provided.

216a qualifier of @public@ is provided.

210

217

211>>> :{

218>>> :{

squeal-postgresql/src/Squeal/PostgreSQL/Binary.hs+214−149

@@ -39,7 +39,7 @@ the input and output should be equal.

40>>> let input = Row 2 "hi" (Just True)

41>>> :{

42−void . withConnection "host=localhost port=5432 dbname=exampledb" $ do

42+withConnection "host=localhost port=5432 dbname=exampledb" $ do

43 result <- runQueryParams roundTrip input

44 Just output <- firstRow result

45 liftIO . print $ input == output

@@ -78,7 +78,7 @@ let

78>>> :set -XOverloadedLists

79>>> let input = Row (VarArray [1,2]) (FixArray (Just 1,Nothing)) (FixArray ((1,2),(3,4),(5,6)))

80>>> :{

81−void . withConnection "host=localhost port=5432 dbname=exampledb" $ do

81+withConnection "host=localhost port=5432 dbname=exampledb" $ do

82 result <- runQueryParams roundTrip input

83 Just output <- firstRow result

84 liftIO . print $ input == output

@@ -170,7 +170,7 @@ let

170 Just output <- firstRow result

171 liftIO . print $ input == output

172in

173− void . withConnection "host=localhost port=5432 dbname=exampledb" $

173+ withConnection "host=localhost port=5432 dbname=exampledb" $

174 define setup

175 & pqThen session

176 & pqThen (define teardown)

@@ -202,25 +202,23 @@ True

202#-}

203

204module Squeal.PostgreSQL.Binary

205− ( -- * Storage newtypes

206− Money (..)

207− , Json (..)

208− , Jsonb (..)

209− , Composite (..)

210− , Enumerated (..)

211− , VarArray (..)

212− , FixArray (..)

213− -- * Encoding

205+ ( -- * Encoding

214− , ToParam (..)

206+ ToParam (..)

215 , ToParams (..)

207 , ToParams (..)

216− , ToNullityParam

208+ , ToNullityParam (..)

217− , ToField

209+ , ToField (..)

218− , ToFixArray

210+ , ToFixArray (..)

219 -- * Decoding

211 -- * Decoding

220 , FromValue (..)

212 , FromValue (..)

221 , FromRow (..)

213 , FromRow (..)

214+ , FromField (..)

215+ , FromFixArray (..)

222 -- * Only

216 -- * Only

223 , Only (..)

217 , Only (..)

218+ -- * Oid

219+ , OidOf (..)

220+ , OidOfParam (..)

221+ , OidOfField (..)

224 ) where

222 ) where

225

223

226import BinaryParser

224import BinaryParser

@@ -234,6 +232,7 @@ import Data.Time

234import Data.UUID.Types

232import Data.UUID.Types

235import Data.Vector (Vector)

233import Data.Vector (Vector)

236import Data.Word

234import Data.Word

235+import Foreign.C.Types (CUInt(CUInt))

237import Generics.SOP

236import Generics.SOP

238import Generics.SOP.Record

237import Generics.SOP.Record

239import GHC.TypeLits

238import GHC.TypeLits

@@ -247,6 +246,7 @@ import qualified Data.Text.Lazy as Lazy (Text)

247import qualified Data.Text as Strict (Text)

246import qualified Data.Text as Strict (Text)

248import qualified Data.Text as Strict.Text

247import qualified Data.Text as Strict.Text

249import qualified Data.Vector as Vector

248import qualified Data.Vector as Vector

249+import qualified Database.PostgreSQL.LibPQ as LibPQ

250import qualified GHC.Generics as GHC

251import qualified PostgreSQL.Binary.Decoding as Decoding

252import qualified PostgreSQL.Binary.Encoding as Encoding

@@ -277,11 +277,9 @@ class ToParam (x :: Type) (pg :: PGType) where

277 toParam :: x -> K Encoding.Encoding pg

278instance ToParam Bool 'PGbool where toParam = K . Encoding.bool

279instance ToParam Int16 'PGint2 where toParam = K . Encoding.int2_int16

280−instance ToParam Word16 'PGint2 where toParam = K . Encoding.int2_word16

281instance ToParam Int32 'PGint4 where toParam = K . Encoding.int4_int32

280instance ToParam Int32 'PGint4 where toParam = K . Encoding.int4_int32

282−instance ToParam Word32 'PGint4 where toParam = K . Encoding.int4_word32

283instance ToParam Int64 'PGint8 where toParam = K . Encoding.int8_int64

281instance ToParam Int64 'PGint8 where toParam = K . Encoding.int8_int64

284−instance ToParam Word64 'PGint8 where toParam = K . Encoding.int8_word64

282+instance ToParam Oid 'PGoid where toParam = K . Encoding.int4_word32 . getOid

285instance ToParam Float 'PGfloat4 where toParam = K . Encoding.float4

283instance ToParam Float 'PGfloat4 where toParam = K . Encoding.float4

286instance ToParam Double 'PGfloat8 where toParam = K . Encoding.float8

284instance ToParam Double 'PGfloat8 where toParam = K . Encoding.float8

287instance ToParam Scientific 'PGnumeric where toParam = K . Encoding.numeric

285instance ToParam Scientific 'PGnumeric where toParam = K . Encoding.numeric

@@ -314,24 +312,26 @@ instance Aeson.ToJSON x => ToParam (Json x) 'PGjson where

314instance Aeson.ToJSON x => ToParam (Jsonb x) 'PGjsonb where

312instance Aeson.ToJSON x => ToParam (Jsonb x) 'PGjsonb where

315 toParam = K . Encoding.jsonb_bytes

313 toParam = K . Encoding.jsonb_bytes

316 . Lazy.ByteString.toStrict . Aeson.encode . getJsonb

314 . Lazy.ByteString.toStrict . Aeson.encode . getJsonb

317−instance (ToNullityParam x ty, ty ~ nullity pg, HasOid pg)

315+instance (ToNullityParam x ty, ty ~ nullity pg, OidOf pg)

318 => ToParam (VarArray [x]) ('PGvararray ty) where

316 => ToParam (VarArray [x]) ('PGvararray ty) where

319 toParam = K

317 toParam = K

320− . Encoding.array_foldable (oid @pg) (unK . toNullityParam @x @ty)

318+ . Encoding.array_foldable

319+ (getOid (oidOf @pg)) (unK . toNullityParam @x @ty)

321 . getVarArray

320 . getVarArray

322−instance (ToParam x pg, HasOid pg)

321+instance (ToParam x pg, OidOf pg)

323 => ToParam (VarArray (Vector x)) ('PGvararray ('NotNull pg)) where

322 => ToParam (VarArray (Vector x)) ('PGvararray ('NotNull pg)) where

324 toParam = K

323 toParam = K

325− . Encoding.array_vector (oid @pg) (unK . toParam @x @pg)

324+ . Encoding.array_vector (getOid (oidOf @pg)) (unK . toParam @x @pg)

326 . getVarArray

325 . getVarArray

327−instance (ToParam x pg, HasOid pg)

326+instance (ToParam x pg, OidOf pg)

328 => ToParam (VarArray (Vector (Maybe x))) ('PGvararray ('Null pg)) where

327 => ToParam (VarArray (Vector (Maybe x))) ('PGvararray ('Null pg)) where

329 toParam = K

328 toParam = K

330− . Encoding.nullableArray_vector (oid @pg) (unK . toParam @x @pg)

329+ . Encoding.nullableArray_vector

330+ (getOid (oidOf @pg)) (unK . toParam @x @pg)

331 . getVarArray

332−instance (ToFixArray x dims ty, ty ~ nullity pg, HasOid pg)

332+instance (ToFixArray x dims ty, ty ~ nullity pg, OidOf pg)

333 => ToParam (FixArray x) ('PGfixarray dims ty) where

334− toParam = K . Encoding.array (oid @pg)

334+ toParam = K . Encoding.array (getOid (oidOf @pg))

335 . unK . unK . toFixArray @x @dims @ty . getFixArray

336instance

337 ( IsEnumType x

@@ -356,7 +356,7 @@ instance

356 ( SListI fields

357 , IsRecord x xs

358 , AllZip ToField xs fields

359− , All HasAliasedOid fields

359+ , All OidOfField fields

360 ) => ToParam (Composite x) ('PGcomposite fields) where

361 toParam =

362 let

@@ -364,7 +364,7 @@ instance

364 encoders = htrans (Proxy @ToField) toField

365

366 composite

367− :: All HasAliasedOid row

367+ :: All OidOfField row

368 => NP (K (Maybe Encoding.Encoding)) row

369 -> K Encoding.Encoding ('PGcomposite row)

370 composite fields = K $

@@ -381,27 +381,142 @@ instance

381 int32BE (fromIntegral (lengthSList (Proxy @xs))) <>

382 let

383 each

384− :: HasAliasedOid field

384+ :: OidOfField field

385 => K (Maybe Encoding.Encoding) field

386 -> Encoding.Encoding

387 each (K field :: K (Maybe Encoding.Encoding) field) =

388− word32BE (aliasedOid @field)

388+ word32BE (getOid (oidOfField @field))

389 <> case field of

390 Nothing -> int64BE (-1)

391 Just value ->

392 int32BE (fromIntegral (builderLength value))

393 <> value

394 in

395− hcfoldMap (Proxy @HasAliasedOid) each fields

395+ hcfoldMap (Proxy @OidOfField) each fields

396

397 in

398 composite . encoders . toRecord . getComposite

399

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.

400−class HasAliasedOid (field :: (Symbol, NullityType)) where

513+class OidOfField (field :: (Symbol, NullityType)) where

401− aliasedOid :: Word32

514+ oidOfField :: Oid

402−instance HasOid ty => HasAliasedOid (alias ::: nullity ty) where

515+instance OidOf ty => OidOfField (alias ::: nullity ty) where

403− aliasedOid = oid @ty

516+ oidOfField = oidOf @ty

404−

517+

518+-- | A `ToNullityParam` constraint gives an encoding of a Haskell `Type` into

519+-- into the binary format of a PostgreSQL `NullityType`.

405class ToNullityParam (x :: Type) (ty :: NullityType) where

520class ToNullityParam (x :: Type) (ty :: NullityType) where

406 toNullityParam :: x -> K (Maybe Encoding.Encoding) ty

521 toNullityParam :: x -> K (Maybe Encoding.Encoding) ty

407instance ToParam x pg => ToNullityParam x ('NotNull pg) where

522instance ToParam x pg => ToNullityParam x ('NotNull pg) where

@@ -409,11 +524,19 @@ instance ToParam x pg => ToNullityParam x ('NotNull pg) where

409instance ToParam x pg => ToNullityParam (Maybe x) ('Null pg) where

524instance ToParam x pg => ToNullityParam (Maybe x) ('Null pg) where

410 toNullityParam = K . fmap (unK . toParam @x @pg)

525 toNullityParam = K . fmap (unK . toParam @x @pg)

411

526

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.

412class ToField (x :: (Symbol, Type)) (field :: (Symbol, NullityType)) where

531class ToField (x :: (Symbol, Type)) (field :: (Symbol, NullityType)) where

413 toField :: P x -> K (Maybe Encoding.Encoding) field

532 toField :: P x -> K (Maybe Encoding.Encoding) field

414instance ToNullityParam x ty => ToField (alias ::: x) (alias ::: ty) where

533instance ToNullityParam x ty => ToField (alias ::: x) (alias ::: ty) where

415 toField (P x) = K . unK $ toNullityParam @x @ty x

534 toField (P x) = K . unK $ toNullityParam @x @ty x

416

535

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.

417class ToFixArray (x :: Type) (dims :: [Nat]) (array :: NullityType) where

540class ToFixArray (x :: Type) (dims :: [Nat]) (array :: NullityType) where

418 toFixArray :: x -> K (K Encoding.Array dims) array

541 toFixArray :: x -> K (K Encoding.Array dims) array

419instance ToNullityParam x ty => ToFixArray x '[] ty where

542instance ToNullityParam x ty => ToFixArray x '[] ty where

@@ -459,6 +582,7 @@ instance FromValue 'PGbool Bool where fromValue = Decoding.bool

459instance FromValue 'PGint2 Int16 where fromValue = Decoding.int

582instance FromValue 'PGint2 Int16 where fromValue = Decoding.int

460instance FromValue 'PGint4 Int32 where fromValue = Decoding.int

583instance FromValue 'PGint4 Int32 where fromValue = Decoding.int

461instance FromValue 'PGint8 Int64 where fromValue = Decoding.int

584instance FromValue 'PGint8 Int64 where fromValue = Decoding.int

585+instance FromValue 'PGoid Word32 where fromValue = Decoding.int

462instance FromValue 'PGfloat4 Float where fromValue = Decoding.float4

586instance FromValue 'PGfloat4 Float where fromValue = Decoding.float4

463instance FromValue 'PGfloat8 Double where fromValue = Decoding.float8

587instance FromValue 'PGfloat8 Double where fromValue = Decoding.float8

464instance FromValue 'PGnumeric Scientific where fromValue = Decoding.numeric

588instance FromValue 'PGnumeric Scientific where fromValue = Decoding.numeric

@@ -597,6 +721,10 @@ instance FromValue pg y

597 K (Just bytestring) -> P . Just <$>

721 K (Just bytestring) -> P . Just <$>

598 Decoding.valueParser (fromValue @pg) bytestring

722 Decoding.valueParser (fromValue @pg) bytestring

599

723

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.

600class FromFixArray (dims :: [Nat]) (ty :: NullityType) (y :: Type) where

728class FromFixArray (dims :: [Nat]) (ty :: NullityType) (y :: Type) where

601 fromFixArray :: Decoding.Array y

729 fromFixArray :: Decoding.Array y

602instance FromValue pg y => FromFixArray '[] ('NotNull pg) y where

730instance FromValue pg y => FromFixArray '[] ('NotNull pg) y where

@@ -641,50 +769,53 @@ instance

641 = fmap fromRecord

769 = fmap fromRecord

642 . hsequence'

770 . hsequence'

643 . htrans (Proxy @FromField) fromField

771 . htrans (Proxy @FromField) fromField

772+------------------------------------------------------

773+-- P records

774+------------------------------------------------------

644−instance (FromField (col ::: pg) (col ::: hask))

775+-- instance (FromField (col ::: pg) (col ::: hask))

645− => FromRow '[col ::: pg] (P (col ::: hask)) where

776+-- => FromRow '[col ::: pg] (P (col ::: hask)) where

646− fromRow (pg :* Nil) = (unComp . fromField) pg

777+-- fromRow (pg :* Nil) = (unComp . fromField) pg

647−instance

778+-- instance

648− ( row ~ Join row1 row2

779+-- ( row ~ Join row1 row2

649− , FromRow row1 hask1

780+-- , FromRow row1 hask1

650− , FromRow row2 hask2

781+-- , FromRow row2 hask2

651− , SListI row

782+-- , SListI row

652− ) => FromRow row (hask1, hask2) where

783+-- ) => FromRow row (hask1, hask2) where

653− fromRow row = case disjoin @row1 @row2 row of

784+-- fromRow row = case disjoin @row1 @row2 row of

654− (row1, row2) -> (,) <$> fromRow row1 <*> fromRow row2

785+-- (row1, row2) -> (,) <$> fromRow row1 <*> fromRow row2

655−instance

786+-- instance

656− ( row ~ Join row1 row23

787+-- ( row ~ Join row1 row23

657− , FromRow row1 hask1

788+-- , FromRow row1 hask1

658− , FromRow row23 (hask2, hask3)

789+-- , FromRow row23 (hask2, hask3)

659− , SListI row

790+-- , SListI row

660− ) => FromRow row (hask1, hask2, hask3) where

791+-- ) => FromRow row (hask1, hask2, hask3) where

661− fromRow row = case disjoin @row1 @row23 row of

792+-- fromRow row = case disjoin @row1 @row23 row of

662− (row1, row23) -> do

793+-- (row1, row23) -> do

663− hask1 <- fromRow row1

794+-- hask1 <- fromRow row1

664− (hask2, hask3) <- fromRow row23

795+-- (hask2, hask3) <- fromRow row23

665− return (hask1, hask2, hask3)

796+-- return (hask1, hask2, hask3)

666−instance

797+-- instance

667− ( row ~ Join row1 row234

798+-- ( row ~ Join row1 row234

668− , FromRow row1 hask1

799+-- , FromRow row1 hask1

669− , FromRow row234 (hask2, hask3, hask4)

800+-- , FromRow row234 (hask2, hask3, hask4)

670− , SListI row

801+-- , SListI row

671− ) => FromRow row (hask1, hask2, hask3, hask4) where

802+-- ) => FromRow row (hask1, hask2, hask3, hask4) where

672− fromRow row = case disjoin @row1 @row234 row of

803+-- fromRow row = case disjoin @row1 @row234 row of

673− (row1, row234) -> do

804+-- (row1, row234) -> do

674− hask1 <- fromRow row1

805+-- hask1 <- fromRow row1

675− (hask2, hask3, hask4) <- fromRow row234

806+-- (hask2, hask3, hask4) <- fromRow row234

676− return (hask1, hask2, hask3, hask4)

807+-- return (hask1, hask2, hask3, hask4)

677−instance

808+-- instance

678− ( row ~ Join row1 row2345

809+-- ( row ~ Join row1 row2345

679− , FromRow row1 hask1

810+-- , FromRow row1 hask1

680− , FromRow row2345 (hask2, hask3, hask4, hask5)

811+-- , FromRow row2345 (hask2, hask3, hask4, hask5)

681− , SListI row

812+-- , SListI row

682− ) => FromRow row (hask1, hask2, hask3, hask4, hask5) where

813+-- ) => FromRow row (hask1, hask2, hask3, hask4, hask5) where

683− fromRow row = case disjoin @row1 @row2345 row of

814+-- fromRow row = case disjoin @row1 @row2345 row of

684− (row1, row2345) -> do

815+-- (row1, row2345) -> do

685− hask1 <- fromRow row1

816+-- hask1 <- fromRow row1

686− (hask2, hask3, hask4, hask5) <- fromRow row2345

817+-- (hask2, hask3, hask4, hask5) <- fromRow row2345

687− return (hask1, hask2, hask3, hask4, hask5)

818+-- return (hask1, hask2, hask3, hask4, hask5)

688

819

689-- | `Only` is a 1-tuple type, useful for encoding a single parameter with

820-- | `Only` is a 1-tuple type, useful for encoding a single parameter with

690-- `toParams` or decoding a single value with `fromRow`.

821-- `toParams` or decoding a single value with `fromRow`.

@@ -713,71 +844,5 @@ replicateMN

713replicateMN mx = hsequence' $

844replicateMN mx = hsequence' $

714 hcpure (Proxy :: Proxy ((~) x)) (Comp (I <$> mx))

845 hcpure (Proxy :: Proxy ((~) x)) (Comp (I <$> mx))

715

846

716−{- | The `Money` newtype stores a monetary value in terms

847+getOid :: LibPQ.Oid -> Word32

717−of the number of cents, i.e. @$2,000.20@ would be expressed as

848+getOid (LibPQ.Oid (CUInt oid)) = oid

718−@Money { cents = 200020 }@.

719−

720−>>> import Control.Monad (void)

721−>>> import Control.Monad.IO.Class (liftIO)

722−>>> import Squeal.PostgreSQL

723−>>> :{

724−let

725− roundTrip :: Query_ (Public '[]) (Only Money) (Only Money)

726− roundTrip = values_ $ parameter @1 money `as` #fromOnly

727−:}

728−

729−>>> let input = Only (Money 20020)

730−

731−>>> :{

732−void . withConnection "host=localhost port=5432 dbname=exampledb" $ do

733− result <- runQueryParams roundTrip input

734− Just output <- firstRow result

735− liftIO . print $ input == output

736−:}

737−True

738−-}

739−newtype Money = Money { cents :: Int64 }

740− deriving (Eq, Ord, Show, Read, GHC.Generic)

741−type instance PG Money = 'PGmoney

742−

743−{- | The `Json` newtype is an indication that the Haskell

744−type it's applied to should be stored as a `PGjson`.

745−-}

746−newtype Json hask = Json {getJson :: hask}

747− deriving (Eq, Ord, Show, Read, GHC.Generic)

748−type instance PG (Json hask) = 'PGjson

749−

750−{- | The `Jsonb` newtype is an indication that the Haskell

751−type it's applied to should be stored as a `PGjsonb`.

752−-}

753−newtype Jsonb hask = Jsonb {getJsonb :: hask}

754− deriving (Eq, Ord, Show, Read, GHC.Generic)

755−type instance PG (Jsonb hask) = 'PGjsonb

756−

757−{- | The `Composite` newtype is an indication that the Haskell

758−type it's applied to should be stored as a `PGcomposite`.

759−-}

760−newtype Composite record = Composite {getComposite :: record}

761− deriving (Eq, Ord, Show, Read, GHC.Generic)

762−type instance PG (Composite hask) = 'PGcomposite (RowPG hask)

763−

764−{- | The `Enumerated` newtype is an indication that the Haskell

765−type it's applied to should be stored as a `PGenum`.

766−-}

767−newtype Enumerated enum = Enumerated {getEnumerated :: enum}

768− deriving (Eq, Ord, Show, Read, GHC.Generic)

769−type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)

770−

771−{- | The `VarArray` newtype is an indication that the Haskell

772−type it's applied to should be stored as a `PGvararray`.

773−-}

774−newtype VarArray arr = VarArray {getVarArray :: arr}

775− deriving (Eq, Ord, Show, Read, GHC.Generic)

776−type instance PG (VarArray (Vector hask)) = 'PGvararray (NullPG hask)

777−

778−{- | The `FixArray` newtype is an indication that the Haskell

779−type it's applied to should be stored as a `PGfixarray`.

780−-}

781−newtype FixArray arr = FixArray {getFixArray :: arr}

782− deriving (Eq, Ord, Show, Read, GHC.Generic)

783−type instance PG (FixArray x) = 'PGfixarray (DimPG x) (FixPG x)

squeal-postgresql/src/Squeal/PostgreSQL/Definition.hs+15−1014

@@ -11,13 +11,15 @@ Squeal data definition language.

11{-# LANGUAGE

12 AllowAmbiguousTypes

13 , ConstraintKinds

14+ , DeriveAnyClass

14 , DeriveGeneric

15 , DeriveGeneric

16+ , DerivingStrategies

15 , FlexibleContexts

17 , FlexibleContexts

16 , FlexibleInstances

18 , FlexibleInstances

17 , GADTs

19 , GADTs

18− , GeneralizedNewtypeDeriving

19 , LambdaCase

20 , LambdaCase

20 , MultiParamTypeClasses

21 , MultiParamTypeClasses

22+ , OverloadedLabels

21 , OverloadedStrings

23 , OverloadedStrings

22 , RankNTypes

24 , RankNTypes

23 , ScopedTypeVariables

25 , ScopedTypeVariables

@@ -25,84 +27,31 @@ Squeal data definition language.

25 , TypeInType

27 , TypeInType

26 , TypeOperators

28 , TypeOperators

27 , UndecidableSuperClasses

29 , UndecidableSuperClasses

30+ , UndecidableInstances

28#-}

31#-}

30module Squeal.PostgreSQL.Definition

33module Squeal.PostgreSQL.Definition

31 ( -- * Definition

34 ( -- * Definition

32 Definition (..)

35 Definition (..)

33 , (>>>)

36 , (>>>)

34− -- * Tables

37+ , manipDefinition

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

86 ) where

38 ) where

88import Control.Category

40import Control.Category

89import Control.DeepSeq

41import Control.DeepSeq

90import Data.ByteString

42import Data.ByteString

91import Data.Monoid

43import Data.Monoid

92−import GHC.TypeLits

93import Prelude hiding ((.), id)

44import Prelude hiding ((.), id)

95−import qualified Generics.SOP as SOP

96import qualified GHC.Generics as GHC

46import qualified GHC.Generics as GHC

98−import Squeal.PostgreSQL.Alias

48+import Squeal.PostgreSQL.Manipulation

99−import Squeal.PostgreSQL.Binary

100−import Squeal.PostgreSQL.Expression

101−import Squeal.PostgreSQL.PG

102−import Squeal.PostgreSQL.Query

103import Squeal.PostgreSQL.Render

49import Squeal.PostgreSQL.Render

104import Squeal.PostgreSQL.Schema

50import Squeal.PostgreSQL.Schema

105

52+-- $setup

53+-- >>> import Squeal.PostgreSQL

54+

106{-----------------------------------------

55{-----------------------------------------

107statements

56statements

108-----------------------------------------}

57-----------------------------------------}

@@ -124,958 +73,10 @@ instance Category Definition where

124 ddl1 . ddl0 = UnsafeDefinition $

73 ddl1 . ddl0 = UnsafeDefinition $

125 renderSQL ddl0 <> "\n" <> renderSQL ddl1

74 renderSQL ddl0 <> "\n" <> renderSQL ddl1

126

127−{-----------------------------------------

76+-- | A `Manipulation` without input or output can be run as a statement

128−CREATE statements

77+-- along with other `Definition`s, by embedding it using `manipDefinition`.

129−-----------------------------------------}

78+manipDefinition

130−

79+ :: Manipulation '[] schemas '[] '[]

131−createSchema

80+ -- ^ no input or output

132− :: KnownSymbol sch

133− => Alias sch

134− -> Definition schemas (Create sch '[] schemas)

135−createSchema sch = UnsafeDefinition $

136− "CREATE" <+> "SCHEMA" <+> renderSQL sch <> ";"

137−

138−createSchemaIfNotExists

139− :: (KnownSymbol sch, Has sch schemas schema)

140− => Alias sch

141 -> Definition schemas schemas

81 -> Definition schemas schemas

142−createSchemaIfNotExists sch = UnsafeDefinition $

82+manipDefinition = UnsafeDefinition . (<> ";") . renderSQL

143− "CREATE" <+> "SCHEMA" <+> "IF" <+> "NOT" <+> "EXISTS"

144− <+> renderSQL sch <> ";"

145−

146−{- | `createTable` adds a table to the schema.

147−

148−>>> :set -XOverloadedLabels

149−>>> :{

150−type Table = '[] :=>

151− '[ "a" ::: 'NoDef :=> 'Null 'PGint4

152− , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]

153−:}

154−

155−>>> :{

156−let

157− setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table])

158− setup = createTable #tab

159− (nullable int `as` #a :* nullable real `as` #b) Nil

160−in printSQL setup

161−:}

162−CREATE TABLE "tab" ("a" int NULL, "b" real NULL);

163−-}

164−createTable

165− :: ( KnownSymbol sch

166− , KnownSymbol tab

167− , columns ~ (col ': cols)

168− , SOP.SListI columns

169− , SOP.SListI constraints

170− , Has sch schemas0 schema0

171− , schemas1 ~ Alter sch (Create tab ('Table (constraints :=> columns)) schema0) schemas0 )

172− => QualifiedAlias sch tab -- ^ the name of the table to add

173− -> NP (Aliased (ColumnTypeExpression schemas0)) columns

174− -- ^ the names and datatype of each column

175− -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints

176− -- ^ constraints that must hold for the table

177− -> Definition schemas0 schemas1

178−createTable tab columns constraints = UnsafeDefinition $

179− "CREATE TABLE" <+> renderCreation tab columns constraints

180−

181−{-| `createTableIfNotExists` creates a table if it doesn't exist, but does not add it to the schema.

182−Instead, the schema already has the table so if the table did not yet exist, the schema was wrong.

183−`createTableIfNotExists` fixes this. Interestingly, this property makes it an idempotent in

184−the `Category` of `Definition`s.

185−

186−>>> :set -XOverloadedLabels -XTypeApplications

187−>>> :{

188−type Table = '[] :=>

189− '[ "a" ::: 'NoDef :=> 'Null 'PGint4

190− , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]

191−:}

192−

193−>>> type Schemas = Public '["tab" ::: 'Table Table]

194−

195−>>> :{

196−let

197− setup :: Definition Schemas Schemas

198− setup = createTableIfNotExists #tab

199− (nullable int `as` #a :* nullable real `as` #b) Nil

200−in printSQL setup

201−:}

202−CREATE TABLE IF NOT EXISTS "tab" ("a" int NULL, "b" real NULL);

203−-}

204−createTableIfNotExists

205− :: ( Has sch schemas schema

206− , Has tab schema ('Table (constraints :=> columns))

207− , SOP.SListI columns

208− , SOP.SListI constraints )

209− => QualifiedAlias sch tab -- ^ the name of the table to add

210− -> NP (Aliased (ColumnTypeExpression schemas)) columns

211− -- ^ the names and datatype of each column

212− -> NP (Aliased (TableConstraintExpression sch tab schemas)) constraints

213− -- ^ constraints that must hold for the table

214− -> Definition schemas schemas

215−createTableIfNotExists tab columns constraints = UnsafeDefinition $

216− "CREATE TABLE IF NOT EXISTS"

217− <+> renderCreation tab columns constraints

218−

219−-- helper function for `createTable` and `createTableIfNotExists`

220−renderCreation

221− :: ( KnownSymbol sch

222− , KnownSymbol tab

223− , SOP.SListI columns

224− , SOP.SListI constraints )

225− => QualifiedAlias sch tab -- ^ the name of the table to add

226− -> NP (Aliased (ColumnTypeExpression schemas0)) columns

227− -- ^ the names and datatype of each column

228− -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints

229− -- ^ constraints that must hold for the table

230− -> ByteString

231−renderCreation tab columns constraints = renderSQL tab

232− <+> parenthesized

233− ( renderCommaSeparated renderColumnDef columns

234− <> ( case constraints of

235− Nil -> ""

236− _ -> ", " <>

237− renderCommaSeparated renderConstraint constraints ) )

238− <> ";"

239− where

240− renderColumnDef :: Aliased (ColumnTypeExpression schemas) x -> ByteString

241− renderColumnDef (ty `As` column) =

242− renderSQL column <+> renderColumnTypeExpression ty

243− renderConstraint

244− :: Aliased (TableConstraintExpression sch tab schemas) constraint

245− -> ByteString

246− renderConstraint (constraint `As` alias) =

247− "CONSTRAINT" <+> renderSQL alias <+> renderSQL constraint

248−

249−-- | Data types are a way to limit the kind of data that can be stored in a

250−-- table. For many applications, however, the constraint they provide is

251−-- too coarse. For example, a column containing a product price should

252−-- probably only accept positive values. But there is no standard data type

253−-- that accepts only positive numbers. Another issue is that you might want

254−-- to constrain column data with respect to other columns or rows.

255−-- For example, in a table containing product information,

256−-- there should be only one row for each product number.

257−-- `TableConstraint`s give you as much control over the data in your tables

258−-- as you wish. If a user attempts to store data in a column that would

259−-- violate a constraint, an error is raised. This applies

260−-- even if the value came from the default value definition.

261−newtype TableConstraintExpression

262− (sch :: Symbol)

263− (tab :: Symbol)

264− (schemas :: SchemasType)

265− (constraint :: TableConstraint)

266− = UnsafeTableConstraintExpression

267− { renderTableConstraintExpression :: ByteString }

268− deriving (GHC.Generic,Show,Eq,Ord,NFData)

269−instance RenderSQL

270− (TableConstraintExpression sch tab schemas constraint) where

271− renderSQL = renderTableConstraintExpression

272−

273−{-| A `check` constraint is the most generic `TableConstraint` type.

274−It allows you to specify that the value in a certain column must satisfy

275−a Boolean (truth-value) expression.

276−

277−>>> :{

278−type Schema = '[

279− "tab" ::: 'Table ('[ "inequality" ::: 'Check '["a","b"]] :=> '[

280− "a" ::: 'NoDef :=> 'NotNull 'PGint4,

281− "b" ::: 'NoDef :=> 'NotNull 'PGint4

282− ])]

283−:}

284−

285−>>> :{

286−let

287− definition :: Definition (Public '[]) (Public Schema)

288− definition = createTable #tab

289− ( (int & notNullable) `as` #a :*

290− (int & notNullable) `as` #b )

291− ( check (#a :* #b) (#a .> #b) `as` #inequality )

292−:}

293−

294−>>> printSQL definition

295−CREATE TABLE "tab" ("a" int NOT NULL, "b" int NOT NULL, CONSTRAINT "inequality" CHECK (("a" > "b")));

296−-}

297−check

298− :: ( Has sch schemas schema

299− , Has tab schema ('Table table)

300− , HasAll aliases (TableToRow table) subcolumns )

301− => NP Alias aliases

302− -- ^ specify the subcolumns which are getting checked

303− -> (forall t. Condition '[] '[] 'Ungrouped schemas '[] '[t ::: subcolumns])

304− -- ^ a closed `Condition` on those subcolumns

305− -> TableConstraintExpression sch tab schemas ('Check aliases)

306−check _cols condition = UnsafeTableConstraintExpression $

307− "CHECK" <+> parenthesized (renderSQL condition)

308−

309−{-| A `unique` constraint ensure that the data contained in a column,

310−or a group of columns, is unique among all the rows in the table.

311−

312−>>> :{

313−type Schema = '[

314− "tab" ::: 'Table( '[ "uq_a_b" ::: 'Unique '["a","b"]] :=> '[

315− "a" ::: 'NoDef :=> 'Null 'PGint4,

316− "b" ::: 'NoDef :=> 'Null 'PGint4

317− ])]

318−:}

319−

320−>>> :{

321−let

322− definition :: Definition (Public '[]) (Public Schema)

323− definition = createTable #tab

324− ( (int & nullable) `as` #a :*

325− (int & nullable) `as` #b )

326− ( unique (#a :* #b) `as` #uq_a_b )

327−:}

328−

329−>>> printSQL definition

330−CREATE TABLE "tab" ("a" int NULL, "b" int NULL, CONSTRAINT "uq_a_b" UNIQUE ("a", "b"));

331−-}

332−unique

333− :: ( Has sch schemas schema

334− , Has tab schema('Table table)

335− , HasAll aliases (TableToRow table) subcolumns )

336− => NP Alias aliases

337− -- ^ specify subcolumns which together are unique for each row

338− -> TableConstraintExpression sch tab schemas ('Unique aliases)

339−unique columns = UnsafeTableConstraintExpression $

340− "UNIQUE" <+> parenthesized (renderSQL columns)

341−

342−{-| A `primaryKey` constraint indicates that a column, or group of columns,

343−can be used as a unique identifier for rows in the table.

344−This requires that the values be both unique and not null.

345−

346−>>> :{

347−type Schema = '[

348− "tab" ::: 'Table ('[ "pk_id" ::: 'PrimaryKey '["id"]] :=> '[

349− "id" ::: 'Def :=> 'NotNull 'PGint4,

350− "name" ::: 'NoDef :=> 'NotNull 'PGtext

351− ])]

352−:}

353−

354−>>> :{

355−let

356− definition :: Definition (Public '[]) (Public Schema)

357− definition = createTable #tab

358− ( serial `as` #id :*

359− (text & notNullable) `as` #name )

360− ( primaryKey #id `as` #pk_id )

361−:}

362−

363−>>> printSQL definition

364−CREATE TABLE "tab" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_id" PRIMARY KEY ("id"));

365−-}

366−primaryKey

367− :: ( Has sch schemas schema

368− , Has tab schema ('Table table)

369− , HasAll aliases (TableToColumns table) subcolumns

370− , AllNotNull subcolumns )

371− => NP Alias aliases

372− -- ^ specify the subcolumns which together form a primary key.

373− -> TableConstraintExpression sch tab schemas ('PrimaryKey aliases)

374−primaryKey columns = UnsafeTableConstraintExpression $

375− "PRIMARY KEY" <+> parenthesized (renderSQL columns)

376−

377−{-| A `foreignKey` specifies that the values in a column

378−(or a group of columns) must match the values appearing in some row of

379−another table. We say this maintains the referential integrity

380−between two related tables.

381−

382−>>> :{

383−type Schema =

384− '[ "users" ::: 'Table (

385− '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>

386− '[ "id" ::: 'Def :=> 'NotNull 'PGint4

387− , "name" ::: 'NoDef :=> 'NotNull 'PGtext

388− ])

389− , "emails" ::: 'Table (

390− '[ "pk_emails" ::: 'PrimaryKey '["id"]

391− , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]

392− ] :=>

393− '[ "id" ::: 'Def :=> 'NotNull 'PGint4

394− , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4

395− , "email" ::: 'NoDef :=> 'Null 'PGtext

396− ])

397− ]

398−:}

399−

400−>>> :{

401−let

402− setup :: Definition (Public '[]) (Public Schema)

403− setup =

404− createTable #users

405− ( serial `as` #id :*

406− (text & notNullable) `as` #name )

407− ( primaryKey #id `as` #pk_users ) >>>

408− createTable #emails

409− ( serial `as` #id :*

410− (int & notNullable) `as` #user_id :*

411− (text & nullable) `as` #email )

412− ( primaryKey #id `as` #pk_emails :*

413− foreignKey #user_id #users #id

414− OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

415−in printSQL setup

416−:}

417−CREATE TABLE "users" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_users" PRIMARY KEY ("id"));

418−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);

419−

420−A `foreignKey` can even be a table self-reference.

421−

422−>>> :{

423−type Schema =

424− '[ "employees" ::: 'Table (

425− '[ "employees_pk" ::: 'PrimaryKey '["id"]

426− , "employees_employer_fk" ::: 'ForeignKey '["employer_id"] "employees" '["id"]

427− ] :=>

428− '[ "id" ::: 'Def :=> 'NotNull 'PGint4

429− , "name" ::: 'NoDef :=> 'NotNull 'PGtext

430− , "employer_id" ::: 'NoDef :=> 'Null 'PGint4

431− ])

432− ]

433−:}

434−

435−>>> :{

436−let

437− setup :: Definition (Public '[]) (Public Schema)

438− setup =

439− createTable #employees

440− ( serial `as` #id :*

441− (text & notNullable) `as` #name :*

442− (integer & nullable) `as` #employer_id )

443− ( primaryKey #id `as` #employees_pk :*

444− foreignKey #employer_id #employees #id

445− OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )

446−in printSQL setup

447−:}

448−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);

449−-}

450−foreignKey

451− :: (ForeignKeyed schemas sch schema child parent

452− table reftable

453− columns refcolumns

454− constraints cols

455− reftys tys )

456− => NP Alias columns

457− -- ^ column or columns in the table

458− -> Alias parent

459− -- ^ reference table

460− -> NP Alias refcolumns

461− -- ^ reference column or columns in the reference table

462− -> OnDeleteClause

463− -- ^ what to do when reference is deleted

464− -> OnUpdateClause

465− -- ^ what to do when reference is updated

466− -> TableConstraintExpression sch child schemas

467− ('ForeignKey columns parent refcolumns)

468−foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $

469− "FOREIGN KEY" <+> parenthesized (renderSQL keys)

470− <+> "REFERENCES" <+> renderSQL parent

471− <+> parenthesized (renderSQL refs)

472− <+> renderSQL ondel

473− <+> renderSQL onupd

474−

475−-- | A constraint synonym between types involved in a foreign key constraint.

476−type ForeignKeyed schemas

477− sch

478− schema

479− child parent

480− table reftable

481− columns refcolumns

482− constraints cols

483− reftys tys =

484− ( Has sch schemas schema

485− , Has child schema ('Table table)

486− , Has parent schema ('Table reftable)

487− , HasAll columns (TableToColumns table) tys

488− , reftable ~ (constraints :=> cols)

489− , HasAll refcolumns cols reftys

490− , SOP.AllZip SamePGType tys reftys

491− , Uniquely refcolumns constraints )

492−

493−-- | `OnDeleteClause` indicates what to do with rows that reference a deleted row.

494−data OnDeleteClause

495− = OnDeleteNoAction

496− -- ^ if any referencing rows still exist when the constraint is checked,

497− -- an error is raised

498− | OnDeleteRestrict -- ^ prevents deletion of a referenced row

499− | OnDeleteCascade

500− -- ^ specifies that when a referenced row is deleted,

501− -- row(s) referencing it should be automatically deleted as well

502− deriving (GHC.Generic,Show,Eq,Ord)

503−instance NFData OnDeleteClause

504−-- | Render `OnDeleteClause`.

505−instance RenderSQL OnDeleteClause where

506− renderSQL = \case

507− OnDeleteNoAction -> "ON DELETE NO ACTION"

508− OnDeleteRestrict -> "ON DELETE RESTRICT"

509− OnDeleteCascade -> "ON DELETE CASCADE"

510−

511−-- | Analagous to `OnDeleteClause` there is also `OnUpdateClause` which is invoked

512−-- when a referenced column is changed (updated).

513−data OnUpdateClause

514− = OnUpdateNoAction

515− -- ^ if any referencing rows has not changed when the constraint is checked,

516− -- an error is raised

517− | OnUpdateRestrict -- ^ prevents update of a referenced row

518− | OnUpdateCascade

519− -- ^ the updated values of the referenced column(s) should be copied

520− -- into the referencing row(s)

521− deriving (GHC.Generic,Show,Eq,Ord)

522−instance NFData OnUpdateClause

523−

524−-- | Render `OnUpdateClause`.

525−instance RenderSQL OnUpdateClause where

526− renderSQL = \case

527− OnUpdateNoAction -> "ON UPDATE NO ACTION"

528− OnUpdateRestrict -> "ON UPDATE RESTRICT"

529− OnUpdateCascade -> "ON UPDATE CASCADE"

530−

531−{-----------------------------------------

532−DROP statements

533−-----------------------------------------}

534−

535−-- >>> :{

536−-- let

537−-- definition :: Definition '["muh_schema" ::: schema, "public" ::: public] '["public" ::: public]

538−-- definition = dropSchema #muh_schema

539−-- :}

540−--

541−-- >>> printSQL definition

542−-- DROP SCHEMA "muh_schema";

543−dropSchema

544− :: Has sch schemas schema

545− => Alias sch

546− -> Definition schemas (Drop sch schemas)

547−dropSchema sch = UnsafeDefinition $ "DROP SCHEMA" <+> renderSQL sch <> ";"

548−

549−-- | `dropTable` removes a table from the schema.

550−--

551−-- >>> :{

552−-- let

553−-- definition :: Definition '["public" ::: '["muh_table" ::: 'Table t]] (Public '[])

554−-- definition = dropTable #muh_table

555−-- :}

556−--

557−-- >>> printSQL definition

558−-- DROP TABLE "muh_table";

559−dropTable

560− :: ( Has sch schemas schema

561− , Has tab schema ('Table table))

562− => QualifiedAlias sch tab -- ^ table to remove

563− -> Definition schemas (Alter sch (Drop tab schema) schemas)

564−dropTable tab = UnsafeDefinition $ "DROP TABLE" <+> renderSQL tab <> ";"

565−

566−{-----------------------------------------

567−ALTER statements

568−-----------------------------------------}

569−

570−-- | `alterTable` changes the definition of a table from the schema.

571−alterTable

572− :: (Has sch schemas schema, Has tab schema ('Table table0))

573− => QualifiedAlias sch tab -- ^ table to alter

574− -> AlterTable sch tab schemas table1 -- ^ alteration to perform

575− -> Definition schemas (Alter sch (Alter tab ('Table table1) schema) schemas)

576−alterTable tab alteration = UnsafeDefinition $

577− "ALTER TABLE"

578− <+> renderSQL tab

579− <+> renderAlterTable alteration

580− <> ";"

581−

582−-- | `alterTableRename` changes the name of a table from the schema.

583−--

584−-- >>> printSQL $ alterTableRename #foo #bar

585−-- ALTER TABLE "foo" RENAME TO "bar";

586−alterTableRename

587− :: (KnownSymbol table0, KnownSymbol table1)

588− => Alias table0 -- ^ table to rename

589− -> Alias table1 -- ^ what to rename it

590− -> Definition schema (Rename table0 table1 schema)

591−alterTableRename table0 table1 = UnsafeDefinition $

592− "ALTER TABLE" <+> renderSQL table0

593− <+> "RENAME TO" <+> renderSQL table1 <> ";"

594−

595−-- | An `AlterTable` describes the alteration to perform on the columns

596−-- of a table.

597−newtype AlterTable

598− (sch :: Symbol)

599− (tab :: Symbol)

600− (schemas :: SchemasType)

601− (table :: TableType) =

602− UnsafeAlterTable {renderAlterTable :: ByteString}

603− deriving (GHC.Generic,Show,Eq,Ord,NFData)

604−

605−-- | An `addConstraint` adds a table constraint.

606−--

607−-- >>> :{

608−-- let

609−-- definition :: Definition

610−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

611−-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: 'Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

612−-- definition = alterTable #tab (addConstraint #positive (check #col (#col .> 0)))

613−-- in printSQL definition

614−-- :}

615−-- ALTER TABLE "tab" ADD CONSTRAINT "positive" CHECK (("col" > 0));

616−addConstraint

617− :: ( KnownSymbol alias

618− , Has sch schemas schema

619− , Has tab schema ('Table table0)

620− , table0 ~ (constraints :=> columns)

621− , table1 ~ (Create alias constraint constraints :=> columns) )

622− => Alias alias

623− -> TableConstraintExpression sch tab schemas constraint

624− -- ^ constraint to add

625− -> AlterTable sch tab schemas table1

626−addConstraint alias constraint = UnsafeAlterTable $

627− "ADD" <+> "CONSTRAINT" <+> renderSQL alias

628− <+> renderSQL constraint

629−

630−-- | A `dropConstraint` drops a table constraint.

631−--

632−-- >>> :{

633−-- let

634−-- definition :: Definition

635−-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

636−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

637−-- definition = alterTable #tab (dropConstraint #positive)

638−-- in printSQL definition

639−-- :}

640−-- ALTER TABLE "tab" DROP CONSTRAINT "positive";

641−dropConstraint

642− :: ( KnownSymbol constraint

643− , Has sch schemas schema

644− , Has tab schema ('Table table0)

645− , table0 ~ (constraints :=> columns)

646− , table1 ~ (Drop constraint constraints :=> columns) )

647− => Alias constraint

648− -- ^ constraint to drop

649− -> AlterTable sch tab schemas table1

650−dropConstraint constraint = UnsafeAlterTable $

651− "DROP" <+> "CONSTRAINT" <+> renderSQL constraint

652−

653−-- | An `AddColumn` is either @NULL@ or has @DEFAULT@.

654−class AddColumn ty where

655− -- | `addColumn` adds a new column, initially filled with whatever

656− -- default value is given or with @NULL@.

657− --

658− -- >>> :{

659− -- let

660− -- definition :: Definition

661− -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

662− -- '["public" ::: '["tab" ::: 'Table ('[] :=>

663− -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

664− -- , "col2" ::: 'Def :=> 'Null 'PGtext ])]]

665− -- definition = alterTable #tab (addColumn #col2 (text & nullable & default_ "foo"))

666− -- in printSQL definition

667− -- :}

668− -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL DEFAULT E'foo';

669− --

670− -- >>> :{

671− -- let

672− -- definition :: Definition

673− -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

674− -- '["public" ::: '["tab" ::: 'Table ('[] :=>

675− -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

676− -- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

677− -- definition = alterTable #tab (addColumn #col2 (text & nullable))

678− -- in printSQL definition

679− -- :}

680− -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL;

681− addColumn

682− :: ( KnownSymbol column

683− , Has sch schemas schema

684− , Has tab schema ('Table table0)

685− , table0 ~ (constraints :=> columns) )

686− => Alias column -- ^ column to add

687− -> ColumnTypeExpression schemas ty -- ^ type of the new column

688− -> AlterTable sch tab schemas (constraints :=> Create column ty columns)

689− addColumn column ty = UnsafeAlterTable $

690− "ADD COLUMN" <+> renderSQL column <+> renderColumnTypeExpression ty

691−instance {-# OVERLAPPING #-} AddColumn ('Def :=> ty)

692−instance {-# OVERLAPPABLE #-} AddColumn ('NoDef :=> 'Null ty)

693−

694−-- | A `dropColumn` removes a column. Whatever data was in the column

695−-- disappears. Table constraints involving the column are dropped, too.

696−-- However, if the column is referenced by a foreign key constraint of

697−-- another table, PostgreSQL will not silently drop that constraint.

698−--

699−-- >>> :{

700−-- let

701−-- definition :: Definition

702−-- '["public" ::: '["tab" ::: 'Table ('[] :=>

703−-- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

704−-- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

705−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

706−-- definition = alterTable #tab (dropColumn #col2)

707−-- in printSQL definition

708−-- :}

709−-- ALTER TABLE "tab" DROP COLUMN "col2";

710−dropColumn

711− :: ( KnownSymbol column

712− , Has sch schemas schema

713− , Has tab schema ('Table table0)

714− , table0 ~ (constraints :=> columns)

715− , table1 ~ (constraints :=> Drop column columns) )

716− => Alias column -- ^ column to remove

717− -> AlterTable sch tab schemas table1

718−dropColumn column = UnsafeAlterTable $

719− "DROP COLUMN" <+> renderSQL column

720−

721−-- | A `renameColumn` renames a column.

722−--

723−-- >>> :{

724−-- let

725−-- definition :: Definition

726−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["foo" ::: 'NoDef :=> 'Null 'PGint4])]]

727−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["bar" ::: 'NoDef :=> 'Null 'PGint4])]]

728−-- definition = alterTable #tab (renameColumn #foo #bar)

729−-- in printSQL definition

730−-- :}

731−-- ALTER TABLE "tab" RENAME COLUMN "foo" TO "bar";

732−renameColumn

733− :: ( KnownSymbol column0

734− , KnownSymbol column1

735− , Has sch schemas schema

736− , Has tab schema ('Table table0)

737− , table0 ~ (constraints :=> columns)

738− , table1 ~ (constraints :=> Rename column0 column1 columns) )

739− => Alias column0 -- ^ column to rename

740− -> Alias column1 -- ^ what to rename the column

741− -> AlterTable sch tab schemas table1

742−renameColumn column0 column1 = UnsafeAlterTable $

743− "RENAME COLUMN" <+> renderSQL column0 <+> "TO" <+> renderSQL column1

744−

745−-- | An `alterColumn` alters a single column.

746−alterColumn

747− :: ( KnownSymbol column

748− , Has sch schemas schema

749− , Has tab schema ('Table table0)

750− , table0 ~ (constraints :=> columns)

751− , Has column columns ty0

752− , table1 ~ (constraints :=> Alter column ty1 columns))

753− => Alias column -- ^ column to alter

754− -> AlterColumn schemas ty0 ty1 -- ^ alteration to perform

755− -> AlterTable sch tab schemas table1

756−alterColumn column alteration = UnsafeAlterTable $

757− "ALTER COLUMN" <+> renderSQL column <+> renderAlterColumn alteration

758−

759−-- | An `AlterColumn` describes the alteration to perform on a single column.

760−newtype AlterColumn (schemas :: SchemasType) (ty0 :: ColumnType) (ty1 :: ColumnType) =

761− UnsafeAlterColumn {renderAlterColumn :: ByteString}

762− deriving (GHC.Generic,Show,Eq,Ord,NFData)

763−

764−-- | A `setDefault` sets a new default for a column. Note that this doesn't

765−-- affect any existing rows in the table, it just changes the default for

766−-- future insert and update commands.

767−--

768−-- >>> :{

769−-- let

770−-- definition :: Definition

771−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

772−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]

773−-- definition = alterTable #tab (alterColumn #col (setDefault 5))

774−-- in printSQL definition

775−-- :}

776−-- ALTER TABLE "tab" ALTER COLUMN "col" SET DEFAULT 5;

777−setDefault

778− :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty -- ^ default value to set

779− -> AlterColumn schemas (constraint :=> ty) ('Def :=> ty)

780−setDefault expression = UnsafeAlterColumn $

781− "SET DEFAULT" <+> renderExpression expression

782−

783−-- | A `dropDefault` removes any default value for a column.

784−--

785−-- >>> :{

786−-- let

787−-- definition :: Definition

788−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]

789−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

790−-- definition = alterTable #tab (alterColumn #col dropDefault)

791−-- in printSQL definition

792−-- :}

793−-- ALTER TABLE "tab" ALTER COLUMN "col" DROP DEFAULT;

794−dropDefault :: AlterColumn schemas ('Def :=> ty) ('NoDef :=> ty)

795−dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"

796−

797−-- | A `setNotNull` adds a @NOT NULL@ constraint to a column.

798−-- The constraint will be checked immediately, so the table data must satisfy

799−-- the constraint before it can be added.

800−--

801−-- >>> :{

802−-- let

803−-- definition :: Definition

804−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

805−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

806−-- definition = alterTable #tab (alterColumn #col setNotNull)

807−-- in printSQL definition

808−-- :}

809−-- ALTER TABLE "tab" ALTER COLUMN "col" SET NOT NULL;

810−setNotNull

811− :: AlterColumn schemas (constraint :=> 'Null ty) (constraint :=> 'NotNull ty)

812−setNotNull = UnsafeAlterColumn $ "SET NOT NULL"

813−

814−-- | A `dropNotNull` drops a @NOT NULL@ constraint from a column.

815−--

816−-- >>> :{

817−-- let

818−-- definition :: Definition

819−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

820−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

821−-- definition = alterTable #tab (alterColumn #col dropNotNull)

822−-- in printSQL definition

823−-- :}

824−-- ALTER TABLE "tab" ALTER COLUMN "col" DROP NOT NULL;

825−dropNotNull

826− :: AlterColumn schemas (constraint :=> 'NotNull ty) (constraint :=> 'Null ty)

827−dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"

828−

829−-- | An `alterType` converts a column to a different data type.

830−-- This will succeed only if each existing entry in the column can be

831−-- converted to the new type by an implicit cast.

832−--

833−-- >>> :{

834−-- let

835−-- definition :: Definition

836−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

837−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGnumeric])]]

838−-- definition =

839−-- alterTable #tab (alterColumn #col (alterType (numeric & notNullable)))

840−-- in printSQL definition

841−-- :}

842−-- ALTER TABLE "tab" ALTER COLUMN "col" TYPE numeric NOT NULL;

843−alterType :: ColumnTypeExpression schemas ty -> AlterColumn schemas ty0 ty

844−alterType ty = UnsafeAlterColumn $ "TYPE" <+> renderColumnTypeExpression ty

845−

846−{- | Create a view.

847−>>> type ABC = '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4]

848−>>> type BC = '["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4]

849−>>> :{

850−let

851− definition :: Definition

852− '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC)]]

853− '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC), "bc" ::: 'View BC]]

854− definition =

855− createView #bc (select_ (#b :* #c) (from (table #abc)))

856−in printSQL definition

857−:}

858−CREATE VIEW "bc" AS SELECT "b" AS "b", "c" AS "c" FROM "abc" AS "abc";

859−-}

860−createView

861− :: (KnownSymbol sch, KnownSymbol vw, Has sch schemas schema)

862− => QualifiedAlias sch vw -- ^ the name of the view to add

863− -> Query '[] '[] schemas '[] view -- ^ query

864− -> Definition schemas (Alter sch (Create vw ('View view) schema) schemas)

865−createView alias query = UnsafeDefinition $

866− "CREATE" <+> "VIEW" <+> renderSQL alias <+> "AS"

867− <+> renderQuery query <> ";"

868−

869−-- | Drop a view.

870−--

871−-- >>> :{

872−-- let

873−-- definition :: Definition

874−-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])

875−-- , "bc" ::: 'View ('["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4])]]

876−-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])]]

877−-- definition = dropView #bc

878−-- in printSQL definition

879−-- :}

880−-- DROP VIEW "bc";

881−dropView

882− :: (Has sch schemas schema, Has vw schema ('View view))

883− => QualifiedAlias sch vw -- ^ view to remove

884− -> Definition schemas (Alter sch (Drop vw schema) schemas)

885−dropView vw = UnsafeDefinition $ "DROP VIEW" <+> renderSQL vw <> ";"

886−

887−-- | Enumerated types are created using the `createTypeEnum` command, for example

888−--

889−-- >>> printSQL $ (createTypeEnum #mood (label @"sad" :* label @"ok" :* label @"happy") :: Definition (Public '[]) '["public" ::: '["mood" ::: 'Typedef ('PGenum '["sad","ok","happy"])]])

890−-- CREATE TYPE "mood" AS ENUM ('sad', 'ok', 'happy');

891−createTypeEnum

892− :: (KnownSymbol enum, Has sch schemas schema, SOP.All KnownSymbol labels)

893− => QualifiedAlias sch enum

894− -- ^ name of the user defined enumerated type

895− -> NP PGlabel labels

896− -- ^ labels of the enumerated type

897− -> Definition schemas (Alter sch (Create enum ('Typedef ('PGenum labels)) schema) schemas)

898−createTypeEnum enum labels = UnsafeDefinition $

899− "CREATE" <+> "TYPE" <+> renderSQL enum <+> "AS" <+> "ENUM" <+>

900− parenthesized (renderSQL labels) <> ";"

901−

902−-- | Enumerated types can also be generated from a Haskell type, for example

903−--

904−-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

905−-- >>> instance SOP.Generic Schwarma

906−-- >>> instance SOP.HasDatatypeInfo Schwarma

907−-- >>> :{

908−-- let

909−-- createSchwarma :: Definition (Public '[]) '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]]

910−-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma

911−-- in

912−-- printSQL createSchwarma

913−-- :}

914−-- CREATE TYPE "schwarma" AS ENUM ('Beef', 'Lamb', 'Chicken');

915−createTypeEnumFrom

916− :: forall hask sch enum schemas schema.

917− ( SOP.Generic hask

918− , SOP.All KnownSymbol (LabelsPG hask)

919− , KnownSymbol enum

920− , Has sch schemas schema )

921− => QualifiedAlias sch enum

922− -- ^ name of the user defined enumerated type

923− -> Definition schemas (Alter sch (Create enum ('Typedef (PG (Enumerated hask))) schema) schemas)

924−createTypeEnumFrom enum = createTypeEnum enum

925− (SOP.hpure label :: NP PGlabel (LabelsPG hask))

926−

927−{- | `createTypeComposite` creates a composite type. The composite type is

928−specified by a list of attribute names and data types.

929−

930−>>> :{

931−type PGcomplex = 'PGcomposite

932− '[ "real" ::: 'NotNull 'PGfloat8

933− , "imaginary" ::: 'NotNull 'PGfloat8 ]

934−:}

935−

936−>>> :{

937−let

938− setup :: Definition (Public '[]) '["public" ::: '["complex" ::: 'Typedef PGcomplex]]

939− setup = createTypeComposite #complex

940− (float8 `as` #real :* float8 `as` #imaginary)

941−in printSQL setup

942−:}

943−CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

944−-}

945−createTypeComposite

946− :: (KnownSymbol ty, Has sch schemas schema, SOP.SListI fields)

947− => QualifiedAlias sch ty

948− -- ^ name of the user defined composite type

949− -> NP (Aliased (TypeExpression schemas)) fields

950− -- ^ list of attribute names and data types

951− -> Definition schemas (Alter sch (Create ty ('Typedef ('PGcomposite fields)) schema) schemas)

952−createTypeComposite ty fields = UnsafeDefinition $

953− "CREATE" <+> "TYPE" <+> renderSQL ty <+> "AS" <+> parenthesized

954− (renderCommaSeparated renderField fields) <> ";"

955− where

956− renderField :: Aliased (TypeExpression schemas) x -> ByteString

957− renderField (typ `As` alias) =

958− renderSQL alias <+> renderSQL typ

959−

960−-- | Composite types can also be generated from a Haskell type, for example

961−--

962−-- >>> data Complex = Complex {real :: Double, imaginary :: Double} deriving GHC.Generic

963−-- >>> instance SOP.Generic Complex

964−-- >>> instance SOP.HasDatatypeInfo Complex

965−-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]

966−-- >>> :{

967−-- let

968−-- createComplex :: Definition (Public '[]) (Public Schema)

969−-- createComplex = createTypeCompositeFrom @Complex #complex

970−-- in

971−-- printSQL createComplex

972−-- :}

973−-- CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

974−createTypeCompositeFrom

975− :: forall hask sch ty schemas schema.

976− ( SOP.All (FieldTyped schemas) (RowPG hask)

977− , KnownSymbol ty

978− , Has sch schemas schema )

979− => QualifiedAlias sch ty

980− -- ^ name of the user defined composite type

981− -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)

982−createTypeCompositeFrom ty = createTypeComposite ty

983− (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype

984− :: NP (Aliased (TypeExpression schemas)) (RowPG hask))

985−

986−{-|

987−`createDomain` creates a new domain. A domain is essentially a data type

988−with constraints (restrictions on the allowed set of values).

989−

990−Domains are useful for abstracting common constraints on fields

991−into a single location for maintenance. For example, several tables might

992−contain email address columns, all requiring the same `check` constraint

993−to verify the address syntax. Define a domain rather than setting up

994−each table's constraint individually.

995−

996−>>> :{

997−let

998− createPositive :: Definition (Public '[]) (Public '["positive" ::: 'Typedef 'PGfloat4])

999− createPositive = createDomain #positive real (#value .> 0 .&& (#value & isNotNull))

1000−in printSQL createPositive

1001−:}

1002−CREATE DOMAIN "positive" AS real CHECK ((("value" > 0) AND "value" IS NOT NULL));

1003−-}

1004−createDomain

1005− :: (Has sch schemas schema, KnownSymbol dom)

1006− => QualifiedAlias sch dom

1007− -> (forall nullity. TypeExpression schemas (nullity ty))

1008− -> (forall tab. Condition '[] '[] 'Ungrouped schemas '[] '[tab ::: '["value" ::: 'Null ty]])

1009− -> Definition schemas (Alter sch (Create alias ('Typedef ty) schema) schemas)

1010−createDomain dom ty condition =

1011− UnsafeDefinition $ "CREATE DOMAIN" <+> renderSQL dom

1012− <+> "AS" <+> renderTypeExpression ty

1013− <+> "CHECK" <+> parenthesized (renderSQL condition) <> ";"

1014−

1015−class FieldTyped schemas ty where

1016− fieldtype :: Aliased (TypeExpression schemas) ty

1017−instance (KnownSymbol alias, PGTyped schemas ty)

1018− => FieldTyped schemas (alias ::: ty) where

1019− fieldtype = pgtype `As` Alias

1020−

1021−-- | Drop a type.

1022−--

1023−-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

1024−-- >>> instance SOP.Generic Schwarma

1025−-- >>> instance SOP.HasDatatypeInfo Schwarma

1026−-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))

1027−-- DROP TYPE "schwarma";

1028−dropType

1029− :: (Has sch schemas schema, Has td schema ('Typedef ty))

1030− => QualifiedAlias sch td

1031− -- ^ name of the user defined type

1032− -> Definition schemas (Alter sch (Drop td schema) schemas)

1033−dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

1034−

1035−-- | `ColumnTypeExpression`s are used in `createTable` commands.

1036−newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)

1037− = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }

1038− deriving (GHC.Generic,Show,Eq,Ord,NFData)

1039−instance RenderSQL (ColumnTypeExpression schemas ty) where

1040− renderSQL = renderColumnTypeExpression

1041−

1042−-- | used in `createTable` commands as a column constraint to note that

1043−-- @NULL@ may be present in a column

1044−nullable

1045− :: TypeExpression schemas (nullity ty)

1046− -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)

1047−nullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NULL"

1048−

1049−-- | used in `createTable` commands as a column constraint to ensure

1050−-- @NULL@ is not present in a column

1051−notNullable

1052− :: TypeExpression schemas (nullity ty)

1053− -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)

1054−notNullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NOT NULL"

1055−

1056−-- | used in `createTable` commands as a column constraint to give a default

1057−default_

1058− :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty

1059− -> ColumnTypeExpression schemas ('NoDef :=> ty)

1060− -> ColumnTypeExpression schemas ('Def :=> ty)

1061−default_ x ty = UnsafeColumnTypeExpression $

1062− renderSQL ty <+> "DEFAULT" <+> renderExpression x

1063−

1064−-- | not a true type, but merely a notational convenience for creating

1065−-- unique identifier columns with type `PGint2`

1066−serial2, smallserial

1067− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)

1068−serial2 = UnsafeColumnTypeExpression "serial2"

1069−smallserial = UnsafeColumnTypeExpression "smallserial"

1070−-- | not a true type, but merely a notational convenience for creating

1071−-- unique identifier columns with type `PGint4`

1072−serial4, serial

1073− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)

1074−serial4 = UnsafeColumnTypeExpression "serial4"

1075−serial = UnsafeColumnTypeExpression "serial"

1076−-- | not a true type, but merely a notational convenience for creating

1077−-- unique identifier columns with type `PGint8`

1078−serial8, bigserial

1079− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)

1080−serial8 = UnsafeColumnTypeExpression "serial8"

1081−bigserial = UnsafeColumnTypeExpression "bigserial"

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

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

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

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

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

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

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

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+115−2237

@@ -1,14 +1,13 @@

1{-|

2Module: Squeal.PostgreSQL.Expression

3Description: Squeal expressions

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

8Squeal expressions are the atoms used to build statements.

9-}

11−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}

12{-# LANGUAGE

11{-# LANGUAGE

13 AllowAmbiguousTypes

12 AllowAmbiguousTypes

14 , ConstraintKinds

13 , ConstraintKinds

@@ -35,257 +34,54 @@ module Squeal.PostgreSQL.Expression

35 ( -- * Expression

34 ( -- * Expression

36 Expression (..)

35 Expression (..)

37 , Expr

36 , Expr

38− , (:-->)

37+ , type (-->)

38+ , FunctionDB

39 , unsafeFunction

40− , unsafeUnaryOpL

40+ , function

41− , unsafeUnaryOpR

41+ , unsafeLeftOp

42+ , leftOp

43+ , unsafeRightOp

44+ , rightOp

42 , Operator

45 , Operator

46+ , OperatorDB

43 , unsafeBinaryOp

47 , unsafeBinaryOp

48+ , binaryOp

44 , FunctionVar

49 , FunctionVar

45 , unsafeFunctionVar

50 , unsafeFunctionVar

46− , FunctionN

51+ , type (--->)

52+ , FunctionNDB

47 , unsafeFunctionN

53 , unsafeFunctionN

48− , Literal (..)

54+ , functionN

49− , HasParameter (parameter)

50− , param

51− -- * Null

52− , null_

53− , notNull

54− , coalesce

55− , fromNull

56− , isNull

57− , isNotNull

58− , matchNull

59− , nullIf

60− -- * Collections

61− , array

62− , array1

63− , array2

64− , cardinality

65− , index

66− , row

67− , field

68 , PGSubset (..)

55 , PGSubset (..)

69− -- * Numerical

56+ , PGIntersect (..)

70− , atan2_

71− , quot_

72− , rem_

73− , trunc

74− , round_

75− , ceiling_

76− -- * Logic

77− , Condition

78− , true

79− , false

80− , not_

81− , (.&&)

82− , (.||)

83− , caseWhenThenElse

84− , ifThenElse

85− -- * Comparison

86− , (.==)

87− , (./=)

88− , (.>=)

89− , (.<)

90− , (.<=)

91− , (.>)

92− , greatest

93− , least

94− , between

95− , notBetween

96− , betweenSymmetric

97− , notBetweenSymmetric

98− , isDistinctFrom

99− , isNotDistinctFrom

100− , isTrue

101− , isNotTrue

102− , isFalse

103− , isNotFalse

104− , isUnknown

105− , isNotUnknown

106− -- * Time

107− , TimeOp (..)

108− , currentDate

109− , currentTime

110− , currentTimestamp

111− , localTime

112− , localTimestamp

113− , now

114− , makeDate

115− , makeTime

116− , makeTimestamp

117− , makeTimestamptz

118− , interval_

119− , TimeUnit (..)

120− -- * Text

121− , lower

122− , upper

123− , charLength

124− , like

125− , ilike

126− -- * Json

127− -- ** Json and Jsonb operators

128− , (.->)

129− , (.->>)

130− , (.#>)

131− , (.#>>)

132− -- ** Jsonb operators

133− , (.?)

134− , (.?|)

135− , (.?&)

136− , (.-.)

137− , (#-.)

138− -- ** Functions

139− , toJson

140− , toJsonb

141− , arrayToJson

142− , rowToJson

143− , jsonBuildArray

144− , jsonbBuildArray

145− , PGBuildObject

146− , jsonBuildObject

147− , jsonbBuildObject

148− , jsonObject

149− , jsonbObject

150− , jsonZipObject

151− , jsonbZipObject

152− , jsonArrayLength

153− , jsonbArrayLength

154− , jsonExtractPath

155− , jsonbExtractPath

156− , jsonExtractPathAsText

157− , jsonbExtractPathAsText

158− , jsonTypeof

159− , jsonbTypeof

160− , jsonStripNulls

161− , jsonbStripNulls

162− , jsonbSet

163− , jsonbInsert

164− , jsonbPretty

165− -- * Text Search

166− , (@@)

167− , (.&)

168− , (.|)

169− , (.!)

170− , (<->)

171− , arrayToTSvector

172− , tsvectorLength

173− , numnode

174− , plainToTSquery

175− , phraseToTSquery

176− , websearchToTSquery

177− , queryTree

178− , toTSquery

179− , toTSvector

180− , setWeight

181− , strip

182− , jsonToTSvector

183− , jsonbToTSvector

184− , tsDelete

185− , tsFilter

186− , tsHeadline

187− -- * Aggregation

188− , Aggregate (..)

189− , Distinction (..)

190− , PGAvg

191− -- * Window Functions

192− , WindowDefinition (..)

193− , partitionBy

194− , WindowFunction (..)

195− , rank

196− , rowNumber

197− , denseRank

198− , percentRank

199− , cumeDist

200− , ntile

201− , lag

202− , lead

203− , firstValue

204− , lastValue

205− , nthValue

206− -- * Sorting

207− , SortExpression (..)

208− , OrderBy (..)

209− -- * Types

210− , TypeExpression (..)

211− , cast

212− , PGTyped (..)

213− , typedef

214− , typetable

215− , typeview

216− , bool

217− , int2

218− , smallint

219− , int4

220− , int

221− , integer

222− , int8

223− , bigint

224− , numeric

225− , float4

226− , real

227− , float8

228− , doublePrecision

229− , money

230− , text

231− , char

232− , character

233− , varchar

234− , characterVarying

235− , bytea

236− , timestamp

237− , timestampWithTimeZone

238− , date

239− , time

240− , timeWithTimeZone

241− , interval

242− , uuid

243− , inet

244− , json

245− , jsonb

246− , vararray

247− , fixarray

248− , tsvector

249− , tsquery

250 -- * Re-export

57 -- * Re-export

251 , (&)

58 , (&)

252− , NP (..)

253 , K (..)

59 , K (..)

60+ , unK

254 ) where

61 ) where

255

256import Control.Category

63import Control.Category

257import Control.DeepSeq

64import Control.DeepSeq

258import Data.ByteString (ByteString)

65import Data.ByteString (ByteString)

259−import Data.ByteString.Lazy (toStrict)

260−import ByteString.StrictBuilder (builderBytes)

261import Data.Function ((&))

66import Data.Function ((&))

262−import Data.Kind

263import Data.Semigroup hiding (All)

67import Data.Semigroup hiding (All)

264−import qualified Data.Aeson as JSON

265−import Data.Int

266import Data.String

68import Data.String

267−import Data.Text (Text)

268−import Data.Word

269import Generics.SOP hiding (All, from)

69import Generics.SOP hiding (All, from)

270import GHC.OverloadedLabels

70import GHC.OverloadedLabels

271import GHC.TypeLits

71import GHC.TypeLits

272import Numeric

72import Numeric

273import Prelude hiding (id, (.))

73import Prelude hiding (id, (.))

274

275−import qualified Data.ByteString as ByteString

276−import qualified Data.Text as Text

277−import qualified Data.Text.Lazy as Lazy (Text)

278−import qualified Data.Text.Lazy as Lazy.Text

279import qualified GHC.Generics as GHC

75import qualified GHC.Generics as GHC

280−import qualified Generics.SOP as SOP

281

282import Squeal.PostgreSQL.Alias

77import Squeal.PostgreSQL.Alias

283−import Squeal.PostgreSQL.Binary

284import Squeal.PostgreSQL.List

78import Squeal.PostgreSQL.List

285−import Squeal.PostgreSQL.PG

286import Squeal.PostgreSQL.Render

79import Squeal.PostgreSQL.Render

287import Squeal.PostgreSQL.Schema

80import Squeal.PostgreSQL.Schema

288

82+-- $setup

83+-- >>> import Squeal.PostgreSQL

84+

289{-----------------------------------------

85{-----------------------------------------

290column expressions

86column expressions

291-----------------------------------------}

87-----------------------------------------}

@@ -295,7 +91,7 @@ such as in the target `Squeal.PostgreSQL.Query.List` of the

295`Squeal.PostgreSQL.Query.select` command,

91`Squeal.PostgreSQL.Query.select` command,

296as new column values in `Squeal.PostgreSQL.Manipulation.insertRow` or

92as new column values in `Squeal.PostgreSQL.Manipulation.insertRow` or

297`Squeal.PostgreSQL.Manipulation.update`,

93`Squeal.PostgreSQL.Manipulation.update`,

298−or in search `Condition`s in a number of commands.

94+or in search `Squeal.PostgreSQL.Logic.Condition`s in a number of commands.

299

300The expression syntax allows the calculation of

96The expression syntax allows the calculation of

301values from primitive expression using arithmetic, logical,

97values from primitive expression using arithmetic, logical,

@@ -329,7 +125,7 @@ instance RenderSQL (Expression outer commons grp schemas params from ty) where

329 renderSQL = renderExpression

125 renderSQL = renderExpression

330

126

331-- | An `Expr` is a closed `Expression`.

127-- | An `Expr` is a closed `Expression`.

332−-- It is a F`RankNType` but don't be scared.

128+-- It is a F@RankNType@ but don't be scared.

333-- Think of it as an expression which sees no

129-- Think of it as an expression which sees no

334-- namespaces, so you can't use parameters

130-- namespaces, so you can't use parameters

335-- or alias references. It can be used as

131-- or alias references. It can be used as

@@ -339,7 +135,7 @@ type Expr x

339 . Expression outer commons grp schemas params from x

135 . Expression outer commons grp schemas params from x

340 -- ^ cannot reference aliases

136 -- ^ cannot reference aliases

341

137

342−-- | A `RankNType` for binary operators.

138+-- | A @RankNType@ for binary operators.

343type Operator x1 x2 y

139type Operator x1 x2 y

344 = forall outer commons grp schemas params from

140 = forall outer commons grp schemas params from

345 . Expression outer commons grp schemas params from x1

141 . Expression outer commons grp schemas params from x1

@@ -349,32 +145,55 @@ type Operator x1 x2 y

349 -> Expression outer commons grp schemas params from y

145 -> Expression outer commons grp schemas params from y

350 -- ^ output

146 -- ^ output

351

147

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+

352−-- | A `RankNType` for functions with a single argument.

157+-- | A @RankNType@ for functions with a single argument.

353-- These could be either function calls or unary operators.

158-- These could be either function calls or unary operators.

354-- This is a subtype of the usual Haskell function type `Prelude.->`,

159-- This is a subtype of the usual Haskell function type `Prelude.->`,

355-- indeed a subcategory as it is closed under the usual

160-- indeed a subcategory as it is closed under the usual

356-- `Prelude..` and `Prelude.id`.

161-- `Prelude..` and `Prelude.id`.

357−type (:-->) x y

162+type (-->) x y

358 = forall outer commons grp schemas params from

163 = forall outer commons grp schemas params from

359 . Expression outer commons grp schemas params from x

164 . Expression outer commons grp schemas params from x

360 -- ^ input

165 -- ^ input

361 -> Expression outer commons grp schemas params from y

166 -> Expression outer commons grp schemas params from y

362 -- ^ output

167 -- ^ output

363

168

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+

364−{- | A `RankNType` for functions with a fixed-length list of heterogeneous arguments.

176+{- | A @RankNType@ for functions with a fixed-length list of heterogeneous arguments.

365Use the `*:` operator to end your argument lists, like so.

177Use the `*:` operator to end your argument lists, like so.

366

178

367>>> printSQL (unsafeFunctionN "fun" (true :* false :* localTime *: true))

179>>> printSQL (unsafeFunctionN "fun" (true :* false :* localTime *: true))

368fun(TRUE, FALSE, LOCALTIME, TRUE)

180fun(TRUE, FALSE, LOCALTIME, TRUE)

369-}

181-}

370−type FunctionN xs y

182+type (--->) xs y

371 = forall outer commons grp schemas params from

183 = forall outer commons grp schemas params from

372 . NP (Expression outer commons grp schemas params from) xs

184 . NP (Expression outer commons grp schemas params from) xs

373 -- ^ inputs

185 -- ^ inputs

374 -> Expression outer commons grp schemas params from y

186 -> Expression outer commons grp schemas params from y

375 -- ^ output

187 -- ^ output

376

188

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+

377−{- | A `RankNType` for functions with a variable-length list of

196+{- | A @RankNType@ for functions with a variable-length list of

378homogeneous arguments and at least 1 more argument.

197homogeneous arguments and at least 1 more argument.

379-}

198-}

380type FunctionVar x0 x1 y

199type FunctionVar x0 x1 y

@@ -393,46 +212,6 @@ unsafeFunctionVar :: ByteString -> FunctionVar x0 x1 y

393unsafeFunctionVar fun xs x = UnsafeExpression $ fun <> parenthesized

212unsafeFunctionVar fun xs x = UnsafeExpression $ fun <> parenthesized

394 (commaSeparated (renderSQL <$> xs) <> ", " <> renderSQL x)

213 (commaSeparated (renderSQL <$> xs) <> ", " <> renderSQL x)

395

214

396−{- | A `HasParameter` constraint is used to indicate a value that is

397−supplied externally to a SQL statement.

398−`Squeal.PostgreSQL.PQ.manipulateParams`,

399−`Squeal.PostgreSQL.PQ.queryParams` and

400−`Squeal.PostgreSQL.PQ.traversePrepared` support specifying data values

401−separately from the SQL command string, in which case `param`s are used to

402−refer to the out-of-line data values.

403−-}

404−class KnownNat n => HasParameter

405− (n :: Nat)

406− (params :: [NullityType])

407− (ty :: NullityType)

408− | n params -> ty where

409− -- | `parameter` takes a `Nat` using type application and a `TypeExpression`.

410− --

411− -- >>> let expr = parameter @1 int4 :: Expression outer '[] grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)

412− -- >>> printSQL expr

413− -- ($1 :: int4)

414− parameter

415− :: TypeExpression schemas ty

416− -> Expression outer commons grp schemas params from ty

417− parameter ty = UnsafeExpression $ parenthesized $

418− "$" <> renderNat @n <+> "::"

419− <+> renderSQL ty

420−instance {-# OVERLAPPING #-} HasParameter 1 (ty1:tys) ty1

421−instance {-# OVERLAPPABLE #-} (KnownNat n, HasParameter (n-1) params ty)

422− => HasParameter n (ty' : params) ty

423−

424−-- | `param` takes a `Nat` using type application and for basic types,

425−-- infers a `TypeExpression`.

426−--

427−-- >>> let expr = param @1 :: Expression outer commons grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)

428−-- >>> printSQL expr

429−-- ($1 :: int4)

430−param

431− :: forall n outer commons schemas params from grp ty

432− . (PGTyped schemas ty, HasParameter n params ty)

433− => Expression outer commons grp schemas params from ty -- ^ param

434−param = parameter @n (pgtype @schemas)

435−

436instance (HasUnique tab (Join outer from) row, Has col row ty)

215instance (HasUnique tab (Join outer from) row, Has col row ty)

437 => IsLabel col (Expression outer commons 'Ungrouped schemas params from ty) where

216 => IsLabel col (Expression outer commons 'Ungrouped schemas params from ty) where

438 fromLabel = UnsafeExpression $ renderSQL (Alias @col)

217 fromLabel = UnsafeExpression $ renderSQL (Alias @col)

@@ -529,242 +308,73 @@ instance

529 (NP (Aliased (Expression outer commons ('Grouped bys) schemas params from)) columns) where

308 (NP (Aliased (Expression outer commons ('Grouped bys) schemas params from)) columns) where

530 tab ! col = tab ! col :* Nil

309 tab ! col = tab ! col :* Nil

531

310

532−-- | analagous to `Nothing`

533−--

534−-- >>> printSQL null_

535−-- NULL

536−null_ :: Expr ('Null ty)

537−null_ = UnsafeExpression "NULL"

538−

539−-- | analagous to `Just`

540−--

541−-- >>> printSQL $ notNull true

542−-- TRUE

543−notNull :: 'NotNull ty :--> 'Null ty

544−notNull = UnsafeExpression . renderSQL

545−

546−-- | return the leftmost value which is not NULL

547−--

548−-- >>> printSQL $ coalesce [null_, true] false

549−-- COALESCE(NULL, TRUE, FALSE)

550−coalesce :: FunctionVar ('Null ty) ('NotNull ty) ('NotNull ty)

551−coalesce nullxs notNullx = UnsafeExpression $

552− "COALESCE" <> parenthesized (commaSeparated

553− ((renderSQL <$> nullxs) <> [renderSQL notNullx]))

554−

555−-- | analagous to `Data.Maybe.fromMaybe` using @COALESCE@

556−--

557−-- >>> printSQL $ fromNull true null_

558−-- COALESCE(NULL, TRUE)

559−fromNull

560− :: Expression outer commons grp schemas params from ('NotNull ty)

561− -- ^ what to convert @NULL@ to

562− -> Expression outer commons grp schemas params from ('Null ty)

563− -> Expression outer commons grp schemas params from ('NotNull ty)

564−fromNull notNullx nullx = coalesce [nullx] notNullx

565−

566−-- | >>> printSQL $ null_ & isNull

567−-- NULL IS NULL

568−isNull :: 'Null ty :--> null 'PGbool

569−isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"

570−

571−-- | >>> printSQL $ null_ & isNotNull

572−-- NULL IS NOT NULL

573−isNotNull :: 'Null ty :--> null 'PGbool

574−isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"

575−

576−-- | analagous to `maybe` using @IS NULL@

577−--

578−-- >>> printSQL $ matchNull true not_ null_

579−-- CASE WHEN NULL IS NULL THEN TRUE ELSE (NOT NULL) END

580−matchNull

581− :: Expression outer commons grp schemas params from (nullty)

582− -- ^ what to convert @NULL@ to

583− -> ( Expression outer commons grp schemas params from ('NotNull ty)

584− -> Expression outer commons grp schemas params from (nullty) )

585− -- ^ function to perform when @NULL@ is absent

586− -> Expression outer commons grp schemas params from ('Null ty)

587− -> Expression outer commons grp schemas params from (nullty)

588−matchNull y f x = ifThenElse (isNull x) y

589− (f (UnsafeExpression (renderSQL x)))

590−

591−{-| right inverse to `fromNull`, if its arguments are equal then

592−`nullIf` gives @NULL@.

593−

594−>>> :set -XTypeApplications -XDataKinds

595−>>> let expr = nullIf (false *: param @1) :: Expression outer commons grp schemas '[ 'NotNull 'PGbool] from ('Null 'PGbool)

596−>>> printSQL expr

597−NULLIF(FALSE, ($1 :: bool))

598−-}

599−nullIf :: FunctionN '[ 'NotNull ty, 'NotNull ty] ('Null ty)

600−nullIf = unsafeFunctionN "NULLIF"

601−

602−-- | >>> printSQL $ array [null_, false, true]

603−-- ARRAY[NULL, FALSE, TRUE]

604−array

605− :: [Expression outer commons grp schemas params from ty]

606− -- ^ array elements

607− -> Expression outer commons grp schemas params from (null ('PGvararray ty))

608−array xs = UnsafeExpression $ "ARRAY" <>

609− bracketed (commaSeparated (renderSQL <$> xs))

610−

611−{- | construct a 1-dimensional fixed length array

612−

613−>>> printSQL $ array1 (null_ :* false *: true)

614−ARRAY[NULL, FALSE, TRUE]

615−

616−>>> :type array1 (null_ :* false *: true)

617−array1 (null_ :* false *: true)

618− :: Expression

619− outer

620− commons

621− grp

622− schemas

623− params

624− from

625− (null ('PGfixarray '[3] ('Null 'PGbool)))

626−-}

627−array1

628− :: (n ~ Length tys, SOP.All ((~) ty) tys)

629− => NP (Expression outer commons grp schemas params from) tys

630− -> Expression outer commons grp schemas params from (null ('PGfixarray '[n] ty))

631−array1 xs = UnsafeExpression $ "ARRAY" <>

632− bracketed (renderCommaSeparated renderSQL xs)

633−

634−{- | construct a 2-dimensional fixed length array

635−

636−>>> printSQL $ array2 ((null_ :* false *: true) *: (false :* null_ *: true))

637−ARRAY[[NULL, FALSE, TRUE], [FALSE, NULL, TRUE]]

638−

639−>>> :type array2 ((null_ :* false *: true) *: (false :* null_ *: true))

640−array2 ((null_ :* false *: true) *: (false :* null_ *: true))

641− :: Expression

642− outer

643− commons

644− grp

645− schemas

646− params

647− from

648− (null ('PGfixarray '[2, 3] ('Null 'PGbool)))

649−-}

650−array2

651− :: ( SOP.All ((~) tys) tyss

652− , SOP.All SOP.SListI tyss

653− , Length tyss ~ n1

654− , SOP.All ((~) ty) tys

655− , Length tys ~ n2 )

656− => NP (NP (Expression outer commons grp schemas params from)) tyss

657− -> Expression outer commons grp schemas params from (null ('PGfixarray '[n1,n2] ty))

658−array2 xss = UnsafeExpression $ "ARRAY" <>

659− bracketed (renderCommaSeparatedConstraint @SOP.SListI (bracketed . renderCommaSeparated renderSQL) xss)

660−

661−-- | >>> printSQL $ cardinality (array [null_, false, true])

662−-- cardinality(ARRAY[NULL, FALSE, TRUE])

663−cardinality :: null ('PGvararray ty) :--> null 'PGint8

664−cardinality = unsafeFunction "cardinality"

665−

666−-- | >>> printSQL $ array [null_, false, true] & index 2

667−-- (ARRAY[NULL, FALSE, TRUE])[2]

668−index

669− :: Word64 -- ^ index

670− -> null ('PGvararray ty) :--> NullifyType ty

671−index n expr = UnsafeExpression $

672− parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"

673−

674instance (KnownSymbol label, label `In` labels) => IsPGlabel label

311instance (KnownSymbol label, label `In` labels) => IsPGlabel label

675 (Expression outer commons grp schemas params from (null ('PGenum labels))) where

312 (Expression outer commons grp schemas params from (null ('PGenum labels))) where

676 label = UnsafeExpression $ renderSQL (PGlabel @label)

313 label = UnsafeExpression $ renderSQL (PGlabel @label)

677

314

678−-- | A row constructor is an expression that builds a row value

679−-- (also called a composite value) using values for its member fields.

680−--

681−-- >>> :{

682−-- type Complex = 'PGcomposite

683−-- '[ "real" ::: 'NotNull 'PGfloat8

684−-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

685−-- :}

686−--

687−-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression outer commons grp schemas params from ('NotNull Complex)

688−-- >>> printSQL i

689−-- ROW(0, 1)

690−row

691− :: SListI row

692− => NP (Aliased (Expression outer commons grp schemas params from)) row

693− -- ^ zero or more expressions for the row field values

694− -> Expression outer commons grp schemas params from (null ('PGcomposite row))

695−row exprs = UnsafeExpression $ "ROW" <> parenthesized

696− (renderCommaSeparated (\ (expr `As` _) -> renderSQL expr) exprs)

697−

698−-- | >>> :{

699−-- type Complex = 'PGcomposite

700−-- '[ "real" ::: 'NotNull 'PGfloat8

701−-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

702−-- type Schema = '["complex" ::: 'Typedef Complex]

703−-- :}

704−--

705−-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression outer '[] grp (Public Schema) from params ('NotNull Complex)

706−-- >>> printSQL $ i & field #complex #imaginary

707−-- (ROW(0, 1)::"complex")."imaginary"

708−field

709− :: ( Has sch schemas schema

710− , Has tydef schema ('Typedef ('PGcomposite row))

711− , Has field row ty)

712− => QualifiedAlias sch tydef -- ^ row type

713− -> Alias field -- ^ field name

714− -> Expression outer commons grp schemas params from ('NotNull ('PGcomposite row))

715− -> Expression outer commons grp schemas params from ty

716−field td fld expr = UnsafeExpression $

717− parenthesized (renderSQL expr <> "::" <> renderSQL td)

718− <> "." <> renderSQL fld

719−

720−instance Semigroup

721− (Expression outer commons grp schemas params from (null ('PGvararray ty))) where

722− (<>) = unsafeBinaryOp "||"

723−

724−instance Monoid

725− (Expression outer commons grp schemas params from (null ('PGvararray ty))) where

726− mempty = array []

727− mappend = (<>)

728−

729−-- | >>> let expr = greatest [param @1] currentTimestamp :: Expression outer commons grp schemas '[ 'NotNull 'PGtimestamptz] from ('NotNull 'PGtimestamptz)

730−-- >>> printSQL expr

731−-- GREATEST(($1 :: timestamp with time zone), CURRENT_TIMESTAMP)

732−greatest :: FunctionVar ty ty ty

733−greatest = unsafeFunctionVar "GREATEST"

734−

735−-- | >>> printSQL $ least [null_] currentTimestamp

736−-- LEAST(NULL, CURRENT_TIMESTAMP)

737−least :: FunctionVar ty ty ty

738−least = unsafeFunctionVar "LEAST"

739−

740-- | >>> printSQL $ unsafeBinaryOp "OR" true false

315-- | >>> printSQL $ unsafeBinaryOp "OR" true false

741-- (TRUE OR FALSE)

316-- (TRUE OR FALSE)

742unsafeBinaryOp :: ByteString -> Operator ty0 ty1 ty2

317unsafeBinaryOp :: ByteString -> Operator ty0 ty1 ty2

743unsafeBinaryOp op x y = UnsafeExpression $ parenthesized $

318unsafeBinaryOp op x y = UnsafeExpression $ parenthesized $

744 renderSQL x <+> op <+> renderSQL y

319 renderSQL x <+> op <+> renderSQL y

745

320

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+

746−-- | >>> printSQL $ unsafeUnaryOpL "NOT" true

328+-- | >>> printSQL $ unsafeLeftOp "NOT" true

747-- (NOT TRUE)

329-- (NOT TRUE)

748−unsafeUnaryOpL :: ByteString -> x :--> y

330+unsafeLeftOp :: ByteString -> x --> y

749−unsafeUnaryOpL op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x

331+unsafeLeftOp op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x

750

332

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+

751−-- | >>> printSQL $ true & unsafeUnaryOpR "IS NOT TRUE"

340+-- | >>> printSQL $ true & unsafeRightOp "IS NOT TRUE"

752-- (TRUE IS NOT TRUE)

341-- (TRUE IS NOT TRUE)

753−unsafeUnaryOpR :: ByteString -> x :--> y

342+unsafeRightOp :: ByteString -> x --> y

754−unsafeUnaryOpR op x = UnsafeExpression $ parenthesized $ renderSQL x <+> op

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

755

351

756-- | >>> printSQL $ unsafeFunction "f" true

352-- | >>> printSQL $ unsafeFunction "f" true

757-- f(TRUE)

353-- f(TRUE)

758−unsafeFunction :: ByteString -> x :--> y

354+unsafeFunction :: ByteString -> x --> y

759unsafeFunction fun x = UnsafeExpression $

355unsafeFunction fun x = UnsafeExpression $

760 fun <> parenthesized (renderSQL x)

356 fun <> parenthesized (renderSQL x)

761

357

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+

762-- | >>> printSQL $ unsafeFunctionN "f" (currentTime :* localTimestamp :* false *: literal 'a')

364-- | >>> printSQL $ unsafeFunctionN "f" (currentTime :* localTimestamp :* false *: literal 'a')

763-- f(CURRENT_TIME, LOCALTIMESTAMP, FALSE, E'a')

365-- f(CURRENT_TIME, LOCALTIMESTAMP, FALSE, E'a')

764−unsafeFunctionN :: SListI xs => ByteString -> FunctionN xs y

366+unsafeFunctionN :: SListI xs => ByteString -> xs ---> y

765unsafeFunctionN fun xs = UnsafeExpression $

367unsafeFunctionN fun xs = UnsafeExpression $

766 fun <> parenthesized (renderCommaSeparated renderSQL xs)

368 fun <> parenthesized (renderCommaSeparated renderSQL xs)

767

369

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+

768instance ty `In` PGNum

378instance ty `In` PGNum

769 => Num (Expression outer commons grp schemas params from (null ty)) where

379 => Num (Expression outer commons grp schemas params from (null ty)) where

770 (+) = unsafeBinaryOp "+"

380 (+) = unsafeBinaryOp "+"

@@ -809,364 +419,22 @@ instance (ty `In` PGNum, ty `In` PGFloating) => Floating

809 acosh x = log (x + sqrt (x*x - 1))

419 acosh x = log (x + sqrt (x*x - 1))

810 atanh x = log ((1 + x) / (1 - x)) / 2

420 atanh x = log ((1 + x) / (1 - x)) / 2

811

421

812−-- | >>> :{

422+-- | Contained by operators

813−-- let

423+class PGSubset ty where

814−-- expression :: Expr (null 'PGfloat4)

424+ (@>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

815−-- expression = atan2_ (pi *: 2)

425+ (@>) = unsafeBinaryOp "@>"

816−-- in printSQL expression

426+ (<@) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

817−-- :}

427+ (<@) = unsafeBinaryOp "<@"

818−-- atan2(pi(), 2)

428+instance PGSubset 'PGjsonb

819−atan2_

429+instance PGSubset 'PGtsquery

820− :: float `In` PGFloating

430+instance PGSubset ('PGvararray ty)

821− => FunctionN '[ null float, null float] (null float)

431+instance PGSubset ('PGrange ty)

822−atan2_ = unsafeFunctionN "atan2"

823−

824−-- When a `cast` is applied to an `Expression` of a known type, it

825−-- represents a run-time type conversion. The cast will succeed only if a

826−-- suitable type conversion operation has been defined.

827−--

828−-- | >>> printSQL $ true & cast int4

829−-- (TRUE :: int4)

830−cast

831− :: TypeExpression schemas ty1

832− -- ^ type to cast as

833− -> Expression outer commons grp schemas params from ty0

834− -- ^ value to convert

835− -> Expression outer commons grp schemas params from ty1

836−cast ty x = UnsafeExpression $ parenthesized $

837− renderSQL x <+> "::" <+> renderSQL ty

838−

839−-- | integer division, truncates the result

840−--

841−-- >>> :{

842−-- let

843−-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

844−-- expression = 5 `quot_` 2

845−-- in printSQL expression

846−-- :}

847−-- (5 / 2)

848−quot_

849− :: int `In` PGIntegral

850− => Operator (null int) (null int) (null int)

851−quot_ = unsafeBinaryOp "/"

852−

853−-- | remainder upon integer division

854−--

855−-- >>> :{

856−-- let

857−-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

858−-- expression = 5 `rem_` 2

859−-- in printSQL expression

860−-- :}

861−-- (5 % 2)

862−rem_

863− :: int `In` PGIntegral

864− => Operator (null int) (null int) (null int)

865−rem_ = unsafeBinaryOp "%"

866−

867−-- | >>> :{

868−-- let

869−-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

870−-- expression = trunc pi

871−-- in printSQL expression

872−-- :}

873−-- trunc(pi())

874−trunc :: frac `In` PGFloating => null frac :--> null frac

875−trunc = unsafeFunction "trunc"

876−

877−-- | >>> :{

878−-- let

879−-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

880−-- expression = round_ pi

881−-- in printSQL expression

882−-- :}

883−-- round(pi())

884−round_ :: frac `In` PGFloating => null frac :--> null frac

885−round_ = unsafeFunction "round"

886−

887−-- | >>> :{

888−-- let

889−-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

890−-- expression = ceiling_ pi

891−-- in printSQL expression

892−-- :}

893−-- ceiling(pi())

894−ceiling_ :: frac `In` PGFloating => null frac :--> null frac

895−ceiling_ = unsafeFunction "ceiling"

896−

897−-- | A `Condition` is an `Expression`, which can evaluate

898−-- to `true`, `false` or `null_`. This is because SQL uses

899−-- a three valued logic.

900−type Condition outer commons grp schemas params from =

901− Expression outer commons grp schemas params from ('Null 'PGbool)

902−

903−-- | >>> printSQL true

904−-- TRUE

905−true :: Expr (null 'PGbool)

906−true = UnsafeExpression "TRUE"

907−

908−-- | >>> printSQL false

909−-- FALSE

910−false :: Expr (null 'PGbool)

911−false = UnsafeExpression "FALSE"

912−

913−-- | >>> printSQL $ not_ true

914−-- (NOT TRUE)

915−not_ :: null 'PGbool :--> null 'PGbool

916−not_ = unsafeUnaryOpL "NOT"

917−

918−-- | >>> printSQL $ true .&& false

919−-- (TRUE AND FALSE)

920−(.&&) :: Operator (null 'PGbool) (null 'PGbool) (null 'PGbool)

921−infixr 3 .&&

922−(.&&) = unsafeBinaryOp "AND"

923−

924−-- | >>> printSQL $ true .|| false

925−-- (TRUE OR FALSE)

926−(.||) :: Operator (null 'PGbool) (null 'PGbool) (null 'PGbool)

927−infixr 2 .||

928−(.||) = unsafeBinaryOp "OR"

929−

930−-- | >>> :{

931−-- let

932−-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

933−-- expression = caseWhenThenElse [(true, 1), (false, 2)] 3

934−-- in printSQL expression

935−-- :}

936−-- CASE WHEN TRUE THEN 1 WHEN FALSE THEN 2 ELSE 3 END

937−caseWhenThenElse

938− :: [ ( Condition outer commons grp schemas params from

939− , Expression outer commons grp schemas params from ty

940− ) ]

941− -- ^ whens and thens

942− -> Expression outer commons grp schemas params from ty

943− -- ^ else

944− -> Expression outer commons grp schemas params from ty

945−caseWhenThenElse whenThens else_ = UnsafeExpression $ mconcat

946− [ "CASE"

947− , mconcat

948− [ mconcat

949− [ " WHEN ", renderSQL when_

950− , " THEN ", renderSQL then_

951− ]

952− | (when_,then_) <- whenThens

953− ]

954− , " ELSE ", renderSQL else_

955− , " END"

956− ]

957−

958−-- | >>> :{

959−-- let

960−-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

961−-- expression = ifThenElse true 1 0

962−-- in printSQL expression

963−-- :}

964−-- CASE WHEN TRUE THEN 1 ELSE 0 END

965−ifThenElse

966− :: Condition outer commons grp schemas params from

967− -> Expression outer commons grp schemas params from ty -- ^ then

968− -> Expression outer commons grp schemas params from ty -- ^ else

969− -> Expression outer commons grp schemas params from ty

970−ifThenElse if_ then_ else_ = caseWhenThenElse [(if_,then_)] else_

971−

972−-- | Comparison operations like `.==`, `./=`, `.>`, `.>=`, `.<` and `.<=`

973−-- will produce @NULL@s if one of their arguments is @NULL@.

974−--

975−-- >>> printSQL $ true .== null_

976−-- (TRUE = NULL)

977−(.==) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

978−(.==) = unsafeBinaryOp "="

979−infix 4 .==

980−

981−-- | >>> printSQL $ true ./= null_

982−-- (TRUE <> NULL)

983−(./=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

984−(./=) = unsafeBinaryOp "<>"

985−infix 4 ./=

986−

987−-- | >>> printSQL $ true .>= null_

988−-- (TRUE >= NULL)

989−(.>=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

990−(.>=) = unsafeBinaryOp ">="

991−infix 4 .>=

992−

993−-- | >>> printSQL $ true .< null_

994−-- (TRUE < NULL)

995−(.<) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

996−(.<) = unsafeBinaryOp "<"

997−infix 4 .<

998−

999−-- | >>> printSQL $ true .<= null_

1000−-- (TRUE <= NULL)

1001−(.<=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

1002−(.<=) = unsafeBinaryOp "<="

1003−infix 4 .<=

1004−

1005−-- | >>> printSQL $ true .> null_

1006−-- (TRUE > NULL)

1007−(.>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

1008−(.>) = unsafeBinaryOp ">"

1009−infix 4 .>

1010−

1011−{- | >>> printSQL $ true `between` (null_, false)

1012−TRUE BETWEEN NULL AND FALSE

1013−-}

1014−between

1015− :: Expression outer commons grp schemas params from (null ty)

1016− -> ( Expression outer commons grp schemas params from (null ty)

1017− , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds

1018− -> Condition outer commons grp schemas params from

1019−between a (x,y) = UnsafeExpression $ renderSQL a <+> "BETWEEN"

1020− <+> renderSQL x <+> "AND" <+> renderSQL y

1021−

1022−{- | >>> printSQL $ true `notBetween` (null_, false)

1023−TRUE NOT BETWEEN NULL AND FALSE

1024−-}

1025−notBetween

1026− :: Expression outer commons grp schemas params from (null ty)

1027− -> ( Expression outer commons grp schemas params from (null ty)

1028− , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds

1029− -> Condition outer commons grp schemas params from

1030−notBetween a (x,y) = UnsafeExpression $ renderSQL a <+> "NOT BETWEEN"

1031− <+> renderSQL x <+> "AND" <+> renderSQL y

1032−

1033−{- | between, after sorting the comparison values

1034−

1035−>>> printSQL $ true `betweenSymmetric` (null_, false)

1036−TRUE BETWEEN SYMMETRIC NULL AND FALSE

1037−-}

1038−betweenSymmetric

1039− :: Expression outer commons grp schemas params from (null ty)

1040− -> ( Expression outer commons grp schemas params from (null ty)

1041− , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds

1042− -> Condition outer commons grp schemas params from

1043−betweenSymmetric a (x,y) = UnsafeExpression $ renderSQL a

1044− <+> "BETWEEN SYMMETRIC" <+> renderSQL x <+> "AND" <+> renderSQL y

1045−

1046−{- | not between, after sorting the comparison values

1047−

1048−>>> printSQL $ true `notBetweenSymmetric` (null_, false)

1049−TRUE NOT BETWEEN SYMMETRIC NULL AND FALSE

1050−-}

1051−notBetweenSymmetric

1052− :: Expression outer commons grp schemas params from (null ty)

1053− -> ( Expression outer commons grp schemas params from (null ty)

1054− , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds

1055− -> Condition outer commons grp schemas params from

1056−notBetweenSymmetric a (x,y) = UnsafeExpression $ renderSQL a

1057− <+> "NOT BETWEEN SYMMETRIC" <+> renderSQL x <+> "AND" <+> renderSQL y

1058−

1059−{- | not equal, treating null like an ordinary value

1060−

1061−>>> printSQL $ true `isDistinctFrom` null_

1062−(TRUE IS DISTINCT FROM NULL)

1063−-}

1064−isDistinctFrom :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

1065−isDistinctFrom = unsafeBinaryOp "IS DISTINCT FROM"

1066−

1067−{- | equal, treating null like an ordinary value

1068−

1069−>>> printSQL $ true `isNotDistinctFrom` null_

1070−(TRUE IS NOT DISTINCT FROM NULL)

1071−-}

1072−isNotDistinctFrom :: Operator (null0 ty) (null1 ty) ('NotNull 'PGbool)

1073−isNotDistinctFrom = unsafeBinaryOp "IS NOT DISTINCT FROM"

1074−

1075−{- | is true

1076−

1077−>>> printSQL $ true & isTrue

1078−(TRUE IS TRUE)

1079−-}

1080−isTrue :: null0 'PGbool :--> null1 'PGbool

1081−isTrue = unsafeUnaryOpR "IS TRUE"

1082−

1083−{- | is false or unknown

1084−

1085−>>> printSQL $ true & isNotTrue

1086−(TRUE IS NOT TRUE)

1087−-}

1088−isNotTrue :: null0 'PGbool :--> null1 'PGbool

1089−isNotTrue = unsafeUnaryOpR "IS NOT TRUE"

1090−

1091−{- | is false

1092−

1093−>>> printSQL $ true & isFalse

1094−(TRUE IS FALSE)

1095−-}

1096−isFalse :: null0 'PGbool :--> null1 'PGbool

1097−isFalse = unsafeUnaryOpR "IS FALSE"

1098−

1099−{- | is true or unknown

1100−

1101−>>> printSQL $ true & isNotFalse

1102−(TRUE IS NOT FALSE)

1103−-}

1104−isNotFalse :: null0 'PGbool :--> null1 'PGbool

1105−isNotFalse = unsafeUnaryOpR "IS NOT FALSE"

1106−

1107−{- | is unknown

1108−

1109−>>> printSQL $ true & isUnknown

1110−(TRUE IS UNKNOWN)

1111−-}

1112−isUnknown :: null0 'PGbool :--> null1 'PGbool

1113−isUnknown = unsafeUnaryOpR "IS UNKNOWN"

1114−

1115−{- | is true or false

1116−

1117−>>> printSQL $ true & isNotUnknown

1118−(TRUE IS NOT UNKNOWN)

1119−-}

1120−isNotUnknown :: null0 'PGbool :--> null1 'PGbool

1121−isNotUnknown = unsafeUnaryOpR "IS NOT UNKNOWN"

1122−

1123−-- | >>> printSQL currentDate

1124−-- CURRENT_DATE

1125−currentDate :: Expr (null 'PGdate)

1126−currentDate = UnsafeExpression "CURRENT_DATE"

1127−

1128−-- | >>> printSQL currentTime

1129−-- CURRENT_TIME

1130−currentTime :: Expr (null 'PGtimetz)

1131−currentTime = UnsafeExpression "CURRENT_TIME"

1132−

1133−-- | >>> printSQL currentTimestamp

1134−-- CURRENT_TIMESTAMP

1135−currentTimestamp :: Expr (null 'PGtimestamptz)

1136−currentTimestamp = UnsafeExpression "CURRENT_TIMESTAMP"

1137−

1138−-- | >>> printSQL localTime

1139−-- LOCALTIME

1140−localTime :: Expr (null 'PGtime)

1141−localTime = UnsafeExpression "LOCALTIME"

1142−

1143−-- | >>> printSQL localTimestamp

1144−-- LOCALTIMESTAMP

1145−localTimestamp :: Expr (null 'PGtimestamp)

1146−localTimestamp = UnsafeExpression "LOCALTIMESTAMP"

1147−

1148−-- | Current date and time (equivalent to `currentTimestamp`)

1149−--

1150−-- >>> printSQL now

1151−-- now()

1152−now :: Expr (null 'PGtimestamptz)

1153−now = UnsafeExpression "now()"

1154−

1155−{-----------------------------------------

1156−text

1157−-----------------------------------------}

1158

432

1159−escape :: Char -> String

433+class PGIntersect ty where

1160−escape = \case

434+ (@&&) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

1161− '\NUL' -> "\\0"

435+ (@&&) = unsafeBinaryOp "&&"

1162− '\'' -> "''"

436+instance PGIntersect ('PGvararray ty)

1163− '"' -> "\\\""

437+instance PGIntersect ('PGrange ty)

1164− '\b' -> "\\b"

1165− '\n' -> "\\n"

1166− '\r' -> "\\r"

1167− '\t' -> "\\t"

1168− '\\' -> "\\\\"

1169− c -> [c]

1170

438

1171instance IsString

439instance IsString

1172 (Expression outer commons grp schemas params from (null 'PGtext)) where

440 (Expression outer commons grp schemas params from (null 'PGtext)) where

@@ -1174,13 +442,19 @@ instance IsString

1174 "E\'" <> fromString (escape =<< str) <> "\'"

442 "E\'" <> fromString (escape =<< str) <> "\'"

1175instance IsString

443instance IsString

1176 (Expression outer commons grp schemas params from (null 'PGtsvector)) where

444 (Expression outer commons grp schemas params from (null 'PGtsvector)) where

1177− fromString str = cast tsvector . UnsafeExpression $

445+ fromString str = UnsafeExpression . parenthesized . (<> " :: tsvector") $

1178 "E\'" <> fromString (escape =<< str) <> "\'"

446 "E\'" <> fromString (escape =<< str) <> "\'"

1179instance IsString

447instance IsString

1180 (Expression outer commons grp schemas params from (null 'PGtsquery)) where

448 (Expression outer commons grp schemas params from (null 'PGtsquery)) where

1181− fromString str = cast tsquery . UnsafeExpression $

449+ fromString str = UnsafeExpression . parenthesized . (<> " :: tsquery") $

1182 "E\'" <> fromString (escape =<< str) <> "\'"

450 "E\'" <> fromString (escape =<< str) <> "\'"

1183

451

452+instance Semigroup

453+ (Expression outer commons grp schemas params from (null ('PGvararray ty))) where

454+ (<>) = unsafeBinaryOp "||"

455+instance Semigroup

456+ (Expression outer commons grp schemas params from (null 'PGjsonb)) where

457+ (<>) = unsafeBinaryOp "||"

1184instance Semigroup

458instance Semigroup

1185 (Expression outer commons grp schemas params from (null 'PGtext)) where

459 (Expression outer commons grp schemas params from (null 'PGtext)) where

1186 (<>) = unsafeBinaryOp "||"

460 (<>) = unsafeBinaryOp "||"

@@ -1196,1399 +470,3 @@ instance Monoid

1196 (Expression outer commons grp schemas params from (null 'PGtsvector)) where

470 (Expression outer commons grp schemas params from (null 'PGtsvector)) where

1197 mempty = fromString ""

471 mempty = fromString ""

1198 mappend = (<>)

472 mappend = (<>)

1199−

1200−-- | >>> printSQL $ lower "ARRRGGG"

1201−-- lower(E'ARRRGGG')

1202−lower :: null 'PGtext :--> null 'PGtext

1203−lower = unsafeFunction "lower"

1204−

1205−-- | >>> printSQL $ upper "eeee"

1206−-- upper(E'eeee')

1207−upper :: null 'PGtext :--> null 'PGtext

1208−upper = unsafeFunction "upper"

1209−

1210−-- | >>> printSQL $ charLength "four"

1211−-- char_length(E'four')

1212−charLength :: null 'PGtext :--> null 'PGint4

1213−charLength = unsafeFunction "char_length"

1214−

1215−-- | The `like` expression returns true if the @string@ matches

1216−-- the supplied @pattern@. If @pattern@ does not contain percent signs

1217−-- or underscores, then the pattern only represents the string itself;

1218−-- in that case `like` acts like the equals operator. An underscore (_)

1219−-- in pattern stands for (matches) any single character; a percent sign (%)

1220−-- matches any sequence of zero or more characters.

1221−--

1222−-- >>> printSQL $ "abc" `like` "a%"

1223−-- (E'abc' LIKE E'a%')

1224−like :: Operator (null 'PGtext) (null 'PGtext) ('Null 'PGbool)

1225−like = unsafeBinaryOp "LIKE"

1226−

1227−-- | The key word ILIKE can be used instead of LIKE to make the

1228−-- match case-insensitive according to the active locale.

1229−--

1230−-- >>> printSQL $ "abc" `ilike` "a%"

1231−-- (E'abc' ILIKE E'a%')

1232−ilike :: Operator (null 'PGtext) (null 'PGtext) ('Null 'PGbool)

1233−ilike = unsafeBinaryOp "ILIKE"

1234−

1235−{-----------------------------------------

1236− -- json and jsonb support

1237−

1238−See https://www.postgresql.org/docs/10/static/functions-json.html -- most

1239−comments lifted directly from this page.

1240−

1241−Table 9.44: json and jsonb operators

1242−-----------------------------------------}

1243−

1244−-- | Get JSON value (object field or array element) at a key.

1245−(.->)

1246− :: (json `In` PGJsonType, key `In` PGJsonKey)

1247− => Operator (null json) (null key) ('Null json)

1248−infixl 8 .->

1249−(.->) = unsafeBinaryOp "->"

1250−

1251−-- | Get JSON value (object field or array element) at a key, as text.

1252−(.->>)

1253− :: (json `In` PGJsonType, key `In` PGJsonKey)

1254− => Operator (null json) (null key) ('Null 'PGtext)

1255−infixl 8 .->>

1256−(.->>) = unsafeBinaryOp "->>"

1257−

1258−-- | Get JSON value at a specified path.

1259−(.#>)

1260− :: json `In` PGJsonType

1261− => Operator (null json) (null ('PGvararray ('NotNull 'PGtext))) ('Null json)

1262−infixl 8 .#>

1263−(.#>) = unsafeBinaryOp "#>"

1264−

1265−-- | Get JSON value at a specified path as text.

1266−(.#>>)

1267− :: json `In` PGJsonType

1268− => Operator (null json) (null ('PGvararray ('NotNull 'PGtext))) ('Null 'PGtext)

1269−infixl 8 .#>>

1270−(.#>>) = unsafeBinaryOp "#>>"

1271−

1272−-- Additional jsonb operators

1273−

1274−class PGSubset container where

1275− (@>) :: Operator (null0 container) (null1 container) ('Null 'PGbool)

1276− (@>) = unsafeBinaryOp "@>"

1277− (<@) :: Operator (null0 container) (null1 container) ('Null 'PGbool)

1278− (<@) = unsafeBinaryOp "<@"

1279−instance PGSubset 'PGjsonb

1280−instance PGSubset 'PGtsquery

1281−instance PGSubset ('PGvararray ty)

1282−

1283−-- | Does the string exist as a top-level key within the JSON value?

1284−(.?) :: Operator (null 'PGjsonb) (null 'PGtext) ('Null 'PGbool)

1285−infixl 9 .?

1286−(.?) = unsafeBinaryOp "?"

1287−

1288−-- | Do any of these array strings exist as top-level keys?

1289−(.?|) :: Operator

1290− (null 'PGjsonb)

1291− (null ('PGvararray ('NotNull 'PGtext)))

1292− ('Null 'PGbool)

1293−infixl 9 .?|

1294−(.?|) = unsafeBinaryOp "?|"

1295−

1296−-- | Do all of these array strings exist as top-level keys?

1297−(.?&) :: Operator

1298− (null 'PGjsonb)

1299− (null ('PGvararray ('NotNull 'PGtext)))

1300− ('Null 'PGbool)

1301−infixl 9 .?&

1302−(.?&) = unsafeBinaryOp "?&"

1303−

1304−instance Semigroup

1305− (Expression outer commons grp schemas params from (null 'PGjsonb)) where

1306− (<>) = unsafeBinaryOp "||"

1307−

1308−-- | Delete a key or keys from a JSON object, or remove an array element.

1309−--

1310−-- If the right operand is..

1311−--

1312−-- @ text @: Delete key/value pair or string element from left operand. Key/value pairs

1313−-- are matched based on their key value.

1314−--

1315−-- @ text[] @: Delete multiple key/value pairs or string elements

1316−-- from left operand. Key/value pairs are matched based on their key value.

1317−--

1318−-- @ integer @: Delete the array element with specified index (Negative integers

1319−-- count from the end). Throws an error if top level container is not an array.

1320−(.-.)

1321− :: (key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]) -- hlint error without parens here

1322− => Operator (null 'PGjsonb) (null key) (null 'PGjsonb)

1323−infixl 6 .-.

1324−(.-.) = unsafeBinaryOp "-"

1325−

1326−-- | Delete the field or element with specified path (for JSON arrays, negative

1327−-- integers count from the end)

1328−(#-.) :: Operator (null 'PGjsonb) (null ('PGvararray ('NotNull 'PGtext))) (null 'PGjsonb)

1329−infixl 6 #-.

1330−(#-.) = unsafeBinaryOp "#-"

1331−

1332−{-----------------------------------------

1333−Table 9.45: JSON creation functions

1334−-----------------------------------------}

1335−

1336−-- | Returns the value as json. Arrays and composites are converted

1337−-- (recursively) to arrays and objects; otherwise, if there is a cast from the

1338−-- type to json, the cast function will be used to perform the conversion;

1339−-- otherwise, a scalar value is produced. For any scalar type other than a

1340−-- number, a Boolean, or a null value, the text representation will be used, in

1341−-- such a fashion that it is a valid json value.

1342−toJson :: null ty :--> null 'PGjson

1343−toJson = unsafeFunction "to_json"

1344−

1345−-- | Returns the value as jsonb. Arrays and composites are converted

1346−-- (recursively) to arrays and objects; otherwise, if there is a cast from the

1347−-- type to json, the cast function will be used to perform the conversion;

1348−-- otherwise, a scalar value is produced. For any scalar type other than a

1349−-- number, a Boolean, or a null value, the text representation will be used, in

1350−-- such a fashion that it is a valid jsonb value.

1351−toJsonb :: null ty :--> null 'PGjsonb

1352−toJsonb = unsafeFunction "to_jsonb"

1353−

1354−-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

1355−-- becomes a JSON array of arrays.

1356−arrayToJson :: null ('PGvararray ty) :--> null 'PGjson

1357−arrayToJson = unsafeFunction "array_to_json"

1358−

1359−-- | Returns the row as a JSON object.

1360−rowToJson :: null ('PGcomposite ty) :--> null 'PGjson

1361−rowToJson = unsafeFunction "row_to_json"

1362−

1363−-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

1364−-- argument list.

1365−jsonBuildArray :: SListI tuple => FunctionN tuple (null 'PGjson)

1366−jsonBuildArray = unsafeFunctionN "json_build_array"

1367−

1368−-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

1369−-- variadic argument list.

1370−jsonbBuildArray :: SListI tuple => FunctionN tuple (null 'PGjsonb)

1371−jsonbBuildArray = unsafeFunctionN "jsonb_build_array"

1372−

1373−class PGBuildObject tys where

1374−instance PGBuildObject '[]

1375−instance (PGBuildObject tys, key `In` PGJsonKey)

1376− => PGBuildObject ('NotNull key ': value ': tys)

1377−

1378−-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

1379−-- argument list. The elements of the argument list must alternate between text

1380−-- and values.

1381−jsonBuildObject

1382− :: (SListI elems, PGBuildObject elems)

1383− => FunctionN elems (null 'PGjson)

1384−jsonBuildObject = unsafeFunctionN "json_build_object"

1385−

1386−-- | Builds a possibly-heterogeneously-typed (binary) JSON object out of a

1387−-- variadic argument list. The elements of the argument list must alternate

1388−-- between keys and values.

1389−jsonbBuildObject

1390− :: (SListI elems, PGBuildObject elems)

1391− => FunctionN elems (null 'PGjsonb)

1392−jsonbBuildObject = unsafeFunctionN "jsonb_build_object"

1393−

1394−-- | Builds a JSON object out of a text array.

1395−-- The array must have two dimensions

1396−-- such that each inner array has exactly two elements,

1397−-- which are taken as a key/value pair.

1398−jsonObject

1399− :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

1400− :--> null 'PGjson

1401−jsonObject = unsafeFunction "json_object"

1402−

1403−-- | Builds a binary JSON object out of a text array.

1404−-- The array must have two dimensions

1405−-- such that each inner array has exactly two elements,

1406−-- which are taken as a key/value pair.

1407−jsonbObject

1408− :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

1409− :--> null 'PGjsonb

1410−jsonbObject = unsafeFunction "jsonb_object"

1411−

1412−-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

1413−-- keys and one for values, that are zipped pairwise to create a JSON object.

1414−jsonZipObject :: FunctionN

1415− '[ null ('PGvararray ('NotNull 'PGtext))

1416− , null ('PGvararray ('NotNull 'PGtext)) ]

1417− ( null 'PGjson )

1418−jsonZipObject = unsafeFunctionN "json_object"

1419−

1420−-- | This is an alternate form of 'jsonbObject' that takes two arrays; one for

1421−-- keys and one for values, that are zipped pairwise to create a binary JSON

1422−-- object.

1423−jsonbZipObject :: FunctionN

1424− '[ null ('PGvararray ('NotNull 'PGtext))

1425− , null ('PGvararray ('NotNull 'PGtext)) ]

1426− ( null 'PGjsonb )

1427−jsonbZipObject = unsafeFunctionN "jsonb_object"

1428−

1429−{-----------------------------------------

1430−Table 9.46: JSON processing functions

1431−-----------------------------------------}

1432−

1433−-- | Returns the number of elements in the outermost JSON array.

1434−jsonArrayLength :: null 'PGjson :--> null 'PGint4

1435−jsonArrayLength = unsafeFunction "json_array_length"

1436−

1437−-- | Returns the number of elements in the outermost binary JSON array.

1438−jsonbArrayLength :: null 'PGjsonb :--> null 'PGint4

1439−jsonbArrayLength = unsafeFunction "jsonb_array_length"

1440−

1441−-- | Returns JSON value pointed to by the given path (equivalent to #>

1442−-- operator).

1443−jsonExtractPath

1444− :: SListI elems

1445− => Expression outer commons grp schemas params from (null 'PGjson)

1446− -> NP (Expression outer commons grp schemas params from) elems

1447− -> Expression outer commons grp schemas params from (null 'PGjsonb)

1448−jsonExtractPath x xs =

1449− unsafeFunctionN "json_extract_path" (x :* xs)

1450−

1451−-- | Returns JSON value pointed to by the given path (equivalent to #>

1452−-- operator).

1453−jsonbExtractPath

1454− :: SListI elems

1455− => Expression outer commons grp schemas params from (null 'PGjsonb)

1456− -> NP (Expression outer commons grp schemas params from) elems

1457− -> Expression outer commons grp schemas params from (null 'PGjsonb)

1458−jsonbExtractPath x xs =

1459− unsafeFunctionN "jsonb_extract_path" (x :* xs)

1460−

1461−-- | Returns JSON value pointed to by the given path (equivalent to #>

1462−-- operator), as text.

1463−jsonExtractPathAsText

1464− :: SListI elems

1465− => Expression outer commons grp schemas params from (null 'PGjson)

1466− -> NP (Expression outer commons grp schemas params from) elems

1467− -> Expression outer commons grp schemas params from (null 'PGjson)

1468−jsonExtractPathAsText x xs =

1469− unsafeFunctionN "json_extract_path_text" (x :* xs)

1470−

1471−-- | Returns JSON value pointed to by the given path (equivalent to #>

1472−-- operator), as text.

1473−jsonbExtractPathAsText

1474− :: SListI elems

1475− => Expression outer commons grp schemas params from (null 'PGjsonb)

1476− -> NP (Expression outer commons grp schemas params from) elems

1477− -> Expression outer commons grp schemas params from (null 'PGjsonb)

1478−jsonbExtractPathAsText x xs =

1479− unsafeFunctionN "jsonb_extract_path_text" (x :* xs)

1480−

1481−-- | Returns the type of the outermost JSON value as a text string. Possible

1482−-- types are object, array, string, number, boolean, and null.

1483−jsonTypeof :: null 'PGjson :--> null 'PGtext

1484−jsonTypeof = unsafeFunction "json_typeof"

1485−

1486−-- | Returns the type of the outermost binary JSON value as a text string.

1487−-- Possible types are object, array, string, number, boolean, and null.

1488−jsonbTypeof :: null 'PGjsonb :--> null 'PGtext

1489−jsonbTypeof = unsafeFunction "jsonb_typeof"

1490−

1491−-- | Returns its argument with all object fields that have null values omitted.

1492−-- Other null values are untouched.

1493−jsonStripNulls :: null 'PGjson :--> null 'PGjson

1494−jsonStripNulls = unsafeFunction "json_strip_nulls"

1495−

1496−-- | Returns its argument with all object fields that have null values omitted.

1497−-- Other null values are untouched.

1498−jsonbStripNulls :: null 'PGjsonb :--> null 'PGjsonb

1499−jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

1500−

1501−-- | @ jsonbSet target path new_value create_missing @

1502−--

1503−-- Returns target with the section designated by path replaced by new_value,

1504−-- or with new_value added if create_missing is true ( default is true) and the

1505−-- item designated by path does not exist. As with the path orientated

1506−-- operators, negative integers that appear in path count from the end of JSON

1507−-- arrays.

1508−jsonbSet

1509− :: Expression outer commons grp schemas params from (null 'PGjsonb)

1510− -> Expression outer commons grp schemas params from (null ('PGvararray ('NotNull 'PGtext)))

1511− -> Expression outer commons grp schemas params from (null 'PGjsonb)

1512− -> Maybe (Expression outer commons grp schemas params from (null 'PGbool))

1513− -> Expression outer commons grp schemas params from (null 'PGjsonb)

1514−jsonbSet tgt path val createMissing = case createMissing of

1515− Just m -> unsafeFunctionN "jsonb_set" (tgt :* path :* val :* m :* Nil)

1516− Nothing -> unsafeFunctionN "jsonb_set" (tgt :* path :* val :* Nil)

1517−

1518−-- | @ jsonbInsert target path new_value insert_after @

1519−--

1520−-- Returns target with new_value inserted. If target section designated by

1521−-- path is in a JSONB array, new_value will be inserted before target or after

1522−-- if insert_after is true (default is false). If target section designated by

1523−-- path is in JSONB object, new_value will be inserted only if target does not

1524−-- exist. As with the path orientated operators, negative integers that appear

1525−-- in path count from the end of JSON arrays.

1526−jsonbInsert

1527− :: Expression outer commons grp schemas params from (null 'PGjsonb)

1528− -> Expression outer commons grp schemas params from (null ('PGvararray ('NotNull 'PGtext)))

1529− -> Expression outer commons grp schemas params from (null 'PGjsonb)

1530− -> Maybe (Expression outer commons grp schemas params from (null 'PGbool))

1531− -> Expression outer commons grp schemas params from (null 'PGjsonb)

1532−jsonbInsert tgt path val insertAfter = case insertAfter of

1533− Just i -> unsafeFunctionN "jsonb_insert" (tgt :* path :* val :* i :* Nil)

1534− Nothing -> unsafeFunctionN "jsonb_insert" (tgt :* path :* val :* Nil)

1535−

1536−-- | Returns its argument as indented JSON text.

1537−jsonbPretty :: null 'PGjsonb :--> null 'PGtext

1538−jsonbPretty = unsafeFunction "jsonb_pretty"

1539−

1540−(@@) :: Operator (null 'PGtsvector) (null 'PGtsquery) ('Null 'PGbool)

1541−(@@) = unsafeBinaryOp "@@"

1542−

1543−(.&) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

1544−(.&) = unsafeBinaryOp "&&"

1545−

1546−(.|) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

1547−(.|) = unsafeBinaryOp "||"

1548−

1549−(.!) :: null 'PGtsquery :--> null 'PGtsquery

1550−(.!) = unsafeUnaryOpL "!!"

1551−

1552−(<->) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

1553−(<->) = unsafeBinaryOp "<->"

1554−

1555−arrayToTSvector

1556− :: null ('PGvararray ('NotNull 'PGtext))

1557− :--> null 'PGtsvector

1558−arrayToTSvector = unsafeFunction "array_to_tsvector"

1559−

1560−tsvectorLength :: null 'PGtsvector :--> null 'PGint4

1561−tsvectorLength = unsafeFunction "length"

1562−

1563−numnode :: null 'PGtsquery :--> null 'PGint4

1564−numnode = unsafeFunction "numnode"

1565−

1566−plainToTSquery :: null 'PGtext :--> null 'PGtsquery

1567−plainToTSquery = unsafeFunction "plainto_tsquery"

1568−

1569−phraseToTSquery :: null 'PGtext :--> null 'PGtsquery

1570−phraseToTSquery = unsafeFunction "phraseto_tsquery"

1571−

1572−websearchToTSquery :: null 'PGtext :--> null 'PGtsquery

1573−websearchToTSquery = unsafeFunction "websearch_to_tsquery"

1574−

1575−queryTree :: null 'PGtsquery :--> null 'PGtext

1576−queryTree = unsafeFunction "query_tree"

1577−

1578−toTSquery :: null 'PGtext :--> null 'PGtsquery

1579−toTSquery = unsafeFunction "to_tsquery"

1580−

1581−toTSvector

1582− :: ty `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

1583− => null ty :--> null 'PGtsvector

1584−toTSvector = unsafeFunction "to_tsvector"

1585−

1586−setWeight

1587− :: FunctionN '[null 'PGtsvector, null ('PGchar 1)] (null 'PGtsvector)

1588−setWeight = unsafeFunctionN "set_weight"

1589−

1590−strip :: null 'PGtsvector :--> null 'PGtsvector

1591−strip = unsafeFunction "strip"

1592−

1593−jsonToTSvector :: FunctionN '[null 'PGjson, null 'PGjson] (null 'PGtsvector)

1594−jsonToTSvector = unsafeFunctionN "json_to_tsvector"

1595−

1596−jsonbToTSvector :: FunctionN '[null 'PGjsonb, null 'PGjsonb] (null 'PGtsvector)

1597−jsonbToTSvector = unsafeFunctionN "jsonb_to_tsvector"

1598−

1599−tsDelete :: FunctionN

1600− '[null 'PGtsvector, null ('PGvararray ('NotNull 'PGtext))]

1601− (null 'PGtsvector)

1602−tsDelete = unsafeFunctionN "ts_delete"

1603−

1604−tsFilter :: FunctionN

1605− '[null 'PGtsvector, null ('PGvararray ('NotNull ('PGchar 1)))]

1606− (null 'PGtsvector)

1607−tsFilter = unsafeFunctionN "ts_filter"

1608−

1609−tsHeadline

1610− :: document `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

1611− => FunctionN '[null document, null 'PGtsquery] (null 'PGtext)

1612−tsHeadline = unsafeFunctionN "ts_headline"

1613−{-----------------------------------------

1614−aggregation

1615−-----------------------------------------}

1616−

1617−unsafeAggregateN

1618− :: SOP.SListI xs

1619− => ByteString -- ^ function

1620− -> Distinction (NP (Expression outer commons 'Ungrouped schemas params from)) xs

1621− -> Expression outer commons ('Grouped bys) schemas params from y

1622−unsafeAggregateN fun xs = UnsafeExpression $ fun <> parenthesized (renderSQL xs)

1623−

1624−{- |

1625−`Aggregate` functions compute a single result from a set of input values.

1626−`Aggregate` functions can be used as `GroupedBy` `Expression`s as well

1627−as `WindowFunction`s.

1628−-}

1629−class Aggregate expr1 exprN aggr

1630− | aggr -> expr1, aggr -> exprN where

1631−

1632− -- | A special aggregation that does not require an input

1633− --

1634− -- >>> :{

1635− -- let

1636− -- expression :: Expression '[] commons ('Grouped bys) schemas params from ('NotNull 'PGint8)

1637− -- expression = countStar

1638− -- in printSQL expression

1639− -- :}

1640− -- count(*)

1641− countStar :: aggr ('NotNull 'PGint8)

1642−

1643− -- | >>> :{

1644− -- let

1645− -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null ty]] ('NotNull 'PGint8)

1646− -- expression = count (All #col)

1647− -- in printSQL expression

1648− -- :}

1649− -- count(ALL "col")

1650− count

1651− :: expr1 ty

1652− -- ^ what to count

1653− -> aggr ('NotNull 'PGint8)

1654−

1655− -- | >>> :{

1656− -- let

1657− -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('NotNull 'PGnumeric)

1658− -- expression = sum_ (Distinct #col)

1659− -- in printSQL expression

1660− -- :}

1661− -- sum(DISTINCT "col")

1662− sum_

1663− :: ty `In` PGNum

1664− => expr1 (null ty)

1665− -> aggr ('NotNull ty)

1666−

1667− -- | input values, including nulls, concatenated into an array

1668− arrayAgg

1669− :: expr1 ty

1670− -> aggr ('Null ('PGvararray ty))

1671−

1672− -- | aggregates values as a JSON array

1673− jsonAgg

1674− :: expr1 ty

1675− -> aggr ('Null 'PGjson)

1676−

1677− -- | aggregates values as a JSON array

1678− jsonbAgg

1679− :: expr1 ty

1680− -> aggr ('Null 'PGjsonb)

1681−

1682− {- |

1683− the bitwise AND of all non-null input values, or null if none

1684− >>> :{

1685− let

1686− expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

1687− expression = bitAnd (Distinct #col)

1688− in printSQL expression

1689− :}

1690− bit_and(DISTINCT "col")

1691− -}

1692− bitAnd

1693− :: int `In` PGIntegral

1694− => expr1 (null int)

1695− -- ^ what to aggregate

1696− -> aggr ('Null int)

1697−

1698− {- |

1699− the bitwise OR of all non-null input values, or null if none

1700−

1701− >>> :{

1702− let

1703− expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

1704− expression = bitOr (All #col)

1705− in printSQL expression

1706− :}

1707− bit_or(ALL "col")

1708− -}

1709− bitOr

1710− :: int `In` PGIntegral

1711− => expr1 (null int)

1712− -- ^ what to aggregate

1713− -> aggr ('Null int)

1714−

1715− {- |

1716− true if all input values are true, otherwise false

1717−

1718− >>> :{

1719− let

1720− winFun :: WindowFunction '[] commons 'Ungrouped schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

1721− winFun = boolAnd #col

1722− in printSQL winFun

1723− :}

1724− bool_and("col")

1725− -}

1726− boolAnd

1727− :: expr1 (null 'PGbool)

1728− -- ^ what to aggregate

1729− -> aggr ('Null 'PGbool)

1730−

1731− {- |

1732− true if at least one input value is true, otherwise false

1733−

1734− >>> :{

1735− let

1736− expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

1737− expression = boolOr (All #col)

1738− in printSQL expression

1739− :}

1740− bool_or(ALL "col")

1741− -}

1742− boolOr

1743− :: expr1 (null 'PGbool)

1744− -- ^ what to aggregate

1745− -> aggr ('Null 'PGbool)

1746−

1747− {- |

1748− equivalent to `boolAnd`

1749−

1750− >>> :{

1751− let

1752− expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

1753− expression = every (Distinct #col)

1754− in printSQL expression

1755− :}

1756− every(DISTINCT "col")

1757− -}

1758− every

1759− :: expr1 (null 'PGbool)

1760− -- ^ what to aggregate

1761− -> aggr ('Null 'PGbool)

1762−

1763− {- |maximum value of expression across all input values-}

1764− max_

1765− :: expr1 (null ty)

1766− -- ^ what to maximize

1767− -> aggr ('Null ty)

1768−

1769− -- | minimum value of expression across all input values

1770− min_

1771− :: expr1 (null ty)

1772− -- ^ what to minimize

1773− -> aggr ('Null ty)

1774−

1775− -- | the average (arithmetic mean) of all input values

1776− avg

1777− :: expr1 (null ty)

1778− -- ^ what to average

1779− -> aggr ('Null (PGAvg ty))

1780−

1781− {- | correlation coefficient

1782− >>> :{

1783− let

1784− expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

1785− expression = corr (All (#y *: #x))

1786− in printSQL expression

1787− :}

1788− corr(ALL "y", "x")

1789− -}

1790− corr

1791− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1792− -> aggr ('Null 'PGfloat8)

1793−

1794− {- | population covariance

1795− >>> :{

1796− let

1797− expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

1798− expression = covarPop (All (#y *: #x))

1799− in printSQL expression

1800− :}

1801− covar_pop(ALL "y", "x")

1802− -}

1803− covarPop

1804− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1805− -> aggr ('Null 'PGfloat8)

1806−

1807− {- | sample covariance

1808− >>> :{

1809− let

1810− winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

1811− winFun = covarSamp (#y *: #x)

1812− in printSQL winFun

1813− :}

1814− covar_samp("y", "x")

1815− -}

1816− covarSamp

1817− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1818− -> aggr ('Null 'PGfloat8)

1819−

1820− {- | average of the independent variable (sum(X)/N)

1821− >>> :{

1822− let

1823− expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

1824− expression = regrAvgX (All (#y *: #x))

1825− in printSQL expression

1826− :}

1827− regr_avgx(ALL "y", "x")

1828− -}

1829− regrAvgX

1830− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1831− -> aggr ('Null 'PGfloat8)

1832−

1833− {- | average of the dependent variable (sum(Y)/N)

1834− >>> :{

1835− let

1836− winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

1837− winFun = regrAvgY (#y *: #x)

1838− in printSQL winFun

1839− :}

1840− regr_avgy("y", "x")

1841− -}

1842− regrAvgY

1843− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1844− -> aggr ('Null 'PGfloat8)

1845−

1846− {- | number of input rows in which both expressions are nonnull

1847− >>> :{

1848− let

1849− winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGint8)

1850− winFun = regrCount (#y *: #x)

1851− in printSQL winFun

1852− :}

1853− regr_count("y", "x")

1854− -}

1855− regrCount

1856− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1857− -> aggr ('Null 'PGint8)

1858−

1859− {- | y-intercept of the least-squares-fit linear equation determined by the (X, Y) pairs

1860− >>> :{

1861− let

1862− expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

1863− expression = regrIntercept (All (#y *: #x))

1864− in printSQL expression

1865− :}

1866− regr_intercept(ALL "y", "x")

1867− -}

1868− regrIntercept

1869− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1870− -> aggr ('Null 'PGfloat8)

1871−

1872− -- | @regr_r2(Y, X)@, square of the correlation coefficient

1873− regrR2

1874− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1875− -> aggr ('Null 'PGfloat8)

1876−

1877− -- | @regr_slope(Y, X)@, slope of the least-squares-fit linear equation

1878− -- determined by the (X, Y) pairs

1879− regrSlope

1880− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1881− -> aggr ('Null 'PGfloat8)

1882−

1883− -- | @regr_sxx(Y, X)@, sum(X^2) - sum(X)^2/N

1884− -- (“sum of squares” of the independent variable)

1885− regrSxx

1886− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1887− -> aggr ('Null 'PGfloat8)

1888−

1889− -- | @regr_sxy(Y, X)@, sum(X*Y) - sum(X) * sum(Y)/N

1890− -- (“sum of products” of independent times dependent variable)

1891− regrSxy

1892− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1893− -> aggr ('Null 'PGfloat8)

1894−

1895− -- | @regr_syy(Y, X)@, sum(Y^2) - sum(Y)^2/N

1896− -- (“sum of squares” of the dependent variable)

1897− regrSyy

1898− :: exprN '[null 'PGfloat8, null 'PGfloat8]

1899− -> aggr ('Null 'PGfloat8)

1900−

1901− -- | historical alias for `stddevSamp`

1902− stddev

1903− :: expr1 (null ty)

1904− -> aggr ('Null (PGAvg ty))

1905−

1906− -- | population standard deviation of the input values

1907− stddevPop

1908− :: expr1 (null ty)

1909− -> aggr ('Null (PGAvg ty))

1910−

1911− -- | sample standard deviation of the input values

1912− stddevSamp

1913− :: expr1 (null ty)

1914− -> aggr ('Null (PGAvg ty))

1915−

1916− -- | historical alias for `varSamp`

1917− variance

1918− :: expr1 (null ty)

1919− -> aggr ('Null (PGAvg ty))

1920−

1921− -- | population variance of the input values

1922− -- (square of the population standard deviation)

1923− varPop

1924− :: expr1 (null ty)

1925− -> aggr ('Null (PGAvg ty))

1926−

1927− -- | sample variance of the input values

1928− -- (square of the sample standard deviation)

1929− varSamp

1930− :: expr1 (null ty)

1931− -> aggr ('Null (PGAvg ty))

1932−

1933−{- |

1934−`Distinction`s are used for the input of `Aggregate` `Expression`s.

1935−`All` invokes the aggregate once for each input row.

1936−`Distinct` invokes the aggregate once for each distinct value of the expression

1937−(or distinct set of values, for multiple expressions) found in the input

1938−-}

1939−data Distinction (expr :: kind -> Type) (ty :: kind)

1940− = All (expr ty)

1941− | Distinct (expr ty)

1942− deriving (GHC.Generic,Show,Eq,Ord)

1943−instance NFData (Distinction (Expression outer commons grp schemas params from) ty)

1944−instance RenderSQL (Distinction (Expression outer commons grp schemas params from) ty) where

1945− renderSQL = \case

1946− All x -> "ALL" <+> renderSQL x

1947− Distinct x -> "DISTINCT" <+> renderSQL x

1948−instance SOP.SListI tys => RenderSQL

1949− (Distinction (NP (Expression outer commons grp schemas params from)) tys) where

1950− renderSQL = \case

1951− All xs -> "ALL" <+> renderCommaSeparated renderSQL xs

1952− Distinct xs -> "DISTINCT" <+> renderCommaSeparated renderSQL xs

1953−

1954−instance Aggregate

1955− (Distinction (Expression outer commons 'Ungrouped schemas params from))

1956− (Distinction (NP (Expression outer commons 'Ungrouped schemas params from)))

1957− (Expression outer commons ('Grouped bys) schemas params from) where

1958− countStar = UnsafeExpression "count(*)"

1959− count = unsafeAggregate1 "count"

1960− sum_ = unsafeAggregate1 "sum"

1961− arrayAgg = unsafeAggregate1 "array_agg"

1962− jsonAgg = unsafeAggregate1 "json_agg"

1963− jsonbAgg = unsafeAggregate1 "jsonb_agg"

1964− bitAnd = unsafeAggregate1 "bit_and"

1965− bitOr = unsafeAggregate1 "bit_or"

1966− boolAnd = unsafeAggregate1 "bool_and"

1967− boolOr = unsafeAggregate1 "bool_or"

1968− every = unsafeAggregate1 "every"

1969− max_ = unsafeAggregate1 "max"

1970− min_ = unsafeAggregate1 "min"

1971− avg = unsafeAggregate1 "avg"

1972− corr = unsafeAggregateN "corr"

1973− covarPop = unsafeAggregateN "covar_pop"

1974− covarSamp = unsafeAggregateN "covar_samp"

1975− regrAvgX = unsafeAggregateN "regr_avgx"

1976− regrAvgY = unsafeAggregateN "regr_avgy"

1977− regrCount = unsafeAggregateN "regr_count"

1978− regrIntercept = unsafeAggregateN "regr_intercept"

1979− regrR2 = unsafeAggregateN "regr_r2"

1980− regrSlope = unsafeAggregateN "regr_slope"

1981− regrSxx = unsafeAggregateN "regr_sxx"

1982− regrSxy = unsafeAggregateN "regr_sxy"

1983− regrSyy = unsafeAggregateN "regr_syy"

1984− stddev = unsafeAggregate1 "stddev"

1985− stddevPop = unsafeAggregate1 "stddev_pop"

1986− stddevSamp = unsafeAggregate1 "stddev_samp"

1987− variance = unsafeAggregate1 "variance"

1988− varPop = unsafeAggregate1 "var_pop"

1989− varSamp = unsafeAggregate1 "var_samp"

1990−instance Aggregate

1991− (Expression outer commons grp schemas params from)

1992− (NP (Expression outer commons grp schemas params from))

1993− (WindowFunction outer commons grp schemas params from) where

1994− countStar = UnsafeWindowFunction "count(*)"

1995− count = unsafeWindowFunction1 "count"

1996− sum_ = unsafeWindowFunction1 "sum"

1997− arrayAgg = unsafeWindowFunction1 "array_agg"

1998− jsonAgg = unsafeWindowFunction1 "json_agg"

1999− jsonbAgg = unsafeWindowFunction1 "jsonb_agg"

2000− bitAnd = unsafeWindowFunction1 "bit_and"

2001− bitOr = unsafeWindowFunction1 "bit_or"

2002− boolAnd = unsafeWindowFunction1 "bool_and"

2003− boolOr = unsafeWindowFunction1 "bool_or"

2004− every = unsafeWindowFunction1 "every"

2005− max_ = unsafeWindowFunction1 "max"

2006− min_ = unsafeWindowFunction1 "min"

2007− avg = unsafeWindowFunction1 "avg"

2008− corr = unsafeWindowFunctionN "corr"

2009− covarPop = unsafeWindowFunctionN "covar_pop"

2010− covarSamp = unsafeWindowFunctionN "covar_samp"

2011− regrAvgX = unsafeWindowFunctionN "regr_avgx"

2012− regrAvgY = unsafeWindowFunctionN "regr_avgy"

2013− regrCount = unsafeWindowFunctionN "regr_count"

2014− regrIntercept = unsafeWindowFunctionN "regr_intercept"

2015− regrR2 = unsafeWindowFunctionN "regr_r2"

2016− regrSlope = unsafeWindowFunctionN "regr_slope"

2017− regrSxx = unsafeWindowFunctionN "regr_sxx"

2018− regrSxy = unsafeWindowFunctionN "regr_sxy"

2019− regrSyy = unsafeWindowFunctionN "regr_syy"

2020− stddev = unsafeWindowFunction1 "stddev"

2021− stddevPop = unsafeWindowFunction1 "stddev_pop"

2022− stddevSamp = unsafeWindowFunction1 "stddev_samp"

2023− variance = unsafeWindowFunction1 "variance"

2024− varPop = unsafeWindowFunction1 "var_pop"

2025− varSamp = unsafeWindowFunction1 "var_samp"

2026−

2027−-- | escape hatch to define aggregate functions

2028−unsafeAggregate1

2029− :: ByteString -- ^ aggregate function

2030− -> Distinction (Expression outer commons 'Ungrouped schemas params from) x

2031− -> Expression outer commons ('Grouped bys) schemas params from y

2032−unsafeAggregate1 fun x = UnsafeExpression $ fun <> parenthesized (renderSQL x)

2033−

2034−-- | A type family that calculates `PGAvg` type of a `PGType`.

2035−type family PGAvg ty where

2036− PGAvg 'PGint2 = 'PGnumeric

2037− PGAvg 'PGint4 = 'PGnumeric

2038− PGAvg 'PGint8 = 'PGnumeric

2039− PGAvg 'PGnumeric = 'PGnumeric

2040− PGAvg 'PGfloat4 = 'PGfloat8

2041− PGAvg 'PGfloat8 = 'PGfloat8

2042− PGAvg 'PGinterval = 'PGinterval

2043− PGAvg pg = TypeError

2044− ('Text "Squeal type error: No average for " ':<>: 'ShowType pg)

2045−

2046−{-----------------------------------------

2047−type expressions

2048−-----------------------------------------}

2049−

2050−-- | `TypeExpression`s are used in `cast`s and

2051−-- `Squeal.PostgreSQL.Definition.createTable` commands.

2052−newtype TypeExpression (schemas :: SchemasType) (ty :: NullityType)

2053− = UnsafeTypeExpression { renderTypeExpression :: ByteString }

2054− deriving (GHC.Generic,Show,Eq,Ord,NFData)

2055−instance RenderSQL (TypeExpression schemas ty) where

2056− renderSQL = renderTypeExpression

2057−

2058−-- | The enum or composite type in a `Typedef` can be expressed by its alias.

2059−typedef

2060− :: (Has sch schemas schema, Has td schema ('Typedef ty))

2061− => QualifiedAlias sch td

2062− -> TypeExpression schemas (null ty)

2063−typedef = UnsafeTypeExpression . renderSQL

2064−

2065−-- | The composite type corresponding to a `Table` definition can be expressed

2066−-- by its alias.

2067−typetable

2068− :: (Has sch schemas schema, Has tab schema ('Table table))

2069− => QualifiedAlias sch tab

2070− -> TypeExpression schemas (null ('PGcomposite (TableToRow table)))

2071−typetable = UnsafeTypeExpression . renderSQL

2072−

2073−-- | The composite type corresponding to a `View` definition can be expressed

2074−-- by its alias.

2075−typeview

2076− :: (Has sch schemas schema, Has vw schema ('View view))

2077− => QualifiedAlias sch vw

2078− -> TypeExpression schemas (null ('PGcomposite view))

2079−typeview = UnsafeTypeExpression . renderSQL

2080−

2081−-- | logical Boolean (true/false)

2082−bool :: TypeExpression schemas (null 'PGbool)

2083−bool = UnsafeTypeExpression "bool"

2084−-- | signed two-byte integer

2085−int2, smallint :: TypeExpression schemas (null 'PGint2)

2086−int2 = UnsafeTypeExpression "int2"

2087−smallint = UnsafeTypeExpression "smallint"

2088−-- | signed four-byte integer

2089−int4, int, integer :: TypeExpression schemas (null 'PGint4)

2090−int4 = UnsafeTypeExpression "int4"

2091−int = UnsafeTypeExpression "int"

2092−integer = UnsafeTypeExpression "integer"

2093−-- | signed eight-byte integer

2094−int8, bigint :: TypeExpression schemas (null 'PGint8)

2095−int8 = UnsafeTypeExpression "int8"

2096−bigint = UnsafeTypeExpression "bigint"

2097−-- | arbitrary precision numeric type

2098−numeric :: TypeExpression schemas (null 'PGnumeric)

2099−numeric = UnsafeTypeExpression "numeric"

2100−-- | single precision floating-point number (4 bytes)

2101−float4, real :: TypeExpression schemas (null 'PGfloat4)

2102−float4 = UnsafeTypeExpression "float4"

2103−real = UnsafeTypeExpression "real"

2104−-- | double precision floating-point number (8 bytes)

2105−float8, doublePrecision :: TypeExpression schemas (null 'PGfloat8)

2106−float8 = UnsafeTypeExpression "float8"

2107−doublePrecision = UnsafeTypeExpression "double precision"

2108−-- | currency amount

2109−money :: TypeExpression schema (null 'PGmoney)

2110−money = UnsafeTypeExpression "money"

2111−-- | variable-length character string

2112−text :: TypeExpression schemas (null 'PGtext)

2113−text = UnsafeTypeExpression "text"

2114−-- | fixed-length character string

2115−char, character

2116− :: forall n schemas null. (KnownNat n, 1 <= n)

2117− => TypeExpression schemas (null ('PGchar n))

2118−char = UnsafeTypeExpression $ "char(" <> renderNat @n <> ")"

2119−character = UnsafeTypeExpression $ "character(" <> renderNat @n <> ")"

2120−-- | variable-length character string

2121−varchar, characterVarying

2122− :: forall n schemas null. (KnownNat n, 1 <= n)

2123− => TypeExpression schemas (null ('PGvarchar n))

2124−varchar = UnsafeTypeExpression $ "varchar(" <> renderNat @n <> ")"

2125−characterVarying = UnsafeTypeExpression $

2126− "character varying(" <> renderNat @n <> ")"

2127−-- | binary data ("byte array")

2128−bytea :: TypeExpression schemas (null 'PGbytea)

2129−bytea = UnsafeTypeExpression "bytea"

2130−-- | date and time (no time zone)

2131−timestamp :: TypeExpression schemas (null 'PGtimestamp)

2132−timestamp = UnsafeTypeExpression "timestamp"

2133−-- | date and time, including time zone

2134−timestampWithTimeZone :: TypeExpression schemas (null 'PGtimestamptz)

2135−timestampWithTimeZone = UnsafeTypeExpression "timestamp with time zone"

2136−-- | calendar date (year, month, day)

2137−date :: TypeExpression schemas (null 'PGdate)

2138−date = UnsafeTypeExpression "date"

2139−-- | time of day (no time zone)

2140−time :: TypeExpression schemas (null 'PGtime)

2141−time = UnsafeTypeExpression "time"

2142−-- | time of day, including time zone

2143−timeWithTimeZone :: TypeExpression schemas (null 'PGtimetz)

2144−timeWithTimeZone = UnsafeTypeExpression "time with time zone"

2145−-- | time span

2146−interval :: TypeExpression schemas (null 'PGinterval)

2147−interval = UnsafeTypeExpression "interval"

2148−-- | universally unique identifier

2149−uuid :: TypeExpression schemas (null 'PGuuid)

2150−uuid = UnsafeTypeExpression "uuid"

2151−-- | IPv4 or IPv6 host address

2152−inet :: TypeExpression schemas (null 'PGinet)

2153−inet = UnsafeTypeExpression "inet"

2154−-- | textual JSON data

2155−json :: TypeExpression schemas (null 'PGjson)

2156−json = UnsafeTypeExpression "json"

2157−-- | binary JSON data, decomposed

2158−jsonb :: TypeExpression schemas (null 'PGjsonb)

2159−jsonb = UnsafeTypeExpression "jsonb"

2160−-- | variable length array

2161−vararray

2162− :: TypeExpression schemas pg

2163− -> TypeExpression schemas (null ('PGvararray pg))

2164−vararray ty = UnsafeTypeExpression $ renderSQL ty <> "[]"

2165−-- | fixed length array

2166−--

2167−-- >>> renderSQL (fixarray @'[2] json)

2168−-- "json[2]"

2169−fixarray

2170− :: forall dims schemas null pg. SOP.All KnownNat dims

2171− => TypeExpression schemas pg

2172− -> TypeExpression schemas (null ('PGfixarray dims pg))

2173−fixarray ty = UnsafeTypeExpression $

2174− renderSQL ty <> renderDims @dims

2175− where

2176− renderDims :: forall ns. SOP.All KnownNat ns => ByteString

2177− renderDims =

2178− ("[" <>)

2179− . (<> "]")

2180− . ByteString.intercalate "]["

2181− . hcollapse

2182− $ hcmap (SOP.Proxy @KnownNat)

2183− (K . fromString . show . natVal)

2184− (hpure SOP.Proxy :: NP SOP.Proxy ns)

2185−tsvector :: TypeExpression schemas (null 'PGtsvector)

2186−tsvector = UnsafeTypeExpression "tsvector"

2187−tsquery :: TypeExpression schemas (null 'PGtsquery)

2188−tsquery = UnsafeTypeExpression "tsquery"

2189−

2190−-- | `pgtype` is a demoted version of a `PGType`

2191−class PGTyped schemas (ty :: NullityType) where

2192− pgtype :: TypeExpression schemas ty

2193−instance PGTyped schemas (null 'PGbool) where pgtype = bool

2194−instance PGTyped schemas (null 'PGint2) where pgtype = int2

2195−instance PGTyped schemas (null 'PGint4) where pgtype = int4

2196−instance PGTyped schemas (null 'PGint8) where pgtype = int8

2197−instance PGTyped schemas (null 'PGnumeric) where pgtype = numeric

2198−instance PGTyped schemas (null 'PGfloat4) where pgtype = float4

2199−instance PGTyped schemas (null 'PGfloat8) where pgtype = float8

2200−instance PGTyped schemas (null 'PGmoney) where pgtype = money

2201−instance PGTyped schemas (null 'PGtext) where pgtype = text

2202−instance (KnownNat n, 1 <= n)

2203− => PGTyped schemas (null ('PGchar n)) where pgtype = char @n

2204−instance (KnownNat n, 1 <= n)

2205− => PGTyped schemas (null ('PGvarchar n)) where pgtype = varchar @n

2206−instance PGTyped schemas (null 'PGbytea) where pgtype = bytea

2207−instance PGTyped schemas (null 'PGtimestamp) where pgtype = timestamp

2208−instance PGTyped schemas (null 'PGtimestamptz) where pgtype = timestampWithTimeZone

2209−instance PGTyped schemas (null 'PGdate) where pgtype = date

2210−instance PGTyped schemas (null 'PGtime) where pgtype = time

2211−instance PGTyped schemas (null 'PGtimetz) where pgtype = timeWithTimeZone

2212−instance PGTyped schemas (null 'PGinterval) where pgtype = interval

2213−instance PGTyped schemas (null 'PGuuid) where pgtype = uuid

2214−instance PGTyped schemas (null 'PGjson) where pgtype = json

2215−instance PGTyped schemas (null 'PGjsonb) where pgtype = jsonb

2216−instance PGTyped schemas ty

2217− => PGTyped schemas (null ('PGvararray ty)) where

2218− pgtype = vararray (pgtype @schemas @ty)

2219−instance (SOP.All KnownNat dims, PGTyped schemas ty)

2220− => PGTyped schemas (null ('PGfixarray dims ty)) where

2221− pgtype = fixarray @dims (pgtype @schemas @ty)

2222−instance PGTyped schemas (null 'PGtsvector) where pgtype = tsvector

2223−instance PGTyped schemas (null 'PGtsquery) where pgtype = tsquery

2224−

2225−{-----------------------------------------

2226−Sorting

2227−-----------------------------------------}

2228−

2229−-- | `SortExpression`s are used by `orderBy` to optionally sort the results

2230−-- of a `Squeal.PostgreSQL.Query.Query`. `Asc` or `Desc`

2231−-- set the sort direction of a `NotNull` result

2232−-- column to ascending or descending. Ascending order puts smaller values

2233−-- first, where "smaller" is defined in terms of the `.<` operator. Similarly,

2234−-- descending order is determined with the `.>` operator. `AscNullsFirst`,

2235−-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to

2236−-- determine whether nulls appear before or after non-null values in the sort

2237−-- ordering of a `Null` result column.

2238−data SortExpression outer commons grp schemas params from where

2239− Asc

2240− :: Expression outer commons grp schemas params from ('NotNull ty)

2241− -> SortExpression outer commons grp schemas params from

2242− Desc

2243− :: Expression outer commons grp schemas params from ('NotNull ty)

2244− -> SortExpression outer commons grp schemas params from

2245− AscNullsFirst

2246− :: Expression outer commons grp schemas params from ('Null ty)

2247− -> SortExpression outer commons grp schemas params from

2248− AscNullsLast

2249− :: Expression outer commons grp schemas params from ('Null ty)

2250− -> SortExpression outer commons grp schemas params from

2251− DescNullsFirst

2252− :: Expression outer commons grp schemas params from ('Null ty)

2253− -> SortExpression outer commons grp schemas params from

2254− DescNullsLast

2255− :: Expression outer commons grp schemas params from ('Null ty)

2256− -> SortExpression outer commons grp schemas params from

2257−deriving instance Show (SortExpression outer commons grp schemas params from)

2258−

2259−{- |

2260−The `orderBy` clause causes the result rows of a `Squeal.PostgreSQL.Query.TableExpression`

2261−to be sorted according to the specified `SortExpression`(s).

2262−If two rows are equal according to the leftmost expression,

2263−they are compared according to the next expression and so on.

2264−If they are equal according to all specified expressions,

2265−they are returned in an implementation-dependent order.

2266−

2267−You can also control the order in which rows are processed by window functions

2268−using `orderBy` within `Squeal.PostgreSQL.Query.Over`.

2269−-}

2270−class OrderBy expr where

2271− orderBy

2272− :: [SortExpression outer commons grp schemas params from]

2273− -> expr outer commons grp schemas params from

2274− -> expr outer commons grp schemas params from

2275−

2276−-- | Render a `SortExpression`.

2277−instance RenderSQL (SortExpression outer commons grp schemas params from) where

2278− renderSQL = \case

2279− Asc expression -> renderSQL expression <+> "ASC"

2280− Desc expression -> renderSQL expression <+> "DESC"

2281− AscNullsFirst expression -> renderSQL expression

2282− <+> "ASC NULLS FIRST"

2283− DescNullsFirst expression -> renderSQL expression

2284− <+> "DESC NULLS FIRST"

2285− AscNullsLast expression -> renderSQL expression <+> "ASC NULLS LAST"

2286− DescNullsLast expression -> renderSQL expression <+> "DESC NULLS LAST"

2287−

2288−-- | A `WindowDefinition` is a set of table rows that are somehow related

2289−-- to the current row

2290−data WindowDefinition outer commons grp schemas params from where

2291− WindowDefinition

2292− :: SListI bys

2293− => NP (Expression outer commons grp schemas params from) bys

2294− -> [SortExpression outer commons grp schemas params from]

2295− -> WindowDefinition outer commons grp schemas params from

2296−

2297−instance OrderBy WindowDefinition where

2298− orderBy sortsR (WindowDefinition parts sortsL)

2299− = WindowDefinition parts (sortsL ++ sortsR)

2300−

2301−instance RenderSQL (WindowDefinition outer commons schemas from grp params) where

2302− renderSQL (WindowDefinition part ord) =

2303− renderPartitionByClause part <> renderOrderByClause ord

2304− where

2305− renderPartitionByClause = \case

2306− Nil -> ""

2307− parts -> "PARTITION" <+> "BY" <+> renderCommaSeparated renderExpression parts

2308− renderOrderByClause = \case

2309− [] -> ""

2310− srts -> " ORDER" <+> "BY"

2311− <+> commaSeparated (renderSQL <$> srts)

2312−

2313−{- |

2314−The `partitionBy` clause within `Squeal.PostgreSQL.Query.Over` divides the rows into groups,

2315−or partitions, that share the same values of the `partitionBy` `Expression`(s).

2316−For each row, the window function is computed across the rows that fall into

2317−the same partition as the current row.

2318−-}

2319−partitionBy

2320− :: SListI bys

2321− => NP (Expression outer commons grp schemas params from) bys

2322− -> WindowDefinition outer commons grp schemas params from

2323−partitionBy bys = WindowDefinition bys []

2324−

2325−{- |

2326−A window function performs a calculation across a set of table rows

2327−that are somehow related to the current row. This is comparable to the type

2328−of calculation that can be done with an aggregate function.

2329−However, window functions do not cause rows to become grouped into a single

2330−output row like non-window aggregate calls would.

2331−Instead, the rows retain their separate identities.

2332−Behind the scenes, the window function is able to access more than

2333−just the current row of the query result.

2334−-}

2335−newtype WindowFunction

2336− (outer :: FromType)

2337− (commons :: FromType)

2338− (grp :: Grouping)

2339− (schemas :: SchemasType)

2340− (params :: [NullityType])

2341− (from :: FromType)

2342− (ty :: NullityType)

2343− = UnsafeWindowFunction { renderWindowFunction :: ByteString }

2344− deriving (GHC.Generic,Show,Eq,Ord,NFData)

2345−

2346−instance RenderSQL (WindowFunction outer commons grp schemas params from ty) where

2347− renderSQL = renderWindowFunction

2348−

2349−type WinFun0 x

2350− = forall outer commons grp schemas params from

2351− . WindowFunction outer commons grp schemas params from x

2352− -- ^ cannot reference aliases

2353−

2354−type WinFun1 x y

2355− = forall outer commons grp schemas params from

2356− . Expression outer commons grp schemas params from x

2357− -- ^ input

2358− -> WindowFunction outer commons grp schemas params from y

2359− -- ^ output

2360−

2361−type WinFunN xs y

2362− = forall outer commons grp schemas params from

2363− . NP (Expression outer commons grp schemas params from) xs

2364− -- ^ inputs

2365− -> WindowFunction outer commons grp schemas params from y

2366− -- ^ output

2367−

2368−unsafeWindowFunction1 :: ByteString -> WinFun1 x y

2369−unsafeWindowFunction1 fun x

2370− = UnsafeWindowFunction $ fun <> parenthesized (renderSQL x)

2371−

2372−unsafeWindowFunctionN :: SOP.SListI xs => ByteString -> WinFunN xs y

2373−unsafeWindowFunctionN fun xs = UnsafeWindowFunction $ fun <>

2374− parenthesized (renderCommaSeparated renderSQL xs)

2375−

2376−{- | rank of the current row with gaps; same as `rowNumber` of its first peer

2377−>>> printSQL rank

2378−rank()

2379−-}

2380−rank :: WinFun0 ('NotNull 'PGint8)

2381−rank = UnsafeWindowFunction "rank()"

2382−

2383−{- | number of the current row within its partition, counting from 1

2384−>>> printSQL rowNumber

2385−row_number()

2386−-}

2387−rowNumber :: WinFun0 ('NotNull 'PGint8)

2388−rowNumber = UnsafeWindowFunction "row_number()"

2389−

2390−{- | rank of the current row without gaps; this function counts peer groups

2391−>>> printSQL denseRank

2392−dense_rank()

2393−-}

2394−denseRank :: WinFun0 ('NotNull 'PGint8)

2395−denseRank = UnsafeWindowFunction "dense_rank()"

2396−

2397−{- | relative rank of the current row: (rank - 1) / (total partition rows - 1)

2398−>>> printSQL percentRank

2399−percent_rank()

2400−-}

2401−percentRank :: WinFun0 ('NotNull 'PGfloat8)

2402−percentRank = UnsafeWindowFunction "percent_rank()"

2403−

2404−{- | cumulative distribution: (number of partition rows

2405−preceding or peer with current row) / total partition rows

2406−>>> printSQL cumeDist

2407−cume_dist()

2408−-}

2409−cumeDist :: WinFun0 ('NotNull 'PGfloat8)

2410−cumeDist = UnsafeWindowFunction "cume_dist()"

2411−

2412−{- | integer ranging from 1 to the argument value,

2413−dividing the partition as equally as possible

2414−-}

2415−ntile :: WinFun1 ('NotNull 'PGint4) ('NotNull 'PGint4)

2416−ntile = unsafeWindowFunction1 "ntile"

2417−

2418−{- | returns value evaluated at the row that is offset rows before the current

2419−row within the partition; if there is no such row, instead return default

2420−(which must be of the same type as value). Both offset and default are

2421−evaluated with respect to the current row.

2422−-}

2423−lag :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

2424−lag = unsafeWindowFunctionN "lag"

2425−

2426−{- | returns value evaluated at the row that is offset rows after the current

2427−row within the partition; if there is no such row, instead return default

2428−(which must be of the same type as value). Both offset and default are

2429−evaluated with respect to the current row.

2430−-}

2431−lead :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

2432−lead = unsafeWindowFunctionN "lag"

2433−

2434−{- | returns value evaluated at the row that is the

2435−first row of the window frame

2436−-}

2437−firstValue :: WinFun1 ty ty

2438−firstValue = unsafeWindowFunction1 "first_value"

2439−

2440−{- | returns value evaluated at the row that is the

2441−last row of the window frame

2442−-}

2443−lastValue :: WinFun1 ty ty

2444−lastValue = unsafeWindowFunction1 "last_value"

2445−

2446−{- | returns value evaluated at the row that is the nth

2447−row of the window frame (counting from 1); null if no such row

2448−-}

2449−nthValue :: WinFunN '[null ty, 'NotNull 'PGint4] ('Null ty)

2450−nthValue = unsafeWindowFunctionN "nth_value"

2451−

2452−{-|

2453−Create date from year, month and day fields

2454−

2455−>>> printSQL (makeDate (1984 :* 7 *: 3))

2456−make_date(1984, 7, 3)

2457−-}

2458−makeDate :: FunctionN

2459− '[ null 'PGint4, null 'PGint4, null 'PGint4 ]

2460− ( null 'PGdate )

2461−makeDate = unsafeFunctionN "make_date"

2462−

2463−{-|

2464−Create time from hour, minute and seconds fields

2465−

2466−>>> printSQL (makeTime (8 :* 15 *: 23.5))

2467−make_time(8, 15, 23.5)

2468−-}

2469−makeTime :: FunctionN

2470− '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ]

2471− ( null 'PGtime )

2472−makeTime = unsafeFunctionN "make_time"

2473−

2474−{-|

2475−Create timestamp from year, month, day, hour, minute and seconds fields

2476−

2477−>>> printSQL (makeTimestamp (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

2478−make_timestamp(2013, 7, 15, 8, 15, 23.5)

2479−-}

2480−makeTimestamp :: FunctionN

2481− '[ null 'PGint4, null 'PGint4, null 'PGint4

2482− , null 'PGint4, null 'PGint4, null 'PGfloat8 ]

2483− ( null 'PGtimestamp )

2484−makeTimestamp = unsafeFunctionN "make_timestamp"

2485−

2486−{-|

2487−Create timestamp with time zone from

2488−year, month, day, hour, minute and seconds fields;

2489−the current time zone is used

2490−

2491−>>> printSQL (makeTimestamptz (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

2492−make_timestamptz(2013, 7, 15, 8, 15, 23.5)

2493−-}

2494−makeTimestamptz :: FunctionN

2495− '[ null 'PGint4, null 'PGint4, null 'PGint4

2496− , null 'PGint4, null 'PGint4, null 'PGfloat8 ]

2497− ( null 'PGtimestamptz )

2498−makeTimestamptz = unsafeFunctionN "make_timestamptz"

2499−

2500−{-|

2501−Affine space operations on time types.

2502−-}

2503−class TimeOp time diff | time -> diff where

2504− {-|

2505− >>> printSQL (makeDate (1984 :* 7 *: 3) !+ 365)

2506− (make_date(1984, 7, 3) + 365)

2507− -}

2508− (!+) :: Operator (null time) (null diff) (null time)

2509− (!+) = unsafeBinaryOp "+"

2510− {-|

2511− >>> printSQL (365 +! makeDate (1984 :* 7 *: 3))

2512− (365 + make_date(1984, 7, 3))

2513− -}

2514− (+!) :: Operator (null diff) (null time) (null time)

2515− (+!) = unsafeBinaryOp "+"

2516− {-|

2517− >>> printSQL (makeDate (1984 :* 7 *: 3) !- 365)

2518− (make_date(1984, 7, 3) - 365)

2519− -}

2520− (!-) :: Operator (null time) (null diff) (null time)

2521− (!-) = unsafeBinaryOp "-"

2522− {-|

2523− >>> printSQL (makeDate (1984 :* 7 *: 3) !-! currentDate)

2524− (make_date(1984, 7, 3) - CURRENT_DATE)

2525− -}

2526− (!-!) :: Operator (null time) (null time) (null diff)

2527− (!-!) = unsafeBinaryOp "-"

2528−instance TimeOp 'PGtimestamp 'PGinterval

2529−instance TimeOp 'PGtimestamptz 'PGinterval

2530−instance TimeOp 'PGtime 'PGinterval

2531−instance TimeOp 'PGtimetz 'PGinterval

2532−instance TimeOp 'PGinterval 'PGinterval

2533−instance TimeOp 'PGdate 'PGint4

2534−infixl 6 !+

2535−infixl 6 +!

2536−infixl 6 !-

2537−infixl 6 !-!

2538−

2539−data TimeUnit

2540− = Years | Months | Weeks | Days

2541− | Hours | Minutes | Seconds

2542− | Microseconds | Milliseconds

2543− | Decades | Centuries | Millennia

2544− deriving (Eq, Ord, Show, Read, Enum, GHC.Generic)

2545−instance SOP.Generic TimeUnit

2546−instance SOP.HasDatatypeInfo TimeUnit

2547−instance RenderSQL TimeUnit where

2548− renderSQL = \case

2549− Years -> "years"

2550− Months -> "months"

2551− Weeks -> "weeks"

2552− Days -> "days"

2553− Hours -> "hours"

2554− Minutes -> "minutes"

2555− Seconds -> "seconds"

2556− Microseconds -> "microseconds"

2557− Milliseconds -> "milliseconds"

2558− Decades -> "decades"

2559− Centuries -> "centuries"

2560− Millennia -> "millennia"

2561−

2562−-- | >>> printSQL $ interval_ 7 Days

2563−-- (INTERVAL '7.0 days')

2564−interval_ :: Double -> TimeUnit -> Expr (null 'PGinterval)

2565−interval_ num unit = UnsafeExpression . parenthesized $ "INTERVAL" <+>

2566− "'" <> fromString (show num) <+> renderSQL unit <> "'"

2567−

2568−class Literal hask where

2569− literal :: hask -> Expr (null (PG hask))

2570−instance JSON.ToJSON hask => Literal (Json hask) where

2571− literal = cast json . UnsafeExpression

2572− . singleQuotedUtf8 . toStrict . JSON.encode . getJson

2573−instance JSON.ToJSON hask => Literal (Jsonb hask) where

2574− literal = cast jsonb . UnsafeExpression

2575− . singleQuotedUtf8 . toStrict . JSON.encode . getJsonb

2576−instance Literal Char where

2577− literal chr = UnsafeExpression $

2578− "E\'" <> fromString (escape chr) <> "\'"

2579−instance Literal String where literal = fromString

2580−instance Literal Int16 where literal = fromIntegral

2581−instance Literal Int32 where literal = fromIntegral

2582−instance Literal Int64 where literal = fromIntegral

2583−instance Literal Float where literal = fromRational . toRational

2584−instance Literal Double where literal = fromRational . toRational

2585−instance Literal Text where literal = fromString . Text.unpack

2586−instance Literal Lazy.Text where literal = fromString . Lazy.Text.unpack

2587−instance ToParam (Enumerated enum) (PG (Enumerated enum))

2588− => Literal (Enumerated enum) where

2589− literal

2590− = UnsafeExpression

2591− . singleQuotedUtf8

2592− . builderBytes

2593− . unK

2594− . toParam @(Enumerated enum) @(PG (Enumerated enum))

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Aggregate.hsnew file+462

@@ -0,0 +1,462 @@

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

8+Aggregate functions

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , DeriveGeneric

14+ , FlexibleContexts

15+ , FlexibleInstances

16+ , FunctionalDependencies

17+ , LambdaCase

18+ , MultiParamTypeClasses

19+ , OverloadedStrings

20+ , PolyKinds

21+ , TypeFamilies

22+ , TypeOperators

23+ , UndecidableInstances

24+#-}

25+

26+module Squeal.PostgreSQL.Expression.Aggregate

27+ ( Aggregate (..)

28+ , Distinction (..)

29+ , PGSum

30+ , PGAvg

31+ ) where

32+

33+import Control.DeepSeq

34+import Data.ByteString (ByteString)

35+import Data.Kind

36+import GHC.TypeLits

37+

38+import qualified GHC.Generics as GHC

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.Schema

46+

47+-- $setup

48+-- >>> import Squeal.PostgreSQL

49+

50+{- |

51+`Aggregate` functions compute a single result from a set of input values.

52+`Aggregate` functions can be used as `GroupedBy` `Expression`s as well

53+as `Squeal.PostgreSQL.Expression.Window.WindowFunction`s.

54+-}

55+class Aggregate expr1 exprN aggr

56+ | aggr -> expr1, aggr -> exprN where

57+

58+ -- | A special aggregation that does not require an input

59+ --

60+ -- >>> :{

61+ -- let

62+ -- expression :: Expression '[] commons ('Grouped bys) schemas params from ('NotNull 'PGint8)

63+ -- expression = countStar

64+ -- in printSQL expression

65+ -- :}

66+ -- count(*)

67+ countStar :: aggr ('NotNull 'PGint8)

68+

69+ -- | >>> :{

70+ -- let

71+ -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null ty]] ('NotNull 'PGint8)

72+ -- expression = count (All #col)

73+ -- in printSQL expression

74+ -- :}

75+ -- count(ALL "col")

76+ count

77+ :: expr1 ty

78+ -- ^ what to count

79+ -> aggr ('NotNull 'PGint8)

80+

81+ -- | >>> :{

82+ -- let

83+ -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('Null 'PGnumeric)

84+ -- expression = sum_ (Distinct #col)

85+ -- in printSQL expression

86+ -- :}

87+ -- sum(DISTINCT "col")

88+ sum_

89+ :: expr1 (null ty)

90+ -> aggr ('Null (PGSum ty))

91+

92+ -- | input values, including nulls, concatenated into an array

93+ arrayAgg

94+ :: expr1 ty

95+ -> aggr ('Null ('PGvararray ty))

96+

97+ -- | aggregates values as a JSON array

98+ jsonAgg

99+ :: expr1 ty

100+ -> aggr ('Null 'PGjson)

101+

102+ -- | aggregates values as a JSON array

103+ jsonbAgg

104+ :: expr1 ty

105+ -> aggr ('Null 'PGjsonb)

106+

107+ {- |

108+ the bitwise AND of all non-null input values, or null if none

109+

110+ >>> :{

111+ let

112+ expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

113+ expression = bitAnd (Distinct #col)

114+ in printSQL expression

115+ :}

116+ bit_and(DISTINCT "col")

117+ -}

118+ bitAnd

119+ :: int `In` PGIntegral

120+ => expr1 (null int)

121+ -- ^ what to aggregate

122+ -> aggr ('Null int)

123+

124+ {- |

125+ the bitwise OR of all non-null input values, or null if none

126+

127+ >>> :{

128+ let

129+ expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

130+ expression = bitOr (All #col)

131+ in printSQL expression

132+ :}

133+ bit_or(ALL "col")

134+ -}

135+ bitOr

136+ :: int `In` PGIntegral

137+ => expr1 (null int)

138+ -- ^ what to aggregate

139+ -> aggr ('Null int)

140+

141+ {- |

142+ true if all input values are true, otherwise false

143+

144+ >>> :{

145+ let

146+ winFun :: WindowFunction '[] commons 'Ungrouped schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

147+ winFun = boolAnd #col

148+ in printSQL winFun

149+ :}

150+ bool_and("col")

151+ -}

152+ boolAnd

153+ :: expr1 (null 'PGbool)

154+ -- ^ what to aggregate

155+ -> aggr ('Null 'PGbool)

156+

157+ {- |

158+ true if at least one input value is true, otherwise false

159+

160+ >>> :{

161+ let

162+ expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

163+ expression = boolOr (All #col)

164+ in printSQL expression

165+ :}

166+ bool_or(ALL "col")

167+ -}

168+ boolOr

169+ :: expr1 (null 'PGbool)

170+ -- ^ what to aggregate

171+ -> aggr ('Null 'PGbool)

172+

173+ {- |

174+ equivalent to `boolAnd`

175+

176+ >>> :{

177+ let

178+ expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

179+ expression = every (Distinct #col)

180+ in printSQL expression

181+ :}

182+ every(DISTINCT "col")

183+ -}

184+ every

185+ :: expr1 (null 'PGbool)

186+ -- ^ what to aggregate

187+ -> aggr ('Null 'PGbool)

188+

189+ {- |maximum value of expression across all input values-}

190+ max_

191+ :: expr1 (null ty)

192+ -- ^ what to maximize

193+ -> aggr ('Null ty)

194+

195+ -- | minimum value of expression across all input values

196+ min_

197+ :: expr1 (null ty)

198+ -- ^ what to minimize

199+ -> aggr ('Null ty)

200+

201+ -- | the average (arithmetic mean) of all input values

202+ avg

203+ :: expr1 (null ty)

204+ -- ^ what to average

205+ -> aggr ('Null (PGAvg ty))

206+

207+ {- | correlation coefficient

208+

209+ >>> :{

210+ let

211+ expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

212+ expression = corr (All (#y *: #x))

213+ in printSQL expression

214+ :}

215+ corr(ALL "y", "x")

216+ -}

217+ corr

218+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

219+ -> aggr ('Null 'PGfloat8)

220+

221+ {- | population covariance

222+

223+ >>> :{

224+ let

225+ expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

226+ expression = covarPop (All (#y *: #x))

227+ in printSQL expression

228+ :}

229+ covar_pop(ALL "y", "x")

230+ -}

231+ covarPop

232+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

233+ -> aggr ('Null 'PGfloat8)

234+

235+ {- | sample covariance

236+

237+ >>> :{

238+ let

239+ winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

240+ winFun = covarSamp (#y *: #x)

241+ in printSQL winFun

242+ :}

243+ covar_samp("y", "x")

244+ -}

245+ covarSamp

246+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

247+ -> aggr ('Null 'PGfloat8)

248+

249+ {- | average of the independent variable (sum(X)/N)

250+

251+ >>> :{

252+ let

253+ expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

254+ expression = regrAvgX (All (#y *: #x))

255+ in printSQL expression

256+ :}

257+ regr_avgx(ALL "y", "x")

258+ -}

259+ regrAvgX

260+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

261+ -> aggr ('Null 'PGfloat8)

262+

263+ {- | average of the dependent variable (sum(Y)/N)

264+

265+ >>> :{

266+ let

267+ winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

268+ winFun = regrAvgY (#y *: #x)

269+ in printSQL winFun

270+ :}

271+ regr_avgy("y", "x")

272+ -}

273+ regrAvgY

274+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

275+ -> aggr ('Null 'PGfloat8)

276+

277+ {- | number of input rows in which both expressions are nonnull

278+

279+ >>> :{

280+ let

281+ winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGint8)

282+ winFun = regrCount (#y *: #x)

283+ in printSQL winFun

284+ :}

285+ regr_count("y", "x")

286+ -}

287+ regrCount

288+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

289+ -> aggr ('Null 'PGint8)

290+

291+ {- | y-intercept of the least-squares-fit linear equation determined by the (X, Y) pairs

292+ >>> :{

293+ let

294+ expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

295+ expression = regrIntercept (All (#y *: #x))

296+ in printSQL expression

297+ :}

298+ regr_intercept(ALL "y", "x")

299+ -}

300+ regrIntercept

301+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

302+ -> aggr ('Null 'PGfloat8)

303+

304+ -- | @regr_r2(Y, X)@, square of the correlation coefficient

305+ regrR2

306+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

307+ -> aggr ('Null 'PGfloat8)

308+

309+ -- | @regr_slope(Y, X)@, slope of the least-squares-fit linear equation

310+ -- determined by the (X, Y) pairs

311+ regrSlope

312+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

313+ -> aggr ('Null 'PGfloat8)

314+

315+ -- | @regr_sxx(Y, X)@, sum(X^2) - sum(X)^2/N

316+ -- (“sum of squares” of the independent variable)

317+ regrSxx

318+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

319+ -> aggr ('Null 'PGfloat8)

320+

321+ -- | @regr_sxy(Y, X)@, sum(X*Y) - sum(X) * sum(Y)/N

322+ -- (“sum of products” of independent times dependent variable)

323+ regrSxy

324+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

325+ -> aggr ('Null 'PGfloat8)

326+

327+ -- | @regr_syy(Y, X)@, sum(Y^2) - sum(Y)^2/N

328+ -- (“sum of squares” of the dependent variable)

329+ regrSyy

330+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

331+ -> aggr ('Null 'PGfloat8)

332+

333+ -- | historical alias for `stddevSamp`

334+ stddev

335+ :: expr1 (null ty)

336+ -> aggr ('Null (PGAvg ty))

337+

338+ -- | population standard deviation of the input values

339+ stddevPop

340+ :: expr1 (null ty)

341+ -> aggr ('Null (PGAvg ty))

342+

343+ -- | sample standard deviation of the input values

344+ stddevSamp

345+ :: expr1 (null ty)

346+ -> aggr ('Null (PGAvg ty))

347+

348+ -- | historical alias for `varSamp`

349+ variance

350+ :: expr1 (null ty)

351+ -> aggr ('Null (PGAvg ty))

352+

353+ -- | population variance of the input values

354+ -- (square of the population standard deviation)

355+ varPop

356+ :: expr1 (null ty)

357+ -> aggr ('Null (PGAvg ty))

358+

359+ -- | sample variance of the input values

360+ -- (square of the sample standard deviation)

361+ varSamp

362+ :: expr1 (null ty)

363+ -> aggr ('Null (PGAvg ty))

364+

365+{- |

366+`Distinction`s are used for the input of `Aggregate` `Expression`s.

367+`All` invokes the aggregate once for each input row.

368+`Distinct` invokes the aggregate once for each distinct value of the expression

369+(or distinct set of values, for multiple expressions) found in the input

370+-}

371+data Distinction (expr :: kind -> Type) (ty :: kind)

372+ = All (expr ty)

373+ | Distinct (expr ty)

374+ deriving (GHC.Generic,Show,Eq,Ord)

375+instance NFData (Distinction (Expression outer commons grp schemas params from) ty)

376+instance RenderSQL (Distinction (Expression outer commons grp schemas params from) ty) where

377+ renderSQL = \case

378+ All x -> "ALL" <+> renderSQL x

379+ Distinct x -> "DISTINCT" <+> renderSQL x

380+instance SOP.SListI tys => RenderSQL

381+ (Distinction (NP (Expression outer commons grp schemas params from)) tys) where

382+ renderSQL = \case

383+ All xs -> "ALL" <+> renderCommaSeparated renderSQL xs

384+ Distinct xs -> "DISTINCT" <+> renderCommaSeparated renderSQL xs

385+

386+instance Aggregate

387+ (Distinction (Expression outer commons 'Ungrouped schemas params from))

388+ (Distinction (NP (Expression outer commons 'Ungrouped schemas params from)))

389+ (Expression outer commons ('Grouped bys) schemas params from) where

390+ countStar = UnsafeExpression "count(*)"

391+ count = unsafeAggregate1 "count"

392+ sum_ = unsafeAggregate1 "sum"

393+ arrayAgg = unsafeAggregate1 "array_agg"

394+ jsonAgg = unsafeAggregate1 "json_agg"

395+ jsonbAgg = unsafeAggregate1 "jsonb_agg"

396+ bitAnd = unsafeAggregate1 "bit_and"

397+ bitOr = unsafeAggregate1 "bit_or"

398+ boolAnd = unsafeAggregate1 "bool_and"

399+ boolOr = unsafeAggregate1 "bool_or"

400+ every = unsafeAggregate1 "every"

401+ max_ = unsafeAggregate1 "max"

402+ min_ = unsafeAggregate1 "min"

403+ avg = unsafeAggregate1 "avg"

404+ corr = unsafeAggregateN "corr"

405+ covarPop = unsafeAggregateN "covar_pop"

406+ covarSamp = unsafeAggregateN "covar_samp"

407+ regrAvgX = unsafeAggregateN "regr_avgx"

408+ regrAvgY = unsafeAggregateN "regr_avgy"

409+ regrCount = unsafeAggregateN "regr_count"

410+ regrIntercept = unsafeAggregateN "regr_intercept"

411+ regrR2 = unsafeAggregateN "regr_r2"

412+ regrSlope = unsafeAggregateN "regr_slope"

413+ regrSxx = unsafeAggregateN "regr_sxx"

414+ regrSxy = unsafeAggregateN "regr_sxy"

415+ regrSyy = unsafeAggregateN "regr_syy"

416+ stddev = unsafeAggregate1 "stddev"

417+ stddevPop = unsafeAggregate1 "stddev_pop"

418+ stddevSamp = unsafeAggregate1 "stddev_samp"

419+ variance = unsafeAggregate1 "variance"

420+ varPop = unsafeAggregate1 "var_pop"

421+ varSamp = unsafeAggregate1 "var_samp"

422+

423+-- | escape hatch to define aggregate functions

424+unsafeAggregate1

425+ :: ByteString -- ^ aggregate function

426+ -> Distinction (Expression outer commons 'Ungrouped schemas params from) x

427+ -> Expression outer commons ('Grouped bys) schemas params from y

428+unsafeAggregate1 fun x = UnsafeExpression $ fun <> parenthesized (renderSQL x)

429+

430+unsafeAggregateN

431+ :: SOP.SListI xs

432+ => ByteString -- ^ function

433+ -> Distinction (NP (Expression outer commons 'Ungrouped schemas params from)) xs

434+ -> Expression outer commons ('Grouped bys) schemas params from y

435+unsafeAggregateN fun xs = UnsafeExpression $ fun <> parenthesized (renderSQL xs)

436+

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+

452+-- | A type family that calculates `PGAvg` type of a `PGType`.

453+type family PGAvg ty where

454+ PGAvg 'PGint2 = 'PGnumeric

455+ PGAvg 'PGint4 = 'PGnumeric

456+ PGAvg 'PGint8 = 'PGnumeric

457+ PGAvg 'PGnumeric = 'PGnumeric

458+ PGAvg 'PGfloat4 = 'PGfloat8

459+ PGAvg 'PGfloat8 = 'PGfloat8

460+ PGAvg 'PGinterval = 'PGinterval

461+ PGAvg pg = TypeError

462+ ('Text "Squeal type error: No average for " ':<>: 'ShowType pg)

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Collection.hsnew file+169

@@ -0,0 +1,169 @@

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

8+Array and composite functions

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , DataKinds

14+ , FlexibleContexts

15+ , FlexibleInstances

16+ , MultiParamTypeClasses

17+ , OverloadedLabels

18+ , OverloadedStrings

19+ , RankNTypes

20+ , ScopedTypeVariables

21+ , TypeApplications

22+ , TypeFamilies

23+ , TypeOperators

24+ , UndecidableInstances

25+#-}

26+

27+module Squeal.PostgreSQL.Expression.Collection

28+ ( array

29+ , array1

30+ , array2

31+ , cardinality

32+ , index

33+ , unnest

34+ , row

35+ , field

36+ ) where

37+

38+import Data.String

39+import Data.Word (Word64)

40+

41+import qualified Generics.SOP as SOP

42+

43+import Squeal.PostgreSQL.Alias

44+import Squeal.PostgreSQL.Expression

45+import Squeal.PostgreSQL.Expression.Set

46+import Squeal.PostgreSQL.List

47+import Squeal.PostgreSQL.Render

48+import Squeal.PostgreSQL.Schema

49+

50+-- $setup

51+-- >>> import Squeal.PostgreSQL

52+

53+-- | >>> printSQL $ array [null_, false, true]

54+-- ARRAY[NULL, FALSE, TRUE]

55+array

56+ :: [Expression outer commons grp schemas params from ty]

57+ -- ^ array elements

58+ -> Expression outer commons grp schemas params from (null ('PGvararray ty))

59+array xs = UnsafeExpression $ "ARRAY" <>

60+ bracketed (commaSeparated (renderSQL <$> xs))

61+

62+{- | construct a 1-dimensional fixed length array

63+

64+>>> printSQL $ array1 (null_ :* false *: true)

65+ARRAY[NULL, FALSE, TRUE]

66+

67+>>> :type array1 (null_ :* false *: true)

68+array1 (null_ :* false *: true)

69+ :: Expression

70+ outer

71+ commons

72+ grp

73+ schemas

74+ params

75+ from

76+ (null ('PGfixarray '[3] ('Null 'PGbool)))

77+-}

78+array1

79+ :: (n ~ Length tys, SOP.All ((~) ty) tys)

80+ => NP (Expression outer commons grp schemas params from) tys

81+ -> Expression outer commons grp schemas params from (null ('PGfixarray '[n] ty))

82+array1 xs = UnsafeExpression $ "ARRAY" <>

83+ bracketed (renderCommaSeparated renderSQL xs)

84+

85+{- | construct a 2-dimensional fixed length array

86+

87+>>> printSQL $ array2 ((null_ :* false *: true) *: (false :* null_ *: true))

88+ARRAY[[NULL, FALSE, TRUE], [FALSE, NULL, TRUE]]

89+

90+>>> :type array2 ((null_ :* false *: true) *: (false :* null_ *: true))

91+array2 ((null_ :* false *: true) *: (false :* null_ *: true))

92+ :: Expression

93+ outer

94+ commons

95+ grp

96+ schemas

97+ params

98+ from

99+ (null ('PGfixarray '[2, 3] ('Null 'PGbool)))

100+-}

101+array2

102+ :: ( SOP.All ((~) tys) tyss

103+ , SOP.All SOP.SListI tyss

104+ , Length tyss ~ n1

105+ , SOP.All ((~) ty) tys

106+ , Length tys ~ n2 )

107+ => NP (NP (Expression outer commons grp schemas params from)) tyss

108+ -> Expression outer commons grp schemas params from (null ('PGfixarray '[n1,n2] ty))

109+array2 xss = UnsafeExpression $ "ARRAY" <>

110+ bracketed (renderCommaSeparatedConstraint @SOP.SListI (bracketed . renderCommaSeparated renderSQL) xss)

111+

112+-- | >>> printSQL $ cardinality (array [null_, false, true])

113+-- cardinality(ARRAY[NULL, FALSE, TRUE])

114+cardinality :: null ('PGvararray ty) --> null 'PGint8

115+cardinality = unsafeFunction "cardinality"

116+

117+-- | >>> printSQL $ array [null_, false, true] & index 2

118+-- (ARRAY[NULL, FALSE, TRUE])[2]

119+index

120+ :: Word64 -- ^ index

121+ -> null ('PGvararray ty) --> NullifyType ty

122+index n expr = UnsafeExpression $

123+ parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"

124+

125+-- | Expand an array to a set of rows

126+unnest :: SetFunction "unnest" (null ('PGvararray ty)) '["unnest" ::: ty]

127+unnest = unsafeSetFunction

128+

129+-- | A row constructor is an expression that builds a row value

130+-- (also called a composite value) using values for its member fields.

131+--

132+-- >>> :{

133+-- type Complex = 'PGcomposite

134+-- '[ "real" ::: 'NotNull 'PGfloat8

135+-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

136+-- :}

137+--

138+-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression outer commons grp schemas params from ('NotNull Complex)

139+-- >>> printSQL i

140+-- ROW(0, 1)

141+row

142+ :: SOP.SListI row

143+ => NP (Aliased (Expression outer commons grp schemas params from)) row

144+ -- ^ zero or more expressions for the row field values

145+ -> Expression outer commons grp schemas params from (null ('PGcomposite row))

146+row exprs = UnsafeExpression $ "ROW" <> parenthesized

147+ (renderCommaSeparated (\ (expr `As` _) -> renderSQL expr) exprs)

148+

149+-- | >>> :{

150+-- type Complex = 'PGcomposite

151+-- '[ "real" ::: 'NotNull 'PGfloat8

152+-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

153+-- type Schema = '["complex" ::: 'Typedef Complex]

154+-- :}

155+--

156+-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression outer '[] grp (Public Schema) from params ('NotNull Complex)

157+-- >>> printSQL $ i & field #complex #imaginary

158+-- (ROW(0, 1)::"complex")."imaginary"

159+field

160+ :: ( Has sch schemas schema

161+ , Has tydef schema ('Typedef ('PGcomposite row))

162+ , Has field row ty)

163+ => QualifiedAlias sch tydef -- ^ row type

164+ -> Alias field -- ^ field name

165+ -> Expression outer commons grp schemas params from ('NotNull ('PGcomposite row))

166+ -> Expression outer commons grp schemas params from ty

167+field td fld expr = UnsafeExpression $

168+ parenthesized (renderSQL expr <> "::" <> renderSQL td)

169+ <> "." <> renderSQL fld

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Comparison.hsnew file+206

@@ -0,0 +1,206 @@

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

8+Comparison functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ OverloadedStrings

13+ , RankNTypes

14+ , TypeInType

15+ , TypeOperators

16+#-}

17+

18+module Squeal.PostgreSQL.Expression.Comparison

19+ ( (.==)

20+ , (./=)

21+ , (.>=)

22+ , (.<)

23+ , (.<=)

24+ , (.>)

25+ , greatest

26+ , least

27+ , BetweenExpr

28+ , between

29+ , notBetween

30+ , betweenSymmetric

31+ , notBetweenSymmetric

32+ , isDistinctFrom

33+ , isNotDistinctFrom

34+ , isTrue

35+ , isNotTrue

36+ , isFalse

37+ , isNotFalse

38+ , isUnknown

39+ , isNotUnknown

40+ ) where

41+

42+import Data.ByteString

43+

44+import Squeal.PostgreSQL.Expression

45+import Squeal.PostgreSQL.Expression.Logic

46+import Squeal.PostgreSQL.Render

47+import Squeal.PostgreSQL.Schema

48+

49+-- $setup

50+-- >>> import Squeal.PostgreSQL

51+

52+-- | Comparison operations like `.==`, `./=`, `.>`, `.>=`, `.<` and `.<=`

53+-- will produce @NULL@s if one of their arguments is @NULL@.

54+--

55+-- >>> printSQL $ true .== null_

56+-- (TRUE = NULL)

57+(.==) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

58+(.==) = unsafeBinaryOp "="

59+infix 4 .==

60+

61+-- | >>> printSQL $ true ./= null_

62+-- (TRUE <> NULL)

63+(./=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

64+(./=) = unsafeBinaryOp "<>"

65+infix 4 ./=

66+

67+-- | >>> printSQL $ true .>= null_

68+-- (TRUE >= NULL)

69+(.>=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

70+(.>=) = unsafeBinaryOp ">="

71+infix 4 .>=

72+

73+-- | >>> printSQL $ true .< null_

74+-- (TRUE < NULL)

75+(.<) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

76+(.<) = unsafeBinaryOp "<"

77+infix 4 .<

78+

79+-- | >>> printSQL $ true .<= null_

80+-- (TRUE <= NULL)

81+(.<=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

82+(.<=) = unsafeBinaryOp "<="

83+infix 4 .<=

84+

85+-- | >>> printSQL $ true .> null_

86+-- (TRUE > NULL)

87+(.>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

88+(.>) = unsafeBinaryOp ">"

89+infix 4 .>

90+

91+-- | >>> let expr = greatest [param @1] currentTimestamp :: Expression outer commons grp schemas '[ 'NotNull 'PGtimestamptz] from ('NotNull 'PGtimestamptz)

92+-- >>> printSQL expr

93+-- GREATEST(($1 :: timestamp with time zone), CURRENT_TIMESTAMP)

94+greatest :: FunctionVar ty ty ty

95+greatest = unsafeFunctionVar "GREATEST"

96+

97+-- | >>> printSQL $ least [null_] currentTimestamp

98+-- LEAST(NULL, CURRENT_TIMESTAMP)

99+least :: FunctionVar ty ty ty

100+least = unsafeFunctionVar "LEAST"

101+

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+

116+{- | >>> printSQL $ true `between` (null_, false)

117+TRUE BETWEEN NULL AND FALSE

118+-}

119+between :: BetweenExpr

120+between = unsafeBetweenExpr "BETWEEN"

121+

122+{- | >>> printSQL $ true `notBetween` (null_, false)

123+TRUE NOT BETWEEN NULL AND FALSE

124+-}

125+notBetween :: BetweenExpr

126+notBetween = unsafeBetweenExpr "NOT BETWEEN"

127+

128+{- | between, after sorting the comparison values

129+

130+>>> printSQL $ true `betweenSymmetric` (null_, false)

131+TRUE BETWEEN SYMMETRIC NULL AND FALSE

132+-}

133+betweenSymmetric :: BetweenExpr

134+betweenSymmetric = unsafeBetweenExpr "BETWEEN SYMMETRIC"

135+

136+{- | not between, after sorting the comparison values

137+

138+>>> printSQL $ true `notBetweenSymmetric` (null_, false)

139+TRUE NOT BETWEEN SYMMETRIC NULL AND FALSE

140+-}

141+notBetweenSymmetric :: BetweenExpr

142+notBetweenSymmetric = unsafeBetweenExpr "NOT BETWEEN SYMMETRIC"

143+

144+{- | not equal, treating null like an ordinary value

145+

146+>>> printSQL $ true `isDistinctFrom` null_

147+(TRUE IS DISTINCT FROM NULL)

148+-}

149+isDistinctFrom :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

150+isDistinctFrom = unsafeBinaryOp "IS DISTINCT FROM"

151+

152+{- | equal, treating null like an ordinary value

153+

154+>>> printSQL $ true `isNotDistinctFrom` null_

155+(TRUE IS NOT DISTINCT FROM NULL)

156+-}

157+isNotDistinctFrom :: Operator (null0 ty) (null1 ty) ('NotNull 'PGbool)

158+isNotDistinctFrom = unsafeBinaryOp "IS NOT DISTINCT FROM"

159+

160+{- | is true

161+

162+>>> printSQL $ true & isTrue

163+(TRUE IS TRUE)

164+-}

165+isTrue :: null0 'PGbool --> null1 'PGbool

166+isTrue = unsafeRightOp "IS TRUE"

167+

168+{- | is false or unknown

169+

170+>>> printSQL $ true & isNotTrue

171+(TRUE IS NOT TRUE)

172+-}

173+isNotTrue :: null0 'PGbool --> null1 'PGbool

174+isNotTrue = unsafeRightOp "IS NOT TRUE"

175+

176+{- | is false

177+

178+>>> printSQL $ true & isFalse

179+(TRUE IS FALSE)

180+-}

181+isFalse :: null0 'PGbool --> null1 'PGbool

182+isFalse = unsafeRightOp "IS FALSE"

183+

184+{- | is true or unknown

185+

186+>>> printSQL $ true & isNotFalse

187+(TRUE IS NOT FALSE)

188+-}

189+isNotFalse :: null0 'PGbool --> null1 'PGbool

190+isNotFalse = unsafeRightOp "IS NOT FALSE"

191+

192+{- | is unknown

193+

194+>>> printSQL $ true & isUnknown

195+(TRUE IS UNKNOWN)

196+-}

197+isUnknown :: null0 'PGbool --> null1 'PGbool

198+isUnknown = unsafeRightOp "IS UNKNOWN"

199+

200+{- | is true or false

201+

202+>>> printSQL $ true & isNotUnknown

203+(TRUE IS NOT UNKNOWN)

204+-}

205+isNotUnknown :: null0 'PGbool --> null1 'PGbool

206+isNotUnknown = unsafeRightOp "IS NOT UNKNOWN"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Json.hsnew file+462

@@ -0,0 +1,462 @@

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

8+Json and Jsonb functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , FlexibleContexts

14+ , FlexibleInstances

15+ , GADTs

16+ , OverloadedLabels

17+ , OverloadedStrings

18+ , PolyKinds

19+ , RankNTypes

20+ , ScopedTypeVariables

21+ , TypeApplications

22+ , TypeOperators

23+ , UndecidableInstances

24+ , UndecidableSuperClasses

25+#-}

26+

27+module Squeal.PostgreSQL.Expression.Json

28+ ( -- * Json and Jsonb operators

29+ (.->)

30+ , (.->>)

31+ , (.#>)

32+ , (.#>>)

33+ -- * Jsonb operators

34+ , (.?)

35+ , (.?|)

36+ , (.?&)

37+ , (.-.)

38+ , (#-.)

39+ -- * Json and Jsonb functions

40+ , toJson

41+ , toJsonb

42+ , arrayToJson

43+ , rowToJson

44+ , jsonBuildArray

45+ , jsonbBuildArray

46+ , JsonBuildObject (..)

47+ , jsonObject

48+ , jsonbObject

49+ , jsonZipObject

50+ , jsonbZipObject

51+ , jsonArrayLength

52+ , jsonbArrayLength

53+ , jsonTypeof

54+ , jsonbTypeof

55+ , jsonStripNulls

56+ , jsonbStripNulls

57+ , jsonbSet

58+ , jsonbInsert

59+ , 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

77+ ) where

78+

79+import Data.ByteString (ByteString)

80+import GHC.TypeLits

81+

82+import Squeal.PostgreSQL.Alias

83+import Squeal.PostgreSQL.Expression

84+import Squeal.PostgreSQL.Expression.Set

85+import Squeal.PostgreSQL.Expression.Type

86+import Squeal.PostgreSQL.List

87+import Squeal.PostgreSQL.Query

88+import Squeal.PostgreSQL.Render

89+import Squeal.PostgreSQL.Schema

90+

91+import qualified Generics.SOP as SOP

92+

93+-- $setup

94+-- >>> import Squeal.PostgreSQL

95+-- >>> import Data.Aeson

96+

97+{-----------------------------------------

98+ -- json and jsonb support

99+

100+See https://www.postgresql.org/docs/10/static/functions-json.html -- most

101+comments lifted directly from this page.

102+

103+Table 9.44: json and jsonb operators

104+-----------------------------------------}

105+

106+-- | Get JSON value (object field or array element) at a key.

107+(.->)

108+ :: (json `In` PGJsonType, key `In` PGJsonKey)

109+ => Operator (null json) (null key) ('Null json)

110+infixl 8 .->

111+(.->) = unsafeBinaryOp "->"

112+

113+-- | Get JSON value (object field or array element) at a key, as text.

114+(.->>)

115+ :: (json `In` PGJsonType, key `In` PGJsonKey)

116+ => Operator (null json) (null key) ('Null 'PGtext)

117+infixl 8 .->>

118+(.->>) = unsafeBinaryOp "->>"

119+

120+-- | Get JSON value at a specified path.

121+(.#>)

122+ :: json `In` PGJsonType

123+ => Operator (null json) (null ('PGvararray ('NotNull 'PGtext))) ('Null json)

124+infixl 8 .#>

125+(.#>) = unsafeBinaryOp "#>"

126+

127+-- | Get JSON value at a specified path as text.

128+(.#>>)

129+ :: json `In` PGJsonType

130+ => Operator (null json) (null ('PGvararray ('NotNull 'PGtext))) ('Null 'PGtext)

131+infixl 8 .#>>

132+(.#>>) = unsafeBinaryOp "#>>"

133+

134+-- Additional jsonb operators

135+

136+-- | Does the string exist as a top-level key within the JSON value?

137+(.?) :: Operator (null 'PGjsonb) (null 'PGtext) ('Null 'PGbool)

138+infixl 9 .?

139+(.?) = unsafeBinaryOp "?"

140+

141+-- | Do any of these array strings exist as top-level keys?

142+(.?|) :: Operator

143+ (null 'PGjsonb)

144+ (null ('PGvararray ('NotNull 'PGtext)))

145+ ('Null 'PGbool)

146+infixl 9 .?|

147+(.?|) = unsafeBinaryOp "?|"

148+

149+-- | Do all of these array strings exist as top-level keys?

150+(.?&) :: Operator

151+ (null 'PGjsonb)

152+ (null ('PGvararray ('NotNull 'PGtext)))

153+ ('Null 'PGbool)

154+infixl 9 .?&

155+(.?&) = unsafeBinaryOp "?&"

156+

157+-- | Delete a key or keys from a JSON object, or remove an array element.

158+--

159+-- If the right operand is

160+--

161+-- @ text @: Delete key / value pair or string element from left operand.

162+-- Key / value pairs are matched based on their key value,

163+--

164+-- @ text[] @: Delete multiple key / value pairs or string elements

165+-- from left operand. Key / value pairs are matched based on their key value,

166+--

167+-- @ integer @: Delete the array element with specified index (Negative integers

168+-- count from the end). Throws an error if top level container is not an array.

169+(.-.)

170+ :: key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]

171+ => Operator (null 'PGjsonb) (null key) (null 'PGjsonb)

172+infixl 6 .-.

173+(.-.) = unsafeBinaryOp "-"

174+

175+-- | Delete the field or element with specified path (for JSON arrays, negative

176+-- integers count from the end)

177+(#-.) :: Operator (null 'PGjsonb) (null ('PGvararray ('NotNull 'PGtext))) (null 'PGjsonb)

178+infixl 6 #-.

179+(#-.) = unsafeBinaryOp "#-"

180+

181+{-----------------------------------------

182+Table 9.45: JSON creation functions

183+-----------------------------------------}

184+

185+-- | Returns the value as json. Arrays and composites are converted

186+-- (recursively) to arrays and objects; otherwise, if there is a cast from the

187+-- type to json, the cast function will be used to perform the conversion;

188+-- otherwise, a scalar value is produced. For any scalar type other than a

189+-- number, a Boolean, or a null value, the text representation will be used, in

190+-- such a fashion that it is a valid json value.

191+toJson :: null ty --> null 'PGjson

192+toJson = unsafeFunction "to_json"

193+

194+-- | Returns the value as jsonb. Arrays and composites are converted

195+-- (recursively) to arrays and objects; otherwise, if there is a cast from the

196+-- type to json, the cast function will be used to perform the conversion;

197+-- otherwise, a scalar value is produced. For any scalar type other than a

198+-- number, a Boolean, or a null value, the text representation will be used, in

199+-- such a fashion that it is a valid jsonb value.

200+toJsonb :: null ty --> null 'PGjsonb

201+toJsonb = unsafeFunction "to_jsonb"

202+

203+-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

204+-- becomes a JSON array of arrays.

205+arrayToJson :: null ('PGvararray ty) --> null 'PGjson

206+arrayToJson = unsafeFunction "array_to_json"

207+

208+-- | Returns the row as a JSON object.

209+rowToJson :: null ('PGcomposite ty) --> null 'PGjson

210+rowToJson = unsafeFunction "row_to_json"

211+

212+-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

213+-- argument list.

214+jsonBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjson

215+jsonBuildArray = unsafeFunctionN "json_build_array"

216+

217+-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

218+-- variadic argument list.

219+jsonbBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjsonb

220+jsonbBuildArray = unsafeFunctionN "jsonb_build_array"

221+

222+-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

223+-- argument list. The elements of the argument list must alternate between text

224+-- and values.

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)

236+

237+-- | Builds a JSON object out of a text array.

238+-- The array must have two dimensions

239+-- such that each inner array has exactly two elements,

240+-- which are taken as a key/value pair.

241+jsonObject

242+ :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

243+ --> null 'PGjson

244+jsonObject = unsafeFunction "json_object"

245+

246+-- | Builds a binary JSON object out of a text array.

247+-- The array must have two dimensions

248+-- such that each inner array has exactly two elements,

249+-- which are taken as a key/value pair.

250+jsonbObject

251+ :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

252+ --> null 'PGjsonb

253+jsonbObject = unsafeFunction "jsonb_object"

254+

255+-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

256+-- keys and one for values, that are zipped pairwise to create a JSON object.

257+jsonZipObject ::

258+ '[ null ('PGvararray ('NotNull 'PGtext))

259+ , null ('PGvararray ('NotNull 'PGtext)) ]

260+ ---> null 'PGjson

261+jsonZipObject = unsafeFunctionN "json_object"

262+

263+-- | This is an alternate form of 'jsonbObject' that takes two arrays; one for

264+-- keys and one for values, that are zipped pairwise to create a binary JSON

265+-- object.

266+jsonbZipObject ::

267+ '[ null ('PGvararray ('NotNull 'PGtext))

268+ , null ('PGvararray ('NotNull 'PGtext)) ]

269+ ---> null 'PGjsonb

270+jsonbZipObject = unsafeFunctionN "jsonb_object"

271+

272+{-----------------------------------------

273+Table 9.46: JSON processing functions

274+-----------------------------------------}

275+

276+-- | Returns the number of elements in the outermost JSON array.

277+jsonArrayLength :: null 'PGjson --> null 'PGint4

278+jsonArrayLength = unsafeFunction "json_array_length"

279+

280+-- | Returns the number of elements in the outermost binary JSON array.

281+jsonbArrayLength :: null 'PGjsonb --> null 'PGint4

282+jsonbArrayLength = unsafeFunction "jsonb_array_length"

283+

284+-- | Returns the type of the outermost JSON value as a text string. Possible

285+-- types are object, array, string, number, boolean, and null.

286+jsonTypeof :: null 'PGjson --> null 'PGtext

287+jsonTypeof = unsafeFunction "json_typeof"

288+

289+-- | Returns the type of the outermost binary JSON value as a text string.

290+-- Possible types are object, array, string, number, boolean, and null.

291+jsonbTypeof :: null 'PGjsonb --> null 'PGtext

292+jsonbTypeof = unsafeFunction "jsonb_typeof"

293+

294+-- | Returns its argument with all object fields that have null values omitted.

295+-- Other null values are untouched.

296+jsonStripNulls :: null 'PGjson --> null 'PGjson

297+jsonStripNulls = unsafeFunction "json_strip_nulls"

298+

299+-- | Returns its argument with all object fields that have null values omitted.

300+-- Other null values are untouched.

301+jsonbStripNulls :: null 'PGjsonb --> null 'PGjsonb

302+jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

303+

304+-- | @ jsonbSet target path new_value create_missing @

305+--

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

309+-- item designated by path does not exist. As with the path orientated

310+-- operators, negative integers that appear in path count from the end of JSON

311+-- arrays.

312+jsonbSet ::

313+ '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

314+ , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

315+jsonbSet = unsafeFunctionN "jsonbSet"

316+

317+-- | @ jsonbInsert target path new_value insert_after @

318+--

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

324+-- exist. As with the path orientated operators, negative integers that appear

325+-- in path count from the end of JSON arrays.

326+jsonbInsert ::

327+ '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

328+ , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

329+jsonbInsert = unsafeFunctionN "jsonb_insert"

330+

331+-- | Returns its argument as indented JSON text.

332+jsonbPretty :: null 'PGjsonb --> null 'PGtext

333+jsonbPretty = 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

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.hsnew file+105

@@ -0,0 +1,105 @@

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

8+Logical expressions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.Logic

18+ ( Condition

19+ , true

20+ , false

21+ , not_

22+ , (.&&)

23+ , (.||)

24+ , caseWhenThenElse

25+ , ifThenElse

26+ ) where

27+

28+import Squeal.PostgreSQL.Expression

29+import Squeal.PostgreSQL.Render

30+import Squeal.PostgreSQL.Schema

31+

32+-- | A `Condition` is an `Expression`, which can evaluate

33+-- to `true`, `false` or `Squeal.PostgreSQL.Null.null_`. This is because SQL uses

34+-- a three valued logic.

35+type Condition outer commons grp schemas params from =

36+ Expression outer commons grp schemas params from ('Null 'PGbool)

37+

38+-- | >>> printSQL true

39+-- TRUE

40+true :: Expr (null 'PGbool)

41+true = UnsafeExpression "TRUE"

42+

43+-- | >>> printSQL false

44+-- FALSE

45+false :: Expr (null 'PGbool)

46+false = UnsafeExpression "FALSE"

47+

48+-- | >>> printSQL $ not_ true

49+-- (NOT TRUE)

50+not_ :: null 'PGbool --> null 'PGbool

51+not_ = unsafeLeftOp "NOT"

52+

53+-- | >>> printSQL $ true .&& false

54+-- (TRUE AND FALSE)

55+(.&&) :: Operator (null 'PGbool) (null 'PGbool) (null 'PGbool)

56+infixr 3 .&&

57+(.&&) = unsafeBinaryOp "AND"

58+

59+-- | >>> printSQL $ true .|| false

60+-- (TRUE OR FALSE)

61+(.||) :: Operator (null 'PGbool) (null 'PGbool) (null 'PGbool)

62+infixr 2 .||

63+(.||) = unsafeBinaryOp "OR"

64+

65+-- | >>> :{

66+-- let

67+-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

68+-- expression = caseWhenThenElse [(true, 1), (false, 2)] 3

69+-- in printSQL expression

70+-- :}

71+-- CASE WHEN TRUE THEN 1 WHEN FALSE THEN 2 ELSE 3 END

72+caseWhenThenElse

73+ :: [ ( Condition outer commons grp schemas params from

74+ , Expression outer commons grp schemas params from ty

75+ ) ]

76+ -- ^ whens and thens

77+ -> Expression outer commons grp schemas params from ty

78+ -- ^ else

79+ -> Expression outer commons grp schemas params from ty

80+caseWhenThenElse whenThens else_ = UnsafeExpression $ mconcat

81+ [ "CASE"

82+ , mconcat

83+ [ mconcat

84+ [ " WHEN ", renderSQL when_

85+ , " THEN ", renderSQL then_

86+ ]

87+ | (when_,then_) <- whenThens

88+ ]

89+ , " ELSE ", renderSQL else_

90+ , " END"

91+ ]

92+

93+-- | >>> :{

94+-- let

95+-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

96+-- expression = ifThenElse true 1 0

97+-- in printSQL expression

98+-- :}

99+-- CASE WHEN TRUE THEN 1 ELSE 0 END

100+ifThenElse

101+ :: Condition outer commons grp schemas params from

102+ -> Expression outer commons grp schemas params from ty -- ^ then

103+ -> Expression outer commons grp schemas params from ty -- ^ else

104+ -> Expression outer commons grp schemas params from ty

105+ifThenElse if_ then_ else_ = caseWhenThenElse [(if_,then_)] else_

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Math.hsnew file+100

@@ -0,0 +1,100 @@

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

8+Mathematical functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.Math

18+ ( atan2_

19+ , quot_

20+ , rem_

21+ , trunc

22+ , round_

23+ , ceiling_

24+ ) where

25+

26+import Squeal.PostgreSQL.Expression

27+import Squeal.PostgreSQL.List

28+import Squeal.PostgreSQL.Schema

29+

30+-- $setup

31+-- >>> import Squeal.PostgreSQL

32+

33+-- | >>> :{

34+-- let

35+-- expression :: Expr (null 'PGfloat4)

36+-- expression = atan2_ (pi *: 2)

37+-- in printSQL expression

38+-- :}

39+-- atan2(pi(), 2)

40+atan2_ :: float `In` PGFloating => '[ null float, null float] ---> null float

41+atan2_ = unsafeFunctionN "atan2"

42+

43+

44+-- | integer division, truncates the result

45+--

46+-- >>> :{

47+-- let

48+-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

49+-- expression = 5 `quot_` 2

50+-- in printSQL expression

51+-- :}

52+-- (5 / 2)

53+quot_

54+ :: int `In` PGIntegral

55+ => Operator (null int) (null int) (null int)

56+quot_ = unsafeBinaryOp "/"

57+

58+-- | remainder upon integer division

59+--

60+-- >>> :{

61+-- let

62+-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

63+-- expression = 5 `rem_` 2

64+-- in printSQL expression

65+-- :}

66+-- (5 % 2)

67+rem_

68+ :: int `In` PGIntegral

69+ => Operator (null int) (null int) (null int)

70+rem_ = unsafeBinaryOp "%"

71+

72+-- | >>> :{

73+-- let

74+-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

75+-- expression = trunc pi

76+-- in printSQL expression

77+-- :}

78+-- trunc(pi())

79+trunc :: frac `In` PGFloating => null frac --> null frac

80+trunc = unsafeFunction "trunc"

81+

82+-- | >>> :{

83+-- let

84+-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

85+-- expression = round_ pi

86+-- in printSQL expression

87+-- :}

88+-- round(pi())

89+round_ :: frac `In` PGFloating => null frac --> null frac

90+round_ = unsafeFunction "round"

91+

92+-- | >>> :{

93+-- let

94+-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

95+-- expression = ceiling_ pi

96+-- in printSQL expression

97+-- :}

98+-- ceiling(pi())

99+ceiling_ :: frac `In` PGFloating => null frac --> null frac

100+ceiling_ = unsafeFunction "ceiling"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Null.hsnew file+104

@@ -0,0 +1,104 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Null

3+Description: Null

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Null values and null handling functions

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.Null

18+ ( null_

19+ , notNull

20+ , coalesce

21+ , fromNull

22+ , isNull

23+ , isNotNull

24+ , matchNull

25+ , nullIf

26+ ) where

27+

28+import Squeal.PostgreSQL.Expression

29+import Squeal.PostgreSQL.Expression.Logic

30+import Squeal.PostgreSQL.Render

31+import Squeal.PostgreSQL.Schema

32+

33+-- $setup

34+-- >>> import Squeal.PostgreSQL

35+

36+-- | analagous to `Nothing`

37+--

38+-- >>> printSQL null_

39+-- NULL

40+null_ :: Expr ('Null ty)

41+null_ = UnsafeExpression "NULL"

42+

43+-- | analagous to `Just`

44+--

45+-- >>> printSQL $ notNull true

46+-- TRUE

47+notNull :: 'NotNull ty --> 'Null ty

48+notNull = UnsafeExpression . renderSQL

49+

50+-- | return the leftmost value which is not NULL

51+--

52+-- >>> printSQL $ coalesce [null_, true] false

53+-- COALESCE(NULL, TRUE, FALSE)

54+coalesce :: FunctionVar ('Null ty) ('NotNull ty) ('NotNull ty)

55+coalesce nullxs notNullx = UnsafeExpression $

56+ "COALESCE" <> parenthesized (commaSeparated

57+ ((renderSQL <$> nullxs) <> [renderSQL notNullx]))

58+

59+-- | analagous to `Data.Maybe.fromMaybe` using @COALESCE@

60+--

61+-- >>> printSQL $ fromNull true null_

62+-- COALESCE(NULL, TRUE)

63+fromNull

64+ :: Expression outer commons grp schemas params from ('NotNull ty)

65+ -- ^ what to convert @NULL@ to

66+ -> Expression outer commons grp schemas params from ('Null ty)

67+ -> Expression outer commons grp schemas params from ('NotNull ty)

68+fromNull notNullx nullx = coalesce [nullx] notNullx

69+

70+-- | >>> printSQL $ null_ & isNull

71+-- NULL IS NULL

72+isNull :: 'Null ty --> null 'PGbool

73+isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"

74+

75+-- | >>> printSQL $ null_ & isNotNull

76+-- NULL IS NOT NULL

77+isNotNull :: 'Null ty --> null 'PGbool

78+isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"

79+

80+-- | analagous to `maybe` using @IS NULL@

81+--

82+-- >>> printSQL $ matchNull true not_ null_

83+-- CASE WHEN NULL IS NULL THEN TRUE ELSE (NOT NULL) END

84+matchNull

85+ :: Expression outer commons grp schemas params from (nullty)

86+ -- ^ what to convert @NULL@ to

87+ -> ( Expression outer commons grp schemas params from ('NotNull ty)

88+ -> Expression outer commons grp schemas params from (nullty) )

89+ -- ^ function to perform when @NULL@ is absent

90+ -> Expression outer commons grp schemas params from ('Null ty)

91+ -> Expression outer commons grp schemas params from (nullty)

92+matchNull y f x = ifThenElse (isNull x) y

93+ (f (UnsafeExpression (renderSQL x)))

94+

95+{-| right inverse to `fromNull`, if its arguments are equal then

96+`nullIf` gives @NULL@.

97+

98+>>> :set -XTypeApplications -XDataKinds

99+>>> let expr = nullIf (false *: param @1) :: Expression outer commons grp schemas '[ 'NotNull 'PGbool] from ('Null 'PGbool)

100+>>> printSQL expr

101+NULLIF(FALSE, ($1 :: bool))

102+-}

103+nullIf :: '[ 'NotNull ty, 'NotNull ty] ---> 'Null ty

104+nullIf = 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

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

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

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.hsnew file+85

@@ -0,0 +1,85 @@

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

8+Sort expressions

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , GADTs

14+ , LambdaCase

15+ , OverloadedStrings

16+ , StandaloneDeriving

17+#-}

18+

19+module Squeal.PostgreSQL.Expression.Sort

20+ ( SortExpression (..)

21+ , OrderBy (..)

22+ ) where

23+

24+import Squeal.PostgreSQL.Expression

25+import Squeal.PostgreSQL.Render

26+import Squeal.PostgreSQL.Schema

27+

28+-- | `SortExpression`s are used by `orderBy` to optionally sort the results

29+-- of a `Squeal.PostgreSQL.Query.Query`. `Asc` or `Desc`

30+-- set the sort direction of a `NotNull` result

31+-- column to ascending or descending. Ascending order puts smaller values

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`,

36+-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to

37+-- determine whether nulls appear before or after non-null values in the sort

38+-- ordering of a `Null` result column.

39+data SortExpression outer commons grp schemas params from where

40+ Asc

41+ :: Expression outer commons grp schemas params from ('NotNull ty)

42+ -> SortExpression outer commons grp schemas params from

43+ Desc

44+ :: Expression outer commons grp schemas params from ('NotNull ty)

45+ -> SortExpression outer commons grp schemas params from

46+ AscNullsFirst

47+ :: Expression outer commons grp schemas params from ('Null ty)

48+ -> SortExpression outer commons grp schemas params from

49+ AscNullsLast

50+ :: Expression outer commons grp schemas params from ('Null ty)

51+ -> SortExpression outer commons grp schemas params from

52+ DescNullsFirst

53+ :: Expression outer commons grp schemas params from ('Null ty)

54+ -> SortExpression outer commons grp schemas params from

55+ DescNullsLast

56+ :: Expression outer commons grp schemas params from ('Null ty)

57+ -> SortExpression outer commons grp schemas params from

58+deriving 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"

69+

70+{- |

71+The `orderBy` clause causes the result rows of a `Squeal.PostgreSQL.Query.TableExpression`

72+to be sorted according to the specified `SortExpression`(s).

73+If two rows are equal according to the leftmost expression,

74+they are compared according to the next expression and so on.

75+If they are equal according to all specified expressions,

76+they are returned in an implementation-dependent order.

77+

78+You can also control the order in which rows are processed by window functions

79+using `orderBy` within `Squeal.PostgreSQL.Query.Over`.

80+-}

81+class OrderBy expr where

82+ orderBy

83+ :: [SortExpression outer commons grp schemas params from]

84+ -> expr outer commons grp schemas params from

85+ -> expr outer commons grp schemas params from

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

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.hsnew file+64

@@ -0,0 +1,64 @@

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

8+String functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.Text

18+ ( lower

19+ , upper

20+ , charLength

21+ , like

22+ , ilike

23+ ) where

24+

25+import Squeal.PostgreSQL.Expression

26+import Squeal.PostgreSQL.Schema

27+

28+-- $setup

29+-- >>> import Squeal.PostgreSQL

30+

31+-- | >>> printSQL $ lower "ARRRGGG"

32+-- lower(E'ARRRGGG')

33+lower :: null 'PGtext --> null 'PGtext

34+lower = unsafeFunction "lower"

35+

36+-- | >>> printSQL $ upper "eeee"

37+-- upper(E'eeee')

38+upper :: null 'PGtext --> null 'PGtext

39+upper = unsafeFunction "upper"

40+

41+-- | >>> printSQL $ charLength "four"

42+-- char_length(E'four')

43+charLength :: null 'PGtext --> null 'PGint4

44+charLength = unsafeFunction "char_length"

45+

46+-- | The `like` expression returns true if the @string@ matches

47+-- the supplied @pattern@. If @pattern@ does not contain percent signs

48+-- or underscores, then the pattern only represents the string itself;

49+-- in that case `like` acts like the equals operator. An underscore (_)

50+-- in pattern stands for (matches) any single character; a percent sign (%)

51+-- matches any sequence of zero or more characters.

52+--

53+-- >>> printSQL $ "abc" `like` "a%"

54+-- (E'abc' LIKE E'a%')

55+like :: Operator (null 'PGtext) (null 'PGtext) ('Null 'PGbool)

56+like = unsafeBinaryOp "LIKE"

57+

58+-- | The key word ILIKE can be used instead of LIKE to make the

59+-- match case-insensitive according to the active locale.

60+--

61+-- >>> printSQL $ "abc" `ilike` "a%"

62+-- (E'abc' ILIKE E'a%')

63+ilike :: Operator (null 'PGtext) (null 'PGtext) ('Null 'PGbool)

64+ilike = unsafeBinaryOp "ILIKE"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/TextSearch.hsnew file+157

@@ -0,0 +1,157 @@

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

8+Text search functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.TextSearch

18+ ( (@@)

19+ , (.&)

20+ , (.|)

21+ , (.!)

22+ , (<->)

23+ , arrayToTSvector

24+ , tsvectorLength

25+ , numnode

26+ , plainToTSquery

27+ , phraseToTSquery

28+ , websearchToTSquery

29+ , queryTree

30+ , toTSquery

31+ , toTSvector

32+ , setWeight

33+ , strip

34+ , jsonToTSvector

35+ , jsonbToTSvector

36+ , tsDelete

37+ , tsFilter

38+ , tsHeadline

39+ ) where

40+

41+import Squeal.PostgreSQL.Expression

42+import Squeal.PostgreSQL.List

43+import Squeal.PostgreSQL.Schema

44+

45+-- | `Squeal.PostgreSQL.Expression.Type.tsvector` matches tsquery ?

46+(@@) :: Operator (null 'PGtsvector) (null 'PGtsquery) ('Null 'PGbool)

47+(@@) = unsafeBinaryOp "@@"

48+

49+-- | AND `Squeal.PostgreSQL.Expression.Type.tsquery`s together

50+(.&) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

51+(.&) = unsafeBinaryOp "&&"

52+

53+-- | OR `Squeal.PostgreSQL.Expression.Type.tsquery`s together

54+(.|) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

55+(.|) = unsafeBinaryOp "||"

56+

57+-- | negate a `Squeal.PostgreSQL.Expression.Type.tsquery`

58+(.!) :: null 'PGtsquery --> null 'PGtsquery

59+(.!) = unsafeLeftOp "!!"

60+

61+-- | `Squeal.PostgreSQL.Expression.Type.tsquery` followed by

62+-- `Squeal.PostgreSQL.Expression.Type.tsquery`

63+(<->) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

64+(<->) = unsafeBinaryOp "<->"

65+

66+-- | convert array of lexemes to `Squeal.PostgreSQL.Expression.Type.tsvector`

67+arrayToTSvector

68+ :: null ('PGvararray ('NotNull 'PGtext))

69+ --> null 'PGtsvector

70+arrayToTSvector = unsafeFunction "array_to_tsvector"

71+

72+-- | number of lexemes in `Squeal.PostgreSQL.Expression.Type.tsvector`

73+tsvectorLength :: null 'PGtsvector --> null 'PGint4

74+tsvectorLength = unsafeFunction "length"

75+

76+-- | number of lexemes plus operators in `Squeal.PostgreSQL.Expression.Type.tsquery`

77+numnode :: null 'PGtsquery --> null 'PGint4

78+numnode = unsafeFunction "numnode"

79+

80+-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` ignoring punctuation

81+plainToTSquery :: null 'PGtext --> null 'PGtsquery

82+plainToTSquery = unsafeFunction "plainto_tsquery"

83+

84+-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` that searches for a phrase,

85+-- ignoring punctuation

86+phraseToTSquery :: null 'PGtext --> null 'PGtsquery

87+phraseToTSquery = unsafeFunction "phraseto_tsquery"

88+

89+-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` from a web search style query

90+websearchToTSquery :: null 'PGtext --> null 'PGtsquery

91+websearchToTSquery = unsafeFunction "websearch_to_tsquery"

92+

93+-- | get indexable part of a `Squeal.PostgreSQL.Expression.Type.tsquery`

94+queryTree :: null 'PGtsquery --> null 'PGtext

95+queryTree = unsafeFunction "query_tree"

96+

97+-- | normalize words and convert to `Squeal.PostgreSQL.Expression.Type.tsquery`

98+toTSquery :: null 'PGtext --> null 'PGtsquery

99+toTSquery = unsafeFunction "to_tsquery"

100+

101+-- | reduce document text to `Squeal.PostgreSQL.Expression.Type.tsvector`

102+toTSvector

103+ :: ty `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

104+ => null ty --> null 'PGtsvector

105+toTSvector = unsafeFunction "to_tsvector"

106+

107+-- | assign weight to each element of `Squeal.PostgreSQL.Expression.Type.tsvector`

108+setWeight :: '[null 'PGtsvector, null ('PGchar 1)] ---> null 'PGtsvector

109+setWeight = unsafeFunctionN "set_weight"

110+

111+-- | remove positions and weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

112+strip :: null 'PGtsvector --> null 'PGtsvector

113+strip = unsafeFunction "strip"

114+

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

126+jsonToTSvector = unsafeFunctionN "json_to_tsvector"

127+

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

139+jsonbToTSvector = unsafeFunctionN "jsonb_to_tsvector"

140+

141+-- | remove given lexeme from `Squeal.PostgreSQL.Expression.Type.tsvector`

142+tsDelete ::

143+ '[null 'PGtsvector, null ('PGvararray ('NotNull 'PGtext))]

144+ ---> null 'PGtsvector

145+tsDelete = unsafeFunctionN "ts_delete"

146+

147+-- | select only elements with given weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

148+tsFilter ::

149+ '[null 'PGtsvector, null ('PGvararray ('NotNull ('PGchar 1)))]

150+ ---> null 'PGtsvector

151+tsFilter = unsafeFunctionN "ts_filter"

152+

153+-- | display a `Squeal.PostgreSQL.Expression.Type.tsquery` match

154+tsHeadline

155+ :: document `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

156+ => '[null document, null 'PGtsquery] ---> null 'PGtext

157+tsHeadline = unsafeFunctionN "ts_headline"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Time.hsnew file+192

@@ -0,0 +1,192 @@

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

8+Date/Time functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , DeriveGeneric

14+ , FunctionalDependencies

15+ , LambdaCase

16+ , MultiParamTypeClasses

17+ , OverloadedStrings

18+ , PolyKinds

19+ , RankNTypes

20+ , TypeOperators

21+#-}

22+

23+module Squeal.PostgreSQL.Expression.Time

24+ ( TimeOp (..)

25+ , currentDate

26+ , currentTime

27+ , currentTimestamp

28+ , localTime

29+ , localTimestamp

30+ , now

31+ , makeDate

32+ , makeTime

33+ , makeTimestamp

34+ , makeTimestamptz

35+ , interval_

36+ , TimeUnit (..)

37+ ) where

38+

39+import Data.String

40+

41+import qualified GHC.Generics as GHC

42+import qualified Generics.SOP as SOP

43+

44+import Squeal.PostgreSQL.Expression

45+import Squeal.PostgreSQL.Render

46+import Squeal.PostgreSQL.Schema

47+

48+-- $setup

49+-- >>> import Squeal.PostgreSQL

50+

51+-- | >>> printSQL currentDate

52+-- CURRENT_DATE

53+currentDate :: Expr (null 'PGdate)

54+currentDate = UnsafeExpression "CURRENT_DATE"

55+

56+-- | >>> printSQL currentTime

57+-- CURRENT_TIME

58+currentTime :: Expr (null 'PGtimetz)

59+currentTime = UnsafeExpression "CURRENT_TIME"

60+

61+-- | >>> printSQL currentTimestamp

62+-- CURRENT_TIMESTAMP

63+currentTimestamp :: Expr (null 'PGtimestamptz)

64+currentTimestamp = UnsafeExpression "CURRENT_TIMESTAMP"

65+

66+-- | >>> printSQL localTime

67+-- LOCALTIME

68+localTime :: Expr (null 'PGtime)

69+localTime = UnsafeExpression "LOCALTIME"

70+

71+-- | >>> printSQL localTimestamp

72+-- LOCALTIMESTAMP

73+localTimestamp :: Expr (null 'PGtimestamp)

74+localTimestamp = UnsafeExpression "LOCALTIMESTAMP"

75+

76+-- | Current date and time (equivalent to `currentTimestamp`)

77+--

78+-- >>> printSQL now

79+-- now()

80+now :: Expr (null 'PGtimestamptz)

81+now = UnsafeExpression "now()"

82+

83+{-|

84+Create date from year, month and day fields

85+

86+>>> printSQL (makeDate (1984 :* 7 *: 3))

87+make_date(1984, 7, 3)

88+-}

89+makeDate :: '[ null 'PGint4, null 'PGint4, null 'PGint4 ] ---> null 'PGdate

90+makeDate = unsafeFunctionN "make_date"

91+

92+{-|

93+Create time from hour, minute and seconds fields

94+

95+>>> printSQL (makeTime (8 :* 15 *: 23.5))

96+make_time(8, 15, 23.5)

97+-}

98+makeTime :: '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtime

99+makeTime = unsafeFunctionN "make_time"

100+

101+{-|

102+Create timestamp from year, month, day, hour, minute and seconds fields

103+

104+>>> printSQL (makeTimestamp (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

105+make_timestamp(2013, 7, 15, 8, 15, 23.5)

106+-}

107+makeTimestamp ::

108+ '[ null 'PGint4, null 'PGint4, null 'PGint4

109+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamp

110+makeTimestamp = unsafeFunctionN "make_timestamp"

111+

112+{-|

113+Create timestamp with time zone from

114+year, month, day, hour, minute and seconds fields;

115+the current time zone is used

116+

117+>>> printSQL (makeTimestamptz (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

118+make_timestamptz(2013, 7, 15, 8, 15, 23.5)

119+-}

120+makeTimestamptz ::

121+ '[ null 'PGint4, null 'PGint4, null 'PGint4

122+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamptz

123+makeTimestamptz = unsafeFunctionN "make_timestamptz"

124+

125+{-|

126+Affine space operations on time types.

127+-}

128+class TimeOp time diff | time -> diff where

129+ {-|

130+ >>> printSQL (makeDate (1984 :* 7 *: 3) !+ 365)

131+ (make_date(1984, 7, 3) + 365)

132+ -}

133+ (!+) :: Operator (null time) (null diff) (null time)

134+ (!+) = unsafeBinaryOp "+"

135+ {-|

136+ >>> printSQL (365 +! makeDate (1984 :* 7 *: 3))

137+ (365 + make_date(1984, 7, 3))

138+ -}

139+ (+!) :: Operator (null diff) (null time) (null time)

140+ (+!) = unsafeBinaryOp "+"

141+ {-|

142+ >>> printSQL (makeDate (1984 :* 7 *: 3) !- 365)

143+ (make_date(1984, 7, 3) - 365)

144+ -}

145+ (!-) :: Operator (null time) (null diff) (null time)

146+ (!-) = unsafeBinaryOp "-"

147+ {-|

148+ >>> printSQL (makeDate (1984 :* 7 *: 3) !-! currentDate)

149+ (make_date(1984, 7, 3) - CURRENT_DATE)

150+ -}

151+ (!-!) :: Operator (null time) (null time) (null diff)

152+ (!-!) = unsafeBinaryOp "-"

153+instance TimeOp 'PGtimestamp 'PGinterval

154+instance TimeOp 'PGtimestamptz 'PGinterval

155+instance TimeOp 'PGtime 'PGinterval

156+instance TimeOp 'PGtimetz 'PGinterval

157+instance TimeOp 'PGinterval 'PGinterval

158+instance TimeOp 'PGdate 'PGint4

159+infixl 6 !+

160+infixl 6 +!

161+infixl 6 !-

162+infixl 6 !-!

163+

164+-- | A `TimeUnit` to use in `interval_` construction.

165+data TimeUnit

166+ = Years | Months | Weeks | Days

167+ | Hours | Minutes | Seconds

168+ | Microseconds | Milliseconds

169+ | Decades | Centuries | Millennia

170+ deriving (Eq, Ord, Show, Read, Enum, GHC.Generic)

171+instance SOP.Generic TimeUnit

172+instance SOP.HasDatatypeInfo TimeUnit

173+instance RenderSQL TimeUnit where

174+ renderSQL = \case

175+ Years -> "years"

176+ Months -> "months"

177+ Weeks -> "weeks"

178+ Days -> "days"

179+ Hours -> "hours"

180+ Minutes -> "minutes"

181+ Seconds -> "seconds"

182+ Microseconds -> "microseconds"

183+ Milliseconds -> "milliseconds"

184+ Decades -> "decades"

185+ Centuries -> "centuries"

186+ Millennia -> "millennia"

187+

188+-- | >>> printSQL $ interval_ 7 Days

189+-- (INTERVAL '7.0 days')

190+interval_ :: Double -> TimeUnit -> Expr (null 'PGinterval)

191+interval_ num unit = UnsafeExpression . parenthesized $ "INTERVAL" <+>

192+ "'" <> fromString (show num) <+> renderSQL unit <> "'"

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

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.hsnew file+284

@@ -0,0 +1,284 @@

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

8+Window functions and definitions

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , DeriveGeneric

14+ , FlexibleContexts

15+ , FlexibleInstances

16+ , GADTs

17+ , GeneralizedNewtypeDeriving

18+ , LambdaCase

19+ , MultiParamTypeClasses

20+ , OverloadedStrings

21+ , RankNTypes

22+ , KindSignatures

23+#-}

24+

25+module Squeal.PostgreSQL.Expression.Window

26+ ( -- * functions

27+ partitionBy

28+ , rank

29+ , rowNumber

30+ , denseRank

31+ , percentRank

32+ , cumeDist

33+ , ntile

34+ , lag

35+ , lead

36+ , firstValue

37+ , lastValue

38+ , nthValue

39+ , unsafeWindowFunction1

40+ , unsafeWindowFunctionN

41+ -- * types

42+ , WindowFunction (..)

43+ , WindowDefinition (..)

44+ , WinFun0

45+ , WinFun1

46+ , WinFunN

47+ ) where

48+

49+import Control.DeepSeq

50+import Data.ByteString

51+

52+import qualified GHC.Generics as GHC

53+import qualified Generics.SOP as SOP

54+

55+import Squeal.PostgreSQL.Alias

56+import Squeal.PostgreSQL.Expression

57+import Squeal.PostgreSQL.Expression.Aggregate

58+import Squeal.PostgreSQL.Expression.Sort

59+import Squeal.PostgreSQL.List

60+import Squeal.PostgreSQL.Render

61+import Squeal.PostgreSQL.Schema

62+

63+instance Aggregate

64+ (Expression outer commons grp schemas params from)

65+ (NP (Expression outer commons grp schemas params from))

66+ (WindowFunction outer commons grp schemas params from) where

67+ countStar = UnsafeWindowFunction "count(*)"

68+ count = unsafeWindowFunction1 "count"

69+ sum_ = unsafeWindowFunction1 "sum"

70+ arrayAgg = unsafeWindowFunction1 "array_agg"

71+ jsonAgg = unsafeWindowFunction1 "json_agg"

72+ jsonbAgg = unsafeWindowFunction1 "jsonb_agg"

73+ bitAnd = unsafeWindowFunction1 "bit_and"

74+ bitOr = unsafeWindowFunction1 "bit_or"

75+ boolAnd = unsafeWindowFunction1 "bool_and"

76+ boolOr = unsafeWindowFunction1 "bool_or"

77+ every = unsafeWindowFunction1 "every"

78+ max_ = unsafeWindowFunction1 "max"

79+ min_ = unsafeWindowFunction1 "min"

80+ avg = unsafeWindowFunction1 "avg"

81+ corr = unsafeWindowFunctionN "corr"

82+ covarPop = unsafeWindowFunctionN "covar_pop"

83+ covarSamp = unsafeWindowFunctionN "covar_samp"

84+ regrAvgX = unsafeWindowFunctionN "regr_avgx"

85+ regrAvgY = unsafeWindowFunctionN "regr_avgy"

86+ regrCount = unsafeWindowFunctionN "regr_count"

87+ regrIntercept = unsafeWindowFunctionN "regr_intercept"

88+ regrR2 = unsafeWindowFunctionN "regr_r2"

89+ regrSlope = unsafeWindowFunctionN "regr_slope"

90+ regrSxx = unsafeWindowFunctionN "regr_sxx"

91+ regrSxy = unsafeWindowFunctionN "regr_sxy"

92+ regrSyy = unsafeWindowFunctionN "regr_syy"

93+ stddev = unsafeWindowFunction1 "stddev"

94+ stddevPop = unsafeWindowFunction1 "stddev_pop"

95+ stddevSamp = unsafeWindowFunction1 "stddev_samp"

96+ variance = unsafeWindowFunction1 "variance"

97+ varPop = unsafeWindowFunction1 "var_pop"

98+ varSamp = unsafeWindowFunction1 "var_samp"

99+

100+-- | A `WindowDefinition` is a set of table rows that are somehow related

101+-- to the current row

102+data WindowDefinition outer commons grp schemas params from where

103+ WindowDefinition

104+ :: SOP.SListI bys

105+ => NP (Expression outer commons grp schemas params from) bys

106+ -- ^ `partitionBy` clause

107+ -> [SortExpression outer commons grp schemas params from]

108+ -- ^ `Squeal.PostgreSQL.Expression.Sort.orderBy` clause

109+ -> WindowDefinition outer commons grp schemas params from

110+

111+instance OrderBy WindowDefinition where

112+ orderBy sortsR (WindowDefinition parts sortsL)

113+ = WindowDefinition parts (sortsL ++ sortsR)

114+

115+instance RenderSQL (WindowDefinition outer commons schemas from grp params) where

116+ renderSQL (WindowDefinition part ord) =

117+ renderPartitionByClause part <> renderOrderByClause ord

118+ where

119+ renderPartitionByClause = \case

120+ Nil -> ""

121+ parts -> "PARTITION" <+> "BY" <+> renderCommaSeparated renderExpression parts

122+ renderOrderByClause = \case

123+ [] -> ""

124+ srts -> " ORDER" <+> "BY"

125+ <+> commaSeparated (renderSQL <$> srts)

126+

127+{- |

128+The `partitionBy` clause within `Squeal.PostgreSQL.Query.Over` divides the rows into groups,

129+or partitions, that share the same values of the `partitionBy` `Expression`(s).

130+For each row, the window function is computed across the rows that fall into

131+the same partition as the current row.

132+-}

133+partitionBy

134+ :: SOP.SListI bys

135+ => NP (Expression outer commons grp schemas params from) bys -- ^ partitions

136+ -> WindowDefinition outer commons grp schemas params from

137+partitionBy bys = WindowDefinition bys []

138+

139+{- |

140+A window function performs a calculation across a set of table rows

141+that are somehow related to the current row. This is comparable to the type

142+of calculation that can be done with an aggregate function.

143+However, window functions do not cause rows to become grouped into a single

144+output row like non-window aggregate calls would.

145+Instead, the rows retain their separate identities.

146+Behind the scenes, the window function is able to access more than

147+just the current row of the query result.

148+-}

149+newtype WindowFunction

150+ (outer :: FromType)

151+ (commons :: FromType)

152+ (grp :: Grouping)

153+ (schemas :: SchemasType)

154+ (params :: [NullityType])

155+ (from :: FromType)

156+ (ty :: NullityType)

157+ = UnsafeWindowFunction { renderWindowFunction :: ByteString }

158+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

159+

160+instance RenderSQL (WindowFunction outer commons grp schemas params from ty) where

161+ renderSQL = renderWindowFunction

162+

163+{- |

164+A @RankNType@ for window functions with no arguments.

165+-}

166+type WinFun0 x

167+ = forall outer commons grp schemas params from

168+ . WindowFunction outer commons grp schemas params from x

169+ -- ^ cannot reference aliases

170+

171+{- |

172+A @RankNType@ for window functions with 1 argument.

173+-}

174+type WinFun1 x y

175+ = forall outer commons grp schemas params from

176+ . Expression outer commons grp schemas params from x

177+ -- ^ input

178+ -> WindowFunction outer commons grp schemas params from y

179+ -- ^ output

180+

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+-}

185+type WinFunN xs y

186+ = forall outer commons grp schemas params from

187+ . NP (Expression outer commons grp schemas params from) xs

188+ -- ^ inputs

189+ -> WindowFunction outer commons grp schemas params from y

190+ -- ^ output

191+

192+-- | escape hatch for defining window functions

193+unsafeWindowFunction1 :: ByteString -> WinFun1 x y

194+unsafeWindowFunction1 fun x

195+ = UnsafeWindowFunction $ fun <> parenthesized (renderSQL x)

196+

197+-- | escape hatch for defining multi-argument window functions

198+unsafeWindowFunctionN :: SOP.SListI xs => ByteString -> WinFunN xs y

199+unsafeWindowFunctionN fun xs = UnsafeWindowFunction $ fun <>

200+ parenthesized (renderCommaSeparated renderSQL xs)

201+

202+{- | rank of the current row with gaps; same as `rowNumber` of its first peer

203+

204+>>> printSQL rank

205+rank()

206+-}

207+rank :: WinFun0 ('NotNull 'PGint8)

208+rank = UnsafeWindowFunction "rank()"

209+

210+{- | number of the current row within its partition, counting from 1

211+

212+>>> printSQL rowNumber

213+row_number()

214+-}

215+rowNumber :: WinFun0 ('NotNull 'PGint8)

216+rowNumber = UnsafeWindowFunction "row_number()"

217+

218+{- | rank of the current row without gaps; this function counts peer groups

219+

220+>>> printSQL denseRank

221+dense_rank()

222+-}

223+denseRank :: WinFun0 ('NotNull 'PGint8)

224+denseRank = UnsafeWindowFunction "dense_rank()"

225+

226+{- | relative rank of the current row: (rank - 1) / (total partition rows - 1)

227+

228+>>> printSQL percentRank

229+percent_rank()

230+-}

231+percentRank :: WinFun0 ('NotNull 'PGfloat8)

232+percentRank = UnsafeWindowFunction "percent_rank()"

233+

234+{- | cumulative distribution: (number of partition rows

235+preceding or peer with current row) / total partition rows

236+

237+>>> printSQL cumeDist

238+cume_dist()

239+-}

240+cumeDist :: WinFun0 ('NotNull 'PGfloat8)

241+cumeDist = UnsafeWindowFunction "cume_dist()"

242+

243+{- | integer ranging from 1 to the argument value,

244+dividing the partition as equally as possible

245+

246+>>> printSQL $ ntile 5

247+ntile(5)

248+-}

249+ntile :: WinFun1 ('NotNull 'PGint4) ('NotNull 'PGint4)

250+ntile = unsafeWindowFunction1 "ntile"

251+

252+{- | returns value evaluated at the row that is offset rows before the current

253+row within the partition; if there is no such row, instead return default

254+(which must be of the same type as value). Both offset and default are

255+evaluated with respect to the current row.

256+-}

257+lag :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

258+lag = unsafeWindowFunctionN "lag"

259+

260+{- | returns value evaluated at the row that is offset rows after the current

261+row within the partition; if there is no such row, instead return default

262+(which must be of the same type as value). Both offset and default are

263+evaluated with respect to the current row.

264+-}

265+lead :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

266+lead = unsafeWindowFunctionN "lead"

267+

268+{- | returns value evaluated at the row that is the

269+first row of the window frame

270+-}

271+firstValue :: WinFun1 ty ty

272+firstValue = unsafeWindowFunction1 "first_value"

273+

274+{- | returns value evaluated at the row that is the

275+last row of the window frame

276+-}

277+lastValue :: WinFun1 ty ty

278+lastValue = unsafeWindowFunction1 "last_value"

279+

280+{- | returns value evaluated at the row that is the nth

281+row of the window frame (counting from 1); null if no such row

282+-}

283+nthValue :: WinFunN '[null ty, 'NotNull 'PGint4] ('Null ty)

284+nthValue = unsafeWindowFunctionN "nth_value"

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

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+

1{-# LANGUAGE

13{-# LANGUAGE

2 DataKinds

14 DataKinds

3 , FlexibleContexts

15 , FlexibleContexts

@@ -19,39 +31,31 @@ module Squeal.PostgreSQL.List

19 ( SOP.NP (..)

31 ( SOP.NP (..)

20 , (*:)

32 , (*:)

21 , Join

33 , Join

22− , (+++)

23 , disjoin

34 , disjoin

24− , AlignedList (..)

35+ , Additional (..)

25− , single

36+ , Path (..)

26− , extractList

37+ , CFunctor (..)

27− , alignedMap

38+ , CFoldable (..)

39+ , CFree (..)

28 , Elem

40 , Elem

29 , In

41 , In

30 , Length

42 , Length

31 ) where

43 ) where

33−import Control.Category

45+import Control.Category.Free

46+import Data.Function ((&))

34import Data.Kind

47import Data.Kind

35import Data.Type.Bool

48import Data.Type.Bool

36import GHC.TypeLits

49import GHC.TypeLits

38import Generics.SOP as SOP

51import Generics.SOP as SOP

40−import Squeal.PostgreSQL.Render

41−

42-- | `Join` is simply promoted `++` and is used in @JOIN@s in

53-- | `Join` is simply promoted `++` and is used in @JOIN@s in

43-- `Squeal.PostgreSQL.Query.FromClause`s.

54-- `Squeal.PostgreSQL.Query.FromClause`s.

44type family Join xs ys where

55type family Join xs ys where

45 Join '[] ys = ys

56 Join '[] ys = ys

46 Join (x ': xs) ys = x ': Join xs ys

57 Join (x ': xs) ys = x ': Join xs ys

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−

55-- | `disjoin` is a utility function for splitting an `NP` list into pieces.

59-- | `disjoin` is a utility function for splitting an `NP` list into pieces.

56disjoin

60disjoin

57 :: forall xs ys expr. SListI xs

61 :: forall xs ys expr. SListI xs

@@ -62,39 +66,15 @@ disjoin = case sList @xs of

62 SCons -> \(x :* xsys) ->

66 SCons -> \(x :* xsys) ->

63 case disjoin xsys of (xs,ys) -> (x :* xs, ys)

67 case disjoin xsys of (xs,ys) -> (x :* xs, ys)

65−-- | An `AlignedList` is a type-aligned list or free category.

69+-- | The `Additional` class is for appending

66−data AlignedList p x0 x1 where

70+-- type-level list parameterized constructors such as `NP`,

67− Done :: AlignedList p x x

71+-- `Squeal.PostgreSQL.Query.Selection`, and `Squeal.PostgreSQL.Query.FromClause`.

68− (:>>) :: p x0 x1 -> AlignedList p x1 x2 -> AlignedList p x0 x2

72+class Additional expr where

69−infixr 7 :>>

73+ also :: expr ys -> expr xs -> expr (Join xs ys)

70−instance Category (AlignedList p) where

74+instance Additional (NP expr) where

71− id = Done

75+ also ys = \case

72− (.) list = \case

76+ Nil -> ys

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

77+ x :* xs -> x :* (xs & also ys)

94−

95−-- | A `single` step.

96−single :: p x0 x1 -> AlignedList p x0 x1

97−single step = step :>> Done

99-- | A useful operator for ending an `NP` list of length at least 2 without `Nil`.

79-- | A useful operator for ending an `NP` list of length at least 2 without `Nil`.

100(*:) :: f x -> f y -> NP f '[x,y]

80(*:) :: f x -> f y -> NP f '[x,y]

@@ -104,13 +84,18 @@ infixl 9 *:

104-- | @Elem@ is a promoted `Data.List.elem`.

84-- | @Elem@ is a promoted `Data.List.elem`.

105type family Elem x xs where

85type family Elem x xs where

106 Elem x '[] = 'False

86 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

108 Elem x (_ ': xs) = Elem x xs

93 Elem x (_ ': xs) = Elem x xs

109

110-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.

95-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.

111type family In x xs :: Constraint where

96type family In x xs :: Constraint where

112 In x xs = If (Elem x xs) (() :: Constraint)

97 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))

114

115{- | Calculate the `Length` of a type level list

100{- | Calculate the `Length` of a type level list

116

101

@@ -119,5 +104,9 @@ Length '[Char,String,Bool,Double] :: Nat

119= 4

104= 4

120-}

105-}

121type family Length (xs :: [k]) :: Nat where

106type family Length (xs :: [k]) :: Nat where

107+ Length (_ ': _ ': _ ': _ ': _ : xs) = 5 + Length xs

108+ Length (_ ': _ ': _ ': _ : xs) = 4 + Length xs

109+ Length (_ ': _ ': _ : xs) = 3 + Length xs

110+ Length (_ ': _ : xs) = 2 + Length xs

122− Length (x : xs) = 1 + Length xs

111+ Length (_ : xs) = 1 + Length xs

123 Length '[] = 0

112 Length '[] = 0

squeal-postgresql/src/Squeal/PostgreSQL/Manipulation.hs+159−168

@@ -18,6 +18,7 @@ Squeal data manipulation language.

18 , MultiParamTypeClasses

19 , OverloadedStrings

20 , PatternSynonyms

21+ , QuantifiedConstraints

21 , RankNTypes

22 , RankNTypes

22 , ScopedTypeVariables

23 , ScopedTypeVariables

23 , TypeApplications

24 , TypeApplications

@@ -29,19 +30,9 @@ Squeal data manipulation language.

30module Squeal.PostgreSQL.Manipulation

31module Squeal.PostgreSQL.Manipulation

31 ( -- * Manipulation

32 ( -- * Manipulation

33+ Manipulation_

32− Manipulation (..)

34+ , Manipulation (..)

33− , Manipulation_

34 , queryStatement

35 , queryStatement

35− , QueryClause (..)

36− , pattern Values_

37− , DefaultAliasable (..)

38− , ColumnExpression (..)

39− , ReturningClause (..)

40− , pattern Returning_

41− , ConflictClause (..)

42− , ConflictTarget (..)

43− , ConflictAction (..)

44− , UsingClause (..)

45 -- * Insert

36 -- * Insert

46 , insertInto

37 , insertInto

47 , insertInto_

38 , insertInto_

@@ -51,39 +42,95 @@ module Squeal.PostgreSQL.Manipulation

51 -- * Delete

42 -- * Delete

52 , deleteFrom

43 , deleteFrom

53 , deleteFrom_

44 , 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 (..)

55 ) where

57import Control.DeepSeq

58import Data.ByteString hiding (foldr)

59import Data.Kind (Type)

60−import GHC.TypeLits (KnownSymbol)

62import qualified Generics.SOP as SOP

61import qualified Generics.SOP as SOP

63import qualified GHC.Generics as GHC

62import qualified GHC.Generics as GHC

65import Squeal.PostgreSQL.Alias

64import Squeal.PostgreSQL.Alias

66import Squeal.PostgreSQL.Expression

65import Squeal.PostgreSQL.Expression

66+import Squeal.PostgreSQL.Expression.Logic

67import Squeal.PostgreSQL.List

68import Squeal.PostgreSQL.PG

69import Squeal.PostgreSQL.Render

70import Squeal.PostgreSQL.Query

71import Squeal.PostgreSQL.Schema

73+-- $setup

74+-- >>> import Squeal.PostgreSQL

75+-- >>> import Data.Int

76+-- >>> import Data.Time

77+

73{- |

78{- |

74A `Manipulation` is a statement which may modify data in the database,

79A `Manipulation` is a statement which may modify data in the database,

75but does not alter its schemas. Examples are inserts, updates and deletes.

80but does not alter its schemas. Examples are inserts, updates and deletes.

76A `Query` is also considered a `Manipulation` even though it does not modify data.

81A `Query` is also considered a `Manipulation` even though it does not modify data.

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+

78simple insert:

125simple insert:

126

80>>> type Columns = '["col1" ::: 'NoDef :=> 'Null 'PGint4, "col2" ::: 'Def :=> 'NotNull 'PGint4]

127>>> type Columns = '["col1" ::: 'NoDef :=> 'Null 'PGint4, "col2" ::: 'Def :=> 'NotNull 'PGint4]

81>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

128>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

82>>> :{

129>>> :{

83let

130let

84− manipulation :: Manipulation '[] (Public Schema) '[] '[]

131+ manipulation :: Manipulation_ (Public Schema) () ()

85 manipulation =

132 manipulation =

86− insertInto_ #tab (Values_ (2 `as` #col1 :* defaultAs #col2))

133+ insertInto_ #tab (Values_ (Set 2 `as` #col1 :* Default `as` #col2))

87in printSQL manipulation

134in printSQL manipulation

88:}

135:}

89INSERT INTO "tab" ("col1", "col2") VALUES (2, DEFAULT)

136INSERT INTO "tab" ("col1", "col2") VALUES (2, DEFAULT)

@@ -94,9 +141,9 @@ parameterized insert:

94>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

141>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

95>>> :{

142>>> :{

96let

143let

97− manipulation :: Manipulation '[] (Public Schema) '[ 'NotNull 'PGint4, 'NotNull 'PGint4 ] '[]

144+ manipulation :: Manipulation_ (Public Schema) (Int32, Int32) ()

98 manipulation =

145 manipulation =

99− 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))

100in printSQL manipulation

147in printSQL manipulation

101:}

148:}

102INSERT INTO "tab" ("col1", "col2") VALUES (($1 :: int4), ($2 :: int4))

149INSERT INTO "tab" ("col1", "col2") VALUES (($1 :: int4), ($2 :: int4))

@@ -105,9 +152,9 @@ returning insert:

105

152

106>>> :{

153>>> :{

107let

154let

108− manipulation :: Manipulation '[] (Public Schema) '[] '["fromOnly" ::: 'NotNull 'PGint4]

155+ manipulation :: Manipulation_ (Public Schema) () (Only Int32)

109 manipulation =

156 manipulation =

110− insertInto #tab (Values_ (2 `as` #col1 :* 3 `as` #col2))

157+ insertInto #tab (Values_ (Set 2 `as` #col1 :* Set 3 `as` #col2))

111 OnConflictDoRaise (Returning (#col1 `as` #fromOnly))

158 OnConflictDoRaise (Returning (#col1 `as` #fromOnly))

112in printSQL manipulation

159in printSQL manipulation

113:}

160:}

@@ -120,12 +167,12 @@ upsert:

120>>> type CustomersSchema = '["customers" ::: 'Table (CustomersConstraints :=> CustomersColumns)]

167>>> type CustomersSchema = '["customers" ::: 'Table (CustomersConstraints :=> CustomersColumns)]

121>>> :{

168>>> :{

122let

169let

123− manipulation :: Manipulation '[] (Public CustomersSchema) '[] '[]

170+ manipulation :: Manipulation_ (Public CustomersSchema) () ()

124 manipulation =

171 manipulation =

125 insertInto #customers

172 insertInto #customers

126− (Values_ ("John Smith" `as` #name :* "john@smith.com" `as` #email))

173+ (Values_ (Set "John Smith" `as` #name :* Set "john@smith.com" `as` #email))

127 (OnConflict (OnConstraint #uq)

174 (OnConflict (OnConstraint #uq)

128− (DoUpdate (((#excluded ! #email) <> "; " <> (#customers ! #email)) `as` #email) []))

175+ (DoUpdate (Set (#excluded ! #email <> "; " <> #customers ! #email) `as` #email) []))

129 (Returning_ Nil)

176 (Returning_ Nil)

130in printSQL manipulation

177in printSQL manipulation

131:}

178:}

@@ -135,7 +182,7 @@ query insert:

135

182

136>>> :{

183>>> :{

137let

184let

138− manipulation :: Manipulation '[] (Public Schema) '[] '[]

185+ manipulation :: Manipulation_ (Public Schema) () ()

139 manipulation = insertInto_ #tab (Subquery (select Star (from (table #tab))))

186 manipulation = insertInto_ #tab (Subquery (select Star (from (table #tab))))

140in printSQL manipulation

187in printSQL manipulation

141:}

188:}

@@ -145,8 +192,8 @@ update:

145

192

146>>> :{

193>>> :{

147let

194let

148− manipulation :: Manipulation '[] (Public Schema) '[] '[]

195+ manipulation :: Manipulation_ (Public Schema) () ()

149− manipulation = update_ #tab (2 `as` #col1) (#col1 ./= #col2)

196+ manipulation = update_ #tab (Set 2 `as` #col1) (#col1 ./= #col2)

150in printSQL manipulation

197in printSQL manipulation

151:}

198:}

152UPDATE "tab" SET "col1" = 2 WHERE ("col1" <> "col2")

199UPDATE "tab" SET "col1" = 2 WHERE ("col1" <> "col2")

@@ -155,9 +202,7 @@ delete:

155

202

156>>> :{

203>>> :{

157let

204let

158− manipulation :: Manipulation '[] (Public Schema) '[]

205+ manipulation :: Manipulation_ (Public Schema) () (Row Int32 Int32)

159− '[ "col1" ::: 'NotNull 'PGint4

160− , "col2" ::: 'NotNull 'PGint4 ]

161 manipulation = deleteFrom #tab NoUsing (#col1 .== #col2) (Returning Star)

206 manipulation = deleteFrom #tab NoUsing (#col1 .== #col2) (Returning Star)

162in printSQL manipulation

207in printSQL manipulation

163:}

208:}

@@ -168,13 +213,13 @@ delete and using clause:

168>>> :{

213>>> :{

169type Schema3 =

214type Schema3 =

170 '[ "tab" ::: 'Table ('[] :=> Columns)

215 '[ "tab" ::: 'Table ('[] :=> Columns)

171− , "other_tab" ::: 'Table ('[] :=> Columns)

216+ , "other_tab" ::: 'Table ('[] :=> Columns)

172− , "third_tab" ::: 'Table ('[] :=> Columns) ]

217+ , "third_tab" ::: 'Table ('[] :=> Columns) ]

173:}

218:}

174

219

175>>> :{

220>>> :{

176let

221let

177− manipulation :: Manipulation '[] (Public Schema3) '[] '[]

222+ manipulation :: Manipulation_ (Public Schema3) () ()

178 manipulation =

223 manipulation =

179 deleteFrom #tab (Using (table #other_tab & also (table #third_tab)))

224 deleteFrom #tab (Using (table #other_tab & also (table #third_tab)))

180 ( (#tab ! #col2 .== #other_tab ! #col2)

225 ( (#tab ! #col2 .== #other_tab ! #col2)

@@ -190,7 +235,7 @@ with manipulation:

190>>> type ProductsSchema = '["products" ::: 'Table ('[] :=> ProductsColumns), "products_deleted" ::: 'Table ('[] :=> ProductsColumns)]

235>>> type ProductsSchema = '["products" ::: 'Table ('[] :=> ProductsColumns), "products_deleted" ::: 'Table ('[] :=> ProductsColumns)]

191>>> :{

236>>> :{

192let

237let

193− manipulation :: Manipulation '[] (Public ProductsSchema) '[ 'NotNull 'PGdate] '[]

238+ manipulation :: Manipulation_ (Public ProductsSchema) (Only Day) ()

194 manipulation = with

239 manipulation = with

195 (deleteFrom #products NoUsing (#date .< param @1) (Returning Star) `as` #del)

240 (deleteFrom #products NoUsing (#date .< param @1) (Returning Star) `as` #del)

196 (insertInto_ #products_deleted (Subquery (select Star (from (common #del)))))

241 (insertInto_ #products_deleted (Subquery (select Star (from (common #del)))))

@@ -198,26 +243,13 @@ in printSQL manipulation

198:}

243:}

199WITH "del" AS (DELETE FROM "products" WHERE ("date" < ($1 :: date)) RETURNING *) INSERT INTO "products_deleted" SELECT * FROM "del" AS "del"

244WITH "del" AS (DELETE FROM "products" WHERE ("date" < ($1 :: date)) RETURNING *) INSERT INTO "products_deleted" SELECT * FROM "del" AS "del"

200-}

245-}

201−newtype Manipulation

202− (commons :: FromType)

203− (schemas :: SchemasType)

204− (params :: [NullityType])

205− (columns :: RowType)

206− = UnsafeManipulation { renderManipulation :: ByteString }

207− deriving (GHC.Generic,Show,Eq,Ord,NFData)

208−instance RenderSQL (Manipulation commons schemas params columns) where

209− renderSQL = renderManipulation

210−instance With Manipulation where

211− with Done manip = manip

212− with ctes manip = UnsafeManipulation $

213− "WITH" <+> renderSQL ctes <+> renderSQL manip

214−

215type family Manipulation_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

246type family Manipulation_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

216 Manipulation_ schemas params row = Manipulation '[] schemas (TuplePG params) (RowPG row)

247 Manipulation_ schemas params row = Manipulation '[] schemas (TuplePG params) (RowPG row)

217

248

218-- | Convert a `Query` into a `Manipulation`.

249-- | Convert a `Query` into a `Manipulation`.

219queryStatement

250queryStatement

220 :: Query '[] commons schemas params columns

251 :: Query '[] commons schemas params columns

252+ -- ^ `Query` to embed as a `Manipulation`

221 -> Manipulation commons schemas params columns

253 -> Manipulation commons schemas params columns

222queryStatement q = UnsafeManipulation $ renderSQL q

254queryStatement q = UnsafeManipulation $ renderSQL q

223

255

@@ -240,9 +272,13 @@ insertInto

240 , SOP.SListI columns

272 , SOP.SListI columns

241 , SOP.SListI row1 )

273 , SOP.SListI row1 )

242 => QualifiedAlias sch tab

274 => QualifiedAlias sch tab

275+ -- ^ table

243 -> QueryClause commons schemas params columns

276 -> QueryClause commons schemas params columns

277+ -- ^ what to insert

244 -> ConflictClause tab commons schemas params table

278 -> ConflictClause tab commons schemas params table

279+ -- ^ what to do in case of conflict

245 -> ReturningClause commons schemas params '[tab ::: row0] row1

280 -> ReturningClause commons schemas params '[tab ::: row0] row1

281+ -- ^ what to return

246 -> Manipulation commons schemas params row1

282 -> Manipulation commons schemas params row1

247insertInto tab qry conflict ret = UnsafeManipulation $

283insertInto tab qry conflict ret = UnsafeManipulation $

248 "INSERT" <+> "INTO" <+> renderSQL tab

284 "INSERT" <+> "INTO" <+> renderSQL tab

@@ -250,6 +286,7 @@ insertInto tab qry conflict ret = UnsafeManipulation $

250 <> renderSQL conflict

286 <> renderSQL conflict

251 <> renderSQL ret

287 <> renderSQL ret

252

288

289+-- | Like `insertInto` but with `OnConflictDoRaise` and `no` `ReturningClause`.

253insertInto_

290insertInto_

254 :: ( Has sch schemas schema

291 :: ( Has sch schemas schema

255 , Has tab schema ('Table table)

292 , Has tab schema ('Table table)

@@ -257,25 +294,33 @@ insertInto_

257 , row ~ TableToRow table

294 , row ~ TableToRow table

258 , SOP.SListI columns )

295 , SOP.SListI columns )

259 => QualifiedAlias sch tab

296 => QualifiedAlias sch tab

297+ -- ^ table

260 -> QueryClause commons schemas params columns

298 -> QueryClause commons schemas params columns

299+ -- ^ what to insert

261 -> Manipulation commons schemas params '[]

300 -> Manipulation commons schemas params '[]

262insertInto_ tab qry =

301insertInto_ tab qry =

263 insertInto tab qry OnConflictDoRaise (Returning_ Nil)

302 insertInto tab qry OnConflictDoRaise (Returning_ Nil)

264

303

304+-- | A `QueryClause` describes what to `insertInto` a table.

265data QueryClause commons schemas params columns where

305data QueryClause commons schemas params columns where

266 Values

306 Values

267 :: SOP.SListI columns

307 :: SOP.SListI columns

268− => NP (ColumnExpression 'Ungrouped schemas params '[]) columns

308+ => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

309+ -- ^ row of values

269− -> [NP (ColumnExpression 'Ungrouped schemas params '[]) columns]

310+ -> [NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns]

311+ -- ^ additional rows of values

270 -> QueryClause commons schemas params columns

312 -> QueryClause commons schemas params columns

271 Select

313 Select

272 :: SOP.SListI columns

314 :: SOP.SListI columns

273− => NP (ColumnExpression grp schemas params from) columns

315+ => NP (Aliased (Optional (Expression '[] commons grp schemas params from))) columns

316+ -- ^ row of values

274 -> TableExpression '[] commons grp schemas params from

317 -> TableExpression '[] commons grp schemas params from

318+ -- ^ from a table expression

275 -> QueryClause commons schemas params columns

319 -> QueryClause commons schemas params columns

276 Subquery

320 Subquery

277 :: ColumnsToRow columns ~ row

321 :: ColumnsToRow columns ~ row

278 => Query '[] commons schemas params row

322 => Query '[] commons schemas params row

323+ -- ^ subquery to insert

279 -> QueryClause commons schemas params columns

324 -> QueryClause commons schemas params columns

280

325

281instance RenderSQL (QueryClause commons schemas params columns) where

326instance RenderSQL (QueryClause commons schemas params columns) where

@@ -294,109 +339,41 @@ instance RenderSQL (QueryClause commons schemas params columns) where

294 Subquery qry -> renderQuery qry

339 Subquery qry -> renderQuery qry

295 where

340 where

296 renderSQLPartMaybe, renderValuePartMaybe

341 renderSQLPartMaybe, renderValuePartMaybe

297− :: ColumnExpression grp schemas params from column -> Maybe ByteString

342+ :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

343+ -> Maybe ByteString

298 renderSQLPartMaybe = \case

344 renderSQLPartMaybe = \case

299− DefaultAs _ -> Nothing

345+ Default `As` _ -> Nothing

300− Specific (_ `As` name) -> Just $ renderSQL name

346+ Set _ `As` name -> Just $ renderSQL name

301 renderValuePartMaybe = \case

347 renderValuePartMaybe = \case

302− DefaultAs _ -> Nothing

348+ Default `As` _ -> Nothing

303− Specific (value `As` _) -> Just $ renderExpression value

349+ Set value `As` _ -> Just $ renderExpression value

304 renderSQLPart, renderValuePart

350 renderSQLPart, renderValuePart

305− :: ColumnExpression grp schemas params from column -> ByteString

351+ :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

306− renderSQLPart = \case

352+ -> ByteString

307− DefaultAs name -> renderSQL name

308− Specific (_ `As` name) -> renderSQL name

353+ renderSQLPart (_ `As` name) = renderSQL name

309− renderValuePart = \case

354+ renderValuePart (value `As` _) = renderSQL value

310− DefaultAs _ -> "DEFAULT"

311− Specific (value `As` _) -> renderExpression value

312

355

356+-- | `Values_` describes a single `NP` list of `Aliased` `Optional` `Expression`s

357+-- whose `ColumnsType` must match the tables'.

313pattern Values_

358pattern Values_

314 :: SOP.SListI columns

359 :: SOP.SListI columns

315− => NP (ColumnExpression 'Ungrouped schemas params '[]) columns

360+ => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

361+ -- ^ row of values

316 -> QueryClause commons schemas params columns

362 -> QueryClause commons schemas params columns

317pattern Values_ vals = Values vals []

363pattern Values_ vals = Values vals []

318

364

319−data ColumnExpression grp schemas params from column where

365+-- | `Optional` is either `Default` or a value, parameterized by an appropriate

320− DefaultAs

366+-- `ColumnConstraint`.

321− :: KnownSymbol col

367+data Optional expr ty where

322− => Alias col

368+ -- | Use the `Default` value for a column.

323− -> ColumnExpression grp schemas params from (col ::: 'Def :=> ty)

369+ Default :: Optional expr ('Def :=> ty)

324− Specific

370+ -- | `Set` a value for a column.

325− :: Aliased (Expression '[] '[] grp schemas params from) (col ::: ty)

371+ Set :: expr ty -> Optional expr (def :=> ty)

326− -> ColumnExpression grp schemas params from (col ::: defness :=> ty)

372+

327−

373+instance (forall x. RenderSQL (expr x)) => RenderSQL (Optional expr ty) where

328−instance (KnownSymbol col, column ~ (col ::: defness :=> ty))

329− => Aliasable col

330− (Expression '[] '[] grp schemas params from ty)

331− (ColumnExpression grp schemas params from column) where

332− expression `as` col = Specific (expression `As` col)

333−instance (KnownSymbol col, columns ~ '[col ::: defness :=> ty])

334− => Aliasable col

335− (Expression '[] '[] grp schemas params from ty)

336− (NP (ColumnExpression grp schemas params from) columns) where

337− expression `as` col = expression `as` col :* Nil

338−instance (KnownSymbol col, column ~ (col ::: 'Def :=> ty))

339− => DefaultAliasable col (ColumnExpression grp schemas params from column) where

340− defaultAs = DefaultAs

341−instance (KnownSymbol col, columns ~ '[col ::: 'Def :=> ty])

342− => DefaultAliasable col (NP (ColumnExpression grp schemas params from) columns) where

343− defaultAs col = defaultAs col :* Nil

344−

345−instance (HasUnique tab from row, Has col row ty, column ~ (col ::: defness :=> ty))

346− => IsLabel col (ColumnExpression 'Ungrouped schemas params from column) where

347− fromLabel = fromLabel @col `as` Alias

348−instance (HasUnique tab from row, Has col row ty, columns ~ '[col ::: defness :=> ty])

349− => IsLabel col

350− (NP (ColumnExpression 'Ungrouped schemas params from) columns) where

351− fromLabel = fromLabel @col `as` Alias

352−

353−instance (Has tab from row, Has col row ty, column ~ (col ::: defness :=> ty))

354− => IsQualified tab col (ColumnExpression 'Ungrouped schemas params from column) where

355− tab ! col = tab ! col `as` col

356−instance (Has tab from row, Has col row ty, columns ~ '[col ::: defness :=> ty])

357− => IsQualified tab col (NP (ColumnExpression 'Ungrouped schemas params from) columns) where

358− tab ! col = tab ! col `as` col

359−

360−instance

361− ( HasUnique tab from row

362− , Has col row ty

363− , GroupedBy tab col bys

364− , column ~ (col ::: defness :=> ty)

365− ) => IsLabel col

366− (ColumnExpression ('Grouped bys) schemas params from column) where

367− fromLabel = fromLabel @col `as` Alias

368−instance

369− ( HasUnique tab from row

370− , Has col row ty

371− , GroupedBy tab col bys

372− , columns ~ '[col ::: defness :=> ty]

373− ) => IsLabel col

374− (NP (ColumnExpression ('Grouped bys) schemas params from) columns) where

375− fromLabel = fromLabel @col `as` Alias

376−

377−instance

378− ( Has tab from row

379− , Has col row ty

380− , GroupedBy tab col bys

381− , column ~ (col ::: defness :=> ty)

382− ) => IsQualified tab col

383− (ColumnExpression ('Grouped bys) schemas params from column) where

384− tab ! col = tab ! col `as` col

385−instance

386− ( Has tab from row

387− , Has col row ty

388− , GroupedBy tab col bys

389− , columns ~ '[col ::: defness :=> ty]

390− ) => IsQualified tab col

391− (NP (ColumnExpression ('Grouped bys) schemas params from) columns) where

392− tab ! col = tab ! col :* Nil

393−

394−instance RenderSQL (ColumnExpression grp schemas params from column) where

395 renderSQL = \case

374 renderSQL = \case

396− DefaultAs col ->

397− renderSQL col <+> "=" <+> "DEFAULT"

375+ Default -> "DEFAULT"

398− Specific (expression `As` col) ->

376+ Set expr -> renderSQL expr

399− renderSQL col <+> "=" <+> renderSQL expression

400

377

401-- | A `ReturningClause` computes and return value(s) based

378-- | A `ReturningClause` computes and return value(s) based

402-- on each row actually inserted, updated or deleted. This is primarily

379-- on each row actually inserted, updated or deleted. This is primarily

@@ -406,7 +383,7 @@ instance RenderSQL (ColumnExpression grp schemas params from column) where

406-- deleted will be returned. For example, if a row was locked

383-- deleted will be returned. For example, if a row was locked

407-- but not updated because an `OnConflict` `DoUpdate` condition was not satisfied,

384-- but not updated because an `OnConflict` `DoUpdate` condition was not satisfied,

408-- the row will not be returned. `Returning` `Star` will return all columns

385-- the row will not be returned. `Returning` `Star` will return all columns

409−-- 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

410-- values are desired.

387-- values are desired.

411newtype ReturningClause commons schemas params from row =

388newtype ReturningClause commons schemas params from row =

412 Returning (Selection '[] commons 'Ungrouped schemas params from row)

389 Returning (Selection '[] commons 'Ungrouped schemas params from row)

@@ -416,9 +393,11 @@ instance RenderSQL (ReturningClause commons schemas params from row) where

416 Returning (List Nil) -> ""

393 Returning (List Nil) -> ""

417 Returning selection -> " RETURNING" <+> renderSQL selection

394 Returning selection -> " RETURNING" <+> renderSQL selection

418

395

396+-- | `Returning` a `List`

419pattern Returning_

397pattern Returning_

420 :: SOP.SListI row

398 :: SOP.SListI row

421 => NP (Aliased (Expression '[] commons 'Ungrouped schemas params from)) row

399 => NP (Aliased (Expression '[] commons 'Ungrouped schemas params from)) row

400+ -- ^ row of values

422 -> ReturningClause commons schemas params from row

401 -> ReturningClause commons schemas params from row

423pattern Returning_ list = Returning (List list)

402pattern Returning_ list = Returning (List list)

424

403

@@ -431,7 +410,9 @@ data ConflictClause tab commons schemas params table where

431 OnConflictDoRaise :: ConflictClause tab commons schemas params table

410 OnConflictDoRaise :: ConflictClause tab commons schemas params table

432 OnConflict

411 OnConflict

433 :: ConflictTarget constraints

412 :: ConflictTarget constraints

413+ -- ^ conflict target

434 -> ConflictAction tab commons schemas params columns

414 -> ConflictAction tab commons schemas params columns

415+ -- ^ conflict action

435 -> ConflictClause tab commons schemas params (constraints :=> columns)

416 -> ConflictClause tab commons schemas params (constraints :=> columns)

436

417

437-- | Render a `ConflictClause`.

418-- | Render a `ConflictClause`.

@@ -442,6 +423,17 @@ instance SOP.SListI (TableToColumns table)

442 OnConflict target action -> " ON CONFLICT"

423 OnConflict target action -> " ON CONFLICT"

443 <+> renderSQL target <+> renderSQL action

424 <+> renderSQL target <+> renderSQL action

444

425

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+-}

445data ConflictAction tab commons schemas params columns where

437data ConflictAction tab commons schemas params columns where

446 DoNothing :: ConflictAction tab commons schemas params columns

438 DoNothing :: ConflictAction tab commons schemas params columns

447 DoUpdate

439 DoUpdate

@@ -450,8 +442,9 @@ data ConflictAction tab commons schemas params columns where

450 , columns ~ (col0 ': cols)

442 , columns ~ (col0 ': cols)

451 , SOP.All (HasIn columns) subcolumns

443 , SOP.All (HasIn columns) subcolumns

452 , AllUnique subcolumns )

444 , AllUnique subcolumns )

453− => NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]) subcolumns

445+ => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]))) subcolumns

454 -> [Condition '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]]

446 -> [Condition '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]]

447+ -- ^ WHERE `Condition`s

455 -> ConflictAction tab commons schemas params columns

448 -> ConflictAction tab commons schemas params columns

456

449

457instance RenderSQL (ConflictAction tab commons schemas params columns) where

450instance RenderSQL (ConflictAction tab commons schemas params columns) where

@@ -459,11 +452,17 @@ instance RenderSQL (ConflictAction tab commons schemas params columns) where

459 DoNothing -> "DO NOTHING"

452 DoNothing -> "DO NOTHING"

460 DoUpdate updates whs'

453 DoUpdate updates whs'

461 -> "DO UPDATE SET"

454 -> "DO UPDATE SET"

462− <+> renderCommaSeparated renderSQL updates

455+ <+> renderCommaSeparated renderUpdate updates

463 <> case whs' of

456 <> case whs' of

464 [] -> ""

457 [] -> ""

465 wh:whs -> " WHERE" <+> renderSQL (foldr (.&&) wh whs)

458 wh:whs -> " WHERE" <+> renderSQL (foldr (.&&) wh whs)

466

459

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+

467-- | A `ConflictTarget` specifies the constraint violation that triggers a

466-- | A `ConflictTarget` specifies the constraint violation that triggers a

468-- `ConflictAction`.

467-- `ConflictAction`.

469data ConflictTarget constraints where

468data ConflictTarget constraints where

@@ -486,7 +485,6 @@ UPDATE statements

486update

485update

487 :: ( SOP.SListI columns

486 :: ( SOP.SListI columns

488 , SOP.SListI row1

487 , SOP.SListI row1

489− , db ~ (commons :=> schemas)

490 , Has sch schemas schema

488 , Has sch schemas schema

491 , Has tab schema ('Table table)

489 , Has tab schema ('Table table)

492 , row0 ~ TableToRow table

490 , row0 ~ TableToRow table

@@ -494,7 +492,7 @@ update

494 , SOP.All (HasIn columns) subcolumns

492 , SOP.All (HasIn columns) subcolumns

495 , AllUnique subcolumns )

493 , AllUnique subcolumns )

496 => QualifiedAlias sch tab -- ^ table to update

494 => QualifiedAlias sch tab -- ^ table to update

497− -> NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row0]) subcolumns

495+ -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row0]))) subcolumns

498 -- ^ modified values to replace old values

496 -- ^ modified values to replace old values

499 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row0]

497 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row0]

500 -- ^ condition under which to perform update on a row

498 -- ^ condition under which to perform update on a row

@@ -504,14 +502,13 @@ update tab columns wh returning = UnsafeManipulation $

504 "UPDATE"

502 "UPDATE"

505 <+> renderSQL tab

503 <+> renderSQL tab

506 <+> "SET"

504 <+> "SET"

507− <+> renderCommaSeparated renderSQL columns

505+ <+> renderCommaSeparated renderUpdate columns

508 <+> "WHERE" <+> renderSQL wh

506 <+> "WHERE" <+> renderSQL wh

509 <> renderSQL returning

507 <> renderSQL returning

510

508

511-- | Update a row returning `Nil`.

509-- | Update a row returning `Nil`.

512update_

510update_

513 :: ( SOP.SListI columns

511 :: ( SOP.SListI columns

514− , db ~ (commons :=> schemas)

515 , Has sch schemas schema

512 , Has sch schemas schema

516 , Has tab schema ('Table table)

513 , Has tab schema ('Table table)

517 , row ~ TableToRow table

514 , row ~ TableToRow table

@@ -519,7 +516,7 @@ update_

519 , SOP.All (HasIn columns) subcolumns

516 , SOP.All (HasIn columns) subcolumns

520 , AllUnique subcolumns )

517 , AllUnique subcolumns )

521 => QualifiedAlias sch tab -- ^ table to update

518 => QualifiedAlias sch tab -- ^ table to update

522− -> NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row]) subcolumns

519+ -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row]))) subcolumns

523 -- ^ modified values to replace old values

520 -- ^ modified values to replace old values

524 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]

521 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]

525 -- ^ condition under which to perform update on a row

522 -- ^ condition under which to perform update on a row

@@ -530,16 +527,25 @@ update_ tab columns wh = update tab columns wh (Returning_ Nil)

530DELETE statements

527DELETE statements

531-----------------------------------------}

528-----------------------------------------}

532

529

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.

533data UsingClause commons schemas params from where

539data UsingClause commons schemas params from where

534 NoUsing :: UsingClause commons schemas params '[]

540 NoUsing :: UsingClause commons schemas params '[]

535 Using

541 Using

536 :: FromClause '[] commons schemas params from

542 :: FromClause '[] commons schemas params from

543+ -- ^ what to use

537 -> UsingClause commons schemas params from

544 -> UsingClause commons schemas params from

538

545

539-- | Delete rows from a table.

546-- | Delete rows from a table.

540deleteFrom

547deleteFrom

541 :: ( SOP.SListI row1

548 :: ( SOP.SListI row1

542− , db ~ (commons :=> schemas)

543 , Has sch schemas schema

549 , Has sch schemas schema

544 , Has tab schema ('Table table)

550 , Has tab schema ('Table table)

545 , row0 ~ TableToRow table

551 , row0 ~ TableToRow table

@@ -561,8 +567,7 @@ deleteFrom tab using wh returning = UnsafeManipulation $

561

567

562-- | Delete rows returning `Nil`.

568-- | Delete rows returning `Nil`.

563deleteFrom_

569deleteFrom_

564− :: ( db ~ (commons :=> schemas)

565− , Has sch schemas schema

570+ :: ( Has sch schemas schema

566 , Has tab schema ('Table table)

571 , Has tab schema ('Table table)

567 , row ~ TableToRow table

572 , row ~ TableToRow table

568 , columns ~ TableToColumns table )

573 , columns ~ TableToColumns table )

@@ -571,17 +576,3 @@ deleteFrom_

571 -- ^ condition under which to delete a row

576 -- ^ condition under which to delete a row

572 -> Manipulation commons schemas params '[]

577 -> Manipulation commons schemas params '[]

573deleteFrom_ tab wh = deleteFrom tab NoUsing wh (Returning_ Nil)

578deleteFrom_ tab wh = deleteFrom tab NoUsing wh (Returning_ Nil)

574−

575−-- | This has the behaviour of a cartesian product, taking all

576−-- possible combinations between @left@ and @right@ - exactly like a

577−-- `crossJoin`. Used when no `crossJoin` syntax is required but simply

578−-- a comma separated list of tables. Typical case is the `UsingClause`

579−-- of a `deleteFrom` query.

580−also

581− :: FromClause outer commons schemas params right

582− -- ^ right

583− -> FromClause outer commons schemas params left

584− -- ^ left

585− -> FromClause outer commons schemas params (Join left right)

586−also right left = UnsafeFromClause $

587− renderSQL left <> "," <+> renderSQL right

squeal-postgresql/src/Squeal/PostgreSQL/Migration.hs+60−66

@@ -66,7 +66,7 @@ let

66 }

67:}

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`.

71>>> let migrations = makeUsers :>> makeEmails :>> Done

@@ -120,6 +120,7 @@ In addition to enabling `Migration`s using pure SQL `Definition`s for

120the `up` and `down` instructions, you can also perform impure `IO` actions

121by using a `Migration`s over the `Terminally` `PQ` `IO` category.

122-}

123+

123{-# LANGUAGE

124{-# LANGUAGE

124 DataKinds

125 DataKinds

125 , DeriveGeneric

126 , DeriveGeneric

@@ -155,9 +156,7 @@ import Data.Function ((&))

155import Data.List ((\\))

156import Data.List ((\\))

156import Data.Text (Text)

157import Data.Text (Text)

157import Data.Time (UTCTime)

158import Data.Time (UTCTime)

158−import Generics.SOP (K (..))

159import Prelude hiding ((.), id)

160−import Squeal.PostgreSQL

161import System.Environment

160import System.Environment

162import UnliftIO (MonadIO (..))

161import UnliftIO (MonadIO (..))

163

162

@@ -165,6 +164,22 @@ import qualified Data.Text.IO as Text (putStrLn)

165import qualified Generics.SOP as SOP

164import qualified Generics.SOP as SOP

166import qualified GHC.Generics as GHC

165import qualified GHC.Generics as GHC

167

166

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

182+

168-- | A `Migration` is a named "isomorphism" over a given category.

183-- | A `Migration` is a named "isomorphism" over a given category.

169-- It should contain an inverse pair of `up` and `down`

184-- It should contain an inverse pair of `up` and `down`

170-- instructions and a unique `name`.

185-- instructions and a unique `name`.

@@ -177,40 +192,40 @@ data Migration p schemas0 schemas1 = Migration

177

192

178{- |

193{- |

179A `Migratory` @p@ is a `Category` for which one can execute or rewind

194A `Migratory` @p@ is a `Category` for which one can execute or rewind

180−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

181SQL `Definition`s and the category of impure `Terminally` `PQ` `IO` actions.

196SQL `Definition`s and the category of impure `Terminally` `PQ` `IO` actions.

182-}

197-}

183class Category p => Migratory p where

198class Category p => Migratory p where

184

199

185 {- |

200 {- |

186− Run an `AlignedList` of `Migration`s.

201+ Run a `Path` of `Migration`s.

187 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

202 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

188− In a transaction for each each `Migration`, query to see if the `Migration` has been executed;

203+ In one transaction, for each each `Migration` query to see if the `Migration` has been executed;

189− if not, execute the `Migration` and insert a row in the `MigrationsTable`.

204+ if not, `up` the `Migration` and insert its `name` in the `MigrationsTable`.

190 -}

205 -}

191 migrateUp

206 migrateUp

192− :: AlignedList (Migration p) schemas0 schemas1

207+ :: Path (Migration p) schemas0 schemas1

193 -> PQ schemas0 schemas1 IO ()

208 -> PQ schemas0 schemas1 IO ()

194

209

195 {- |

210 {- |

196− Rewind an `AlignedList` of `Migration`s.

211+ Rewind a `Path` of `Migration`s.

197 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

212 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

198− In a transaction for each each `Migration`, query to see if the `Migration` has been executed;

213+ In one transaction, for each each `Migration` query to see if the `Migration` has been executed;

199− if so, rewind the `Migration` and delete its row in the `MigrationsTable`.

214+ if so, `down` the `Migration` and delete its `name` in the `MigrationsTable`.

200 -}

215 -}

201 migrateDown

216 migrateDown

202− :: AlignedList (Migration p) schemas0 schemas1

217+ :: Path (Migration p) schemas0 schemas1

203 -> PQ schemas1 schemas0 IO ()

218 -> PQ schemas1 schemas0 IO ()

204

219

205instance Migratory Definition where

220instance Migratory Definition where

206− migrateUp = migrateUp . alignedMap pureMigration

221+ migrateUp = migrateUp . cmap pureMigration

207− migrateDown = migrateDown . alignedMap pureMigration

222+ migrateDown = migrateDown . cmap pureMigration

208

223

209{- | `Terminally` turns an indexed monad transformer and the monad it transforms

224{- | `Terminally` turns an indexed monad transformer and the monad it transforms

210into a category by restricting the return type to @()@ and permuting the type variables.

225into a category by restricting the return type to @()@ and permuting the type variables.

211This is similar to how applying a monad to @()@ yields a monoid.

226This is similar to how applying a monad to @()@ yields a monoid.

212Since a `Terminally` action has a trivial return value, the only reason

227Since a `Terminally` action has a trivial return value, the only reason

213−to run one is for the side effects, in particular database effects.

228+to run one is for the side effects, in particular database and other IO effects.

214-}

229-}

215newtype Terminally trans monad x0 x1 = Terminally

230newtype Terminally trans monad x0 x1 = Terminally

216 { runTerminally :: trans x0 x1 monad () }

231 { runTerminally :: trans x0 x1 monad () }

@@ -236,8 +251,8 @@ terminally = Terminally . void

236-- | A `pureMigration` turns a `Migration` involving only pure SQL

251-- | A `pureMigration` turns a `Migration` involving only pure SQL

237-- `Definition`s into a `Migration` that may be combined with arbitrary `IO`.

252-- `Definition`s into a `Migration` that may be combined with arbitrary `IO`.

238pureMigration

253pureMigration

239− :: Migration Definition schema0 schema1

254+ :: Migration Definition schemas0 schemas1

240− -> Migration (Terminally PQ IO) schema0 schema1

255+ -> Migration (Terminally PQ IO) schemas0 schemas1

241pureMigration migration = Migration

256pureMigration migration = Migration

242 { name = name migration

257 { name = name migration

243 , up = terminally . define $ up migration

258 , up = terminally . define $ up migration

@@ -246,81 +261,64 @@ pureMigration migration = Migration

246

261

247instance Migratory (Terminally PQ IO) where

262instance Migratory (Terminally PQ IO) where

248

263

249− migrateUp migration = unsafePQ $

264+ migrateUp migration = unsafePQ . transactionally_ $ do

250 define createMigrations

265 define createMigrations

251− & pqBind okResult

252− & pqThen (transactionallySchema_ (upMigrations migration))

266+ upMigrations migration

253

267

254 where

268 where

255

269

256 upMigrations

270 upMigrations

257− :: AlignedList (Migration (Terminally PQ IO)) schemas0 schemas1

271+ :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

258 -> PQ MigrationsSchemas MigrationsSchemas IO ()

272 -> PQ MigrationsSchemas MigrationsSchemas IO ()

259 upMigrations = \case

273 upMigrations = \case

260 Done -> return ()

274 Done -> return ()

261− step :>> steps -> upMigration step & pqThen (upMigrations steps)

275+ step :>> steps -> upMigration step >> upMigrations steps

262

276

263 upMigration

277 upMigration

264 :: Migration (Terminally PQ IO) schemas0 schemas1

278 :: Migration (Terminally PQ IO) schemas0 schemas1

265 -> PQ MigrationsSchemas MigrationsSchemas IO ()

279 -> PQ MigrationsSchemas MigrationsSchemas IO ()

266− upMigration step =

280+ upMigration step = do

267− queryExecuted step

281+ executed <- queryExecuted step

268− & pqBind ( \ executed -> unless (executed == 1)

282+ unless (executed == 1) $ do

269− $ unsafePQ (runTerminally (up step))

283+ unsafePQ . runTerminally $ up step

270− & pqThen (manipulateParams insertMigration (Only (name step)))

284+ manipulateParams_ insertMigration (Only (name step))

271− -- insert execution record

272− & pqBind okResult )

273

285

274 queryExecuted

286 queryExecuted

275 :: Migration (Terminally PQ IO) schemas0 schemas1

287 :: Migration (Terminally PQ IO) schemas0 schemas1

276 -> PQ MigrationsSchemas MigrationsSchemas IO Row

288 -> PQ MigrationsSchemas MigrationsSchemas IO Row

277 queryExecuted step = do

289 queryExecuted step = do

278 result <- runQueryParams selectMigration (Only (name step))

290 result <- runQueryParams selectMigration (Only (name step))

279− okResult result

280 ntuples result

291 ntuples result

281

292

282− migrateDown migrations = unsafePQ $

293+ migrateDown migrations = unsafePQ . transactionally_ $ do

283 define createMigrations

294 define createMigrations

284− & pqBind okResult

285− & pqThen (transactionallySchema_ (downMigrations migrations))

295+ downMigrations migrations

286

296

287 where

297 where

288

298

289 downMigrations

299 downMigrations

290− :: AlignedList (Migration (Terminally PQ IO)) schemas0 schemas1

300+ :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

291 -> PQ MigrationsSchemas MigrationsSchemas IO ()

301 -> PQ MigrationsSchemas MigrationsSchemas IO ()

292 downMigrations = \case

302 downMigrations = \case

293 Done -> return ()

303 Done -> return ()

294− step :>> steps -> downMigrations steps & pqThen (downMigration step)

304+ step :>> steps -> downMigrations steps >> downMigration step

295

305

296 downMigration

306 downMigration

297 :: Migration (Terminally PQ IO) schemas0 schemas1

307 :: Migration (Terminally PQ IO) schemas0 schemas1

298 -> PQ MigrationsSchemas MigrationsSchemas IO ()

308 -> PQ MigrationsSchemas MigrationsSchemas IO ()

299− downMigration step =

309+ downMigration step = do

300− queryExecuted step

310+ executed <- queryExecuted step

301− & pqBind ( \ executed -> unless (executed == 0)

311+ unless (executed == 0) $ do

302− $ unsafePQ (runTerminally (down step))

312+ unsafePQ . runTerminally $ down step

303− & pqThen (manipulateParams deleteMigration (Only (name step)))

313+ manipulateParams_ deleteMigration (Only (name step))

304− -- delete execution record

305− & pqBind okResult )

306

314

307 queryExecuted

315 queryExecuted

308 :: Migration (Terminally PQ IO) schemas0 schemas1

316 :: Migration (Terminally PQ IO) schemas0 schemas1

309 -> PQ MigrationsSchemas MigrationsSchemas IO Row

317 -> PQ MigrationsSchemas MigrationsSchemas IO Row

310 queryExecuted step = do

318 queryExecuted step = do

311 result <- runQueryParams selectMigration (Only (name step))

319 result <- runQueryParams selectMigration (Only (name step))

312− okResult result

313 ntuples result

320 ntuples result

314

321

315−okResult :: K Result results -> PQ schema schema IO ()

316−okResult result = do

317− status <- resultStatus result

318− when (not (status `elem` [CommandOk, TuplesOk])) $ do

319− errorMessageMaybe <- resultErrorMessage result

320− case errorMessageMaybe of

321− Nothing -> error "migration: unknown error"

322− Just msg -> error ("migration: " <> show msg)

323−

324unsafePQ :: (Functor m) => PQ db0 db1 m x -> PQ db0' db1' m x

322unsafePQ :: (Functor m) => PQ db0 db1 m x -> PQ db0' db1' m x

325unsafePQ (PQ pq) = PQ $ fmap (SOP.K . SOP.unK) . pq . SOP.K . SOP.unK

323unsafePQ (PQ pq) = PQ $ fmap (SOP.K . SOP.unK) . pq . SOP.K . SOP.unK

326

324

@@ -353,24 +351,20 @@ createMigrations =

353

351

354-- | Inserts a `Migration` into the `MigrationsTable`, returning

352-- | Inserts a `Migration` into the `MigrationsTable`, returning

355-- the time at which it was inserted.

353-- the time at which it was inserted.

356−insertMigration

357− :: Manipulation_ MigrationsSchemas (Only Text) (P ("executed_at" ::: UTCTime))

354+insertMigration :: Manipulation_ MigrationsSchemas (Only Text) ()

358−insertMigration = insertInto #schema_migrations

355+insertMigration = insertInto_ #schema_migrations

359− (Values_ ((param @1) `as` #name :* defaultAs #executed_at))

356+ (Values_ (Set (param @1) `as` #name :* Default `as` #executed_at))

360− OnConflictDoRaise (Returning #executed_at)

361

357

362-- | Deletes a `Migration` from the `MigrationsTable`, returning

358-- | Deletes a `Migration` from the `MigrationsTable`, returning

363-- the time at which it was inserted.

359-- the time at which it was inserted.

364−deleteMigration

365− :: Manipulation_ MigrationsSchemas (Only Text) (P ("executed_at" ::: UTCTime))

360+deleteMigration :: Manipulation_ MigrationsSchemas (Only Text) ()

366−deleteMigration = deleteFrom #schema_migrations

361+deleteMigration = deleteFrom_ #schema_migrations (#name .== param @1)

367− NoUsing (#name .== param @1) (Returning #executed_at)

368

362

369-- | Selects a `Migration` from the `MigrationsTable`, returning

363-- | Selects a `Migration` from the `MigrationsTable`, returning

370-- the time at which it was inserted.

364-- the time at which it was inserted.

371selectMigration

365selectMigration

372− :: Query_ MigrationsSchemas (Only Text) (P ("executed_at" ::: UTCTime))

366+ :: Query_ MigrationsSchemas (Only Text) (Only UTCTime)

373−selectMigration = select_ #executed_at

367+selectMigration = select_ (#executed_at `as` #fromOnly)

374 $ from (table (#schema_migrations))

368 $ from (table (#schema_migrations))

375 & where_ (#name .== param @1)

369 & where_ (#name .== param @1)

376

370

@@ -390,7 +384,7 @@ defaultMain

390 :: Migratory p

384 :: Migratory p

391 => ByteString

385 => ByteString

392 -- ^ connection string

386 -- ^ connection string

393− -> AlignedList (Migration p) db0 db1

387+ -> Path (Migration p) db0 db1

394 -- ^ migrations

388 -- ^ migrations

395 -> IO ()

389 -> IO ()

396defaultMain connectTo migrations = do

390defaultMain connectTo migrations = do

@@ -411,12 +405,12 @@ defaultMain connectTo migrations = do

411 migrateStatus :: PQ schema schema IO ()

405 migrateStatus :: PQ schema schema IO ()

412 migrateStatus = unsafePQ $ do

406 migrateStatus = unsafePQ $ do

413 runNames <- getRunMigrationNames

407 runNames <- getRunMigrationNames

414− let names = extractList name migrations

408+ let names = ctoList name migrations

415 unrunNames = names \\ runNames

409 unrunNames = names \\ runNames

416 liftIO $ displayRunned runNames >> displayUnrunned unrunNames

410 liftIO $ displayRunned runNames >> displayUnrunned unrunNames

417

411

418 suppressNotices :: PQ schema schema IO ()

412 suppressNotices :: PQ schema schema IO ()

419− suppressNotices = void . manipulate $

413+ suppressNotices = manipulate_ $

420 UnsafeManipulation "SET client_min_messages TO WARNING;"

414 UnsafeManipulation "SET client_min_messages TO WARNING;"

421

415

422 readCommandFromArgs :: IO (Maybe MigrateCommand)

416 readCommandFromArgs :: IO (Maybe MigrateCommand)

squeal-postgresql/src/Squeal/PostgreSQL/PG.hs+180−89

@@ -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

8+`Squeal.PostgreSQL.PG` provides type families for turning Haskell

9+`Type`s into corresponding Postgres types.

10+-}

2{-# LANGUAGE

11{-# LANGUAGE

3 AllowAmbiguousTypes

12 AllowAmbiguousTypes

13+ , DeriveAnyClass

4 , DeriveFoldable

14 , DeriveFoldable

5 , DeriveFunctor

15 , DeriveFunctor

6 , DeriveGeneric

16 , DeriveGeneric

7 , DeriveTraversable

17 , DeriveTraversable

18+ , DerivingStrategies

8 , DefaultSignatures

19 , DefaultSignatures

9 , FlexibleContexts

20 , FlexibleContexts

10 , FlexibleInstances

21 , FlexibleInstances

11 , FunctionalDependencies

22 , FunctionalDependencies

12 , GADTs

23 , GADTs

13 , LambdaCase

24 , LambdaCase

14− , OverloadedStrings

15 , MultiParamTypeClasses

25 , MultiParamTypeClasses

26+ , OverloadedStrings

16 , ScopedTypeVariables

27 , ScopedTypeVariables

17 , TypeApplications

28 , TypeApplications

18 , TypeFamilies

29 , TypeFamilies

@@ -23,17 +34,27 @@

23#-}

34#-}

25module Squeal.PostgreSQL.PG

36module Squeal.PostgreSQL.PG

37+ ( -- * PG embeddings

26− ( PG

38+ PG

27 , NullPG

39 , NullPG

28 , TuplePG

40 , TuplePG

29 , RowPG

41 , RowPG

30− , Entity

42+ -- * Storage newtypes

31− , SOP.P (..)

43+ , Money (..)

44+ , Json (..)

45+ , Jsonb (..)

46+ , Composite (..)

47+ , Enumerated (..)

48+ , VarArray (..)

49+ , FixArray (..)

50+ , LibPQ.Oid (..)

51+ -- * Type families

32 , LabelsPG

52 , LabelsPG

33 , DimPG

53 , DimPG

34 , FixPG

54 , FixPG

35 , TupleOf

55 , TupleOf

36 , TupleCodeOf

56 , TupleCodeOf

57+ , RowOf

37 , ConstructorsOf

58 , ConstructorsOf

38 , ConstructorNameOf

59 , ConstructorNameOf

39 , ConstructorNamesOf

60 , ConstructorNamesOf

@@ -44,7 +65,7 @@ import Data.Kind (Type)

44import Data.Int (Int16, Int32, Int64)

65import Data.Int (Int16, Int32, Int64)

45import Data.Scientific (Scientific)

66import Data.Scientific (Scientific)

46import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime)

67import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime)

47−import Data.Word (Word16, Word32, Word64)

68+import Data.Vector (Vector)

48import Data.UUID.Types (UUID)

69import Data.UUID.Types (UUID)

49import GHC.TypeLits

70import GHC.TypeLits

50import Network.IP.Addr (NetAddr, IP)

71import Network.IP.Addr (NetAddr, IP)

@@ -53,14 +74,19 @@ import qualified Data.ByteString.Lazy as Lazy (ByteString)

53import qualified Data.ByteString as Strict (ByteString)

74import qualified Data.ByteString as Strict (ByteString)

54import qualified Data.Text.Lazy as Lazy (Text)

75import qualified Data.Text.Lazy as Lazy (Text)

55import qualified Data.Text as Strict (Text)

76import qualified Data.Text as Strict (Text)

77+import qualified Database.PostgreSQL.LibPQ as LibPQ

78+import qualified GHC.Generics as GHC

56import qualified Generics.SOP as SOP

79import qualified Generics.SOP as SOP

57import qualified Generics.SOP.Record as SOP

80import qualified Generics.SOP.Record as SOP

58import qualified Generics.SOP.Type.Metadata as Type

81import qualified Generics.SOP.Type.Metadata as Type

60import Squeal.PostgreSQL.Alias

83import Squeal.PostgreSQL.Alias

61−import Squeal.PostgreSQL.List

62import Squeal.PostgreSQL.Schema

84import Squeal.PostgreSQL.Schema

86+-- $setup

87+-- >>> import Squeal.PostgreSQL

88+-- >>> import Data.Text (Text)

89+

64{- | The `PG` type family embeds a subset of Haskell types

90{- | The `PG` type family embeds a subset of Haskell types

65as Postgres types. As an open type family, `PG` is extensible.

91as Postgres types. As an open type family, `PG` is extensible.

@@ -73,38 +99,59 @@ PG LocalTime :: PGType

73>>> type instance PG MyDouble = 'PGfloat8

99>>> type instance PG MyDouble = 'PGfloat8

74-}

100-}

75type family PG (hask :: Type) :: PGType

101type family PG (hask :: Type) :: PGType

102+-- | `PGbool`

76type instance PG Bool = 'PGbool

103type instance PG Bool = 'PGbool

104+-- | `PGint2`

77type instance PG Int16 = 'PGint2

105type instance PG Int16 = 'PGint2

106+-- | `PGint4`

78type instance PG Int32 = 'PGint4

107type instance PG Int32 = 'PGint4

108+-- | `PGint8`

79type instance PG Int64 = 'PGint8

109type instance PG Int64 = 'PGint8

80−type instance PG Word16 = 'PGint2

110+-- | `PGint2`

81−type instance PG Word32 = 'PGint4

111+type instance PG LibPQ.Oid = 'PGoid

82−type instance PG Word64 = 'PGint8

112+-- | `PGnumeric`

83type instance PG Scientific = 'PGnumeric

113type instance PG Scientific = 'PGnumeric

114+-- | `PGfloat4`

84type instance PG Float = 'PGfloat4

115type instance PG Float = 'PGfloat4

116+-- | `PGfloat8`

85type instance PG Double = 'PGfloat8

117type instance PG Double = 'PGfloat8

118+-- | `PGchar` @1@

86type instance PG Char = 'PGchar 1

119type instance PG Char = 'PGchar 1

120+-- | `PGtext`

87type instance PG Strict.Text = 'PGtext

121type instance PG Strict.Text = 'PGtext

122+-- | `PGtext`

88type instance PG Lazy.Text = 'PGtext

123type instance PG Lazy.Text = 'PGtext

124+-- | `PGtext`

89type instance PG String = 'PGtext

125type instance PG String = 'PGtext

126+-- | `PGbytea`

90type instance PG Strict.ByteString = 'PGbytea

127type instance PG Strict.ByteString = 'PGbytea

128+-- | `PGbytea`

91type instance PG Lazy.ByteString = 'PGbytea

129type instance PG Lazy.ByteString = 'PGbytea

130+-- | `PGtimestamp`

92type instance PG LocalTime = 'PGtimestamp

131type instance PG LocalTime = 'PGtimestamp

132+-- | `PGtimestamptz`

93type instance PG UTCTime = 'PGtimestamptz

133type instance PG UTCTime = 'PGtimestamptz

134+-- | `PGdate`

94type instance PG Day = 'PGdate

135type instance PG Day = 'PGdate

136+-- | `PGtime`

95type instance PG TimeOfDay = 'PGtime

137type instance PG TimeOfDay = 'PGtime

138+-- | `PGtimetz`

96type instance PG (TimeOfDay, TimeZone) = 'PGtimetz

139type instance PG (TimeOfDay, TimeZone) = 'PGtimetz

140+-- | `PGinterval`

97type instance PG DiffTime = 'PGinterval

141type instance PG DiffTime = 'PGinterval

142+-- | `PGuuid`

98type instance PG UUID = 'PGuuid

143type instance PG UUID = 'PGuuid

144+-- | `PGinet`

99type instance PG (NetAddr IP) = 'PGinet

145type instance PG (NetAddr IP) = 'PGinet

146+-- | `PGjson`

100type instance PG Value = 'PGjson

147type instance PG Value = 'PGjson

101

148

102{-| The `LabelsPG` type family calculates the constructors of a

149{-| The `LabelsPG` type family calculates the constructors of a

103Haskell enum type.

150Haskell enum type.

104

151

105>>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

152>>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

106−>>> instance Generic Schwarma

153+>>> instance SOP.Generic Schwarma

107−>>> instance HasDatatypeInfo Schwarma

154+>>> instance SOP.HasDatatypeInfo Schwarma

108>>> :kind! LabelsPG Schwarma

155>>> :kind! LabelsPG Schwarma

109LabelsPG Schwarma :: [Type.ConstructorName]

156LabelsPG Schwarma :: [Type.ConstructorName]

110= '["Beef", "Lamb", "Chicken"]

157= '["Beef", "Lamb", "Chicken"]

@@ -117,92 +164,30 @@ type family LabelsPG (hask :: Type) :: [Type.ConstructorName] where

117`RowPG` turns a Haskell `Type` into a `RowType`.

164`RowPG` turns a Haskell `Type` into a `RowType`.

118

165

119`RowPG` may be applied to normal Haskell record types provided they

166`RowPG` may be applied to normal Haskell record types provided they

120−have the `Generic` and `HasDatatypeInfo` instances;

167+have `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

121

168

122−>>> data Person = Person { name :: Text, age :: Int32 } deriving GHC.Generic

169+>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic

123−>>> instance Generic Person

170+>>> instance SOP.Generic Person

124−>>> instance HasDatatypeInfo Person

171+>>> instance SOP.HasDatatypeInfo Person

125>>> :kind! RowPG Person

172>>> :kind! RowPG Person

126RowPG Person :: [(Symbol, NullityType)]

173RowPG Person :: [(Symbol, NullityType)]

127= '["name" ::: 'NotNull 'PGtext, "age" ::: 'NotNull 'PGint4]

174= '["name" ::: 'NotNull 'PGtext, "age" ::: 'NotNull 'PGint4]

128−

129−Or to tuples of `P` types;

130−

131−>>> :kind! RowPG (P ("id" ::: Int32), P ("foreign_id" ::: Int32))

132−RowPG (P ("id" ::: Int32), P ("foreign_id" ::: Int32)) :: [(Symbol,

133− NullityType)]

134−= '[ '("id", 'NotNull 'PGint4), "foreign_id" ::: 'NotNull 'PGint4]

135−

136−Or to tuples which mix `P` types and record types.

137−

138−>>> :kind! RowPG (P ("id" ::: Int32), Person, P ("foreign_id" ::: Int32))

139−RowPG (P ("id" ::: Int32), Person, P ("foreign_id" ::: Int32)) :: [(Symbol,

140− NullityType)]

141−= '[ '("id", 'NotNull 'PGint4), '("name", 'NotNull 'PGtext),

142− '("age", 'NotNull 'PGint4), "foreign_id" ::: 'NotNull 'PGint4]

143-}

175-}

144type family RowPG (hask :: Type) :: RowType where

176type family RowPG (hask :: Type) :: RowType where

145− RowPG (hask1, hask2) = Join (RowPG hask1) (RowPG hask2)

146− RowPG (hask1, hask2, hask3) =

147− Join (RowPG hask1) (RowPG (hask2, hask3))

148− RowPG (hask1, hask2, hask3, hask4) =

149− Join (RowPG hask1) (RowPG (hask2, hask3, hask4))

150− RowPG (hask1, hask2, hask3, hask4, hask5) =

151− Join (RowPG hask1) (RowPG (hask2, hask3, hask4, hask5))

152− RowPG (SOP.P (col ::: head)) = '[col ::: NullPG head]

153 RowPG hask = RowOf (SOP.RecordCodeOf hask)

177 RowPG hask = RowOf (SOP.RecordCodeOf hask)

154

178

179+-- | `RowOf` applies `NullPG` to the fields of a list.

155type family RowOf (record :: [(Symbol, Type)]) :: RowType where

180type family RowOf (record :: [(Symbol, Type)]) :: RowType where

156− 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

157 RowOf (col ::: ty ': record) = col ::: NullPG ty ': RowOf record

189 RowOf (col ::: ty ': record) = col ::: NullPG ty ': RowOf record

158−

190+ RowOf '[] = '[]

159−type family ColumnsOf (record :: [(Symbol, Type)]) :: ColumnsType where

160− ColumnsOf '[] = '[]

161− ColumnsOf (col ::: ty ': record) =

162− col ::: 'NoDef :=> NullPG ty ': ColumnsOf record

163−

164−{- |

165−`Entity` turns a Haskell `Type` into a `ColumnsType`.

166−

167−`Entity` may be applied to normal Haskell record types provided they

168−have the `Generic` and `HasDatatypeInfo` instances;

169−

170−>>> data Person = Person { name :: Text, age :: Int32 } deriving GHC.Generic

171−>>> instance Generic Person

172−>>> instance HasDatatypeInfo Person

173−>>> :kind! Entity Person

174−Entity Person :: [(Symbol, (ColumnConstraint, NullityType))]

175−= '["name" ::: ('NoDef :=> 'NotNull 'PGtext),

176− "age" ::: ('NoDef :=> 'NotNull 'PGint4)]

177−

178−Or to tuples of `P` types;

179−

180−>>> :kind! Entity (P ("id" ::: Int32), P ("foreign_id" ::: Int32))

181−Entity (P ("id" ::: Int32), P ("foreign_id" ::: Int32)) :: [(Symbol,

182− ColumnType)]

183−= '[ '("id", 'Def :=> 'NotNull 'PGint4),

184− "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]

185−

186−Or to tuples which mix `P` types and record types.

187−

188−>>> :kind! Entity (P ("id" ::: Int32), Person, P ("foreign_id" ::: Int32))

189−Entity (P ("id" ::: Int32), Person, P ("foreign_id" ::: Int32)) :: [(Symbol,

190− ColumnType)]

191−= '[ '("id", 'Def :=> 'NotNull 'PGint4),

192− '("name", 'NoDef :=> 'NotNull 'PGtext),

193− '("age", 'NoDef :=> 'NotNull 'PGint4),

194− "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]

195−-}

196−type family Entity (hask :: Type) :: ColumnsType where

197− Entity (hask1, hask2) = Join (Entity hask1) (Entity hask2)

198− Entity (hask1, hask2, hask3) =

199− Join (Entity hask1) (Entity (hask2, hask3))

200− Entity (hask1, hask2, hask3, hask4) =

201− Join (Entity hask1) (Entity (hask2, hask3, hask4))

202− Entity (hask1, hask2, hask3, hask4, hask5) =

203− Join (Entity hask1) (Entity (hask2, hask3, hask4, hask5))

204− Entity (SOP.P (col ::: head)) = '[col ::: 'Def :=> NullPG head]

205− Entity hask = ColumnsOf (SOP.RecordCodeOf hask)

206

191

207{- | `NullPG` turns a Haskell type into a `NullityType`.

192{- | `NullPG` turns a Haskell type into a `NullityType`.

208

193

@@ -227,10 +212,22 @@ TuplePG (Double, Maybe Char) :: [NullityType]

227type family TuplePG (hask :: Type) :: [NullityType] where

212type family TuplePG (hask :: Type) :: [NullityType] where

228 TuplePG hask = TupleOf (TupleCodeOf hask (SOP.Code hask))

213 TuplePG hask = TupleOf (TupleCodeOf hask (SOP.Code hask))

229

214

215+-- | `TupleOf` turns a list of Haskell `Type`s into a list of `NullityType`s.

230type family TupleOf (tuple :: [Type]) :: [NullityType] where

216type family TupleOf (tuple :: [Type]) :: [NullityType] where

231− 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

232 TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple

226 TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple

227+ TupleOf '[] = '[]

233

228

229+-- | `TupleCodeOf` takes the `SOP.Code` of a haskell `Type`

230+-- and if it's a simple product returns it, otherwise giving a `TypeError`.

234type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where

231type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where

235 TupleCodeOf hask '[tuple] = tuple

232 TupleCodeOf hask '[tuple] = tuple

236 TupleCodeOf hask '[] =

233 TupleCodeOf hask '[] =

@@ -271,6 +268,7 @@ type family ConstructorNamesOf (constructors :: [Type.ConstructorInfo])

271 ConstructorNamesOf (constructor ': constructors) =

268 ConstructorNamesOf (constructor ': constructors) =

272 ConstructorNameOf constructor ': ConstructorNamesOf constructors

269 ConstructorNameOf constructor ': ConstructorNamesOf constructors

273

270

271+-- | `DimPG` turns Haskell nested homogeneous tuples into a list of lengths.

274type family DimPG (hask :: Type) :: [Nat] where

272type family DimPG (hask :: Type) :: [Nat] where

275 DimPG (x,x) = 2 ': DimPG x

273 DimPG (x,x) = 2 ': DimPG x

276 DimPG (x,x,x) = 3 ': DimPG x

274 DimPG (x,x,x) = 3 ': DimPG x

@@ -283,6 +281,7 @@ type family DimPG (hask :: Type) :: [Nat] where

283 DimPG (x,x,x,x,x,x,x,x,x,x) = 10 ': DimPG x

281 DimPG (x,x,x,x,x,x,x,x,x,x) = 10 ': DimPG x

284 DimPG x = '[]

282 DimPG x = '[]

285

283

284+-- | `FixPG` extracts `NullPG` of the base type of nested homogeneous tuples.

286type family FixPG (hask :: Type) :: NullityType where

285type family FixPG (hask :: Type) :: NullityType where

287 FixPG (x,x) = FixPG x

286 FixPG (x,x) = FixPG x

288 FixPG (x,x,x) = FixPG x

287 FixPG (x,x,x) = FixPG x

@@ -295,3 +294,95 @@ type family FixPG (hask :: Type) :: NullityType where

295 FixPG (x,x,x,x,x,x,x,x,x,x) = FixPG x

294 FixPG (x,x,x,x,x,x,x,x,x,x) = FixPG x

296 FixPG (x,x,x,x,x,x,x,x,x,x,x) = FixPG x

295 FixPG (x,x,x,x,x,x,x,x,x,x,x) = FixPG x

297 FixPG x = NullPG x

296 FixPG x = NullPG x

297+

298+{- | The `Money` newtype stores a monetary value in terms

299+of the number of cents, i.e. @$2,000.20@ would be expressed as

300+@Money { cents = 200020 }@.

301+

302+>>> import Control.Monad (void)

303+>>> import Control.Monad.IO.Class (liftIO)

304+>>> import Squeal.PostgreSQL

305+>>> :{

306+let

307+ roundTrip :: Query_ (Public '[]) (Only Money) (Only Money)

308+ roundTrip = values_ $ parameter @1 money `as` #fromOnly

309+:}

310+

311+>>> let input = Only (Money 20020)

312+

313+>>> :{

314+withConnection "host=localhost port=5432 dbname=exampledb" $ do

315+ result <- runQueryParams roundTrip input

316+ Just output <- firstRow result

317+ liftIO . print $ input == output

318+:}

319+True

320+-}

321+newtype Money = Money { cents :: Int64 }

322+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)

323+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

324+-- | `PGmoney`

325+type instance PG Money = 'PGmoney

326+

327+{- | The `Json` newtype is an indication that the Haskell

328+type it's applied to should be stored as a `PGjson`.

329+-}

330+newtype Json hask = Json {getJson :: hask}

331+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)

332+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

333+-- | `PGjson`

334+type instance PG (Json hask) = 'PGjson

335+

336+{- | The `Jsonb` newtype is an indication that the Haskell

337+type it's applied to should be stored as a `PGjsonb`.

338+-}

339+newtype Jsonb hask = Jsonb {getJsonb :: hask}

340+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)

341+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

342+-- | `PGjsonb`

343+type instance PG (Jsonb hask) = 'PGjsonb

344+

345+{- | The `Composite` newtype is an indication that the Haskell

346+type it's applied to should be stored as a `PGcomposite`.

347+-}

348+newtype Composite record = Composite {getComposite :: record}

349+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)

350+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

351+-- | `PGcomposite` @(@`RowPG` @hask)@

352+type instance PG (Composite hask) = 'PGcomposite (RowPG hask)

353+

354+{- | The `Enumerated` newtype is an indication that the Haskell

355+type it's applied to should be stored as a `PGenum`.

356+-}

357+newtype Enumerated enum = Enumerated {getEnumerated :: enum}

358+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)

359+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

360+-- | `PGenum` @(@`LabelsPG` @hask)@

361+type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)

362+

363+{- | The `VarArray` newtype is an indication that the Haskell

364+type 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)

369+-}

370+newtype VarArray arr = VarArray {getVarArray :: arr}

371+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)

372+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

373+-- | `PGvararray` @(@`NullPG` @hask)@

374+type instance PG (VarArray (Vector hask)) = 'PGvararray (NullPG hask)

375+type instance PG (VarArray [hask]) = 'PGvararray (NullPG hask)

376+

377+{- | The `FixArray` newtype is an indication that the Haskell

378+type 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)

383+-}

384+newtype FixArray arr = FixArray {getFixArray :: arr}

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+99−40

@@ -64,17 +64,21 @@ module Squeal.PostgreSQL.PQ

64 , resultErrorCode

65 -- * Exceptions

66 , SquealException (..)

67+ , PQState (..)

68+ , okResult

67 , catchSqueal

69 , catchSqueal

68 , handleSqueal

70 , handleSqueal

71+ , trySqueal

69 ) where

72 ) where

71import Control.Exception (Exception, throw)

74import Control.Exception (Exception, throw)

72import Control.Monad.Except

75import Control.Monad.Except

73import Control.Monad.Morph

76import Control.Monad.Morph

74−import UnliftIO (MonadUnliftIO (..), bracket, catch, handle)

77+import UnliftIO (MonadUnliftIO (..), bracket, catch, handle, try)

75import Data.ByteString (ByteString)

78import Data.ByteString (ByteString)

76import Data.Foldable

79import Data.Foldable

77import Data.Function ((&))

80import Data.Function ((&))

81+import Data.Functor ((<&>))

78import Data.Kind

82import Data.Kind

79import Data.Text (pack, Text)

83import Data.Text (pack, Text)

80import Data.Traversable

84import Data.Traversable

@@ -83,6 +87,7 @@ import PostgreSQL.Binary.Encoding (encodingBytes)

84import qualified Control.Monad.Fail as Fail

88import qualified Control.Monad.Fail as Fail

85import qualified Database.PostgreSQL.LibPQ as LibPQ

89import qualified Database.PostgreSQL.LibPQ as LibPQ

90+import qualified PostgreSQL.Binary.Encoding as Encoding

87import Squeal.PostgreSQL.Binary

92import Squeal.PostgreSQL.Binary

88import Squeal.PostgreSQL.Definition

93import Squeal.PostgreSQL.Definition

@@ -103,6 +108,9 @@ import qualified Control.Monad.Trans.Writer.Strict as Strict

103import qualified Control.Monad.Trans.RWS.Lazy as Lazy

108import qualified Control.Monad.Trans.RWS.Lazy as Lazy

104import qualified Control.Monad.Trans.RWS.Strict as Strict

109import qualified Control.Monad.Trans.RWS.Strict as Strict

105

110

111+-- $setup

112+-- >>> import Squeal.PostgreSQL

113+

106{- | Makes a new connection to the database server.

114{- | Makes a new connection to the database server.

107

115

108This function opens a new database connection using the parameters taken

116This function opens a new database connection using the parameters taken

@@ -240,13 +248,16 @@ class IndexedMonadTransPQ pq where

240 -> x -> pq schemas0 schemas2 m z

248 -> x -> pq schemas0 schemas2 m z

241 pqAndThen g f x = pqBind g (f x)

249 pqAndThen g f x = pqBind g (f x)

242

250

243− -- | Run a `Definition` with `LibPQ.exec`, we expect that libpq obeys the law

251+ -- | Run a `Definition` with `LibPQ.exec`.

252+ --

253+ -- It should be functorial in effect.

244 --

254 --

255+ -- @define id = return ()@

245− -- @define statement1 & pqThen (define statement2) = define (statement1 >>> statement2)@

256+ -- @define (statement1 >>> statement2) = define statement1 & pqThen (define statement2)@

246 define

257 define

247 :: MonadIO io

258 :: MonadIO io

248 => Definition schemas0 schemas1

259 => Definition schemas0 schemas1

249− -> pq schemas0 schemas1 io (K LibPQ.Result '[])

260+ -> pq schemas0 schemas1 io ()

250

261

251instance IndexedMonadTransPQ PQ where

262instance IndexedMonadTransPQ PQ where

252

263

@@ -264,7 +275,7 @@ instance IndexedMonadTransPQ PQ where

264 case resultMaybe of

275 case resultMaybe of

265 Nothing -> throw $ ResultException

276 Nothing -> throw $ ResultException

266 "define: LibPQ.exec returned no results"

277 "define: LibPQ.exec returned no results"

267− Just result -> return $ K (K result)

278+ Just result -> K <$> okResult_ result

268

279

269{- | `MonadPQ` is an @mtl@ style constraint, similar to

280{- | `MonadPQ` is an @mtl@ style constraint, similar to

270`Control.Monad.State.Class.MonadState`, for using `Database.PostgreSQL.LibPQ` to

281`Control.Monad.State.Class.MonadState`, for using `Database.PostgreSQL.LibPQ` to

@@ -273,8 +284,12 @@ instance IndexedMonadTransPQ PQ where

273 with a `ToParams` constraint. It calls `LibPQ.execParams` and

284 with a `ToParams` constraint. It calls `LibPQ.execParams` and

274 doesn't afraid of anything.

285 doesn't afraid of anything.

275

286

287+* `manipulateParams_` is like `manipulateParams` for a returning-free statement.

288+

276* `manipulate` is like `manipulateParams` for a parameter-free statement.

289* `manipulate` is like `manipulateParams` for a parameter-free statement.

277

290

291+* `manipulate_` is like `manipulate` for a returning-free statement.

292+

278* `runQueryParams` is like `manipulateParams` for query statements.

293* `runQueryParams` is like `manipulateParams` for query statements.

279

294

280* `runQuery` is like `runQueryParams` for a parameter-free statement.

295* `runQuery` is like `runQueryParams` for a parameter-free statement.

@@ -288,7 +303,7 @@ instance IndexedMonadTransPQ PQ where

288* `forPrepared` is a flipped `traversePrepared`

303* `forPrepared` is a flipped `traversePrepared`

289

304

290* `traversePrepared_` is like `traversePrepared` but works on `Foldable`

305* `traversePrepared_` is like `traversePrepared` but works on `Foldable`

291− containers and returns unit.

306+ containers for a returning-free statement.

292

307

293* `forPrepared_` is a flipped `traversePrepared_`.

308* `forPrepared_` is a flipped `traversePrepared_`.

294

309

@@ -302,24 +317,34 @@ a default instance.

302-}

317-}

303class Monad pq => MonadPQ schemas pq | pq -> schemas where

318class Monad pq => MonadPQ schemas pq | pq -> schemas where

304 manipulateParams

319 manipulateParams

305− :: ToParams x params

320+ :: (ToParams x params, All OidOfParam params)

306 => Manipulation '[] schemas params ys

321 => Manipulation '[] schemas params ys

307 -- ^ `insertInto`, `update` or `deleteFrom`

322 -- ^ `insertInto`, `update` or `deleteFrom`

308 -> x -> pq (K LibPQ.Result ys)

323 -> x -> pq (K LibPQ.Result ys)

309 default manipulateParams

324 default manipulateParams

310 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

325 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

311− => ToParams x params

326+ => (ToParams x params, All OidOfParam params)

312 => Manipulation '[] schemas params ys

327 => Manipulation '[] schemas params ys

313 -- ^ `insertInto`, `update` or `deleteFrom`

328 -- ^ `insertInto`, `update` or `deleteFrom`

314 -> x -> pq (K LibPQ.Result ys)

329 -> x -> pq (K LibPQ.Result ys)

315 manipulateParams manipulation params = lift $

330 manipulateParams manipulation params = lift $

316 manipulateParams manipulation params

331 manipulateParams manipulation params

317

332

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+

318 manipulate :: Manipulation '[] schemas '[] ys -> pq (K LibPQ.Result ys)

340 manipulate :: Manipulation '[] schemas '[] ys -> pq (K LibPQ.Result ys)

319 manipulate statement = manipulateParams statement ()

341 manipulate statement = manipulateParams statement ()

320

342

343+ manipulate_ :: Manipulation '[] schemas '[] '[] -> pq ()

344+ manipulate_ = void . manipulate

345+

321 runQueryParams

346 runQueryParams

322− :: ToParams x params

347+ :: (ToParams x params, All OidOfParam params)

323 => Query '[] '[] schemas params ys

348 => Query '[] '[] schemas params ys

324 -- ^ `select` and friends

349 -- ^ `select` and friends

325 -> x -> pq (K LibPQ.Result ys)

350 -> x -> pq (K LibPQ.Result ys)

@@ -332,19 +357,19 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

332 runQuery q = runQueryParams q ()

357 runQuery q = runQueryParams q ()

333

358

334 traversePrepared

359 traversePrepared

335− :: (ToParams x params, Traversable list)

360+ :: (ToParams x params, Traversable list, All OidOfParam params)

336 => Manipulation '[] schemas params ys

361 => Manipulation '[] schemas params ys

337 -- ^ `insertInto`, `update`, or `deleteFrom`, and friends

362 -- ^ `insertInto`, `update`, or `deleteFrom`, and friends

338 -> list x -> pq (list (K LibPQ.Result ys))

363 -> list x -> pq (list (K LibPQ.Result ys))

339 default traversePrepared

364 default traversePrepared

340 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

365 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

341− => (ToParams x params, Traversable list)

366+ => (ToParams x params, Traversable list, All OidOfParam params)

342 => Manipulation '[] schemas params ys -> list x -> pq (list (K LibPQ.Result ys))

367 => Manipulation '[] schemas params ys -> list x -> pq (list (K LibPQ.Result ys))

343 traversePrepared manipulation params = lift $

368 traversePrepared manipulation params = lift $

344 traversePrepared manipulation params

369 traversePrepared manipulation params

345

370

346 forPrepared

371 forPrepared

347− :: (ToParams x params, Traversable list)

372+ :: (ToParams x params, Traversable list, All OidOfParam params)

348 => list x

373 => list x

349 -> Manipulation '[] schemas params ys

374 -> Manipulation '[] schemas params ys

350 -- ^ `insertInto`, `update` or `deleteFrom`

375 -- ^ `insertInto`, `update` or `deleteFrom`

@@ -352,13 +377,13 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

352 forPrepared = flip traversePrepared

377 forPrepared = flip traversePrepared

353

378

354 traversePrepared_

379 traversePrepared_

355− :: (ToParams x params, Foldable list)

380+ :: (ToParams x params, Foldable list, All OidOfParam params)

356 => Manipulation '[] schemas params '[]

381 => Manipulation '[] schemas params '[]

357 -- ^ `insertInto`, `update` or `deleteFrom`

382 -- ^ `insertInto`, `update` or `deleteFrom`

358 -> list x -> pq ()

383 -> list x -> pq ()

359 default traversePrepared_

384 default traversePrepared_

360 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

385 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

361− => (ToParams x params, Foldable list)

386+ => (ToParams x params, Foldable list, All OidOfParam params)

362 => Manipulation '[] schemas params '[]

387 => Manipulation '[] schemas params '[]

363 -- ^ `insertInto`, `update` or `deleteFrom`

388 -- ^ `insertInto`, `update` or `deleteFrom`

364 -> list x -> pq ()

389 -> list x -> pq ()

@@ -366,7 +391,7 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

366 traversePrepared_ manipulation params

391 traversePrepared_ manipulation params

367

392

368 forPrepared_

393 forPrepared_

369− :: (ToParams x params, Foldable list)

394+ :: (ToParams x params, Foldable list, All OidOfParam params)

370 => list x

395 => list x

371 -> Manipulation '[] schemas params '[]

396 -> Manipulation '[] schemas params '[]

372 -- ^ `insertInto`, `update` or `deleteFrom`

397 -- ^ `insertInto`, `update` or `deleteFrom`

@@ -386,54 +411,76 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

386 (UnsafeManipulation q :: Manipulation '[] schemas ps ys) (params :: x) =

411 (UnsafeManipulation q :: Manipulation '[] schemas ps ys) (params :: x) =

387 PQ $ \ (K conn) -> do

412 PQ $ \ (K conn) -> do

388 let

413 let

389− toParam' encoding =

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 ->

390− (LibPQ.invalidOid, encodingBytes encoding, LibPQ.Binary)

420+ (oidOfParam @param, encodingBytes encoding, LibPQ.Binary)

421+ params'

422+ = hcollapse

423+ . hcmap (Proxy @OidOfParam) paramSet

391− params' = fmap (fmap toParam') (hcollapse (toParams @x @ps params))

424+ $ toParams @x @ps params

392 q' = q <> ";"

425 q' = q <> ";"

393 resultMaybe <- liftIO $ LibPQ.execParams conn q' params' LibPQ.Binary

426 resultMaybe <- liftIO $ LibPQ.execParams conn q' params' LibPQ.Binary

394 case resultMaybe of

427 case resultMaybe of

395 Nothing -> throw $ ResultException

428 Nothing -> throw $ ResultException

396 "manipulateParams: LibPQ.execParams returned no results"

429 "manipulateParams: LibPQ.execParams returned no results"

397 Just result -> do

430 Just result -> do

398− tryResult result

431+ okResult_ result

399 return $ K (K result)

432 return $ K (K result)

400

433

401 traversePrepared

434 traversePrepared

402 (UnsafeManipulation q :: Manipulation '[] schemas xs ys) (list :: list x) =

435 (UnsafeManipulation q :: Manipulation '[] schemas xs ys) (list :: list x) =

403 PQ $ \ (K conn) -> liftIO $ do

436 PQ $ \ (K conn) -> liftIO $ do

437+ let

404− let temp = "temporary_statement"

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

405− prepResultMaybe <- LibPQ.prepare conn temp q Nothing

445+ prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

406 case prepResultMaybe of

446 case prepResultMaybe of

407 Nothing -> throw $ ResultException

447 Nothing -> throw $ ResultException

408 "traversePrepared: LibPQ.prepare returned no results"

448 "traversePrepared: LibPQ.prepare returned no results"

409− Just prepResult -> tryResult prepResult

449+ Just prepResult -> okResult_ prepResult

410 results <- for list $ \ params -> do

450 results <- for list $ \ params -> do

411 let

451 let

412− toParam' encoding = (encodingBytes encoding,LibPQ.Binary)

452+ toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

413 params' = fmap (fmap toParam') (hcollapse (toParams @x @xs params))

453 params' = fmap (fmap toParam') (hcollapse (toParams @x @xs params))

414 resultMaybe <- LibPQ.execPrepared conn temp params' LibPQ.Binary

454 resultMaybe <- LibPQ.execPrepared conn temp params' LibPQ.Binary

415 case resultMaybe of

455 case resultMaybe of

416 Nothing -> throw $ ResultException

456 Nothing -> throw $ ResultException

417 "traversePrepared: LibPQ.execParams returned no results"

457 "traversePrepared: LibPQ.execParams returned no results"

418 Just result -> do

458 Just result -> do

419− tryResult result

459+ okResult_ result

420 return $ K result

460 return $ K result

421 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

461 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

422 case deallocResultMaybe of

462 case deallocResultMaybe of

423 Nothing -> throw $ ResultException

463 Nothing -> throw $ ResultException

424 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

464 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

425− Just deallocResult -> tryResult deallocResult

465+ Just deallocResult -> okResult_ deallocResult

426 return (K results)

466 return (K results)

427

467

428 traversePrepared_

468 traversePrepared_

429 (UnsafeManipulation q :: Manipulation '[] schemas xs '[]) (list :: list x) =

469 (UnsafeManipulation q :: Manipulation '[] schemas xs '[]) (list :: list x) =

430 PQ $ \ (K conn) -> liftIO $ do

470 PQ $ \ (K conn) -> liftIO $ do

471+ let

431− let temp = "temporary_statement"

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

432− prepResultMaybe <- LibPQ.prepare conn temp q Nothing

479+ prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

433 case prepResultMaybe of

480 case prepResultMaybe of

434 Nothing -> throw $ ResultException

481 Nothing -> throw $ ResultException

435 "traversePrepared_: LibPQ.prepare returned no results"

482 "traversePrepared_: LibPQ.prepare returned no results"

436− Just prepResult -> tryResult prepResult

483+ Just prepResult -> okResult_ prepResult

437 for_ list $ \ params -> do

484 for_ list $ \ params -> do

438 let

485 let

439 toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

486 toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

@@ -442,12 +489,12 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

442 case resultMaybe of

489 case resultMaybe of

443 Nothing -> throw $ ResultException

490 Nothing -> throw $ ResultException

444 "traversePrepared_: LibPQ.execParams returned no results"

491 "traversePrepared_: LibPQ.execParams returned no results"

445− Just result -> tryResult result

492+ Just result -> okResult_ result

446 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

493 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

447 case deallocResultMaybe of

494 case deallocResultMaybe of

448 Nothing -> throw $ ResultException

495 Nothing -> throw $ ResultException

449 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

496 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

450− Just deallocResult -> tryResult deallocResult

497+ Just deallocResult -> okResult_ deallocResult

451 return (K ())

498 return (K ())

452

499

453 liftPQ pq = PQ $ \ (K conn) -> do

500 liftPQ pq = PQ $ \ (K conn) -> do

@@ -610,24 +657,24 @@ resultErrorCode

610 -> io (Maybe ByteString)

657 -> io (Maybe ByteString)

611resultErrorCode = liftResult (flip LibPQ.resultErrorField LibPQ.DiagSqlstate)

658resultErrorCode = liftResult (flip LibPQ.resultErrorField LibPQ.DiagSqlstate)

612

659

613−-- | `Exception`s that can be thrown by Squeal.

660+-- | the state of LibPQ

614−data SquealException

661+data PQState = PQState

615− = PQException

616 { sqlExecStatus :: LibPQ.ExecStatus

662 { sqlExecStatus :: LibPQ.ExecStatus

617 , sqlStateCode :: Maybe ByteString

663 , sqlStateCode :: Maybe ByteString

618 -- ^ https://www.postgresql.org/docs/current/static/errcodes-appendix.html

664 -- ^ https://www.postgresql.org/docs/current/static/errcodes-appendix.html

619 , sqlErrorMessage :: Maybe ByteString

665 , sqlErrorMessage :: Maybe ByteString

620− }

666+ } deriving (Eq, Show)

667+

668+-- | `Exception`s that can be thrown by Squeal.

669+data SquealException

670+ = PQException PQState

621 | ResultException Text

671 | ResultException Text

622 | ParseException Text

672 | ParseException Text

623 deriving (Eq, Show)

673 deriving (Eq, Show)

624instance Exception SquealException

674instance Exception SquealException

625

675

626−tryResult

627− :: MonadIO io

628− => LibPQ.Result

676+okResult_ :: MonadIO io => LibPQ.Result -> io ()

629− -> io ()

630−tryResult result = liftIO $ do

677+okResult_ result = liftIO $ do

631 status <- LibPQ.resultStatus result

678 status <- LibPQ.resultStatus result

632 case status of

679 case status of

633 LibPQ.CommandOk -> return ()

680 LibPQ.CommandOk -> return ()

@@ -635,7 +682,12 @@ tryResult result = liftIO $ do

635 _ -> do

682 _ -> do

636 stateCode <- LibPQ.resultErrorField result LibPQ.DiagSqlstate

683 stateCode <- LibPQ.resultErrorField result LibPQ.DiagSqlstate

637 msg <- LibPQ.resultErrorMessage result

684 msg <- LibPQ.resultErrorMessage result

638− 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

639

691

640-- | Catch `SquealException`s.

692-- | Catch `SquealException`s.

641catchSqueal

693catchSqueal

@@ -651,3 +703,10 @@ handleSqueal

651 => (SquealException -> io a) -- ^ handler

703 => (SquealException -> io a) -- ^ handler

652 -> io a -> io a

704 -> io a -> io a

653handleSqueal = handle

705handleSqueal = 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 @@

1{-|

2−Module: Squeal.PostgreSQL.Definition

2+Module: Squeal.PostgreSQL.Pool

3−Description: Pooled connections

3+Description: Connection pools

4Copyright: (c) Eitan Chatav, 2017

5Maintainer: eitan@morphism.tech

6Stability: experimental

8−A `MonadPQ` for pooled connections.

8+Connection pools.

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

9-}

31-}

11{-# LANGUAGE

33{-# LANGUAGE

@@ -23,51 +45,19 @@ A `MonadPQ` for pooled connections.

24module Squeal.PostgreSQL.Pool

46module Squeal.PostgreSQL.Pool

25 ( -- * Pools

47 ( -- * Pools

26− PoolPQ (..)

48+ Pool

27 , createConnectionPool

49 , createConnectionPool

28− , Pool

50+ , usingConnectionPool

29− , destroyAllResources

51+ , destroyConnectionPool

30 ) where

52 ) where

32−import Control.Monad.Trans

33import Data.ByteString

54import Data.ByteString

34import Data.Time

55import Data.Time

35−import Generics.SOP (K(..))

56+import Generics.SOP (K(..), unK)

36import UnliftIO (MonadUnliftIO (..))

57import UnliftIO (MonadUnliftIO (..))

37import UnliftIO.Pool (Pool, createPool, destroyAllResources, withResource)

58import UnliftIO.Pool (Pool, createPool, destroyAllResources, withResource)

39−import qualified Control.Monad.Fail as Fail

40−

41import Squeal.PostgreSQL.PQ

60import 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

72-- | Create a striped pool of connections.

62-- | Create a striped pool of connections.

73-- 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.

63-- 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

92createConnectionPool conninfo stripes idle maxResrc =

82createConnectionPool conninfo stripes idle maxResrc =

93 createPool (connectdb conninfo) finish stripes idle maxResrc

83 createPool (connectdb conninfo) finish stripes idle maxResrc

95−-- | `Applicative` instance for `PoolPQ`.

85+{-|

96−instance Monad m => Applicative (PoolPQ schemas m) where

86+Temporarily take a connection from a `Pool`, perform an action with it,

97− pure x = PoolPQ $ \ _ -> pure x

87+and return it to the pool afterwards.

98− PoolPQ f <*> PoolPQ x = PoolPQ $ \ pool -> do

88+

99− f' <- f pool

89+If the pool has an idle connection available, it is used immediately.

100− x' <- x pool

90+Otherwise, if the maximum number of connections has not yet been reached,

101− return $ f' x'

91+a new connection is created and used.

102−

92+If the maximum number of connections has been reached, this function blocks

103−-- | `Monad` instance for `PoolPQ`.

93+until a connection becomes available.

104−instance Monad m => Monad (PoolPQ schemas m) where

94+-}

105− return = pure

95+usingConnectionPool

106− PoolPQ x >>= f = PoolPQ $ \ pool -> do

96+ :: MonadUnliftIO io

107− x' <- x pool

97+ => Pool (K Connection schemas) -- ^ pool

108− runPoolPQ (f x') pool

98+ -> PQ schemas schemas io x -- ^ session

109−

99+ -> io x

110−-- | `Fail.MonadFail` instance for `PoolPQ`.

100+usingConnectionPool pool (PQ session) = unK <$> withResource pool session

111−instance Monad m => Fail.MonadFail (PoolPQ schemas m) where

101+

112− fail = Fail.fail

102+{- |

113−

103+Destroy all connections in all stripes in the pool.

114−-- | `MonadTrans` instance for `PoolPQ`.

104+Note that this will ignore any exceptions in the destroy function.

115−instance MonadTrans (PoolPQ schemas) where

105+

116− lift m = PoolPQ $ \ _pool -> m

106+This function is useful when you detect that all connections

117−

107+in the pool are broken. For example after a database has been

118−-- | `MonadPQ` instance for `PoolPQ`.

108+restarted all connections opened before the restart will be broken.

119−instance MonadUnliftIO io => MonadPQ schemas (PoolPQ schemas io) where

109+In that case it's better to close those connections so that

120− manipulateParams manipulation params = PoolPQ $ \ pool -> do

110+`usingConnectionPool` won't take a broken connection from the pool

121− withResource pool $ \ conn -> do

111+but will open a new connection instead.

122− (K result :: K (K Result ys) schemas) <- flip unPQ conn $

112+

123− manipulateParams manipulation params

113+Another use-case for this function is that when you know you are done

124− return result

114+with the pool you can destroy all idle connections immediately

125− traversePrepared manipulation params = PoolPQ $ \ pool ->

115+instead of waiting on the garbage collector to destroy them,

126− withResource pool $ \ conn -> do

116+thus freeing up those connections sooner.

127− (K result :: K (list (K Result ys)) schemas) <- flip unPQ conn $

117+-}

128− traversePrepared manipulation params

118+destroyConnectionPool

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)

119+ :: MonadUnliftIO io

148− => MonadUnliftIO (PoolPQ schemas m) where

120+ => Pool (K Connection schemas) -- ^ pool

149− withRunInIO

121+ -> io ()

150− :: ((forall a . PoolPQ schemas m a -> IO a) -> IO b)

122+destroyConnectionPool = destroyAllResources

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)

squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+253−370

@@ -1,7 +1,7 @@

1{-|

2Module: Squeal.PostgreSQL.Query

3Description: Squeal queries

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

@@ -32,13 +32,15 @@ Squeal queries.

33module Squeal.PostgreSQL.Query

34 ( -- * Queries

35+ Query_

35− Query (..)

36+ , Query (..)

36− , Query_

37 -- ** Select

38 , select

39 , select_

40 , selectDistinct

41 , selectDistinct_

42+ , selectDistinctOn

43+ , selectDistinctOn_

42 , Selection (..)

44 , Selection (..)

43 -- ** Values

45 -- ** Values

44 , values

46 , values

@@ -53,23 +55,7 @@ module Squeal.PostgreSQL.Query

53 -- ** With

55 -- ** With

54 , With (..)

56 , With (..)

55 , CommonTableExpression (..)

57 , CommonTableExpression (..)

56− -- ** Unnest

58+ , withRecursive

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

73 -- * Table Expressions

59 -- * Table Expressions

74 , TableExpression (..)

60 , TableExpression (..)

75 , from

61 , from

@@ -93,13 +79,6 @@ module Squeal.PostgreSQL.Query

93 , By (..)

79 , By (..)

94 , GroupByClause (..)

80 , GroupByClause (..)

95 , HavingClause (..)

81 , HavingClause (..)

96− -- * Subquery Expressions

97− , exists

98− , in_

99− , notIn

100− , Operator

101− , subAll

102− , subAny

103 ) where

82 ) where

104

105import Control.DeepSeq

84import Control.DeepSeq

@@ -114,14 +93,65 @@ import qualified GHC.Generics as GHC

114

115import Squeal.PostgreSQL.Alias

94import Squeal.PostgreSQL.Alias

116import Squeal.PostgreSQL.Expression

95import Squeal.PostgreSQL.Expression

96+import Squeal.PostgreSQL.Expression.Logic

97+import Squeal.PostgreSQL.Expression.Sort

98+import Squeal.PostgreSQL.Expression.Window

117import Squeal.PostgreSQL.List

99import Squeal.PostgreSQL.List

118import Squeal.PostgreSQL.PG

100import Squeal.PostgreSQL.PG

119import Squeal.PostgreSQL.Render

101import Squeal.PostgreSQL.Render

120import Squeal.PostgreSQL.Schema

102import Squeal.PostgreSQL.Schema

121

103

104+-- $setup

105+-- >>> 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

110+

111+{- |

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+

122{- |

133{- |

123−The process of retrieving or the command to retrieve data from a database

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+

124−is called a `Query`. Let's see some examples of queries.

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+:}

125

155

126simple query:

156simple query:

127

157

@@ -129,7 +159,7 @@ simple query:

129>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

159>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

130>>> :{

160>>> :{

131let

161let

132− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

162+ query :: Query_ (Public Schema) () (Row Int32 Int32)

133 query = select Star (from (table #tab))

163 query = select Star (from (table #tab))

134in printSQL query

164in printSQL query

135:}

165:}

@@ -139,21 +169,21 @@ restricted query:

139

169

140>>> :{

170>>> :{

141let

171let

142− query :: Query '[] '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4]

172+ query :: Query_ (Public Schema) () (Row Int32 Int32)

143 query =

173 query =

144− select_ ((#col1 + #col2) `as` #sum :* #col1)

174+ select_ ((#col1 + #col2) `as` #col1 :* #col1 `as` #col2)

145 ( from (table #tab)

175 ( from (table #tab)

146 & where_ (#col1 .> #col2)

176 & where_ (#col1 .> #col2)

147 & where_ (#col2 .> 0) )

177 & where_ (#col2 .> 0) )

148in printSQL query

178in printSQL query

149:}

179:}

150−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))

151

181

152subquery:

182subquery:

153

183

154>>> :{

184>>> :{

155let

185let

156− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

186+ query :: Query_ (Public Schema) () (Row Int32 Int32)

157 query = select Star (from (subquery (select Star (from (table #tab)) `as` #sub)))

187 query = select Star (from (subquery (select Star (from (table #tab)) `as` #sub)))

158in printSQL query

188in printSQL query

159:}

189:}

@@ -163,7 +193,7 @@ limits and offsets:

163

193

164>>> :{

194>>> :{

165let

195let

166− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

196+ query :: Query_ (Public Schema) () (Row Int32 Int32)

167 query = select Star (from (table #tab) & limit 100 & offset 2 & limit 50 & offset 2)

197 query = select Star (from (table #tab) & limit 100 & offset 2 & limit 50 & offset 2)

168in printSQL query

198in printSQL query

169:}

199:}

@@ -173,7 +203,7 @@ parameterized query:

173

203

174>>> :{

204>>> :{

175let

205let

176− query :: Query '[] '[] (Public Schema) '[ 'NotNull 'PGint4] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

206+ query :: Query_ (Public Schema) (Only Int32) (Row Int32 Int32)

177 query = select Star (from (table #tab) & where_ (#col1 .> param @1))

207 query = select Star (from (table #tab) & where_ (#col1 .> param @1))

178in printSQL query

208in printSQL query

179:}

209:}

@@ -183,21 +213,21 @@ aggregation query:

183

213

184>>> :{

214>>> :{

185let

215let

186− query :: Query '[] '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4 ]

216+ query :: Query_ (Public Schema) () (Row Int64 Int32)

187 query =

217 query =

188− select_ (sum_ (All #col2) `as` #sum :* #col1)

218+ select_ ((fromNull 0 (sum_ (All #col2))) `as` #col1 :* #col1 `as` #col2)

189 ( from (table (#tab `as` #table1))

219 ( from (table (#tab `as` #table1))

190 & groupBy #col1

220 & groupBy #col1

191− & having (#col1 + sum_ (Distinct #col2) .> 1) )

221+ & having (sum_ (Distinct #col2) .> 1) )

192in printSQL query

222in printSQL query

193:}

223:}

194−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)

195

225

196sorted query:

226sorted query:

197

227

198>>> :{

228>>> :{

199let

229let

200− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

230+ query :: Query_ (Public Schema) () (Row Int32 Int32)

201 query = select Star (from (table #tab) & orderBy [#col1 & Asc])

231 query = select Star (from (table #tab) & orderBy [#col1 & Asc])

202in printSQL query

232in printSQL query

203:}

233:}

@@ -205,14 +235,12 @@ SELECT * FROM "tab" AS "tab" ORDER BY "col1" ASC

205

235

206joins:

236joins:

207

237

208−>>> :set -XFlexibleContexts

209>>> :{

238>>> :{

210type OrdersColumns =

239type OrdersColumns =

211 '[ "id" ::: 'NoDef :=> 'NotNull 'PGint4

240 '[ "id" ::: 'NoDef :=> 'NotNull 'PGint4

212− , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

241+ , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

213− , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

242+ , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

214− , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4

243+ , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4 ]

215− ]

216:}

244:}

217

245

218>>> :{

246>>> :{

@@ -228,22 +256,27 @@ type OrdersConstraints =

228>>> :{

256>>> :{

229type OrdersSchema =

257type OrdersSchema =

230 '[ "orders" ::: 'Table (OrdersConstraints :=> OrdersColumns)

258 '[ "orders" ::: 'Table (OrdersConstraints :=> OrdersColumns)

231− , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

259+ , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

232− , "shippers" ::: 'Table (ShippersConstraints :=> 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

233:}

271:}

234

272

235>>> :{

273>>> :{

236let

274let

237− query :: Query '[] '[] (Public OrdersSchema)

275+ query :: Query_ (Public OrdersSchema) () Order

238− '[]

239− '[ "order_price" ::: 'NotNull 'PGfloat4

240− , "customer_name" ::: 'NotNull 'PGtext

241− , "shipper_name" ::: 'NotNull 'PGtext

242− ]

243 query = select_

276 query = select_

244− ( #o ! #price `as` #order_price :*

277+ ( #o ! #price `as` #price :*

245− #c ! #name `as` #customer_name :*

278+ #c ! #name `as` #customerName :*

246− #s ! #name `as` #shipper_name )

279+ #s ! #name `as` #shipperName )

247 ( from (table (#orders `as` #o)

280 ( from (table (#orders `as` #o)

248 & innerJoin (table (#customers `as` #c))

281 & innerJoin (table (#customers `as` #c))

249 (#o ! #customer_id .== #c ! #id)

282 (#o ! #customer_id .== #c ! #id)

@@ -251,14 +284,16 @@ let

251 (#o ! #shipper_id .== #s ! #id)) )

284 (#o ! #shipper_id .== #s ! #id)) )

252in printSQL query

285in printSQL query

253:}

286:}

254−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")

255

288

256self-join:

289self-join:

257

290

258>>> :{

291>>> :{

259let

292let

260− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

293+ query :: Query_ (Public Schema) () (Row Int32 Int32)

294+ query = select

295+ (#t1 & DotStar)

261− query = select (#t1 & DotStar) (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

296+ (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

262in printSQL query

297in printSQL query

263:}

298:}

264SELECT "t1".* FROM "tab" AS "t1" CROSS JOIN "tab" AS "t2"

299SELECT "t1".* FROM "tab" AS "t1" CROSS JOIN "tab" AS "t2"

@@ -267,17 +302,19 @@ value queries:

267

302

268>>> :{

303>>> :{

269let

304let

270− query :: Query '[] commons schemas '[] '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

305+ query :: Query_ schemas () (Row String Bool)

271− query = values (1 `as` #foo :* true `as` #bar) [2 `as` #foo :* false `as` #bar]

306+ query = values

307+ ("true" `as` #col1 :* true `as` #col2)

308+ ["false" `as` #col1 :* false `as` #col2]

272in printSQL query

309in printSQL query

273:}

310:}

274−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")

275

312

276set operations:

313set operations:

277

314

278>>> :{

315>>> :{

279let

316let

280− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

317+ query :: Query_ (Public Schema) () (Row Int32 Int32)

281 query = select Star (from (table #tab)) `unionAll` select Star (from (table #tab))

318 query = select Star (from (table #tab)) `unionAll` select Star (from (table #tab))

282in printSQL query

319in printSQL query

283:}

320:}

@@ -287,7 +324,7 @@ with queries:

287

324

288>>> :{

325>>> :{

289let

326let

290− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

327+ query :: Query_ (Public Schema) () (Row Int32 Int32)

291 query = with (

328 query = with (

292 select Star (from (table #tab)) `as` #cte1 :>>

329 select Star (from (table #tab)) `as` #cte1 :>>

293 select Star (from (common #cte1)) `as` #cte2

330 select Star (from (common #cte1)) `as` #cte2

@@ -300,40 +337,35 @@ window function queries

300

337

301>>> :{

338>>> :{

302let

339let

303− query :: Query '[] '[] (Public Schema) '[] ["col1" ::: 'NotNull 'PGint4, "rank" ::: 'NotNull 'PGint8]

340+ query :: Query_ (Public Schema) () (Row Int32 Int64)

304 query = select

341 query = select

305− (#col1 & Also (rank `as` #rank `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))

342+ (#col1 & Also (rank `as` #col2 `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))

306 (from (table #tab))

343 (from (table #tab))

307in printSQL query

344in printSQL query

308:}

345:}

309−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"

310

347

311correlated subqueries

348correlated subqueries

312

349

313>>> :{

350>>> :{

314let

351let

315− query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4]

352+ query :: Query_ (Public Schema) () (Only Int32)

316 query =

353 query =

317− select #col1 (from (table (#tab `as` #t1))

354+ select (#col1 `as` #fromOnly) (from (table (#tab `as` #t1))

318 & where_ (exists (

355 & where_ (exists (

319 select Star (from (table (#tab `as` #t2))

356 select Star (from (table (#tab `as` #t2))

320 & where_ (#t2 ! #col2 .== #t1 ! #col1)))))

357 & where_ (#t2 ! #col2 .== #t1 ! #col1)))))

321in printSQL query

358in printSQL query

322:}

359:}

323−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+

324-}

362-}

325−newtype Query

363+type family Query_

326− (outer :: FromType)

327− (commons :: FromType)

328 (schemas :: SchemasType)

364 (schemas :: SchemasType)

329− (params :: [NullityType])

365+ (parameters :: Type)

330− (row :: RowType)

366+ (row :: Type) where

331− = UnsafeQuery { renderQuery :: ByteString }

367+ Query_ schemas params row =

332− deriving (GHC.Generic,Show,Eq,Ord,NFData)

333−instance RenderSQL (Query outer commons schemas params row) where renderSQL = renderQuery

334−

335−type family Query_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

336− Query_ schemas params row = Query '[] '[] schemas (TuplePG params) (RowPG row)

368+ Query '[] '[] schemas (TuplePG params) (RowPG row)

337

369

338-- | The results of two queries can be combined using the set operation

370-- | The results of two queries can be combined using the set operation

339-- `union`. Duplicate rows are eliminated.

371-- `union`. Duplicate rows are eliminated.

@@ -405,27 +437,40 @@ q1 `exceptAll` q2 = UnsafeQuery $

405SELECT queries

437SELECT queries

406-----------------------------------------}

438-----------------------------------------}

407

439

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+-}

408data Selection outer commons grp schemas params from row where

446data Selection outer commons grp schemas params from row where

409− List

410− :: SListI row

411− => NP (Aliased (Expression outer commons grp schemas params from)) row

412− -> Selection outer commons grp schemas params from row

413 Star

447 Star

414 :: HasUnique tab from row

448 :: HasUnique tab from row

415 => Selection outer commons 'Ungrouped schemas params from row

449 => Selection outer commons 'Ungrouped schemas params from row

450+ -- ^ `HasUnique` table in the `FromClause`

416 DotStar

451 DotStar

417 :: Has tab from row

452 :: Has tab from row

418 => Alias tab

453 => Alias tab

454+ -- ^ `Has` table with `Alias`

419 -> Selection outer commons 'Ungrouped schemas params from row

455 -> Selection outer commons 'Ungrouped schemas params from row

420− Also

456+ List

457+ :: SListI row

421− :: Selection outer commons grp schemas params from right

458+ => NP (Aliased (Expression outer commons grp schemas params from)) row

422− -> Selection outer commons grp schemas params from left

459+ -- ^ `NP` list of `Aliased` `Expression`s

423− -> Selection outer commons grp schemas params from (Join left right)

460+ -> Selection outer commons grp schemas params from row

424 Over

461 Over

425 :: SListI row

462 :: SListI row

426 => NP (Aliased (WindowFunction outer commons grp schemas params from)) row

463 => NP (Aliased (WindowFunction outer commons grp schemas params from)) row

464+ -- ^ `NP` list of `Aliased` `WindowFunction`s

427 -> WindowDefinition outer commons grp schemas params from

465 -> WindowDefinition outer commons grp schemas params from

428 -> Selection outer commons grp schemas params from row

466 -> 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

429instance (KnownSymbol col, row ~ '[col ::: ty])

474instance (KnownSymbol col, row ~ '[col ::: ty])

430 => Aliasable col

475 => Aliasable col

431 (Expression outer commons grp schemas params from ty)

476 (Expression outer commons grp schemas params from ty)

@@ -485,7 +530,7 @@ instance IsString

485select

530select

486 :: (SListI row, row ~ (x ': xs))

531 :: (SListI row, row ~ (x ': xs))

487 => Selection outer commons grp schemas params from row

532 => Selection outer commons grp schemas params from row

488− -- ^ select list

533+ -- ^ selection

489 -> TableExpression outer commons grp schemas params from

534 -> TableExpression outer commons grp schemas params from

490 -- ^ intermediate virtual table

535 -- ^ intermediate virtual table

491 -> Query outer commons schemas params row

536 -> Query outer commons schemas params row

@@ -494,20 +539,24 @@ select selection tabexpr = UnsafeQuery $

494 <+> renderSQL selection

539 <+> renderSQL selection

495 <+> renderSQL tabexpr

540 <+> renderSQL tabexpr

496

541

542+-- | Like `select` but takes an `NP` list of `Expression`s instead

543+-- of a general `Selection`.

497select_

544select_

498 :: (SListI row, row ~ (x ': xs))

545 :: (SListI row, row ~ (x ': xs))

499 => NP (Aliased (Expression outer commons grp schemas params from)) row

546 => NP (Aliased (Expression outer commons grp schemas params from)) row

547+ -- ^ select list

500 -> TableExpression outer commons grp schemas params from

548 -> TableExpression outer commons grp schemas params from

549+ -- ^ intermediate virtual table

501 -> Query outer commons schemas params row

550 -> Query outer commons schemas params row

502−select_ list = select (List list)

551+select_ = select . List

503

552

504-- | After the select list has been processed, the result table can

553-- | After the select list has been processed, the result table can

505-- be subject to the elimination of duplicate rows using `selectDistinct`.

554-- be subject to the elimination of duplicate rows using `selectDistinct`.

506selectDistinct

555selectDistinct

507 :: (SListI columns, columns ~ (col ': cols))

556 :: (SListI columns, columns ~ (col ': cols))

508− => Selection outer commons 'Ungrouped schemas params from columns

557+ => Selection outer commons grp schemas params from columns

509− -- ^ select list

558+ -- ^ selection

510− -> TableExpression outer commons 'Ungrouped schemas params from

559+ -> TableExpression outer commons grp schemas params from

511 -- ^ intermediate virtual table

560 -- ^ intermediate virtual table

512 -> Query outer commons schemas params columns

561 -> Query outer commons schemas params columns

513selectDistinct selection tabexpr = UnsafeQuery $

562selectDistinct selection tabexpr = UnsafeQuery $

@@ -515,14 +564,65 @@ selectDistinct selection tabexpr = UnsafeQuery $

515 <+> renderSQL selection

564 <+> renderSQL selection

516 <+> renderSQL tabexpr

565 <+> renderSQL tabexpr

517

566

567+-- | Like `selectDistinct` but takes an `NP` list of `Expression`s instead

568+-- of a general `Selection`.

518selectDistinct_

569selectDistinct_

519 :: (SListI columns, columns ~ (col ': cols))

570 :: (SListI columns, columns ~ (col ': cols))

520− => NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns

571+ => NP (Aliased (Expression outer commons grp schemas params from)) columns

521 -- ^ select list

572 -- ^ select list

522− -> TableExpression outer commons 'Ungrouped schemas params from

573+ -> TableExpression outer commons grp schemas params from

523 -- ^ intermediate virtual table

574 -- ^ intermediate virtual table

524 -> Query outer commons schemas params columns

575 -> Query outer commons schemas params columns

525−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

526

626

527-- | `values` computes a row value or set of row values

627-- | `values` computes a row value or set of row values

528-- specified by value expressions. It is most commonly used

628-- specified by value expressions. It is most commonly used

@@ -657,7 +757,7 @@ instance RenderSQL (TableExpression outer commons grp schemas params from) where

657from

757from

658 :: FromClause outer commons schemas params from -- ^ table reference

758 :: FromClause outer commons schemas params from -- ^ table reference

659 -> TableExpression outer commons 'Ungrouped schemas params from

759 -> TableExpression outer commons 'Ungrouped schemas params from

660−from tab = TableExpression tab [] NoGroups NoHaving [] [] []

760+from tab = TableExpression tab [] noGroups NoHaving [] [] []

661

761

662-- | A `where_` is an endomorphism of `TableExpression`s which adds a

762-- | A `where_` is an endomorphism of `TableExpression`s which adds a

663-- search condition to the `whereClause`.

763-- search condition to the `whereClause`.

@@ -678,7 +778,7 @@ groupBy

678groupBy bys rels = TableExpression

778groupBy bys rels = TableExpression

679 { fromClause = fromClause rels

779 { fromClause = fromClause rels

680 , whereClause = whereClause rels

780 , whereClause = whereClause rels

681− , groupByClause = Group bys

781+ , groupByClause = group bys

682 , havingClause = Having []

782 , havingClause = Having []

683 , orderByClause = []

783 , orderByClause = []

684 , limitClause = limitClause rels

784 , limitClause = limitClause rels

@@ -713,170 +813,6 @@ offset

713 -> TableExpression outer commons grp schemas params from

813 -> TableExpression outer commons grp schemas params from

714offset off rels = rels {offsetClause = off : offsetClause rels}

814offset off rels = rels {offsetClause = off : offsetClause rels}

715

815

716−{-----------------------------------------

717−JSON stuff

718−-----------------------------------------}

719−

720−unsafeSetOfFunction

721− :: ByteString

722− -> Expression outer commons 'Ungrouped schemas params '[] ty

723− -> FromClause outer commons schemas params from

724−unsafeSetOfFunction fun expr = UnsafeFromClause $

725− fun <> "(" <> renderSQL expr <> ")"

726−

727−-- | Expand an array to a set of rows

728−unnest

729− :: Expression outer commons 'Ungrouped schemas params '[] (nullity ('PGvararray ty))

730− -> FromClause outer commons schemas params '["unnest" ::: '["unnest" ::: ty]]

731−unnest = unsafeSetOfFunction "unnest"

732−

733−-- | Expands the outermost JSON object into a set of key/value pairs.

734−-- >>> import Data.Aeson

735−-- >>> printSQL (select Star (from (jsonEach (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))

736−-- SELECT * FROM json_each(('{"a":"foo","b":"bar"}' :: json))

737−jsonEach

738− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

739− -> FromClause outer commons schemas params

740− '["json_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]]

741−jsonEach = unsafeSetOfFunction "json_each"

742−

743−-- | Expands the outermost binary JSON object into a set of key/value pairs.

744−-- >>> import Data.Aeson

745−-- >>> printSQL (select Star (from (jsonbEach (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))

746−-- SELECT * FROM jsonb_each(('{"a":"foo","b":"bar"}' :: jsonb))

747−jsonbEach

748− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

749− -> FromClause outer commons schemas params

750− '["jsonb_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]]

751−jsonbEach = unsafeSetOfFunction "jsonb_each"

752−

753−-- | 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.

754−-- >>> import Data.Aeson

755−-- >>> printSQL (select Star (from (jsonEachText (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))

756−-- SELECT * FROM json_each_text(('{"a":"foo","b":"bar"}' :: json))

757−jsonEachText

758− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

759− -> FromClause outer commons schemas params

760− '["json_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]]

761−jsonEachText = unsafeSetOfFunction "json_each_text"

762−

763−-- | Expands the outermost binary JSON object into a set of key/value pairs.

764−-- >>> import Data.Aeson

765−-- >>> printSQL (select Star (from (jsonbEachText (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))

766−-- SELECT * FROM jsonb_each_text(('{"a":"foo","b":"bar"}' :: jsonb))

767−jsonbEachText

768− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

769− -> FromClause outer commons schemas params

770− '["jsonb_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]]

771−jsonbEachText = unsafeSetOfFunction "jsonb_each_text"

772−

773−-- | Returns set of keys in the outermost JSON object.

774−-- >>> import Data.Aeson

775−-- >>> printSQL (jsonObjectKeys (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))

776−-- json_object_keys(('{"a":"foo","b":"bar"}' :: json))

777−jsonObjectKeys

778− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

779− -> FromClause outer commons schemas params

780− '["json_object_keys" ::: '["json_object_keys" ::: 'NotNull 'PGtext]]

781−jsonObjectKeys = unsafeSetOfFunction "json_object_keys"

782−

783−-- | Returns set of keys in the outermost JSON object.

784−-- >>> import Data.Aeson

785−-- >>> printSQL (jsonbObjectKeys (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))

786−-- jsonb_object_keys(('{"a":"foo","b":"bar"}' :: jsonb))

787−jsonbObjectKeys

788− :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

789− -> FromClause outer commons schemas params

790− '["jsonb_object_keys" ::: '["jsonb_object_keys" ::: 'NotNull 'PGtext]]

791−jsonbObjectKeys = unsafeSetOfFunction "jsonb_object_keys"

792−

793−unsafePopulateFunction

794− :: KnownSymbol fun

795− => Alias fun

796− -> TypeExpression schemas (nullity ('PGcomposite row))

797− -> Expression outer commons 'Ungrouped schemas params '[] ty

798− -> FromClause outer commons schemas params '[fun ::: row]

799−unsafePopulateFunction fun ty expr = UnsafeFromClause $ renderSQL fun

800− <> parenthesized ("null::" <> renderSQL ty <> ", " <> renderSQL expr)

801−

802−-- | Expands the JSON expression to a row whose columns match the record

803−-- type defined by the given table.

804−jsonPopulateRecord

805− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

806− -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

807− -> FromClause outer commons schemas params '["json_populate_record" ::: row]

808−jsonPopulateRecord = unsafePopulateFunction #json_populate_record

809−

810−-- | Expands the binary JSON expression to a row whose columns match the record

811−-- type defined by the given table.

812−jsonbPopulateRecord

813− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

814− -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

815− -> FromClause outer commons schemas params '["jsonb_populate_record" ::: row]

816−jsonbPopulateRecord = unsafePopulateFunction #jsonb_populate_record

817−

818−-- | Expands the outermost array of objects in the given JSON expression to a

819−-- set of rows whose columns match the record type defined by the given table.

820−jsonPopulateRecordSet

821− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

822− -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json array

823− -> FromClause outer commons schemas params '["json_populate_record_set" ::: row]

824−jsonPopulateRecordSet = unsafePopulateFunction #json_populate_record_set

825−

826−-- | Expands the outermost array of objects in the given binary JSON expression

827−-- to a set of rows whose columns match the record type defined by the given

828−-- table.

829−jsonbPopulateRecordSet

830− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

831− -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb array

832− -> FromClause outer commons schemas params '["jsonb_populate_record_set" ::: row]

833−jsonbPopulateRecordSet = unsafePopulateFunction #jsonb_populate_record_set

834−

835−unsafeRecordFunction

836− :: (SListI record, json `In` PGJsonType)

837− => ByteString

838− -> Expression outer commons 'Ungrouped schemas params '[] (nullity json)

839− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

840− -> FromClause outer commons schemas params '[tab ::: record]

841−unsafeRecordFunction fun expr (types `As` tab) = UnsafeFromClause $

842− fun <> parenthesized (renderSQL expr) <+> "AS" <+> renderSQL tab

843− <> parenthesized (renderCommaSeparated renderTy types)

844− where

845− renderTy :: Aliased (TypeExpression schemas) ty -> ByteString

846− renderTy (ty `As` alias) = renderSQL alias <+> renderSQL ty

847−

848−-- | Builds an arbitrary record from a JSON object.

849−jsonToRecord

850− :: SListI record

851− => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

852− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

853− -> FromClause outer commons schemas params '[tab ::: record]

854−jsonToRecord = unsafeRecordFunction "json_to_record"

855−

856−-- | Builds an arbitrary record from a binary JSON object.

857−jsonbToRecord

858− :: SListI record

859− => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

860− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

861− -> FromClause outer commons schemas params '[tab ::: record]

862−jsonbToRecord = unsafeRecordFunction "jsonb_to_record"

863−

864−-- | Builds an arbitrary set of records from a JSON array of objects.

865−jsonToRecordSet

866− :: SListI record

867− => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json array

868− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

869− -> FromClause outer commons schemas params '[tab ::: record]

870−jsonToRecordSet = unsafeRecordFunction "json_to_record_set"

871−

872−-- | Builds an arbitrary set of records from a binary JSON array of objects.

873−jsonbToRecordSet

874− :: SListI record

875− => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb array

876− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

877− -> FromClause outer commons schemas params '[tab ::: record]

878−jsonbToRecordSet = unsafeRecordFunction "jsonb_to_record_set"

879−

880{-----------------------------------------

816{-----------------------------------------

881FROM clauses

817FROM clauses

882-----------------------------------------}

818-----------------------------------------}

@@ -903,7 +839,7 @@ table (tab `As` alias) = UnsafeFromClause $

903subquery

839subquery

904 :: Aliased (Query outer commons schemas params) query

840 :: Aliased (Query outer commons schemas params) query

905 -> FromClause outer commons schemas params '[query]

841 -> FromClause outer commons schemas params '[query]

906−subquery = UnsafeFromClause . renderAliased (parenthesized . renderQuery)

842+subquery = UnsafeFromClause . renderAliased (parenthesized . renderSQL)

907

843

908-- | `view` derives a table from a `View`.

844-- | `view` derives a table from a `View`.

909view

845view

@@ -921,11 +857,16 @@ common

921common (cte `As` alias) = UnsafeFromClause $

857common (cte `As` alias) = UnsafeFromClause $

922 renderSQL cte <+> "AS" <+> renderSQL alias

858 renderSQL cte <+> "AS" <+> renderSQL alias

923

859

860+instance Additional (FromClause outer commons schemas params) where

861+ also right left = UnsafeFromClause $

862+ renderSQL left <> ", " <> renderSQL right

863+

864+{- |

924−{- | @left & crossJoin right@. For every possible combination of rows from

865+@left & crossJoin right@. For every possible combination of rows from

925− @left@ and @right@ (i.e., a Cartesian product), the joined table will contain

866+@left@ and @right@ (i.e., a Cartesian product), the joined table will contain

926− a row consisting of all columns in @left@ followed by all columns in @right@.

867+a row consisting of all columns in @left@ followed by all columns in @right@.

927− If the tables have @n@ and @m@ rows respectively, the joined table will

868+If the tables have @n@ and @m@ rows respectively, the joined table will

928− have @n * m@ rows.

869+have @n * m@ rows.

929-}

870-}

930crossJoin

871crossJoin

931 :: FromClause outer commons schemas params right

872 :: FromClause outer commons schemas params right

@@ -1051,19 +992,20 @@ instance (Has rel rels cols, Has col cols ty, bys ~ '[ '(rel, col)])

1051-- done on @NoGroups@ while all output `Expression`s must be aggregated

992-- done on @NoGroups@ while all output `Expression`s must be aggregated

1052-- in @Group Nil@. In general, all output `Expression`s in the

993-- in @Group Nil@. In general, all output `Expression`s in the

1053-- complement of @bys@ must be aggregated in @Group bys@.

994-- complement of @bys@ must be aggregated in @Group bys@.

1054−data GroupByClause grp from where

995+newtype GroupByClause grp from = UnsafeGroupByClause

1055− NoGroups :: GroupByClause 'Ungrouped from

996+ { renderGroupByClause :: ByteString }

1056− Group

997+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

1057− :: SListI bys

1058− => NP (By from) bys

1059− -> GroupByClause ('Grouped bys) from

1060−

1061−-- | Renders a `GroupByClause`.

1062instance RenderSQL (GroupByClause grp from) where

998instance RenderSQL (GroupByClause grp from) where

1063− renderSQL = \case

999+ renderSQL = renderGroupByClause

1064− NoGroups -> ""

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

1065− Group Nil -> ""

1007+ Nil -> ""

1066− Group bys -> " GROUP BY" <+> renderCommaSeparated renderSQL bys

1008+ bys' -> " GROUP BY" <+> renderCommaSeparated renderSQL bys'

1067

1009

1068-- | A `HavingClause` is used to eliminate groups that are not of interest.

1010-- | A `HavingClause` is used to eliminate groups that are not of interest.

1069-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`

1011-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`

@@ -1086,90 +1028,6 @@ instance RenderSQL (HavingClause outer commons grp schemas params from) where

1086 Having conditions ->

1028 Having conditions ->

1087 " HAVING" <+> commaSeparated (renderSQL <$> conditions)

1029 " HAVING" <+> commaSeparated (renderSQL <$> conditions)

1088

1030

1089−{- |

1090−The argument of `exists` is an arbitrary subquery. The subquery is evaluated

1091−to determine whether it returns any rows. If it returns at least one row,

1092−the result of `exists` is `true`; if the subquery returns no rows,

1093−the result of `exists` is `false`.

1094−

1095−The subquery can refer to variables from the surrounding query,

1096−which will act as constants during any one evaluation of the subquery.

1097−

1098−The subquery will generally only be executed long enough to determine whether

1099−at least one row is returned, not all the way to completion.

1100−-}

1101−exists

1102− :: Query (Join outer from) commons schemas params row

1103− -> Condition outer commons grp schemas params from

1104−exists query = UnsafeExpression $ "EXISTS" <+> parenthesized (renderSQL query)

1105−

1106−{- |

1107−The right-hand side is a parenthesized subquery, which must return

1108−exactly one column. The left-hand expression is evaluated and compared to each

1109−row of the subquery result using the given `Operator`,

1110−which must yield a Boolean result. The result of `subAll` is `true`

1111−if all rows yield true (including the case where the subquery returns no rows).

1112−The result is `false` if any `false` result is found.

1113−The result is `null_` if no comparison with a subquery row returns `false`,

1114−and at least one comparison returns `null_`.

1115−

1116−>>> printSQL $ subAll true (.==) (values_ (true `as` #foo))

1117−(TRUE = ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo")))

1118−-}

1119−subAll

1120− :: Expression outer commons grp schemas params from ty1 -- ^ expression

1121− -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator

1122− -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery

1123− -> Condition outer commons grp schemas params from

1124−subAll expr (?) qry = expr ?

1125− (UnsafeExpression $ "ALL" <+> parenthesized (renderSQL qry))

1126−

1127−{- |

1128−The right-hand side is a parenthesized subquery, which must return exactly one column.

1129−The left-hand expression is evaluated and compared to each row of the subquery result

1130−using the given `Operator`, which must yield a Boolean result. The result of `subAny` is `true`

1131−if any `true` result is obtained. The result is `false` if no true result is found

1132−(including the case where the subquery returns no rows).

1133−

1134−>>> printSQL $ subAll "foo" like (values_ ("foobar" `as` #foo))

1135−(E'foo' LIKE ALL (SELECT * FROM (VALUES (E'foobar')) AS t ("foo")))

1136−-}

1137−subAny

1138− :: Expression outer commons grp schemas params from ty1 -- ^ expression

1139− -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator

1140− -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery

1141− -> Condition outer commons grp schemas params from

1142−subAny expr (?) qry = expr ?

1143− (UnsafeExpression $ "ANY" <+> parenthesized (renderSQL qry))

1144−

1145−{- |

1146−The result is `true` if the left-hand expression's result is equal

1147−to any of the right-hand expressions.

1148−

1149−>>> printSQL $ true `in_` [true, false, null_]

1150−TRUE IN (TRUE, FALSE, NULL)

1151−-}

1152−in_

1153− :: Expression outer commons grp schemas params from ty -- ^ expression

1154− -> [Expression outer commons grp schemas params from ty]

1155− -> Condition outer commons grp schemas params from

1156−expr `in_` exprs = UnsafeExpression $ renderSQL expr <+> "IN"

1157− <+> parenthesized (commaSeparated (renderSQL <$> exprs))

1158−

1159−{- |

1160−The result is `true` if the left-hand expression's result is not equal

1161−to any of the right-hand expressions.

1162−

1163−>>> printSQL $ true `notIn` [false, null_]

1164−TRUE NOT IN (FALSE, NULL)

1165−-}

1166−notIn

1167− :: Expression outer commons grp schemas params from ty -- ^ expression

1168− -> [Expression outer commons grp schemas params from ty]

1169− -> Condition outer commons grp schemas params from

1170−expr `notIn` exprs = UnsafeExpression $ renderSQL expr <+> "NOT IN"

1171− <+> parenthesized (commaSeparated (renderSQL <$> exprs))

1172−

1173-- | A `CommonTableExpression` is an auxiliary statement in a `with` clause.

1031-- | A `CommonTableExpression` is an auxiliary statement in a `with` clause.

1174data CommonTableExpression statement

1032data CommonTableExpression statement

1175 (schemas :: SchemasType)

1033 (schemas :: SchemasType)

@@ -1191,8 +1049,8 @@ instance

1191 , commons1 ~ (cte ::: common ': commons)

1049 , commons1 ~ (cte ::: common ': commons)

1192 ) => Aliasable cte

1050 ) => Aliasable cte

1193 (statement commons schemas params common)

1051 (statement commons schemas params common)

1194− (AlignedList (CommonTableExpression statement schemas params) commons commons1) where

1052+ (Path (CommonTableExpression statement schemas params) commons commons1) where

1195− statement `as` cte = single (statement `as` cte)

1053+ statement `as` cte = csingleton (statement `as` cte)

1196

1054

1197instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

1055instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

1198 (CommonTableExpression statement schemas params commons0 commons1) where

1056 (CommonTableExpression statement schemas params commons0 commons1) where

@@ -1204,7 +1062,7 @@ instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

1204-- defining temporary tables that exist just for one query.

1062-- defining temporary tables that exist just for one query.

1205class With statement where

1063class With statement where

1206 with

1064 with

1207− :: AlignedList (CommonTableExpression statement schemas params) commons0 commons1

1065+ :: Path (CommonTableExpression statement schemas params) commons0 commons1

1208 -- ^ common table expressions

1066 -- ^ common table expressions

1209 -> statement commons1 schemas params row

1067 -> statement commons1 schemas params row

1210 -- ^ larger query

1068 -- ^ larger query

@@ -1212,4 +1070,29 @@ class With statement where

1212instance With (Query outer) where

1070instance With (Query outer) where

1213 with Done query = query

1071 with Done query = query

1214 with ctes query = UnsafeQuery $

1072 with ctes query = UnsafeQuery $

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)

1215− "WITH" <+> renderSQL ctes <+> renderSQL query

1098+ <+> renderSQL query

squeal-postgresql/src/Squeal/PostgreSQL/Render.hs+18−3

@@ -12,6 +12,7 @@ Rendering helper functions.

12 AllowAmbiguousTypes

13 , ConstraintKinds

14 , FlexibleContexts

15+ , LambdaCase

15 , MagicHash

16 , MagicHash

16 , OverloadedStrings

17 , OverloadedStrings

17 , PolyKinds

18 , PolyKinds

@@ -22,7 +23,10 @@ Rendering helper functions.

23module Squeal.PostgreSQL.Render

24module Squeal.PostgreSQL.Render

24 ( -- * Render

25 ( -- * Render

26+ RenderSQL (..)

27+ , printSQL

28+ , escape

25− parenthesized

29+ , parenthesized

26 , bracketed

30 , bracketed

27 , (<+>)

31 , (<+>)

28 , commaSeparated

32 , commaSeparated

@@ -34,8 +38,6 @@ module Squeal.PostgreSQL.Render

34 , renderCommaSeparatedMaybe

38 , renderCommaSeparatedMaybe

35 , renderNat

39 , renderNat

36 , renderSymbol

40 , renderSymbol

37− , RenderSQL (..)

38− , printSQL

39 ) where

41 ) where

41import Control.Monad.IO.Class (MonadIO (..))

43import Control.Monad.IO.Class (MonadIO (..))

@@ -128,3 +130,16 @@ class RenderSQL sql where renderSQL :: sql -> ByteString

128-- | Print SQL.

130-- | Print SQL.

129printSQL :: (RenderSQL sql, MonadIO io) => sql -> io ()

131printSQL :: (RenderSQL sql, MonadIO io) => sql -> io ()

130printSQL = liftIO . Char8.putStrLn . renderSQL

132printSQL = liftIO . Char8.putStrLn . renderSQL

133+

134+-- | `escape` a character to prevent injection

135+escape :: Char -> String

136+escape = \case

137+ '\NUL' -> "\\0"

138+ '\'' -> "''"

139+ '"' -> "\\\""

140+ '\b' -> "\\b"

141+ '\n' -> "\\n"

142+ '\r' -> "\\r"

143+ '\t' -> "\\t"

144+ '\\' -> "\\\\"

145+ c -> [c]

squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+164−62

@@ -1,11 +1,11 @@

1{-|

2Module: Squeal.PostgreSQL.Schema

3Description: Embedding of PostgreSQL type and alias system

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

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,

9tables, schema, constraints, aliases, enumerated labels, and groupings.

10It also defines useful type families to operate on these. Finally,

11it defines an embedding of Haskell types into Postgres types.

@@ -44,6 +44,10 @@ module Squeal.PostgreSQL.Schema

44 , ColumnsType

45 , TableType

46 , SchemumType (..)

47+ , IndexType (..)

48+ , FunctionType

49+ , OperatorType (..)

50+ , ReturnsType (..)

47 , SchemaType

51 , SchemaType

48 , SchemasType

52 , SchemasType

49 , Public

53 , Public

@@ -58,15 +62,21 @@ module Squeal.PostgreSQL.Schema

58 , PGlabel (..)

62 , PGlabel (..)

59 -- * Data Definitions

63 -- * Data Definitions

60 , Create

64 , Create

65+ , CreateIfNotExists

66+ , CreateOrReplace

61 , Drop

67 , Drop

68+ , DropSchemum

69+ , DropIfExists

70+ , DropSchemumIfExists

62 , Alter

71 , Alter

72+ , AlterIfExists

63 , Rename

73 , Rename

74+ , RenameIfExists

64 , ConstraintInvolves

75 , ConstraintInvolves

65 , DropIfConstraintsInvolve

76 , DropIfConstraintsInvolve

66 , IsNotElem

77 , IsNotElem

67 , AllUnique

78 , AllUnique

68 -- * Type Classifications

79 -- * Type Classifications

69− , HasOid (..)

70 , PGNum

80 , PGNum

71 , PGIntegral

81 , PGIntegral

72 , PGFloating

82 , PGFloating

@@ -90,17 +100,19 @@ import Control.Category

90import Data.Kind

100import Data.Kind

91import Data.Monoid hiding (All)

101import Data.Monoid hiding (All)

92import Data.Type.Bool

102import Data.Type.Bool

93−import Data.Word (Word32)

94import Generics.SOP

103import Generics.SOP

95import GHC.TypeLits

104import GHC.TypeLits

96import Prelude hiding (id, (.))

105import Prelude hiding (id, (.))

106

98import Squeal.PostgreSQL.Alias

107import Squeal.PostgreSQL.Alias

108+import Squeal.PostgreSQL.List

99import Squeal.PostgreSQL.Render

109import Squeal.PostgreSQL.Render

100

110

111+-- $setup

112+-- >>> import Squeal.PostgreSQL

113+

101-- | `PGType` is the promoted datakind of PostgreSQL types.

114-- | `PGType` is the promoted datakind of PostgreSQL types.

102--

115--

103−-- >>> import Squeal.PostgreSQL.Schema

104-- >>> :kind 'PGbool

116-- >>> :kind 'PGbool

105-- 'PGbool :: PGType

117-- 'PGbool :: PGType

106data PGType

118data PGType

@@ -131,37 +143,11 @@ data PGType

131 | PGenum [Symbol] -- ^ enumerated (enum) types are data types that comprise a static, ordered set of values.

143 | PGenum [Symbol] -- ^ enumerated (enum) types are data types that comprise a static, ordered set of values.

132 | 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.

144 | 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.

133 | 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.

145 | 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).

135 | UnsafePGType Symbol -- ^ an escape hatch for unsupported PostgreSQL types

149 | UnsafePGType Symbol -- ^ an escape hatch for unsupported PostgreSQL types

136

150

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−

165-- | `NullityType` encodes the potential presence or definite absence of a

151-- | `NullityType` encodes the potential presence or definite absence of a

166-- @NULL@ allowing operations which are sensitive to such to be well typed.

152-- @NULL@ allowing operations which are sensitive to such to be well typed.

167--

153--

@@ -274,9 +260,19 @@ type FromType = [(Symbol,RowType)]

274

260

275-- | `ColumnsToRow` removes column constraints.

261-- | `ColumnsToRow` removes column constraints.

276type family ColumnsToRow (columns :: ColumnsType) :: RowType where

262type family ColumnsToRow (columns :: ColumnsType) :: RowType where

277− ColumnsToRow '[] = '[]

263+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': column4 ::: _ :=> ty4 ': column5 ::: _ :=> ty5 ': columns) =

278− ColumnsToRow (column ::: constraint :=> ty ': 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) =

279 column ::: ty ': ColumnsToRow columns

274 column ::: ty ': ColumnsToRow columns

275+ ColumnsToRow '[] = '[]

280

276

281-- | `TableToColumns` removes table constraints.

277-- | `TableToColumns` removes table constraints.

282type family TableToColumns (table :: TableType) :: ColumnsType where

278type family TableToColumns (table :: TableType) :: ColumnsType where

@@ -286,15 +282,6 @@ type family TableToColumns (table :: TableType) :: ColumnsType where

286type family TableToRow (table :: TableType) :: RowType where

282type family TableToRow (table :: TableType) :: RowType where

287 TableToRow tab = ColumnsToRow (TableToColumns tab)

283 TableToRow tab = ColumnsToRow (TableToColumns tab)

288

284

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−

298-- | Numeric Postgres types.

285-- | Numeric Postgres types.

299type PGNum =

286type PGNum =

300 '[ 'PGint2, 'PGint4, 'PGint8, 'PGnumeric, 'PGfloat4, 'PGfloat8]

287 '[ 'PGint2, 'PGint4, 'PGint8, 'PGnumeric, 'PGfloat4, 'PGfloat8]

@@ -318,14 +305,24 @@ instance ty0 ~ ty1 => SamePGType

318

305

319-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.

306-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.

320type family AllNotNull (columns :: ColumnsType) :: Constraint where

307type 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

321 AllNotNull '[] = ()

314 AllNotNull '[] = ()

322− AllNotNull (column ::: def :=> 'NotNull ty ': columns) = AllNotNull columns

323

315

324-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some

316-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some

325-- @NOT NULL@.

317-- @NOT NULL@.

326type family NotAllNull (columns :: ColumnsType) :: Constraint where

318type family NotAllNull (columns :: ColumnsType) :: Constraint where

327− NotAllNull (column ::: def :=> 'NotNull ty ': columns) = ()

319+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

320+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

321+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

322+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

323+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

324+ NotAllNull (_ ::: _ :=> 'NotNull _ ': _) = ()

328− NotAllNull (column ::: def :=> 'Null ty ': columns) = NotAllNull columns

325+ NotAllNull (_ ::: _ :=> 'Null _ ': columns) = NotAllNull columns

329

326

330-- | `NullifyType` is an idempotent that nullifies a `NullityType`.

327-- | `NullifyType` is an idempotent that nullifies a `NullityType`.

331type family NullifyType (ty :: NullityType) :: NullityType where

328type family NullifyType (ty :: NullityType) :: NullityType where

@@ -334,17 +331,37 @@ type family NullifyType (ty :: NullityType) :: NullityType where

334

331

335-- | `NullifyRow` is an idempotent that nullifies a `RowType`.

332-- | `NullifyRow` is an idempotent that nullifies a `RowType`.

336type family NullifyRow (columns :: RowType) :: RowType where

333type 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

338 NullifyRow (column ::: ty ': columns) =

344 NullifyRow (column ::: ty ': columns) =

339 column ::: NullifyType ty ': NullifyRow columns

345 column ::: NullifyType ty ': NullifyRow columns

346+ NullifyRow '[] = '[]

340

347

341-- | `NullifyFrom` is an idempotent that nullifies a `FromType`

348-- | `NullifyFrom` is an idempotent that nullifies a `FromType`

342-- used to nullify the left or right hand side of an outer join

349-- used to nullify the left or right hand side of an outer join

343-- in a `Squeal.PostgreSQL.Query.FromClause`.

350-- in a `Squeal.PostgreSQL.Query.FromClause`.

344type family NullifyFrom (tables :: FromType) :: FromType where

351type 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

346 NullifyFrom (table ::: columns ': tables) =

362 NullifyFrom (table ::: columns ': tables) =

347 table ::: NullifyRow columns ': NullifyFrom tables

363 table ::: NullifyRow columns ': NullifyFrom tables

364+ NullifyFrom '[] = '[]

348

365

349-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in

366-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in

350-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@

367-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@

@@ -354,30 +371,101 @@ type family Create alias x xs where

354 Create alias x (alias ::: y ': xs) = TypeError

371 Create alias x (alias ::: y ': xs) = TypeError

355 ('Text "Create: alias "

372 ('Text "Create: alias "

356 ':<>: 'ShowType alias

373 ':<>: 'ShowType alias

357− ':<>: 'Text "already in use")

374+ ':<>: 'Text "already exists")

358 Create alias y (x ': xs) = x ': Create alias y xs

375 Create alias y (x ': xs) = x ': Create alias y xs

359

376

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+

360-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@

394-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@

361-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements

395-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements

362-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.

396-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.

363type family Drop alias xs where

397type family Drop alias xs where

398+ Drop alias '[] = TypeError

399+ ('Text "Drop: alias "

400+ ':<>: 'ShowType alias

401+ ':<>: 'Text " does not exist" )

364− Drop alias ((alias ::: x) ': xs) = xs

402+ Drop alias (alias ::: x ': xs) = xs

365 Drop alias (x ': xs) = x ': Drop alias xs

403 Drop alias (x ': xs) = x ': Drop alias xs

366

404

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+

367-- | @Alter alias x xs@ replaces the type associated with an @alias@ in @xs@

437-- | @Alter alias x xs@ replaces the type associated with an @alias@ in @xs@

368-- with the type @x@ and is used in `Squeal.PostgreSQL.Definition.alterTable`

438-- with the type @x@ and is used in `Squeal.PostgreSQL.Definition.alterTable`

369-- and `Squeal.PostgreSQL.Definition.alterColumn`.

439-- and `Squeal.PostgreSQL.Definition.alterColumn`.

370type family Alter alias x xs where

440type family Alter alias x xs where

441+ Alter alias x '[] = TypeError

442+ ('Text "Alter: alias "

443+ ':<>: 'ShowType alias

444+ ':<>: 'Text " does not exist" )

371 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

445 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

372 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

446 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

373

447

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+

374-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@

453-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@

375-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and

454-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and

376-- `Squeal.PostgreSQL.Definition.renameColumn`.

455-- `Squeal.PostgreSQL.Definition.renameColumn`.

377type family Rename alias0 alias1 xs where

456type family Rename alias0 alias1 xs where

457+ Rename alias0 alias1 '[] = TypeError

458+ ('Text "Rename: alias "

459+ ':<>: 'ShowType alias0

460+ ':<>: 'Text " does not exist" )

378 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

461 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

379 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

462 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

380

463

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+

381-- | Check if a `TableConstraint` involves a column

469-- | Check if a `TableConstraint` involves a column

382type family ConstraintInvolves column constraint where

470type family ConstraintInvolves column constraint where

383 ConstraintInvolves column ('Check columns) = column `Elem` columns

471 ConstraintInvolves column ('Check columns) = column `Elem` columns

@@ -394,22 +482,35 @@ type family DropIfConstraintsInvolve column constraints where

394 (DropIfConstraintsInvolve column constraints)

482 (DropIfConstraintsInvolve column constraints)

395 (alias ::: constraint ': DropIfConstraintsInvolve column constraints)

483 (alias ::: constraint ': DropIfConstraintsInvolve column constraints)

396

484

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−

407-- | A `SchemumType` is a user-defined type, either a `Table`,

485-- | A `SchemumType` is a user-defined type, either a `Table`,

408-- `View` or `Typedef`.

486-- `View` or `Typedef`.

409data SchemumType

487data SchemumType

410 = Table TableType

488 = Table TableType

411 | View RowType

489 | View RowType

412 | Typedef PGType

490 | 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

413

514

414{- | The schema of a database consists of a list of aliased,

515{- | The schema of a database consists of a list of aliased,

415user-defined `SchemumType`s.

516user-defined `SchemumType`s.

@@ -452,6 +553,7 @@ There are several reasons why one might want to use schemas:

452-}

553-}

453type SchemasType = [(Symbol,SchemaType)]

554type SchemasType = [(Symbol,SchemaType)]

454

555

556+-- | A type family to use for a single schema database.

455type family Public (schema :: SchemaType) :: SchemasType

557type family Public (schema :: SchemaType) :: SchemasType

456 where Public schema = '["public" ::: schema]

558 where Public schema = '["public" ::: schema]

457

559

squeal-postgresql/src/Squeal/PostgreSQL/Transaction.hs+76−44

@@ -1,7 +1,7 @@

1{-|

2Module: Squeal.PostgreSQL.Transaction

3Description: Squeal transaction control language

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

@@ -20,11 +20,12 @@ module Squeal.PostgreSQL.Transaction

20 ( -- * Transaction

21 transactionally

22 , transactionally_

23+ , transactionallyRetry

24+ , ephemerally

25+ , ephemerally_

23 , begin

26 , begin

24 , commit

27 , commit

25 , rollback

28 , rollback

26− , transactionallySchema

27− , transactionallySchema_

28 -- * Transaction Mode

29 -- * Transaction Mode

29 , TransactionMode (..)

30 , TransactionMode (..)

30 , defaultMode

31 , defaultMode

@@ -34,68 +35,99 @@ module Squeal.PostgreSQL.Transaction

34 , DeferrableMode (..)

35 , DeferrableMode (..)

35 ) where

36 ) where

37−import Generics.SOP

38+import UnliftIO

38−import UnliftIO (MonadUnliftIO, liftIO, mask, onException)

39−

40−import qualified Database.PostgreSQL.LibPQ as LibPQ

42import Squeal.PostgreSQL.Manipulation

40import Squeal.PostgreSQL.Manipulation

43import Squeal.PostgreSQL.Render

41import Squeal.PostgreSQL.Render

44import Squeal.PostgreSQL.PQ

42import Squeal.PostgreSQL.PQ

45−import Squeal.PostgreSQL.Schema

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+-}

48transactionally

50transactionally

49 :: (MonadUnliftIO tx, MonadPQ schemas tx)

51 :: (MonadUnliftIO tx, MonadPQ schemas tx)

50 => TransactionMode

52 => TransactionMode

51 -> tx x -- ^ run inside a transaction

53 -> tx x -- ^ run inside a transaction

52 -> tx x

54 -> tx x

53transactionally mode tx = mask $ \restore -> do

55transactionally mode tx = mask $ \restore -> do

54− _ <- begin mode

56+ manipulate_ $ begin mode

55− result <- restore tx `onException` rollback

57+ result <- restore tx `onException` (manipulate_ rollback)

56− _ <- commit

58+ manipulate_ commit

57 return result

59 return result

59−-- | Run a schema invariant computation `transactionally_` in `defaultMode`.

61+-- | Run a computation `transactionally_`, in `defaultMode`.

60transactionally_

62transactionally_

61 :: (MonadUnliftIO tx, MonadPQ schemas tx)

63 :: (MonadUnliftIO tx, MonadPQ schemas tx)

62 => tx x -- ^ run inside a transaction

64 => tx x -- ^ run inside a transaction

63 -> tx x

65 -> tx x

64transactionally_ = transactionally defaultMode

66transactionally_ = transactionally defaultMode

66−-- | @BEGIN@ a transaction.

68+{- |

67−begin :: MonadPQ schemas tx => TransactionMode -> tx (K Result ('[] :: RowType))

69+`transactionallyRetry` a computation;

68−begin mode = manipulate . UnsafeManipulation $

69− "BEGIN" <+> renderSQL mode <> ";"

71−-- | @COMMIT@ a schema invariant transaction.

71+* first `begin`,

72−commit :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

72+* then `try` the computation,

73−commit = manipulate $ UnsafeManipulation "COMMIT;"

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

112

75−-- | @ROLLBACK@ a schema invariant transaction.

113+{- | Run a computation `ephemerally` in `defaultMode`. -}

114+ephemerally_

76−rollback :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

115+ :: (MonadUnliftIO tx, MonadPQ schemas tx)

77−rollback = manipulate $ UnsafeManipulation "ROLLBACK;"

116+ => tx x -- ^ run inside an ephemeral transaction

117+ -> tx x

118+ephemerally_ = ephemerally defaultMode

119

79−-- | Run a schema changing computation `transactionallySchema`.

120+-- | @BEGIN@ a transaction.

80−transactionallySchema

81− :: MonadUnliftIO io

82− => TransactionMode

121+begin :: TransactionMode -> Manipulation_ schemas () ()

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 <> ";"

122+begin mode = UnsafeManipulation $ "BEGIN" <+> renderSQL mode

88− x <- restore (unPQ u conn)

123+

89− `onException` (liftIO (LibPQ.exec (unK conn) "ROLLBACK"))

124+-- | @COMMIT@ a transaction.

90− _ <- liftIO $ LibPQ.exec (unK conn) "COMMIT"

125+commit :: Manipulation_ schemas () ()

91− return x

126+commit = UnsafeManipulation "COMMIT"

92−

127+

93−-- | Run a schema changing computation `transactionallySchema_` in `defaultMode`.

128+-- | @ROLLBACK@ a transaction.

94−transactionallySchema_

129+rollback :: Manipulation_ schemas () ()

95− :: MonadUnliftIO io

130+rollback = UnsafeManipulation "ROLLBACK"

96− => PQ schemas0 schemas1 io x

97− -> PQ schemas0 schemas1 io x

98−transactionallySchema_ = transactionallySchema defaultMode

131

100-- | The available transaction characteristics are the transaction `IsolationLevel`,

132-- | The available transaction characteristics are the transaction `IsolationLevel`,

101-- the transaction `AccessMode` (`ReadWrite` or `ReadOnly`), and the `DeferrableMode`.

133-- the transaction `AccessMode` (`ReadWrite` or `ReadOnly`), and the `DeferrableMode`.

@@ -108,7 +140,7 @@ data TransactionMode = TransactionMode

108-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

140-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

109-- `ReadWrite` `AccessMode` and `NotDeferrable` `DeferrableMode`.

141-- `ReadWrite` `AccessMode` and `NotDeferrable` `DeferrableMode`.

110defaultMode :: TransactionMode

142defaultMode :: TransactionMode

111−defaultMode = TransactionMode Serializable ReadWrite NotDeferrable

143+defaultMode = TransactionMode ReadCommitted ReadWrite NotDeferrable

112

144

113-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

145-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

114-- `ReadOnly` `AccessMode` and `Deferrable` `DeferrableMode`.

146-- `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

3+import Test.DocTest

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

2packages:

3- squeal-postgresql

5extra-deps:

6- unliftio-pool-0.2.1.0

7+- github: morphismtech/free-categories

8+ commit: c0e555fbefb5c21619e532264c4dfeac556d0630