dev..d30ec04 · squeal · git.iko.soy

git.iko.soy/squeal

52 files changed+2637−5064

unifiedsplit

.circleci/config.yml+1−1

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

22jobs:

33 build:

44 docker:

5− - image: haskell:8.6.5

5+ - image: haskell:8.6.3

66 - image: circleci/postgres:latest

77 environment:

88 POSTGRES_USER: root

README.md+70−59

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

4646* transactions

4747* views

4848* array, composite and enumerated types

49−* json functions and operations

50−* multischema support

51−* correlated subqueries

52−* window functions

53−* text search

49+* json operations

5450

5551## installation

5652

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

7672features.

7773

7874```Haskell

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

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

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

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

8177```

8278

8379We'll need some imports.

8480

8581```Haskell

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

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

8784>>> import Data.Int (Int32)

8885>>> import Data.Text (Text)

8986>>> import Squeal.PostgreSQL

87+>>> import Squeal.PostgreSQL.Render

9088```

9189

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

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

10199

102100```Haskell

103101>>> :{

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

115102type Schema =

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

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

118−type Schemas = Public Schema

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

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

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

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

107+ ])

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

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

110+ , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]

111+ ] :=>

112+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4

113+ , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4

114+ , "email" ::: 'NoDef :=> 'Null 'PGtext

115+ ])

116+ ]

119117:}

120118```

121119

122120Notice the use of type operators.

123121

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

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

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

126124operator.

127125

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

139137```Haskell

140138>>> :{

141139let

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

140+ setup :: Definition '[] Schema

143141 setup =

144142 createTable #users

145143 ( serial `as` #id :*

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

171169```Haskell

172170>>> :{

173171let

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

172+ teardown :: Definition Schema '[]

175173 teardown = dropTable #emails >>> dropTable #users

176174:}

177175

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

180178DROP TABLE "users";

181179```

182180

183−We'll need a Haskell type for `User`s. We give the type `SOP.Generic` and

184−`SOP.HasDatatypeInfo` instances so that we can encode and decode `User`s.

185−

186−```Haskell

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

188−>>> instance SOP.Generic User

189−>>> instance SOP.HasDatatypeInfo User

190−```

191−

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

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

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

195−and an output row. When

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

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

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

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

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

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

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

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

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

201−`with` statement.

189+the emails table. Take a careful look at the type and definition of both

190+of our inserts.

202191

203192```Haskell

204193>>> :{

205194let

206− insertUser :: Manipulation_ Schemas User ()

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

208− where

209− u = insertInto #users

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

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

212− e = insertInto_ #emails $ Select

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

214− (from (common #u))

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

196+ insertUser = insertRow #users

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

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

199+:}

200+

201+>>> :{

202+let

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

204+ insertEmail = insertRow #emails

205+ ( Default `as` #id :*

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

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

208+ OnConflictDoNothing (Returning Nil)

215209:}

216210

217211>>> printSQL insertUser

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"

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

213+>>> printSQL insertEmail

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

219215```

220216

221−Next we write a `Query_` to retrieve users from the database. We're not

217+Next we write a `Query` to retrieve users from the database. We're not

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

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

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

219+need to use an inner join to get the right result. A `Query` is like a

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

225221

226222```Haskell

227223>>> :{

228224let

229− getUsers :: Query_ Schemas () User

230− getUsers = select_

225+ getUsers :: Query Schema '[]

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

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

228+ getUsers = select

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

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

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

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

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

239237```

240238

241−Let's create some users to add to the database.

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.

242252

243253```Haskell

244254>>> :{

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

263273```Haskell

264274>>> :{

265275let

266− session :: PQ Schemas Schemas IO ()

276+ session :: PQ Schema Schema IO ()

267277 session = do

268− _ <- traversePrepared_ insertUser users

278+ idResults <- traversePrepared insertUser (Only . userName <$> users)

279+ ids <- traverse (fmap fromOnly . getRow 0) idResults

280+ traversePrepared_ insertEmail (zip (ids :: [Int32]) (userEmail <$> users))

269281 usersResult <- runQuery getUsers

270282 usersRows <- getRows usersResult

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

272284in

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

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

274286 define setup

275287 & pqThen session

276288 & pqThen (define teardown)

277289:}

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

279−-}

280291```

RELEASE NOTES.md−400

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

11## RELEASE NOTES

3−### Version 0.5

4−

5−Version 0.5 makes a number of large changes and additions to Squeal.

6−I want to thank folks who contributed issues and pull requests;

7−Raveline, rimmington, ilyakooo0, chshersh, reygoch, and more.

8−

9−**Multi-schema support**

10−

11−Previous versions of Squeal only supported definitions in the "public"

12−schema. Squeal 0.5 adds support for multiple schemas with the new kind

13−

14−```Haskell

15−type SchemasType = [(Symbol,SchemaType)]

16−```

17−

18−In order to upgrade your queries, manipulations and definitions from

19−Squeal 0.4, you will have to apply the `Public` type family, which indicates

20−that your only schema is the "public" schema.

21−

22−```Haskell

23−-- Squeal 0.4

24−setup :: Definition '[] Schema

25−

26−-- Squeal 0.5

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

28−```

29−

30−You can create non-public schemas using `createSchema` and inversely

31−remove them using `dropSchema`. There is also an idempotent

32−`createSchemaIfNotExists`.

33−

34−In order to handle aliases which may refer to non-public schemas, Squeal 0.5

35−introduces `QualifiedAlias`es. A `QualifiedAlias` can be referred to using

36−the `(!)` operator from the `IsQualified` typeclass; but if you want to refer

37−to an alias from the "public" schema, you can continue to use a single

38−overloaded label, no need to write `#public ! #tab`, just write `#tab`.

39−

40−**Top-level statements**

41−

42−As a consequence of multi-schema support, common table expressions that

43−a `Query` or `Manipulation` may refer to had to be broken into a new parameter.

44−Additionally, `Query` gained another new parameter for its outer scope which

45−will be discussed in the next section.

46−

47−To simplify type signatures that you have to write for top-level queries

48−and manipulations, Squeal 0.5 introduces the `Query_` and `Manipulation_`

49−type families.

50−

51−```

52−type family Query_

53− (schemas :: SchemasType)

54− (parameters :: Type)

55− (row :: Type) where

56− Query_ schemas params row =

57− Query '[] '[] schemas (TuplePG params) (RowPG row)

58−```

59−

60−As you see, a top-level `Query_` has no outer scope and no common

61−table expressions in scope, they are empty `'[]`. Moreover,

62−its parameters and row parameters are now `Type`s, which are

63−converted to corresponding Postgres types using the `TuplePG`

64−and `RowPG` type families. This means you can write the type signatures

65−for your top-level statements using the Haskell types that you

66−intend to input and retrieve when running the statements. Similar

67−to `Query_`, there is a `Manipulation_` type, the only difference

68−being that a general `Manipulation` doesn't have an outer scope,

69−only a scope for common table expressions.

70−

71−**Subquery expressions**

72−

73−Previous versions of Squeal offered subquery expression support

74−but there were issues. The common use case of using the `IN` operator

75−from SQL was overly complex. There was a proliferation of subquery

76−functions to handle different comparison operators, each with two versions

77−for comparing `ALL` or `ANY` of the query rows. And, most confoundedly,

78−there was no way to support the `EXISTS` subquery because the "outer scope"

79−for a query was not available.

80−

81−Squeal adds an outer scope to the `Query` type.

82−

83−```Haskell

84−newtype Query

85− (outer :: FromType)

86− (commons :: FromType)

87− (schemas :: SchemasType)

88− (params :: [NullityType])

89− (row :: RowType)

90− = UnsafeQuery { renderQuery :: ByteString }

91−```

92−

93−This enables a well-typed `exists` function.

94−

95−```Haskell

96−exists

97− :: Query (Join outer from) commons schemas params row

98− -> Condition outer commons grp schemas params from

99−```

100−

101−The `in_` and `notIn` functions were simplified to handle the most

102−common use case of comparing to a list of values.

103−

104−```Haskell

105−in_

106− :: Expression outer commons grp schemas params from ty -- ^ expression

107− -> [Expression outer commons grp schemas params from ty]

108− -> Condition outer commons grp schemas params from

109−```

110−

111−Finally, general subquery comparisons were abstracted to work with

112−any comparison operators, using the `Operator` type which will be discussed in

113−the next section.

114−

115−```Haskell

116−subAll

117− :: Expression outer commons grp schemas params from ty1

118− -> Operator ty1 ty2 ('Null 'PGbool)

119− -> Query (Join outer from) commons schemas params '[col ::: ty2]

120− -> Condition outer commons grp schemas params from

121−

122−subAny

123− :: Expression outer commons grp schemas params from ty1

124− -> Operator ty1 ty2 ('Null 'PGbool)

125− -> Query (Join outer from) commons schemas params '[col ::: ty2]

126− -> Condition outer commons grp schemas params from

127−```

128−

129−**Expression RankNTypes**

130−

131−Squeal 0.5 introduces RankNType type synonyms for common expression patterns.

132−The simplest example is the `Expr` type, a type for "closed" expressions

133−that cannot reference any aliases or parameters.

134−

135−```Haskell

136−type Expr x

137− = forall outer commons grp schemas params from

138− . Expression outer commons grp schemas params from x

139−```

140−

141−There is also a function type `(-->)`, which is a subtype of the usual Haskell function

142−type `(->)`.

143−

144−```Haskell

145−type (-->) x y

146− = forall outer commons grp schemas params from

147− . Expression outer commons grp schemas params from x

148− -> Expression outer commons grp schemas params from y

149−```

150−

151−We saw in the subquery section that there is an `Operator` type.

152−

153−```Haskell

154−type Operator x1 x2 y

155− = forall outer commons grp schemas params from

156− . Expression outer commons grp schemas params from x1

157− -> Expression outer commons grp schemas params from x2

158− -> Expression outer commons grp schemas params from y

159−```

160−

161−There are also types `FunctionN` and `FunctionVar` for n-ary functions

162−and variadic functions.

163−

164−```

165−type FunctionN xs y

166− = forall outer commons grp schemas params from

167− . NP (Expression outer commons grp schemas params from) xs

168− -> Expression outer commons grp schemas params from y

169−```

170−

171−An n-ary function takes an `NP` list of `Expression`s as its argument.

172−Squeal 0.5 adds a helpful operator `(*:)`, to help scrap your `Nil`s.

173−You can construct an `NP` list now by using the operator `(:*)`,

174−until your last element, using `(*:)` there. For instance, the function

175−`atan2_` takes two arguments, `atan2_ (pi *: 2)`.

176−

177−**Selections**

178−

179−Previously, Squeal provided a couple versions of `SELECT` depending

180−on whether you wanted to select all columns of a unique table

181−in the from clause, i.e. `*`, all columns of a particular table

182−in the from clause, i.e. `.*`, or a list of columns from the from clause.

183−

184−Squeal 0.5 refactors this pattern into a `Selection` GADT type, allowing

185−for abstraction and combinations that were not possible before.

186−

187−```Haskell

188−data Selection outer commons grp schemas params from row where

189− Star

190− :: HasUnique tab from row

191− => Selection outer commons 'Ungrouped schemas params from row

192− DotStar

193− :: Has tab from row

194− => Alias tab

195− -> Selection outer commons 'Ungrouped schemas params from row

196− List

197− :: SListI row

198− => NP (Aliased (Expression outer commons grp schemas params from)) row

199− -> Selection outer commons grp schemas params from row

200− Over

201− :: SListI row

202− => NP (Aliased (WindowFunction outer commons grp schemas params from)) row

203− -> WindowDefinition outer commons grp schemas params from

204− -> Selection outer commons grp schemas params from row

205− Also

206− :: Selection outer commons grp schemas params from right

207− -> Selection outer commons grp schemas params from left

208− -> Selection outer commons grp schemas params from (Join left right)

209−```

210−

211−In addition to the `Star`, `DotStar` and `List` constructors, there is an

212−`Also` constructor combinator, which enables users to combine `Selection`s.

213−Additionally, there is an `Over` constructor that is used to enable

214−window functions, described in the next section.

215−

216−To upgrade from Squeal 0.4, you will replace `selectStar` with `select Star`,

217−replace `selectDotStar #tab` with `select (DotStar #tab)`. The `List`

218−selection is such a common use case that there is a function `select_` which

219−automatically applies it, so to upgrade from Squeal 0.4, replace `select`

220−with `select_`. There are also independent `selectDistinct` and `selectDistinct_`

221−functions to filter out duplicate rows.

222−

223−**Query clauses**

224−

225−Previously, Squeal provided a couple versions of `INSERT` depending

226−on whether you wanted to insert `VALUES` or a query.

227−

228−Squeal 0.5 refactors this pattern into a `QueryClause` GADT.

229−

230−```

231−-- Squeal 0.4

232−insertRow_ #tab (Set 2 `as` #col1 :* Default `as` #col2)

233−insertQuery_ #tab (selectStar (from (table #other_tab)))

234−

235−-- Squeal 0.5

236−insertInto_ #tab (Values_ (Set 2 `as` #col1 :* Default `as` #col2))

237−insertInto_ #tab (Subquery (select Star (from (table #other_tab))))

238−```

239−

240−**Window functions and aggregation**

241−

242−Previous versions of Squeal provided no support for window functions.

243−Squeal 0.5 adds support for window functions. We saw `Over` in the

244−previous section.

245−

246−```Haskell

247−Over

248− :: SListI row

249− => NP (Aliased (WindowFunction outer commons grp schemas params from)) row

250− -> WindowDefinition outer commons grp schemas params from

251− -> Selection outer commons grp schemas params from row

252−```

253−

254−`Over` combines window functions with window definitions. A `WindowDefinition`

255−is constructed using the `partitionBy` function, optionally with an `orderBy`

256−clause. For example,

257−

258−```Haskell

259−query :: Query_ (Public Schema) () (Row Int32 Int32)

260−query = select

261− (#col1 & Also (rank `as` #col2 `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))

262− (from (table #tab))

263−```

264−

265−Here the `rank` function is a `WindowFunction`

266−

267−```Haskell

268−rank :: WinFun0 ('NotNull 'PGint8)

269−rank = UnsafeWindowFunction "rank()"

270−```

271−

272−`WinFun0` is a RankNType, like `Expr` was, used for no argument window functions.

273−Similarly, there are also `WinFun1` and `WinFunN` types for

274−window functions and n-ary window functions.

275−

276−In order to use the same syntax for certain window functions and aggregate functions,

277−a new typeclass `Aggregate` was introduced. So for instance, `sum_` can be

278−either a `Distinction` `Expression` or a `WindowFunction`, used either with

279−a `groupBy` or with a `partitionBy` in the appropriate way.

280−

281−```

282−data Distinction (expr :: kind -> Type) (ty :: kind)

283− = All (expr ty)

284− | Distinct (expr ty)

285−```

286−

287−Aggregate functions can be run over all rows or only over distinct rows,

288−while window functions bear no such distinction.

289−

290−**Migrations**

291−

292−Thanks to [https://github.com/Raveline](Raveline) Squeal 0.5 introduces

293−a function `defaultMain` to easily create a command line program to

294−run or rewind your migrations.

295−

296−Previously, Squeal's migrations were impure, allowing in addition to

297−running `Definition`s to run arbitrary `IO` operations, such as inserting

298−data into the database or printing out status messages. In order to

299−provide compatibility with other migration systems, Squeal 0.5 introduces

300−pure migrations, that is migrations that are only `Definition`s.

301−

302−```Haskell

303−data Migration p schemas0 schemas1 = Migration

304− { name :: Text -- ^ The `name` of a `Migration`.

305− -- Each `name` in a `Migration` should be unique.

306− , up :: p schemas0 schemas1 -- ^ The `up` instruction of a `Migration`.

307− , down :: p schemas1 schemas0 -- ^ The `down` instruction of a `Migration`.

308− } deriving (GHC.Generic)

309−```

310−

311−A pure migration is a `Migration Definition`, a pair of inverse

312−`Definition`s with a unique name. To recover impure migrations, Squeal 0.5

313−introduces the `Terminally` type.

314−

315−```Haskell

316−newtype Terminally trans monad x0 x1 = Terminally

317− { runTerminally :: trans x0 x1 monad () }

318−```

319−

320−`Terminally` applies the indexed monad transformer and the monad it transforms

321−to the unit type `()`, thereby turning an indexed monad into a `Category`. An

322−impure migration is a `Migration (Terminally PQ IO)`. You can always cast

323−a pure migration into an impure migration with the functor, `pureMigration`.

324−

325−```Haskell

326−pureMigration

327− :: Migration Definition schemas0 schemas1

328− -> Migration (Terminally PQ IO) schemas0 schemas1

329−```

330−

331−To run either pure or impure migrations, Squeal 0.5 introduces

332−a typeclass, `Migratory`.

333−

334−```

335−class Category p => Migratory p where

336−

337− migrateUp

338− :: AlignedList (Migration p) schemas0 schemas1

339− -> PQ schemas0 schemas1 IO ()

340−

341− migrateDown

342− :: AlignedList (Migration p) schemas0 schemas1

343− -> PQ schemas1 schemas0 IO ()

344−```

345−

346−The signatures of `migrateUp` and `migrateDown` have been changed

347−to make them easier to compose with other `PQ` actions.

348−

349−**Transactions**

350−

351−You can now run transactions `ephemerally`, guaranteed to roll back,

352−but return the result or throw the exception that the transaction

353−would have generated. This is useful for testing. You can also

354−`transactionallyRetry` computations, retrying the transaction if

355−a [serialization failure](https://www.postgresql.org/docs/11/transaction-iso.html#XACT-REPEATABLE-READ) occurs.

356−

357−**Types**

358−

359−Squeal now supports money via a `Money` Haskell `Type` and a `'PGmoney`

360−`PGType`. Squeal 0.5 also adds support for creating domain types

361−with `createDomain`.

362−

363−**Time**

364−

365−Squeal 0.5 adds support for new functions; `now`, `makeDate`, `makeTime`,

366−, `makeTimestamp`, and `makeTimestamptz`, a function `interval_` for

367−constructing time intervals out multiples of `TimeUnit`s, and a new

368−`TimeOp` class, defining affine space operators for time types and their

369−differences.

370−

371−**Literals**

372−

373−Squeal allows you to include Haskell values in your statements using

374−out of line `parameter`s, but often you want to include them inline,

375−as a SQL `literal`. Squeal 0.5 enables this using the `Literal` class.

376−

377−**Set returning functions**

378−

379−Squeal 0.5 adds support for set returning functions such as `unnest`,

380−with the `RankNType` `SetOfFunction`, which can be used as as a `FromClause`.

381−

382−**Text search**

383−

384−Squeal 0.5 adds extensive support for text search types, functions and operators.

385−

386−**Much more**

387−

388−Lots more changes went into and under the hood of the new version.

389−The `Expression` module was split into coherent submodules since it

390−had grown to immense proportions. New modules `Alias`, `PG` and `List`

391−were added to relieve some of the burden that the `Schema` module

392−had been carrying. Rendering has been better unified with a new

393−`RenderSQL` typeclass. Type level list concatenation with the `Additional`

394−typeclass has been added. `Manipulation`s `update` and `delete`

395−were upgraded, so you can leave out fields you don't want to update and

396−use `USING` clauses in deletes. Upserts which were previously broken

397−now work. The `IO` typeclass hierarchy was changed from `MonadBase`

398−and `MonadBaseControl` to `MonadIO` and `MonadUnliftIO`. A new

399−`withRecursive` `Manipulation` was added. `SquealException`s were

400−refactored and a `trySqueal` function added. Arrays were refactored.

401−And there was probably more I've forgotten.

402−

4033### Version 0.4

4044

4055Version 0.4 strengthens Squeal's type system, adds

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

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

1111

1212module Main (main, main2) where

1313

14+import Control.Monad (void)

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

1516import Data.Int (Int16, Int32)

1617import Data.Monoid ((<>))

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

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

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

4041 ])

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

4242 ]

4343

4444type Schemas = Public Schema

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

5353 >>>

5454 createTable #emails

5555 ( serial `as` #id :*

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

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

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

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

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

5959 foreignKey #user_id #users #id

6060 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

61− >>>

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

6361

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

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

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

6664

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

6866insertUser = insertInto #users

69− (Values_ (Default `as` #id :* Set (param @1) `as` #name :* Set (param @2) `as` #vec))

67+ (Values_ (defaultAs #id :* param @1 `as` #name :* param @2 `as` #vec))

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

7169

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

7371insertEmail = insertInto_ #emails

74− (Values_ (Default `as` #id :* Set (param @1) `as` #user_id :* Set (param @2) `as` #email))

72+ (Values_ (defaultAs #id :* param @1 `as` #user_id :* param @2 `as` #email))

7573

7674getUsers :: Query_ Schemas () User

7775getUsers = select_

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

119117

120118main2 :: IO ()

121119main2 =

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

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

123121 define setup

124122 & pqThen session

125123 & pqThen (define teardown)

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

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

11name: squeal-postgresql

2−version: 0.5.1.0

2+version: 0.4.9.0

33synopsis: Squeal PostgreSQL Library

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

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

@@ -25,25 +25,15 @@ library

2525 Squeal.PostgreSQL.Alias

2626 Squeal.PostgreSQL.Binary

2727 Squeal.PostgreSQL.Definition

28− Squeal.PostgreSQL.Definition.Function

29− Squeal.PostgreSQL.Definition.Index

30− Squeal.PostgreSQL.Definition.Table

31− Squeal.PostgreSQL.Definition.Table.Constraint

32− Squeal.PostgreSQL.Definition.Type

33− Squeal.PostgreSQL.Definition.Schema

34− Squeal.PostgreSQL.Definition.View

3528 Squeal.PostgreSQL.Expression

3629 Squeal.PostgreSQL.Expression.Aggregate

3730 Squeal.PostgreSQL.Expression.Collection

3831 Squeal.PostgreSQL.Expression.Comparison

3932 Squeal.PostgreSQL.Expression.Json

40− Squeal.PostgreSQL.Expression.Literal

4133 Squeal.PostgreSQL.Expression.Logic

4234 Squeal.PostgreSQL.Expression.Math

4335 Squeal.PostgreSQL.Expression.Null

4436 Squeal.PostgreSQL.Expression.Parameter

45− Squeal.PostgreSQL.Expression.Range

46− Squeal.PostgreSQL.Expression.Set

4737 Squeal.PostgreSQL.Expression.Sort

4838 Squeal.PostgreSQL.Expression.Subquery

4939 Squeal.PostgreSQL.Expression.Text

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

7060 , bytestring >= 0.10.8.2

7161 , bytestring-strict-builder >= 0.4.5

7262 , deepseq >= 1.4.3.0

73− , free-categories >= 0.1.0.0

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

63+ , generics-sop >= 0.3.2.0

7564 , mmorph >= 1.1.1

7665 , mtl >= 2.2.2

7766 , network-ip >= 0.3.0.2

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

8877 , uuid-types >= 1.0.3

8978 , vector >= 0.12.0.1

9079

91−test-suite doctest

80+test-suite squeal-postgresql-doctest

9281 default-language: Haskell2010

9382 type: exitcode-stdio-1.0

9483 hs-source-dirs: test

9584 ghc-options: -Wall

96− main-is: Doc.hs

85+ main-is: DocTest.hs

9786 build-depends:

9887 base >= 4.10.0.0

9988 , doctest >= 0.11.4

100− , squeal-postgresql

10189

102−test-suite properties

90+test-suite squeal-postgresql-specs

10391 default-language: Haskell2010

10492 type: exitcode-stdio-1.0

105− hs-source-dirs: test

106− ghc-options: -Wall

107− main-is: Property.hs

93+ hs-source-dirs: test/Specs

94+ ghc-options: -Wall -main-is Specs

95+ main-is: Specs.hs

96+ other-modules: ExceptionHandling

10897 build-depends:

10998 base >= 4.10.0.0

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

127100 , generics-sop >= 0.3.1.0

128101 , hspec >= 2.4.8

129− , mtl >= 2.2.2

130102 , squeal-postgresql

131103 , text >= 1.2.2.2

104+ , transformers >= 0.5.2.0

132105 , vector >= 0.12.0.1

133106

134−executable example

107+executable squeal-postgresql-example

135108 default-language: Haskell2010

136109 hs-source-dirs: exe

137110 ghc-options: -Wall

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

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

11{-|

22Module: Squeal.PostgreSQL

33Description: Squeal export module

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

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

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

1212features.

1313

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

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

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

1616

1717We'll need some imports.

1818

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

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

2021>>> import Data.Int (Int32)

2122>>> import Data.Text (Text)

2223>>> import Squeal.PostgreSQL

24+>>> import Squeal.PostgreSQL.Render

2325

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

2527

@@ -102,23 +104,25 @@ let

102104DROP TABLE "emails";

103105DROP TABLE "users";

104106

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

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

107−

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

109−>>> instance SOP.Generic User

110−>>> instance SOP.HasDatatypeInfo User

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

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

116111we insert into the users table, we will need a parameter for the @name@

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

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

119114need 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.

115+the emails table. Take a careful look at the type and definition of both

116+of our inserts.

117+

118+We'll need a Haskell type for users. We give the type `Generics.SOP.Generic` and

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

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

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

122+

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

124+>>> instance SOP.Generic User

125+>>> instance SOP.HasDatatypeInfo User

122126

123127>>> :{

124128let

@@ -126,20 +130,19 @@ let

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

127131 where

128132 u = insertInto #users

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

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

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

131− e = insertInto_ #emails $ Select

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

133− (from (common #u))

135+ e = insertInto_ #emails

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

134137:}

135138

136139>>> printSQL insertUser

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

138141

139−Next we write a `Query_` to retrieve users from the database. We're not

142+Next we write a `Query` to retrieve users from the database. We're not

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

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

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

144+need to use an inner join to get the right result. A `Query` is like a

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

143146

144147>>> :{

145148let

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

183186 usersRows <- getRows usersResult

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

185188in

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

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

187190 define setup

188191 & pqThen session

189192 & pqThen (define teardown)

190193:}

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

192195-}

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

194−

195−import Squeal.PostgreSQL.Alias as X

196−import Squeal.PostgreSQL.Binary as X

197−import Squeal.PostgreSQL.Definition as X

198−import Squeal.PostgreSQL.Definition.Function as X

199−import Squeal.PostgreSQL.Definition.Index as X

200−import Squeal.PostgreSQL.Definition.Schema as X

201−import Squeal.PostgreSQL.Definition.Table as X

202−import Squeal.PostgreSQL.Definition.Table.Constraint as X

203−import Squeal.PostgreSQL.Definition.Type as X

204−import Squeal.PostgreSQL.Definition.View as X

205−import Squeal.PostgreSQL.Expression as X

206−import Squeal.PostgreSQL.Expression.Aggregate as X

207−import Squeal.PostgreSQL.Expression.Collection as X

208−import Squeal.PostgreSQL.Expression.Comparison as X

209−import Squeal.PostgreSQL.Expression.Json as X

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

211−import Squeal.PostgreSQL.Expression.Logic as X

212−import Squeal.PostgreSQL.Expression.Math as X

213−import Squeal.PostgreSQL.Expression.Null as X

214−import Squeal.PostgreSQL.Expression.Parameter as X

215−import Squeal.PostgreSQL.Expression.Range as X

216−import Squeal.PostgreSQL.Expression.Set as X

217−import Squeal.PostgreSQL.Expression.Sort as X

218−import Squeal.PostgreSQL.Expression.Subquery as X

219−import Squeal.PostgreSQL.Expression.Text as X

220−import Squeal.PostgreSQL.Expression.TextSearch as X

221−import Squeal.PostgreSQL.Expression.Time as X

222−import Squeal.PostgreSQL.Expression.Type as X

223−import Squeal.PostgreSQL.Expression.Window as X

224−import Squeal.PostgreSQL.List as X

225−import Squeal.PostgreSQL.Manipulation as X

226−import Squeal.PostgreSQL.Migration as X

227−import Squeal.PostgreSQL.PG as X

228−import Squeal.PostgreSQL.Pool as X

229−import Squeal.PostgreSQL.PQ as X

230−import Squeal.PostgreSQL.Query as X

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

232−import Squeal.PostgreSQL.Schema as X

233−import Squeal.PostgreSQL.Transaction as X

196+module Squeal.PostgreSQL

197+ ( module Squeal.PostgreSQL.Alias

198+ , module Squeal.PostgreSQL.Binary

199+ , module Squeal.PostgreSQL.Definition

200+ , module Squeal.PostgreSQL.Expression

201+ , module Squeal.PostgreSQL.Expression.Aggregate

202+ , module Squeal.PostgreSQL.Expression.Collection

203+ , module Squeal.PostgreSQL.Expression.Comparison

204+ , module Squeal.PostgreSQL.Expression.Json

205+ , module Squeal.PostgreSQL.Expression.Logic

206+ , module Squeal.PostgreSQL.Expression.Math

207+ , module Squeal.PostgreSQL.Expression.Null

208+ , module Squeal.PostgreSQL.Expression.Parameter

209+ , module Squeal.PostgreSQL.Expression.Sort

210+ , module Squeal.PostgreSQL.Expression.Subquery

211+ , module Squeal.PostgreSQL.Expression.Text

212+ , module Squeal.PostgreSQL.Expression.TextSearch

213+ , module Squeal.PostgreSQL.Expression.Time

214+ , module Squeal.PostgreSQL.Expression.Type

215+ , module Squeal.PostgreSQL.Expression.Window

216+ , module Squeal.PostgreSQL.List

217+ , module Squeal.PostgreSQL.Manipulation

218+ , module Squeal.PostgreSQL.PG

219+ , module Squeal.PostgreSQL.PQ

220+ , module Squeal.PostgreSQL.Query

221+ , module Squeal.PostgreSQL.Schema

222+ , module Squeal.PostgreSQL.Transaction

223+ ) where

224+

225+import Squeal.PostgreSQL.Alias

226+import Squeal.PostgreSQL.Binary

227+import Squeal.PostgreSQL.Definition

228+import Squeal.PostgreSQL.Expression

229+import Squeal.PostgreSQL.Expression.Aggregate

230+import Squeal.PostgreSQL.Expression.Collection

231+import Squeal.PostgreSQL.Expression.Comparison

232+import Squeal.PostgreSQL.Expression.Json

233+import Squeal.PostgreSQL.Expression.Logic

234+import Squeal.PostgreSQL.Expression.Math

235+import Squeal.PostgreSQL.Expression.Null

236+import Squeal.PostgreSQL.Expression.Parameter

237+import Squeal.PostgreSQL.Expression.Sort

238+import Squeal.PostgreSQL.Expression.Subquery

239+import Squeal.PostgreSQL.Expression.Text

240+import Squeal.PostgreSQL.Expression.TextSearch

241+import Squeal.PostgreSQL.Expression.Time

242+import Squeal.PostgreSQL.Expression.Type

243+import Squeal.PostgreSQL.Expression.Window

244+import Squeal.PostgreSQL.List

245+import Squeal.PostgreSQL.Manipulation

246+import Squeal.PostgreSQL.PG

247+import Squeal.PostgreSQL.PQ

248+import Squeal.PostgreSQL.Query

249+import Squeal.PostgreSQL.Schema

250+import Squeal.PostgreSQL.Transaction

squeal-postgresql/src/Squeal/PostgreSQL/Alias.hs+10−14

@@ -1,15 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Alias

3−Description: Aliases

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−This module embeds Postgres's alias system in Haskell in

9−a typesafe fashion. Thanks to GHC's @OverloadedLabels@ extension,

10−Squeal can reference aliases by prepending with a @#@.

11−-}

12−

131{-# LANGUAGE

142 AllowAmbiguousTypes

153 , ConstraintKinds

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

4634 , HasIn

4735 , QualifiedAlias (..)

4836 , IsQualified (..)

37+ , DefaultAliasable (..)

4938 -- * Grouping

5039 , Grouping (..)

5140 , GroupedBy

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

188177class HasIn fields field where

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

190179

180+{- |

181+The `DefaultAliasable` class is intended to help with Scrap your Nils

182+for default inserts and updates.

183+-}

184+class KnownSymbol alias

185+ => DefaultAliasable alias aliased | aliased -> alias where

186+ defaultAs :: Alias alias -> aliased

187+

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

192189-- a list of @subfields@.

193190class

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

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

212209

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

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

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

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

216212a qualifier of @public@ is provided.

217213

218214>>> :{

squeal-postgresql/src/Squeal/PostgreSQL/Binary.hs+71−213

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

3939

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

4141>>> :{

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

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

4343 result <- runQueryParams roundTrip input

4444 Just output <- firstRow result

4545 liftIO . print $ input == output

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

7878>>> :set -XOverloadedLists

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

8080>>> :{

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

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

8282 result <- runQueryParams roundTrip input

8383 Just output <- firstRow result

8484 liftIO . print $ input == output

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

170170 Just output <- firstRow result

171171 liftIO . print $ input == output

172172in

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

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

174174 define setup

175175 & pqThen session

176176 & pqThen (define teardown)

@@ -205,20 +205,14 @@ module Squeal.PostgreSQL.Binary

205205 ( -- * Encoding

206206 ToParam (..)

207207 , ToParams (..)

208− , ToNullityParam (..)

209− , ToField (..)

210− , ToFixArray (..)

208+ , ToNullityParam

209+ , ToField

210+ , ToFixArray

211211 -- * Decoding

212212 , FromValue (..)

213213 , FromRow (..)

214− , FromField (..)

215− , FromFixArray (..)

216214 -- * Only

217215 , Only (..)

218− -- * Oid

219− , OidOf (..)

220− , OidOfParam (..)

221− , OidOfField (..)

222216 ) where

223217

224218import BinaryParser

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

232226import Data.UUID.Types

233227import Data.Vector (Vector)

234228import Data.Word

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

236229import Generics.SOP

237230import Generics.SOP.Record

238231import GHC.TypeLits

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

246239import qualified Data.Text as Strict (Text)

247240import qualified Data.Text as Strict.Text

248241import qualified Data.Vector as Vector

249−import qualified Database.PostgreSQL.LibPQ as LibPQ

250242import qualified GHC.Generics as GHC

251243import qualified PostgreSQL.Binary.Decoding as Decoding

252244import qualified PostgreSQL.Binary.Encoding as Encoding

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

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

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

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

272+instance ToParam Word16 'PGint2 where toParam = K . Encoding.int2_word16

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

274+instance ToParam Word32 'PGint4 where toParam = K . Encoding.int4_word32

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

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

276+instance ToParam Word64 'PGint8 where toParam = K . Encoding.int8_word64

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

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

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

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

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

313307 toParam = K . Encoding.jsonb_bytes

314308 . Lazy.ByteString.toStrict . Aeson.encode . getJsonb

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

309+instance (ToNullityParam x ty, ty ~ nullity pg, HasOid pg)

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

317311 toParam = K

318− . Encoding.array_foldable

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

312+ . Encoding.array_foldable (oid @pg) (unK . toNullityParam @x @ty)

320313 . getVarArray

321−instance (ToParam x pg, OidOf pg)

314+instance (ToParam x pg, HasOid pg)

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

323316 toParam = K

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

317+ . Encoding.array_vector (oid @pg) (unK . toParam @x @pg)

325318 . getVarArray

326−instance (ToParam x pg, OidOf pg)

319+instance (ToParam x pg, HasOid pg)

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

328321 toParam = K

329− . Encoding.nullableArray_vector

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

322+ . Encoding.nullableArray_vector (oid @pg) (unK . toParam @x @pg)

331323 . getVarArray

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

324+instance (ToFixArray x dims ty, ty ~ nullity pg, HasOid pg)

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

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

326+ toParam = K . Encoding.array (oid @pg)

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

336328instance

337329 ( IsEnumType x

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

356348 ( SListI fields

357349 , IsRecord x xs

358350 , AllZip ToField xs fields

359− , All OidOfField fields

351+ , All HasAliasedOid fields

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

361353 toParam =

362354 let

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

364356 encoders = htrans (Proxy @ToField) toField

365357

366358 composite

367− :: All OidOfField row

359+ :: All HasAliasedOid row

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

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

370362 composite fields = K $

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

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

382374 let

383375 each

384− :: OidOfField field

376+ :: HasAliasedOid field

385377 => K (Maybe Encoding.Encoding) field

386378 -> Encoding.Encoding

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

388− word32BE (getOid (oidOfField @field))

380+ word32BE (aliasedOid @field)

389381 <> case field of

390382 Nothing -> int64BE (-1)

391383 Just value ->

392384 int32BE (fromIntegral (builderLength value))

393385 <> value

394386 in

395− hcfoldMap (Proxy @OidOfField) each fields

387+ hcfoldMap (Proxy @HasAliasedOid) each fields

396388

397389 in

398390 composite . encoders . toRecord . getComposite

399391

400−-- | The object identifier of a `PGType`.

401−--

402−-- >>> :set -XTypeApplications

403−-- >>> oidOf @'PGbool

404−-- Oid 16

405−class OidOf (ty :: PGType) where oidOf :: LibPQ.Oid

406−instance OidOf 'PGbool where oidOf = LibPQ.Oid 16

407−instance OidOf ('PGfixarray ns (null 'PGbool)) where oidOf = LibPQ.Oid 1000

408−instance OidOf ('PGvararray (null 'PGbool)) where oidOf = LibPQ.Oid 1000

409−instance OidOf 'PGint2 where oidOf = LibPQ.Oid 21

410−instance OidOf ('PGfixarray ns (null 'PGint2)) where oidOf = LibPQ.Oid 1005

411−instance OidOf ('PGvararray (null 'PGint2)) where oidOf = LibPQ.Oid 1005

412−instance OidOf 'PGint4 where oidOf = LibPQ.Oid 23

413−instance OidOf ('PGfixarray ns (null 'PGint4)) where oidOf = LibPQ.Oid 1007

414−instance OidOf ('PGvararray (null 'PGint4)) where oidOf = LibPQ.Oid 1007

415−instance OidOf 'PGint8 where oidOf = LibPQ.Oid 20

416−instance OidOf ('PGfixarray ns (null 'PGint8)) where oidOf = LibPQ.Oid 1016

417−instance OidOf ('PGvararray (null 'PGint8)) where oidOf = LibPQ.Oid 1016

418−instance OidOf 'PGnumeric where oidOf = LibPQ.Oid 1700

419−instance OidOf ('PGfixarray ns (null 'PGnumeric)) where oidOf = LibPQ.Oid 1231

420−instance OidOf ('PGvararray (null 'PGnumeric)) where oidOf = LibPQ.Oid 1231

421−instance OidOf 'PGfloat4 where oidOf = LibPQ.Oid 700

422−instance OidOf ('PGfixarray ns (null 'PGfloat4)) where oidOf = LibPQ.Oid 1021

423−instance OidOf ('PGvararray (null 'PGfloat4)) where oidOf = LibPQ.Oid 1021

424−instance OidOf 'PGfloat8 where oidOf = LibPQ.Oid 701

425−instance OidOf ('PGfixarray ns (null 'PGfloat8)) where oidOf = LibPQ.Oid 1022

426−instance OidOf ('PGvararray (null 'PGfloat8)) where oidOf = LibPQ.Oid 1022

427−instance OidOf 'PGmoney where oidOf = LibPQ.Oid 790

428−instance OidOf ('PGfixarray ns (null 'PGmoney)) where oidOf = LibPQ.Oid 791

429−instance OidOf ('PGvararray (null 'PGmoney)) where oidOf = LibPQ.Oid 791

430−instance OidOf ('PGchar n) where oidOf = LibPQ.Oid 18

431−instance OidOf ('PGfixarray ns (null ('PGchar n))) where oidOf = LibPQ.Oid 1002

432−instance OidOf ('PGvararray (null ('PGchar n))) where oidOf = LibPQ.Oid 1002

433−instance OidOf ('PGvarchar n) where oidOf = LibPQ.Oid 1043

434−instance OidOf ('PGfixarray ns (null ('PGvarchar n))) where oidOf = LibPQ.Oid 1015

435−instance OidOf ('PGvararray (null ('PGvarchar n))) where oidOf = LibPQ.Oid 1015

436−instance OidOf 'PGtext where oidOf = LibPQ.Oid 25

437−instance OidOf ('PGfixarray ns (null 'PGtext)) where oidOf = LibPQ.Oid 1009

438−instance OidOf ('PGvararray (null 'PGtext)) where oidOf = LibPQ.Oid 1009

439−instance OidOf 'PGbytea where oidOf = LibPQ.Oid 17

440−instance OidOf ('PGfixarray ns (null 'PGbytea)) where oidOf = LibPQ.Oid 1001

441−instance OidOf ('PGvararray (null 'PGbytea)) where oidOf = LibPQ.Oid 1001

442−instance OidOf 'PGtimestamp where oidOf = LibPQ.Oid 1114

443−instance OidOf ('PGfixarray ns (null 'PGtimestamp)) where oidOf = LibPQ.Oid 1115

444−instance OidOf ('PGvararray (null 'PGtimestamp)) where oidOf = LibPQ.Oid 1115

445−instance OidOf 'PGtimestamptz where oidOf = LibPQ.Oid 1184

446−instance OidOf ('PGfixarray ns (null 'PGtimestamptz)) where oidOf = LibPQ.Oid 1185

447−instance OidOf ('PGvararray (null 'PGtimestamptz)) where oidOf = LibPQ.Oid 1185

448−instance OidOf 'PGdate where oidOf = LibPQ.Oid 1082

449−instance OidOf ('PGfixarray ns (null 'PGdate)) where oidOf = LibPQ.Oid 1182

450−instance OidOf ('PGvararray (null 'PGdate)) where oidOf = LibPQ.Oid 1182

451−instance OidOf 'PGtime where oidOf = LibPQ.Oid 1083

452−instance OidOf ('PGfixarray ns (null 'PGtime)) where oidOf = LibPQ.Oid 1183

453−instance OidOf ('PGvararray (null 'PGtime)) where oidOf = LibPQ.Oid 1183

454−instance OidOf 'PGtimetz where oidOf = LibPQ.Oid 1266

455−instance OidOf ('PGfixarray ns (null 'PGtimetz)) where oidOf = LibPQ.Oid 1270

456−instance OidOf ('PGvararray (null 'PGtimetz)) where oidOf = LibPQ.Oid 1270

457−instance OidOf 'PGinterval where oidOf = LibPQ.Oid 1186

458−instance OidOf ('PGfixarray ns (null 'PGinterval)) where oidOf = LibPQ.Oid 1187

459−instance OidOf ('PGvararray (null 'PGinterval)) where oidOf = LibPQ.Oid 1187

460−instance OidOf 'PGuuid where oidOf = LibPQ.Oid 2950

461−instance OidOf ('PGfixarray ns (null 'PGuuid)) where oidOf = LibPQ.Oid 2951

462−instance OidOf ('PGvararray (null 'PGuuid)) where oidOf = LibPQ.Oid 2951

463−instance OidOf 'PGinet where oidOf = LibPQ.Oid 869

464−instance OidOf ('PGfixarray ns (null 'PGinet)) where oidOf = LibPQ.Oid 1041

465−instance OidOf ('PGvararray (null 'PGinet)) where oidOf = LibPQ.Oid 1041

466−instance OidOf 'PGjson where oidOf = LibPQ.Oid 114

467−instance OidOf ('PGfixarray ns (null 'PGjson)) where oidOf = LibPQ.Oid 199

468−instance OidOf ('PGvararray (null 'PGjson)) where oidOf = LibPQ.Oid 199

469−instance OidOf 'PGjsonb where oidOf = LibPQ.Oid 3802

470−instance OidOf ('PGfixarray ns (null 'PGjsonb)) where oidOf = LibPQ.Oid 3807

471−instance OidOf ('PGvararray (null 'PGjsonb)) where oidOf = LibPQ.Oid 3807

472−instance OidOf 'PGtsvector where oidOf = LibPQ.Oid 3614

473−instance OidOf ('PGfixarray ns (null 'PGtsvector)) where oidOf = LibPQ.Oid 3643

474−instance OidOf ('PGvararray (null 'PGtsvector)) where oidOf = LibPQ.Oid 3643

475−instance OidOf 'PGtsquery where oidOf = LibPQ.Oid 3615

476−instance OidOf ('PGfixarray ns (null 'PGtsquery)) where oidOf = LibPQ.Oid 3645

477−instance OidOf ('PGvararray (null 'PGtsquery)) where oidOf = LibPQ.Oid 3645

478−instance OidOf 'PGoid where oidOf = LibPQ.Oid 26

479−instance OidOf ('PGfixarray ns (null 'PGoid)) where oidOf = LibPQ.Oid 1028

480−instance OidOf ('PGvararray (null 'PGoid)) where oidOf = LibPQ.Oid 1028

481−instance OidOf ('PGrange 'PGint4) where oidOf = LibPQ.Oid 3904

482−instance OidOf ('PGfixarray ns (null ('PGrange 'PGint4))) where oidOf = LibPQ.Oid 3905

483−instance OidOf ('PGvararray (null ('PGrange 'PGint4))) where oidOf = LibPQ.Oid 3905

484−instance OidOf ('PGrange 'PGint8) where oidOf = LibPQ.Oid 3926

485−instance OidOf ('PGfixarray ns (null ('PGrange 'PGint8))) where oidOf = LibPQ.Oid 3927

486−instance OidOf ('PGvararray (null ('PGrange 'PGint8))) where oidOf = LibPQ.Oid 3927

487−instance OidOf ('PGrange 'PGnumeric) where oidOf = LibPQ.Oid 3906

488−instance OidOf ('PGfixarray ns (null ('PGrange 'PGnumeric))) where oidOf = LibPQ.Oid 3907

489−instance OidOf ('PGvararray (null ('PGrange 'PGnumeric))) where oidOf = LibPQ.Oid 3907

490−instance OidOf ('PGrange 'PGtimestamp) where oidOf = LibPQ.Oid 3908

491−instance OidOf ('PGfixarray ns (null ('PGrange 'PGtimestamp))) where oidOf = LibPQ.Oid 3909

492−instance OidOf ('PGvararray (null ('PGrange 'PGtimestamp))) where oidOf = LibPQ.Oid 3909

493−instance OidOf ('PGrange 'PGtimestamptz) where oidOf = LibPQ.Oid 3910

494−instance OidOf ('PGfixarray ns (null ('PGrange 'PGtimestamptz))) where oidOf = LibPQ.Oid 3911

495−instance OidOf ('PGvararray (null ('PGrange 'PGtimestamptz))) where oidOf = LibPQ.Oid 3911

496−instance OidOf ('PGrange 'PGdate) where oidOf = LibPQ.Oid 3912

497−instance OidOf ('PGfixarray ns (null ('PGrange 'PGdate))) where oidOf = LibPQ.Oid 3913

498−instance OidOf ('PGvararray (null ('PGrange 'PGdate))) where oidOf = LibPQ.Oid 3913

499−instance {-# OVERLAPPABLE #-} OidOf ('PGrange ty) where oidOf = LibPQ.invalidOid

500−instance {-# OVERLAPPABLE #-} OidOf ('PGfixarray ns (null ('PGrange ty))) where oidOf = LibPQ.invalidOid

501−instance {-# OVERLAPPABLE #-} OidOf ('PGvararray (null ('PGrange ty))) where oidOf = LibPQ.invalidOid

502−instance {-# OVERLAPPABLE #-} OidOf ('PGcomposite row) where oidOf = LibPQ.invalidOid

503−instance {-# OVERLAPPABLE #-} OidOf ('PGfixarray ns (null ('PGcomposite row))) where oidOf = LibPQ.invalidOid

504−instance {-# OVERLAPPABLE #-} OidOf ('PGvararray (null ('PGcomposite row))) where oidOf = LibPQ.invalidOid

505−instance {-# OVERLAPPABLE #-} OidOf ('PGenum labels) where oidOf = LibPQ.invalidOid

506−instance {-# OVERLAPPABLE #-} OidOf ('PGfixarray ns (null ('PGenum labels))) where oidOf = LibPQ.invalidOid

507−instance {-# OVERLAPPABLE #-} OidOf ('PGvararray (null ('PGenum labels))) where oidOf = LibPQ.invalidOid

508−

509−class OidOfParam (ty :: NullityType) where oidOfParam :: Oid

510−instance OidOf ty => OidOfParam (null ty) where oidOfParam = oidOf @ty

511−

512−-- | Lifts a `OidOf` constraint to a field.

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

514− oidOfField :: Oid

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

516− oidOfField = oidOf @ty

517−

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

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

392+class HasAliasedOid (field :: (Symbol, NullityType)) where

393+ aliasedOid :: Word32

394+instance HasOid ty => HasAliasedOid (alias ::: nullity ty) where

395+ aliasedOid = oid @ty

396+

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

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

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

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

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

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

526403

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.

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

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

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

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

535408

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

722590 Decoding.valueParser (fromValue @pg) bytestring

723591

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.

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

729593 fromFixArray :: Decoding.Array y

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

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

769633 = fmap fromRecord

770634 . hsequence'

771635 . htrans (Proxy @FromField) fromField

772−------------------------------------------------------

773−-- P records

774−------------------------------------------------------

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

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

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

778−-- instance

779−-- ( row ~ Join row1 row2

780−-- , FromRow row1 hask1

781−-- , FromRow row2 hask2

782−-- , SListI row

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

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

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

786−-- instance

787−-- ( row ~ Join row1 row23

788−-- , FromRow row1 hask1

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

790−-- , SListI row

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

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

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

794−-- hask1 <- fromRow row1

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

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

797−-- instance

798−-- ( row ~ Join row1 row234

799−-- , FromRow row1 hask1

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

801−-- , SListI row

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

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

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

805−-- hask1 <- fromRow row1

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

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

808−-- instance

809−-- ( row ~ Join row1 row2345

810−-- , FromRow row1 hask1

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

812−-- , SListI row

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

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

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

816−-- hask1 <- fromRow row1

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

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

636+instance (FromField (col ::: pg) (col ::: hask))

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

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

639+instance

640+ ( row ~ Join row1 row2

641+ , FromRow row1 hask1

642+ , FromRow row2 hask2

643+ , SListI row

644+ ) => FromRow row (hask1, hask2) where

645+ fromRow row = case disjoin @row1 @row2 row of

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

647+instance

648+ ( row ~ Join row1 row23

649+ , FromRow row1 hask1

650+ , FromRow row23 (hask2, hask3)

651+ , SListI row

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

653+ fromRow row = case disjoin @row1 @row23 row of

654+ (row1, row23) -> do

655+ hask1 <- fromRow row1

656+ (hask2, hask3) <- fromRow row23

657+ return (hask1, hask2, hask3)

658+instance

659+ ( row ~ Join row1 row234

660+ , FromRow row1 hask1

661+ , FromRow row234 (hask2, hask3, hask4)

662+ , SListI row

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

664+ fromRow row = case disjoin @row1 @row234 row of

665+ (row1, row234) -> do

666+ hask1 <- fromRow row1

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

668+ return (hask1, hask2, hask3, hask4)

669+instance

670+ ( row ~ Join row1 row2345

671+ , FromRow row1 hask1

672+ , FromRow row2345 (hask2, hask3, hask4, hask5)

673+ , SListI row

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

675+ fromRow row = case disjoin @row1 @row2345 row of

676+ (row1, row2345) -> do

677+ hask1 <- fromRow row1

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

679+ return (hask1, hask2, hask3, hask4, hask5)

819680

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

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

@@ -843,6 +704,3 @@ replicateMN

843704 => m x -> m (NP I xs)

844705replicateMN mx = hsequence' $

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

846−

847−getOid :: LibPQ.Oid -> Word32

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

squeal-postgresql/src/Squeal/PostgreSQL/Definition.hs+1016−12

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

1111{-# LANGUAGE

1212 AllowAmbiguousTypes

1313 , ConstraintKinds

14− , DeriveAnyClass

1514 , DeriveGeneric

16− , DerivingStrategies

1715 , FlexibleContexts

1816 , FlexibleInstances

1917 , GADTs

18+ , GeneralizedNewtypeDeriving

2019 , LambdaCase

2120 , MultiParamTypeClasses

22− , OverloadedLabels

2321 , OverloadedStrings

2422 , RankNTypes

2523 , ScopedTypeVariables

@@ -27,25 +25,83 @@ Squeal data definition language.

2725 , TypeInType

2826 , TypeOperators

2927 , UndecidableSuperClasses

30− , UndecidableInstances

3128#-}

3229

3330module Squeal.PostgreSQL.Definition

3431 ( -- * Definition

3532 Definition (..)

3633 , (>>>)

37− , manipDefinition

34+ -- * Tables

35+ -- ** Create

36+ , createSchema

37+ , createSchemaIfNotExists

38+ , createTable

39+ , createTableIfNotExists

40+ , createView

41+ , createTypeEnum

42+ , createTypeEnumFrom

43+ , createTypeComposite

44+ , createTypeCompositeFrom

45+ , createDomain

46+ , TableConstraintExpression (..)

47+ , check

48+ , unique

49+ , primaryKey

50+ , foreignKey

51+ , ForeignKeyed

52+ , OnDeleteClause (..)

53+ , OnUpdateClause (..)

54+ -- ** Drop

55+ , dropSchema

56+ , dropTable

57+ , dropView

58+ , dropType

59+ -- ** Alter

60+ , alterTable

61+ , alterTableRename

62+ , AlterTable (..)

63+ , addConstraint

64+ , dropConstraint

65+ , AddColumn (..)

66+ , dropColumn

67+ , renameColumn

68+ , alterColumn

69+ , AlterColumn (..)

70+ , setDefault

71+ , dropDefault

72+ , setNotNull

73+ , dropNotNull

74+ , alterType

75+ -- * Columns

76+ , ColumnTypeExpression (..)

77+ , nullable

78+ , notNullable

79+ , default_

80+ , serial2

81+ , smallserial

82+ , serial4

83+ , serial

84+ , serial8

85+ , bigserial

3886 ) where

3987

4088import Control.Category

4189import Control.DeepSeq

4290import Data.ByteString

4391import Data.Monoid

92+import GHC.TypeLits

4493import Prelude hiding ((.), id)

4594

95+import qualified Generics.SOP as SOP

4696import qualified GHC.Generics as GHC

4797

48−import Squeal.PostgreSQL.Manipulation

98+import Squeal.PostgreSQL.Alias

99+import Squeal.PostgreSQL.Expression

100+import Squeal.PostgreSQL.Expression.Logic

101+import Squeal.PostgreSQL.Expression.Type

102+import Squeal.PostgreSQL.List

103+import Squeal.PostgreSQL.PG

104+import Squeal.PostgreSQL.Query

49105import Squeal.PostgreSQL.Render

50106import Squeal.PostgreSQL.Schema

51107

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

73129 ddl1 . ddl0 = UnsafeDefinition $

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

75131

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

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

78−manipDefinition

79− :: Manipulation '[] schemas '[] '[]

80− -- ^ no input or output

132+{-----------------------------------------

133+CREATE statements

134+-----------------------------------------}

135+

136+createSchema

137+ :: KnownSymbol sch

138+ => Alias sch

139+ -> Definition schemas (Create sch '[] schemas)

140+createSchema sch = UnsafeDefinition $

141+ "CREATE" <+> "SCHEMA" <+> renderSQL sch <> ";"

142+

143+createSchemaIfNotExists

144+ :: (KnownSymbol sch, Has sch schemas schema)

145+ => Alias sch

81146 -> Definition schemas schemas

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

147+createSchemaIfNotExists sch = UnsafeDefinition $

148+ "CREATE" <+> "SCHEMA" <+> "IF" <+> "NOT" <+> "EXISTS"

149+ <+> renderSQL sch <> ";"

150+

151+{- | `createTable` adds a table to the schema.

152+

153+>>> :set -XOverloadedLabels

154+>>> :{

155+type Table = '[] :=>

156+ '[ "a" ::: 'NoDef :=> 'Null 'PGint4

157+ , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]

158+:}

159+

160+>>> :{

161+let

162+ setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table])

163+ setup = createTable #tab

164+ (nullable int `as` #a :* nullable real `as` #b) Nil

165+in printSQL setup

166+:}

167+CREATE TABLE "tab" ("a" int NULL, "b" real NULL);

168+-}

169+createTable

170+ :: ( KnownSymbol sch

171+ , KnownSymbol tab

172+ , columns ~ (col ': cols)

173+ , SOP.SListI columns

174+ , SOP.SListI constraints

175+ , Has sch schemas0 schema0

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

177+ => QualifiedAlias sch tab -- ^ the name of the table to add

178+ -> NP (Aliased (ColumnTypeExpression schemas0)) columns

179+ -- ^ the names and datatype of each column

180+ -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints

181+ -- ^ constraints that must hold for the table

182+ -> Definition schemas0 schemas1

183+createTable tab columns constraints = UnsafeDefinition $

184+ "CREATE TABLE" <+> renderCreation tab columns constraints

185+

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

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

188+`createTableIfNotExists` fixes this. Interestingly, this property makes it an idempotent in

189+the `Category` of `Definition`s.

190+

191+>>> :set -XOverloadedLabels -XTypeApplications

192+>>> :{

193+type Table = '[] :=>

194+ '[ "a" ::: 'NoDef :=> 'Null 'PGint4

195+ , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]

196+:}

197+

198+>>> type Schemas = Public '["tab" ::: 'Table Table]

199+

200+>>> :{

201+let

202+ setup :: Definition Schemas Schemas

203+ setup = createTableIfNotExists #tab

204+ (nullable int `as` #a :* nullable real `as` #b) Nil

205+in printSQL setup

206+:}

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

208+-}

209+createTableIfNotExists

210+ :: ( Has sch schemas schema

211+ , Has tab schema ('Table (constraints :=> columns))

212+ , SOP.SListI columns

213+ , SOP.SListI constraints )

214+ => QualifiedAlias sch tab -- ^ the name of the table to add

215+ -> NP (Aliased (ColumnTypeExpression schemas)) columns

216+ -- ^ the names and datatype of each column

217+ -> NP (Aliased (TableConstraintExpression sch tab schemas)) constraints

218+ -- ^ constraints that must hold for the table

219+ -> Definition schemas schemas

220+createTableIfNotExists tab columns constraints = UnsafeDefinition $

221+ "CREATE TABLE IF NOT EXISTS"

222+ <+> renderCreation tab columns constraints

223+

224+-- helper function for `createTable` and `createTableIfNotExists`

225+renderCreation

226+ :: ( KnownSymbol sch

227+ , KnownSymbol tab

228+ , SOP.SListI columns

229+ , SOP.SListI constraints )

230+ => QualifiedAlias sch tab -- ^ the name of the table to add

231+ -> NP (Aliased (ColumnTypeExpression schemas0)) columns

232+ -- ^ the names and datatype of each column

233+ -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints

234+ -- ^ constraints that must hold for the table

235+ -> ByteString

236+renderCreation tab columns constraints = renderSQL tab

237+ <+> parenthesized

238+ ( renderCommaSeparated renderColumnDef columns

239+ <> ( case constraints of

240+ Nil -> ""

241+ _ -> ", " <>

242+ renderCommaSeparated renderConstraint constraints ) )

243+ <> ";"

244+ where

245+ renderColumnDef :: Aliased (ColumnTypeExpression schemas) x -> ByteString

246+ renderColumnDef (ty `As` column) =

247+ renderSQL column <+> renderColumnTypeExpression ty

248+ renderConstraint

249+ :: Aliased (TableConstraintExpression sch tab schemas) constraint

250+ -> ByteString

251+ renderConstraint (constraint `As` alias) =

252+ "CONSTRAINT" <+> renderSQL alias <+> renderSQL constraint

253+

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

255+-- table. For many applications, however, the constraint they provide is

256+-- too coarse. For example, a column containing a product price should

257+-- probably only accept positive values. But there is no standard data type

258+-- that accepts only positive numbers. Another issue is that you might want

259+-- to constrain column data with respect to other columns or rows.

260+-- For example, in a table containing product information,

261+-- there should be only one row for each product number.

262+-- `TableConstraint`s give you as much control over the data in your tables

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

264+-- violate a constraint, an error is raised. This applies

265+-- even if the value came from the default value definition.

266+newtype TableConstraintExpression

267+ (sch :: Symbol)

268+ (tab :: Symbol)

269+ (schemas :: SchemasType)

270+ (constraint :: TableConstraint)

271+ = UnsafeTableConstraintExpression

272+ { renderTableConstraintExpression :: ByteString }

273+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

274+instance RenderSQL

275+ (TableConstraintExpression sch tab schemas constraint) where

276+ renderSQL = renderTableConstraintExpression

277+

278+{-| A `check` constraint is the most generic `TableConstraint` type.

279+It allows you to specify that the value in a certain column must satisfy

280+a Boolean (truth-value) expression.

281+

282+>>> :{

283+type Schema = '[

284+ "tab" ::: 'Table ('[ "inequality" ::: 'Check '["a","b"]] :=> '[

285+ "a" ::: 'NoDef :=> 'NotNull 'PGint4,

286+ "b" ::: 'NoDef :=> 'NotNull 'PGint4

287+ ])]

288+:}

289+

290+>>> :{

291+let

292+ definition :: Definition (Public '[]) (Public Schema)

293+ definition = createTable #tab

294+ ( (int & notNullable) `as` #a :*

295+ (int & notNullable) `as` #b )

296+ ( check (#a :* #b) (#a .> #b) `as` #inequality )

297+:}

298+

299+>>> printSQL definition

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

301+-}

302+check

303+ :: ( Has sch schemas schema

304+ , Has tab schema ('Table table)

305+ , HasAll aliases (TableToRow table) subcolumns )

306+ => NP Alias aliases

307+ -- ^ specify the subcolumns which are getting checked

308+ -> (forall t. Condition '[] '[] 'Ungrouped schemas '[] '[t ::: subcolumns])

309+ -- ^ a closed `Condition` on those subcolumns

310+ -> TableConstraintExpression sch tab schemas ('Check aliases)

311+check _cols condition = UnsafeTableConstraintExpression $

312+ "CHECK" <+> parenthesized (renderSQL condition)

313+

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

315+or a group of columns, is unique among all the rows in the table.

316+

317+>>> :{

318+type Schema = '[

319+ "tab" ::: 'Table( '[ "uq_a_b" ::: 'Unique '["a","b"]] :=> '[

320+ "a" ::: 'NoDef :=> 'Null 'PGint4,

321+ "b" ::: 'NoDef :=> 'Null 'PGint4

322+ ])]

323+:}

324+

325+>>> :{

326+let

327+ definition :: Definition (Public '[]) (Public Schema)

328+ definition = createTable #tab

329+ ( (int & nullable) `as` #a :*

330+ (int & nullable) `as` #b )

331+ ( unique (#a :* #b) `as` #uq_a_b )

332+:}

333+

334+>>> printSQL definition

335+CREATE TABLE "tab" ("a" int NULL, "b" int NULL, CONSTRAINT "uq_a_b" UNIQUE ("a", "b"));

336+-}

337+unique

338+ :: ( Has sch schemas schema

339+ , Has tab schema('Table table)

340+ , HasAll aliases (TableToRow table) subcolumns )

341+ => NP Alias aliases

342+ -- ^ specify subcolumns which together are unique for each row

343+ -> TableConstraintExpression sch tab schemas ('Unique aliases)

344+unique columns = UnsafeTableConstraintExpression $

345+ "UNIQUE" <+> parenthesized (renderSQL columns)

346+

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

348+can be used as a unique identifier for rows in the table.

349+This requires that the values be both unique and not null.

350+

351+>>> :{

352+type Schema = '[

353+ "tab" ::: 'Table ('[ "pk_id" ::: 'PrimaryKey '["id"]] :=> '[

354+ "id" ::: 'Def :=> 'NotNull 'PGint4,

355+ "name" ::: 'NoDef :=> 'NotNull 'PGtext

356+ ])]

357+:}

358+

359+>>> :{

360+let

361+ definition :: Definition (Public '[]) (Public Schema)

362+ definition = createTable #tab

363+ ( serial `as` #id :*

364+ (text & notNullable) `as` #name )

365+ ( primaryKey #id `as` #pk_id )

366+:}

367+

368+>>> printSQL definition

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

370+-}

371+primaryKey

372+ :: ( Has sch schemas schema

373+ , Has tab schema ('Table table)

374+ , HasAll aliases (TableToColumns table) subcolumns

375+ , AllNotNull subcolumns )

376+ => NP Alias aliases

377+ -- ^ specify the subcolumns which together form a primary key.

378+ -> TableConstraintExpression sch tab schemas ('PrimaryKey aliases)

379+primaryKey columns = UnsafeTableConstraintExpression $

380+ "PRIMARY KEY" <+> parenthesized (renderSQL columns)

381+

382+{-| A `foreignKey` specifies that the values in a column

383+(or a group of columns) must match the values appearing in some row of

384+another table. We say this maintains the referential integrity

385+between two related tables.

386+

387+>>> :{

388+type Schema =

389+ '[ "users" ::: 'Table (

390+ '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>

391+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4

392+ , "name" ::: 'NoDef :=> 'NotNull 'PGtext

393+ ])

394+ , "emails" ::: 'Table (

395+ '[ "pk_emails" ::: 'PrimaryKey '["id"]

396+ , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]

397+ ] :=>

398+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4

399+ , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4

400+ , "email" ::: 'NoDef :=> 'Null 'PGtext

401+ ])

402+ ]

403+:}

404+

405+>>> :{

406+let

407+ setup :: Definition (Public '[]) (Public Schema)

408+ setup =

409+ createTable #users

410+ ( serial `as` #id :*

411+ (text & notNullable) `as` #name )

412+ ( primaryKey #id `as` #pk_users ) >>>

413+ createTable #emails

414+ ( serial `as` #id :*

415+ (int & notNullable) `as` #user_id :*

416+ (text & nullable) `as` #email )

417+ ( primaryKey #id `as` #pk_emails :*

418+ foreignKey #user_id #users #id

419+ OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

420+in printSQL setup

421+:}

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

423+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);

424+

425+A `foreignKey` can even be a table self-reference.

426+

427+>>> :{

428+type Schema =

429+ '[ "employees" ::: 'Table (

430+ '[ "employees_pk" ::: 'PrimaryKey '["id"]

431+ , "employees_employer_fk" ::: 'ForeignKey '["employer_id"] "employees" '["id"]

432+ ] :=>

433+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4

434+ , "name" ::: 'NoDef :=> 'NotNull 'PGtext

435+ , "employer_id" ::: 'NoDef :=> 'Null 'PGint4

436+ ])

437+ ]

438+:}

439+

440+>>> :{

441+let

442+ setup :: Definition (Public '[]) (Public Schema)

443+ setup =

444+ createTable #employees

445+ ( serial `as` #id :*

446+ (text & notNullable) `as` #name :*

447+ (integer & nullable) `as` #employer_id )

448+ ( primaryKey #id `as` #employees_pk :*

449+ foreignKey #employer_id #employees #id

450+ OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )

451+in printSQL setup

452+:}

453+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);

454+-}

455+foreignKey

456+ :: (ForeignKeyed schemas sch schema child parent

457+ table reftable

458+ columns refcolumns

459+ constraints cols

460+ reftys tys )

461+ => NP Alias columns

462+ -- ^ column or columns in the table

463+ -> Alias parent

464+ -- ^ reference table

465+ -> NP Alias refcolumns

466+ -- ^ reference column or columns in the reference table

467+ -> OnDeleteClause

468+ -- ^ what to do when reference is deleted

469+ -> OnUpdateClause

470+ -- ^ what to do when reference is updated

471+ -> TableConstraintExpression sch child schemas

472+ ('ForeignKey columns parent refcolumns)

473+foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $

474+ "FOREIGN KEY" <+> parenthesized (renderSQL keys)

475+ <+> "REFERENCES" <+> renderSQL parent

476+ <+> parenthesized (renderSQL refs)

477+ <+> renderSQL ondel

478+ <+> renderSQL onupd

479+

480+-- | A constraint synonym between types involved in a foreign key constraint.

481+type ForeignKeyed schemas

482+ sch

483+ schema

484+ child parent

485+ table reftable

486+ columns refcolumns

487+ constraints cols

488+ reftys tys =

489+ ( Has sch schemas schema

490+ , Has child schema ('Table table)

491+ , Has parent schema ('Table reftable)

492+ , HasAll columns (TableToColumns table) tys

493+ , reftable ~ (constraints :=> cols)

494+ , HasAll refcolumns cols reftys

495+ , SOP.AllZip SamePGType tys reftys

496+ , Uniquely refcolumns constraints )

497+

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

499+data OnDeleteClause

500+ = OnDeleteNoAction

501+ -- ^ if any referencing rows still exist when the constraint is checked,

502+ -- an error is raised

503+ | OnDeleteRestrict -- ^ prevents deletion of a referenced row

504+ | OnDeleteCascade

505+ -- ^ specifies that when a referenced row is deleted,

506+ -- row(s) referencing it should be automatically deleted as well

507+ deriving (GHC.Generic,Show,Eq,Ord)

508+instance NFData OnDeleteClause

509+-- | Render `OnDeleteClause`.

510+instance RenderSQL OnDeleteClause where

511+ renderSQL = \case

512+ OnDeleteNoAction -> "ON DELETE NO ACTION"

513+ OnDeleteRestrict -> "ON DELETE RESTRICT"

514+ OnDeleteCascade -> "ON DELETE CASCADE"

515+

516+-- | Analagous to `OnDeleteClause` there is also `OnUpdateClause` which is invoked

517+-- when a referenced column is changed (updated).

518+data OnUpdateClause

519+ = OnUpdateNoAction

520+ -- ^ if any referencing rows has not changed when the constraint is checked,

521+ -- an error is raised

522+ | OnUpdateRestrict -- ^ prevents update of a referenced row

523+ | OnUpdateCascade

524+ -- ^ the updated values of the referenced column(s) should be copied

525+ -- into the referencing row(s)

526+ deriving (GHC.Generic,Show,Eq,Ord)

527+instance NFData OnUpdateClause

528+

529+-- | Render `OnUpdateClause`.

530+instance RenderSQL OnUpdateClause where

531+ renderSQL = \case

532+ OnUpdateNoAction -> "ON UPDATE NO ACTION"

533+ OnUpdateRestrict -> "ON UPDATE RESTRICT"

534+ OnUpdateCascade -> "ON UPDATE CASCADE"

535+

536+{-----------------------------------------

537+DROP statements

538+-----------------------------------------}

539+

540+-- >>> :{

541+-- let

542+-- definition :: Definition '["muh_schema" ::: schema, "public" ::: public] '["public" ::: public]

543+-- definition = dropSchema #muh_schema

544+-- :}

545+--

546+-- >>> printSQL definition

547+-- DROP SCHEMA "muh_schema";

548+dropSchema

549+ :: Has sch schemas schema

550+ => Alias sch

551+ -> Definition schemas (Drop sch schemas)

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

553+

554+-- | `dropTable` removes a table from the schema.

555+--

556+-- >>> :{

557+-- let

558+-- definition :: Definition '["public" ::: '["muh_table" ::: 'Table t]] (Public '[])

559+-- definition = dropTable #muh_table

560+-- :}

561+--

562+-- >>> printSQL definition

563+-- DROP TABLE "muh_table";

564+dropTable

565+ :: ( Has sch schemas schema

566+ , Has tab schema ('Table table))

567+ => QualifiedAlias sch tab -- ^ table to remove

568+ -> Definition schemas (Alter sch (Drop tab schema) schemas)

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

570+

571+{-----------------------------------------

572+ALTER statements

573+-----------------------------------------}

574+

575+-- | `alterTable` changes the definition of a table from the schema.

576+alterTable

577+ :: (Has sch schemas schema, Has tab schema ('Table table0))

578+ => QualifiedAlias sch tab -- ^ table to alter

579+ -> AlterTable sch tab schemas table1 -- ^ alteration to perform

580+ -> Definition schemas (Alter sch (Alter tab ('Table table1) schema) schemas)

581+alterTable tab alteration = UnsafeDefinition $

582+ "ALTER TABLE"

583+ <+> renderSQL tab

584+ <+> renderAlterTable alteration

585+ <> ";"

586+

587+-- | `alterTableRename` changes the name of a table from the schema.

588+--

589+-- >>> printSQL $ alterTableRename #foo #bar

590+-- ALTER TABLE "foo" RENAME TO "bar";

591+alterTableRename

592+ :: (KnownSymbol table0, KnownSymbol table1)

593+ => Alias table0 -- ^ table to rename

594+ -> Alias table1 -- ^ what to rename it

595+ -> Definition schema (Rename table0 table1 schema)

596+alterTableRename table0 table1 = UnsafeDefinition $

597+ "ALTER TABLE" <+> renderSQL table0

598+ <+> "RENAME TO" <+> renderSQL table1 <> ";"

599+

600+-- | An `AlterTable` describes the alteration to perform on the columns

601+-- of a table.

602+newtype AlterTable

603+ (sch :: Symbol)

604+ (tab :: Symbol)

605+ (schemas :: SchemasType)

606+ (table :: TableType) =

607+ UnsafeAlterTable {renderAlterTable :: ByteString}

608+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

609+

610+-- | An `addConstraint` adds a table constraint.

611+--

612+-- >>> :{

613+-- let

614+-- definition :: Definition

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

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

617+-- definition = alterTable #tab (addConstraint #positive (check #col (#col .> 0)))

618+-- in printSQL definition

619+-- :}

620+-- ALTER TABLE "tab" ADD CONSTRAINT "positive" CHECK (("col" > 0));

621+addConstraint

622+ :: ( KnownSymbol alias

623+ , Has sch schemas schema

624+ , Has tab schema ('Table table0)

625+ , table0 ~ (constraints :=> columns)

626+ , table1 ~ (Create alias constraint constraints :=> columns) )

627+ => Alias alias

628+ -> TableConstraintExpression sch tab schemas constraint

629+ -- ^ constraint to add

630+ -> AlterTable sch tab schemas table1

631+addConstraint alias constraint = UnsafeAlterTable $

632+ "ADD" <+> "CONSTRAINT" <+> renderSQL alias

633+ <+> renderSQL constraint

634+

635+-- | A `dropConstraint` drops a table constraint.

636+--

637+-- >>> :{

638+-- let

639+-- definition :: Definition

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

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

642+-- definition = alterTable #tab (dropConstraint #positive)

643+-- in printSQL definition

644+-- :}

645+-- ALTER TABLE "tab" DROP CONSTRAINT "positive";

646+dropConstraint

647+ :: ( KnownSymbol constraint

648+ , Has sch schemas schema

649+ , Has tab schema ('Table table0)

650+ , table0 ~ (constraints :=> columns)

651+ , table1 ~ (Drop constraint constraints :=> columns) )

652+ => Alias constraint

653+ -- ^ constraint to drop

654+ -> AlterTable sch tab schemas table1

655+dropConstraint constraint = UnsafeAlterTable $

656+ "DROP" <+> "CONSTRAINT" <+> renderSQL constraint

657+

658+-- | An `AddColumn` is either @NULL@ or has @DEFAULT@.

659+class AddColumn ty where

660+ -- | `addColumn` adds a new column, initially filled with whatever

661+ -- default value is given or with @NULL@.

662+ --

663+ -- >>> :{

664+ -- let

665+ -- definition :: Definition

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

667+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>

668+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

669+ -- , "col2" ::: 'Def :=> 'Null 'PGtext ])]]

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

671+ -- in printSQL definition

672+ -- :}

673+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL DEFAULT E'foo';

674+ --

675+ -- >>> :{

676+ -- let

677+ -- definition :: Definition

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

679+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>

680+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

681+ -- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

682+ -- definition = alterTable #tab (addColumn #col2 (text & nullable))

683+ -- in printSQL definition

684+ -- :}

685+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL;

686+ addColumn

687+ :: ( KnownSymbol column

688+ , Has sch schemas schema

689+ , Has tab schema ('Table table0)

690+ , table0 ~ (constraints :=> columns) )

691+ => Alias column -- ^ column to add

692+ -> ColumnTypeExpression schemas ty -- ^ type of the new column

693+ -> AlterTable sch tab schemas (constraints :=> Create column ty columns)

694+ addColumn column ty = UnsafeAlterTable $

695+ "ADD COLUMN" <+> renderSQL column <+> renderColumnTypeExpression ty

696+instance {-# OVERLAPPING #-} AddColumn ('Def :=> ty)

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

698+

699+-- | A `dropColumn` removes a column. Whatever data was in the column

700+-- disappears. Table constraints involving the column are dropped, too.

701+-- However, if the column is referenced by a foreign key constraint of

702+-- another table, PostgreSQL will not silently drop that constraint.

703+--

704+-- >>> :{

705+-- let

706+-- definition :: Definition

707+-- '["public" ::: '["tab" ::: 'Table ('[] :=>

708+-- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

709+-- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

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

711+-- definition = alterTable #tab (dropColumn #col2)

712+-- in printSQL definition

713+-- :}

714+-- ALTER TABLE "tab" DROP COLUMN "col2";

715+dropColumn

716+ :: ( KnownSymbol column

717+ , Has sch schemas schema

718+ , Has tab schema ('Table table0)

719+ , table0 ~ (constraints :=> columns)

720+ , table1 ~ (constraints :=> Drop column columns) )

721+ => Alias column -- ^ column to remove

722+ -> AlterTable sch tab schemas table1

723+dropColumn column = UnsafeAlterTable $

724+ "DROP COLUMN" <+> renderSQL column

725+

726+-- | A `renameColumn` renames a column.

727+--

728+-- >>> :{

729+-- let

730+-- definition :: Definition

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

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

733+-- definition = alterTable #tab (renameColumn #foo #bar)

734+-- in printSQL definition

735+-- :}

736+-- ALTER TABLE "tab" RENAME COLUMN "foo" TO "bar";

737+renameColumn

738+ :: ( KnownSymbol column0

739+ , KnownSymbol column1

740+ , Has sch schemas schema

741+ , Has tab schema ('Table table0)

742+ , table0 ~ (constraints :=> columns)

743+ , table1 ~ (constraints :=> Rename column0 column1 columns) )

744+ => Alias column0 -- ^ column to rename

745+ -> Alias column1 -- ^ what to rename the column

746+ -> AlterTable sch tab schemas table1

747+renameColumn column0 column1 = UnsafeAlterTable $

748+ "RENAME COLUMN" <+> renderSQL column0 <+> "TO" <+> renderSQL column1

749+

750+-- | An `alterColumn` alters a single column.

751+alterColumn

752+ :: ( KnownSymbol column

753+ , Has sch schemas schema

754+ , Has tab schema ('Table table0)

755+ , table0 ~ (constraints :=> columns)

756+ , Has column columns ty0

757+ , table1 ~ (constraints :=> Alter column ty1 columns))

758+ => Alias column -- ^ column to alter

759+ -> AlterColumn schemas ty0 ty1 -- ^ alteration to perform

760+ -> AlterTable sch tab schemas table1

761+alterColumn column alteration = UnsafeAlterTable $

762+ "ALTER COLUMN" <+> renderSQL column <+> renderAlterColumn alteration

763+

764+-- | An `AlterColumn` describes the alteration to perform on a single column.

765+newtype AlterColumn (schemas :: SchemasType) (ty0 :: ColumnType) (ty1 :: ColumnType) =

766+ UnsafeAlterColumn {renderAlterColumn :: ByteString}

767+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

768+

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

770+-- affect any existing rows in the table, it just changes the default for

771+-- future insert and update commands.

772+--

773+-- >>> :{

774+-- let

775+-- definition :: Definition

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

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

778+-- definition = alterTable #tab (alterColumn #col (setDefault 5))

779+-- in printSQL definition

780+-- :}

781+-- ALTER TABLE "tab" ALTER COLUMN "col" SET DEFAULT 5;

782+setDefault

783+ :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty -- ^ default value to set

784+ -> AlterColumn schemas (constraint :=> ty) ('Def :=> ty)

785+setDefault expression = UnsafeAlterColumn $

786+ "SET DEFAULT" <+> renderExpression expression

787+

788+-- | A `dropDefault` removes any default value for a column.

789+--

790+-- >>> :{

791+-- let

792+-- definition :: Definition

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

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

795+-- definition = alterTable #tab (alterColumn #col dropDefault)

796+-- in printSQL definition

797+-- :}

798+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP DEFAULT;

799+dropDefault :: AlterColumn schemas ('Def :=> ty) ('NoDef :=> ty)

800+dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"

801+

802+-- | A `setNotNull` adds a @NOT NULL@ constraint to a column.

803+-- The constraint will be checked immediately, so the table data must satisfy

804+-- the constraint before it can be added.

805+--

806+-- >>> :{

807+-- let

808+-- definition :: Definition

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

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

811+-- definition = alterTable #tab (alterColumn #col setNotNull)

812+-- in printSQL definition

813+-- :}

814+-- ALTER TABLE "tab" ALTER COLUMN "col" SET NOT NULL;

815+setNotNull

816+ :: AlterColumn schemas (constraint :=> 'Null ty) (constraint :=> 'NotNull ty)

817+setNotNull = UnsafeAlterColumn $ "SET NOT NULL"

818+

819+-- | A `dropNotNull` drops a @NOT NULL@ constraint from a column.

820+--

821+-- >>> :{

822+-- let

823+-- definition :: Definition

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

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

826+-- definition = alterTable #tab (alterColumn #col dropNotNull)

827+-- in printSQL definition

828+-- :}

829+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP NOT NULL;

830+dropNotNull

831+ :: AlterColumn schemas (constraint :=> 'NotNull ty) (constraint :=> 'Null ty)

832+dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"

833+

834+-- | An `alterType` converts a column to a different data type.

835+-- This will succeed only if each existing entry in the column can be

836+-- converted to the new type by an implicit cast.

837+--

838+-- >>> :{

839+-- let

840+-- definition :: Definition

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

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

843+-- definition =

844+-- alterTable #tab (alterColumn #col (alterType (numeric & notNullable)))

845+-- in printSQL definition

846+-- :}

847+-- ALTER TABLE "tab" ALTER COLUMN "col" TYPE numeric NOT NULL;

848+alterType :: ColumnTypeExpression schemas ty -> AlterColumn schemas ty0 ty

849+alterType ty = UnsafeAlterColumn $ "TYPE" <+> renderColumnTypeExpression ty

850+

851+{- | Create a view.

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

853+>>> type BC = '["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4]

854+>>> :{

855+let

856+ definition :: Definition

857+ '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC)]]

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

859+ definition =

860+ createView #bc (select_ (#b :* #c) (from (table #abc)))

861+in printSQL definition

862+:}

863+CREATE VIEW "bc" AS SELECT "b" AS "b", "c" AS "c" FROM "abc" AS "abc";

864+-}

865+createView

866+ :: (KnownSymbol sch, KnownSymbol vw, Has sch schemas schema)

867+ => QualifiedAlias sch vw -- ^ the name of the view to add

868+ -> Query '[] '[] schemas '[] view -- ^ query

869+ -> Definition schemas (Alter sch (Create vw ('View view) schema) schemas)

870+createView alias query = UnsafeDefinition $

871+ "CREATE" <+> "VIEW" <+> renderSQL alias <+> "AS"

872+ <+> renderQuery query <> ";"

873+

874+-- | Drop a view.

875+--

876+-- >>> :{

877+-- let

878+-- definition :: Definition

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

880+-- , "bc" ::: 'View ('["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4])]]

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

882+-- definition = dropView #bc

883+-- in printSQL definition

884+-- :}

885+-- DROP VIEW "bc";

886+dropView

887+ :: (Has sch schemas schema, Has vw schema ('View view))

888+ => QualifiedAlias sch vw -- ^ view to remove

889+ -> Definition schemas (Alter sch (Drop vw schema) schemas)

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

891+

892+-- | Enumerated types are created using the `createTypeEnum` command, for example

893+--

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

895+-- CREATE TYPE "mood" AS ENUM ('sad', 'ok', 'happy');

896+createTypeEnum

897+ :: (KnownSymbol enum, Has sch schemas schema, SOP.All KnownSymbol labels)

898+ => QualifiedAlias sch enum

899+ -- ^ name of the user defined enumerated type

900+ -> NP PGlabel labels

901+ -- ^ labels of the enumerated type

902+ -> Definition schemas (Alter sch (Create enum ('Typedef ('PGenum labels)) schema) schemas)

903+createTypeEnum enum labels = UnsafeDefinition $

904+ "CREATE" <+> "TYPE" <+> renderSQL enum <+> "AS" <+> "ENUM" <+>

905+ parenthesized (renderSQL labels) <> ";"

906+

907+-- | Enumerated types can also be generated from a Haskell type, for example

908+--

909+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

910+-- >>> instance SOP.Generic Schwarma

911+-- >>> instance SOP.HasDatatypeInfo Schwarma

912+-- >>> :{

913+-- let

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

915+-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma

916+-- in

917+-- printSQL createSchwarma

918+-- :}

919+-- CREATE TYPE "schwarma" AS ENUM ('Beef', 'Lamb', 'Chicken');

920+createTypeEnumFrom

921+ :: forall hask sch enum schemas schema.

922+ ( SOP.Generic hask

923+ , SOP.All KnownSymbol (LabelsPG hask)

924+ , KnownSymbol enum

925+ , Has sch schemas schema )

926+ => QualifiedAlias sch enum

927+ -- ^ name of the user defined enumerated type

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

929+createTypeEnumFrom enum = createTypeEnum enum

930+ (SOP.hpure label :: NP PGlabel (LabelsPG hask))

931+

932+{- | `createTypeComposite` creates a composite type. The composite type is

933+specified by a list of attribute names and data types.

934+

935+>>> :{

936+type PGcomplex = 'PGcomposite

937+ '[ "real" ::: 'NotNull 'PGfloat8

938+ , "imaginary" ::: 'NotNull 'PGfloat8 ]

939+:}

940+

941+>>> :{

942+let

943+ setup :: Definition (Public '[]) '["public" ::: '["complex" ::: 'Typedef PGcomplex]]

944+ setup = createTypeComposite #complex

945+ (float8 `as` #real :* float8 `as` #imaginary)

946+in printSQL setup

947+:}

948+CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

949+-}

950+createTypeComposite

951+ :: (KnownSymbol ty, Has sch schemas schema, SOP.SListI fields)

952+ => QualifiedAlias sch ty

953+ -- ^ name of the user defined composite type

954+ -> NP (Aliased (TypeExpression schemas)) fields

955+ -- ^ list of attribute names and data types

956+ -> Definition schemas (Alter sch (Create ty ('Typedef ('PGcomposite fields)) schema) schemas)

957+createTypeComposite ty fields = UnsafeDefinition $

958+ "CREATE" <+> "TYPE" <+> renderSQL ty <+> "AS" <+> parenthesized

959+ (renderCommaSeparated renderField fields) <> ";"

960+ where

961+ renderField :: Aliased (TypeExpression schemas) x -> ByteString

962+ renderField (typ `As` alias) =

963+ renderSQL alias <+> renderSQL typ

964+

965+-- | Composite types can also be generated from a Haskell type, for example

966+--

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

968+-- >>> instance SOP.Generic Complex

969+-- >>> instance SOP.HasDatatypeInfo Complex

970+-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]

971+-- >>> :{

972+-- let

973+-- createComplex :: Definition (Public '[]) (Public Schema)

974+-- createComplex = createTypeCompositeFrom @Complex #complex

975+-- in

976+-- printSQL createComplex

977+-- :}

978+-- CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

979+createTypeCompositeFrom

980+ :: forall hask sch ty schemas schema.

981+ ( SOP.All (FieldTyped schemas) (RowPG hask)

982+ , KnownSymbol ty

983+ , Has sch schemas schema )

984+ => QualifiedAlias sch ty

985+ -- ^ name of the user defined composite type

986+ -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)

987+createTypeCompositeFrom ty = createTypeComposite ty

988+ (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype

989+ :: NP (Aliased (TypeExpression schemas)) (RowPG hask))

990+

991+{-|

992+`createDomain` creates a new domain. A domain is essentially a data type

993+with constraints (restrictions on the allowed set of values).

994+

995+Domains are useful for abstracting common constraints on fields

996+into a single location for maintenance. For example, several tables might

997+contain email address columns, all requiring the same `check` constraint

998+to verify the address syntax. Define a domain rather than setting up

999+each table's constraint individually.

1000+

1001+>>> :{

1002+let

1003+ createPositive :: Definition (Public '[]) (Public '["positive" ::: 'Typedef 'PGfloat4])

1004+ createPositive = createDomain #positive real (#value .> 0 .&& (#value & isNotNull))

1005+in printSQL createPositive

1006+:}

1007+CREATE DOMAIN "positive" AS real CHECK ((("value" > 0) AND "value" IS NOT NULL));

1008+-}

1009+createDomain

1010+ :: (Has sch schemas schema, KnownSymbol dom)

1011+ => QualifiedAlias sch dom

1012+ -> (forall nullity. TypeExpression schemas (nullity ty))

1013+ -> (forall tab. Condition '[] '[] 'Ungrouped schemas '[] '[tab ::: '["value" ::: 'Null ty]])

1014+ -> Definition schemas (Alter sch (Create alias ('Typedef ty) schema) schemas)

1015+createDomain dom ty condition =

1016+ UnsafeDefinition $ "CREATE DOMAIN" <+> renderSQL dom

1017+ <+> "AS" <+> renderTypeExpression ty

1018+ <+> "CHECK" <+> parenthesized (renderSQL condition) <> ";"

1019+

1020+class FieldTyped schemas ty where

1021+ fieldtype :: Aliased (TypeExpression schemas) ty

1022+instance (KnownSymbol alias, PGTyped schemas ty)

1023+ => FieldTyped schemas (alias ::: ty) where

1024+ fieldtype = pgtype `As` Alias

1025+

1026+-- | Drop a type.

1027+--

1028+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

1029+-- >>> instance SOP.Generic Schwarma

1030+-- >>> instance SOP.HasDatatypeInfo Schwarma

1031+-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))

1032+-- DROP TYPE "schwarma";

1033+dropType

1034+ :: (Has sch schemas schema, Has td schema ('Typedef ty))

1035+ => QualifiedAlias sch td

1036+ -- ^ name of the user defined type

1037+ -> Definition schemas (Alter sch (Drop td schema) schemas)

1038+dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

1039+

1040+-- | `ColumnTypeExpression`s are used in `createTable` commands.

1041+newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)

1042+ = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }

1043+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

1044+instance RenderSQL (ColumnTypeExpression schemas ty) where

1045+ renderSQL = renderColumnTypeExpression

1046+

1047+-- | used in `createTable` commands as a column constraint to note that

1048+-- @NULL@ may be present in a column

1049+nullable

1050+ :: TypeExpression schemas (nullity ty)

1051+ -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)

1052+nullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NULL"

1053+

1054+-- | used in `createTable` commands as a column constraint to ensure

1055+-- @NULL@ is not present in a column

1056+notNullable

1057+ :: TypeExpression schemas (nullity ty)

1058+ -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)

1059+notNullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NOT NULL"

1060+

1061+-- | used in `createTable` commands as a column constraint to give a default

1062+default_

1063+ :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty

1064+ -> ColumnTypeExpression schemas ('NoDef :=> ty)

1065+ -> ColumnTypeExpression schemas ('Def :=> ty)

1066+default_ x ty = UnsafeColumnTypeExpression $

1067+ renderSQL ty <+> "DEFAULT" <+> renderExpression x

1068+

1069+-- | not a true type, but merely a notational convenience for creating

1070+-- unique identifier columns with type `PGint2`

1071+serial2, smallserial

1072+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)

1073+serial2 = UnsafeColumnTypeExpression "serial2"

1074+smallserial = UnsafeColumnTypeExpression "smallserial"

1075+-- | not a true type, but merely a notational convenience for creating

1076+-- unique identifier columns with type `PGint4`

1077+serial4, serial

1078+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)

1079+serial4 = UnsafeColumnTypeExpression "serial4"

1080+serial = UnsafeColumnTypeExpression "serial"

1081+-- | not a true type, but merely a notational convenience for creating

1082+-- unique identifier columns with type `PGint8`

1083+serial8, bigserial

1084+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)

1085+serial8 = UnsafeColumnTypeExpression "serial8"

1086+bigserial = UnsafeColumnTypeExpression "bigserial"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Function.hsdeleted−238

@@ -1,238 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Function

3−Description: Create and drop function and operator definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop function and operator definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Function

33− ( createFunction

34− , createOrReplaceFunction

35− , createSetFunction

36− , createOrReplaceSetFunction

37− , createBinaryOp

38− , createLeftOp

39− , createRightOp

40− , dropFunction

41− , dropFunctionIfExists

42− , dropOperator

43− , dropOperatorIfExists

44− , FunctionDefinition(..)

45− , languageSqlExpr

46− , languageSqlQuery

47− ) where

48−

49−import Control.DeepSeq

50−import Data.ByteString

51−import GHC.TypeLits

52−

53−import qualified Generics.SOP as SOP

54−import qualified GHC.Generics as GHC

55−

56−import Squeal.PostgreSQL.Alias

57−import Squeal.PostgreSQL.Definition

58−import Squeal.PostgreSQL.Expression

59−import Squeal.PostgreSQL.Expression.Type

60−import Squeal.PostgreSQL.List

61−import Squeal.PostgreSQL.Query

62−import Squeal.PostgreSQL.Render

63−import Squeal.PostgreSQL.Schema

64−

65−-- $setup

66−-- >>> import Squeal.PostgreSQL

67−

68−createFunction

69− :: ( Has sch schemas schema

70− , KnownSymbol fun

71− , SOP.SListI args )

72− => QualifiedAlias sch fun

73− -> NP (TypeExpression schemas) args

74− -> TypeExpression schemas ret

75− -> FunctionDefinition schemas args ('Returns ret)

76− -> Definition schemas (Alter sch (Create fun ('Function (args :=> 'Returns ret)) schema) schemas)

77−createFunction fun args ret fundef = UnsafeDefinition $

78− "CREATE" <+> "FUNCTION" <+> renderSQL fun

79− <+> parenthesized (renderCommaSeparated renderSQL args)

80− <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"

81−

82−createOrReplaceFunction

83− :: ( Has sch schemas schema

84− , KnownSymbol fun

85− , SOP.SListI args )

86− => QualifiedAlias sch fun

87− -> NP (TypeExpression schemas) args

88− -> TypeExpression schemas ret

89− -> FunctionDefinition schemas args ('Returns ret)

90− -> Definition schemas (Alter sch (CreateOrReplace fun ('Function (args :=> 'Returns ret)) schema) schemas)

91−createOrReplaceFunction fun args ret fundef = UnsafeDefinition $

92− "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun

93− <+> parenthesized (renderCommaSeparated renderSQL args)

94− <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"

95−

96−languageSqlExpr

97− :: Expression '[] '[] 'Ungrouped schemas args '[] ret

98− -> FunctionDefinition schemas args ('Returns ret)

99−languageSqlExpr expr = UnsafeFunctionDefinition $

100− "language sql as"

101− <+> "$$" <+> renderSQL (values_ (expr `as` #ret)) <+> "$$"

102−

103−languageSqlQuery

104− :: Query '[] '[] schemas args rets

105− -> FunctionDefinition schemas args ('ReturnsTable rets)

106−languageSqlQuery qry = UnsafeFunctionDefinition $

107− "language sql as" <+> "$$" <+> renderSQL qry <+> "$$"

108−

109−createSetFunction

110− :: ( Has sch schemas schema

111− , KnownSymbol fun

112− , SOP.SListI args

113− , SOP.SListI rets )

114− => QualifiedAlias sch fun

115− -> NP (TypeExpression schemas) args

116− -> NP (Aliased (TypeExpression schemas)) rets

117− -> FunctionDefinition schemas args ('ReturnsTable rets)

118− -> Definition schemas (Alter sch (Create fun ('Function (args :=> 'ReturnsTable rets)) schema) schemas)

119−createSetFunction fun args rets fundef = UnsafeDefinition $

120− "CREATE" <+> "FUNCTION" <+> renderSQL fun

121− <+> parenthesized (renderCommaSeparated renderSQL args)

122− <+> "RETURNS" <+> "TABLE"

123− <+> parenthesized (renderCommaSeparated renderRet rets)

124− <+> renderSQL fundef <> ";"

125− where

126− renderRet :: Aliased (TypeExpression s) r -> ByteString

127− renderRet (ty `As` col) = renderSQL col <+> renderSQL ty

128−

129−createOrReplaceSetFunction

130− :: ( Has sch schemas schema

131− , KnownSymbol fun

132− , SOP.SListI args

133− , SOP.SListI rets )

134− => QualifiedAlias sch fun

135− -> NP (TypeExpression schemas) args

136− -> NP (Aliased (TypeExpression schemas)) rets

137− -> FunctionDefinition schemas args ('ReturnsTable rets)

138− -> Definition schemas (Alter sch (CreateOrReplace fun ('Function (args :=> 'ReturnsTable rets)) schema) schemas)

139−createOrReplaceSetFunction fun args rets fundef = UnsafeDefinition $

140− "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun

141− <+> parenthesized (renderCommaSeparated renderSQL args)

142− <+> "RETURNS" <+> "TABLE"

143− <+> parenthesized (renderCommaSeparated renderRet rets)

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

145− where

146− renderRet :: Aliased (TypeExpression s) r -> ByteString

147− renderRet (ty `As` col) = renderSQL col <+> renderSQL ty

148−

149−createBinaryOp

150− :: forall op fun sch schemas schema x y z.

151− ( Has sch schemas schema

152− , Has fun schema ('Function ('[x,y] :=> 'Returns z))

153− , KnownSymbol op )

154− => QualifiedAlias sch fun

155− -> TypeExpression schemas x

156− -> TypeExpression schemas y

157− -> Definition schemas

158− (Alter sch (Create op ('Operator ('BinaryOp x y z)) schema) schemas)

159−createBinaryOp fun x y = UnsafeDefinition $

160− "CREATE" <+> "OPERATOR" <+> renderSymbol @op

161− <+> parenthesized (commaSeparated opdef)

162− where

163− opdef =

164− [ "FUNCTION" <+> "=" <+> renderSQL fun

165− , "LEFTARG" <+> "=" <+> renderSQL x

166− , "RIGHTARG" <+> "=" <+> renderSQL y ]

167−

168−createLeftOp

169− :: forall op fun sch schemas schema x y.

170− ( Has sch schemas schema

171− , Has fun schema ('Function ('[x] :=> 'Returns y))

172− , KnownSymbol op )

173− => QualifiedAlias sch fun

174− -> TypeExpression schemas x

175− -> Definition schemas

176− (Alter sch (Create op ('Operator ('LeftOp x y)) schema) schemas)

177−createLeftOp fun x = UnsafeDefinition $

178− "CREATE" <+> "OPERATOR" <+> renderSymbol @op

179− <+> parenthesized (commaSeparated opdef)

180− where

181− opdef =

182− [ "FUNCTION" <+> "=" <+> renderSQL fun

183− , "RIGHTARG" <+> "=" <+> renderSQL x ]

184−

185−createRightOp

186− :: forall op fun sch schemas schema x y.

187− ( Has sch schemas schema

188− , Has fun schema ('Function ('[x] :=> 'Returns y))

189− , KnownSymbol op )

190− => QualifiedAlias sch fun

191− -> TypeExpression schemas x

192− -> Definition schemas

193− (Alter sch (Create op ('Operator ('RightOp x y)) schema) schemas)

194−createRightOp fun x = UnsafeDefinition $

195− "CREATE" <+> "OPERATOR" <+> renderSymbol @op

196− <+> parenthesized (commaSeparated opdef)

197− where

198− opdef =

199− [ "FUNCTION" <+> "=" <+> renderSQL fun

200− , "LEFTARG" <+> "=" <+> renderSQL x ]

201−

202−dropFunction

203− :: (Has sch schemas schema, KnownSymbol fun)

204− => QualifiedAlias sch fun

205− -- ^ name of the user defined function

206− -> Definition schemas (Alter sch (DropSchemum fun 'Function schema) schemas)

207−dropFunction fun = UnsafeDefinition $

208− "DROP" <+> "FUNCTION" <+> renderSQL fun <> ";"

209−

210−dropFunctionIfExists

211− :: (Has sch schemas schema, KnownSymbol fun)

212− => QualifiedAlias sch fun

213− -- ^ name of the user defined function

214− -> Definition schemas (Alter sch (DropSchemumIfExists fun 'Function schema) schemas)

215−dropFunctionIfExists fun = UnsafeDefinition $

216− "DROP FUNCTION IF EXISTS" <+> renderSQL fun <> ";"

217−

218−dropOperator

219− :: (Has sch schemas schema, KnownSymbol op)

220− => QualifiedAlias sch op

221− -- ^ name of the user defined operator

222− -> Definition schemas (Alter sch (DropSchemum op 'Operator schema) schemas)

223−dropOperator op = UnsafeDefinition $

224− "DROP" <+> "OPERATOR" <+> renderSQL op <> ";"

225−

226−dropOperatorIfExists

227− :: (Has sch schemas schema, KnownSymbol op)

228− => QualifiedAlias sch op

229− -- ^ name of the user defined operator

230− -> Definition schemas (Alter sch (DropSchemumIfExists op 'Operator schema) schemas)

231−dropOperatorIfExists op = UnsafeDefinition $

232− "DROP OPERATOR IF EXISTS" <+> renderSQL op <> ";"

233−

234−newtype FunctionDefinition schemas args ret = UnsafeFunctionDefinition

235− { renderFunctionDefinition :: ByteString }

236− deriving (Eq,Show,GHC.Generic,NFData)

237−instance RenderSQL (FunctionDefinition schemas args ret) where

238− renderSQL = renderFunctionDefinition

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Index.hsdeleted−159

@@ -1,159 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Index

3−Description: Create and drop index definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop index definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Index

33− ( createIndex

34− , createIndexIfNotExists

35− , dropIndex

36− , dropIndexIfExists

37− , IndexMethod (..)

38− , btree

39− , hash

40− , gist

41− , spgist

42− , gin

43− , brin

44− ) where

45−

46−import Data.ByteString

47−import GHC.TypeLits

48−

49−import qualified GHC.Generics as GHC

50−

51−import Squeal.PostgreSQL.Alias

52−import Squeal.PostgreSQL.Definition

53−import Squeal.PostgreSQL.Expression.Sort

54−import Squeal.PostgreSQL.Render

55−import Squeal.PostgreSQL.Schema

56−

57−-- $setup

58−-- >>> import Squeal.PostgreSQL

59−

60−{- |

61−>>> :{

62−type Table = '[] :=>

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

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

65−:}

66−

67−>>> :{

68−let

69− setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table, "ix" ::: 'Index 'Btree])

70− setup =

71− createTable #tab (nullable int `as` #a :* nullable real `as` #b) Nil >>>

72− createIndex #ix #tab btree [#a & AscNullsFirst, #b & AscNullsLast]

73−in printSQL setup

74−:}

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

76−CREATE INDEX "ix" ON "tab" USING btree (("a") ASC NULLS FIRST, ("b") ASC NULLS LAST);

77−-}

78−createIndex

79− :: (Has sch schemas schema, Has tab schema ('Table table), KnownSymbol ix)

80− => Alias ix

81− -> QualifiedAlias sch tab

82− -> IndexMethod method

83− -> [SortExpression '[] '[] 'Ungrouped schemas '[] '[tab ::: TableToRow table]]

84− -> Definition schemas (Alter sch (Create ix ('Index method) schema) schemas)

85−createIndex ix tab method cols = UnsafeDefinition $

86− "CREATE" <+> "INDEX" <+> renderSQL ix <+> "ON" <+> renderSQL tab

87− <+> "USING" <+> renderSQL method

88− <+> parenthesized (commaSeparated (renderIndex <$> cols))

89− <> ";"

90− where

91− renderIndex = \case

92− Asc expression -> parenthesized (renderSQL expression) <+> "ASC"

93− Desc expression -> parenthesized (renderSQL expression) <+> "DESC"

94− AscNullsFirst expression -> parenthesized (renderSQL expression)

95− <+> "ASC NULLS FIRST"

96− DescNullsFirst expression -> parenthesized (renderSQL expression)

97− <+> "DESC NULLS FIRST"

98− AscNullsLast expression -> parenthesized (renderSQL expression)

99− <+> "ASC NULLS LAST"

100− DescNullsLast expression -> parenthesized (renderSQL expression)

101− <+> "DESC NULLS LAST"

102−

103−createIndexIfNotExists

104− :: (Has sch schemas schema, Has tab schema ('Table table), KnownSymbol ix)

105− => Alias ix

106− -> QualifiedAlias sch tab

107− -> IndexMethod method

108− -> [SortExpression '[] '[] 'Ungrouped schemas '[] '[tab ::: TableToRow table]]

109− -> Definition schemas (Alter sch (CreateIfNotExists ix ('Index method) schema) schemas)

110−createIndexIfNotExists ix tab method cols = UnsafeDefinition $

111− "CREATE INDEX IF NOT EXISTS" <+> renderSQL ix <+> "ON" <+> renderSQL tab

112− <+> "USING" <+> renderSQL method

113− <+> parenthesized (commaSeparated (renderIndex <$> cols))

114− <> ";"

115− where

116− renderIndex = \case

117− Asc expression -> parenthesized (renderSQL expression) <+> "ASC"

118− Desc expression -> parenthesized (renderSQL expression) <+> "DESC"

119− AscNullsFirst expression -> parenthesized (renderSQL expression)

120− <+> "ASC NULLS FIRST"

121− DescNullsFirst expression -> parenthesized (renderSQL expression)

122− <+> "DESC NULLS FIRST"

123− AscNullsLast expression -> parenthesized (renderSQL expression)

124− <+> "ASC NULLS LAST"

125− DescNullsLast expression -> parenthesized (renderSQL expression)

126− <+> "DESC NULLS LAST"

127−

128−newtype IndexMethod ty = UnsafeIndexMethod {renderIndexMethod :: ByteString}

129− deriving stock (Eq, Ord, Show, GHC.Generic)

130−instance RenderSQL (IndexMethod ty) where renderSQL = renderIndexMethod

131−btree :: IndexMethod 'Btree

132−btree = UnsafeIndexMethod "btree"

133−hash :: IndexMethod 'Hash

134−hash = UnsafeIndexMethod "hash"

135−gist :: IndexMethod 'Gist

136−gist = UnsafeIndexMethod "gist"

137−spgist :: IndexMethod 'Spgist

138−spgist = UnsafeIndexMethod "spgist"

139−gin :: IndexMethod 'Gin

140−gin = UnsafeIndexMethod "gin"

141−brin :: IndexMethod 'Brin

142−brin = UnsafeIndexMethod "brin"

143−

144−-- |

145−-- >>> printSQL (dropIndex #ix :: Definition (Public '["ix" ::: 'Index 'Btree]) (Public '[]))

146−-- DROP INDEX "ix";

147−dropIndex

148− :: (Has sch schemas schema, KnownSymbol ix)

149− => QualifiedAlias sch ix

150− -- ^ name of the user defined index

151− -> Definition schemas (Alter sch (DropSchemum ix 'Index schema) schemas)

152−dropIndex ix = UnsafeDefinition $ "DROP" <+> "INDEX" <+> renderSQL ix <> ";"

153−

154−dropIndexIfExists

155− :: (Has sch schemas schema, KnownSymbol ix)

156− => QualifiedAlias sch ix

157− -- ^ name of the user defined index

158− -> Definition schemas (Alter sch (DropSchemumIfExists ix 'Index schema) schemas)

159−dropIndexIfExists ix = UnsafeDefinition $ "DROP INDEX IF EXISTS" <+> renderSQL ix <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Schema.hsdeleted−96

@@ -1,96 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Schema

3−Description: Create and drop schema definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop schema definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Schema

33− ( createSchema

34− , createSchemaIfNotExists

35− , dropSchema

36− , dropSchemaIfExists

37− ) where

38−

39−import GHC.TypeLits

40−

41−import Squeal.PostgreSQL.Alias

42−import Squeal.PostgreSQL.Definition

43−import Squeal.PostgreSQL.Render

44−import Squeal.PostgreSQL.Schema

45−

46−-- $setup

47−-- >>> import Squeal.PostgreSQL

48−

49−{- |

50−`createSchema` enters a new schema into the current database.

51−The schema name must be distinct from the name of any existing schema

52−in the current database.

53−

54−A schema is essentially a namespace: it contains named objects

55−(tables, data types, functions, and operators) whose names

56−can duplicate those of other objects existing in other schemas.

57−Named objects are accessed by `QualifiedAlias`es with the schema

58−name as a prefix.

59−-}

60−createSchema

61− :: KnownSymbol sch

62− => Alias sch

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

64−createSchema sch = UnsafeDefinition $

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

66−

67−{- | Idempotent version of `createSchema`. -}

68−createSchemaIfNotExists

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

70− => Alias sch

71− -> Definition schemas (CreateIfNotExists sch '[] schemas)

72−createSchemaIfNotExists sch = UnsafeDefinition $

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

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

75−

76−-- | >>> :{

77−-- let

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

79−-- definition = dropSchema #muh_schema

80−-- :}

81−--

82−-- >>> printSQL definition

83−-- DROP SCHEMA "muh_schema";

84−dropSchema

85− :: KnownSymbol sch

86− => Alias sch

87− -- ^ user defined schema

88− -> Definition schemas (Drop sch schemas)

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

90−

91−dropSchemaIfExists

92− :: KnownSymbol sch

93− => Alias sch

94− -- ^ user defined schema

95− -> Definition schemas (DropIfExists sch schemas)

96−dropSchemaIfExists sch = UnsafeDefinition $ "DROP SCHEMA" <+> renderSQL sch <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table.hsdeleted−500

@@ -1,500 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Table

3−Description: Create, drop and alter table definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create, drop and alter table definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Table

33− ( createTable

34− , createTableIfNotExists

35− , dropTable

36− , dropTableIfExists

37− , alterTable

38− , alterTableIfExists

39− , alterTableRename

40− , alterTableIfExistsRename

41− , AlterTable (..)

42− , addConstraint

43− , dropConstraint

44− , AddColumn (..)

45− , dropColumn

46− , renameColumn

47− , alterColumn

48− , AlterColumn (..)

49− , setDefault

50− , dropDefault

51− , setNotNull

52− , dropNotNull

53− , alterType

54− ) where

55−

56−import Control.DeepSeq

57−import Data.ByteString

58−import GHC.TypeLits

59−

60−import qualified Generics.SOP as SOP

61−import qualified GHC.Generics as GHC

62−

63−import Squeal.PostgreSQL.Alias

64−import Squeal.PostgreSQL.Definition

65−import Squeal.PostgreSQL.Definition.Table.Constraint

66−import Squeal.PostgreSQL.Expression

67−import Squeal.PostgreSQL.Expression.Type

68−import Squeal.PostgreSQL.List

69−import Squeal.PostgreSQL.Render

70−import Squeal.PostgreSQL.Schema

71−

72−-- $setup

73−-- >>> import Squeal.PostgreSQL

74−

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

76−

77−>>> :set -XOverloadedLabels

78−>>> :{

79−type Table = '[] :=>

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

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

82−:}

83−

84−>>> :{

85−let

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

87− setup = createTable #tab

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

89−in printSQL setup

90−:}

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

92−-}

93−createTable

94− :: ( KnownSymbol sch

95− , KnownSymbol tab

96− , columns ~ (col ': cols)

97− , SOP.SListI columns

98− , SOP.SListI constraints

99− , Has sch schemas0 schema0

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

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

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

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

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

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

106− -> Definition schemas0 schemas1

107−createTable tab columns constraints = UnsafeDefinition $

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

109−

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

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

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

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

114−

115−>>> :set -XOverloadedLabels -XTypeApplications

116−>>> :{

117−type Table = '[] :=>

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

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

120−:}

121−

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

123−

124−>>> :{

125−let

126− setup :: Definition Schemas Schemas

127− setup = createTableIfNotExists #tab

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

129−in printSQL setup

130−:}

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

132−-}

133−createTableIfNotExists

134− :: ( KnownSymbol sch

135− , KnownSymbol tab

136− , columns ~ (col ': cols)

137− , SOP.SListI columns

138− , SOP.SListI constraints

139− , Has sch schemas0 schema0

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

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

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

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

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

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

146− -> Definition schemas0 schemas1

147−createTableIfNotExists tab columns constraints = UnsafeDefinition $

148− "CREATE TABLE IF NOT EXISTS"

149− <+> renderCreation tab columns constraints

150−

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

152−renderCreation

153− :: ( KnownSymbol sch

154− , KnownSymbol tab

155− , SOP.SListI columns

156− , SOP.SListI constraints )

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

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

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

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

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

162− -> ByteString

163−renderCreation tab columns constraints = renderSQL tab

164− <+> parenthesized

165− ( renderCommaSeparated renderColumnDef columns

166− <> ( case constraints of

167− Nil -> ""

168− _ -> ", " <>

169− renderCommaSeparated renderConstraint constraints ) )

170− <> ";"

171− where

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

173− renderColumnDef (ty `As` column) =

174− renderSQL column <+> renderColumnTypeExpression ty

175− renderConstraint

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

177− -> ByteString

178− renderConstraint (constraint `As` alias) =

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

180−

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

182−--

183−-- >>> :{

184−-- let

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

186−-- definition = dropTable #muh_table

187−-- :}

188−--

189−-- >>> printSQL definition

190−-- DROP TABLE "muh_table";

191−dropTable

192− :: ( Has sch schemas schema

193− , KnownSymbol tab )

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

195− -> Definition schemas (Alter sch (DropSchemum tab 'Table schema) schemas)

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

197−

198−dropTableIfExists

199− :: ( Has sch schemas schema

200− , KnownSymbol tab)

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

202− -> Definition schemas (Alter sch (DropSchemumIfExists tab 'Table schema) schemas)

203−dropTableIfExists tab = UnsafeDefinition $ "DROP TABLE IF EXISTS" <+> renderSQL tab <> ";"

204−

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

206−alterTable

207− :: (Has sch schemas schema, KnownSymbol tab)

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

209− -> AlterTable sch tab schemas table -- ^ alteration to perform

210− -> Definition schemas (Alter sch (Alter tab ('Table table) schema) schemas)

211−alterTable tab alteration = UnsafeDefinition $

212− "ALTER TABLE"

213− <+> renderSQL tab

214− <+> renderAlterTable alteration

215− <> ";"

216−

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

218−alterTableIfExists

219− :: (Has sch schemas schema, KnownSymbol tab)

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

221− -> AlterTable sch tab schemas table -- ^ alteration to perform

222− -> Definition schemas (Alter sch (AlterIfExists tab ('Table table) schema) schemas)

223−alterTableIfExists tab alteration = UnsafeDefinition $

224− "ALTER TABLE IF EXISTS"

225− <+> renderSQL tab

226− <+> renderAlterTable alteration

227− <> ";"

228−

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

230−--

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

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

233−alterTableRename

234− :: (KnownSymbol tab0, KnownSymbol tab1)

235− => Alias tab0 -- ^ table to rename

236− -> Alias tab1 -- ^ what to rename it

237− -> Definition schema (Rename tab0 tab1 schema)

238−alterTableRename tab0 tab1 = UnsafeDefinition $

239− "ALTER TABLE" <+> renderSQL tab0

240− <+> "RENAME TO" <+> renderSQL tab1 <> ";"

241−

242−alterTableIfExistsRename

243− :: (KnownSymbol tab0, KnownSymbol tab1)

244− => Alias tab0 -- ^ table to rename

245− -> Alias tab1 -- ^ what to rename it

246− -> Definition schema (RenameIfExists tab0 tab1 schema)

247−alterTableIfExistsRename tab0 tab1 = UnsafeDefinition $

248− "ALTER TABLE IF EXISTS" <+> renderSQL tab0

249− <+> "RENAME TO" <+> renderSQL tab1 <> ";"

250−

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

252−-- of a table.

253−newtype AlterTable

254− (sch :: Symbol)

255− (tab :: Symbol)

256− (schemas :: SchemasType)

257− (table :: TableType) =

258− UnsafeAlterTable {renderAlterTable :: ByteString}

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

260−

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

262−--

263−-- >>> :{

264−-- let

265−-- definition :: Definition

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

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

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

269−-- in printSQL definition

270−-- :}

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

272−addConstraint

273− :: ( KnownSymbol alias

274− , Has sch schemas schema

275− , Has tab schema ('Table table0)

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

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

278− => Alias alias

279− -> TableConstraintExpression sch tab schemas constraint

280− -- ^ constraint to add

281− -> AlterTable sch tab schemas table1

282−addConstraint alias constraint = UnsafeAlterTable $

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

284− <+> renderSQL constraint

285−

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

287−--

288−-- >>> :{

289−-- let

290−-- definition :: Definition

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

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

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

294−-- in printSQL definition

295−-- :}

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

297−dropConstraint

298− :: ( KnownSymbol constraint

299− , Has sch schemas schema

300− , Has tab schema ('Table table0)

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

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

303− => Alias constraint

304− -- ^ constraint to drop

305− -> AlterTable sch tab schemas table1

306−dropConstraint constraint = UnsafeAlterTable $

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

308−

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

310−class AddColumn ty where

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

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

313− --

314− -- >>> :{

315− -- let

316− -- definition :: Definition

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

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

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

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

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

322− -- in printSQL definition

323− -- :}

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

325− --

326− -- >>> :{

327− -- let

328− -- definition :: Definition

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

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

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

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

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

334− -- in printSQL definition

335− -- :}

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

337− addColumn

338− :: ( KnownSymbol column

339− , Has sch schemas schema

340− , Has tab schema ('Table table0)

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

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

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

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

345− addColumn column ty = UnsafeAlterTable $

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

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

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

349−

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

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

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

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

354−--

355−-- >>> :{

356−-- let

357−-- definition :: Definition

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

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

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

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

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

363−-- in printSQL definition

364−-- :}

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

366−dropColumn

367− :: ( KnownSymbol column

368− , Has sch schemas schema

369− , Has tab schema ('Table table0)

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

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

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

373− -> AlterTable sch tab schemas table1

374−dropColumn column = UnsafeAlterTable $

375− "DROP COLUMN" <+> renderSQL column

376−

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

378−--

379−-- >>> :{

380−-- let

381−-- definition :: Definition

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

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

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

385−-- in printSQL definition

386−-- :}

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

388−renameColumn

389− :: ( KnownSymbol column0

390− , KnownSymbol column1

391− , Has sch schemas schema

392− , Has tab schema ('Table table0)

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

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

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

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

397− -> AlterTable sch tab schemas table1

398−renameColumn column0 column1 = UnsafeAlterTable $

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

400−

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

402−alterColumn

403− :: ( KnownSymbol column

404− , Has sch schemas schema

405− , Has tab schema ('Table table0)

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

407− , Has column columns ty0

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

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

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

411− -> AlterTable sch tab schemas table1

412−alterColumn column alteration = UnsafeAlterTable $

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

414−

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

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

417− UnsafeAlterColumn {renderAlterColumn :: ByteString}

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

419−

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

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

422−-- future insert and update commands.

423−--

424−-- >>> :{

425−-- let

426−-- definition :: Definition

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

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

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

430−-- in printSQL definition

431−-- :}

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

433−setDefault

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

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

436−setDefault expression = UnsafeAlterColumn $

437− "SET DEFAULT" <+> renderExpression expression

438−

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

440−--

441−-- >>> :{

442−-- let

443−-- definition :: Definition

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

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

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

447−-- in printSQL definition

448−-- :}

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

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

451−dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"

452−

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

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

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

456−--

457−-- >>> :{

458−-- let

459−-- definition :: Definition

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

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

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

463−-- in printSQL definition

464−-- :}

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

466−setNotNull

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

468−setNotNull = UnsafeAlterColumn $ "SET NOT NULL"

469−

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

471−--

472−-- >>> :{

473−-- let

474−-- definition :: Definition

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

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

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

478−-- in printSQL definition

479−-- :}

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

481−dropNotNull

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

483−dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"

484−

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

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

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

488−--

489−-- >>> :{

490−-- let

491−-- definition :: Definition

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

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

494−-- definition =

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

496−-- in printSQL definition

497−-- :}

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

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

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

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table/Constraint.hsdeleted−339

@@ -1,339 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Table.Constraint

3−Description: Table constraint expressions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Table constraint expressions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Table.Constraint

33− ( TableConstraintExpression (..)

34− , check

35− , unique

36− , primaryKey

37− , foreignKey

38− , ForeignKeyed

39− , OnDeleteClause (..)

40− , OnUpdateClause (..)

41− ) where

42−

43−import Control.DeepSeq

44−import Data.ByteString

45−import GHC.TypeLits

46−

47−import qualified Generics.SOP as SOP

48−import qualified GHC.Generics as GHC

49−

50−import Squeal.PostgreSQL.Alias

51−import Squeal.PostgreSQL.Expression.Logic

52−import Squeal.PostgreSQL.List

53−import Squeal.PostgreSQL.Render

54−import Squeal.PostgreSQL.Schema

55−

56−-- $setup

57−-- >>> import Squeal.PostgreSQL

58−

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

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

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

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

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

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

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

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

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

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

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

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

71−newtype TableConstraintExpression

72− (sch :: Symbol)

73− (tab :: Symbol)

74− (schemas :: SchemasType)

75− (constraint :: TableConstraint)

76− = UnsafeTableConstraintExpression

77− { renderTableConstraintExpression :: ByteString }

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

79−instance RenderSQL

80− (TableConstraintExpression sch tab schemas constraint) where

81− renderSQL = renderTableConstraintExpression

82−

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

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

85−a Boolean (truth-value) expression.

86−

87−>>> :{

88−type Schema = '[

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

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

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

92− ])]

93−:}

94−

95−>>> :{

96−let

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

98− definition = createTable #tab

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

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

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

102−:}

103−

104−>>> printSQL definition

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

106−-}

107−check

108− :: ( Has sch schemas schema

109− , Has tab schema ('Table table)

110− , HasAll aliases (TableToRow table) subcolumns )

111− => NP Alias aliases

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

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

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

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

116−check _cols condition = UnsafeTableConstraintExpression $

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

118−

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

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

121−

122−>>> :{

123−type Schema = '[

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

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

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

127− ])]

128−:}

129−

130−>>> :{

131−let

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

133− definition = createTable #tab

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

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

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

137−:}

138−

139−>>> printSQL definition

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

141−-}

142−unique

143− :: ( Has sch schemas schema

144− , Has tab schema('Table table)

145− , HasAll aliases (TableToRow table) subcolumns )

146− => NP Alias aliases

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

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

149−unique columns = UnsafeTableConstraintExpression $

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

151−

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

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

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

155−

156−>>> :{

157−type Schema = '[

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

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

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

161− ])]

162−:}

163−

164−>>> :{

165−let

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

167− definition = createTable #tab

168− ( serial `as` #id :*

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

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

171−:}

172−

173−>>> printSQL definition

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

175−-}

176−primaryKey

177− :: ( Has sch schemas schema

178− , Has tab schema ('Table table)

179− , HasAll aliases (TableToColumns table) subcolumns

180− , AllNotNull subcolumns )

181− => NP Alias aliases

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

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

184−primaryKey columns = UnsafeTableConstraintExpression $

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

186−

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

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

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

190−between two related tables.

191−

192−>>> :{

193−type Schema =

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

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

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

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

198− ])

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

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

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

202− ] :=>

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

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

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

206− ])

207− ]

208−:}

209−

210−>>> :{

211−let

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

213− setup =

214− createTable #users

215− ( serial `as` #id :*

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

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

218− createTable #emails

219− ( serial `as` #id :*

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

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

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

223− foreignKey #user_id #users #id

224− OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

225−in printSQL setup

226−:}

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

228−CREATE TABLE "emails" ("id" serial, "user_id" int NOT NULL, "email" text NULL, CONSTRAINT "pk_emails" PRIMARY KEY ("id"), CONSTRAINT "fk_user_id" FOREIGN KEY ("user_id") REFERENCES "users" ("id") ON DELETE CASCADE ON UPDATE CASCADE);

229−

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

231−

232−>>> :{

233−type Schema =

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

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

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

237− ] :=>

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

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

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

241− ])

242− ]

243−:}

244−

245−>>> :{

246−let

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

248− setup =

249− createTable #employees

250− ( serial `as` #id :*

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

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

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

254− foreignKey #employer_id #employees #id

255− OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )

256−in printSQL setup

257−:}

258−CREATE TABLE "employees" ("id" serial, "name" text NOT NULL, "employer_id" integer NULL, CONSTRAINT "employees_pk" PRIMARY KEY ("id"), CONSTRAINT "employees_employer_fk" FOREIGN KEY ("employer_id") REFERENCES "employees" ("id") ON DELETE CASCADE ON UPDATE CASCADE);

259−-}

260−foreignKey

261− :: (ForeignKeyed schemas sch schema child parent

262− table reftable

263− columns refcolumns

264− constraints cols

265− reftys tys )

266− => NP Alias columns

267− -- ^ column or columns in the table

268− -> Alias parent

269− -- ^ reference table

270− -> NP Alias refcolumns

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

272− -> OnDeleteClause

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

274− -> OnUpdateClause

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

276− -> TableConstraintExpression sch child schemas

277− ('ForeignKey columns parent refcolumns)

278−foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $

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

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

281− <+> parenthesized (renderSQL refs)

282− <+> renderSQL ondel

283− <+> renderSQL onupd

284−

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

286−type ForeignKeyed schemas

287− sch

288− schema

289− child parent

290− table reftable

291− columns refcolumns

292− constraints cols

293− reftys tys =

294− ( Has sch schemas schema

295− , Has child schema ('Table table)

296− , Has parent schema ('Table reftable)

297− , HasAll columns (TableToColumns table) tys

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

299− , HasAll refcolumns cols reftys

300− , SOP.AllZip SamePGType tys reftys

301− , Uniquely refcolumns constraints )

302−

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

304−data OnDeleteClause

305− = OnDeleteNoAction

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

307− -- an error is raised

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

309− | OnDeleteCascade

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

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

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

313−instance NFData OnDeleteClause

314−-- | Render `OnDeleteClause`.

315−instance RenderSQL OnDeleteClause where

316− renderSQL = \case

317− OnDeleteNoAction -> "ON DELETE NO ACTION"

318− OnDeleteRestrict -> "ON DELETE RESTRICT"

319− OnDeleteCascade -> "ON DELETE CASCADE"

320−

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

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

323−data OnUpdateClause

324− = OnUpdateNoAction

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

326− -- an error is raised

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

328− | OnUpdateCascade

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

330− -- into the referencing row(s)

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

332−instance NFData OnUpdateClause

333−

334−-- | Render `OnUpdateClause`.

335−instance RenderSQL OnUpdateClause where

336− renderSQL = \case

337− OnUpdateNoAction -> "ON UPDATE NO ACTION"

338− OnUpdateRestrict -> "ON UPDATE RESTRICT"

339− OnUpdateCascade -> "ON UPDATE CASCADE"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Type.hsdeleted−229

@@ -1,229 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Type

3−Description: Create and drop type definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop type definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Type

33− ( createTypeEnum

34− , createTypeEnumFrom

35− , createTypeComposite

36− , createTypeCompositeFrom

37− , createTypeRange

38− , createDomain

39− , dropType

40− , dropTypeIfExists

41− ) where

42−

43−import Data.ByteString

44−import Data.Monoid

45−import GHC.TypeLits

46−import Prelude hiding ((.), id)

47−

48−import qualified Generics.SOP as SOP

49−

50−import Squeal.PostgreSQL.Alias

51−import Squeal.PostgreSQL.Expression.Logic

52−import Squeal.PostgreSQL.Expression.Type

53−import Squeal.PostgreSQL.Definition

54−import Squeal.PostgreSQL.List

55−import Squeal.PostgreSQL.PG

56−import Squeal.PostgreSQL.Render

57−import Squeal.PostgreSQL.Schema

58−

59−-- $setup

60−-- >>> import Squeal.PostgreSQL

61−-- >>> import qualified GHC.Generics as GHC

62−-- >>> import qualified Generics.SOP as SOP

63−

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

65−--

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

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

68−createTypeEnum

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

70− => QualifiedAlias sch enum

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

72− -> NP PGlabel labels

73− -- ^ labels of the enumerated type

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

75−createTypeEnum enum labels = UnsafeDefinition $

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

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

78−

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

80−--

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

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

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

84−-- >>> :{

85−-- let

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

87−-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma

88−-- in

89−-- printSQL createSchwarma

90−-- :}

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

92−createTypeEnumFrom

93− :: forall hask sch enum schemas schema.

94− ( SOP.Generic hask

95− , SOP.All KnownSymbol (LabelsPG hask)

96− , KnownSymbol enum

97− , Has sch schemas schema )

98− => QualifiedAlias sch enum

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

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

101−createTypeEnumFrom enum = createTypeEnum enum

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

103−

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

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

106−

107−>>> :{

108−type PGcomplex = 'PGcomposite

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

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

111−:}

112−

113−>>> :{

114−let

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

116− setup = createTypeComposite #complex

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

118−in printSQL setup

119−:}

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

121−-}

122−createTypeComposite

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

124− => QualifiedAlias sch ty

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

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

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

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

129−createTypeComposite ty fields = UnsafeDefinition $

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

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

132− where

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

134− renderField (typ `As` alias) =

135− renderSQL alias <+> renderSQL typ

136−

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

138−--

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

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

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

142−-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]

143−-- >>> :{

144−-- let

145−-- createComplex :: Definition (Public '[]) (Public Schema)

146−-- createComplex = createTypeCompositeFrom @Complex #complex

147−-- in

148−-- printSQL createComplex

149−-- :}

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

151−createTypeCompositeFrom

152− :: forall hask sch ty schemas schema.

153− ( SOP.All (FieldTyped schemas) (RowPG hask)

154− , KnownSymbol ty

155− , Has sch schemas schema )

156− => QualifiedAlias sch ty

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

158− -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)

159−createTypeCompositeFrom ty = createTypeComposite ty

160− (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype

161− :: NP (Aliased (TypeExpression schemas)) (RowPG hask))

162−

163−{-|

164−`createDomain` creates a new domain. A domain is essentially a data type

165−with constraints (restrictions on the allowed set of values).

166−

167−Domains are useful for abstracting common constraints on fields

168−into a single location for maintenance. For example, several tables might

169−contain email address columns, all requiring the same `check` constraint

170−to verify the address syntax. Define a domain rather than setting up

171−each table's constraint individually.

172−

173−>>> :{

174−let

175− createPositive :: Definition (Public '[]) (Public '["positive" ::: 'Typedef 'PGfloat4])

176− createPositive = createDomain #positive real (#value .> 0 .&& (#value & isNotNull))

177−in printSQL createPositive

178−:}

179−CREATE DOMAIN "positive" AS real CHECK ((("value" > 0) AND "value" IS NOT NULL));

180−-}

181−createDomain

182− :: (Has sch schemas schema, KnownSymbol dom)

183− => QualifiedAlias sch dom

184− -> (forall null. TypeExpression schemas (null ty))

185− -> (forall tab. Condition '[] '[] 'Ungrouped schemas '[] '[tab ::: '["value" ::: 'Null ty]])

186− -> Definition schemas (Alter sch (Create dom ('Typedef ty) schema) schemas)

187−createDomain dom ty condition =

188− UnsafeDefinition $ "CREATE DOMAIN" <+> renderSQL dom

189− <+> "AS" <+> renderTypeExpression ty

190− <+> "CHECK" <+> parenthesized (renderSQL condition) <> ";"

191−

192−{- |

193−>>> :{

194−let

195− createSmallIntRange :: Definition (Public '[]) (Public '["int2range" ::: 'Typedef ('PGrange 'PGint2)])

196− createSmallIntRange = createTypeRange #int2range int2

197−in printSQL createSmallIntRange

198−:}

199−CREATE TYPE "int2range" AS RANGE (subtype = int2);

200−-}

201−createTypeRange

202− :: (Has sch schemas schema, KnownSymbol range)

203− => QualifiedAlias sch range

204− -> (forall null. TypeExpression schemas (null ty))

205− -> Definition schemas (Alter sch (Create range ('Typedef ('PGrange ty)) schema) schemas)

206−createTypeRange range ty = UnsafeDefinition $

207− "CREATE" <+> "TYPE" <+> renderSQL range <+> "AS" <+> "RANGE" <+>

208− parenthesized ("subtype" <+> "=" <+> renderTypeExpression ty) <> ";"

209−

210−-- | Drop a type.

211−--

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

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

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

215−-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))

216−-- DROP TYPE "schwarma";

217−dropType

218− :: (Has sch schemas schema, KnownSymbol td)

219− => QualifiedAlias sch td

220− -- ^ name of the user defined type

221− -> Definition schemas (Alter sch (DropSchemum td 'Typedef schema) schemas)

222−dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

223−

224−dropTypeIfExists

225− :: (Has sch schemas schema, KnownSymbol td)

226− => QualifiedAlias sch td

227− -- ^ name of the user defined type

228− -> Definition schemas (Alter sch (DropSchemumIfExists td 'Typedef schema) schemas)

229−dropTypeIfExists tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/View.hsdeleted−104

@@ -1,104 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.View

3−Description: Create and drop view definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop view definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.View

33− ( createView

34− , createOrReplaceView

35− , dropView

36− , dropViewIfExists

37− ) where

38−

39−import GHC.TypeLits

40−

41−import Squeal.PostgreSQL.Alias

42−import Squeal.PostgreSQL.Definition

43−import Squeal.PostgreSQL.Query

44−import Squeal.PostgreSQL.Render

45−import Squeal.PostgreSQL.Schema

46−

47−-- $setup

48−-- >>> import Squeal.PostgreSQL

49−

50−{- | Create a view.

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

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

53−>>> :{

54−let

55− definition :: Definition

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

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

58− definition =

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

60−in printSQL definition

61−:}

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

63−-}

64−createView

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

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

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

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

69−createView alias query = UnsafeDefinition $

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

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

72−

73−createOrReplaceView

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

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

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

77− -> Definition schemas (Alter sch (CreateOrReplace vw ('View view) schema) schemas)

78−createOrReplaceView alias query = UnsafeDefinition $

79− "CREATE OR REPLACE VIEW" <+> renderSQL alias <+> "AS"

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

81−

82−-- | Drop a view.

83−--

84−-- >>> :{

85−-- let

86−-- definition :: Definition

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

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

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

90−-- definition = dropView #bc

91−-- in printSQL definition

92−-- :}

93−-- DROP VIEW "bc";

94−dropView

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

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

97− -> Definition schemas (Alter sch (DropSchemum vw 'View schema) schemas)

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

99−

100−dropViewIfExists

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

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

103− -> Definition schemas (Alter sch (DropIfExists vw schema) schemas)

104−dropViewIfExists vw = UnsafeDefinition $ "DROP VIEW IF EXISTS" <+> renderSQL vw <> ";"

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

@@ -1,13 +1,14 @@

11{-|

22Module: Squeal.PostgreSQL.Expression

33Description: Squeal expressions

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

88Squeal expressions are the atoms used to build statements.

99-}

1010

11+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}

1112{-# LANGUAGE

1213 AllowAmbiguousTypes

1314 , ConstraintKinds

@@ -34,48 +35,49 @@ module Squeal.PostgreSQL.Expression

3435 ( -- * Expression

3536 Expression (..)

3637 , Expr

37− , type (-->)

38− , FunctionDB

38+ , (:-->)

3939 , unsafeFunction

40− , function

41− , unsafeLeftOp

42− , leftOp

43− , unsafeRightOp

44− , rightOp

40+ , unsafeUnaryOpL

41+ , unsafeUnaryOpR

4542 , Operator

46− , OperatorDB

4743 , unsafeBinaryOp

48− , binaryOp

4944 , FunctionVar

5045 , unsafeFunctionVar

51− , type (--->)

52− , FunctionNDB

46+ , FunctionN

5347 , unsafeFunctionN

54− , functionN

48+ , Literal (..)

5549 , PGSubset (..)

56− , PGIntersect (..)

5750 -- * Re-export

5851 , (&)

5952 , K (..)

60− , unK

6153 ) where

6254

6355import Control.Category

6456import Control.DeepSeq

6557import Data.ByteString (ByteString)

58+import Data.ByteString.Lazy (toStrict)

59+import ByteString.StrictBuilder (builderBytes)

6660import Data.Function ((&))

6761import Data.Semigroup hiding (All)

62+import qualified Data.Aeson as JSON

63+import Data.Int

6864import Data.String

65+import Data.Text (Text)

6966import Generics.SOP hiding (All, from)

7067import GHC.OverloadedLabels

7168import GHC.TypeLits

7269import Numeric

7370import Prelude hiding (id, (.))

7471

72+import qualified Data.Text as Text

73+import qualified Data.Text.Lazy as Lazy (Text)

74+import qualified Data.Text.Lazy as Lazy.Text

7575import qualified GHC.Generics as GHC

7676

7777import Squeal.PostgreSQL.Alias

78+import Squeal.PostgreSQL.Binary

7879import Squeal.PostgreSQL.List

80+import Squeal.PostgreSQL.PG

7981import Squeal.PostgreSQL.Render

8082import Squeal.PostgreSQL.Schema

8183

@@ -91,7 +93,7 @@ such as in the target `Squeal.PostgreSQL.Query.List` of the

9193`Squeal.PostgreSQL.Query.select` command,

9294as new column values in `Squeal.PostgreSQL.Manipulation.insertRow` or

9395`Squeal.PostgreSQL.Manipulation.update`,

94−or in search `Squeal.PostgreSQL.Logic.Condition`s in a number of commands.

96+or in search `Condition`s in a number of commands.

9597

9698The expression syntax allows the calculation of

9799values from primitive expression using arithmetic, logical,

@@ -125,7 +127,7 @@ instance RenderSQL (Expression outer commons grp schemas params from ty) where

125127 renderSQL = renderExpression

126128

127129-- | An `Expr` is a closed `Expression`.

128−-- It is a F@RankNType@ but don't be scared.

130+-- It is a F`RankNType` but don't be scared.

129131-- Think of it as an expression which sees no

130132-- namespaces, so you can't use parameters

131133-- or alias references. It can be used as

@@ -135,7 +137,7 @@ type Expr x

135137 . Expression outer commons grp schemas params from x

136138 -- ^ cannot reference aliases

137139

138−-- | A @RankNType@ for binary operators.

140+-- | A `RankNType` for binary operators.

139141type Operator x1 x2 y

140142 = forall outer commons grp schemas params from

141143 . Expression outer commons grp schemas params from x1

@@ -145,55 +147,32 @@ type Operator x1 x2 y

145147 -> Expression outer commons grp schemas params from y

146148 -- ^ output

147149

148−type OperatorDB schemas x1 x2 y

149− = forall outer commons grp params from

150− . Expression outer commons grp schemas params from x1

151− -- ^ left input

152− -> Expression outer commons grp schemas params from x2

153− -- ^ right input

154− -> Expression outer commons grp schemas params from y

155− -- ^ output

156−

157−-- | A @RankNType@ for functions with a single argument.

150+-- | A `RankNType` for functions with a single argument.

158151-- These could be either function calls or unary operators.

159152-- This is a subtype of the usual Haskell function type `Prelude.->`,

160153-- indeed a subcategory as it is closed under the usual

161154-- `Prelude..` and `Prelude.id`.

162−type (-->) x y

155+type (:-->) x y

163156 = forall outer commons grp schemas params from

164157 . Expression outer commons grp schemas params from x

165158 -- ^ input

166159 -> Expression outer commons grp schemas params from y

167160 -- ^ output

168161

169−type FunctionDB schemas x y

170− = forall outer commons grp params from

171− . Expression outer commons grp schemas params from x

172− -- ^ input

173− -> Expression outer commons grp schemas params from y

174− -- ^ output

175−

176−{- | A @RankNType@ for functions with a fixed-length list of heterogeneous arguments.

162+{- | A `RankNType` for functions with a fixed-length list of heterogeneous arguments.

177163Use the `*:` operator to end your argument lists, like so.

178164

179165>>> printSQL (unsafeFunctionN "fun" (true :* false :* localTime *: true))

180166fun(TRUE, FALSE, LOCALTIME, TRUE)

181167-}

182−type (--->) xs y

168+type FunctionN xs y

183169 = forall outer commons grp schemas params from

184170 . NP (Expression outer commons grp schemas params from) xs

185171 -- ^ inputs

186172 -> Expression outer commons grp schemas params from y

187173 -- ^ output

188174

189−type FunctionNDB schemas xs y

190− = forall outer commons grp params from

191− . NP (Expression outer commons grp schemas params from) xs

192− -- ^ inputs

193− -> Expression outer commons grp schemas params from y

194− -- ^ output

195−

196−{- | A @RankNType@ for functions with a variable-length list of

175+{- | A `RankNType` for functions with a variable-length list of

197176homogeneous arguments and at least 1 more argument.

198177-}

199178type FunctionVar x0 x1 y

@@ -318,63 +297,28 @@ unsafeBinaryOp :: ByteString -> Operator ty0 ty1 ty2

318297unsafeBinaryOp op x y = UnsafeExpression $ parenthesized $

319298 renderSQL x <+> op <+> renderSQL y

320299

321−binaryOp

322− :: forall op sch schemas schema x y z.

323− ( Has sch schemas schema

324− , Has op schema ('Operator ('BinaryOp x y z)) )

325− => OperatorDB schemas x y z

326−binaryOp = unsafeBinaryOp $ renderSymbol @op

327−

328−-- | >>> printSQL $ unsafeLeftOp "NOT" true

300+-- | >>> printSQL $ unsafeUnaryOpL "NOT" true

329301-- (NOT TRUE)

330−unsafeLeftOp :: ByteString -> x --> y

331−unsafeLeftOp op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x

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

302+unsafeUnaryOpL :: ByteString -> x :--> y

303+unsafeUnaryOpL op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x

339304

340−-- | >>> printSQL $ true & unsafeRightOp "IS NOT TRUE"

305+-- | >>> printSQL $ true & unsafeUnaryOpR "IS NOT TRUE"

341306-- (TRUE IS NOT TRUE)

342−unsafeRightOp :: ByteString -> x --> y

343−unsafeRightOp op x = UnsafeExpression $ parenthesized $ renderSQL x <+> op

344−

345−rightOp

346− :: forall op sch schemas schema x y.

347− ( Has sch schemas schema

348− , Has op schema ('Operator ('RightOp x y)) )

349− => FunctionDB schemas x y

350−rightOp = unsafeRightOp $ renderSymbol @op

307+unsafeUnaryOpR :: ByteString -> x :--> y

308+unsafeUnaryOpR op x = UnsafeExpression $ parenthesized $ renderSQL x <+> op

351309

352310-- | >>> printSQL $ unsafeFunction "f" true

353311-- f(TRUE)

354−unsafeFunction :: ByteString -> x --> y

312+unsafeFunction :: ByteString -> x :--> y

355313unsafeFunction fun x = UnsafeExpression $

356314 fun <> parenthesized (renderSQL x)

357315

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−

364316-- | >>> printSQL $ unsafeFunctionN "f" (currentTime :* localTimestamp :* false *: literal 'a')

365317-- f(CURRENT_TIME, LOCALTIMESTAMP, FALSE, E'a')

366−unsafeFunctionN :: SListI xs => ByteString -> xs ---> y

318+unsafeFunctionN :: SListI xs => ByteString -> FunctionN xs y

367319unsafeFunctionN fun xs = UnsafeExpression $

368320 fun <> parenthesized (renderCommaSeparated renderSQL xs)

369321

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−

378322instance ty `In` PGNum

379323 => Num (Expression outer commons grp schemas params from (null ty)) where

380324 (+) = unsafeBinaryOp "+"

@@ -419,22 +363,14 @@ instance (ty `In` PGNum, ty `In` PGFloating) => Floating

419363 acosh x = log (x + sqrt (x*x - 1))

420364 atanh x = log ((1 + x) / (1 - x)) / 2

421365

422−-- | Contained by operators

423−class PGSubset ty where

424− (@>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

366+class PGSubset container where

367+ (@>) :: Operator (null0 container) (null1 container) ('Null 'PGbool)

425368 (@>) = unsafeBinaryOp "@>"

426− (<@) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

369+ (<@) :: Operator (null0 container) (null1 container) ('Null 'PGbool)

427370 (<@) = unsafeBinaryOp "<@"

428371instance PGSubset 'PGjsonb

429372instance PGSubset 'PGtsquery

430373instance PGSubset ('PGvararray ty)

431−instance PGSubset ('PGrange ty)

432−

433−class PGIntersect ty where

434− (@&&) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

435− (@&&) = unsafeBinaryOp "&&"

436−instance PGIntersect ('PGvararray ty)

437−instance PGIntersect ('PGrange ty)

438374

439375instance IsString

440376 (Expression outer commons grp schemas params from (null 'PGtext)) where

@@ -470,3 +406,31 @@ instance Monoid

470406 (Expression outer commons grp schemas params from (null 'PGtsvector)) where

471407 mempty = fromString ""

472408 mappend = (<>)

409+

410+class Literal hask where

411+ literal :: hask -> Expr (null (PG hask))

412+instance JSON.ToJSON hask => Literal (Json hask) where

413+ literal = UnsafeExpression . parenthesized . (<> " :: json")

414+ . singleQuotedUtf8 . toStrict . JSON.encode . getJson

415+instance JSON.ToJSON hask => Literal (Jsonb hask) where

416+ literal = UnsafeExpression . parenthesized . (<> " :: jsonb")

417+ . singleQuotedUtf8 . toStrict . JSON.encode . getJsonb

418+instance Literal Char where

419+ literal chr = UnsafeExpression $

420+ "E\'" <> fromString (escape chr) <> "\'"

421+instance Literal String where literal = fromString

422+instance Literal Int16 where literal = fromIntegral

423+instance Literal Int32 where literal = fromIntegral

424+instance Literal Int64 where literal = fromIntegral

425+instance Literal Float where literal = fromRational . toRational

426+instance Literal Double where literal = fromRational . toRational

427+instance Literal Text where literal = fromString . Text.unpack

428+instance Literal Lazy.Text where literal = fromString . Lazy.Text.unpack

429+instance ToParam (Enumerated enum) (PG (Enumerated enum))

430+ => Literal (Enumerated enum) where

431+ literal

432+ = UnsafeExpression

433+ . singleQuotedUtf8

434+ . builderBytes

435+ . unK

436+ . toParam @(Enumerated enum) @(PG (Enumerated enum))

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Aggregate.hs+5−30

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Aggregate

3−Description: Aggregate functions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Aggregate functions

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , DeriveGeneric

@@ -26,7 +16,6 @@ Aggregate functions

2616module Squeal.PostgreSQL.Expression.Aggregate

2717 ( Aggregate (..)

2818 , Distinction (..)

29− , PGSum

3019 , PGAvg

3120 ) where

3221

@@ -50,7 +39,7 @@ import Squeal.PostgreSQL.Schema

5039{- |

5140`Aggregate` functions compute a single result from a set of input values.

5241`Aggregate` functions can be used as `GroupedBy` `Expression`s as well

53−as `Squeal.PostgreSQL.Expression.Window.WindowFunction`s.

42+as `WindowFunction`s.

5443-}

5544class Aggregate expr1 exprN aggr

5645 | aggr -> expr1, aggr -> exprN where

@@ -80,14 +69,15 @@ class Aggregate expr1 exprN aggr

8069

8170 -- | >>> :{

8271 -- let

83− -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('Null 'PGnumeric)

72+ -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('NotNull 'PGnumeric)

8473 -- expression = sum_ (Distinct #col)

8574 -- in printSQL expression

8675 -- :}

8776 -- sum(DISTINCT "col")

8877 sum_

89− :: expr1 (null ty)

90− -> aggr ('Null (PGSum ty))

78+ :: ty `In` PGNum

79+ => expr1 (null ty)

80+ -> aggr ('NotNull ty)

9181

9282 -- | input values, including nulls, concatenated into an array

9383 arrayAgg

@@ -434,21 +424,6 @@ unsafeAggregateN

434424 -> Expression outer commons ('Grouped bys) schemas params from y

435425unsafeAggregateN fun xs = UnsafeExpression $ fun <> parenthesized (renderSQL xs)

436426

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−

452427-- | A type family that calculates `PGAvg` type of a `PGType`.

453428type family PGAvg ty where

454429 PGAvg 'PGint2 = 'PGnumeric

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Collection.hs+2−19

@@ -1,20 +1,9 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Collection

3−Description: Array and composite functions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Array and composite functions

9−-}

10−

111{-# LANGUAGE

122 AllowAmbiguousTypes

133 , DataKinds

144 , FlexibleContexts

155 , FlexibleInstances

166 , MultiParamTypeClasses

17− , OverloadedLabels

187 , OverloadedStrings

198 , RankNTypes

209 , ScopedTypeVariables

@@ -30,7 +19,6 @@ module Squeal.PostgreSQL.Expression.Collection

3019 , array2

3120 , cardinality

3221 , index

33− , unnest

3422 , row

3523 , field

3624 ) where

@@ -42,7 +30,6 @@ import qualified Generics.SOP as SOP

4230

4331import Squeal.PostgreSQL.Alias

4432import Squeal.PostgreSQL.Expression

45−import Squeal.PostgreSQL.Expression.Set

4633import Squeal.PostgreSQL.List

4734import Squeal.PostgreSQL.Render

4835import Squeal.PostgreSQL.Schema

@@ -111,21 +98,17 @@ array2 xss = UnsafeExpression $ "ARRAY" <>

11198

11299-- | >>> printSQL $ cardinality (array [null_, false, true])

113100-- cardinality(ARRAY[NULL, FALSE, TRUE])

114−cardinality :: null ('PGvararray ty) --> null 'PGint8

101+cardinality :: null ('PGvararray ty) :--> null 'PGint8

115102cardinality = unsafeFunction "cardinality"

116103

117104-- | >>> printSQL $ array [null_, false, true] & index 2

118105-- (ARRAY[NULL, FALSE, TRUE])[2]

119106index

120107 :: Word64 -- ^ index

121− -> null ('PGvararray ty) --> NullifyType ty

108+ -> null ('PGvararray ty) :--> NullifyType ty

122109index n expr = UnsafeExpression $

123110 parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"

124111

125−-- | Expand an array to a set of rows

126−unnest :: SetFunction "unnest" (null ('PGvararray ty)) '["unnest" ::: ty]

127−unnest = unsafeSetFunction

128−

129112-- | A row constructor is an expression that builds a row value

130113-- (also called a composite value) using values for its member fields.

131114--

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Comparison.hs+20−35

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Comparison

3−Description: Comparison expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Comparison functions and operators

9−-}

10−

111{-# LANGUAGE

122 OverloadedStrings

133 , RankNTypes

@@ -39,8 +29,6 @@ module Squeal.PostgreSQL.Expression.Comparison

3929 , isNotUnknown

4030 ) where

4131

42−import Data.ByteString

43−

4432import Squeal.PostgreSQL.Expression

4533import Squeal.PostgreSQL.Expression.Logic

4634import Squeal.PostgreSQL.Render

@@ -99,9 +87,6 @@ greatest = unsafeFunctionVar "GREATEST"

9987least :: FunctionVar ty ty ty

10088least = unsafeFunctionVar "LEAST"

10189

102−{- |

103−A @RankNType@ for comparison expressions like `between`.

104−-}

10590type BetweenExpr

10691 = forall outer commons grp schemas params from ty

10792 . Expression outer commons grp schemas params from ty

@@ -109,21 +94,19 @@ type BetweenExpr

10994 , Expression outer commons grp schemas params from ty ) -- ^ bounds

11095 -> Condition outer commons grp schemas params from

11196

112−unsafeBetweenExpr :: ByteString -> BetweenExpr

113−unsafeBetweenExpr fun a (x,y) = UnsafeExpression $

114− renderSQL a <+> fun <+> renderSQL x <+> "AND" <+> renderSQL y

115−

11697{- | >>> printSQL $ true `between` (null_, false)

11798TRUE BETWEEN NULL AND FALSE

11899-}

119100between :: BetweenExpr

120−between = unsafeBetweenExpr "BETWEEN"

101+between a (x,y) = UnsafeExpression $ renderSQL a <+> "BETWEEN"

102+ <+> renderSQL x <+> "AND" <+> renderSQL y

121103

122104{- | >>> printSQL $ true `notBetween` (null_, false)

123105TRUE NOT BETWEEN NULL AND FALSE

124106-}

125107notBetween :: BetweenExpr

126−notBetween = unsafeBetweenExpr "NOT BETWEEN"

108+notBetween a (x,y) = UnsafeExpression $ renderSQL a <+> "NOT BETWEEN"

109+ <+> renderSQL x <+> "AND" <+> renderSQL y

127110

128111{- | between, after sorting the comparison values

129112

@@ -131,7 +114,8 @@ notBetween = unsafeBetweenExpr "NOT BETWEEN"

131114TRUE BETWEEN SYMMETRIC NULL AND FALSE

132115-}

133116betweenSymmetric :: BetweenExpr

134−betweenSymmetric = unsafeBetweenExpr "BETWEEN SYMMETRIC"

117+betweenSymmetric a (x,y) = UnsafeExpression $ renderSQL a

118+ <+> "BETWEEN SYMMETRIC" <+> renderSQL x <+> "AND" <+> renderSQL y

135119

136120{- | not between, after sorting the comparison values

137121

@@ -139,7 +123,8 @@ betweenSymmetric = unsafeBetweenExpr "BETWEEN SYMMETRIC"

139123TRUE NOT BETWEEN SYMMETRIC NULL AND FALSE

140124-}

141125notBetweenSymmetric :: BetweenExpr

142−notBetweenSymmetric = unsafeBetweenExpr "NOT BETWEEN SYMMETRIC"

126+notBetweenSymmetric a (x,y) = UnsafeExpression $ renderSQL a

127+ <+> "NOT BETWEEN SYMMETRIC" <+> renderSQL x <+> "AND" <+> renderSQL y

143128

144129{- | not equal, treating null like an ordinary value

145130

@@ -162,45 +147,45 @@ isNotDistinctFrom = unsafeBinaryOp "IS NOT DISTINCT FROM"

162147>>> printSQL $ true & isTrue

163148(TRUE IS TRUE)

164149-}

165−isTrue :: null0 'PGbool --> null1 'PGbool

166−isTrue = unsafeRightOp "IS TRUE"

150+isTrue :: null0 'PGbool :--> null1 'PGbool

151+isTrue = unsafeUnaryOpR "IS TRUE"

167152

168153{- | is false or unknown

169154

170155>>> printSQL $ true & isNotTrue

171156(TRUE IS NOT TRUE)

172157-}

173−isNotTrue :: null0 'PGbool --> null1 'PGbool

174−isNotTrue = unsafeRightOp "IS NOT TRUE"

158+isNotTrue :: null0 'PGbool :--> null1 'PGbool

159+isNotTrue = unsafeUnaryOpR "IS NOT TRUE"

175160

176161{- | is false

177162

178163>>> printSQL $ true & isFalse

179164(TRUE IS FALSE)

180165-}

181−isFalse :: null0 'PGbool --> null1 'PGbool

182−isFalse = unsafeRightOp "IS FALSE"

166+isFalse :: null0 'PGbool :--> null1 'PGbool

167+isFalse = unsafeUnaryOpR "IS FALSE"

183168

184169{- | is true or unknown

185170

186171>>> printSQL $ true & isNotFalse

187172(TRUE IS NOT FALSE)

188173-}

189−isNotFalse :: null0 'PGbool --> null1 'PGbool

190−isNotFalse = unsafeRightOp "IS NOT FALSE"

174+isNotFalse :: null0 'PGbool :--> null1 'PGbool

175+isNotFalse = unsafeUnaryOpR "IS NOT FALSE"

191176

192177{- | is unknown

193178

194179>>> printSQL $ true & isUnknown

195180(TRUE IS UNKNOWN)

196181-}

197−isUnknown :: null0 'PGbool --> null1 'PGbool

198−isUnknown = unsafeRightOp "IS UNKNOWN"

182+isUnknown :: null0 'PGbool :--> null1 'PGbool

183+isUnknown = unsafeUnaryOpR "IS UNKNOWN"

199184

200185{- | is true or false

201186

202187>>> printSQL $ true & isNotUnknown

203188(TRUE IS NOT UNKNOWN)

204189-}

205−isNotUnknown :: null0 'PGbool --> null1 'PGbool

206−isNotUnknown = unsafeRightOp "IS NOT UNKNOWN"

190+isNotUnknown :: null0 'PGbool :--> null1 'PGbool

191+isNotUnknown = unsafeUnaryOpR "IS NOT UNKNOWN"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Json.hs+113−227

@@ -1,27 +1,11 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Json

3−Description: Json and Jsonb functions and operators

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Json and Jsonb functions and operators

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , FlexibleContexts

144 , FlexibleInstances

15− , GADTs

16− , OverloadedLabels

175 , OverloadedStrings

186 , PolyKinds

19− , RankNTypes

20− , ScopedTypeVariables

21− , TypeApplications

227 , TypeOperators

238 , UndecidableInstances

24− , UndecidableSuperClasses

259#-}

2610

2711module Squeal.PostgreSQL.Expression.Json

@@ -43,13 +27,19 @@ module Squeal.PostgreSQL.Expression.Json

4327 , rowToJson

4428 , jsonBuildArray

4529 , jsonbBuildArray

46− , JsonBuildObject (..)

30+ , PGBuildObject

31+ , jsonBuildObject

32+ , jsonbBuildObject

4733 , jsonObject

4834 , jsonbObject

4935 , jsonZipObject

5036 , jsonbZipObject

5137 , jsonArrayLength

5238 , jsonbArrayLength

39+ , jsonExtractPath

40+ , jsonbExtractPath

41+ , jsonExtractPathAsText

42+ , jsonbExtractPathAsText

5343 , jsonTypeof

5444 , jsonbTypeof

5545 , jsonStripNulls

@@ -57,43 +47,14 @@ module Squeal.PostgreSQL.Expression.Json

5747 , jsonbSet

5848 , jsonbInsert

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

7750 ) where

7851

79−import Data.ByteString (ByteString)

80−import GHC.TypeLits

81−

82−import Squeal.PostgreSQL.Alias

8352import Squeal.PostgreSQL.Expression

84−import Squeal.PostgreSQL.Expression.Set

85−import Squeal.PostgreSQL.Expression.Type

8653import Squeal.PostgreSQL.List

87−import Squeal.PostgreSQL.Query

88−import Squeal.PostgreSQL.Render

8954import Squeal.PostgreSQL.Schema

9055

9156import qualified Generics.SOP as SOP

9257

93−-- $setup

94−-- >>> import Squeal.PostgreSQL

95−-- >>> import Data.Aeson

96−

9758{-----------------------------------------

9859 -- json and jsonb support

9960

@@ -156,18 +117,18 @@ infixl 9 .?&

156117

157118-- | Delete a key or keys from a JSON object, or remove an array element.

158119--

159−-- If the right operand is

120+-- If the right operand is..

160121--

161−-- @ text @: Delete key / value pair or string element from left operand.

162−-- Key / value pairs are matched based on their key value,

122+-- @ text @: Delete key/value pair or string element from left operand. Key/value pairs

123+-- are matched based on their key value.

163124--

164−-- @ text[] @: Delete multiple key / value pairs or string elements

165−-- from left operand. Key / value pairs are matched based on their key value,

125+-- @ text[] @: Delete multiple key/value pairs or string elements

126+-- from left operand. Key/value pairs are matched based on their key value.

166127--

167128-- @ integer @: Delete the array element with specified index (Negative integers

168129-- count from the end). Throws an error if top level container is not an array.

169130(.-.)

170− :: key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]

131+ :: (key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]) -- hlint error without parens here

171132 => Operator (null 'PGjsonb) (null key) (null 'PGjsonb)

172133infixl 6 .-.

173134(.-.) = unsafeBinaryOp "-"

@@ -188,7 +149,7 @@ Table 9.45: JSON creation functions

188149-- otherwise, a scalar value is produced. For any scalar type other than a

189150-- number, a Boolean, or a null value, the text representation will be used, in

190151-- such a fashion that it is a valid json value.

191−toJson :: null ty --> null 'PGjson

152+toJson :: null ty :--> null 'PGjson

192153toJson = unsafeFunction "to_json"

193154

194155-- | Returns the value as jsonb. Arrays and composites are converted

@@ -197,42 +158,48 @@ toJson = unsafeFunction "to_json"

197158-- otherwise, a scalar value is produced. For any scalar type other than a

198159-- number, a Boolean, or a null value, the text representation will be used, in

199160-- such a fashion that it is a valid jsonb value.

200−toJsonb :: null ty --> null 'PGjsonb

161+toJsonb :: null ty :--> null 'PGjsonb

201162toJsonb = unsafeFunction "to_jsonb"

202163

203164-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

204165-- becomes a JSON array of arrays.

205−arrayToJson :: null ('PGvararray ty) --> null 'PGjson

166+arrayToJson :: null ('PGvararray ty) :--> null 'PGjson

206167arrayToJson = unsafeFunction "array_to_json"

207168

208169-- | Returns the row as a JSON object.

209−rowToJson :: null ('PGcomposite ty) --> null 'PGjson

170+rowToJson :: null ('PGcomposite ty) :--> null 'PGjson

210171rowToJson = unsafeFunction "row_to_json"

211172

212173-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

213174-- argument list.

214−jsonBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjson

175+jsonBuildArray :: SOP.SListI tuple => FunctionN tuple (null 'PGjson)

215176jsonBuildArray = unsafeFunctionN "json_build_array"

216177

217178-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

218179-- variadic argument list.

219−jsonbBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjsonb

180+jsonbBuildArray :: SOP.SListI tuple => FunctionN tuple (null 'PGjsonb)

220181jsonbBuildArray = unsafeFunctionN "jsonb_build_array"

221182

183+class PGBuildObject tys where

184+instance PGBuildObject '[]

185+instance (PGBuildObject tys, key `In` PGJsonKey)

186+ => PGBuildObject ('NotNull key ': value ': tys)

187+

222188-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

223189-- argument list. The elements of the argument list must alternate between text

224190-- 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)

191+jsonBuildObject

192+ :: (SOP.SListI elems, PGBuildObject elems)

193+ => FunctionN elems (null 'PGjson)

194+jsonBuildObject = unsafeFunctionN "json_build_object"

195+

196+-- | Builds a possibly-heterogeneously-typed (binary) JSON object out of a

197+-- variadic argument list. The elements of the argument list must alternate

198+-- between keys and values.

199+jsonbBuildObject

200+ :: (SOP.SListI elems, PGBuildObject elems)

201+ => FunctionN elems (null 'PGjsonb)

202+jsonbBuildObject = unsafeFunctionN "jsonb_build_object"

236203

237204-- | Builds a JSON object out of a text array.

238205-- The array must have two dimensions

@@ -240,7 +207,7 @@ instance (JsonBuildObject tys, key `In` PGJsonKey)

240207-- which are taken as a key/value pair.

241208jsonObject

242209 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

243− --> null 'PGjson

210+ :--> null 'PGjson

244211jsonObject = unsafeFunction "json_object"

245212

246213-- | Builds a binary JSON object out of a text array.

@@ -249,24 +216,24 @@ jsonObject = unsafeFunction "json_object"

249216-- which are taken as a key/value pair.

250217jsonbObject

251218 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

252− --> null 'PGjsonb

219+ :--> null 'PGjsonb

253220jsonbObject = unsafeFunction "jsonb_object"

254221

255222-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

256223-- keys and one for values, that are zipped pairwise to create a JSON object.

257−jsonZipObject ::

224+jsonZipObject :: FunctionN

258225 '[ null ('PGvararray ('NotNull 'PGtext))

259226 , null ('PGvararray ('NotNull 'PGtext)) ]

260− ---> null 'PGjson

227+ ( null 'PGjson )

261228jsonZipObject = unsafeFunctionN "json_object"

262229

263230-- | This is an alternate form of 'jsonbObject' that takes two arrays; one for

264231-- keys and one for values, that are zipped pairwise to create a binary JSON

265232-- object.

266−jsonbZipObject ::

233+jsonbZipObject :: FunctionN

267234 '[ null ('PGvararray ('NotNull 'PGtext))

268235 , null ('PGvararray ('NotNull 'PGtext)) ]

269− ---> null 'PGjsonb

236+ ( null 'PGjsonb )

270237jsonbZipObject = unsafeFunctionN "jsonb_object"

271238

272239{-----------------------------------------

@@ -274,189 +241,108 @@ Table 9.46: JSON processing functions

274241-----------------------------------------}

275242

276243-- | Returns the number of elements in the outermost JSON array.

277−jsonArrayLength :: null 'PGjson --> null 'PGint4

244+jsonArrayLength :: null 'PGjson :--> null 'PGint4

278245jsonArrayLength = unsafeFunction "json_array_length"

279246

280247-- | Returns the number of elements in the outermost binary JSON array.

281−jsonbArrayLength :: null 'PGjsonb --> null 'PGint4

248+jsonbArrayLength :: null 'PGjsonb :--> null 'PGint4

282249jsonbArrayLength = unsafeFunction "jsonb_array_length"

283250

251+-- | Returns JSON value pointed to by the given path (equivalent to #>

252+-- operator).

253+jsonExtractPath

254+ :: SOP.SListI elems

255+ => Expression outer commons grp schemas params from (null 'PGjson)

256+ -> NP (Expression outer commons grp schemas params from) elems

257+ -> Expression outer commons grp schemas params from (null 'PGjsonb)

258+jsonExtractPath x xs =

259+ unsafeFunctionN "json_extract_path" (x :* xs)

260+

261+-- | Returns JSON value pointed to by the given path (equivalent to #>

262+-- operator).

263+jsonbExtractPath

264+ :: SOP.SListI elems

265+ => Expression outer commons grp schemas params from (null 'PGjsonb)

266+ -> NP (Expression outer commons grp schemas params from) elems

267+ -> Expression outer commons grp schemas params from (null 'PGjsonb)

268+jsonbExtractPath x xs =

269+ unsafeFunctionN "jsonb_extract_path" (x :* xs)

270+

271+-- | Returns JSON value pointed to by the given path (equivalent to #>

272+-- operator), as text.

273+jsonExtractPathAsText

274+ :: SOP.SListI elems

275+ => Expression outer commons grp schemas params from (null 'PGjson)

276+ -> NP (Expression outer commons grp schemas params from) elems

277+ -> Expression outer commons grp schemas params from (null 'PGjson)

278+jsonExtractPathAsText x xs =

279+ unsafeFunctionN "json_extract_path_text" (x :* xs)

280+

281+-- | Returns JSON value pointed to by the given path (equivalent to #>

282+-- operator), as text.

283+jsonbExtractPathAsText

284+ :: SOP.SListI elems

285+ => Expression outer commons grp schemas params from (null 'PGjsonb)

286+ -> NP (Expression outer commons grp schemas params from) elems

287+ -> Expression outer commons grp schemas params from (null 'PGjsonb)

288+jsonbExtractPathAsText x xs =

289+ unsafeFunctionN "jsonb_extract_path_text" (x :* xs)

290+

284291-- | Returns the type of the outermost JSON value as a text string. Possible

285292-- types are object, array, string, number, boolean, and null.

286−jsonTypeof :: null 'PGjson --> null 'PGtext

293+jsonTypeof :: null 'PGjson :--> null 'PGtext

287294jsonTypeof = unsafeFunction "json_typeof"

288295

289296-- | Returns the type of the outermost binary JSON value as a text string.

290297-- Possible types are object, array, string, number, boolean, and null.

291−jsonbTypeof :: null 'PGjsonb --> null 'PGtext

298+jsonbTypeof :: null 'PGjsonb :--> null 'PGtext

292299jsonbTypeof = unsafeFunction "jsonb_typeof"

293300

294301-- | Returns its argument with all object fields that have null values omitted.

295302-- Other null values are untouched.

296−jsonStripNulls :: null 'PGjson --> null 'PGjson

303+jsonStripNulls :: null 'PGjson :--> null 'PGjson

297304jsonStripNulls = unsafeFunction "json_strip_nulls"

298305

299306-- | Returns its argument with all object fields that have null values omitted.

300307-- Other null values are untouched.

301−jsonbStripNulls :: null 'PGjsonb --> null 'PGjsonb

308+jsonbStripNulls :: null 'PGjsonb :--> null 'PGjsonb

302309jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

303310

304311-- | @ jsonbSet target path new_value create_missing @

305312--

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

313+-- Returns target with the section designated by path replaced by new_value,

314+-- or with new_value added if create_missing is true ( default is true) and the

309315-- item designated by path does not exist. As with the path orientated

310316-- operators, negative integers that appear in path count from the end of JSON

311317-- arrays.

312−jsonbSet ::

313− '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

314− , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

315−jsonbSet = unsafeFunctionN "jsonbSet"

318+jsonbSet

319+ :: Expression outer commons grp schemas params from (null 'PGjsonb)

320+ -> Expression outer commons grp schemas params from (null ('PGvararray ('NotNull 'PGtext)))

321+ -> Expression outer commons grp schemas params from (null 'PGjsonb)

322+ -> Maybe (Expression outer commons grp schemas params from (null 'PGbool))

323+ -> Expression outer commons grp schemas params from (null 'PGjsonb)

324+jsonbSet tgt path val createMissing = case createMissing of

325+ Just m -> unsafeFunctionN "jsonb_set" (tgt :* path :* val :* m :* Nil)

326+ Nothing -> unsafeFunctionN "jsonb_set" (tgt :* path :* val :* Nil)

316327

317328-- | @ jsonbInsert target path new_value insert_after @

318329--

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

330+-- Returns target with new_value inserted. If target section designated by

331+-- path is in a JSONB array, new_value will be inserted before target or after

332+-- if insert_after is true (default is false). If target section designated by

333+-- path is in JSONB object, new_value will be inserted only if target does not

324334-- exist. As with the path orientated operators, negative integers that appear

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

336+jsonbInsert

337+ :: Expression outer commons grp schemas params from (null 'PGjsonb)

338+ -> Expression outer commons grp schemas params from (null ('PGvararray ('NotNull 'PGtext)))

339+ -> Expression outer commons grp schemas params from (null 'PGjsonb)

340+ -> Maybe (Expression outer commons grp schemas params from (null 'PGbool))

341+ -> Expression outer commons grp schemas params from (null 'PGjsonb)

342+jsonbInsert tgt path val insertAfter = case insertAfter of

343+ Just i -> unsafeFunctionN "jsonb_insert" (tgt :* path :* val :* i :* Nil)

344+ Nothing -> unsafeFunctionN "jsonb_insert" (tgt :* path :* val :* Nil)

330345

331346-- | Returns its argument as indented JSON text.

332−jsonbPretty :: null 'PGjsonb --> null 'PGtext

347+jsonbPretty :: null 'PGjsonb :--> null 'PGtext

333348jsonbPretty = 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.hsdeleted−87

@@ -1,87 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Literal

3−Description: Literal expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Literal expressions

9−-}

10−

11−{-# LANGUAGE

12− FlexibleContexts

13− , FlexibleInstances

14− , LambdaCase

15− , OverloadedStrings

16− , RankNTypes

17− , ScopedTypeVariables

18− , TypeApplications

19− , TypeSynonymInstances

20− , UndecidableInstances

21−#-}

22−

23−module Squeal.PostgreSQL.Expression.Literal (Literal (..)) where

24−

25−import ByteString.StrictBuilder (builderBytes)

26−import Data.ByteString.Lazy (toStrict)

27−import Data.Int

28−import Data.String

29−import Data.Text (Text)

30−

31−import qualified Data.Aeson as JSON

32−import qualified Data.Text as Text

33−import qualified Data.Text.Lazy as Lazy (Text)

34−import qualified Data.Text.Lazy as Lazy.Text

35−

36−import Squeal.PostgreSQL.Binary

37−import Squeal.PostgreSQL.Expression

38−import Squeal.PostgreSQL.Expression.Logic

39−import Squeal.PostgreSQL.PG

40−import Squeal.PostgreSQL.Render

41−

42−{- |

43−The `Literal` class allows embedding a Haskell value directly

44−as an `Expression` using `literal`.

45−

46−>>> printSQL (literal 'a')

47−E'a'

48−

49−>>> printSQL (literal (1 :: Double))

50−1.0

51−

52−>>> printSQL (literal (Json [1 :: Double, 2]))

53−('[1.0,2.0]' :: json)

54−

55−>>> printSQL (literal (Enumerated GT))

56−'GT'

57−-}

58−class Literal hask where literal :: hask -> Expr (null (PG hask))

59−instance Literal Bool where

60− literal = \case

61− True -> true

62− False -> false

63−instance JSON.ToJSON hask => Literal (Json hask) where

64− literal = UnsafeExpression . parenthesized . (<> " :: json")

65− . singleQuotedUtf8 . toStrict . JSON.encode . getJson

66−instance JSON.ToJSON hask => Literal (Jsonb hask) where

67− literal = UnsafeExpression . parenthesized . (<> " :: jsonb")

68− . singleQuotedUtf8 . toStrict . JSON.encode . getJsonb

69−instance Literal Char where

70− literal chr = UnsafeExpression $

71− "E\'" <> fromString (escape chr) <> "\'"

72−instance Literal String where literal = fromString

73−instance Literal Int16 where literal = fromIntegral

74−instance Literal Int32 where literal = fromIntegral

75−instance Literal Int64 where literal = fromIntegral

76−instance Literal Float where literal = fromRational . toRational

77−instance Literal Double where literal = fromRational . toRational

78−instance Literal Text where literal = fromString . Text.unpack

79−instance Literal Lazy.Text where literal = fromString . Lazy.Text.unpack

80−instance ToParam (Enumerated enum) (PG (Enumerated enum))

81− => Literal (Enumerated enum) where

82− literal

83− = UnsafeExpression

84− . singleQuotedUtf8

85− . builderBytes

86− . unK

87− . toParam @(Enumerated enum) @(PG (Enumerated enum))

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Logic.hs+3−13

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Logic

3−Description: Logical expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Logical expressions and operators

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , OverloadedStrings

@@ -30,7 +20,7 @@ import Squeal.PostgreSQL.Render

3020import Squeal.PostgreSQL.Schema

3121

3222-- | A `Condition` is an `Expression`, which can evaluate

33−-- to `true`, `false` or `Squeal.PostgreSQL.Null.null_`. This is because SQL uses

23+-- to `true`, `false` or `null_`. This is because SQL uses

3424-- a three valued logic.

3525type Condition outer commons grp schemas params from =

3626 Expression outer commons grp schemas params from ('Null 'PGbool)

@@ -47,8 +37,8 @@ false = UnsafeExpression "FALSE"

4737

4838-- | >>> printSQL $ not_ true

4939-- (NOT TRUE)

50−not_ :: null 'PGbool --> null 'PGbool

51−not_ = unsafeLeftOp "NOT"

40+not_ :: null 'PGbool :--> null 'PGbool

41+not_ = unsafeUnaryOpL "NOT"

5242

5343-- | >>> printSQL $ true .&& false

5444-- (TRUE AND FALSE)

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Math.hs+7−14

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Math

3−Description: Math expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Mathematical functions and operators

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , OverloadedStrings

@@ -29,6 +19,7 @@ import Squeal.PostgreSQL.Schema

2919

3020-- $setup

3121-- >>> import Squeal.PostgreSQL

22+-- >>> import Squeal.PostgreSQL.Render

3223

3324-- | >>> :{

3425-- let

@@ -37,7 +28,9 @@ import Squeal.PostgreSQL.Schema

3728-- in printSQL expression

3829-- :}

3930-- atan2(pi(), 2)

40−atan2_ :: float `In` PGFloating => '[ null float, null float] ---> null float

31+atan2_

32+ :: float `In` PGFloating

33+ => FunctionN '[ null float, null float] (null float)

4134atan2_ = unsafeFunctionN "atan2"

4235

4336

@@ -76,7 +69,7 @@ rem_ = unsafeBinaryOp "%"

7669-- in printSQL expression

7770-- :}

7871-- trunc(pi())

79−trunc :: frac `In` PGFloating => null frac --> null frac

72+trunc :: frac `In` PGFloating => null frac :--> null frac

8073trunc = unsafeFunction "trunc"

8174

8275-- | >>> :{

@@ -86,7 +79,7 @@ trunc = unsafeFunction "trunc"

8679-- in printSQL expression

8780-- :}

8881-- round(pi())

89−round_ :: frac `In` PGFloating => null frac --> null frac

82+round_ :: frac `In` PGFloating => null frac :--> null frac

9083round_ = unsafeFunction "round"

9184

9285-- | >>> :{

@@ -96,5 +89,5 @@ round_ = unsafeFunction "round"

9689-- in printSQL expression

9790-- :}

9891-- ceiling(pi())

99−ceiling_ :: frac `In` PGFloating => null frac --> null frac

92+ceiling_ :: frac `In` PGFloating => null frac :--> null frac

10093ceiling_ = unsafeFunction "ceiling"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Null.hs+4−14

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Null

3−Description: Null

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Null values and null handling functions

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , OverloadedStrings

@@ -44,7 +34,7 @@ null_ = UnsafeExpression "NULL"

4434--

4535-- >>> printSQL $ notNull true

4636-- TRUE

47−notNull :: 'NotNull ty --> 'Null ty

37+notNull :: 'NotNull ty :--> 'Null ty

4838notNull = UnsafeExpression . renderSQL

4939

5040-- | return the leftmost value which is not NULL

@@ -69,12 +59,12 @@ fromNull notNullx nullx = coalesce [nullx] notNullx

6959

7060-- | >>> printSQL $ null_ & isNull

7161-- NULL IS NULL

72−isNull :: 'Null ty --> null 'PGbool

62+isNull :: 'Null ty :--> null 'PGbool

7363isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"

7464

7565-- | >>> printSQL $ null_ & isNotNull

7666-- NULL IS NOT NULL

77−isNotNull :: 'Null ty --> null 'PGbool

67+isNotNull :: 'Null ty :--> null 'PGbool

7868isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"

7969

8070-- | analagous to `maybe` using @IS NULL@

@@ -100,5 +90,5 @@ matchNull y f x = ifThenElse (isNull x) y

10090>>> printSQL expr

10191NULLIF(FALSE, ($1 :: bool))

10292-}

103−nullIf :: '[ 'NotNull ty, 'NotNull ty] ---> 'Null ty

93+nullIf :: FunctionN '[ 'NotNull ty, 'NotNull ty] ('Null ty)

10494nullIf = unsafeFunctionN "NULLIF"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Parameter.hs−10

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Parameter

3−Description: Parameters

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Parameters, out-of-line data values

9−-}

10−

111{-# LANGUAGE

122 AllowAmbiguousTypes

133 , DataKinds

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Range.hsdeleted−230

@@ -1,230 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Range

3−Description: range types and functions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Range types and functions

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , DataKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DeriveFoldable

17− , DerivingStrategies

18− , DeriveTraversable

19− , FlexibleContexts

20− , FlexibleInstances

21− , LambdaCase

22− , MultiParamTypeClasses

23− , OverloadedLabels

24− , OverloadedStrings

25− , PatternSynonyms

26− , RankNTypes

27− , ScopedTypeVariables

28− , TypeApplications

29− , TypeFamilies

30− , TypeOperators

31− , UndecidableInstances

32−#-}

33−

34−module Squeal.PostgreSQL.Expression.Range

35− ( range

36− , Range (..)

37− , (<=..<=), (<..<), (<=..<), (<..<=)

38− , moreThan, atLeast, lessThan, atMost

39− , singleton, whole

40− , Bound (..)

41− , (.<@)

42− , (@>.)

43− , (<<@)

44− , (@>>)

45− , (&<)

46− , (&>)

47− , (-|-)

48− , (@+)

49− , (@*)

50− , (@-)

51− , lowerBound

52− , upperBound

53− , isEmpty

54− , lowerInc

55− , lowerInf

56− , upperInc

57− , upperInf

58− , rangeMerge

59− ) where

60−

61−import BinaryParser

62−import ByteString.StrictBuilder

63−import Data.Bits

64−import qualified GHC.Generics as GHC

65−import qualified Generics.SOP as SOP

66−import qualified PostgreSQL.Binary.Decoding as Decoding

67−

68−import Squeal.PostgreSQL.Binary

69−import Squeal.PostgreSQL.Expression

70−import Squeal.PostgreSQL.Expression.Type hiding (bool)

71−import Squeal.PostgreSQL.PG

72−import Squeal.PostgreSQL.Render

73−import Squeal.PostgreSQL.Schema

74−

75−-- $setup

76−-- >>> import Squeal.PostgreSQL

77−

78−-- | Construct a `range`

79−--

80−-- >>> printSQL $ range tstzrange (atLeast now)

81−-- tstzrange(now(), NULL, '[)')

82−-- >>> printSQL $ range numrange (0 <=..< 2*pi)

83−-- numrange(0, (2 * pi()), '[)')

84−-- >>> printSQL $ range int4range Empty

85−-- ('empty' :: int4range)

86−range

87− :: TypeExpression schemas (null ('PGrange ty))

88− -> Range (Expression outer commons grp schemas params from ('NotNull ty))

89− -> Expression outer commons grp schemas params from (null ('PGrange ty))

90−range ty = \case

91− Empty -> UnsafeExpression $ parenthesized

92− (emp <+> "::" <+> renderSQL ty)

93− NonEmpty l u -> UnsafeExpression $ renderSQL ty <> parenthesized

94− (commaSeparated (args l u))

95− where

96− emp = singleQuote <> "empty" <> singleQuote

97− args l u = [arg l, arg u, singleQuote <> bra l <> ket u <> singleQuote]

98− singleQuote = "\'"

99− arg = \case

100− Infinite -> "NULL"; Closed x -> renderSQL x; Open x -> renderSQL x

101− bra = \case Infinite -> "("; Closed _ -> "["; Open _ -> "("

102− ket = \case Infinite -> ")"; Closed _ -> "]"; Open _ -> ")"

103−

104−data Bound x = Infinite | Closed x | Open x

105− deriving

106− ( Eq, Ord, Show, Read, GHC.Generic

107− , Functor, Foldable, Traversable )

108−

109−data Range x = Empty | NonEmpty (Bound x) (Bound x)

110− deriving

111− ( Eq, Ord, Show, Read, GHC.Generic

112− , Functor, Foldable, Traversable )

113− deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)

114−type instance PG (Range x) = 'PGrange (PG x)

115−instance ToParam x pg => ToParam (Range x) ('PGrange pg) where

116− toParam rng = K $

117− word8 (setFlags rng 0) <>

118− case rng of

119− Empty -> mempty

120− NonEmpty lower upper -> putBound lower <> putBound upper

121− where

122− putBound = \case

123− Infinite -> mempty

124− Closed value -> putValue (unK (toParam @x @pg value))

125− Open value -> putValue (unK (toParam @x @pg value))

126− putValue value = int32BE (fromIntegral (builderLength value)) <> value

127− setFlags = \case

128− Empty -> (`setBit` 0)

129− NonEmpty lower upper ->

130− setLowerFlags lower . setUpperFlags upper

131− setLowerFlags = \case

132− Infinite -> (`setBit` 3)

133− Closed _ -> (`setBit` 1)

134− Open _ -> id

135− setUpperFlags = \case

136− Infinite -> (`setBit` 4)

137− Closed _ -> (`setBit` 2)

138− Open _ -> id

139−instance FromValue pg y => FromValue ('PGrange pg) (Range y) where

140− fromValue = do

141− flag <- byte

142− if testBit flag 0 then return Empty else do

143− lower <-

144− if testBit flag 3

145− then return Infinite

146− else do

147− len <- sized 4 Decoding.int

148− l <- sized len (fromValue @pg)

149− return $ if testBit flag 1 then Closed l else Open l

150− upper <-

151− if testBit flag 4

152− then return Infinite

153− else do

154− len <- sized 4 Decoding.int

155− l <- sized len (fromValue @pg)

156− return $ if testBit flag 2 then Closed l else Open l

157− return $ NonEmpty lower upper

158−

159−(<=..<=), (<..<), (<=..<), (<..<=) :: x -> x -> Range x

160−infix 4 <=..<=, <..<, <=..<, <..<=

161−x <=..<= y = NonEmpty (Closed x) (Closed y)

162−x <..< y = NonEmpty (Open x) (Open y)

163−x <=..< y = NonEmpty (Closed x) (Open y)

164−x <..<= y = NonEmpty (Open x) (Closed y)

165−

166−moreThan, atLeast, lessThan, atMost :: x -> Range x

167−moreThan x = NonEmpty (Open x) Infinite

168−atLeast x = NonEmpty (Closed x) Infinite

169−lessThan x = NonEmpty Infinite (Open x)

170−atMost x = NonEmpty Infinite (Closed x)

171−

172−singleton :: x -> Range x

173−singleton x = x <=..<= x

174−

175−whole :: Range x

176−whole = NonEmpty Infinite Infinite

177−

178−(.<@) :: Operator ('NotNull ty) (null ('PGrange ty)) ('Null 'PGbool)

179−(.<@) = unsafeBinaryOp "<@"

180−

181−(@>.) :: Operator (null ('PGrange ty)) ('NotNull ty) ('Null 'PGbool)

182−(@>.) = unsafeBinaryOp "<@"

183−

184−(<<@) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

185−(<<@) = unsafeBinaryOp "<<"

186−

187−(@>>) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

188−(@>>) = unsafeBinaryOp ">>"

189−

190−(&<) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

191−(&<) = unsafeBinaryOp "&<"

192−

193−(&>) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

194−(&>) = unsafeBinaryOp "&>"

195−

196−(-|-) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

197−(-|-) = unsafeBinaryOp "-|-"

198−

199−(@+) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))

200−(@+) = unsafeBinaryOp "+"

201−

202−(@*) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))

203−(@*) = unsafeBinaryOp "*"

204−

205−(@-) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))

206−(@-) = unsafeBinaryOp "-"

207−

208−lowerBound :: null ('PGrange ty) --> 'Null ty

209−lowerBound = unsafeFunction "lower"

210−

211−upperBound :: null ('PGrange ty) --> 'Null ty

212−upperBound = unsafeFunction "upper"

213−

214−isEmpty :: null ('PGrange ty) --> 'Null 'PGbool

215−isEmpty = unsafeFunction "isempty"

216−

217−lowerInc :: null ('PGrange ty) --> 'Null 'PGbool

218−lowerInc = unsafeFunction "lower_inc"

219−

220−lowerInf :: null ('PGrange ty) --> 'Null 'PGbool

221−lowerInf = unsafeFunction "lower_inf"

222−

223−upperInc :: null ('PGrange ty) --> 'Null 'PGbool

224−upperInc = unsafeFunction "upper_inc"

225−

226−upperInf :: null ('PGrange ty) --> 'Null 'PGbool

227−upperInf = unsafeFunction "upper_inf"

228−

229−rangeMerge :: '[null ('PGrange ty), null ('PGrange ty)] ---> null ('PGrange ty)

230−rangeMerge = unsafeFunctionN "range_merge"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Set.hsdeleted−139

@@ -1,139 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Set

3−Description: Set returning functions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Set returning functions

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , DataKinds

14− , FlexibleContexts

15− , OverloadedStrings

16− , PolyKinds

17− , RankNTypes

18− , ScopedTypeVariables

19− , TypeApplications

20− , TypeOperators

21−#-}

22−

23−module Squeal.PostgreSQL.Expression.Set

24− ( generateSeries

25− , generateSeriesStep

26− , generateSeriesTimestamp

27− , SetFunction

28− , unsafeSetFunction

29− , SetFunctionDB

30− , setFunction

31− , SetFunctionN

32− , unsafeSetFunctionN

33− , SetFunctionNDB

34− , setFunctionN

35− ) where

36−

37−import GHC.TypeLits

38−

39−import qualified Generics.SOP as SOP

40−

41−import Squeal.PostgreSQL.Alias

42−import Squeal.PostgreSQL.Expression

43−import Squeal.PostgreSQL.List

44−import Squeal.PostgreSQL.Render

45−import Squeal.PostgreSQL.Query

46−import Squeal.PostgreSQL.Schema

47−

48−{- |

49−A @RankNType@ for set returning functions with 1 argument.

50−-}

51−type SetFunction fun ty row

52− = forall outer commons schemas params

53− . Expression outer commons 'Ungrouped schemas params '[] ty

54− -- ^ input

55− -> FromClause outer commons schemas params '[fun ::: row]

56− -- ^ output

57−

58−type SetFunctionDB fun schemas ty row

59− = forall outer commons params

60− . Expression outer commons 'Ungrouped schemas params '[] ty

61− -- ^ input

62− -> FromClause outer commons schemas params '[fun ::: row]

63− -- ^ output

64−

65−-- | Escape hatch for a set returning function with 1 argument.

66−unsafeSetFunction

67− :: forall fun ty row. KnownSymbol fun

68− => SetFunction fun ty row -- ^ set returning function

69−unsafeSetFunction x = UnsafeFromClause $

70− renderSymbol @fun <> parenthesized (renderSQL x)

71−

72−setFunction

73− :: ( Has sch schemas schema

74− , Has fun schema ('Function ('[ty] :=> 'ReturnsTable row)) )

75− => QualifiedAlias sch fun

76− -> SetFunctionDB fun schemas ty row

77−setFunction _ = unsafeSetFunction

78−

79−{- |

80−A @RankNType@ for set returning functions with multiple argument.

81−-}

82−type SetFunctionN fun tys row

83− = forall outer commons schemas params

84− . NP (Expression outer commons 'Ungrouped schemas params '[]) tys

85− -- ^ inputs

86− -> FromClause outer commons schemas params '[fun ::: row]

87− -- ^ output

88−

89−-- | Escape hatch for a set returning function with multiple argument.

90−unsafeSetFunctionN

91− :: forall fun tys row. (SOP.SListI tys, KnownSymbol fun)

92− => SetFunctionN fun tys row -- ^ set returning function

93−unsafeSetFunctionN xs = UnsafeFromClause $

94− renderSymbol @fun <> parenthesized (renderCommaSeparated renderSQL xs)

95−

96−type SetFunctionNDB fun schemas tys row

97− = forall outer commons params

98− . NP (Expression outer commons 'Ungrouped schemas params '[]) tys

99− -- ^ inputs

100− -> FromClause outer commons schemas params '[fun ::: row]

101− -- ^ output

102−

103−setFunctionN

104− :: ( Has sch schemas schema

105− , Has fun schema ('Function (tys :=> 'ReturnsTable row))

106− , SOP.SListI tys )

107− => QualifiedAlias sch fun

108− -> SetFunctionNDB fun schemas tys row

109−setFunctionN _ = unsafeSetFunctionN

110−

111−{- | @generateSeries (start *: stop)@

112−

113−Generate a series of values, from @start@ to @stop@ with a step size of one

114−-}

115−generateSeries

116− :: ty `In` '[ 'PGint4, 'PGint8, 'PGnumeric]

117− => SetFunctionN "generate_series" '[ null ty, null ty]

118− '["generate_series" ::: null ty] -- ^ set returning function

119−generateSeries = unsafeSetFunctionN

120−

121−{- | @generateSeries (start :* stop *: step)@

122−

123−Generate a series of values, from @start@ to @stop@ with a step size of @step@

124−-}

125−generateSeriesStep

126− :: ty `In` '[ 'PGint4, 'PGint8, 'PGnumeric]

127− => SetFunctionN "generate_series" '[null ty, null ty, null ty]

128− '["generate_series" ::: null ty] -- ^ set returning function

129−generateSeriesStep = unsafeSetFunctionN

130−

131−{- | @generateSeries (start :* stop *: step)@

132−

133−Generate a series of values, from @start@ to @stop@ with a step size of @step@

134−-}

135−generateSeriesTimestamp

136− :: ty `In` '[ 'PGtimestamp, 'PGtimestamptz]

137− => SetFunctionN "generate_series" '[null ty, null ty, null 'PGinterval]

138− '["generate_series" ::: null ty] -- ^ set returning function

139−generateSeriesTimestamp = unsafeSetFunctionN

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Sort.hs+14−24

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Sort

3−Description: Sort expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Sort expressions

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , GADTs

@@ -29,10 +19,8 @@ import Squeal.PostgreSQL.Schema

2919-- of a `Squeal.PostgreSQL.Query.Query`. `Asc` or `Desc`

3020-- set the sort direction of a `NotNull` result

3121-- 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`,

22+-- first, where "smaller" is defined in terms of the `.<` operator. Similarly,

23+-- descending order is determined with the `.>` operator. `AscNullsFirst`,

3624-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to

3725-- determine whether nulls appear before or after non-null values in the sort

3826-- ordering of a `Null` result column.

@@ -56,16 +44,6 @@ data SortExpression outer commons grp schemas params from where

5644 :: Expression outer commons grp schemas params from ('Null ty)

5745 -> SortExpression outer commons grp schemas params from

5846deriving 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"

6947

7048{- |

7149The `orderBy` clause causes the result rows of a `Squeal.PostgreSQL.Query.TableExpression`

@@ -83,3 +61,15 @@ class OrderBy expr where

8361 :: [SortExpression outer commons grp schemas params from]

8462 -> expr outer commons grp schemas params from

8563 -> expr outer commons grp schemas params from

64+

65+-- | Render a `SortExpression`.

66+instance RenderSQL (SortExpression outer commons grp schemas params from) where

67+ renderSQL = \case

68+ Asc expression -> renderSQL expression <+> "ASC"

69+ Desc expression -> renderSQL expression <+> "DESC"

70+ AscNullsFirst expression -> renderSQL expression

71+ <+> "ASC NULLS FIRST"

72+ DescNullsFirst expression -> renderSQL expression

73+ <+> "DESC NULLS FIRST"

74+ AscNullsLast expression -> renderSQL expression <+> "ASC NULLS LAST"

75+ DescNullsLast expression -> renderSQL expression <+> "DESC NULLS LAST"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Subquery.hs+5−15

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Subquery

3−Description: Subquery expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Subquery expressions

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , OverloadedStrings

@@ -33,6 +23,7 @@ import Squeal.PostgreSQL.Schema

3323

3424-- $setup

3525-- >>> import Squeal.PostgreSQL

26+-- >>> import Squeal.PostgreSQL.Render

3627

3728{- |

3829The argument of `exists` is an arbitrary subquery. The subquery is evaluated

@@ -58,9 +49,8 @@ row of the subquery result using the given `Operator`,

5849which must yield a Boolean result. The result of `subAll` is `true`

5950if all rows yield true (including the case where the subquery returns no rows).

6051The 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_`.

52+The result is `null_` if no comparison with a subquery row returns `false`,

53+and at least one comparison returns `null_`.

6454

6555>>> printSQL $ subAll true (.==) (values_ (true `as` #foo))

6656(TRUE = ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo")))

@@ -80,8 +70,8 @@ using the given `Operator`, which must yield a Boolean result. The result of `su

8070if any `true` result is obtained. The result is `false` if no true result is found

8171(including the case where the subquery returns no rows).

8272

83−>>> printSQL $ subAny "foo" like (values_ ("foobar" `as` #foo))

84−(E'foo' LIKE ANY (SELECT * FROM (VALUES (E'foobar')) AS t ("foo")))

73+>>> printSQL $ subAll "foo" like (values_ ("foobar" `as` #foo))

74+(E'foo' LIKE ALL (SELECT * FROM (VALUES (E'foobar')) AS t ("foo")))

8575-}

8676subAny

8777 :: Expression outer commons grp schemas params from ty1 -- ^ expression

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Text.hs+4−13

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Text

3−Description: Text expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−String functions and operators

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , OverloadedStrings

@@ -27,20 +17,21 @@ import Squeal.PostgreSQL.Schema

2717

2818-- $setup

2919-- >>> import Squeal.PostgreSQL

20+-- >>> import Squeal.PostgreSQL.Render

3021

3122-- | >>> printSQL $ lower "ARRRGGG"

3223-- lower(E'ARRRGGG')

33−lower :: null 'PGtext --> null 'PGtext

24+lower :: null 'PGtext :--> null 'PGtext

3425lower = unsafeFunction "lower"

3526

3627-- | >>> printSQL $ upper "eeee"

3728-- upper(E'eeee')

38−upper :: null 'PGtext --> null 'PGtext

29+upper :: null 'PGtext :--> null 'PGtext

3930upper = unsafeFunction "upper"

4031

4132-- | >>> printSQL $ charLength "four"

4233-- char_length(E'four')

43−charLength :: null 'PGtext --> null 'PGint4

34+charLength :: null 'PGtext :--> null 'PGint4

4435charLength = unsafeFunction "char_length"

4536

4637-- | The `like` expression returns true if the @string@ matches

squeal-postgresql/src/Squeal/PostgreSQL/Expression/TextSearch.hs+21−71

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.TextSearch

3−Description: Text search expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Text search functions and operators

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , OverloadedStrings

@@ -42,116 +32,76 @@ import Squeal.PostgreSQL.Expression

4232import Squeal.PostgreSQL.List

4333import Squeal.PostgreSQL.Schema

4434

45−-- | `Squeal.PostgreSQL.Expression.Type.tsvector` matches tsquery ?

4635(@@) :: Operator (null 'PGtsvector) (null 'PGtsquery) ('Null 'PGbool)

4736(@@) = unsafeBinaryOp "@@"

4837

49−-- | AND `Squeal.PostgreSQL.Expression.Type.tsquery`s together

5038(.&) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

5139(.&) = unsafeBinaryOp "&&"

5240

53−-- | OR `Squeal.PostgreSQL.Expression.Type.tsquery`s together

5441(.|) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

5542(.|) = unsafeBinaryOp "||"

5643

57−-- | negate a `Squeal.PostgreSQL.Expression.Type.tsquery`

58−(.!) :: null 'PGtsquery --> null 'PGtsquery

59−(.!) = unsafeLeftOp "!!"

44+(.!) :: null 'PGtsquery :--> null 'PGtsquery

45+(.!) = unsafeUnaryOpL "!!"

6046

61−-- | `Squeal.PostgreSQL.Expression.Type.tsquery` followed by

62−-- `Squeal.PostgreSQL.Expression.Type.tsquery`

6347(<->) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

6448(<->) = unsafeBinaryOp "<->"

6549

66−-- | convert array of lexemes to `Squeal.PostgreSQL.Expression.Type.tsvector`

6750arrayToTSvector

6851 :: null ('PGvararray ('NotNull 'PGtext))

69− --> null 'PGtsvector

52+ :--> null 'PGtsvector

7053arrayToTSvector = unsafeFunction "array_to_tsvector"

7154

72−-- | number of lexemes in `Squeal.PostgreSQL.Expression.Type.tsvector`

73−tsvectorLength :: null 'PGtsvector --> null 'PGint4

55+tsvectorLength :: null 'PGtsvector :--> null 'PGint4

7456tsvectorLength = unsafeFunction "length"

7557

76−-- | number of lexemes plus operators in `Squeal.PostgreSQL.Expression.Type.tsquery`

77−numnode :: null 'PGtsquery --> null 'PGint4

58+numnode :: null 'PGtsquery :--> null 'PGint4

7859numnode = unsafeFunction "numnode"

7960

80−-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` ignoring punctuation

81−plainToTSquery :: null 'PGtext --> null 'PGtsquery

61+plainToTSquery :: null 'PGtext :--> null 'PGtsquery

8262plainToTSquery = unsafeFunction "plainto_tsquery"

8363

84−-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` that searches for a phrase,

85−-- ignoring punctuation

86−phraseToTSquery :: null 'PGtext --> null 'PGtsquery

64+phraseToTSquery :: null 'PGtext :--> null 'PGtsquery

8765phraseToTSquery = unsafeFunction "phraseto_tsquery"

8866

89−-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` from a web search style query

90−websearchToTSquery :: null 'PGtext --> null 'PGtsquery

67+websearchToTSquery :: null 'PGtext :--> null 'PGtsquery

9168websearchToTSquery = unsafeFunction "websearch_to_tsquery"

9269

93−-- | get indexable part of a `Squeal.PostgreSQL.Expression.Type.tsquery`

94−queryTree :: null 'PGtsquery --> null 'PGtext

70+queryTree :: null 'PGtsquery :--> null 'PGtext

9571queryTree = unsafeFunction "query_tree"

9672

97−-- | normalize words and convert to `Squeal.PostgreSQL.Expression.Type.tsquery`

98−toTSquery :: null 'PGtext --> null 'PGtsquery

73+toTSquery :: null 'PGtext :--> null 'PGtsquery

9974toTSquery = unsafeFunction "to_tsquery"

10075

101−-- | reduce document text to `Squeal.PostgreSQL.Expression.Type.tsvector`

10276toTSvector

10377 :: ty `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

104− => null ty --> null 'PGtsvector

78+ => null ty :--> null 'PGtsvector

10579toTSvector = unsafeFunction "to_tsvector"

10680

107−-- | assign weight to each element of `Squeal.PostgreSQL.Expression.Type.tsvector`

108−setWeight :: '[null 'PGtsvector, null ('PGchar 1)] ---> null 'PGtsvector

81+setWeight

82+ :: FunctionN '[null 'PGtsvector, null ('PGchar 1)] (null 'PGtsvector)

10983setWeight = unsafeFunctionN "set_weight"

11084

111−-- | remove positions and weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

112−strip :: null 'PGtsvector --> null 'PGtsvector

85+strip :: null 'PGtsvector :--> null 'PGtsvector

11386strip = unsafeFunction "strip"

11487

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

88+jsonToTSvector :: FunctionN '[null 'PGjson, null 'PGjson] (null 'PGtsvector)

12689jsonToTSvector = unsafeFunctionN "json_to_tsvector"

12790

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

91+jsonbToTSvector :: FunctionN '[null 'PGjsonb, null 'PGjsonb] (null 'PGtsvector)

13992jsonbToTSvector = unsafeFunctionN "jsonb_to_tsvector"

14093

141−-- | remove given lexeme from `Squeal.PostgreSQL.Expression.Type.tsvector`

142−tsDelete ::

94+tsDelete :: FunctionN

14395 '[null 'PGtsvector, null ('PGvararray ('NotNull 'PGtext))]

144− ---> null 'PGtsvector

96+ (null 'PGtsvector)

14597tsDelete = unsafeFunctionN "ts_delete"

14698

147−-- | select only elements with given weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

148−tsFilter ::

99+tsFilter :: FunctionN

149100 '[null 'PGtsvector, null ('PGvararray ('NotNull ('PGchar 1)))]

150− ---> null 'PGtsvector

101+ (null 'PGtsvector)

151102tsFilter = unsafeFunctionN "ts_filter"

152103

153−-- | display a `Squeal.PostgreSQL.Expression.Type.tsquery` match

154104tsHeadline

155105 :: document `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

156− => '[null document, null 'PGtsquery] ---> null 'PGtext

106+ => FunctionN '[null document, null 'PGtsquery] (null 'PGtext)

157107tsHeadline = unsafeFunctionN "ts_headline"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Time.hs+12−18

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Time

3−Description: Date/Time expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Date/Time functions and operators

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , DeriveGeneric

@@ -17,7 +7,6 @@ Date/Time functions and operators

177 , OverloadedStrings

188 , PolyKinds

199 , RankNTypes

20− , TypeOperators

2110#-}

2211

2312module Squeal.PostgreSQL.Expression.Time

@@ -86,7 +75,9 @@ Create date from year, month and day fields

8675>>> printSQL (makeDate (1984 :* 7 *: 3))

8776make_date(1984, 7, 3)

8877-}

89−makeDate :: '[ null 'PGint4, null 'PGint4, null 'PGint4 ] ---> null 'PGdate

78+makeDate :: FunctionN

79+ '[ null 'PGint4, null 'PGint4, null 'PGint4 ]

80+ ( null 'PGdate )

9081makeDate = unsafeFunctionN "make_date"

9182

9283{-|

@@ -95,7 +86,9 @@ Create time from hour, minute and seconds fields

9586>>> printSQL (makeTime (8 :* 15 *: 23.5))

9687make_time(8, 15, 23.5)

9788-}

98−makeTime :: '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtime

89+makeTime :: FunctionN

90+ '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ]

91+ ( null 'PGtime )

9992makeTime = unsafeFunctionN "make_time"

10093

10194{-|

@@ -104,9 +97,10 @@ Create timestamp from year, month, day, hour, minute and seconds fields

10497>>> printSQL (makeTimestamp (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

10598make_timestamp(2013, 7, 15, 8, 15, 23.5)

10699-}

107−makeTimestamp ::

100+makeTimestamp :: FunctionN

108101 '[ null 'PGint4, null 'PGint4, null 'PGint4

109− , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamp

102+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ]

103+ ( null 'PGtimestamp )

110104makeTimestamp = unsafeFunctionN "make_timestamp"

111105

112106{-|

@@ -117,9 +111,10 @@ the current time zone is used

117111>>> printSQL (makeTimestamptz (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

118112make_timestamptz(2013, 7, 15, 8, 15, 23.5)

119113-}

120−makeTimestamptz ::

114+makeTimestamptz :: FunctionN

121115 '[ null 'PGint4, null 'PGint4, null 'PGint4

122− , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamptz

116+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ]

117+ ( null 'PGtimestamptz )

123118makeTimestamptz = unsafeFunctionN "make_timestamptz"

124119

125120{-|

@@ -161,7 +156,6 @@ infixl 6 +!

161156infixl 6 !-

162157infixl 6 !-!

163158

164−-- | A `TimeUnit` to use in `interval_` construction.

165159data TimeUnit

166160 = Years | Months | Weeks | Days

167161 | Hours | Minutes | Seconds

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Type.hs+5−180

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression

3−Description: Type expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Type expressions.

9−-}

10−

111{-# LANGUAGE

122 AllowAmbiguousTypes

133 , DataKinds

@@ -23,16 +13,12 @@ Type expressions.

2313 , ScopedTypeVariables

2414 , TypeApplications

2515 , TypeOperators

26− , UndecidableInstances

2716#-}

2817

2918module Squeal.PostgreSQL.Expression.Type

30− ( -- * type casting

31− cast

32− , astype

33− , inferredtype

34− -- * type expressions

35− , TypeExpression (..)

19+ ( TypeExpression (..)

20+ , cast

21+ , PGTyped (..)

3622 , typedef

3723 , typetable

3824 , typeview

@@ -58,11 +44,9 @@ module Squeal.PostgreSQL.Expression.Type

5844 , bytea

5945 , timestamp

6046 , timestampWithTimeZone

61− , timestamptz

6247 , date

6348 , time

6449 , timeWithTimeZone

65− , timetz

6650 , interval

6751 , uuid

6852 , inet

@@ -72,29 +56,6 @@ module Squeal.PostgreSQL.Expression.Type

7256 , fixarray

7357 , tsvector

7458 , 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 (..)

9859 ) where

9960

10061import Control.DeepSeq

@@ -108,7 +69,6 @@ import qualified Generics.SOP as SOP

10869

10970import Squeal.PostgreSQL.Alias

11071import Squeal.PostgreSQL.Expression

111−import Squeal.PostgreSQL.PG

11272import Squeal.PostgreSQL.Render

11373import Squeal.PostgreSQL.Schema

11474

@@ -130,29 +90,6 @@ cast

13090cast ty x = UnsafeExpression $ parenthesized $

13191 renderSQL x <+> "::" <+> renderSQL ty

13292

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

15693

15794{-----------------------------------------

15895type expressions

@@ -170,7 +107,6 @@ instance RenderSQL (TypeExpression schemas ty) where

170107typedef

171108 :: (Has sch schemas schema, Has td schema ('Typedef ty))

172109 => QualifiedAlias sch td

173− -- ^ type alias

174110 -> TypeExpression schemas (null ty)

175111typedef = UnsafeTypeExpression . renderSQL

176112

@@ -179,7 +115,6 @@ typedef = UnsafeTypeExpression . renderSQL

179115typetable

180116 :: (Has sch schemas schema, Has tab schema ('Table table))

181117 => QualifiedAlias sch tab

182− -- ^ table alias

183118 -> TypeExpression schemas (null ('PGcomposite (TableToRow table)))

184119typetable = UnsafeTypeExpression . renderSQL

185120

@@ -188,7 +123,6 @@ typetable = UnsafeTypeExpression . renderSQL

188123typeview

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

190125 => QualifiedAlias sch vw

191− -- ^ view alias

192126 -> TypeExpression schemas (null ('PGcomposite view))

193127typeview = UnsafeTypeExpression . renderSQL

194128

@@ -245,9 +179,8 @@ bytea = UnsafeTypeExpression "bytea"

245179timestamp :: TypeExpression schemas (null 'PGtimestamp)

246180timestamp = UnsafeTypeExpression "timestamp"

247181-- | date and time, including time zone

248−timestampWithTimeZone, timestamptz :: TypeExpression schemas (null 'PGtimestamptz)

182+timestampWithTimeZone :: TypeExpression schemas (null 'PGtimestamptz)

249183timestampWithTimeZone = UnsafeTypeExpression "timestamp with time zone"

250−timestamptz = UnsafeTypeExpression "timestamptz"

251184-- | calendar date (year, month, day)

252185date :: TypeExpression schemas (null 'PGdate)

253186date = UnsafeTypeExpression "date"

@@ -255,9 +188,8 @@ date = UnsafeTypeExpression "date"

255188time :: TypeExpression schemas (null 'PGtime)

256189time = UnsafeTypeExpression "time"

257190-- | time of day, including time zone

258−timeWithTimeZone, timetz :: TypeExpression schemas (null 'PGtimetz)

191+timeWithTimeZone :: TypeExpression schemas (null 'PGtimetz)

259192timeWithTimeZone = UnsafeTypeExpression "time with time zone"

260−timetz = UnsafeTypeExpression "timetz"

261193-- | time span

262194interval :: TypeExpression schemas (null 'PGinterval)

263195interval = UnsafeTypeExpression "interval"

@@ -298,34 +230,10 @@ fixarray ty = UnsafeTypeExpression $

298230 $ SOP.hcmap (SOP.Proxy @KnownNat)

299231 (K . fromString . show . natVal)

300232 (SOP.hpure SOP.Proxy :: SOP.NP SOP.Proxy ns)

301−-- | text search query

302233tsvector :: TypeExpression schemas (null 'PGtsvector)

303234tsvector = UnsafeTypeExpression "tsvector"

304−-- | text search document

305235tsquery :: TypeExpression schemas (null 'PGtsquery)

306236tsquery = 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"

329237

330238-- | `pgtype` is a demoted version of a `PGType`

331239class PGTyped schemas (ty :: NullityType) where

@@ -361,86 +269,3 @@ instance (SOP.All KnownNat dims, PGTyped schemas ty)

361269 pgtype = fixarray @dims (pgtype @schemas @ty)

362270instance PGTyped schemas (null 'PGtsvector) where pgtype = tsvector

363271instance PGTyped schemas (null 'PGtsquery) where pgtype = tsquery

364−instance PGTyped schemas (null 'PGoid) where pgtype = oid

365−instance PGTyped schemas (null ('PGrange 'PGint4)) where pgtype = int4range

366−instance PGTyped schemas (null ('PGrange 'PGint8)) where pgtype = int8range

367−instance PGTyped schemas (null ('PGrange 'PGnumeric)) where pgtype = numrange

368−instance PGTyped schemas (null ('PGrange 'PGtimestamp)) where pgtype = tsrange

369−instance PGTyped schemas (null ('PGrange 'PGtimestamptz)) where pgtype = tstzrange

370−instance PGTyped schemas (null ('PGrange 'PGdate)) where pgtype = daterange

371−

372−-- | Lift `PGTyped` to a field

373−class FieldTyped schemas ty where

374− fieldtype :: Aliased (TypeExpression schemas) ty

375−instance (KnownSymbol alias, PGTyped schemas ty)

376− => FieldTyped schemas (alias ::: ty) where

377− fieldtype = pgtype `As` Alias

378−

379−-- | `ColumnTypeExpression`s are used in `createTable` commands.

380−newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)

381− = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }

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

383−instance RenderSQL (ColumnTypeExpression schemas ty) where

384− renderSQL = renderColumnTypeExpression

385−

386−-- | used in `createTable` commands as a column constraint to note that

387−-- @NULL@ may be present in a column

388−nullable

389− :: TypeExpression schemas (nullity ty)

390− -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)

391−nullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NULL"

392−

393−-- | used in `createTable` commands as a column constraint to ensure

394−-- @NULL@ is not present in a column

395−notNullable

396− :: TypeExpression schemas (nullity ty)

397− -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)

398−notNullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NOT NULL"

399−

400−-- | used in `createTable` commands as a column constraint to give a default

401−default_

402− :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty

403− -> ColumnTypeExpression schemas ('NoDef :=> ty)

404− -> ColumnTypeExpression schemas ('Def :=> ty)

405−default_ x ty = UnsafeColumnTypeExpression $

406− renderSQL ty <+> "DEFAULT" <+> renderExpression x

407−

408−-- | not a true type, but merely a notational convenience for creating

409−-- unique identifier columns with type `PGint2`

410−serial2, smallserial

411− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)

412−serial2 = UnsafeColumnTypeExpression "serial2"

413−smallserial = UnsafeColumnTypeExpression "smallserial"

414−-- | not a true type, but merely a notational convenience for creating

415−-- unique identifier columns with type `PGint4`

416−serial4, serial

417− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)

418−serial4 = UnsafeColumnTypeExpression "serial4"

419−serial = UnsafeColumnTypeExpression "serial"

420−-- | not a true type, but merely a notational convenience for creating

421−-- unique identifier columns with type `PGint8`

422−serial8, bigserial

423− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)

424−serial8 = UnsafeColumnTypeExpression "serial8"

425−bigserial = UnsafeColumnTypeExpression "bigserial"

426−

427−-- | Like @PGTyped@ but also accounts for nullity.

428−class PGNullityTyped schemas (nullty :: NullityType) where

429− pgNullityType :: ColumnTypeExpression schemas ('NoDef :=> nullty)

430−

431−instance PGTyped schemas ('Null ty) => PGNullityTyped schemas ('Null ty) where

432− pgNullityType = nullable (pgtype @_ @('Null ty))

433−

434−instance PGTyped schemas ('NotNull ty) => PGNullityTyped schemas ('NotNull ty) where

435− pgNullityType = notNullable (pgtype @_ @('NotNull ty))

436−

437−-- | Allow you to specify pg column types in relation to haskell types.

438−-- >>> printSQL $ hask @(Maybe String)

439−-- text NULL

440−--

441−-- >>> printSQL $ hask @Double

442−-- float8 NOT NULL

443−hask

444− :: forall hask schemas. PGNullityTyped schemas (NullPG hask)

445− => ColumnTypeExpression schemas ('NoDef :=> NullPG hask)

446−hask = pgNullityType

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Window.hs+6−44

@@ -1,13 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Window

3−Description: Window functions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Window functions and definitions

9−-}

10−

111{-# LANGUAGE

122 DataKinds

133 , DeriveGeneric

@@ -23,8 +13,9 @@ Window functions and definitions

2313#-}

2414

2515module Squeal.PostgreSQL.Expression.Window

26− ( -- * functions

27− partitionBy

16+ ( WindowDefinition (..)

17+ , partitionBy

18+ , WindowFunction (..)

2819 , rank

2920 , rowNumber

3021 , denseRank

@@ -36,14 +27,6 @@ module Squeal.PostgreSQL.Expression.Window

3627 , firstValue

3728 , lastValue

3829 , nthValue

39− , unsafeWindowFunction1

40− , unsafeWindowFunctionN

41− -- * types

42− , WindowFunction (..)

43− , WindowDefinition (..)

44− , WinFun0

45− , WinFun1

46− , WinFunN

4730 ) where

4831

4932import Control.DeepSeq

@@ -97,15 +80,14 @@ instance Aggregate

9780 varPop = unsafeWindowFunction1 "var_pop"

9881 varSamp = unsafeWindowFunction1 "var_samp"

9982

83+

10084-- | A `WindowDefinition` is a set of table rows that are somehow related

10185-- to the current row

10286data WindowDefinition outer commons grp schemas params from where

10387 WindowDefinition

10488 :: SOP.SListI bys

10589 => NP (Expression outer commons grp schemas params from) bys

106− -- ^ `partitionBy` clause

10790 -> [SortExpression outer commons grp schemas params from]

108− -- ^ `Squeal.PostgreSQL.Expression.Sort.orderBy` clause

10991 -> WindowDefinition outer commons grp schemas params from

11092

11193instance OrderBy WindowDefinition where

@@ -132,7 +114,7 @@ the same partition as the current row.

132114-}

133115partitionBy

134116 :: SOP.SListI bys

135− => NP (Expression outer commons grp schemas params from) bys -- ^ partitions

117+ => NP (Expression outer commons grp schemas params from) bys

136118 -> WindowDefinition outer commons grp schemas params from

137119partitionBy bys = WindowDefinition bys []

138120

@@ -160,17 +142,11 @@ newtype WindowFunction

160142instance RenderSQL (WindowFunction outer commons grp schemas params from ty) where

161143 renderSQL = renderWindowFunction

162144

163−{- |

164−A @RankNType@ for window functions with no arguments.

165−-}

166145type WinFun0 x

167146 = forall outer commons grp schemas params from

168147 . WindowFunction outer commons grp schemas params from x

169148 -- ^ cannot reference aliases

170149

171−{- |

172−A @RankNType@ for window functions with 1 argument.

173−-}

174150type WinFun1 x y

175151 = forall outer commons grp schemas params from

176152 . Expression outer commons grp schemas params from x

@@ -178,10 +154,6 @@ type WinFun1 x y

178154 -> WindowFunction outer commons grp schemas params from y

179155 -- ^ output

180156

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

185157type WinFunN xs y

186158 = forall outer commons grp schemas params from

187159 . NP (Expression outer commons grp schemas params from) xs

@@ -189,18 +161,15 @@ type WinFunN xs y

189161 -> WindowFunction outer commons grp schemas params from y

190162 -- ^ output

191163

192−-- | escape hatch for defining window functions

193164unsafeWindowFunction1 :: ByteString -> WinFun1 x y

194165unsafeWindowFunction1 fun x

195166 = UnsafeWindowFunction $ fun <> parenthesized (renderSQL x)

196167

197−-- | escape hatch for defining multi-argument window functions

198168unsafeWindowFunctionN :: SOP.SListI xs => ByteString -> WinFunN xs y

199169unsafeWindowFunctionN fun xs = UnsafeWindowFunction $ fun <>

200170 parenthesized (renderCommaSeparated renderSQL xs)

201171

202172{- | rank of the current row with gaps; same as `rowNumber` of its first peer

203−

204173>>> printSQL rank

205174rank()

206175-}

@@ -208,7 +177,6 @@ rank :: WinFun0 ('NotNull 'PGint8)

208177rank = UnsafeWindowFunction "rank()"

209178

210179{- | number of the current row within its partition, counting from 1

211−

212180>>> printSQL rowNumber

213181row_number()

214182-}

@@ -216,7 +184,6 @@ rowNumber :: WinFun0 ('NotNull 'PGint8)

216184rowNumber = UnsafeWindowFunction "row_number()"

217185

218186{- | rank of the current row without gaps; this function counts peer groups

219−

220187>>> printSQL denseRank

221188dense_rank()

222189-}

@@ -224,7 +191,6 @@ denseRank :: WinFun0 ('NotNull 'PGint8)

224191denseRank = UnsafeWindowFunction "dense_rank()"

225192

226193{- | relative rank of the current row: (rank - 1) / (total partition rows - 1)

227−

228194>>> printSQL percentRank

229195percent_rank()

230196-}

@@ -233,7 +199,6 @@ percentRank = UnsafeWindowFunction "percent_rank()"

233199

234200{- | cumulative distribution: (number of partition rows

235201preceding or peer with current row) / total partition rows

236−

237202>>> printSQL cumeDist

238203cume_dist()

239204-}

@@ -242,9 +207,6 @@ cumeDist = UnsafeWindowFunction "cume_dist()"

242207

243208{- | integer ranging from 1 to the argument value,

244209dividing the partition as equally as possible

245−

246−>>> printSQL $ ntile 5

247−ntile(5)

248210-}

249211ntile :: WinFun1 ('NotNull 'PGint4) ('NotNull 'PGint4)

250212ntile = unsafeWindowFunction1 "ntile"

@@ -263,7 +225,7 @@ row within the partition; if there is no such row, instead return default

263225evaluated with respect to the current row.

264226-}

265227lead :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

266−lead = unsafeWindowFunctionN "lead"

228+lead = unsafeWindowFunctionN "lag"

267229

268230{- | returns value evaluated at the row that is the

269231first row of the window frame

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

@@ -1,15 +1,3 @@

1−{-|

2−Module: Squeal.PostgreSQL.List

3−Description: List related types and functions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Haskell singly-linked lists are very powerful. This module

9−provides functionality for type-level lists, heterogeneous

10−lists and type aligned lists.

11−-}

12−

131{-# LANGUAGE

142 DataKinds

153 , FlexibleContexts

@@ -31,31 +19,39 @@ module Squeal.PostgreSQL.List

3119 ( SOP.NP (..)

3220 , (*:)

3321 , Join

22+ , (+++)

3423 , disjoin

35− , Additional (..)

36− , Path (..)

37− , CFunctor (..)

38− , CFoldable (..)

39− , CFree (..)

24+ , AlignedList (..)

25+ , single

26+ , extractList

27+ , alignedMap

4028 , Elem

4129 , In

4230 , Length

4331 ) where

4432

45−import Control.Category.Free

46−import Data.Function ((&))

33+import Control.Category

4734import Data.Kind

4835import Data.Type.Bool

4936import GHC.TypeLits

5037

5138import Generics.SOP as SOP

5239

40+import Squeal.PostgreSQL.Render

41+

5342-- | `Join` is simply promoted `++` and is used in @JOIN@s in

5443-- `Squeal.PostgreSQL.Query.FromClause`s.

5544type family Join xs ys where

5645 Join '[] ys = ys

5746 Join (x ': xs) ys = x ': Join xs ys

5847

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+

5955-- | `disjoin` is a utility function for splitting an `NP` list into pieces.

6056disjoin

6157 :: forall xs ys expr. SListI xs

@@ -66,15 +62,39 @@ disjoin = case sList @xs of

6662 SCons -> \(x :* xsys) ->

6763 case disjoin xsys of (xs,ys) -> (x :* xs, ys)

6864

69−-- | The `Additional` class is for appending

70−-- type-level list parameterized constructors such as `NP`,

71−-- `Squeal.PostgreSQL.Query.Selection`, and `Squeal.PostgreSQL.Query.FromClause`.

72−class Additional expr where

73− also :: expr ys -> expr xs -> expr (Join xs ys)

74−instance Additional (NP expr) where

75− also ys = \case

76− Nil -> ys

77− x :* xs -> x :* (xs & also ys)

65+-- | An `AlignedList` is a type-aligned list or free category.

66+data AlignedList p x0 x1 where

67+ Done :: AlignedList p x x

68+ (:>>) :: p x0 x1 -> AlignedList p x1 x2 -> AlignedList p x0 x2

69+infixr 7 :>>

70+instance Category (AlignedList p) where

71+ id = Done

72+ (.) list = \case

73+ Done -> list

74+ step :>> steps -> step :>> (steps >>> list)

75+instance (forall t0 t1. RenderSQL (p t0 t1))

76+ => RenderSQL (AlignedList p x0 x1) where

77+ renderSQL = \case

78+ Done -> ""

79+ step :>> Done -> renderSQL step

80+ step :>> steps -> renderSQL step <> ", " <> renderSQL steps

81+

82+extractList :: (forall a0 a1. p a0 a1 -> b) -> AlignedList p x0 x1 -> [b]

83+extractList f = \case

84+ Done -> []

85+ step :>> steps -> (f step):extractList f steps

86+

87+alignedMap

88+ :: (forall z0 z1. p z0 z1 -> q z0 z1)

89+ -> AlignedList p x0 x1

90+ -> AlignedList q x0 x1

91+alignedMap f = \case

92+ Done -> Done

93+ x :>> xs -> f x :>> alignedMap f xs

94+

95+-- | A `single` step.

96+single :: p x0 x1 -> AlignedList p x0 x1

97+single step = step :>> Done

7898

7999-- | A useful operator for ending an `NP` list of length at least 2 without `Nil`.

80100(*:) :: f x -> f y -> NP f '[x,y]

@@ -84,18 +104,13 @@ infixl 9 *:

84104-- | @Elem@ is a promoted `Data.List.elem`.

85105type family Elem x xs where

86106 Elem x '[] = 'False

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

107+ Elem x (x ': xs) = 'True

93108 Elem x (_ ': xs) = Elem x xs

94109

95110-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.

96111type family In x xs :: Constraint where

97112 In x xs = If (Elem x xs) (() :: Constraint)

98− (TypeError ('ShowType x ':<>: 'Text " is not in " ':<>: 'ShowType xs))

113+ (TypeError ('ShowType x ':<>: 'Text "is not in " ':<>: 'ShowType xs))

99114

100115{- | Calculate the `Length` of a type level list

101116

@@ -104,9 +119,5 @@ Length '[Char,String,Bool,Double] :: Nat

104119= 4

105120-}

106121type 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

111− Length (_ : xs) = 1 + Length xs

122+ Length (x : xs) = 1 + Length xs

112123 Length '[] = 0

squeal-postgresql/src/Squeal/PostgreSQL/Manipulation.hs+168−155

@@ -18,7 +18,6 @@ Squeal data manipulation language.

1818 , MultiParamTypeClasses

1919 , OverloadedStrings

2020 , PatternSynonyms

21− , QuantifiedConstraints

2221 , RankNTypes

2322 , ScopedTypeVariables

2423 , TypeApplications

@@ -30,9 +29,19 @@ Squeal data manipulation language.

3029

3130module Squeal.PostgreSQL.Manipulation

3231 ( -- * Manipulation

33− Manipulation_

34− , Manipulation (..)

32+ Manipulation (..)

33+ , Manipulation_

3534 , queryStatement

35+ , QueryClause (..)

36+ , pattern Values_

37+ , DefaultAliasable (..)

38+ , ColumnExpression (..)

39+ , ReturningClause (..)

40+ , pattern Returning_

41+ , ConflictClause (..)

42+ , ConflictTarget (..)

43+ , ConflictAction (..)

44+ , UsingClause (..)

3645 -- * Insert

3746 , insertInto

3847 , insertInto_

@@ -42,21 +51,13 @@ module Squeal.PostgreSQL.Manipulation

4251 -- * Delete

4352 , deleteFrom

4453 , deleteFrom_

45− -- * Clauses

46− , Optional (..)

47− , QueryClause (..)

48− , pattern Values_

49− , ReturningClause (..)

50− , pattern Returning_

51− , ConflictClause (..)

52− , ConflictTarget (..)

53− , ConflictAction (..)

54− , UsingClause (..)

54+ , also

5555 ) where

5656

5757import Control.DeepSeq

5858import Data.ByteString hiding (foldr)

5959import Data.Kind (Type)

60+import GHC.TypeLits (KnownSymbol)

6061

6162import qualified Generics.SOP as SOP

6263import qualified GHC.Generics as GHC

@@ -72,65 +73,21 @@ import Squeal.PostgreSQL.Schema

7273

7374-- $setup

7475-- >>> import Squeal.PostgreSQL

75−-- >>> import Data.Int

76−-- >>> import Data.Time

7776

7877{- |

7978A `Manipulation` is a statement which may modify data in the database,

8079but does not alter its schemas. Examples are inserts, updates and deletes.

8180A `Query` is also considered a `Manipulation` even though it does not modify data.

8281

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−

12582simple insert:

12683

12784>>> type Columns = '["col1" ::: 'NoDef :=> 'Null 'PGint4, "col2" ::: 'Def :=> 'NotNull 'PGint4]

12885>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

12986>>> :{

13087let

131− manipulation :: Manipulation_ (Public Schema) () ()

88+ manipulation :: Manipulation '[] (Public Schema) '[] '[]

13289 manipulation =

133− insertInto_ #tab (Values_ (Set 2 `as` #col1 :* Default `as` #col2))

90+ insertInto_ #tab (Values_ (2 `as` #col1 :* defaultAs #col2))

13491in printSQL manipulation

13592:}

13693INSERT INTO "tab" ("col1", "col2") VALUES (2, DEFAULT)

@@ -141,9 +98,9 @@ parameterized insert:

14198>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

14299>>> :{

143100let

144− manipulation :: Manipulation_ (Public Schema) (Int32, Int32) ()

101+ manipulation :: Manipulation '[] (Public Schema) '[ 'NotNull 'PGint4, 'NotNull 'PGint4 ] '[]

145102 manipulation =

146− insertInto_ #tab (Values_ (Set (param @1) `as` #col1 :* Set (param @2) `as` #col2))

103+ insertInto_ #tab (Values_ (param @1 `as` #col1 :* param @2 `as` #col2))

147104in printSQL manipulation

148105:}

149106INSERT INTO "tab" ("col1", "col2") VALUES (($1 :: int4), ($2 :: int4))

@@ -152,9 +109,9 @@ returning insert:

152109

153110>>> :{

154111let

155− manipulation :: Manipulation_ (Public Schema) () (Only Int32)

112+ manipulation :: Manipulation '[] (Public Schema) '[] '["fromOnly" ::: 'NotNull 'PGint4]

156113 manipulation =

157− insertInto #tab (Values_ (Set 2 `as` #col1 :* Set 3 `as` #col2))

114+ insertInto #tab (Values_ (2 `as` #col1 :* 3 `as` #col2))

158115 OnConflictDoRaise (Returning (#col1 `as` #fromOnly))

159116in printSQL manipulation

160117:}

@@ -167,12 +124,12 @@ upsert:

167124>>> type CustomersSchema = '["customers" ::: 'Table (CustomersConstraints :=> CustomersColumns)]

168125>>> :{

169126let

170− manipulation :: Manipulation_ (Public CustomersSchema) () ()

127+ manipulation :: Manipulation '[] (Public CustomersSchema) '[] '[]

171128 manipulation =

172129 insertInto #customers

173− (Values_ (Set "John Smith" `as` #name :* Set "john@smith.com" `as` #email))

130+ (Values_ ("John Smith" `as` #name :* "john@smith.com" `as` #email))

174131 (OnConflict (OnConstraint #uq)

175− (DoUpdate (Set (#excluded ! #email <> "; " <> #customers ! #email) `as` #email) []))

132+ (DoUpdate (((#excluded ! #email) <> "; " <> (#customers ! #email)) `as` #email) []))

176133 (Returning_ Nil)

177134in printSQL manipulation

178135:}

@@ -182,7 +139,7 @@ query insert:

182139

183140>>> :{

184141let

185− manipulation :: Manipulation_ (Public Schema) () ()

142+ manipulation :: Manipulation '[] (Public Schema) '[] '[]

186143 manipulation = insertInto_ #tab (Subquery (select Star (from (table #tab))))

187144in printSQL manipulation

188145:}

@@ -192,8 +149,8 @@ update:

192149

193150>>> :{

194151let

195− manipulation :: Manipulation_ (Public Schema) () ()

196− manipulation = update_ #tab (Set 2 `as` #col1) (#col1 ./= #col2)

152+ manipulation :: Manipulation '[] (Public Schema) '[] '[]

153+ manipulation = update_ #tab (2 `as` #col1) (#col1 ./= #col2)

197154in printSQL manipulation

198155:}

199156UPDATE "tab" SET "col1" = 2 WHERE ("col1" <> "col2")

@@ -202,7 +159,9 @@ delete:

202159

203160>>> :{

204161let

205− manipulation :: Manipulation_ (Public Schema) () (Row Int32 Int32)

162+ manipulation :: Manipulation '[] (Public Schema) '[]

163+ '[ "col1" ::: 'NotNull 'PGint4

164+ , "col2" ::: 'NotNull 'PGint4 ]

206165 manipulation = deleteFrom #tab NoUsing (#col1 .== #col2) (Returning Star)

207166in printSQL manipulation

208167:}

@@ -213,13 +172,13 @@ delete and using clause:

213172>>> :{

214173type Schema3 =

215174 '[ "tab" ::: 'Table ('[] :=> Columns)

216− , "other_tab" ::: 'Table ('[] :=> Columns)

217− , "third_tab" ::: 'Table ('[] :=> Columns) ]

175+ , "other_tab" ::: 'Table ('[] :=> Columns)

176+ , "third_tab" ::: 'Table ('[] :=> Columns) ]

218177:}

219178

220179>>> :{

221180let

222− manipulation :: Manipulation_ (Public Schema3) () ()

181+ manipulation :: Manipulation '[] (Public Schema3) '[] '[]

223182 manipulation =

224183 deleteFrom #tab (Using (table #other_tab & also (table #third_tab)))

225184 ( (#tab ! #col2 .== #other_tab ! #col2)

@@ -235,7 +194,7 @@ with manipulation:

235194>>> type ProductsSchema = '["products" ::: 'Table ('[] :=> ProductsColumns), "products_deleted" ::: 'Table ('[] :=> ProductsColumns)]

236195>>> :{

237196let

238− manipulation :: Manipulation_ (Public ProductsSchema) (Only Day) ()

197+ manipulation :: Manipulation '[] (Public ProductsSchema) '[ 'NotNull 'PGdate] '[]

239198 manipulation = with

240199 (deleteFrom #products NoUsing (#date .< param @1) (Returning Star) `as` #del)

241200 (insertInto_ #products_deleted (Subquery (select Star (from (common #del)))))

@@ -243,13 +202,26 @@ in printSQL manipulation

243202:}

244203WITH "del" AS (DELETE FROM "products" WHERE ("date" < ($1 :: date)) RETURNING *) INSERT INTO "products_deleted" SELECT * FROM "del" AS "del"

245204-}

205+newtype Manipulation

206+ (commons :: FromType)

207+ (schemas :: SchemasType)

208+ (params :: [NullityType])

209+ (columns :: RowType)

210+ = UnsafeManipulation { renderManipulation :: ByteString }

211+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

212+instance RenderSQL (Manipulation commons schemas params columns) where

213+ renderSQL = renderManipulation

214+instance With Manipulation where

215+ with Done manip = manip

216+ with ctes manip = UnsafeManipulation $

217+ "WITH" <+> renderSQL ctes <+> renderSQL manip

218+

246219type family Manipulation_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

247220 Manipulation_ schemas params row = Manipulation '[] schemas (TuplePG params) (RowPG row)

248221

249222-- | Convert a `Query` into a `Manipulation`.

250223queryStatement

251224 :: Query '[] commons schemas params columns

252− -- ^ `Query` to embed as a `Manipulation`

253225 -> Manipulation commons schemas params columns

254226queryStatement q = UnsafeManipulation $ renderSQL q

255227

@@ -272,13 +244,9 @@ insertInto

272244 , SOP.SListI columns

273245 , SOP.SListI row1 )

274246 => QualifiedAlias sch tab

275− -- ^ table

276247 -> QueryClause commons schemas params columns

277− -- ^ what to insert

278248 -> ConflictClause tab commons schemas params table

279− -- ^ what to do in case of conflict

280249 -> ReturningClause commons schemas params '[tab ::: row0] row1

281− -- ^ what to return

282250 -> Manipulation commons schemas params row1

283251insertInto tab qry conflict ret = UnsafeManipulation $

284252 "INSERT" <+> "INTO" <+> renderSQL tab

@@ -286,7 +254,6 @@ insertInto tab qry conflict ret = UnsafeManipulation $

286254 <> renderSQL conflict

287255 <> renderSQL ret

288256

289−-- | Like `insertInto` but with `OnConflictDoRaise` and `no` `ReturningClause`.

290257insertInto_

291258 :: ( Has sch schemas schema

292259 , Has tab schema ('Table table)

@@ -294,33 +261,25 @@ insertInto_

294261 , row ~ TableToRow table

295262 , SOP.SListI columns )

296263 => QualifiedAlias sch tab

297− -- ^ table

298264 -> QueryClause commons schemas params columns

299− -- ^ what to insert

300265 -> Manipulation commons schemas params '[]

301266insertInto_ tab qry =

302267 insertInto tab qry OnConflictDoRaise (Returning_ Nil)

303268

304−-- | A `QueryClause` describes what to `insertInto` a table.

305269data QueryClause commons schemas params columns where

306270 Values

307271 :: SOP.SListI columns

308− => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

309− -- ^ row of values

310− -> [NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns]

311− -- ^ additional rows of values

272+ => NP (ColumnExpression 'Ungrouped schemas params '[]) columns

273+ -> [NP (ColumnExpression 'Ungrouped schemas params '[]) columns]

312274 -> QueryClause commons schemas params columns

313275 Select

314276 :: SOP.SListI columns

315− => NP (Aliased (Optional (Expression '[] commons grp schemas params from))) columns

316− -- ^ row of values

277+ => NP (ColumnExpression grp schemas params from) columns

317278 -> TableExpression '[] commons grp schemas params from

318− -- ^ from a table expression

319279 -> QueryClause commons schemas params columns

320280 Subquery

321281 :: ColumnsToRow columns ~ row

322282 => Query '[] commons schemas params row

323− -- ^ subquery to insert

324283 -> QueryClause commons schemas params columns

325284

326285instance RenderSQL (QueryClause commons schemas params columns) where

@@ -339,41 +298,109 @@ instance RenderSQL (QueryClause commons schemas params columns) where

339298 Subquery qry -> renderQuery qry

340299 where

341300 renderSQLPartMaybe, renderValuePartMaybe

342− :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

343− -> Maybe ByteString

301+ :: ColumnExpression grp schemas params from column -> Maybe ByteString

344302 renderSQLPartMaybe = \case

345− Default `As` _ -> Nothing

346− Set _ `As` name -> Just $ renderSQL name

303+ DefaultAs _ -> Nothing

304+ Specific (_ `As` name) -> Just $ renderSQL name

347305 renderValuePartMaybe = \case

348− Default `As` _ -> Nothing

349− Set value `As` _ -> Just $ renderExpression value

306+ DefaultAs _ -> Nothing

307+ Specific (value `As` _) -> Just $ renderExpression value

350308 renderSQLPart, renderValuePart

351− :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

352− -> ByteString

353− renderSQLPart (_ `As` name) = renderSQL name

354− renderValuePart (value `As` _) = renderSQL value

309+ :: ColumnExpression grp schemas params from column -> ByteString

310+ renderSQLPart = \case

311+ DefaultAs name -> renderSQL name

312+ Specific (_ `As` name) -> renderSQL name

313+ renderValuePart = \case

314+ DefaultAs _ -> "DEFAULT"

315+ Specific (value `As` _) -> renderExpression value

355316

356−-- | `Values_` describes a single `NP` list of `Aliased` `Optional` `Expression`s

357−-- whose `ColumnsType` must match the tables'.

358317pattern Values_

359318 :: SOP.SListI columns

360− => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

361− -- ^ row of values

319+ => NP (ColumnExpression 'Ungrouped schemas params '[]) columns

362320 -> QueryClause commons schemas params columns

363321pattern Values_ vals = Values vals []

364322

365−-- | `Optional` is either `Default` or a value, parameterized by an appropriate

366−-- `ColumnConstraint`.

367−data Optional expr ty where

368− -- | Use the `Default` value for a column.

369− Default :: Optional expr ('Def :=> ty)

370− -- | `Set` a value for a column.

371− Set :: expr ty -> Optional expr (def :=> ty)

372−

373−instance (forall x. RenderSQL (expr x)) => RenderSQL (Optional expr ty) where

323+data ColumnExpression grp schemas params from column where

324+ DefaultAs

325+ :: KnownSymbol col

326+ => Alias col

327+ -> ColumnExpression grp schemas params from (col ::: 'Def :=> ty)

328+ Specific

329+ :: Aliased (Expression '[] '[] grp schemas params from) (col ::: ty)

330+ -> ColumnExpression grp schemas params from (col ::: defness :=> ty)

331+

332+instance (KnownSymbol col, column ~ (col ::: defness :=> ty))

333+ => Aliasable col

334+ (Expression '[] '[] grp schemas params from ty)

335+ (ColumnExpression grp schemas params from column) where

336+ expression `as` col = Specific (expression `As` col)

337+instance (KnownSymbol col, columns ~ '[col ::: defness :=> ty])

338+ => Aliasable col

339+ (Expression '[] '[] grp schemas params from ty)

340+ (NP (ColumnExpression grp schemas params from) columns) where

341+ expression `as` col = expression `as` col :* Nil

342+instance (KnownSymbol col, column ~ (col ::: 'Def :=> ty))

343+ => DefaultAliasable col (ColumnExpression grp schemas params from column) where

344+ defaultAs = DefaultAs

345+instance (KnownSymbol col, columns ~ '[col ::: 'Def :=> ty])

346+ => DefaultAliasable col (NP (ColumnExpression grp schemas params from) columns) where

347+ defaultAs col = defaultAs col :* Nil

348+

349+instance (HasUnique tab from row, Has col row ty, column ~ (col ::: defness :=> ty))

350+ => IsLabel col (ColumnExpression 'Ungrouped schemas params from column) where

351+ fromLabel = fromLabel @col `as` Alias

352+instance (HasUnique tab from row, Has col row ty, columns ~ '[col ::: defness :=> ty])

353+ => IsLabel col

354+ (NP (ColumnExpression 'Ungrouped schemas params from) columns) where

355+ fromLabel = fromLabel @col `as` Alias

356+

357+instance (Has tab from row, Has col row ty, column ~ (col ::: defness :=> ty))

358+ => IsQualified tab col (ColumnExpression 'Ungrouped schemas params from column) where

359+ tab ! col = tab ! col `as` col

360+instance (Has tab from row, Has col row ty, columns ~ '[col ::: defness :=> ty])

361+ => IsQualified tab col (NP (ColumnExpression 'Ungrouped schemas params from) columns) where

362+ tab ! col = tab ! col `as` col

363+

364+instance

365+ ( HasUnique tab from row

366+ , Has col row ty

367+ , GroupedBy tab col bys

368+ , column ~ (col ::: defness :=> ty)

369+ ) => IsLabel col

370+ (ColumnExpression ('Grouped bys) schemas params from column) where

371+ fromLabel = fromLabel @col `as` Alias

372+instance

373+ ( HasUnique tab from row

374+ , Has col row ty

375+ , GroupedBy tab col bys

376+ , columns ~ '[col ::: defness :=> ty]

377+ ) => IsLabel col

378+ (NP (ColumnExpression ('Grouped bys) schemas params from) columns) where

379+ fromLabel = fromLabel @col `as` Alias

380+

381+instance

382+ ( Has tab from row

383+ , Has col row ty

384+ , GroupedBy tab col bys

385+ , column ~ (col ::: defness :=> ty)

386+ ) => IsQualified tab col

387+ (ColumnExpression ('Grouped bys) schemas params from column) where

388+ tab ! col = tab ! col `as` col

389+instance

390+ ( Has tab from row

391+ , Has col row ty

392+ , GroupedBy tab col bys

393+ , columns ~ '[col ::: defness :=> ty]

394+ ) => IsQualified tab col

395+ (NP (ColumnExpression ('Grouped bys) schemas params from) columns) where

396+ tab ! col = tab ! col :* Nil

397+

398+instance RenderSQL (ColumnExpression grp schemas params from column) where

374399 renderSQL = \case

375− Default -> "DEFAULT"

376− Set expr -> renderSQL expr

400+ DefaultAs col ->

401+ renderSQL col <+> "=" <+> "DEFAULT"

402+ Specific (expression `As` col) ->

403+ renderSQL col <+> "=" <+> renderSQL expression

377404

378405-- | A `ReturningClause` computes and return value(s) based

379406-- on each row actually inserted, updated or deleted. This is primarily

@@ -383,7 +410,7 @@ instance (forall x. RenderSQL (expr x)) => RenderSQL (Optional expr ty) where

383410-- deleted will be returned. For example, if a row was locked

384411-- but not updated because an `OnConflict` `DoUpdate` condition was not satisfied,

385412-- the row will not be returned. `Returning` `Star` will return all columns

386−-- in the row. Use `Returning` `Nil` in the common case where no return

413+-- in the row. Use @Returning Nil@ in the common case where no return

387414-- values are desired.

388415newtype ReturningClause commons schemas params from row =

389416 Returning (Selection '[] commons 'Ungrouped schemas params from row)

@@ -393,11 +420,9 @@ instance RenderSQL (ReturningClause commons schemas params from row) where

393420 Returning (List Nil) -> ""

394421 Returning selection -> " RETURNING" <+> renderSQL selection

395422

396−-- | `Returning` a `List`

397423pattern Returning_

398424 :: SOP.SListI row

399425 => NP (Aliased (Expression '[] commons 'Ungrouped schemas params from)) row

400− -- ^ row of values

401426 -> ReturningClause commons schemas params from row

402427pattern Returning_ list = Returning (List list)

403428

@@ -410,9 +435,7 @@ data ConflictClause tab commons schemas params table where

410435 OnConflictDoRaise :: ConflictClause tab commons schemas params table

411436 OnConflict

412437 :: ConflictTarget constraints

413− -- ^ conflict target

414438 -> ConflictAction tab commons schemas params columns

415− -- ^ conflict action

416439 -> ConflictClause tab commons schemas params (constraints :=> columns)

417440

418441-- | Render a `ConflictClause`.

@@ -423,17 +446,6 @@ instance SOP.SListI (TableToColumns table)

423446 OnConflict target action -> " ON CONFLICT"

424447 <+> renderSQL target <+> renderSQL action

425448

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

437449data ConflictAction tab commons schemas params columns where

438450 DoNothing :: ConflictAction tab commons schemas params columns

439451 DoUpdate

@@ -442,9 +454,8 @@ data ConflictAction tab commons schemas params columns where

442454 , columns ~ (col0 ': cols)

443455 , SOP.All (HasIn columns) subcolumns

444456 , AllUnique subcolumns )

445− => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]))) subcolumns

457+ => NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]) subcolumns

446458 -> [Condition '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]]

447− -- ^ WHERE `Condition`s

448459 -> ConflictAction tab commons schemas params columns

449460

450461instance RenderSQL (ConflictAction tab commons schemas params columns) where

@@ -452,17 +463,11 @@ instance RenderSQL (ConflictAction tab commons schemas params columns) where

452463 DoNothing -> "DO NOTHING"

453464 DoUpdate updates whs'

454465 -> "DO UPDATE SET"

455− <+> renderCommaSeparated renderUpdate updates

466+ <+> renderCommaSeparated renderSQL updates

456467 <> case whs' of

457468 [] -> ""

458469 wh:whs -> " WHERE" <+> renderSQL (foldr (.&&) wh whs)

459470

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−

466471-- | A `ConflictTarget` specifies the constraint violation that triggers a

467472-- `ConflictAction`.

468473data ConflictTarget constraints where

@@ -485,6 +490,7 @@ UPDATE statements

485490update

486491 :: ( SOP.SListI columns

487492 , SOP.SListI row1

493+ , db ~ (commons :=> schemas)

488494 , Has sch schemas schema

489495 , Has tab schema ('Table table)

490496 , row0 ~ TableToRow table

@@ -492,7 +498,7 @@ update

492498 , SOP.All (HasIn columns) subcolumns

493499 , AllUnique subcolumns )

494500 => QualifiedAlias sch tab -- ^ table to update

495− -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row0]))) subcolumns

501+ -> NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row0]) subcolumns

496502 -- ^ modified values to replace old values

497503 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row0]

498504 -- ^ condition under which to perform update on a row

@@ -502,13 +508,14 @@ update tab columns wh returning = UnsafeManipulation $

502508 "UPDATE"

503509 <+> renderSQL tab

504510 <+> "SET"

505− <+> renderCommaSeparated renderUpdate columns

511+ <+> renderCommaSeparated renderSQL columns

506512 <+> "WHERE" <+> renderSQL wh

507513 <> renderSQL returning

508514

509515-- | Update a row returning `Nil`.

510516update_

511517 :: ( SOP.SListI columns

518+ , db ~ (commons :=> schemas)

512519 , Has sch schemas schema

513520 , Has tab schema ('Table table)

514521 , row ~ TableToRow table

@@ -516,7 +523,7 @@ update_

516523 , SOP.All (HasIn columns) subcolumns

517524 , AllUnique subcolumns )

518525 => QualifiedAlias sch tab -- ^ table to update

519− -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row]))) subcolumns

526+ -> NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row]) subcolumns

520527 -- ^ modified values to replace old values

521528 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]

522529 -- ^ condition under which to perform update on a row

@@ -527,25 +534,16 @@ update_ tab columns wh = update tab columns wh (Returning_ Nil)

527534DELETE statements

528535-----------------------------------------}

529536

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.

539537data UsingClause commons schemas params from where

540538 NoUsing :: UsingClause commons schemas params '[]

541539 Using

542540 :: FromClause '[] commons schemas params from

543− -- ^ what to use

544541 -> UsingClause commons schemas params from

545542

546543-- | Delete rows from a table.

547544deleteFrom

548545 :: ( SOP.SListI row1

546+ , db ~ (commons :=> schemas)

549547 , Has sch schemas schema

550548 , Has tab schema ('Table table)

551549 , row0 ~ TableToRow table

@@ -567,7 +565,8 @@ deleteFrom tab using wh returning = UnsafeManipulation $

567565

568566-- | Delete rows returning `Nil`.

569567deleteFrom_

570− :: ( Has sch schemas schema

568+ :: ( db ~ (commons :=> schemas)

569+ , Has sch schemas schema

571570 , Has tab schema ('Table table)

572571 , row ~ TableToRow table

573572 , columns ~ TableToColumns table )

@@ -576,3 +575,17 @@ deleteFrom_

576575 -- ^ condition under which to delete a row

577576 -> Manipulation commons schemas params '[]

578577deleteFrom_ tab wh = deleteFrom tab NoUsing wh (Returning_ Nil)

578+

579+-- | This has the behaviour of a cartesian product, taking all

580+-- possible combinations between @left@ and @right@ - exactly like a

581+-- `crossJoin`. Used when no `crossJoin` syntax is required but simply

582+-- a comma separated list of tables. Typical case is the `UsingClause`

583+-- of a `deleteFrom` query.

584+also

585+ :: FromClause outer commons schemas params right

586+ -- ^ right

587+ -> FromClause outer commons schemas params left

588+ -- ^ left

589+ -> FromClause outer commons schemas params (Join left right)

590+also right left = UnsafeFromClause $

591+ renderSQL left <> "," <+> renderSQL right

squeal-postgresql/src/Squeal/PostgreSQL/Migration.hs+57−53

@@ -66,7 +66,7 @@ let

6666 }

6767:}

6868

69−Now that we have a couple migrations we can chain them together into a `Path`.

69+Now that we have a couple migrations we can chain them together into an `AlignedList`.

7070

7171>>> let migrations = makeUsers :>> makeEmails :>> Done

7272

@@ -156,6 +156,7 @@ import Data.Function ((&))

156156import Data.List ((\\))

157157import Data.Text (Text)

158158import Data.Time (UTCTime)

159+import Generics.SOP (K (..))

159160import Prelude hiding ((.), id)

160161import System.Environment

161162import UnliftIO (MonadIO (..))

@@ -164,21 +165,7 @@ import qualified Data.Text.IO as Text (putStrLn)

164165import qualified Generics.SOP as SOP

165166import qualified GHC.Generics as GHC

166167

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

168+import Squeal.PostgreSQL

182169

183170-- | A `Migration` is a named "isomorphism" over a given category.

184171-- It should contain an inverse pair of `up` and `down`

@@ -192,34 +179,34 @@ data Migration p schemas0 schemas1 = Migration

192179

193180{- |

194181A `Migratory` @p@ is a `Category` for which one can execute or rewind

195−a `Path` of `Migration`s over @p@. This includes the category of pure

182+an `AlignedList` of `Migration`s over @p@. This includes the category of pure

196183SQL `Definition`s and the category of impure `Terminally` `PQ` `IO` actions.

197184-}

198185class Category p => Migratory p where

199186

200187 {- |

201− Run a `Path` of `Migration`s.

188+ Run an `AlignedList` of `Migration`s.

202189 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

203− In one transaction, for each each `Migration` query to see if the `Migration` has been executed;

204− if not, `up` the `Migration` and insert its `name` in the `MigrationsTable`.

190+ In a transaction for each each `Migration`, query to see if the `Migration` has been executed;

191+ if not, execute the `Migration` and insert a row in the `MigrationsTable`.

205192 -}

206193 migrateUp

207− :: Path (Migration p) schemas0 schemas1

194+ :: AlignedList (Migration p) schemas0 schemas1

208195 -> PQ schemas0 schemas1 IO ()

209196

210197 {- |

211− Rewind a `Path` of `Migration`s.

198+ Rewind an `AlignedList` of `Migration`s.

212199 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

213− In one transaction, for each each `Migration` query to see if the `Migration` has been executed;

214− if so, `down` the `Migration` and delete its `name` in the `MigrationsTable`.

200+ In a transaction for each each `Migration`, query to see if the `Migration` has been executed;

201+ if so, rewind the `Migration` and delete its row in the `MigrationsTable`.

215202 -}

216203 migrateDown

217− :: Path (Migration p) schemas0 schemas1

204+ :: AlignedList (Migration p) schemas0 schemas1

218205 -> PQ schemas1 schemas0 IO ()

219206

220207instance Migratory Definition where

221− migrateUp = migrateUp . cmap pureMigration

222− migrateDown = migrateDown . cmap pureMigration

208+ migrateUp = migrateUp . alignedMap pureMigration

209+ migrateDown = migrateDown . alignedMap pureMigration

223210

224211{- | `Terminally` turns an indexed monad transformer and the monad it transforms

225212into a category by restricting the return type to @()@ and permuting the type variables.

@@ -251,8 +238,8 @@ terminally = Terminally . void

251238-- | A `pureMigration` turns a `Migration` involving only pure SQL

252239-- `Definition`s into a `Migration` that may be combined with arbitrary `IO`.

253240pureMigration

254− :: Migration Definition schemas0 schemas1

255− -> Migration (Terminally PQ IO) schemas0 schemas1

241+ :: Migration Definition schema0 schema1

242+ -> Migration (Terminally PQ IO) schema0 schema1

256243pureMigration migration = Migration

257244 { name = name migration

258245 , up = terminally . define $ up migration

@@ -261,64 +248,81 @@ pureMigration migration = Migration

261248

262249instance Migratory (Terminally PQ IO) where

263250

264− migrateUp migration = unsafePQ . transactionally_ $ do

251+ migrateUp migration = unsafePQ $

265252 define createMigrations

266− upMigrations migration

253+ & pqBind okResult

254+ & pqThen (transactionallySchema_ (upMigrations migration))

267255

268256 where

269257

270258 upMigrations

271− :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

259+ :: AlignedList (Migration (Terminally PQ IO)) schemas0 schemas1

272260 -> PQ MigrationsSchemas MigrationsSchemas IO ()

273261 upMigrations = \case

274262 Done -> return ()

275− step :>> steps -> upMigration step >> upMigrations steps

263+ step :>> steps -> upMigration step & pqThen (upMigrations steps)

276264

277265 upMigration

278266 :: Migration (Terminally PQ IO) schemas0 schemas1

279267 -> PQ MigrationsSchemas MigrationsSchemas IO ()

280− upMigration step = do

281− executed <- queryExecuted step

282− unless (executed == 1) $ do

283− unsafePQ . runTerminally $ up step

284− manipulateParams_ insertMigration (Only (name step))

268+ upMigration step =

269+ queryExecuted step

270+ & pqBind ( \ executed -> unless (executed == 1)

271+ $ unsafePQ (runTerminally (up step))

272+ & pqThen (manipulateParams insertMigration (Only (name step)))

273+ -- insert execution record

274+ & pqBind okResult )

285275

286276 queryExecuted

287277 :: Migration (Terminally PQ IO) schemas0 schemas1

288278 -> PQ MigrationsSchemas MigrationsSchemas IO Row

289279 queryExecuted step = do

290280 result <- runQueryParams selectMigration (Only (name step))

281+ okResult result

291282 ntuples result

292283

293− migrateDown migrations = unsafePQ . transactionally_ $ do

284+ migrateDown migrations = unsafePQ $

294285 define createMigrations

295− downMigrations migrations

286+ & pqBind okResult

287+ & pqThen (transactionallySchema_ (downMigrations migrations))

296288

297289 where

298290

299291 downMigrations

300− :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

292+ :: AlignedList (Migration (Terminally PQ IO)) schemas0 schemas1

301293 -> PQ MigrationsSchemas MigrationsSchemas IO ()

302294 downMigrations = \case

303295 Done -> return ()

304− step :>> steps -> downMigrations steps >> downMigration step

296+ step :>> steps -> downMigrations steps & pqThen (downMigration step)

305297

306298 downMigration

307299 :: Migration (Terminally PQ IO) schemas0 schemas1

308300 -> PQ MigrationsSchemas MigrationsSchemas IO ()

309− downMigration step = do

310− executed <- queryExecuted step

311− unless (executed == 0) $ do

312− unsafePQ . runTerminally $ down step

313− manipulateParams_ deleteMigration (Only (name step))

301+ downMigration step =

302+ queryExecuted step

303+ & pqBind ( \ executed -> unless (executed == 0)

304+ $ unsafePQ (runTerminally (down step))

305+ & pqThen (manipulateParams deleteMigration (Only (name step)))

306+ -- delete execution record

307+ & pqBind okResult )

314308

315309 queryExecuted

316310 :: Migration (Terminally PQ IO) schemas0 schemas1

317311 -> PQ MigrationsSchemas MigrationsSchemas IO Row

318312 queryExecuted step = do

319313 result <- runQueryParams selectMigration (Only (name step))

314+ okResult result

320315 ntuples result

321316

317+okResult :: K Result results -> PQ schema schema IO ()

318+okResult result = do

319+ status <- resultStatus result

320+ when (not (status `elem` [CommandOk, TuplesOk])) $ do

321+ errorMessageMaybe <- resultErrorMessage result

322+ case errorMessageMaybe of

323+ Nothing -> error "migration: unknown error"

324+ Just msg -> error ("migration: " <> show msg)

325+

322326unsafePQ :: (Functor m) => PQ db0 db1 m x -> PQ db0' db1' m x

323327unsafePQ (PQ pq) = PQ $ fmap (SOP.K . SOP.unK) . pq . SOP.K . SOP.unK

324328

@@ -353,7 +357,7 @@ createMigrations =

353357-- the time at which it was inserted.

354358insertMigration :: Manipulation_ MigrationsSchemas (Only Text) ()

355359insertMigration = insertInto_ #schema_migrations

356− (Values_ (Set (param @1) `as` #name :* Default `as` #executed_at))

360+ (Values_ ((param @1) `as` #name :* defaultAs #executed_at))

357361

358362-- | Deletes a `Migration` from the `MigrationsTable`, returning

359363-- the time at which it was inserted.

@@ -363,8 +367,8 @@ deleteMigration = deleteFrom_ #schema_migrations (#name .== param @1)

363367-- | Selects a `Migration` from the `MigrationsTable`, returning

364368-- the time at which it was inserted.

365369selectMigration

366− :: Query_ MigrationsSchemas (Only Text) (Only UTCTime)

367−selectMigration = select_ (#executed_at `as` #fromOnly)

370+ :: Query_ MigrationsSchemas (Only Text) (P ("executed_at" ::: UTCTime))

371+selectMigration = select_ #executed_at

368372 $ from (table (#schema_migrations))

369373 & where_ (#name .== param @1)

370374

@@ -384,7 +388,7 @@ defaultMain

384388 :: Migratory p

385389 => ByteString

386390 -- ^ connection string

387− -> Path (Migration p) db0 db1

391+ -> AlignedList (Migration p) db0 db1

388392 -- ^ migrations

389393 -> IO ()

390394defaultMain connectTo migrations = do

@@ -405,12 +409,12 @@ defaultMain connectTo migrations = do

405409 migrateStatus :: PQ schema schema IO ()

406410 migrateStatus = unsafePQ $ do

407411 runNames <- getRunMigrationNames

408− let names = ctoList name migrations

412+ let names = extractList name migrations

409413 unrunNames = names \\ runNames

410414 liftIO $ displayRunned runNames >> displayUnrunned unrunNames

411415

412416 suppressNotices :: PQ schema schema IO ()

413− suppressNotices = manipulate_ $

417+ suppressNotices = void . manipulate $

414418 UnsafeManipulation "SET client_min_messages TO WARNING;"

415419

416420 readCommandFromArgs :: IO (Maybe MigrateCommand)

squeal-postgresql/src/Squeal/PostgreSQL/PG.hs+93−97

@@ -1,29 +1,18 @@

1−{-|

2−Module: Squeal.PostgreSQL.PG

3−Description: Embedding of Haskell types into Postgres's type system

4−Copyright: (c) Eitan Chatav, 2010

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−`Squeal.PostgreSQL.PG` provides type families for turning Haskell

9−`Type`s into corresponding Postgres types.

10−-}

112{-# LANGUAGE

123 AllowAmbiguousTypes

13− , DeriveAnyClass

144 , DeriveFoldable

155 , DeriveFunctor

166 , DeriveGeneric

177 , DeriveTraversable

18− , DerivingStrategies

198 , DefaultSignatures

209 , FlexibleContexts

2110 , FlexibleInstances

2211 , FunctionalDependencies

2312 , GADTs

2413 , LambdaCase

25− , MultiParamTypeClasses

2614 , OverloadedStrings

15+ , MultiParamTypeClasses

2716 , ScopedTypeVariables

2817 , TypeApplications

2918 , TypeFamilies

@@ -39,6 +28,7 @@ module Squeal.PostgreSQL.PG

3928 , NullPG

4029 , TuplePG

4130 , RowPG

31+ , Entity

4232 -- * Storage newtypes

4333 , Money (..)

4434 , Json (..)

@@ -47,7 +37,7 @@ module Squeal.PostgreSQL.PG

4737 , Enumerated (..)

4838 , VarArray (..)

4939 , FixArray (..)

50− , LibPQ.Oid (..)

40+ , SOP.P (..)

5141 -- * Type families

5242 , LabelsPG

5343 , DimPG

@@ -55,6 +45,7 @@ module Squeal.PostgreSQL.PG

5545 , TupleOf

5646 , TupleCodeOf

5747 , RowOf

48+ , ColumnsOf

5849 , ConstructorsOf

5950 , ConstructorNameOf

6051 , ConstructorNamesOf

@@ -66,6 +57,7 @@ import Data.Int (Int16, Int32, Int64)

6657import Data.Scientific (Scientific)

6758import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime)

6859import Data.Vector (Vector)

60+import Data.Word (Word16, Word32, Word64)

6961import Data.UUID.Types (UUID)

7062import GHC.TypeLits

7163import Network.IP.Addr (NetAddr, IP)

@@ -74,13 +66,13 @@ import qualified Data.ByteString.Lazy as Lazy (ByteString)

7466import qualified Data.ByteString as Strict (ByteString)

7567import qualified Data.Text.Lazy as Lazy (Text)

7668import qualified Data.Text as Strict (Text)

77−import qualified Database.PostgreSQL.LibPQ as LibPQ

7869import qualified GHC.Generics as GHC

7970import qualified Generics.SOP as SOP

8071import qualified Generics.SOP.Record as SOP

8172import qualified Generics.SOP.Type.Metadata as Type

8273

8374import Squeal.PostgreSQL.Alias

75+import Squeal.PostgreSQL.List

8476import Squeal.PostgreSQL.Schema

8577

8678-- $setup

@@ -99,51 +91,30 @@ PG LocalTime :: PGType

9991>>> type instance PG MyDouble = 'PGfloat8

10092-}

10193type family PG (hask :: Type) :: PGType

102−-- | `PGbool`

10394type instance PG Bool = 'PGbool

104−-- | `PGint2`

10595type instance PG Int16 = 'PGint2

106−-- | `PGint4`

10796type instance PG Int32 = 'PGint4

108−-- | `PGint8`

10997type instance PG Int64 = 'PGint8

110−-- | `PGint2`

111−type instance PG LibPQ.Oid = 'PGoid

112−-- | `PGnumeric`

98+type instance PG Word16 = 'PGint2

99+type instance PG Word32 = 'PGint4

100+type instance PG Word64 = 'PGint8

113101type instance PG Scientific = 'PGnumeric

114−-- | `PGfloat4`

115102type instance PG Float = 'PGfloat4

116−-- | `PGfloat8`

117103type instance PG Double = 'PGfloat8

118−-- | `PGchar` @1@

119104type instance PG Char = 'PGchar 1

120−-- | `PGtext`

121105type instance PG Strict.Text = 'PGtext

122−-- | `PGtext`

123106type instance PG Lazy.Text = 'PGtext

124−-- | `PGtext`

125107type instance PG String = 'PGtext

126−-- | `PGbytea`

127108type instance PG Strict.ByteString = 'PGbytea

128−-- | `PGbytea`

129109type instance PG Lazy.ByteString = 'PGbytea

130−-- | `PGtimestamp`

131110type instance PG LocalTime = 'PGtimestamp

132−-- | `PGtimestamptz`

133111type instance PG UTCTime = 'PGtimestamptz

134−-- | `PGdate`

135112type instance PG Day = 'PGdate

136−-- | `PGtime`

137113type instance PG TimeOfDay = 'PGtime

138−-- | `PGtimetz`

139114type instance PG (TimeOfDay, TimeZone) = 'PGtimetz

140−-- | `PGinterval`

141115type instance PG DiffTime = 'PGinterval

142−-- | `PGuuid`

143116type instance PG UUID = 'PGuuid

144−-- | `PGinet`

145117type instance PG (NetAddr IP) = 'PGinet

146−-- | `PGjson`

147118type instance PG Value = 'PGjson

148119

149120{-| The `LabelsPG` type family calculates the constructors of a

@@ -164,7 +135,7 @@ type family LabelsPG (hask :: Type) :: [Type.ConstructorName] where

164135`RowPG` turns a Haskell `Type` into a `RowType`.

165136

166137`RowPG` may be applied to normal Haskell record types provided they

167−have `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

138+have the `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

168139

169140>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic

170141>>> instance SOP.Generic Person

@@ -172,22 +143,84 @@ have `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

172143>>> :kind! RowPG Person

173144RowPG Person :: [(Symbol, NullityType)]

174145= '["name" ::: 'NotNull 'PGtext, "age" ::: 'NotNull 'PGint4]

146+

147+Or to tuples of `SOP.P` types;

148+

149+>>> :kind! RowPG (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32))

150+RowPG (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

151+ NullityType)]

152+= '[ '("id", 'NotNull 'PGint4), "foreign_id" ::: 'NotNull 'PGint4]

153+

154+Or to tuples which mix `SOP.P` types and record types.

155+

156+>>> :kind! RowPG (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32))

157+RowPG (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

158+ NullityType)]

159+= '[ '("id", 'NotNull 'PGint4), '("name", 'NotNull 'PGtext),

160+ '("age", 'NotNull 'PGint4), "foreign_id" ::: 'NotNull 'PGint4]

175161-}

176162type family RowPG (hask :: Type) :: RowType where

163+ RowPG (hask1, hask2) = Join (RowPG hask1) (RowPG hask2)

164+ RowPG (hask1, hask2, hask3) =

165+ Join (RowPG hask1) (RowPG (hask2, hask3))

166+ RowPG (hask1, hask2, hask3, hask4) =

167+ Join (RowPG hask1) (RowPG (hask2, hask3, hask4))

168+ RowPG (hask1, hask2, hask3, hask4, hask5) =

169+ Join (RowPG hask1) (RowPG (hask2, hask3, hask4, hask5))

170+ RowPG (SOP.P (col ::: ty)) = '[col ::: NullPG ty]

177171 RowPG hask = RowOf (SOP.RecordCodeOf hask)

178172

179−-- | `RowOf` applies `NullPG` to the fields of a list.

180173type family RowOf (record :: [(Symbol, Type)]) :: RowType where

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

189− RowOf (col ::: ty ': record) = col ::: NullPG ty ': RowOf record

190174 RowOf '[] = '[]

175+ RowOf (col ::: ty ': record) = col ::: NullPG ty ': RowOf record

176+

177+type family ColumnsOf (record :: [(Symbol, Type)]) :: ColumnsType where

178+ ColumnsOf '[] = '[]

179+ ColumnsOf (col ::: ty ': record) =

180+ col ::: 'NoDef :=> NullPG ty ': ColumnsOf record

181+

182+{- |

183+`Entity` turns a Haskell `Type` into a `ColumnsType`.

184+

185+`Entity` may be applied to normal Haskell record types provided they

186+have the `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

187+

188+>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic

189+>>> instance SOP.Generic Person

190+>>> instance SOP.HasDatatypeInfo Person

191+>>> :kind! Entity Person

192+Entity Person :: [(Symbol, (ColumnConstraint, NullityType))]

193+= '["name" ::: ('NoDef :=> 'NotNull 'PGtext),

194+ "age" ::: ('NoDef :=> 'NotNull 'PGint4)]

195+

196+Or to tuples of `SOP.P` types;

197+

198+>>> :kind! Entity (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32))

199+Entity (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

200+ ColumnType)]

201+= '[ '("id", 'Def :=> 'NotNull 'PGint4),

202+ "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]

203+

204+Or to tuples which mix `SOP.P` types and record types.

205+

206+>>> :kind! Entity (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32))

207+Entity (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

208+ ColumnType)]

209+= '[ '("id", 'Def :=> 'NotNull 'PGint4),

210+ '("name", 'NoDef :=> 'NotNull 'PGtext),

211+ '("age", 'NoDef :=> 'NotNull 'PGint4),

212+ "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]

213+-}

214+type family Entity (hask :: Type) :: ColumnsType where

215+ Entity (hask1, hask2) = Join (Entity hask1) (Entity hask2)

216+ Entity (hask1, hask2, hask3) =

217+ Join (Entity hask1) (Entity (hask2, hask3))

218+ Entity (hask1, hask2, hask3, hask4) =

219+ Join (Entity hask1) (Entity (hask2, hask3, hask4))

220+ Entity (hask1, hask2, hask3, hask4, hask5) =

221+ Join (Entity hask1) (Entity (hask2, hask3, hask4, hask5))

222+ Entity (SOP.P (col ::: ty)) = '[col ::: 'Def :=> NullPG ty]

223+ Entity hask = ColumnsOf (SOP.RecordCodeOf hask)

191224

192225{- | `NullPG` turns a Haskell type into a `NullityType`.

193226

@@ -212,22 +245,10 @@ TuplePG (Double, Maybe Char) :: [NullityType]

212245type family TuplePG (hask :: Type) :: [NullityType] where

213246 TuplePG hask = TupleOf (TupleCodeOf hask (SOP.Code hask))

214247

215−-- | `TupleOf` turns a list of Haskell `Type`s into a list of `NullityType`s.

216248type family TupleOf (tuple :: [Type]) :: [NullityType] where

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

226− TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple

227249 TupleOf '[] = '[]

250+ TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple

228251

229−-- | `TupleCodeOf` takes the `SOP.Code` of a haskell `Type`

230−-- and if it's a simple product returns it, otherwise giving a `TypeError`.

231252type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where

232253 TupleCodeOf hask '[tuple] = tuple

233254 TupleCodeOf hask '[] =

@@ -268,7 +289,6 @@ type family ConstructorNamesOf (constructors :: [Type.ConstructorInfo])

268289 ConstructorNamesOf (constructor ': constructors) =

269290 ConstructorNameOf constructor ': ConstructorNamesOf constructors

270291

271−-- | `DimPG` turns Haskell nested homogeneous tuples into a list of lengths.

272292type family DimPG (hask :: Type) :: [Nat] where

273293 DimPG (x,x) = 2 ': DimPG x

274294 DimPG (x,x,x) = 3 ': DimPG x

@@ -281,7 +301,6 @@ type family DimPG (hask :: Type) :: [Nat] where

281301 DimPG (x,x,x,x,x,x,x,x,x,x) = 10 ': DimPG x

282302 DimPG x = '[]

283303

284−-- | `FixPG` extracts `NullPG` of the base type of nested homogeneous tuples.

285304type family FixPG (hask :: Type) :: NullityType where

286305 FixPG (x,x) = FixPG x

287306 FixPG (x,x,x) = FixPG x

@@ -311,7 +330,7 @@ let

311330>>> let input = Only (Money 20020)

312331

313332>>> :{

314−withConnection "host=localhost port=5432 dbname=exampledb" $ do

333+void . withConnection "host=localhost port=5432 dbname=exampledb" $ do

315334 result <- runQueryParams roundTrip input

316335 Just output <- firstRow result

317336 liftIO . print $ input == output

@@ -319,70 +338,47 @@ withConnection "host=localhost port=5432 dbname=exampledb" $ do

319338True

320339-}

321340newtype Money = Money { cents :: Int64 }

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

323− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

324−-- | `PGmoney`

341+ deriving (Eq, Ord, Show, Read, GHC.Generic)

325342type instance PG Money = 'PGmoney

326343

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

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

329346-}

330347newtype Json hask = Json {getJson :: hask}

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

332− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

333−-- | `PGjson`

348+ deriving (Eq, Ord, Show, Read, GHC.Generic)

334349type instance PG (Json hask) = 'PGjson

335350

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

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

338353-}

339354newtype Jsonb hask = Jsonb {getJsonb :: hask}

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

341− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

342−-- | `PGjsonb`

355+ deriving (Eq, Ord, Show, Read, GHC.Generic)

343356type instance PG (Jsonb hask) = 'PGjsonb

344357

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

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

347360-}

348361newtype 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)@

362+ deriving (Eq, Ord, Show, Read, GHC.Generic)

352363type instance PG (Composite hask) = 'PGcomposite (RowPG hask)

353364

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

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

356367-}

357368newtype 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)@

369+ deriving (Eq, Ord, Show, Read, GHC.Generic)

361370type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)

362371

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

364373type 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)

369374-}

370375newtype 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)@

376+ deriving (Eq, Ord, Show, Read, GHC.Generic)

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

375−type instance PG (VarArray [hask]) = 'PGvararray (NullPG hask)

376378

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

378380type 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)

383381-}

384382newtype 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)

383+ deriving (Eq, Ord, Show, Read, GHC.Generic)

384+type instance PG (FixArray x) = 'PGfixarray (DimPG x) (FixPG x)

squeal-postgresql/src/Squeal/PostgreSQL/PQ.hs+40−96

@@ -64,21 +64,17 @@ module Squeal.PostgreSQL.PQ

6464 , resultErrorCode

6565 -- * Exceptions

6666 , SquealException (..)

67− , PQState (..)

68− , okResult

6967 , catchSqueal

7068 , handleSqueal

71− , trySqueal

7269 ) where

7370

7471import Control.Exception (Exception, throw)

7572import Control.Monad.Except

7673import Control.Monad.Morph

77−import UnliftIO (MonadUnliftIO (..), bracket, catch, handle, try)

74+import UnliftIO (MonadUnliftIO (..), bracket, catch, handle)

7875import Data.ByteString (ByteString)

7976import Data.Foldable

8077import Data.Function ((&))

81−import Data.Functor ((<&>))

8278import Data.Kind

8379import Data.Text (pack, Text)

8480import Data.Traversable

@@ -87,7 +83,6 @@ import PostgreSQL.Binary.Encoding (encodingBytes)

8783

8884import qualified Control.Monad.Fail as Fail

8985import qualified Database.PostgreSQL.LibPQ as LibPQ

90−import qualified PostgreSQL.Binary.Encoding as Encoding

9186

9287import Squeal.PostgreSQL.Binary

9388import Squeal.PostgreSQL.Definition

@@ -248,16 +243,13 @@ class IndexedMonadTransPQ pq where

248243 -> x -> pq schemas0 schemas2 m z

249244 pqAndThen g f x = pqBind g (f x)

250245

251− -- | Run a `Definition` with `LibPQ.exec`.

246+ -- | Run a `Definition` with `LibPQ.exec`, we expect that libpq obeys the law

252247 --

253− -- It should be functorial in effect.

254− --

255− -- @define id = return ()@

256− -- @define (statement1 >>> statement2) = define statement1 & pqThen (define statement2)@

248+ -- @define statement1 & pqThen (define statement2) = define (statement1 >>> statement2)@

257249 define

258250 :: MonadIO io

259251 => Definition schemas0 schemas1

260− -> pq schemas0 schemas1 io ()

252+ -> pq schemas0 schemas1 io (K LibPQ.Result '[])

261253

262254instance IndexedMonadTransPQ PQ where

263255

@@ -275,7 +267,7 @@ instance IndexedMonadTransPQ PQ where

275267 case resultMaybe of

276268 Nothing -> throw $ ResultException

277269 "define: LibPQ.exec returned no results"

278− Just result -> K <$> okResult_ result

270+ Just result -> return $ K (K result)

279271

280272{- | `MonadPQ` is an @mtl@ style constraint, similar to

281273`Control.Monad.State.Class.MonadState`, for using `Database.PostgreSQL.LibPQ` to

@@ -284,12 +276,8 @@ instance IndexedMonadTransPQ PQ where

284276 with a `ToParams` constraint. It calls `LibPQ.execParams` and

285277 doesn't afraid of anything.

286278

287−* `manipulateParams_` is like `manipulateParams` for a returning-free statement.

288−

289279* `manipulate` is like `manipulateParams` for a parameter-free statement.

290280

291−* `manipulate_` is like `manipulate` for a returning-free statement.

292−

293281* `runQueryParams` is like `manipulateParams` for query statements.

294282

295283* `runQuery` is like `runQueryParams` for a parameter-free statement.

@@ -303,7 +291,7 @@ instance IndexedMonadTransPQ PQ where

303291* `forPrepared` is a flipped `traversePrepared`

304292

305293* `traversePrepared_` is like `traversePrepared` but works on `Foldable`

306− containers for a returning-free statement.

294+ containers and returns unit.

307295

308296* `forPrepared_` is a flipped `traversePrepared_`.

309297

@@ -317,34 +305,24 @@ a default instance.

317305-}

318306class Monad pq => MonadPQ schemas pq | pq -> schemas where

319307 manipulateParams

320− :: (ToParams x params, All OidOfParam params)

308+ :: ToParams x params

321309 => Manipulation '[] schemas params ys

322310 -- ^ `insertInto`, `update` or `deleteFrom`

323311 -> x -> pq (K LibPQ.Result ys)

324312 default manipulateParams

325313 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

326− => (ToParams x params, All OidOfParam params)

314+ => ToParams x params

327315 => Manipulation '[] schemas params ys

328316 -- ^ `insertInto`, `update` or `deleteFrom`

329317 -> x -> pq (K LibPQ.Result ys)

330318 manipulateParams manipulation params = lift $

331319 manipulateParams manipulation params

332320

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−

340321 manipulate :: Manipulation '[] schemas '[] ys -> pq (K LibPQ.Result ys)

341322 manipulate statement = manipulateParams statement ()

342323

343− manipulate_ :: Manipulation '[] schemas '[] '[] -> pq ()

344− manipulate_ = void . manipulate

345−

346324 runQueryParams

347− :: (ToParams x params, All OidOfParam params)

325+ :: ToParams x params

348326 => Query '[] '[] schemas params ys

349327 -- ^ `select` and friends

350328 -> x -> pq (K LibPQ.Result ys)

@@ -357,19 +335,19 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

357335 runQuery q = runQueryParams q ()

358336

359337 traversePrepared

360− :: (ToParams x params, Traversable list, All OidOfParam params)

338+ :: (ToParams x params, Traversable list)

361339 => Manipulation '[] schemas params ys

362340 -- ^ `insertInto`, `update`, or `deleteFrom`, and friends

363341 -> list x -> pq (list (K LibPQ.Result ys))

364342 default traversePrepared

365343 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

366− => (ToParams x params, Traversable list, All OidOfParam params)

344+ => (ToParams x params, Traversable list)

367345 => Manipulation '[] schemas params ys -> list x -> pq (list (K LibPQ.Result ys))

368346 traversePrepared manipulation params = lift $

369347 traversePrepared manipulation params

370348

371349 forPrepared

372− :: (ToParams x params, Traversable list, All OidOfParam params)

350+ :: (ToParams x params, Traversable list)

373351 => list x

374352 -> Manipulation '[] schemas params ys

375353 -- ^ `insertInto`, `update` or `deleteFrom`

@@ -377,13 +355,13 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

377355 forPrepared = flip traversePrepared

378356

379357 traversePrepared_

380− :: (ToParams x params, Foldable list, All OidOfParam params)

358+ :: (ToParams x params, Foldable list)

381359 => Manipulation '[] schemas params '[]

382360 -- ^ `insertInto`, `update` or `deleteFrom`

383361 -> list x -> pq ()

384362 default traversePrepared_

385363 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

386− => (ToParams x params, Foldable list, All OidOfParam params)

364+ => (ToParams x params, Foldable list)

387365 => Manipulation '[] schemas params '[]

388366 -- ^ `insertInto`, `update` or `deleteFrom`

389367 -> list x -> pq ()

@@ -391,7 +369,7 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

391369 traversePrepared_ manipulation params

392370

393371 forPrepared_

394− :: (ToParams x params, Foldable list, All OidOfParam params)

372+ :: (ToParams x params, Foldable list)

395373 => list x

396374 -> Manipulation '[] schemas params '[]

397375 -- ^ `insertInto`, `update` or `deleteFrom`

@@ -411,76 +389,54 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

411389 (UnsafeManipulation q :: Manipulation '[] schemas ps ys) (params :: x) =

412390 PQ $ \ (K conn) -> do

413391 let

414− paramSet

415− :: forall param. OidOfParam param

416− => K (Maybe Encoding.Encoding) param

417− -> K (Maybe (LibPQ.Oid, ByteString, LibPQ.Format)) param

418− paramSet (K maybeEncoding) = K $

419− maybeEncoding <&> \encoding ->

420− (oidOfParam @param, encodingBytes encoding, LibPQ.Binary)

421− params'

422− = hcollapse

423− . hcmap (Proxy @OidOfParam) paramSet

424− $ toParams @x @ps params

392+ toParam' encoding =

393+ (LibPQ.invalidOid, encodingBytes encoding, LibPQ.Binary)

394+ params' = fmap (fmap toParam') (hcollapse (toParams @x @ps params))

425395 q' = q <> ";"

426396 resultMaybe <- liftIO $ LibPQ.execParams conn q' params' LibPQ.Binary

427397 case resultMaybe of

428398 Nothing -> throw $ ResultException

429399 "manipulateParams: LibPQ.execParams returned no results"

430400 Just result -> do

431− okResult_ result

401+ tryResult result

432402 return $ K (K result)

433403

434404 traversePrepared

435405 (UnsafeManipulation q :: Manipulation '[] schemas xs ys) (list :: list x) =

436406 PQ $ \ (K conn) -> liftIO $ do

437− let

438− temp = "temporary_statement"

439− paramOid :: forall p. OidOfParam p => K LibPQ.Oid p

440− paramOid = K (oidOfParam @p)

441− paramOids :: NP (K LibPQ.Oid) xs

442− paramOids = hcpure (Proxy @OidOfParam) paramOid

443− paramOids' :: [LibPQ.Oid]

444− paramOids' = hcollapse paramOids

445− prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

407+ let temp = "temporary_statement"

408+ prepResultMaybe <- LibPQ.prepare conn temp q Nothing

446409 case prepResultMaybe of

447410 Nothing -> throw $ ResultException

448411 "traversePrepared: LibPQ.prepare returned no results"

449− Just prepResult -> okResult_ prepResult

412+ Just prepResult -> tryResult prepResult

450413 results <- for list $ \ params -> do

451414 let

452− toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

415+ toParam' encoding = (encodingBytes encoding,LibPQ.Binary)

453416 params' = fmap (fmap toParam') (hcollapse (toParams @x @xs params))

454417 resultMaybe <- LibPQ.execPrepared conn temp params' LibPQ.Binary

455418 case resultMaybe of

456419 Nothing -> throw $ ResultException

457420 "traversePrepared: LibPQ.execParams returned no results"

458421 Just result -> do

459− okResult_ result

422+ tryResult result

460423 return $ K result

461424 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

462425 case deallocResultMaybe of

463426 Nothing -> throw $ ResultException

464427 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

465− Just deallocResult -> okResult_ deallocResult

428+ Just deallocResult -> tryResult deallocResult

466429 return (K results)

467430

468431 traversePrepared_

469432 (UnsafeManipulation q :: Manipulation '[] schemas xs '[]) (list :: list x) =

470433 PQ $ \ (K conn) -> liftIO $ do

471− let

472− temp = "temporary_statement"

473− paramOid :: forall p. OidOfParam p => K LibPQ.Oid p

474− paramOid = K (oidOfParam @p)

475− paramOids :: NP (K LibPQ.Oid) xs

476− paramOids = hcpure (Proxy @OidOfParam) paramOid

477− paramOids' :: [LibPQ.Oid]

478− paramOids' = hcollapse paramOids

479− prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

434+ let temp = "temporary_statement"

435+ prepResultMaybe <- LibPQ.prepare conn temp q Nothing

480436 case prepResultMaybe of

481437 Nothing -> throw $ ResultException

482438 "traversePrepared_: LibPQ.prepare returned no results"

483− Just prepResult -> okResult_ prepResult

439+ Just prepResult -> tryResult prepResult

484440 for_ list $ \ params -> do

485441 let

486442 toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

@@ -489,12 +445,12 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

489445 case resultMaybe of

490446 Nothing -> throw $ ResultException

491447 "traversePrepared_: LibPQ.execParams returned no results"

492− Just result -> okResult_ result

448+ Just result -> tryResult result

493449 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

494450 case deallocResultMaybe of

495451 Nothing -> throw $ ResultException

496452 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

497− Just deallocResult -> okResult_ deallocResult

453+ Just deallocResult -> tryResult deallocResult

498454 return (K ())

499455

500456 liftPQ pq = PQ $ \ (K conn) -> do

@@ -657,24 +613,24 @@ resultErrorCode

657613 -> io (Maybe ByteString)

658614resultErrorCode = liftResult (flip LibPQ.resultErrorField LibPQ.DiagSqlstate)

659615

660−-- | the state of LibPQ

661−data PQState = PQState

616+-- | `Exception`s that can be thrown by Squeal.

617+data SquealException

618+ = PQException

662619 { sqlExecStatus :: LibPQ.ExecStatus

663620 , sqlStateCode :: Maybe ByteString

664621 -- ^ https://www.postgresql.org/docs/current/static/errcodes-appendix.html

665622 , sqlErrorMessage :: Maybe ByteString

666− } deriving (Eq, Show)

667−

668−-- | `Exception`s that can be thrown by Squeal.

669−data SquealException

670− = PQException PQState

623+ }

671624 | ResultException Text

672625 | ParseException Text

673626 deriving (Eq, Show)

674627instance Exception SquealException

675628

676−okResult_ :: MonadIO io => LibPQ.Result -> io ()

677−okResult_ result = liftIO $ do

629+tryResult

630+ :: MonadIO io

631+ => LibPQ.Result

632+ -> io ()

633+tryResult result = liftIO $ do

678634 status <- LibPQ.resultStatus result

679635 case status of

680636 LibPQ.CommandOk -> return ()

@@ -682,12 +638,7 @@ okResult_ result = liftIO $ do

682638 _ -> do

683639 stateCode <- LibPQ.resultErrorField result LibPQ.DiagSqlstate

684640 msg <- LibPQ.resultErrorMessage result

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

641+ throw $ PQException status stateCode msg

691642

692643-- | Catch `SquealException`s.

693644catchSqueal

@@ -703,10 +654,3 @@ handleSqueal

703654 => (SquealException -> io a) -- ^ handler

704655 -> io a -> io a

705656handleSqueal = 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+99−67

@@ -1,33 +1,11 @@

11{-|

2−Module: Squeal.PostgreSQL.Pool

3−Description: Connection pools

2+Module: Squeal.PostgreSQL.Definition

3+Description: Pooled connections

44Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

8−Connection pools.

9−

10−Typical use case would be to create your pool using `createConnectionPool`

11−and run anything that requires the pool connection with `usingConnectionPool`.

12−

13−Here's a simplified example:

14−

15−>>> import Squeal.PostgreSQL

16−

17−>>> :{

18−do

19− let

20− query :: Query_ (Public '[]) () (Only Char)

21− query = values_ (literal 'a' `as` #fromOnly)

22− pool <- createConnectionPool "host=localhost port=5432 dbname=exampledb" 1 0.5 10

23− chr <- usingConnectionPool pool $ do

24− result <- runQuery query

25− Just (Only a) <- firstRow result

26− return a

27− destroyConnectionPool pool

28− putChar chr

29−:}

30−a

8+A `MonadPQ` for pooled connections.

319-}

3210

3311{-# LANGUAGE

@@ -45,19 +23,51 @@ a

4523

4624module Squeal.PostgreSQL.Pool

4725 ( -- * Pools

48− Pool

26+ PoolPQ (..)

4927 , createConnectionPool

50− , usingConnectionPool

51− , destroyConnectionPool

28+ , Pool

29+ , destroyAllResources

5230 ) where

5331

32+import Control.Monad.Trans

5433import Data.ByteString

5534import Data.Time

56−import Generics.SOP (K(..), unK)

35+import Generics.SOP (K(..))

5736import UnliftIO (MonadUnliftIO (..))

5837import UnliftIO.Pool (Pool, createPool, destroyAllResources, withResource)

5938

39+import qualified Control.Monad.Fail as Fail

40+

6041import 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

6171

6272-- | Create a striped pool of connections.

6373-- 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.

@@ -82,41 +92,63 @@ createConnectionPool

8292createConnectionPool conninfo stripes idle maxResrc =

8393 createPool (connectdb conninfo) finish stripes idle maxResrc

8494

85−{-|

86−Temporarily take a connection from a `Pool`, perform an action with it,

87−and return it to the pool afterwards.

88−

89−If the pool has an idle connection available, it is used immediately.

90−Otherwise, if the maximum number of connections has not yet been reached,

91−a new connection is created and used.

92−If the maximum number of connections has been reached, this function blocks

93−until a connection becomes available.

94−-}

95−usingConnectionPool

96− :: MonadUnliftIO io

97− => Pool (K Connection schemas) -- ^ pool

98− -> PQ schemas schemas io x -- ^ session

99− -> io x

100−usingConnectionPool pool (PQ session) = unK <$> withResource pool session

101−

102−{- |

103−Destroy all connections in all stripes in the pool.

104−Note that this will ignore any exceptions in the destroy function.

105−

106−This function is useful when you detect that all connections

107−in the pool are broken. For example after a database has been

108−restarted all connections opened before the restart will be broken.

109−In that case it's better to close those connections so that

110−`usingConnectionPool` won't take a broken connection from the pool

111−but will open a new connection instead.

112−

113−Another use-case for this function is that when you know you are done

114−with the pool you can destroy all idle connections immediately

115−instead of waiting on the garbage collector to destroy them,

116−thus freeing up those connections sooner.

117−-}

118−destroyConnectionPool

119− :: MonadUnliftIO io

120− => Pool (K Connection schemas) -- ^ pool

121− -> io ()

122−destroyConnectionPool = destroyAllResources

95+-- | `Applicative` instance for `PoolPQ`.

96+instance Monad m => Applicative (PoolPQ schemas m) where

97+ pure x = PoolPQ $ \ _ -> pure x

98+ PoolPQ f <*> PoolPQ x = PoolPQ $ \ pool -> do

99+ f' <- f pool

100+ x' <- x pool

101+ return $ f' x'

102+

103+-- | `Monad` instance for `PoolPQ`.

104+instance Monad m => Monad (PoolPQ schemas m) where

105+ return = pure

106+ PoolPQ x >>= f = PoolPQ $ \ pool -> do

107+ x' <- x pool

108+ runPoolPQ (f x') pool

109+

110+-- | `Fail.MonadFail` instance for `PoolPQ`.

111+instance Monad m => Fail.MonadFail (PoolPQ schemas m) where

112+ fail = Fail.fail

113+

114+-- | `MonadTrans` instance for `PoolPQ`.

115+instance MonadTrans (PoolPQ schemas) where

116+ lift m = PoolPQ $ \ _pool -> m

117+

118+-- | `MonadPQ` instance for `PoolPQ`.

119+instance MonadUnliftIO io => MonadPQ schemas (PoolPQ schemas io) where

120+ manipulateParams manipulation params = PoolPQ $ \ pool -> do

121+ withResource pool $ \ conn -> do

122+ (K result :: K (K Result ys) schemas) <- flip unPQ conn $

123+ manipulateParams manipulation params

124+ return result

125+ traversePrepared manipulation params = PoolPQ $ \ pool ->

126+ withResource pool $ \ conn -> do

127+ (K result :: K (list (K Result ys)) schemas) <- flip unPQ conn $

128+ traversePrepared manipulation params

129+ return result

130+ traversePrepared_ manipulation params = PoolPQ $ \ pool -> do

131+ withResource pool $ \ conn -> do

132+ (_ :: K () schemas) <- flip unPQ conn $

133+ traversePrepared_ manipulation params

134+ return ()

135+ liftPQ m = PoolPQ $ \ pool ->

136+ withResource pool $ \ conn -> do

137+ (K result :: K result schemas) <- flip unPQ conn $

138+ liftPQ m

139+ return result

140+

141+-- | 'MonadIO' instance for 'PoolPQ'.

142+instance (MonadIO m)

143+ => MonadIO (PoolPQ schemas m) where

144+ liftIO = lift . liftIO

145+

146+-- | 'MonadUnliftIO' instance for 'PoolPQ'.

147+instance (MonadUnliftIO m)

148+ => MonadUnliftIO (PoolPQ schemas m) where

149+ withRunInIO

150+ :: ((forall a . PoolPQ schemas m a -> IO a) -> IO b)

151+ -> PoolPQ schemas m b

152+ withRunInIO inner = PoolPQ $ \pool ->

153+ withRunInIO $ \(run :: (forall x . m x -> IO x)) ->

154+ inner (\poolpq -> run $ runPoolPQ poolpq pool)

squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+280−247

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

11{-|

22Module: Squeal.PostgreSQL.Query

33Description: Squeal queries

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

@@ -32,15 +32,13 @@ Squeal queries.

3232

3333module Squeal.PostgreSQL.Query

3434 ( -- * Queries

35− Query_

36− , Query (..)

35+ Query (..)

36+ , Query_

3737 -- ** Select

3838 , select

3939 , select_

4040 , selectDistinct

4141 , selectDistinct_

42− , selectDistinctOn

43− , selectDistinctOn_

4442 , Selection (..)

4543 -- ** Values

4644 , values

@@ -55,7 +53,23 @@ module Squeal.PostgreSQL.Query

5553 -- ** With

5654 , With (..)

5755 , CommonTableExpression (..)

58− , withRecursive

56+ -- ** Unnest

57+ , unnest

58+ -- ** Json

59+ , jsonEach

60+ , jsonbEach

61+ , jsonEachText

62+ , jsonbEachText

63+ , jsonObjectKeys

64+ , jsonbObjectKeys

65+ , jsonPopulateRecord

66+ , jsonbPopulateRecord

67+ , jsonPopulateRecordSet

68+ , jsonbPopulateRecordSet

69+ , jsonToRecord

70+ , jsonbToRecord

71+ , jsonToRecordSet

72+ , jsonbToRecordSet

5973 -- * Table Expressions

6074 , TableExpression (..)

6175 , from

@@ -95,6 +109,7 @@ import Squeal.PostgreSQL.Alias

95109import Squeal.PostgreSQL.Expression

96110import Squeal.PostgreSQL.Expression.Logic

97111import Squeal.PostgreSQL.Expression.Sort

112+import Squeal.PostgreSQL.Expression.Type

98113import Squeal.PostgreSQL.Expression.Window

99114import Squeal.PostgreSQL.List

100115import Squeal.PostgreSQL.PG

@@ -103,55 +118,10 @@ import Squeal.PostgreSQL.Schema

103118

104119-- $setup

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

110121

111122{- |

112−The process of retrieving or the command to retrieve data from

113−a database is called a `Query`.

114−

115−The general `Query` type is parameterized by

116−

117−* @outer :: FromType@ - outer scope for a correlated subquery,

118−* @commons :: FromType@ - scope for all `common` table expressions,

119−* @schemas :: SchemasType@ - scope for all `table`s and `view`s,

120−* @params :: [NullityType]@ - scope for all `Squeal.Expression.Parameter.parameter`s,

121−* @row :: RowType@ - return type of the `Query`.

122−-}

123−newtype Query

124− (outer :: FromType)

125− (commons :: FromType)

126− (schemas :: SchemasType)

127− (params :: [NullityType])

128− (row :: RowType)

129− = UnsafeQuery { renderQuery :: ByteString }

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

131−instance RenderSQL (Query outer commons schemas params row) where renderSQL = renderQuery

132−

133−{- |

134−The top level `Query_` type is parameterized by a @schemas@ `SchemasType`,

135−against which the query is type-checked, an input @parameters@ Haskell `Type`,

136−and an ouput row Haskell `Type`.

137−

138−A top-level query can be run

139−using `Squeal.PostgreSQL.PQ.runQueryParams`, or if @parameters = ()@

140−using `Squeal.PostgreSQL.PQ.runQuery`.

141−

142−Generally, @parameters@ will be a Haskell tuple or record whose entries

143−may be referenced using positional

144−`Squeal.PostgreSQL.Expression.Parameter.parameter`s and @row@ will be a

145−Haskell record, whose entries will be targeted using overloaded labels.

146−

147−Let's see some examples of queries.

148−

149−>>> :set -XDeriveAnyClass -XDerivingStrategies

150−>>> :{

151−data Row a b = Row { col1 :: a, col2 :: b }

152− deriving stock (GHC.Generic)

153− deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)

154−:}

123+The process of retrieving or the command to retrieve data from a database

124+is called a `Query`. Let's see some examples of queries.

155125

156126simple query:

157127

@@ -159,7 +129,7 @@ simple query:

159129>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

160130>>> :{

161131let

162− query :: Query_ (Public Schema) () (Row Int32 Int32)

132+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

163133 query = select Star (from (table #tab))

164134in printSQL query

165135:}

@@ -169,21 +139,21 @@ restricted query:

169139

170140>>> :{

171141let

172− query :: Query_ (Public Schema) () (Row Int32 Int32)

142+ query :: Query '[] '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4]

173143 query =

174− select_ ((#col1 + #col2) `as` #col1 :* #col1 `as` #col2)

144+ select_ ((#col1 + #col2) `as` #sum :* #col1)

175145 ( from (table #tab)

176146 & where_ (#col1 .> #col2)

177147 & where_ (#col2 .> 0) )

178148in printSQL query

179149:}

180−SELECT ("col1" + "col2") AS "col1", "col1" AS "col2" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))

150+SELECT ("col1" + "col2") AS "sum", "col1" AS "col1" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))

181151

182152subquery:

183153

184154>>> :{

185155let

186− query :: Query_ (Public Schema) () (Row Int32 Int32)

156+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

187157 query = select Star (from (subquery (select Star (from (table #tab)) `as` #sub)))

188158in printSQL query

189159:}

@@ -193,7 +163,7 @@ limits and offsets:

193163

194164>>> :{

195165let

196− query :: Query_ (Public Schema) () (Row Int32 Int32)

166+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

197167 query = select Star (from (table #tab) & limit 100 & offset 2 & limit 50 & offset 2)

198168in printSQL query

199169:}

@@ -203,7 +173,7 @@ parameterized query:

203173

204174>>> :{

205175let

206− query :: Query_ (Public Schema) (Only Int32) (Row Int32 Int32)

176+ query :: Query '[] '[] (Public Schema) '[ 'NotNull 'PGint4] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

207177 query = select Star (from (table #tab) & where_ (#col1 .> param @1))

208178in printSQL query

209179:}

@@ -213,21 +183,21 @@ aggregation query:

213183

214184>>> :{

215185let

216− query :: Query_ (Public Schema) () (Row Int64 Int32)

186+ query :: Query '[] '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4 ]

217187 query =

218− select_ ((fromNull 0 (sum_ (All #col2))) `as` #col1 :* #col1 `as` #col2)

188+ select_ (sum_ (All #col2) `as` #sum :* #col1)

219189 ( from (table (#tab `as` #table1))

220190 & groupBy #col1

221− & having (sum_ (Distinct #col2) .> 1) )

191+ & having (#col1 + sum_ (Distinct #col2) .> 1) )

222192in printSQL query

223193:}

224−SELECT COALESCE(sum(ALL "col2"), 0) AS "col1", "col1" AS "col2" FROM "tab" AS "table1" GROUP BY "col1" HAVING (sum(DISTINCT "col2") > 1)

194+SELECT sum(ALL "col2") AS "sum", "col1" AS "col1" FROM "tab" AS "table1" GROUP BY "col1" HAVING (("col1" + sum(DISTINCT "col2")) > 1)

225195

226196sorted query:

227197

228198>>> :{

229199let

230− query :: Query_ (Public Schema) () (Row Int32 Int32)

200+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

231201 query = select Star (from (table #tab) & orderBy [#col1 & Asc])

232202in printSQL query

233203:}

@@ -235,12 +205,14 @@ SELECT * FROM "tab" AS "tab" ORDER BY "col1" ASC

235205

236206joins:

237207

208+>>> :set -XFlexibleContexts

238209>>> :{

239210type OrdersColumns =

240211 '[ "id" ::: 'NoDef :=> 'NotNull 'PGint4

241− , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

242− , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

243− , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4 ]

212+ , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

213+ , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

214+ , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4

215+ ]

244216:}

245217

246218>>> :{

@@ -256,27 +228,22 @@ type OrdersConstraints =

256228>>> :{

257229type OrdersSchema =

258230 '[ "orders" ::: 'Table (OrdersConstraints :=> OrdersColumns)

259− , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

260− , "shippers" ::: 'Table (ShippersConstraints :=> NamesColumns) ]

261−:}

262−

263−>>> :{

264−data Order = Order

265− { price :: Float

266− , customerName :: Text

267− , shipperName :: Text

268− } deriving GHC.Generic

269−instance SOP.Generic Order

270−instance SOP.HasDatatypeInfo Order

231+ , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

232+ , "shippers" ::: 'Table (ShippersConstraints :=> NamesColumns) ]

271233:}

272234

273235>>> :{

274236let

275− query :: Query_ (Public OrdersSchema) () Order

237+ query :: Query '[] '[] (Public OrdersSchema)

238+ '[]

239+ '[ "order_price" ::: 'NotNull 'PGfloat4

240+ , "customer_name" ::: 'NotNull 'PGtext

241+ , "shipper_name" ::: 'NotNull 'PGtext

242+ ]

276243 query = select_

277− ( #o ! #price `as` #price :*

278− #c ! #name `as` #customerName :*

279− #s ! #name `as` #shipperName )

244+ ( #o ! #price `as` #order_price :*

245+ #c ! #name `as` #customer_name :*

246+ #s ! #name `as` #shipper_name )

280247 ( from (table (#orders `as` #o)

281248 & innerJoin (table (#customers `as` #c))

282249 (#o ! #customer_id .== #c ! #id)

@@ -284,16 +251,14 @@ let

284251 (#o ! #shipper_id .== #s ! #id)) )

285252in printSQL query

286253:}

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

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

288255

289256self-join:

290257

291258>>> :{

292259let

293− query :: Query_ (Public Schema) () (Row Int32 Int32)

294− query = select

295− (#t1 & DotStar)

296− (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

260+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

261+ query = select (#t1 & DotStar) (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

297262in printSQL query

298263:}

299264SELECT "t1".* FROM "tab" AS "t1" CROSS JOIN "tab" AS "t2"

@@ -302,19 +267,17 @@ value queries:

302267

303268>>> :{

304269let

305− query :: Query_ schemas () (Row String Bool)

306− query = values

307− ("true" `as` #col1 :* true `as` #col2)

308− ["false" `as` #col1 :* false `as` #col2]

270+ query :: Query '[] commons schemas '[] '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

271+ query = values (1 `as` #foo :* true `as` #bar) [2 `as` #foo :* false `as` #bar]

309272in printSQL query

310273:}

311−SELECT * FROM (VALUES (E'true', TRUE), (E'false', FALSE)) AS t ("col1", "col2")

274+SELECT * FROM (VALUES (1, TRUE), (2, FALSE)) AS t ("foo", "bar")

312275

313276set operations:

314277

315278>>> :{

316279let

317− query :: Query_ (Public Schema) () (Row Int32 Int32)

280+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

318281 query = select Star (from (table #tab)) `unionAll` select Star (from (table #tab))

319282in printSQL query

320283:}

@@ -324,7 +287,7 @@ with queries:

324287

325288>>> :{

326289let

327− query :: Query_ (Public Schema) () (Row Int32 Int32)

290+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

328291 query = with (

329292 select Star (from (table #tab)) `as` #cte1 :>>

330293 select Star (from (common #cte1)) `as` #cte2

@@ -337,35 +300,40 @@ window function queries

337300

338301>>> :{

339302let

340− query :: Query_ (Public Schema) () (Row Int32 Int64)

303+ query :: Query '[] '[] (Public Schema) '[] ["col1" ::: 'NotNull 'PGint4, "rank" ::: 'NotNull 'PGint8]

341304 query = select

342− (#col1 & Also (rank `as` #col2 `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))

305+ (#col1 & Also (rank `as` #rank `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))

343306 (from (table #tab))

344307in printSQL query

345308:}

346−SELECT "col1" AS "col1", rank() OVER (PARTITION BY "col1" ORDER BY "col2" ASC) AS "col2" FROM "tab" AS "tab"

309+SELECT "col1" AS "col1", rank() OVER (PARTITION BY "col1" ORDER BY "col2" ASC) AS "rank" FROM "tab" AS "tab"

347310

348311correlated subqueries

349312

350313>>> :{

351314let

352− query :: Query_ (Public Schema) () (Only Int32)

315+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4]

353316 query =

354− select (#col1 `as` #fromOnly) (from (table (#tab `as` #t1))

317+ select #col1 (from (table (#tab `as` #t1))

355318 & where_ (exists (

356319 select Star (from (table (#tab `as` #t2))

357320 & where_ (#t2 ! #col2 .== #t1 ! #col1)))))

358321in printSQL query

359322:}

360−SELECT "col1" AS "fromOnly" FROM "tab" AS "t1" WHERE EXISTS (SELECT * FROM "tab" AS "t2" WHERE ("t2"."col2" = "t1"."col1"))

361−

323+SELECT "col1" AS "col1" FROM "tab" AS "t1" WHERE EXISTS (SELECT * FROM "tab" AS "t2" WHERE ("t2"."col2" = "t1"."col1"))

362324-}

363−type family Query_

325+newtype Query

326+ (outer :: FromType)

327+ (commons :: FromType)

364328 (schemas :: SchemasType)

365− (parameters :: Type)

366− (row :: Type) where

367− Query_ schemas params row =

368− Query '[] '[] schemas (TuplePG params) (RowPG row)

329+ (params :: [NullityType])

330+ (row :: RowType)

331+ = UnsafeQuery { renderQuery :: ByteString }

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)

369337

370338-- | The results of two queries can be combined using the set operation

371339-- `union`. Duplicate rows are eliminated.

@@ -437,40 +405,27 @@ q1 `exceptAll` q2 = UnsafeQuery $

437405SELECT queries

438406-----------------------------------------}

439407

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

446408data 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

447413 Star

448414 :: HasUnique tab from row

449415 => Selection outer commons 'Ungrouped schemas params from row

450− -- ^ `HasUnique` table in the `FromClause`

451416 DotStar

452417 :: Has tab from row

453418 => Alias tab

454− -- ^ `Has` table with `Alias`

455419 -> Selection outer commons 'Ungrouped schemas params from row

456− List

457− :: SListI row

458− => NP (Aliased (Expression outer commons grp schemas params from)) row

459− -- ^ `NP` list of `Aliased` `Expression`s

460− -> Selection outer commons grp schemas params from row

420+ Also

421+ :: Selection outer commons grp schemas params from right

422+ -> Selection outer commons grp schemas params from left

423+ -> Selection outer commons grp schemas params from (Join left right)

461424 Over

462425 :: SListI row

463426 => NP (Aliased (WindowFunction outer commons grp schemas params from)) row

464− -- ^ `NP` list of `Aliased` `WindowFunction`s

465427 -> WindowDefinition outer commons grp schemas params from

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

474429instance (KnownSymbol col, row ~ '[col ::: ty])

475430 => Aliasable col

476431 (Expression outer commons grp schemas params from ty)

@@ -530,7 +485,7 @@ instance IsString

530485select

531486 :: (SListI row, row ~ (x ': xs))

532487 => Selection outer commons grp schemas params from row

533− -- ^ selection

488+ -- ^ select list

534489 -> TableExpression outer commons grp schemas params from

535490 -- ^ intermediate virtual table

536491 -> Query outer commons schemas params row

@@ -539,24 +494,20 @@ select selection tabexpr = UnsafeQuery $

539494 <+> renderSQL selection

540495 <+> renderSQL tabexpr

541496

542−-- | Like `select` but takes an `NP` list of `Expression`s instead

543−-- of a general `Selection`.

544497select_

545498 :: (SListI row, row ~ (x ': xs))

546499 => NP (Aliased (Expression outer commons grp schemas params from)) row

547− -- ^ select list

548500 -> TableExpression outer commons grp schemas params from

549− -- ^ intermediate virtual table

550501 -> Query outer commons schemas params row

551−select_ = select . List

502+select_ list = select (List list)

552503

553504-- | After the select list has been processed, the result table can

554505-- be subject to the elimination of duplicate rows using `selectDistinct`.

555506selectDistinct

556507 :: (SListI columns, columns ~ (col ': cols))

557− => Selection outer commons grp schemas params from columns

558− -- ^ selection

559− -> TableExpression outer commons grp schemas params from

508+ => Selection outer commons 'Ungrouped schemas params from columns

509+ -- ^ select list

510+ -> TableExpression outer commons 'Ungrouped schemas params from

560511 -- ^ intermediate virtual table

561512 -> Query outer commons schemas params columns

562513selectDistinct selection tabexpr = UnsafeQuery $

@@ -564,65 +515,14 @@ selectDistinct selection tabexpr = UnsafeQuery $

564515 <+> renderSQL selection

565516 <+> renderSQL tabexpr

566517

567−-- | Like `selectDistinct` but takes an `NP` list of `Expression`s instead

568−-- of a general `Selection`.

569518selectDistinct_

570519 :: (SListI columns, columns ~ (col ': cols))

571− => NP (Aliased (Expression outer commons grp schemas params from)) columns

520+ => NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns

572521 -- ^ select list

573− -> TableExpression outer commons grp schemas params from

574− -- ^ intermediate virtual table

575− -> Query outer commons schemas params columns

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

522+ -> TableExpression outer commons 'Ungrouped schemas params from

623523 -- ^ intermediate virtual table

624524 -> Query outer commons schemas params columns

625−selectDistinctOn_ distincts = selectDistinctOn distincts . List

525+selectDistinct_ list = select (List list)

626526

627527-- | `values` computes a row value or set of row values

628528-- specified by value expressions. It is most commonly used

@@ -757,7 +657,7 @@ instance RenderSQL (TableExpression outer commons grp schemas params from) where

757657from

758658 :: FromClause outer commons schemas params from -- ^ table reference

759659 -> TableExpression outer commons 'Ungrouped schemas params from

760−from tab = TableExpression tab [] noGroups NoHaving [] [] []

660+from tab = TableExpression tab [] NoGroups NoHaving [] [] []

761661

762662-- | A `where_` is an endomorphism of `TableExpression`s which adds a

763663-- search condition to the `whereClause`.

@@ -778,7 +678,7 @@ groupBy

778678groupBy bys rels = TableExpression

779679 { fromClause = fromClause rels

780680 , whereClause = whereClause rels

781− , groupByClause = group bys

681+ , groupByClause = Group bys

782682 , havingClause = Having []

783683 , orderByClause = []

784684 , limitClause = limitClause rels

@@ -813,6 +713,170 @@ offset

813713 -> TableExpression outer commons grp schemas params from

814714offset off rels = rels {offsetClause = off : offsetClause rels}

815715

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+

816880{-----------------------------------------

817881FROM clauses

818882-----------------------------------------}

@@ -839,7 +903,7 @@ table (tab `As` alias) = UnsafeFromClause $

839903subquery

840904 :: Aliased (Query outer commons schemas params) query

841905 -> FromClause outer commons schemas params '[query]

842−subquery = UnsafeFromClause . renderAliased (parenthesized . renderSQL)

906+subquery = UnsafeFromClause . renderAliased (parenthesized . renderQuery)

843907

844908-- | `view` derives a table from a `View`.

845909view

@@ -857,16 +921,11 @@ common

857921common (cte `As` alias) = UnsafeFromClause $

858922 renderSQL cte <+> "AS" <+> renderSQL alias

859923

860−instance Additional (FromClause outer commons schemas params) where

861− also right left = UnsafeFromClause $

862− renderSQL left <> ", " <> renderSQL right

863−

864−{- |

865−@left & crossJoin right@. For every possible combination of rows from

866−@left@ and @right@ (i.e., a Cartesian product), the joined table will contain

867−a row consisting of all columns in @left@ followed by all columns in @right@.

868−If the tables have @n@ and @m@ rows respectively, the joined table will

869−have @n * m@ rows.

924+{- | @left & crossJoin right@. For every possible combination of rows from

925+ @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@.

927+ If the tables have @n@ and @m@ rows respectively, the joined table will

928+ have @n * m@ rows.

870929-}

871930crossJoin

872931 :: FromClause outer commons schemas params right

@@ -992,20 +1051,19 @@ instance (Has rel rels cols, Has col cols ty, bys ~ '[ '(rel, col)])

9921051-- done on @NoGroups@ while all output `Expression`s must be aggregated

9931052-- in @Group Nil@. In general, all output `Expression`s in the

9941053-- complement of @bys@ must be aggregated in @Group bys@.

995−newtype GroupByClause grp from = UnsafeGroupByClause

996− { renderGroupByClause :: ByteString }

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

1054+data GroupByClause grp from where

1055+ NoGroups :: GroupByClause 'Ungrouped from

1056+ Group

1057+ :: SListI bys

1058+ => NP (By from) bys

1059+ -> GroupByClause ('Grouped bys) from

1060+

1061+-- | Renders a `GroupByClause`.

9981062instance RenderSQL (GroupByClause grp from) where

999− renderSQL = renderGroupByClause

1000−noGroups :: GroupByClause 'Ungrouped from

1001−noGroups = UnsafeGroupByClause ""

1002−group

1003− :: SListI bys

1004− => NP (By from) bys

1005− -> GroupByClause ('Grouped bys) from

1006−group bys = UnsafeGroupByClause $ case bys of

1007− Nil -> ""

1008− bys' -> " GROUP BY" <+> renderCommaSeparated renderSQL bys'

1063+ renderSQL = \case

1064+ NoGroups -> ""

1065+ Group Nil -> ""

1066+ Group bys -> " GROUP BY" <+> renderCommaSeparated renderSQL bys

10091067

10101068-- | A `HavingClause` is used to eliminate groups that are not of interest.

10111069-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`

@@ -1049,8 +1107,8 @@ instance

10491107 , commons1 ~ (cte ::: common ': commons)

10501108 ) => Aliasable cte

10511109 (statement commons schemas params common)

1052− (Path (CommonTableExpression statement schemas params) commons commons1) where

1053− statement `as` cte = csingleton (statement `as` cte)

1110+ (AlignedList (CommonTableExpression statement schemas params) commons commons1) where

1111+ statement `as` cte = single (statement `as` cte)

10541112

10551113instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

10561114 (CommonTableExpression statement schemas params commons0 commons1) where

@@ -1062,7 +1120,7 @@ instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

10621120-- defining temporary tables that exist just for one query.

10631121class With statement where

10641122 with

1065− :: Path (CommonTableExpression statement schemas params) commons0 commons1

1123+ :: AlignedList (CommonTableExpression statement schemas params) commons0 commons1

10661124 -- ^ common table expressions

10671125 -> statement commons1 schemas params row

10681126 -- ^ larger query

@@ -1070,29 +1128,4 @@ class With statement where

10701128instance With (Query outer) where

10711129 with Done query = query

10721130 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)

1098− <+> renderSQL query

1131+ "WITH" <+> renderSQL ctes <+> renderSQL query

squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+62−164

@@ -1,11 +1,11 @@

11{-|

22Module: Squeal.PostgreSQL.Schema

33Description: Embedding of PostgreSQL type and alias system

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

8−`Squeal.PostgreSQL.Schema` provides a type-level DSL for kinds of Postgres types,

8+This module provides a type-level DSL for kinds of Postgres types,

99tables, schema, constraints, aliases, enumerated labels, and groupings.

1010It also defines useful type families to operate on these. Finally,

1111it defines an embedding of Haskell types into Postgres types.

@@ -44,10 +44,6 @@ module Squeal.PostgreSQL.Schema

4444 , ColumnsType

4545 , TableType

4646 , SchemumType (..)

47− , IndexType (..)

48− , FunctionType

49− , OperatorType (..)

50− , ReturnsType (..)

5147 , SchemaType

5248 , SchemasType

5349 , Public

@@ -62,21 +58,15 @@ module Squeal.PostgreSQL.Schema

6258 , PGlabel (..)

6359 -- * Data Definitions

6460 , Create

65− , CreateIfNotExists

66− , CreateOrReplace

6761 , Drop

68− , DropSchemum

69− , DropIfExists

70− , DropSchemumIfExists

7162 , Alter

72− , AlterIfExists

7363 , Rename

74− , RenameIfExists

7564 , ConstraintInvolves

7665 , DropIfConstraintsInvolve

7766 , IsNotElem

7867 , AllUnique

7968 -- * Type Classifications

69+ , HasOid (..)

8070 , PGNum

8171 , PGIntegral

8272 , PGFloating

@@ -100,19 +90,17 @@ import Control.Category

10090import Data.Kind

10191import Data.Monoid hiding (All)

10292import Data.Type.Bool

93+import Data.Word (Word32)

10394import Generics.SOP

10495import GHC.TypeLits

10596import Prelude hiding (id, (.))

10697

10798import Squeal.PostgreSQL.Alias

108−import Squeal.PostgreSQL.List

10999import Squeal.PostgreSQL.Render

110100

111−-- $setup

112−-- >>> import Squeal.PostgreSQL

113−

114101-- | `PGType` is the promoted datakind of PostgreSQL types.

115102--

103+-- >>> import Squeal.PostgreSQL.Schema

116104-- >>> :kind 'PGbool

117105-- 'PGbool :: PGType

118106data PGType

@@ -143,11 +131,37 @@ data PGType

143131 | PGenum [Symbol] -- ^ enumerated (enum) types are data types that comprise a static, ordered set of values.

144132 | 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.

145133 | 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.

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).

134+ | PGtsquery -- ^ A tsquery value stores lexemes that are to be searched for

149135 | UnsafePGType Symbol -- ^ an escape hatch for unsupported PostgreSQL types

150136

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+

151165-- | `NullityType` encodes the potential presence or definite absence of a

152166-- @NULL@ allowing operations which are sensitive to such to be well typed.

153167--

@@ -260,19 +274,9 @@ type FromType = [(Symbol,RowType)]

260274

261275-- | `ColumnsToRow` removes column constraints.

262276type family ColumnsToRow (columns :: ColumnsType) :: RowType where

263− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': column4 ::: _ :=> ty4 ': column5 ::: _ :=> ty5 ': columns) =

264− column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': column5 ::: ty5 ': ColumnsToRow columns

265− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': column4 ::: _ :=> ty4 ': columns) =

266− column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': ColumnsToRow columns

267− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': columns) =

268− column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': ColumnsToRow columns

269− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': columns) =

270− column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': ColumnsToRow columns

271− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': columns) =

272− column ::: ty ': column1 ::: ty1 ': ColumnsToRow columns

273− ColumnsToRow (column ::: _ :=> ty ': columns) =

274− column ::: ty ': ColumnsToRow columns

275277 ColumnsToRow '[] = '[]

278+ ColumnsToRow (column ::: constraint :=> ty ': columns) =

279+ column ::: ty ': ColumnsToRow columns

276280

277281-- | `TableToColumns` removes table constraints.

278282type family TableToColumns (table :: TableType) :: ColumnsType where

@@ -282,6 +286,15 @@ type family TableToColumns (table :: TableType) :: ColumnsType where

282286type family TableToRow (table :: TableType) :: RowType where

283287 TableToRow tab = ColumnsToRow (TableToColumns tab)

284288

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+

285298-- | Numeric Postgres types.

286299type PGNum =

287300 '[ 'PGint2, 'PGint4, 'PGint8, 'PGnumeric, 'PGfloat4, 'PGfloat8]

@@ -305,24 +318,14 @@ instance ty0 ~ ty1 => SamePGType

305318

306319-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.

307320type 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

314321 AllNotNull '[] = ()

322+ AllNotNull (column ::: def :=> 'NotNull ty ': columns) = AllNotNull columns

315323

316324-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some

317325-- @NOT NULL@.

318326type family NotAllNull (columns :: ColumnsType) :: Constraint where

319− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

320− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

321− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

322− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

323− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

324− NotAllNull (_ ::: _ :=> 'NotNull _ ': _) = ()

325− NotAllNull (_ ::: _ :=> 'Null _ ': columns) = NotAllNull columns

327+ NotAllNull (column ::: def :=> 'NotNull ty ': columns) = ()

328+ NotAllNull (column ::: def :=> 'Null ty ': columns) = NotAllNull columns

326329

327330-- | `NullifyType` is an idempotent that nullifies a `NullityType`.

328331type family NullifyType (ty :: NullityType) :: NullityType where

@@ -331,37 +334,17 @@ type family NullifyType (ty :: NullityType) :: NullityType where

331334

332335-- | `NullifyRow` is an idempotent that nullifies a `RowType`.

333336type family NullifyRow (columns :: RowType) :: RowType where

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

337+ NullifyRow '[] = '[]

344338 NullifyRow (column ::: ty ': columns) =

345339 column ::: NullifyType ty ': NullifyRow columns

346− NullifyRow '[] = '[]

347340

348341-- | `NullifyFrom` is an idempotent that nullifies a `FromType`

349342-- used to nullify the left or right hand side of an outer join

350343-- in a `Squeal.PostgreSQL.Query.FromClause`.

351344type family NullifyFrom (tables :: FromType) :: FromType where

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

345+ NullifyFrom '[] = '[]

362346 NullifyFrom (table ::: columns ': tables) =

363347 table ::: NullifyRow columns ': NullifyFrom tables

364− NullifyFrom '[] = '[]

365348

366349-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in

367350-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@

@@ -371,101 +354,30 @@ type family Create alias x xs where

371354 Create alias x (alias ::: y ': xs) = TypeError

372355 ('Text "Create: alias "

373356 ':<>: 'ShowType alias

374− ':<>: 'Text "already exists")

357+ ':<>: 'Text "already in use")

375358 Create alias y (x ': xs) = x ': Create alias y xs

376359

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−

394360-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@

395361-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements

396362-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.

397363type family Drop alias xs where

398− Drop alias '[] = TypeError

399− ('Text "Drop: alias "

400− ':<>: 'ShowType alias

401− ':<>: 'Text " does not exist" )

402− Drop alias (alias ::: x ': xs) = xs

364+ Drop alias ((alias ::: x) ': xs) = xs

403365 Drop alias (x ': xs) = x ': Drop alias xs

404366

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−

437367-- | @Alter alias x xs@ replaces the type associated with an @alias@ in @xs@

438368-- with the type @x@ and is used in `Squeal.PostgreSQL.Definition.alterTable`

439369-- and `Squeal.PostgreSQL.Definition.alterColumn`.

440370type family Alter alias x xs where

441− Alter alias x '[] = TypeError

442− ('Text "Alter: alias "

443− ':<>: 'ShowType alias

444− ':<>: 'Text " does not exist" )

445371 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

446372 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

447373

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−

453374-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@

454375-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and

455376-- `Squeal.PostgreSQL.Definition.renameColumn`.

456377type family Rename alias0 alias1 xs where

457− Rename alias0 alias1 '[] = TypeError

458− ('Text "Rename: alias "

459− ':<>: 'ShowType alias0

460− ':<>: 'Text " does not exist" )

461378 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

462379 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

463380

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−

469381-- | Check if a `TableConstraint` involves a column

470382type family ConstraintInvolves column constraint where

471383 ConstraintInvolves column ('Check columns) = column `Elem` columns

@@ -482,35 +394,22 @@ type family DropIfConstraintsInvolve column constraints where

482394 (DropIfConstraintsInvolve column constraints)

483395 (alias ::: constraint ': DropIfConstraintsInvolve column constraints)

484396

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+

485407-- | A `SchemumType` is a user-defined type, either a `Table`,

486408-- `View` or `Typedef`.

487409data SchemumType

488410 = Table TableType

489411 | View RowType

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

514413

515414{- | The schema of a database consists of a list of aliased,

516415user-defined `SchemumType`s.

@@ -553,7 +452,6 @@ There are several reasons why one might want to use schemas:

553452-}

554453type SchemasType = [(Symbol,SchemaType)]

555454

556−-- | A type family to use for a single schema database.

557455type family Public (schema :: SchemaType) :: SchemasType

558456 where Public schema = '["public" ::: schema]

559457

squeal-postgresql/src/Squeal/PostgreSQL/Transaction.hs+44−76

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

11{-|

22Module: Squeal.PostgreSQL.Transaction

33Description: Squeal transaction control language

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

@@ -20,12 +20,11 @@ module Squeal.PostgreSQL.Transaction

2020 ( -- * Transaction

2121 transactionally

2222 , transactionally_

23− , transactionallyRetry

24− , ephemerally

25− , ephemerally_

2623 , begin

2724 , commit

2825 , rollback

26+ , transactionallySchema

27+ , transactionallySchema_

2928 -- * Transaction Mode

3029 , TransactionMode (..)

3130 , defaultMode

@@ -35,99 +34,68 @@ module Squeal.PostgreSQL.Transaction

3534 , DeferrableMode (..)

3635 ) where

3736

38−import UnliftIO

37+import Generics.SOP

38+import UnliftIO (MonadUnliftIO, liftIO, mask, onException)

39+

40+import qualified Database.PostgreSQL.LibPQ as LibPQ

3941

4042import Squeal.PostgreSQL.Manipulation

4143import Squeal.PostgreSQL.Render

4244import Squeal.PostgreSQL.PQ

45+import Squeal.PostgreSQL.Schema

4346

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

47+-- | Run a schema invariant computation `transactionally`.

5048transactionally

5149 :: (MonadUnliftIO tx, MonadPQ schemas tx)

5250 => TransactionMode

5351 -> tx x -- ^ run inside a transaction

5452 -> tx x

5553transactionally mode tx = mask $ \restore -> do

56− manipulate_ $ begin mode

57− result <- restore tx `onException` (manipulate_ rollback)

58− manipulate_ commit

54+ _ <- begin mode

55+ result <- restore tx `onException` rollback

56+ _ <- commit

5957 return result

6058

61−-- | Run a computation `transactionally_`, in `defaultMode`.

59+-- | Run a schema invariant computation `transactionally_` in `defaultMode`.

6260transactionally_

6361 :: (MonadUnliftIO tx, MonadPQ schemas tx)

6462 => tx x -- ^ run inside a transaction

6563 -> tx x

6664transactionally_ = transactionally defaultMode

6765

68−{- |

69−`transactionallyRetry` a computation;

70−

71−* first `begin`,

72−* then `try` the computation,

73− - if it raises a serialization failure then `rollback` and restart the transaction,

74− - if it raises any other exception then `rollback` and rethrow the exception,

75− - otherwise `commit` and `return` the result.

76−-}

77−transactionallyRetry

78− :: (MonadUnliftIO tx, MonadPQ schemas tx)

79− => TransactionMode

80− -> tx x -- ^ run inside a transaction

81− -> tx x

82−transactionallyRetry mode tx = mask $ \restore ->

83− loop . try $ do

84− x <- restore tx

85− manipulate_ commit

86− return x

87− where

88− loop attempt = do

89− manipulate_ $ begin mode

90− attempt >>= \case

91− Left (PQException (PQState _ (Just "40001") _)) -> do

92− manipulate_ rollback

93− loop attempt

94− Left err -> do

95− manipulate_ rollback

96− throwIO err

97− Right x -> return x

98−

99−{- | Run a computation `ephemerally`;

100−Like `transactionally` but always `rollback`, useful in testing.

101−-}

102−ephemerally

103− :: (MonadUnliftIO tx, MonadPQ schemas tx)

104− => TransactionMode

105− -> tx x -- ^ run inside an ephemeral transaction

106− -> tx x

107−ephemerally mode tx = mask $ \restore -> do

108− manipulate_ $ begin mode

109− result <- restore tx `onException` (manipulate_ rollback)

110− manipulate_ rollback

111− return result

112−

113−{- | Run a computation `ephemerally` in `defaultMode`. -}

114−ephemerally_

115− :: (MonadUnliftIO tx, MonadPQ schemas tx)

116− => tx x -- ^ run inside an ephemeral transaction

117− -> tx x

118−ephemerally_ = ephemerally defaultMode

119−

12066-- | @BEGIN@ a transaction.

121−begin :: TransactionMode -> Manipulation_ schemas () ()

122−begin mode = UnsafeManipulation $ "BEGIN" <+> renderSQL mode

67+begin :: MonadPQ schemas tx => TransactionMode -> tx (K Result ('[] :: RowType))

68+begin mode = manipulate . UnsafeManipulation $

69+ "BEGIN" <+> renderSQL mode <> ";"

12370

124−-- | @COMMIT@ a transaction.

125−commit :: Manipulation_ schemas () ()

126−commit = UnsafeManipulation "COMMIT"

71+-- | @COMMIT@ a schema invariant transaction.

72+commit :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

73+commit = manipulate $ UnsafeManipulation "COMMIT;"

12774

128−-- | @ROLLBACK@ a transaction.

129−rollback :: Manipulation_ schemas () ()

130−rollback = UnsafeManipulation "ROLLBACK"

75+-- | @ROLLBACK@ a schema invariant transaction.

76+rollback :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

77+rollback = manipulate $ UnsafeManipulation "ROLLBACK;"

78+

79+-- | Run a schema changing computation `transactionallySchema`.

80+transactionallySchema

81+ :: MonadUnliftIO io

82+ => TransactionMode

83+ -> PQ schemas0 schemas1 io x

84+ -> PQ schemas0 schemas1 io x

85+transactionallySchema mode u = PQ $ \ conn -> mask $ \ restore -> do

86+ _ <- liftIO . LibPQ.exec (unK conn) $

87+ "BEGIN" <+> renderSQL mode <> ";"

88+ x <- restore (unPQ u conn)

89+ `onException` (liftIO (LibPQ.exec (unK conn) "ROLLBACK"))

90+ _ <- liftIO $ LibPQ.exec (unK conn) "COMMIT"

91+ return x

92+

93+-- | Run a schema changing computation `transactionallySchema_` in `defaultMode`.

94+transactionallySchema_

95+ :: MonadUnliftIO io

96+ => PQ schemas0 schemas1 io x

97+ -> PQ schemas0 schemas1 io x

98+transactionallySchema_ = transactionallySchema defaultMode

13199

132100-- | The available transaction characteristics are the transaction `IsolationLevel`,

133101-- the transaction `AccessMode` (`ReadWrite` or `ReadOnly`), and the `DeferrableMode`.

@@ -140,7 +108,7 @@ data TransactionMode = TransactionMode

140108-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

141109-- `ReadWrite` `AccessMode` and `NotDeferrable` `DeferrableMode`.

142110defaultMode :: TransactionMode

143−defaultMode = TransactionMode ReadCommitted ReadWrite NotDeferrable

111+defaultMode = TransactionMode Serializable ReadWrite NotDeferrable

144112

145113-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

146114-- `ReadOnly` `AccessMode` and `Deferrable` `DeferrableMode`.

squeal-postgresql/src/Squeal/PostgreSQL/Tutorial.hsnew file+39

@@ -0,0 +1,39 @@

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

8+== `P` records

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.hsdeleted−6

@@ -1,6 +0,0 @@

1−module Main (main) where

2−

3−import Test.DocTest

4−

5−main :: IO ()

6−main = doctest [ "-isrc", "src" ]

squeal-postgresql/test/DocTest.hsnew file+18

@@ -0,0 +1,18 @@

1+module Main (main) where

3+import Test.DocTest

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.hsdeleted−166

@@ -1,166 +0,0 @@

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.hsdeleted−136

@@ -1,136 +0,0 @@

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.hsnew file+126

@@ -0,0 +1,126 @@

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.hsnew file+7

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

1+module Specs where

3+import Test.Hspec

4+import qualified ExceptionHandling

6+main :: IO ()

7+main = hspec ExceptionHandling.specs

stack.yaml+1−3

@@ -1,8 +1,6 @@

1−resolver: nightly-2019-07-14

1+resolver: lts-13.8

22packages:

33- squeal-postgresql

55extra-deps:

66- unliftio-pool-0.2.1.0

7−- github: morphismtech/free-categories

8− commit: c0e555fbefb5c21619e532264c4dfeac556d0630