dev..857823d · squeal · git.iko.soy

git.iko.soy/squeal

on 857823d help sign in

.circleci/config.yml+1−1

since splitsnapshots

unifiedsplit

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

2jobs:

3 build:

4 docker:

5− - image: haskell:8.6.5

5+ - image: haskell:8.6.3

6 - image: circleci/postgres:latest

7 environment:

8 POSTGRES_USER: root

README.md+70−59

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

46* transactions

47* views

48* array, composite and enumerated types

49−* json functions and operations

49+* json operations

50−* multischema support

51−* correlated subqueries

52−* window functions

53−* text search

55## installation

51## installation

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

76features.

72features.

78```Haskell

74```Haskell

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

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

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

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

81```

77```

83We'll need some imports.

79We'll need some imports.

85```Haskell

81```Haskell

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

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

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

87>>> import Data.Int (Int32)

84>>> import Data.Int (Int32)

88>>> import Data.Text (Text)

85>>> import Data.Text (Text)

89>>> import Squeal.PostgreSQL

86>>> import Squeal.PostgreSQL

87+>>> import Squeal.PostgreSQL.Render

90```

88```

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

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

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

101

102```Haskell

100```Haskell

103>>> :{

101>>> :{

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

115type Schema =

102type Schema =

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

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

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

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

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

107+ ])

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

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

118−type Schemas = Public Schema

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

119:}

117:}

120```

118```

121

119

122Notice the use of type operators.

120Notice the use of type operators.

123

121

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

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

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

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

126operator.

124operator.

127

125

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

139```Haskell

137```Haskell

140>>> :{

138>>> :{

141let

139let

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

140+ setup :: Definition '[] Schema

143 setup =

141 setup =

144 createTable #users

142 createTable #users

145 ( serial `as` #id :*

143 ( serial `as` #id :*

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

171```Haskell

169```Haskell

172>>> :{

170>>> :{

173let

171let

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

172+ teardown :: Definition Schema '[]

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

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

176:}

174:}

177

175

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

180DROP TABLE "users";

178DROP TABLE "users";

181```

179```

182

180

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.

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

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

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

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

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

195−and an output row. When

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

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

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

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

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

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

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

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

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

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

201−`with` statement.

190+of our inserts.

202

191

203```Haskell

192```Haskell

204>>> :{

193>>> :{

205let

194let

206− insertUser :: Manipulation_ Schemas User ()

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

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

196+ insertUser = insertRow #users

208− where

209− u = insertInto #users

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

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

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

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

212− e = insertInto_ #emails $ Select

199+:}

200+

201+>>> :{

202+let

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

204+ insertEmail = insertRow #emails

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

205+ ( Default `as` #id :*

214− (from (common #u))

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

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

208+ OnConflictDoNothing (Returning Nil)

215:}

209:}

216

210

217>>> printSQL insertUser

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

219```

215```

220

216

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

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

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

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

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

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

225

221

226```Haskell

222```Haskell

227>>> :{

223>>> :{

228let

224let

229− getUsers :: Query_ Schemas () User

225+ getUsers :: Query Schema '[]

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

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

230− getUsers = select_

228+ getUsers = select

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

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

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

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

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

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

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

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

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

239```

237```

240

238

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+

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

251+Let's also create some users to add to the database.

242

252

243```Haskell

253```Haskell

244>>> :{

254>>> :{

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

263```Haskell

273```Haskell

264>>> :{

274>>> :{

265let

275let

266− session :: PQ Schemas Schemas IO ()

276+ session :: PQ Schema Schema IO ()

267 session = do

277 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))

269 usersResult <- runQuery getUsers

281 usersResult <- runQuery getUsers

270 usersRows <- getRows usersResult

282 usersRows <- getRows usersResult

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

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

272in

284in

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

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

274 define setup

286 define setup

275 & pqThen session

287 & pqThen session

276 & pqThen (define teardown)

288 & pqThen (define teardown)

277:}

289:}

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

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

279−-}

280```

291```

RELEASE NOTES.md−400

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

1## 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−

403### Version 0.4

3### Version 0.4

404

405Version 0.4 strengthens Squeal's type system, adds

5Version 0.4 strengthens Squeal's type system, adds

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

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

12module Main (main, main2) where

14+import Control.Monad (void)

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

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

15import Data.Int (Int16, Int32)

16import Data.Int (Int16, Int32)

16import Data.Monoid ((<>))

17import Data.Monoid ((<>))

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

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

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

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

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

40 ])

41 ])

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

42 ]

44type Schemas = Public Schema

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

53 >>>

54 createTable #emails

55 ( serial `as` #id :*

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

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

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

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

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

59 foreignKey #user_id #users #id

60 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

61− >>>

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

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

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

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

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

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

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

68insertUser = insertInto #users

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

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

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

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

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

73insertEmail = insertInto_ #emails

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

76getUsers :: Query_ Schemas () User

74getUsers :: Query_ Schemas () User

77getUsers = select_

75getUsers = select_

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

119

117

120main2 :: IO ()

118main2 :: IO ()

121main2 =

119main2 =

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

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

123 define setup

121 define setup

124 & pqThen session

122 & pqThen session

125 & pqThen (define teardown)

123 & pqThen (define teardown)

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

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

1name: squeal-postgresql

2−version: 0.5.1.0

2+version: 0.4.9.0

3synopsis: Squeal PostgreSQL Library

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

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

@@ -25,31 +25,18 @@ library

25 Squeal.PostgreSQL.Alias

26 Squeal.PostgreSQL.Binary

27 Squeal.PostgreSQL.Definition

28− Squeal.PostgreSQL.Definition.Function

29− Squeal.PostgreSQL.Definition.Index

30− Squeal.PostgreSQL.Definition.Table

31− Squeal.PostgreSQL.Definition.Table.Constraint

32− Squeal.PostgreSQL.Definition.Type

33− Squeal.PostgreSQL.Definition.Schema

34− Squeal.PostgreSQL.Definition.View

35 Squeal.PostgreSQL.Expression

28 Squeal.PostgreSQL.Expression

36 Squeal.PostgreSQL.Expression.Aggregate

29 Squeal.PostgreSQL.Expression.Aggregate

37 Squeal.PostgreSQL.Expression.Collection

30 Squeal.PostgreSQL.Expression.Collection

38 Squeal.PostgreSQL.Expression.Comparison

31 Squeal.PostgreSQL.Expression.Comparison

39 Squeal.PostgreSQL.Expression.Json

32 Squeal.PostgreSQL.Expression.Json

40− Squeal.PostgreSQL.Expression.Literal

41 Squeal.PostgreSQL.Expression.Logic

33 Squeal.PostgreSQL.Expression.Logic

42 Squeal.PostgreSQL.Expression.Math

34 Squeal.PostgreSQL.Expression.Math

43 Squeal.PostgreSQL.Expression.Null

35 Squeal.PostgreSQL.Expression.Null

44− Squeal.PostgreSQL.Expression.Parameter

45− Squeal.PostgreSQL.Expression.Range

46− Squeal.PostgreSQL.Expression.Set

47 Squeal.PostgreSQL.Expression.Sort

36 Squeal.PostgreSQL.Expression.Sort

48− Squeal.PostgreSQL.Expression.Subquery

49 Squeal.PostgreSQL.Expression.Text

37 Squeal.PostgreSQL.Expression.Text

50 Squeal.PostgreSQL.Expression.TextSearch

38 Squeal.PostgreSQL.Expression.TextSearch

51 Squeal.PostgreSQL.Expression.Time

39 Squeal.PostgreSQL.Expression.Time

52− Squeal.PostgreSQL.Expression.Type

53 Squeal.PostgreSQL.Expression.Window

40 Squeal.PostgreSQL.Expression.Window

54 Squeal.PostgreSQL.List

41 Squeal.PostgreSQL.List

55 Squeal.PostgreSQL.Manipulation

42 Squeal.PostgreSQL.Manipulation

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

70 , bytestring >= 0.10.8.2

57 , bytestring >= 0.10.8.2

71 , bytestring-strict-builder >= 0.4.5

58 , bytestring-strict-builder >= 0.4.5

72 , deepseq >= 1.4.3.0

59 , deepseq >= 1.4.3.0

73− , free-categories >= 0.1.0.0

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

60+ , generics-sop >= 0.3.2.0

75 , mmorph >= 1.1.1

61 , mmorph >= 1.1.1

76 , mtl >= 2.2.2

62 , mtl >= 2.2.2

77 , network-ip >= 0.3.0.2

63 , network-ip >= 0.3.0.2

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

88 , uuid-types >= 1.0.3

74 , uuid-types >= 1.0.3

89 , vector >= 0.12.0.1

75 , vector >= 0.12.0.1

91−test-suite doctest

77+test-suite squeal-postgresql-doctest

92 default-language: Haskell2010

78 default-language: Haskell2010

93 type: exitcode-stdio-1.0

79 type: exitcode-stdio-1.0

94 hs-source-dirs: test

80 hs-source-dirs: test

95 ghc-options: -Wall

81 ghc-options: -Wall

96− main-is: Doc.hs

82+ main-is: DocTest.hs

97 build-depends:

83 build-depends:

98 base >= 4.10.0.0

84 base >= 4.10.0.0

99 , doctest >= 0.11.4

85 , doctest >= 0.11.4

100− , squeal-postgresql

101

102−test-suite properties

87+test-suite squeal-postgresql-specs

103 default-language: Haskell2010

88 default-language: Haskell2010

104 type: exitcode-stdio-1.0

89 type: exitcode-stdio-1.0

105− hs-source-dirs: test

90+ hs-source-dirs: test/Specs

106− ghc-options: -Wall

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

107− main-is: Property.hs

92+ main-is: Specs.hs

93+ other-modules: ExceptionHandling

108 build-depends:

94 build-depends:

109 base >= 4.10.0.0

95 base >= 4.10.0.0

110 , bytestring >= 0.10.8.2

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

127 , generics-sop >= 0.3.1.0

97 , generics-sop >= 0.3.1.0

128 , hspec >= 2.4.8

98 , hspec >= 2.4.8

129− , mtl >= 2.2.2

130 , squeal-postgresql

99 , squeal-postgresql

131 , text >= 1.2.2.2

100 , text >= 1.2.2.2

101+ , transformers >= 0.5.2.0

132 , vector >= 0.12.0.1

102 , vector >= 0.12.0.1

133

103

134−executable example

104+executable squeal-postgresql-example

135 default-language: Haskell2010

105 default-language: Haskell2010

136 hs-source-dirs: exe

106 hs-source-dirs: exe

137 ghc-options: -Wall

107 ghc-options: -Wall

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

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

1{-|

2Module: Squeal.PostgreSQL

3Description: Squeal export module

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

5Maintainer: eitan@morphism.tech

6Stability: experimental

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

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

12features.

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

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

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

17We'll need some imports.

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

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

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

20>>> import Data.Int (Int32)

21>>> import Data.Int (Int32)

21>>> import Data.Text (Text)

22>>> import Data.Text (Text)

22>>> import Squeal.PostgreSQL

23>>> import Squeal.PostgreSQL

24+>>> import Squeal.PostgreSQL.Render

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

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

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

102DROP TABLE "emails";

104DROP TABLE "emails";

103DROP TABLE "users";

105DROP TABLE "users";

104

106

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.

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

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

108+A `Manipulation` like `insertInto`, `update` or `deleteFrom`

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

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

115−and an output row. When

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

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

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

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

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

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

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

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

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

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

121−`with` statement.

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

122

126

123>>> :{

127>>> :{

124let

128let

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

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

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

127 where

131 where

128 u = insertInto #users

132 u = insertInto #users

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

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

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

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

131− e = insertInto_ #emails $ Select

135+ e = insertInto_ #emails

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

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

133− (from (common #u))

134:}

137:}

135

138

136>>> printSQL insertUser

139>>> printSQL insertUser

137WITH "u" AS (INSERT INTO "users" ("id", "name") VALUES (DEFAULT, ($1 :: text)) RETURNING "id" AS "id", ($2 :: text) AS "email") INSERT INTO "emails" ("user_id", "email") SELECT "u"."id", "u"."email" FROM "u" AS "u"

140WITH "u" AS (INSERT INTO "users" ("id", "name") VALUES (DEFAULT, ($1 :: text)) RETURNING "id" AS "id", ($2 :: text) AS "email") INSERT INTO "emails" ("user_id", "email") SELECT "u"."id", "u"."email" FROM "u" AS "u"

138

141

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

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

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

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

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

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

143

146

144>>> :{

147>>> :{

145let

148let

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

183 usersRows <- getRows usersResult

186 usersRows <- getRows usersResult

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

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

185in

188in

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

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

187 define setup

190 define setup

188 & pqThen session

191 & pqThen session

189 & pqThen (define teardown)

192 & pqThen (define teardown)

190:}

193:}

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

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

192-}

195-}

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

196+module Squeal.PostgreSQL

194−

197+ ( module Squeal.PostgreSQL.Alias

198+ , module Squeal.PostgreSQL.Binary

199+ , module Squeal.PostgreSQL.Definition

200+ , module Squeal.PostgreSQL.Expression

201+ , module Squeal.PostgreSQL.Expression.Aggregate

202+ , module Squeal.PostgreSQL.Expression.Collection

203+ , module Squeal.PostgreSQL.Expression.Comparison

204+ , module Squeal.PostgreSQL.Expression.Json

205+ , module Squeal.PostgreSQL.Expression.Logic

206+ , module Squeal.PostgreSQL.Expression.Math

207+ , module Squeal.PostgreSQL.Expression.Null

208+ , module Squeal.PostgreSQL.Expression.Text

209+ , module Squeal.PostgreSQL.Expression.TextSearch

210+ , module Squeal.PostgreSQL.Expression.Time

211+ , module Squeal.PostgreSQL.Expression.Window

212+ , module Squeal.PostgreSQL.List

213+ , module Squeal.PostgreSQL.Manipulation

214+ , module Squeal.PostgreSQL.PG

215+ , module Squeal.PostgreSQL.PQ

216+ , module Squeal.PostgreSQL.Query

217+ , module Squeal.PostgreSQL.Schema

218+ , module Squeal.PostgreSQL.Transaction

219+ ) where

220+

195−import Squeal.PostgreSQL.Alias as X

221+import Squeal.PostgreSQL.Alias

196−import Squeal.PostgreSQL.Binary as X

222+import Squeal.PostgreSQL.Binary

197−import Squeal.PostgreSQL.Definition as X

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

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

223+import Squeal.PostgreSQL.Definition

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

224+import Squeal.PostgreSQL.Expression

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

225+import Squeal.PostgreSQL.Expression.Aggregate

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

226+import Squeal.PostgreSQL.Expression.Collection

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

227+import Squeal.PostgreSQL.Expression.Comparison

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

228+import Squeal.PostgreSQL.Expression.Json

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

229+import Squeal.PostgreSQL.Expression.Logic

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

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

230+import Squeal.PostgreSQL.Expression.Math

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

231+import Squeal.PostgreSQL.Expression.Null

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

232+import Squeal.PostgreSQL.Expression.Text

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

233+import Squeal.PostgreSQL.Expression.TextSearch

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

234+import Squeal.PostgreSQL.Expression.Time

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

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

235+import Squeal.PostgreSQL.Expression.Window

224−import Squeal.PostgreSQL.List as X

236+import Squeal.PostgreSQL.List

225−import Squeal.PostgreSQL.Manipulation as X

237+import Squeal.PostgreSQL.Manipulation

226−import Squeal.PostgreSQL.Migration as X

238+import Squeal.PostgreSQL.PG

227−import Squeal.PostgreSQL.PG as X

228−import Squeal.PostgreSQL.Pool as X

229−import Squeal.PostgreSQL.PQ as X

239+import Squeal.PostgreSQL.PQ

230−import Squeal.PostgreSQL.Query as X

240+import Squeal.PostgreSQL.Query

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

241+import Squeal.PostgreSQL.Schema

232−import Squeal.PostgreSQL.Schema as X

233−import Squeal.PostgreSQL.Transaction as X

242+import Squeal.PostgreSQL.Transaction

squeal-postgresql/src/Squeal/PostgreSQL/Alias.hs+12−18

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

13{-# LANGUAGE

1{-# LANGUAGE

14 AllowAmbiguousTypes

2 AllowAmbiguousTypes

15 , ConstraintKinds

3 , ConstraintKinds

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

46 , HasIn

34 , HasIn

47 , QualifiedAlias (..)

35 , QualifiedAlias (..)

48 , IsQualified (..)

36 , IsQualified (..)

37+ , DefaultAliasable (..)

49 -- * Grouping

38 -- * Grouping

50 , Grouping (..)

39 , Grouping (..)

51 , GroupedBy

40 , GroupedBy

@@ -63,9 +52,6 @@ import qualified GHC.Generics as GHC

63import Squeal.PostgreSQL.List

52import Squeal.PostgreSQL.List

64import Squeal.PostgreSQL.Render

53import Squeal.PostgreSQL.Render

66−-- $setup

67−-- >>> import Squeal.PostgreSQL

68−

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

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

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

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

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

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

@@ -110,7 +96,8 @@ instance aliases ~ '[alias] => IsLabel alias (NP Alias aliases) where

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

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

111 renderSQL = doubleQuoted . fromString . symbolVal

97 renderSQL = doubleQuoted . fromString . symbolVal

112

99+-- | >>> import Generics.SOP (NP(..))

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

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

114-- "jimbob", "kandi"

101-- "jimbob", "kandi"

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

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

116 renderSQL

103 renderSQL

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

188class HasIn fields field where

175class HasIn fields field where

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

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

190

177

178+{- |

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

180+for default inserts and updates.

181+-}

182+class KnownSymbol alias

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

184+ defaultAs :: Alias alias -> aliased

185+

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

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

192-- a list of @subfields@.

187-- a list of @subfields@.

193class

188class

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

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

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

212

207

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

208{-| `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,

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

216a qualifier of @public@ is provided.

210a qualifier of @public@ is provided.

217

211

218>>> :{

212>>> :{

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

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

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

41>>> :{

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

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

43 result <- runQueryParams roundTrip input

44 Just output <- firstRow result

45 liftIO . print $ input == output

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

78>>> :set -XOverloadedLists

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

80>>> :{

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

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

82 result <- runQueryParams roundTrip input

83 Just output <- firstRow result

84 liftIO . print $ input == output

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

170 Just output <- firstRow result

171 liftIO . print $ input == output

172in

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

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

174 define setup

175 & pqThen session

176 & pqThen (define teardown)

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

205 ( -- * Encoding

206 ToParam (..)

207 , ToParams (..)

208− , ToNullityParam (..)

208+ , ToNullityParam

209− , ToField (..)

209+ , ToField

210− , ToFixArray (..)

210+ , ToFixArray

211 -- * Decoding

212 , FromValue (..)

213 , FromRow (..)

214− , FromField (..)

215− , FromFixArray (..)

216 -- * Only

214 -- * Only

217 , Only (..)

215 , Only (..)

218− -- * Oid

219− , OidOf (..)

220− , OidOfParam (..)

221− , OidOfField (..)

222 ) where

216 ) where

223

217

224import BinaryParser

218import BinaryParser

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

232import Data.UUID.Types

226import Data.UUID.Types

233import Data.Vector (Vector)

227import Data.Vector (Vector)

234import Data.Word

228import Data.Word

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

236import Generics.SOP

229import Generics.SOP

237import Generics.SOP.Record

230import Generics.SOP.Record

238import GHC.TypeLits

231import GHC.TypeLits

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

246import qualified Data.Text as Strict (Text)

239import qualified Data.Text as Strict (Text)

247import qualified Data.Text as Strict.Text

240import qualified Data.Text as Strict.Text

248import qualified Data.Vector as Vector

241import qualified Data.Vector as Vector

249−import qualified Database.PostgreSQL.LibPQ as LibPQ

250import qualified GHC.Generics as GHC

242import qualified GHC.Generics as GHC

251import qualified PostgreSQL.Binary.Decoding as Decoding

243import qualified PostgreSQL.Binary.Decoding as Decoding

252import qualified PostgreSQL.Binary.Encoding as Encoding

244import qualified PostgreSQL.Binary.Encoding as Encoding

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

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

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

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

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

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

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

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

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

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

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

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

275instance 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

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

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

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

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

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

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

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

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

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

313 toParam = K . Encoding.jsonb_bytes

307 toParam = K . Encoding.jsonb_bytes

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

308 . 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)

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

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

317 toParam = K

311 toParam = K

318− . Encoding.array_foldable

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

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

320 . getVarArray

313 . getVarArray

321−instance (ToParam x pg, OidOf pg)

314+instance (ToParam x pg, HasOid pg)

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

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

323 toParam = K

316 toParam = K

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

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

325 . getVarArray

318 . getVarArray

326−instance (ToParam x pg, OidOf pg)

319+instance (ToParam x pg, HasOid pg)

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

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

328 toParam = K

321 toParam = K

329− . Encoding.nullableArray_vector

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

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

331 . getVarArray

323 . getVarArray

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

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

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

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

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

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

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

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

336instance

328instance

337 ( IsEnumType x

329 ( IsEnumType x

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

356 ( SListI fields

348 ( SListI fields

357 , IsRecord x xs

349 , IsRecord x xs

358 , AllZip ToField xs fields

350 , AllZip ToField xs fields

359− , All OidOfField fields

351+ , All HasAliasedOid fields

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

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

361 toParam =

353 toParam =

362 let

354 let

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

364 encoders = htrans (Proxy @ToField) toField

356 encoders = htrans (Proxy @ToField) toField

365

357

366 composite

358 composite

367− :: All OidOfField row

359+ :: All HasAliasedOid row

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

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

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

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

370 composite fields = K $

362 composite fields = K $

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

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

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

382 let

374 let

383 each

375 each

384− :: OidOfField field

376+ :: HasAliasedOid field

385 => K (Maybe Encoding.Encoding) field

377 => K (Maybe Encoding.Encoding) field

386 -> Encoding.Encoding

378 -> Encoding.Encoding

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

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

388− word32BE (getOid (oidOfField @field))

380+ word32BE (aliasedOid @field)

389 <> case field of

381 <> case field of

390 Nothing -> int64BE (-1)

382 Nothing -> int64BE (-1)

391 Just value ->

383 Just value ->

392 int32BE (fromIntegral (builderLength value))

384 int32BE (fromIntegral (builderLength value))

393 <> value

385 <> value

394 in

386 in

395− hcfoldMap (Proxy @OidOfField) each fields

387+ hcfoldMap (Proxy @HasAliasedOid) each fields

396

388

397 in

389 in

398 composite . encoders . toRecord . getComposite

390 composite . encoders . toRecord . getComposite

399

391

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

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

514− oidOfField :: Oid

393+ aliasedOid :: Word32

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

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

516− oidOfField = oidOf @ty

395+ aliasedOid = oid @ty

517−

396+

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

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

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

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

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

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

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

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

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

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

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

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

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

526

403

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.

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

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

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

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

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

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

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

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

535

408

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

722 Decoding.valueParser (fromValue @pg) bytestring

590 Decoding.valueParser (fromValue @pg) bytestring

723

591

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.

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

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

729 fromFixArray :: Decoding.Array y

593 fromFixArray :: Decoding.Array y

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

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

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

769 = fmap fromRecord

633 = fmap fromRecord

770 . hsequence'

634 . hsequence'

771 . htrans (Proxy @FromField) fromField

635 . htrans (Proxy @FromField) fromField

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

773−-- P records

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

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

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

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

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

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

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

778−-- instance

639+instance

779−-- ( row ~ Join row1 row2

640+ ( row ~ Join row1 row2

780−-- , FromRow row1 hask1

641+ , FromRow row1 hask1

781−-- , FromRow row2 hask2

642+ , FromRow row2 hask2

782−-- , SListI row

643+ , SListI row

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

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

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

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

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

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

786−-- instance

647+instance

787−-- ( row ~ Join row1 row23

648+ ( row ~ Join row1 row23

788−-- , FromRow row1 hask1

649+ , FromRow row1 hask1

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

650+ , FromRow row23 (hask2, hask3)

790−-- , SListI row

651+ , SListI row

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

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

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

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

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

654+ (row1, row23) -> do

794−-- hask1 <- fromRow row1

655+ hask1 <- fromRow row1

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

656+ (hask2, hask3) <- fromRow row23

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

657+ return (hask1, hask2, hask3)

797−-- instance

658+instance

798−-- ( row ~ Join row1 row234

659+ ( row ~ Join row1 row234

799−-- , FromRow row1 hask1

660+ , FromRow row1 hask1

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

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

801−-- , SListI row

662+ , SListI row

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

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

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

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

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

665+ (row1, row234) -> do

805−-- hask1 <- fromRow row1

666+ hask1 <- fromRow row1

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

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

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

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

808−-- instance

669+instance

809−-- ( row ~ Join row1 row2345

670+ ( row ~ Join row1 row2345

810−-- , FromRow row1 hask1

671+ , FromRow row1 hask1

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

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

812−-- , SListI row

673+ , SListI row

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

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

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

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

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

676+ (row1, row2345) -> do

816−-- hask1 <- fromRow row1

677+ hask1 <- fromRow row1

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

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

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

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

819

680

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

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

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

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

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

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

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

844replicateMN mx = hsequence' $

705replicateMN mx = hsequence' $

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

706 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+1015−12

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

11{-# LANGUAGE

12 AllowAmbiguousTypes

13 , ConstraintKinds

14− , DeriveAnyClass

15 , DeriveGeneric

14 , DeriveGeneric

16− , DerivingStrategies

17 , FlexibleContexts

15 , FlexibleContexts

18 , FlexibleInstances

16 , FlexibleInstances

19 , GADTs

17 , GADTs

18+ , GeneralizedNewtypeDeriving

20 , LambdaCase

19 , LambdaCase

21 , MultiParamTypeClasses

20 , MultiParamTypeClasses

22− , OverloadedLabels

23 , OverloadedStrings

21 , OverloadedStrings

24 , RankNTypes

22 , RankNTypes

25 , ScopedTypeVariables

23 , ScopedTypeVariables

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

27 , TypeInType

25 , TypeInType

28 , TypeOperators

26 , TypeOperators

29 , UndecidableSuperClasses

27 , UndecidableSuperClasses

30− , UndecidableInstances

31#-}

28#-}

33module Squeal.PostgreSQL.Definition

30module Squeal.PostgreSQL.Definition

34 ( -- * Definition

31 ( -- * Definition

35 Definition (..)

32 Definition (..)

36 , (>>>)

33 , (>>>)

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

38 ) where

86 ) where

40import Control.Category

88import Control.Category

41import Control.DeepSeq

89import Control.DeepSeq

42import Data.ByteString

90import Data.ByteString

43import Data.Monoid

91import Data.Monoid

92+import GHC.TypeLits

44import Prelude hiding ((.), id)

93import Prelude hiding ((.), id)

95+import qualified Generics.SOP as SOP

46import qualified GHC.Generics as GHC

96import qualified GHC.Generics as GHC

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.List

102+import Squeal.PostgreSQL.PG

103+import Squeal.PostgreSQL.Query

49import Squeal.PostgreSQL.Render

104import Squeal.PostgreSQL.Render

50import Squeal.PostgreSQL.Schema

105import Squeal.PostgreSQL.Schema

106

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

73 ddl1 . ddl0 = UnsafeDefinition $

128 ddl1 . ddl0 = UnsafeDefinition $

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

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

130

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

131+{-----------------------------------------

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

132+CREATE statements

78−manipDefinition

133+-----------------------------------------}

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

134+

80− -- ^ no input or output

135+createSchema

136+ :: KnownSymbol sch

137+ => Alias sch

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

139+createSchema sch = UnsafeDefinition $

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

141+

142+createSchemaIfNotExists

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

144+ => Alias sch

81 -> Definition schemas schemas

145 -> Definition schemas schemas

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

146+createSchemaIfNotExists sch = UnsafeDefinition $

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

148+ <+> renderSQL sch <> ";"

149+

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

151+

152+>>> :set -XOverloadedLabels

153+>>> :{

154+type Table = '[] :=>

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

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

157+:}

158+

159+>>> :{

160+let

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

162+ setup = createTable #tab

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

164+in printSQL setup

165+:}

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

167+-}

168+createTable

169+ :: ( KnownSymbol sch

170+ , KnownSymbol tab

171+ , columns ~ (col ': cols)

172+ , SOP.SListI columns

173+ , SOP.SListI constraints

174+ , Has sch schemas0 schema0

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

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

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

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

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

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

181+ -> Definition schemas0 schemas1

182+createTable tab columns constraints = UnsafeDefinition $

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

184+

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

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

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

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

189+

190+>>> :set -XOverloadedLabels -XTypeApplications

191+>>> :{

192+type Table = '[] :=>

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

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

195+:}

196+

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

198+

199+>>> :{

200+let

201+ setup :: Definition Schemas Schemas

202+ setup = createTableIfNotExists #tab

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

204+in printSQL setup

205+:}

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

207+-}

208+createTableIfNotExists

209+ :: ( Has sch schemas schema

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

211+ , SOP.SListI columns

212+ , SOP.SListI constraints )

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

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

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

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

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

218+ -> Definition schemas schemas

219+createTableIfNotExists tab columns constraints = UnsafeDefinition $

220+ "CREATE TABLE IF NOT EXISTS"

221+ <+> renderCreation tab columns constraints

222+

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

224+renderCreation

225+ :: ( KnownSymbol sch

226+ , KnownSymbol tab

227+ , SOP.SListI columns

228+ , SOP.SListI constraints )

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

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

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

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

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

234+ -> ByteString

235+renderCreation tab columns constraints = renderSQL tab

236+ <+> parenthesized

237+ ( renderCommaSeparated renderColumnDef columns

238+ <> ( case constraints of

239+ Nil -> ""

240+ _ -> ", " <>

241+ renderCommaSeparated renderConstraint constraints ) )

242+ <> ";"

243+ where

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

245+ renderColumnDef (ty `As` column) =

246+ renderSQL column <+> renderColumnTypeExpression ty

247+ renderConstraint

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

249+ -> ByteString

250+ renderConstraint (constraint `As` alias) =

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

252+

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

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

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

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

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

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

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

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

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

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

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

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

265+newtype TableConstraintExpression

266+ (sch :: Symbol)

267+ (tab :: Symbol)

268+ (schemas :: SchemasType)

269+ (constraint :: TableConstraint)

270+ = UnsafeTableConstraintExpression

271+ { renderTableConstraintExpression :: ByteString }

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

273+instance RenderSQL

274+ (TableConstraintExpression sch tab schemas constraint) where

275+ renderSQL = renderTableConstraintExpression

276+

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

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

279+a Boolean (truth-value) expression.

280+

281+>>> :{

282+type Schema = '[

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

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

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

286+ ])]

287+:}

288+

289+>>> :{

290+let

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

292+ definition = createTable #tab

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

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

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

296+:}

297+

298+>>> printSQL definition

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

300+-}

301+check

302+ :: ( Has sch schemas schema

303+ , Has tab schema ('Table table)

304+ , HasAll aliases (TableToRow table) subcolumns )

305+ => NP Alias aliases

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

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

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

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

310+check _cols condition = UnsafeTableConstraintExpression $

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

312+

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

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

315+

316+>>> :{

317+type Schema = '[

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

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

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

321+ ])]

322+:}

323+

324+>>> :{

325+let

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

327+ definition = createTable #tab

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

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

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

331+:}

332+

333+>>> printSQL definition

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

335+-}

336+unique

337+ :: ( Has sch schemas schema

338+ , Has tab schema('Table table)

339+ , HasAll aliases (TableToRow table) subcolumns )

340+ => NP Alias aliases

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

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

343+unique columns = UnsafeTableConstraintExpression $

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

345+

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

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

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

349+

350+>>> :{

351+type Schema = '[

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

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

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

355+ ])]

356+:}

357+

358+>>> :{

359+let

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

361+ definition = createTable #tab

362+ ( serial `as` #id :*

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

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

365+:}

366+

367+>>> printSQL definition

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

369+-}

370+primaryKey

371+ :: ( Has sch schemas schema

372+ , Has tab schema ('Table table)

373+ , HasAll aliases (TableToColumns table) subcolumns

374+ , AllNotNull subcolumns )

375+ => NP Alias aliases

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

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

378+primaryKey columns = UnsafeTableConstraintExpression $

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

380+

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

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

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

384+between two related tables.

385+

386+>>> :{

387+type Schema =

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

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

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

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

392+ ])

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

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

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

396+ ] :=>

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

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

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

400+ ])

401+ ]

402+:}

403+

404+>>> :{

405+let

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

407+ setup =

408+ createTable #users

409+ ( serial `as` #id :*

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

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

412+ createTable #emails

413+ ( serial `as` #id :*

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

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

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

417+ foreignKey #user_id #users #id

418+ OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

419+in printSQL setup

420+:}

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

422+CREATE TABLE "emails" ("id" serial, "user_id" int NOT NULL, "email" text NULL, CONSTRAINT "pk_emails" PRIMARY KEY ("id"), CONSTRAINT "fk_user_id" FOREIGN KEY ("user_id") REFERENCES "users" ("id") ON DELETE CASCADE ON UPDATE CASCADE);

423+

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

425+

426+>>> :{

427+type Schema =

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

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

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

431+ ] :=>

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

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

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

435+ ])

436+ ]

437+:}

438+

439+>>> :{

440+let

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

442+ setup =

443+ createTable #employees

444+ ( serial `as` #id :*

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

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

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

448+ foreignKey #employer_id #employees #id

449+ OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )

450+in printSQL setup

451+:}

452+CREATE TABLE "employees" ("id" serial, "name" text NOT NULL, "employer_id" integer NULL, CONSTRAINT "employees_pk" PRIMARY KEY ("id"), CONSTRAINT "employees_employer_fk" FOREIGN KEY ("employer_id") REFERENCES "employees" ("id") ON DELETE CASCADE ON UPDATE CASCADE);

453+-}

454+foreignKey

455+ :: (ForeignKeyed schemas sch schema child parent

456+ table reftable

457+ columns refcolumns

458+ constraints cols

459+ reftys tys )

460+ => NP Alias columns

461+ -- ^ column or columns in the table

462+ -> Alias parent

463+ -- ^ reference table

464+ -> NP Alias refcolumns

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

466+ -> OnDeleteClause

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

468+ -> OnUpdateClause

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

470+ -> TableConstraintExpression sch child schemas

471+ ('ForeignKey columns parent refcolumns)

472+foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $

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

474+ <+> "REFERENCES" <+> renderSQL parent

475+ <+> parenthesized (renderSQL refs)

476+ <+> renderSQL ondel

477+ <+> renderSQL onupd

478+

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

480+type ForeignKeyed schemas

481+ sch

482+ schema

483+ child parent

484+ table reftable

485+ columns refcolumns

486+ constraints cols

487+ reftys tys =

488+ ( Has sch schemas schema

489+ , Has child schema ('Table table)

490+ , Has parent schema ('Table reftable)

491+ , HasAll columns (TableToColumns table) tys

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

493+ , HasAll refcolumns cols reftys

494+ , SOP.AllZip SamePGType tys reftys

495+ , Uniquely refcolumns constraints )

496+

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

498+data OnDeleteClause

499+ = OnDeleteNoAction

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

501+ -- an error is raised

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

503+ | OnDeleteCascade

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

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

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

507+instance NFData OnDeleteClause

508+-- | Render `OnDeleteClause`.

509+instance RenderSQL OnDeleteClause where

510+ renderSQL = \case

511+ OnDeleteNoAction -> "ON DELETE NO ACTION"

512+ OnDeleteRestrict -> "ON DELETE RESTRICT"

513+ OnDeleteCascade -> "ON DELETE CASCADE"

514+

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

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

517+data OnUpdateClause

518+ = OnUpdateNoAction

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

520+ -- an error is raised

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

522+ | OnUpdateCascade

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

524+ -- into the referencing row(s)

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

526+instance NFData OnUpdateClause

527+

528+-- | Render `OnUpdateClause`.

529+instance RenderSQL OnUpdateClause where

530+ renderSQL = \case

531+ OnUpdateNoAction -> "ON UPDATE NO ACTION"

532+ OnUpdateRestrict -> "ON UPDATE RESTRICT"

533+ OnUpdateCascade -> "ON UPDATE CASCADE"

534+

535+{-----------------------------------------

536+DROP statements

537+-----------------------------------------}

538+

539+-- >>> :{

540+-- let

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

542+-- definition = dropSchema #muh_schema

543+-- :}

544+--

545+-- >>> printSQL definition

546+-- DROP SCHEMA "muh_schema";

547+dropSchema

548+ :: Has sch schemas schema

549+ => Alias sch

550+ -> Definition schemas (Drop sch schemas)

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

552+

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

554+--

555+-- >>> :{

556+-- let

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

558+-- definition = dropTable #muh_table

559+-- :}

560+--

561+-- >>> printSQL definition

562+-- DROP TABLE "muh_table";

563+dropTable

564+ :: ( Has sch schemas schema

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

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

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

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

569+

570+{-----------------------------------------

571+ALTER statements

572+-----------------------------------------}

573+

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

575+alterTable

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

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

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

579+ -> Definition schemas (Alter sch (Alter tab ('Table table1) schema) schemas)

580+alterTable tab alteration = UnsafeDefinition $

581+ "ALTER TABLE"

582+ <+> renderSQL tab

583+ <+> renderAlterTable alteration

584+ <> ";"

585+

586+-- | `alterTableRename` changes the name of a table from the schema.

587+--

588+-- >>> printSQL $ alterTableRename #foo #bar

589+-- ALTER TABLE "foo" RENAME TO "bar";

590+alterTableRename

591+ :: (KnownSymbol table0, KnownSymbol table1)

592+ => Alias table0 -- ^ table to rename

593+ -> Alias table1 -- ^ what to rename it

594+ -> Definition schema (Rename table0 table1 schema)

595+alterTableRename table0 table1 = UnsafeDefinition $

596+ "ALTER TABLE" <+> renderSQL table0

597+ <+> "RENAME TO" <+> renderSQL table1 <> ";"

598+

599+-- | An `AlterTable` describes the alteration to perform on the columns

600+-- of a table.

601+newtype AlterTable

602+ (sch :: Symbol)

603+ (tab :: Symbol)

604+ (schemas :: SchemasType)

605+ (table :: TableType) =

606+ UnsafeAlterTable {renderAlterTable :: ByteString}

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

608+

609+-- | An `addConstraint` adds a table constraint.

610+--

611+-- >>> :{

612+-- let

613+-- definition :: Definition

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

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

616+-- definition = alterTable #tab (addConstraint #positive (check #col (#col .> 0)))

617+-- in printSQL definition

618+-- :}

619+-- ALTER TABLE "tab" ADD CONSTRAINT "positive" CHECK (("col" > 0));

620+addConstraint

621+ :: ( KnownSymbol alias

622+ , Has sch schemas schema

623+ , Has tab schema ('Table table0)

624+ , table0 ~ (constraints :=> columns)

625+ , table1 ~ (Create alias constraint constraints :=> columns) )

626+ => Alias alias

627+ -> TableConstraintExpression sch tab schemas constraint

628+ -- ^ constraint to add

629+ -> AlterTable sch tab schemas table1

630+addConstraint alias constraint = UnsafeAlterTable $

631+ "ADD" <+> "CONSTRAINT" <+> renderSQL alias

632+ <+> renderSQL constraint

633+

634+-- | A `dropConstraint` drops a table constraint.

635+--

636+-- >>> :{

637+-- let

638+-- definition :: Definition

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

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

641+-- definition = alterTable #tab (dropConstraint #positive)

642+-- in printSQL definition

643+-- :}

644+-- ALTER TABLE "tab" DROP CONSTRAINT "positive";

645+dropConstraint

646+ :: ( KnownSymbol constraint

647+ , Has sch schemas schema

648+ , Has tab schema ('Table table0)

649+ , table0 ~ (constraints :=> columns)

650+ , table1 ~ (Drop constraint constraints :=> columns) )

651+ => Alias constraint

652+ -- ^ constraint to drop

653+ -> AlterTable sch tab schemas table1

654+dropConstraint constraint = UnsafeAlterTable $

655+ "DROP" <+> "CONSTRAINT" <+> renderSQL constraint

656+

657+-- | An `AddColumn` is either @NULL@ or has @DEFAULT@.

658+class AddColumn ty where

659+ -- | `addColumn` adds a new column, initially filled with whatever

660+ -- default value is given or with @NULL@.

661+ --

662+ -- >>> :{

663+ -- let

664+ -- definition :: Definition

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

666+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>

667+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

668+ -- , "col2" ::: 'Def :=> 'Null 'PGtext ])]]

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

670+ -- in printSQL definition

671+ -- :}

672+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL DEFAULT E'foo';

673+ --

674+ -- >>> :{

675+ -- let

676+ -- definition :: Definition

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

678+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>

679+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

680+ -- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

681+ -- definition = alterTable #tab (addColumn #col2 (text & nullable))

682+ -- in printSQL definition

683+ -- :}

684+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL;

685+ addColumn

686+ :: ( KnownSymbol column

687+ , Has sch schemas schema

688+ , Has tab schema ('Table table0)

689+ , table0 ~ (constraints :=> columns) )

690+ => Alias column -- ^ column to add

691+ -> ColumnTypeExpression schemas ty -- ^ type of the new column

692+ -> AlterTable sch tab schemas (constraints :=> Create column ty columns)

693+ addColumn column ty = UnsafeAlterTable $

694+ "ADD COLUMN" <+> renderSQL column <+> renderColumnTypeExpression ty

695+instance {-# OVERLAPPING #-} AddColumn ('Def :=> ty)

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

697+

698+-- | A `dropColumn` removes a column. Whatever data was in the column

699+-- disappears. Table constraints involving the column are dropped, too.

700+-- However, if the column is referenced by a foreign key constraint of

701+-- another table, PostgreSQL will not silently drop that constraint.

702+--

703+-- >>> :{

704+-- let

705+-- definition :: Definition

706+-- '["public" ::: '["tab" ::: 'Table ('[] :=>

707+-- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

708+-- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

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

710+-- definition = alterTable #tab (dropColumn #col2)

711+-- in printSQL definition

712+-- :}

713+-- ALTER TABLE "tab" DROP COLUMN "col2";

714+dropColumn

715+ :: ( KnownSymbol column

716+ , Has sch schemas schema

717+ , Has tab schema ('Table table0)

718+ , table0 ~ (constraints :=> columns)

719+ , table1 ~ (constraints :=> Drop column columns) )

720+ => Alias column -- ^ column to remove

721+ -> AlterTable sch tab schemas table1

722+dropColumn column = UnsafeAlterTable $

723+ "DROP COLUMN" <+> renderSQL column

724+

725+-- | A `renameColumn` renames a column.

726+--

727+-- >>> :{

728+-- let

729+-- definition :: Definition

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

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

732+-- definition = alterTable #tab (renameColumn #foo #bar)

733+-- in printSQL definition

734+-- :}

735+-- ALTER TABLE "tab" RENAME COLUMN "foo" TO "bar";

736+renameColumn

737+ :: ( KnownSymbol column0

738+ , KnownSymbol column1

739+ , Has sch schemas schema

740+ , Has tab schema ('Table table0)

741+ , table0 ~ (constraints :=> columns)

742+ , table1 ~ (constraints :=> Rename column0 column1 columns) )

743+ => Alias column0 -- ^ column to rename

744+ -> Alias column1 -- ^ what to rename the column

745+ -> AlterTable sch tab schemas table1

746+renameColumn column0 column1 = UnsafeAlterTable $

747+ "RENAME COLUMN" <+> renderSQL column0 <+> "TO" <+> renderSQL column1

748+

749+-- | An `alterColumn` alters a single column.

750+alterColumn

751+ :: ( KnownSymbol column

752+ , Has sch schemas schema

753+ , Has tab schema ('Table table0)

754+ , table0 ~ (constraints :=> columns)

755+ , Has column columns ty0

756+ , table1 ~ (constraints :=> Alter column ty1 columns))

757+ => Alias column -- ^ column to alter

758+ -> AlterColumn schemas ty0 ty1 -- ^ alteration to perform

759+ -> AlterTable sch tab schemas table1

760+alterColumn column alteration = UnsafeAlterTable $

761+ "ALTER COLUMN" <+> renderSQL column <+> renderAlterColumn alteration

762+

763+-- | An `AlterColumn` describes the alteration to perform on a single column.

764+newtype AlterColumn (schemas :: SchemasType) (ty0 :: ColumnType) (ty1 :: ColumnType) =

765+ UnsafeAlterColumn {renderAlterColumn :: ByteString}

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

767+

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

769+-- affect any existing rows in the table, it just changes the default for

770+-- future insert and update commands.

771+--

772+-- >>> :{

773+-- let

774+-- definition :: Definition

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

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

777+-- definition = alterTable #tab (alterColumn #col (setDefault 5))

778+-- in printSQL definition

779+-- :}

780+-- ALTER TABLE "tab" ALTER COLUMN "col" SET DEFAULT 5;

781+setDefault

782+ :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty -- ^ default value to set

783+ -> AlterColumn schemas (constraint :=> ty) ('Def :=> ty)

784+setDefault expression = UnsafeAlterColumn $

785+ "SET DEFAULT" <+> renderExpression expression

786+

787+-- | A `dropDefault` removes any default value for a column.

788+--

789+-- >>> :{

790+-- let

791+-- definition :: Definition

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

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

794+-- definition = alterTable #tab (alterColumn #col dropDefault)

795+-- in printSQL definition

796+-- :}

797+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP DEFAULT;

798+dropDefault :: AlterColumn schemas ('Def :=> ty) ('NoDef :=> ty)

799+dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"

800+

801+-- | A `setNotNull` adds a @NOT NULL@ constraint to a column.

802+-- The constraint will be checked immediately, so the table data must satisfy

803+-- the constraint before it can be added.

804+--

805+-- >>> :{

806+-- let

807+-- definition :: Definition

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

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

810+-- definition = alterTable #tab (alterColumn #col setNotNull)

811+-- in printSQL definition

812+-- :}

813+-- ALTER TABLE "tab" ALTER COLUMN "col" SET NOT NULL;

814+setNotNull

815+ :: AlterColumn schemas (constraint :=> 'Null ty) (constraint :=> 'NotNull ty)

816+setNotNull = UnsafeAlterColumn $ "SET NOT NULL"

817+

818+-- | A `dropNotNull` drops a @NOT NULL@ constraint from a column.

819+--

820+-- >>> :{

821+-- let

822+-- definition :: Definition

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

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

825+-- definition = alterTable #tab (alterColumn #col dropNotNull)

826+-- in printSQL definition

827+-- :}

828+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP NOT NULL;

829+dropNotNull

830+ :: AlterColumn schemas (constraint :=> 'NotNull ty) (constraint :=> 'Null ty)

831+dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"

832+

833+-- | An `alterType` converts a column to a different data type.

834+-- This will succeed only if each existing entry in the column can be

835+-- converted to the new type by an implicit cast.

836+--

837+-- >>> :{

838+-- let

839+-- definition :: Definition

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

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

842+-- definition =

843+-- alterTable #tab (alterColumn #col (alterType (numeric & notNullable)))

844+-- in printSQL definition

845+-- :}

846+-- ALTER TABLE "tab" ALTER COLUMN "col" TYPE numeric NOT NULL;

847+alterType :: ColumnTypeExpression schemas ty -> AlterColumn schemas ty0 ty

848+alterType ty = UnsafeAlterColumn $ "TYPE" <+> renderColumnTypeExpression ty

849+

850+{- | Create a view.

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

852+>>> type BC = '["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4]

853+>>> :{

854+let

855+ definition :: Definition

856+ '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC)]]

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

858+ definition =

859+ createView #bc (select_ (#b :* #c) (from (table #abc)))

860+in printSQL definition

861+:}

862+CREATE VIEW "bc" AS SELECT "b" AS "b", "c" AS "c" FROM "abc" AS "abc";

863+-}

864+createView

865+ :: (KnownSymbol sch, KnownSymbol vw, Has sch schemas schema)

866+ => QualifiedAlias sch vw -- ^ the name of the view to add

867+ -> Query '[] '[] schemas '[] view -- ^ query

868+ -> Definition schemas (Alter sch (Create vw ('View view) schema) schemas)

869+createView alias query = UnsafeDefinition $

870+ "CREATE" <+> "VIEW" <+> renderSQL alias <+> "AS"

871+ <+> renderQuery query <> ";"

872+

873+-- | Drop a view.

874+--

875+-- >>> :{

876+-- let

877+-- definition :: Definition

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

879+-- , "bc" ::: 'View ('["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4])]]

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

881+-- definition = dropView #bc

882+-- in printSQL definition

883+-- :}

884+-- DROP VIEW "bc";

885+dropView

886+ :: (Has sch schemas schema, Has vw schema ('View view))

887+ => QualifiedAlias sch vw -- ^ view to remove

888+ -> Definition schemas (Alter sch (Drop vw schema) schemas)

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

890+

891+-- | Enumerated types are created using the `createTypeEnum` command, for example

892+--

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

894+-- CREATE TYPE "mood" AS ENUM ('sad', 'ok', 'happy');

895+createTypeEnum

896+ :: (KnownSymbol enum, Has sch schemas schema, SOP.All KnownSymbol labels)

897+ => QualifiedAlias sch enum

898+ -- ^ name of the user defined enumerated type

899+ -> NP PGlabel labels

900+ -- ^ labels of the enumerated type

901+ -> Definition schemas (Alter sch (Create enum ('Typedef ('PGenum labels)) schema) schemas)

902+createTypeEnum enum labels = UnsafeDefinition $

903+ "CREATE" <+> "TYPE" <+> renderSQL enum <+> "AS" <+> "ENUM" <+>

904+ parenthesized (renderSQL labels) <> ";"

905+

906+-- | Enumerated types can also be generated from a Haskell type, for example

907+--

908+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

909+-- >>> instance SOP.Generic Schwarma

910+-- >>> instance SOP.HasDatatypeInfo Schwarma

911+-- >>> :{

912+-- let

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

914+-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma

915+-- in

916+-- printSQL createSchwarma

917+-- :}

918+-- CREATE TYPE "schwarma" AS ENUM ('Beef', 'Lamb', 'Chicken');

919+createTypeEnumFrom

920+ :: forall hask sch enum schemas schema.

921+ ( SOP.Generic hask

922+ , SOP.All KnownSymbol (LabelsPG hask)

923+ , KnownSymbol enum

924+ , Has sch schemas schema )

925+ => QualifiedAlias sch enum

926+ -- ^ name of the user defined enumerated type

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

928+createTypeEnumFrom enum = createTypeEnum enum

929+ (SOP.hpure label :: NP PGlabel (LabelsPG hask))

930+

931+{- | `createTypeComposite` creates a composite type. The composite type is

932+specified by a list of attribute names and data types.

933+

934+>>> :{

935+type PGcomplex = 'PGcomposite

936+ '[ "real" ::: 'NotNull 'PGfloat8

937+ , "imaginary" ::: 'NotNull 'PGfloat8 ]

938+:}

939+

940+>>> :{

941+let

942+ setup :: Definition (Public '[]) '["public" ::: '["complex" ::: 'Typedef PGcomplex]]

943+ setup = createTypeComposite #complex

944+ (float8 `as` #real :* float8 `as` #imaginary)

945+in printSQL setup

946+:}

947+CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

948+-}

949+createTypeComposite

950+ :: (KnownSymbol ty, Has sch schemas schema, SOP.SListI fields)

951+ => QualifiedAlias sch ty

952+ -- ^ name of the user defined composite type

953+ -> NP (Aliased (TypeExpression schemas)) fields

954+ -- ^ list of attribute names and data types

955+ -> Definition schemas (Alter sch (Create ty ('Typedef ('PGcomposite fields)) schema) schemas)

956+createTypeComposite ty fields = UnsafeDefinition $

957+ "CREATE" <+> "TYPE" <+> renderSQL ty <+> "AS" <+> parenthesized

958+ (renderCommaSeparated renderField fields) <> ";"

959+ where

960+ renderField :: Aliased (TypeExpression schemas) x -> ByteString

961+ renderField (typ `As` alias) =

962+ renderSQL alias <+> renderSQL typ

963+

964+-- | Composite types can also be generated from a Haskell type, for example

965+--

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

967+-- >>> instance SOP.Generic Complex

968+-- >>> instance SOP.HasDatatypeInfo Complex

969+-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]

970+-- >>> :{

971+-- let

972+-- createComplex :: Definition (Public '[]) (Public Schema)

973+-- createComplex = createTypeCompositeFrom @Complex #complex

974+-- in

975+-- printSQL createComplex

976+-- :}

977+-- CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

978+createTypeCompositeFrom

979+ :: forall hask sch ty schemas schema.

980+ ( SOP.All (FieldTyped schemas) (RowPG hask)

981+ , KnownSymbol ty

982+ , Has sch schemas schema )

983+ => QualifiedAlias sch ty

984+ -- ^ name of the user defined composite type

985+ -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)

986+createTypeCompositeFrom ty = createTypeComposite ty

987+ (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype

988+ :: NP (Aliased (TypeExpression schemas)) (RowPG hask))

989+

990+{-|

991+`createDomain` creates a new domain. A domain is essentially a data type

992+with constraints (restrictions on the allowed set of values).

993+

994+Domains are useful for abstracting common constraints on fields

995+into a single location for maintenance. For example, several tables might

996+contain email address columns, all requiring the same `check` constraint

997+to verify the address syntax. Define a domain rather than setting up

998+each table's constraint individually.

999+

1000+>>> :{

1001+let

1002+ createPositive :: Definition (Public '[]) (Public '["positive" ::: 'Typedef 'PGfloat4])

1003+ createPositive = createDomain #positive real (#value .> 0 .&& (#value & isNotNull))

1004+in printSQL createPositive

1005+:}

1006+CREATE DOMAIN "positive" AS real CHECK ((("value" > 0) AND "value" IS NOT NULL));

1007+-}

1008+createDomain

1009+ :: (Has sch schemas schema, KnownSymbol dom)

1010+ => QualifiedAlias sch dom

1011+ -> (forall nullity. TypeExpression schemas (nullity ty))

1012+ -> (forall tab. Condition '[] '[] 'Ungrouped schemas '[] '[tab ::: '["value" ::: 'Null ty]])

1013+ -> Definition schemas (Alter sch (Create alias ('Typedef ty) schema) schemas)

1014+createDomain dom ty condition =

1015+ UnsafeDefinition $ "CREATE DOMAIN" <+> renderSQL dom

1016+ <+> "AS" <+> renderTypeExpression ty

1017+ <+> "CHECK" <+> parenthesized (renderSQL condition) <> ";"

1018+

1019+class FieldTyped schemas ty where

1020+ fieldtype :: Aliased (TypeExpression schemas) ty

1021+instance (KnownSymbol alias, PGTyped schemas ty)

1022+ => FieldTyped schemas (alias ::: ty) where

1023+ fieldtype = pgtype `As` Alias

1024+

1025+-- | Drop a type.

1026+--

1027+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

1028+-- >>> instance SOP.Generic Schwarma

1029+-- >>> instance SOP.HasDatatypeInfo Schwarma

1030+-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))

1031+-- DROP TYPE "schwarma";

1032+dropType

1033+ :: (Has sch schemas schema, Has td schema ('Typedef ty))

1034+ => QualifiedAlias sch td

1035+ -- ^ name of the user defined type

1036+ -> Definition schemas (Alter sch (Drop td schema) schemas)

1037+dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

1038+

1039+-- | `ColumnTypeExpression`s are used in `createTable` commands.

1040+newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)

1041+ = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }

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

1043+instance RenderSQL (ColumnTypeExpression schemas ty) where

1044+ renderSQL = renderColumnTypeExpression

1045+

1046+-- | used in `createTable` commands as a column constraint to note that

1047+-- @NULL@ may be present in a column

1048+nullable

1049+ :: TypeExpression schemas (nullity ty)

1050+ -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)

1051+nullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NULL"

1052+

1053+-- | used in `createTable` commands as a column constraint to ensure

1054+-- @NULL@ is not present in a column

1055+notNullable

1056+ :: TypeExpression schemas (nullity ty)

1057+ -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)

1058+notNullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NOT NULL"

1059+

1060+-- | used in `createTable` commands as a column constraint to give a default

1061+default_

1062+ :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty

1063+ -> ColumnTypeExpression schemas ('NoDef :=> ty)

1064+ -> ColumnTypeExpression schemas ('Def :=> ty)

1065+default_ x ty = UnsafeColumnTypeExpression $

1066+ renderSQL ty <+> "DEFAULT" <+> renderExpression x

1067+

1068+-- | not a true type, but merely a notational convenience for creating

1069+-- unique identifier columns with type `PGint2`

1070+serial2, smallserial

1071+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)

1072+serial2 = UnsafeColumnTypeExpression "serial2"

1073+smallserial = UnsafeColumnTypeExpression "smallserial"

1074+-- | not a true type, but merely a notational convenience for creating

1075+-- unique identifier columns with type `PGint4`

1076+serial4, serial

1077+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)

1078+serial4 = UnsafeColumnTypeExpression "serial4"

1079+serial = UnsafeColumnTypeExpression "serial"

1080+-- | not a true type, but merely a notational convenience for creating

1081+-- unique identifier columns with type `PGint8`

1082+serial8, bigserial

1083+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)

1084+serial8 = UnsafeColumnTypeExpression "serial8"

1085+bigserial = UnsafeColumnTypeExpression "bigserial"

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+348−101

@@ -1,13 +1,14 @@

1{-|

2Module: Squeal.PostgreSQL.Expression

3Description: Squeal expressions

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

5Maintainer: eitan@morphism.tech

6Stability: experimental

8Squeal expressions are the atoms used to build statements.

9-}

11+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}

11{-# LANGUAGE

12{-# LANGUAGE

12 AllowAmbiguousTypes

13 AllowAmbiguousTypes

13 , ConstraintKinds

14 , ConstraintKinds

@@ -34,48 +35,94 @@ module Squeal.PostgreSQL.Expression

34 ( -- * Expression

35 ( -- * Expression

35 Expression (..)

36 Expression (..)

36 , Expr

37 , Expr

37− , type (-->)

38+ , (:-->)

38− , FunctionDB

39 , unsafeFunction

40− , function

40+ , unsafeUnaryOpL

41− , unsafeLeftOp

41+ , unsafeUnaryOpR

42− , leftOp

43− , unsafeRightOp

44− , rightOp

45 , Operator

42 , Operator

46− , OperatorDB

47 , unsafeBinaryOp

43 , unsafeBinaryOp

48− , binaryOp

49 , FunctionVar

44 , FunctionVar

50 , unsafeFunctionVar

45 , unsafeFunctionVar

51− , type (--->)

46+ , FunctionN

52− , FunctionNDB

53 , unsafeFunctionN

47 , unsafeFunctionN

54− , functionN

48+ , Literal (..)

49+ , HasParameter (parameter)

50+ , param

55 , PGSubset (..)

51 , PGSubset (..)

56− , PGIntersect (..)

52+ -- * Types

53+ , TypeExpression (..)

54+ , cast

55+ , PGTyped (..)

56+ , typedef

57+ , typetable

58+ , typeview

59+ , bool

60+ , int2

61+ , smallint

62+ , int4

63+ , int

64+ , integer

65+ , int8

66+ , bigint

67+ , numeric

68+ , float4

69+ , real

70+ , float8

71+ , doublePrecision

72+ , money

73+ , text

74+ , char

75+ , character

76+ , varchar

77+ , characterVarying

78+ , bytea

79+ , timestamp

80+ , timestampWithTimeZone

81+ , date

82+ , time

83+ , timeWithTimeZone

84+ , interval

85+ , uuid

86+ , inet

87+ , json

88+ , jsonb

89+ , vararray

90+ , fixarray

91+ , tsvector

92+ , tsquery

57 -- * Re-export

93 -- * Re-export

58 , (&)

94 , (&)

59 , K (..)

95 , K (..)

60− , unK

61 ) where

96 ) where

63import Control.Category

98import Control.Category

64import Control.DeepSeq

99import Control.DeepSeq

65import Data.ByteString (ByteString)

100import Data.ByteString (ByteString)

101+import Data.ByteString.Lazy (toStrict)

102+import ByteString.StrictBuilder (builderBytes)

66import Data.Function ((&))

103import Data.Function ((&))

67import Data.Semigroup hiding (All)

104import Data.Semigroup hiding (All)

105+import qualified Data.Aeson as JSON

106+import Data.Int

68import Data.String

107import Data.String

108+import Data.Text (Text)

69import Generics.SOP hiding (All, from)

109import Generics.SOP hiding (All, from)

70import GHC.OverloadedLabels

110import GHC.OverloadedLabels

71import GHC.TypeLits

111import GHC.TypeLits

72import Numeric

112import Numeric

73import Prelude hiding (id, (.))

113import Prelude hiding (id, (.))

114

115+import qualified Data.ByteString as ByteString

116+import qualified Data.Text as Text

117+import qualified Data.Text.Lazy as Lazy (Text)

118+import qualified Data.Text.Lazy as Lazy.Text

75import qualified GHC.Generics as GHC

119import qualified GHC.Generics as GHC

120+import qualified Generics.SOP as SOP

121

77import Squeal.PostgreSQL.Alias

122import Squeal.PostgreSQL.Alias

123+import Squeal.PostgreSQL.Binary

78import Squeal.PostgreSQL.List

124import Squeal.PostgreSQL.List

125+import Squeal.PostgreSQL.PG

79import Squeal.PostgreSQL.Render

126import Squeal.PostgreSQL.Render

80import Squeal.PostgreSQL.Schema

127import Squeal.PostgreSQL.Schema

128

@@ -91,7 +138,7 @@ such as in the target `Squeal.PostgreSQL.Query.List` of the

91`Squeal.PostgreSQL.Query.select` command,

138`Squeal.PostgreSQL.Query.select` command,

92as new column values in `Squeal.PostgreSQL.Manipulation.insertRow` or

139as new column values in `Squeal.PostgreSQL.Manipulation.insertRow` or

93`Squeal.PostgreSQL.Manipulation.update`,

140`Squeal.PostgreSQL.Manipulation.update`,

94−or in search `Squeal.PostgreSQL.Logic.Condition`s in a number of commands.

141+or in search `Condition`s in a number of commands.

142

96The expression syntax allows the calculation of

143The expression syntax allows the calculation of

97values from primitive expression using arithmetic, logical,

144values from primitive expression using arithmetic, logical,

@@ -125,7 +172,7 @@ instance RenderSQL (Expression outer commons grp schemas params from ty) where

125 renderSQL = renderExpression

172 renderSQL = renderExpression

126

173

127-- | An `Expr` is a closed `Expression`.

174-- | An `Expr` is a closed `Expression`.

128−-- It is a F@RankNType@ but don't be scared.

175+-- It is a F`RankNType` but don't be scared.

129-- Think of it as an expression which sees no

176-- Think of it as an expression which sees no

130-- namespaces, so you can't use parameters

177-- namespaces, so you can't use parameters

131-- or alias references. It can be used as

178-- or alias references. It can be used as

@@ -135,7 +182,7 @@ type Expr x

135 . Expression outer commons grp schemas params from x

182 . Expression outer commons grp schemas params from x

136 -- ^ cannot reference aliases

183 -- ^ cannot reference aliases

137

184

138−-- | A @RankNType@ for binary operators.

185+-- | A `RankNType` for binary operators.

139type Operator x1 x2 y

186type Operator x1 x2 y

140 = forall outer commons grp schemas params from

187 = forall outer commons grp schemas params from

141 . Expression outer commons grp schemas params from x1

188 . Expression outer commons grp schemas params from x1

@@ -145,55 +192,32 @@ type Operator x1 x2 y

145 -> Expression outer commons grp schemas params from y

192 -> Expression outer commons grp schemas params from y

146 -- ^ output

193 -- ^ output

147

194

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.

195+-- | A `RankNType` for functions with a single argument.

158-- These could be either function calls or unary operators.

196-- These could be either function calls or unary operators.

159-- This is a subtype of the usual Haskell function type `Prelude.->`,

197-- This is a subtype of the usual Haskell function type `Prelude.->`,

160-- indeed a subcategory as it is closed under the usual

198-- indeed a subcategory as it is closed under the usual

161-- `Prelude..` and `Prelude.id`.

199-- `Prelude..` and `Prelude.id`.

162−type (-->) x y

200+type (:-->) x y

163 = forall outer commons grp schemas params from

201 = forall outer commons grp schemas params from

164 . Expression outer commons grp schemas params from x

202 . Expression outer commons grp schemas params from x

165 -- ^ input

203 -- ^ input

166 -> Expression outer commons grp schemas params from y

204 -> Expression outer commons grp schemas params from y

167 -- ^ output

205 -- ^ output

168

206

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.

207+{- | A `RankNType` for functions with a fixed-length list of heterogeneous arguments.

177Use the `*:` operator to end your argument lists, like so.

208Use the `*:` operator to end your argument lists, like so.

178

209

179>>> printSQL (unsafeFunctionN "fun" (true :* false :* localTime *: true))

210>>> printSQL (unsafeFunctionN "fun" (true :* false :* localTime *: true))

180fun(TRUE, FALSE, LOCALTIME, TRUE)

211fun(TRUE, FALSE, LOCALTIME, TRUE)

181-}

212-}

182−type (--->) xs y

213+type FunctionN xs y

183 = forall outer commons grp schemas params from

214 = forall outer commons grp schemas params from

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

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

185 -- ^ inputs

216 -- ^ inputs

186 -> Expression outer commons grp schemas params from y

217 -> Expression outer commons grp schemas params from y

187 -- ^ output

218 -- ^ output

188

219

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

220+{- | A `RankNType` for functions with a variable-length list of

197homogeneous arguments and at least 1 more argument.

221homogeneous arguments and at least 1 more argument.

198-}

222-}

199type FunctionVar x0 x1 y

223type FunctionVar x0 x1 y

@@ -212,6 +236,46 @@ unsafeFunctionVar :: ByteString -> FunctionVar x0 x1 y

212unsafeFunctionVar fun xs x = UnsafeExpression $ fun <> parenthesized

236unsafeFunctionVar fun xs x = UnsafeExpression $ fun <> parenthesized

213 (commaSeparated (renderSQL <$> xs) <> ", " <> renderSQL x)

237 (commaSeparated (renderSQL <$> xs) <> ", " <> renderSQL x)

214

238

239+{- | A `HasParameter` constraint is used to indicate a value that is

240+supplied externally to a SQL statement.

241+`Squeal.PostgreSQL.PQ.manipulateParams`,

242+`Squeal.PostgreSQL.PQ.queryParams` and

243+`Squeal.PostgreSQL.PQ.traversePrepared` support specifying data values

244+separately from the SQL command string, in which case `param`s are used to

245+refer to the out-of-line data values.

246+-}

247+class KnownNat n => HasParameter

248+ (n :: Nat)

249+ (params :: [NullityType])

250+ (ty :: NullityType)

251+ | n params -> ty where

252+ -- | `parameter` takes a `Nat` using type application and a `TypeExpression`.

253+ --

254+ -- >>> let expr = parameter @1 int4 :: Expression outer '[] grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)

255+ -- >>> printSQL expr

256+ -- ($1 :: int4)

257+ parameter

258+ :: TypeExpression schemas ty

259+ -> Expression outer commons grp schemas params from ty

260+ parameter ty = UnsafeExpression $ parenthesized $

261+ "$" <> renderNat @n <+> "::"

262+ <+> renderSQL ty

263+instance {-# OVERLAPPING #-} HasParameter 1 (ty1:tys) ty1

264+instance {-# OVERLAPPABLE #-} (KnownNat n, HasParameter (n-1) params ty)

265+ => HasParameter n (ty' : params) ty

266+

267+-- | `param` takes a `Nat` using type application and for basic types,

268+-- infers a `TypeExpression`.

269+--

270+-- >>> let expr = param @1 :: Expression outer commons grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)

271+-- >>> printSQL expr

272+-- ($1 :: int4)

273+param

274+ :: forall n outer commons schemas params from grp ty

275+ . (PGTyped schemas ty, HasParameter n params ty)

276+ => Expression outer commons grp schemas params from ty -- ^ param

277+param = parameter @n (pgtype @schemas)

278+

215instance (HasUnique tab (Join outer from) row, Has col row ty)

279instance (HasUnique tab (Join outer from) row, Has col row ty)

216 => IsLabel col (Expression outer commons 'Ungrouped schemas params from ty) where

280 => IsLabel col (Expression outer commons 'Ungrouped schemas params from ty) where

217 fromLabel = UnsafeExpression $ renderSQL (Alias @col)

281 fromLabel = UnsafeExpression $ renderSQL (Alias @col)

@@ -318,63 +382,28 @@ unsafeBinaryOp :: ByteString -> Operator ty0 ty1 ty2

318unsafeBinaryOp op x y = UnsafeExpression $ parenthesized $

382unsafeBinaryOp op x y = UnsafeExpression $ parenthesized $

319 renderSQL x <+> op <+> renderSQL y

383 renderSQL x <+> op <+> renderSQL y

320

384

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

385+-- | >>> printSQL $ unsafeUnaryOpL "NOT" true

329-- (NOT TRUE)

386-- (NOT TRUE)

330−unsafeLeftOp :: ByteString -> x --> y

387+unsafeUnaryOpL :: ByteString -> x :--> y

331−unsafeLeftOp op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x

388+unsafeUnaryOpL op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x

332

389

333−leftOp

334− :: forall op sch schemas schema x y.

335− ( Has sch schemas schema

336− , Has op schema ('Operator ('LeftOp x y)) )

337− => FunctionDB schemas x y

338−leftOp = unsafeLeftOp $ renderSymbol @op

339−

340−-- | >>> printSQL $ true & unsafeRightOp "IS NOT TRUE"

390+-- | >>> printSQL $ true & unsafeUnaryOpR "IS NOT TRUE"

341-- (TRUE IS NOT TRUE)

391-- (TRUE IS NOT TRUE)

342−unsafeRightOp :: ByteString -> x --> y

392+unsafeUnaryOpR :: ByteString -> x :--> y

343−unsafeRightOp op x = UnsafeExpression $ parenthesized $ renderSQL x <+> op

393+unsafeUnaryOpR 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

351

394

352-- | >>> printSQL $ unsafeFunction "f" true

395-- | >>> printSQL $ unsafeFunction "f" true

353-- f(TRUE)

396-- f(TRUE)

354−unsafeFunction :: ByteString -> x --> y

397+unsafeFunction :: ByteString -> x :--> y

355unsafeFunction fun x = UnsafeExpression $

398unsafeFunction fun x = UnsafeExpression $

356 fun <> parenthesized (renderSQL x)

399 fun <> parenthesized (renderSQL x)

357

400

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−

364-- | >>> printSQL $ unsafeFunctionN "f" (currentTime :* localTimestamp :* false *: literal 'a')

401-- | >>> printSQL $ unsafeFunctionN "f" (currentTime :* localTimestamp :* false *: literal 'a')

365-- f(CURRENT_TIME, LOCALTIMESTAMP, FALSE, E'a')

402-- f(CURRENT_TIME, LOCALTIMESTAMP, FALSE, E'a')

366−unsafeFunctionN :: SListI xs => ByteString -> xs ---> y

403+unsafeFunctionN :: SListI xs => ByteString -> FunctionN xs y

367unsafeFunctionN fun xs = UnsafeExpression $

404unsafeFunctionN fun xs = UnsafeExpression $

368 fun <> parenthesized (renderCommaSeparated renderSQL xs)

405 fun <> parenthesized (renderCommaSeparated renderSQL xs)

369

406

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−

378instance ty `In` PGNum

407instance ty `In` PGNum

379 => Num (Expression outer commons grp schemas params from (null ty)) where

408 => Num (Expression outer commons grp schemas params from (null ty)) where

380 (+) = unsafeBinaryOp "+"

409 (+) = unsafeBinaryOp "+"

@@ -419,22 +448,33 @@ instance (ty `In` PGNum, ty `In` PGFloating) => Floating

419 acosh x = log (x + sqrt (x*x - 1))

448 acosh x = log (x + sqrt (x*x - 1))

420 atanh x = log ((1 + x) / (1 - x)) / 2

449 atanh x = log ((1 + x) / (1 - x)) / 2

421

450

422−-- | Contained by operators

423−class PGSubset ty where

451+class PGSubset container where

424− (@>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

452+ (@>) :: Operator (null0 container) (null1 container) ('Null 'PGbool)

425 (@>) = unsafeBinaryOp "@>"

453 (@>) = unsafeBinaryOp "@>"

426− (<@) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

454+ (<@) :: Operator (null0 container) (null1 container) ('Null 'PGbool)

427 (<@) = unsafeBinaryOp "<@"

455 (<@) = unsafeBinaryOp "<@"

428instance PGSubset 'PGjsonb

456instance PGSubset 'PGjsonb

429instance PGSubset 'PGtsquery

457instance PGSubset 'PGtsquery

430instance PGSubset ('PGvararray ty)

458instance PGSubset ('PGvararray ty)

431−instance PGSubset ('PGrange ty)

432

459

433−class PGIntersect ty where

460+-- When a `cast` is applied to an `Expression` of a known type, it

434− (@&&) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

461+-- represents a run-time type conversion. The cast will succeed only if a

435− (@&&) = unsafeBinaryOp "&&"

462+-- suitable type conversion operation has been defined.

436−instance PGIntersect ('PGvararray ty)

463+--

437−instance PGIntersect ('PGrange ty)

464+-- | >>> printSQL $ true & cast int4

465+-- (TRUE :: int4)

466+cast

467+ :: TypeExpression schemas ty1

468+ -- ^ type to cast as

469+ -> Expression outer commons grp schemas params from ty0

470+ -- ^ value to convert

471+ -> Expression outer commons grp schemas params from ty1

472+cast ty x = UnsafeExpression $ parenthesized $

473+ renderSQL x <+> "::" <+> renderSQL ty

474+

475+{-----------------------------------------

476+text

477+-----------------------------------------}

438

478

439instance IsString

479instance IsString

440 (Expression outer commons grp schemas params from (null 'PGtext)) where

480 (Expression outer commons grp schemas params from (null 'PGtext)) where

@@ -442,11 +482,11 @@ instance IsString

442 "E\'" <> fromString (escape =<< str) <> "\'"

482 "E\'" <> fromString (escape =<< str) <> "\'"

443instance IsString

483instance IsString

444 (Expression outer commons grp schemas params from (null 'PGtsvector)) where

484 (Expression outer commons grp schemas params from (null 'PGtsvector)) where

445− fromString str = UnsafeExpression . parenthesized . (<> " :: tsvector") $

485+ fromString str = cast tsvector . UnsafeExpression $

446 "E\'" <> fromString (escape =<< str) <> "\'"

486 "E\'" <> fromString (escape =<< str) <> "\'"

447instance IsString

487instance IsString

448 (Expression outer commons grp schemas params from (null 'PGtsquery)) where

488 (Expression outer commons grp schemas params from (null 'PGtsquery)) where

449− fromString str = UnsafeExpression . parenthesized . (<> " :: tsquery") $

489+ fromString str = cast tsquery . UnsafeExpression $

450 "E\'" <> fromString (escape =<< str) <> "\'"

490 "E\'" <> fromString (escape =<< str) <> "\'"

451

491

452instance Semigroup

492instance Semigroup

@@ -470,3 +510,210 @@ instance Monoid

470 (Expression outer commons grp schemas params from (null 'PGtsvector)) where

510 (Expression outer commons grp schemas params from (null 'PGtsvector)) where

471 mempty = fromString ""

511 mempty = fromString ""

472 mappend = (<>)

512 mappend = (<>)

513+

514+{-----------------------------------------

515+type expressions

516+-----------------------------------------}

517+

518+-- | `TypeExpression`s are used in `cast`s and

519+-- `Squeal.PostgreSQL.Definition.createTable` commands.

520+newtype TypeExpression (schemas :: SchemasType) (ty :: NullityType)

521+ = UnsafeTypeExpression { renderTypeExpression :: ByteString }

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

523+instance RenderSQL (TypeExpression schemas ty) where

524+ renderSQL = renderTypeExpression

525+

526+-- | The enum or composite type in a `Typedef` can be expressed by its alias.

527+typedef

528+ :: (Has sch schemas schema, Has td schema ('Typedef ty))

529+ => QualifiedAlias sch td

530+ -> TypeExpression schemas (null ty)

531+typedef = UnsafeTypeExpression . renderSQL

532+

533+-- | The composite type corresponding to a `Table` definition can be expressed

534+-- by its alias.

535+typetable

536+ :: (Has sch schemas schema, Has tab schema ('Table table))

537+ => QualifiedAlias sch tab

538+ -> TypeExpression schemas (null ('PGcomposite (TableToRow table)))

539+typetable = UnsafeTypeExpression . renderSQL

540+

541+-- | The composite type corresponding to a `View` definition can be expressed

542+-- by its alias.

543+typeview

544+ :: (Has sch schemas schema, Has vw schema ('View view))

545+ => QualifiedAlias sch vw

546+ -> TypeExpression schemas (null ('PGcomposite view))

547+typeview = UnsafeTypeExpression . renderSQL

548+

549+-- | logical Boolean (true/false)

550+bool :: TypeExpression schemas (null 'PGbool)

551+bool = UnsafeTypeExpression "bool"

552+-- | signed two-byte integer

553+int2, smallint :: TypeExpression schemas (null 'PGint2)

554+int2 = UnsafeTypeExpression "int2"

555+smallint = UnsafeTypeExpression "smallint"

556+-- | signed four-byte integer

557+int4, int, integer :: TypeExpression schemas (null 'PGint4)

558+int4 = UnsafeTypeExpression "int4"

559+int = UnsafeTypeExpression "int"

560+integer = UnsafeTypeExpression "integer"

561+-- | signed eight-byte integer

562+int8, bigint :: TypeExpression schemas (null 'PGint8)

563+int8 = UnsafeTypeExpression "int8"

564+bigint = UnsafeTypeExpression "bigint"

565+-- | arbitrary precision numeric type

566+numeric :: TypeExpression schemas (null 'PGnumeric)

567+numeric = UnsafeTypeExpression "numeric"

568+-- | single precision floating-point number (4 bytes)

569+float4, real :: TypeExpression schemas (null 'PGfloat4)

570+float4 = UnsafeTypeExpression "float4"

571+real = UnsafeTypeExpression "real"

572+-- | double precision floating-point number (8 bytes)

573+float8, doublePrecision :: TypeExpression schemas (null 'PGfloat8)

574+float8 = UnsafeTypeExpression "float8"

575+doublePrecision = UnsafeTypeExpression "double precision"

576+-- | currency amount

577+money :: TypeExpression schema (null 'PGmoney)

578+money = UnsafeTypeExpression "money"

579+-- | variable-length character string

580+text :: TypeExpression schemas (null 'PGtext)

581+text = UnsafeTypeExpression "text"

582+-- | fixed-length character string

583+char, character

584+ :: forall n schemas null. (KnownNat n, 1 <= n)

585+ => TypeExpression schemas (null ('PGchar n))

586+char = UnsafeTypeExpression $ "char(" <> renderNat @n <> ")"

587+character = UnsafeTypeExpression $ "character(" <> renderNat @n <> ")"

588+-- | variable-length character string

589+varchar, characterVarying

590+ :: forall n schemas null. (KnownNat n, 1 <= n)

591+ => TypeExpression schemas (null ('PGvarchar n))

592+varchar = UnsafeTypeExpression $ "varchar(" <> renderNat @n <> ")"

593+characterVarying = UnsafeTypeExpression $

594+ "character varying(" <> renderNat @n <> ")"

595+-- | binary data ("byte array")

596+bytea :: TypeExpression schemas (null 'PGbytea)

597+bytea = UnsafeTypeExpression "bytea"

598+-- | date and time (no time zone)

599+timestamp :: TypeExpression schemas (null 'PGtimestamp)

600+timestamp = UnsafeTypeExpression "timestamp"

601+-- | date and time, including time zone

602+timestampWithTimeZone :: TypeExpression schemas (null 'PGtimestamptz)

603+timestampWithTimeZone = UnsafeTypeExpression "timestamp with time zone"

604+-- | calendar date (year, month, day)

605+date :: TypeExpression schemas (null 'PGdate)

606+date = UnsafeTypeExpression "date"

607+-- | time of day (no time zone)

608+time :: TypeExpression schemas (null 'PGtime)

609+time = UnsafeTypeExpression "time"

610+-- | time of day, including time zone

611+timeWithTimeZone :: TypeExpression schemas (null 'PGtimetz)

612+timeWithTimeZone = UnsafeTypeExpression "time with time zone"

613+-- | time span

614+interval :: TypeExpression schemas (null 'PGinterval)

615+interval = UnsafeTypeExpression "interval"

616+-- | universally unique identifier

617+uuid :: TypeExpression schemas (null 'PGuuid)

618+uuid = UnsafeTypeExpression "uuid"

619+-- | IPv4 or IPv6 host address

620+inet :: TypeExpression schemas (null 'PGinet)

621+inet = UnsafeTypeExpression "inet"

622+-- | textual JSON data

623+json :: TypeExpression schemas (null 'PGjson)

624+json = UnsafeTypeExpression "json"

625+-- | binary JSON data, decomposed

626+jsonb :: TypeExpression schemas (null 'PGjsonb)

627+jsonb = UnsafeTypeExpression "jsonb"

628+-- | variable length array

629+vararray

630+ :: TypeExpression schemas pg

631+ -> TypeExpression schemas (null ('PGvararray pg))

632+vararray ty = UnsafeTypeExpression $ renderSQL ty <> "[]"

633+-- | fixed length array

634+--

635+-- >>> renderSQL (fixarray @'[2] json)

636+-- "json[2]"

637+fixarray

638+ :: forall dims schemas null pg. SOP.All KnownNat dims

639+ => TypeExpression schemas pg

640+ -> TypeExpression schemas (null ('PGfixarray dims pg))

641+fixarray ty = UnsafeTypeExpression $

642+ renderSQL ty <> renderDims @dims

643+ where

644+ renderDims :: forall ns. SOP.All KnownNat ns => ByteString

645+ renderDims =

646+ ("[" <>)

647+ . (<> "]")

648+ . ByteString.intercalate "]["

649+ . hcollapse

650+ $ hcmap (SOP.Proxy @KnownNat)

651+ (K . fromString . show . natVal)

652+ (hpure SOP.Proxy :: NP SOP.Proxy ns)

653+tsvector :: TypeExpression schemas (null 'PGtsvector)

654+tsvector = UnsafeTypeExpression "tsvector"

655+tsquery :: TypeExpression schemas (null 'PGtsquery)

656+tsquery = UnsafeTypeExpression "tsquery"

657+

658+-- | `pgtype` is a demoted version of a `PGType`

659+class PGTyped schemas (ty :: NullityType) where

660+ pgtype :: TypeExpression schemas ty

661+instance PGTyped schemas (null 'PGbool) where pgtype = bool

662+instance PGTyped schemas (null 'PGint2) where pgtype = int2

663+instance PGTyped schemas (null 'PGint4) where pgtype = int4

664+instance PGTyped schemas (null 'PGint8) where pgtype = int8

665+instance PGTyped schemas (null 'PGnumeric) where pgtype = numeric

666+instance PGTyped schemas (null 'PGfloat4) where pgtype = float4

667+instance PGTyped schemas (null 'PGfloat8) where pgtype = float8

668+instance PGTyped schemas (null 'PGmoney) where pgtype = money

669+instance PGTyped schemas (null 'PGtext) where pgtype = text

670+instance (KnownNat n, 1 <= n)

671+ => PGTyped schemas (null ('PGchar n)) where pgtype = char @n

672+instance (KnownNat n, 1 <= n)

673+ => PGTyped schemas (null ('PGvarchar n)) where pgtype = varchar @n

674+instance PGTyped schemas (null 'PGbytea) where pgtype = bytea

675+instance PGTyped schemas (null 'PGtimestamp) where pgtype = timestamp

676+instance PGTyped schemas (null 'PGtimestamptz) where pgtype = timestampWithTimeZone

677+instance PGTyped schemas (null 'PGdate) where pgtype = date

678+instance PGTyped schemas (null 'PGtime) where pgtype = time

679+instance PGTyped schemas (null 'PGtimetz) where pgtype = timeWithTimeZone

680+instance PGTyped schemas (null 'PGinterval) where pgtype = interval

681+instance PGTyped schemas (null 'PGuuid) where pgtype = uuid

682+instance PGTyped schemas (null 'PGjson) where pgtype = json

683+instance PGTyped schemas (null 'PGjsonb) where pgtype = jsonb

684+instance PGTyped schemas ty

685+ => PGTyped schemas (null ('PGvararray ty)) where

686+ pgtype = vararray (pgtype @schemas @ty)

687+instance (SOP.All KnownNat dims, PGTyped schemas ty)

688+ => PGTyped schemas (null ('PGfixarray dims ty)) where

689+ pgtype = fixarray @dims (pgtype @schemas @ty)

690+instance PGTyped schemas (null 'PGtsvector) where pgtype = tsvector

691+instance PGTyped schemas (null 'PGtsquery) where pgtype = tsquery

692+

693+class Literal hask where

694+ literal :: hask -> Expr (null (PG hask))

695+instance JSON.ToJSON hask => Literal (Json hask) where

696+ literal = cast json . UnsafeExpression

697+ . singleQuotedUtf8 . toStrict . JSON.encode . getJson

698+instance JSON.ToJSON hask => Literal (Jsonb hask) where

699+ literal = cast jsonb . UnsafeExpression

700+ . singleQuotedUtf8 . toStrict . JSON.encode . getJsonb

701+instance Literal Char where

702+ literal chr = UnsafeExpression $

703+ "E\'" <> fromString (escape chr) <> "\'"

704+instance Literal String where literal = fromString

705+instance Literal Int16 where literal = fromIntegral

706+instance Literal Int32 where literal = fromIntegral

707+instance Literal Int64 where literal = fromIntegral

708+instance Literal Float where literal = fromRational . toRational

709+instance Literal Double where literal = fromRational . toRational

710+instance Literal Text where literal = fromString . Text.unpack

711+instance Literal Lazy.Text where literal = fromString . Lazy.Text.unpack

712+instance ToParam (Enumerated enum) (PG (Enumerated enum))

713+ => Literal (Enumerated enum) where

714+ literal

715+ = UnsafeExpression

716+ . singleQuotedUtf8

717+ . builderBytes

718+ . unK

719+ . toParam @(Enumerated enum) @(PG (Enumerated enum))

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Aggregate.hs+5−37

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

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , DeriveGeneric

3 , DeriveGeneric

@@ -26,7 +16,6 @@ Aggregate functions

26module Squeal.PostgreSQL.Expression.Aggregate

16module Squeal.PostgreSQL.Expression.Aggregate

27 ( Aggregate (..)

17 ( Aggregate (..)

28 , Distinction (..)

18 , Distinction (..)

29− , PGSum

30 , PGAvg

19 , PGAvg

31 ) where

20 ) where

@@ -50,7 +39,7 @@ import Squeal.PostgreSQL.Schema

50{- |

39{- |

51`Aggregate` functions compute a single result from a set of input values.

40`Aggregate` functions compute a single result from a set of input values.

52`Aggregate` functions can be used as `GroupedBy` `Expression`s as well

41`Aggregate` functions can be used as `GroupedBy` `Expression`s as well

53−as `Squeal.PostgreSQL.Expression.Window.WindowFunction`s.

42+as `WindowFunction`s.

54-}

43-}

55class Aggregate expr1 exprN aggr

44class Aggregate expr1 exprN aggr

56 | aggr -> expr1, aggr -> exprN where

45 | aggr -> expr1, aggr -> exprN where

@@ -80,14 +69,15 @@ class Aggregate expr1 exprN aggr

81 -- | >>> :{

70 -- | >>> :{

82 -- let

71 -- 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)

84 -- expression = sum_ (Distinct #col)

73 -- expression = sum_ (Distinct #col)

85 -- in printSQL expression

74 -- in printSQL expression

86 -- :}

75 -- :}

87 -- sum(DISTINCT "col")

76 -- sum(DISTINCT "col")

88 sum_

77 sum_

78+ :: ty `In` PGNum

89− :: expr1 (null ty)

79+ => expr1 (null ty)

90− -> aggr ('Null (PGSum ty))

80+ -> aggr ('NotNull ty)

92 -- | input values, including nulls, concatenated into an array

82 -- | input values, including nulls, concatenated into an array

93 arrayAgg

83 arrayAgg

@@ -106,7 +96,6 @@ class Aggregate expr1 exprN aggr

106

107 {- |

97 {- |

108 the bitwise AND of all non-null input values, or null if none

98 the bitwise AND of all non-null input values, or null if none

109−

110 >>> :{

99 >>> :{

111 let

100 let

112 expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

101 expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

@@ -205,7 +194,6 @@ class Aggregate expr1 exprN aggr

205 -> aggr ('Null (PGAvg ty))

194 -> aggr ('Null (PGAvg ty))

206

195

207 {- | correlation coefficient

196 {- | correlation coefficient

208−

209 >>> :{

197 >>> :{

210 let

198 let

211 expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

199 expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

@@ -219,7 +207,6 @@ class Aggregate expr1 exprN aggr

219 -> aggr ('Null 'PGfloat8)

207 -> aggr ('Null 'PGfloat8)

220

208

221 {- | population covariance

209 {- | population covariance

222−

223 >>> :{

210 >>> :{

224 let

211 let

225 expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

212 expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

@@ -233,7 +220,6 @@ class Aggregate expr1 exprN aggr

233 -> aggr ('Null 'PGfloat8)

220 -> aggr ('Null 'PGfloat8)

234

221

235 {- | sample covariance

222 {- | sample covariance

236−

237 >>> :{

223 >>> :{

238 let

224 let

239 winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

225 winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

@@ -247,7 +233,6 @@ class Aggregate expr1 exprN aggr

247 -> aggr ('Null 'PGfloat8)

233 -> aggr ('Null 'PGfloat8)

248

234

249 {- | average of the independent variable (sum(X)/N)

235 {- | average of the independent variable (sum(X)/N)

250−

251 >>> :{

236 >>> :{

252 let

237 let

253 expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

238 expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

@@ -261,7 +246,6 @@ class Aggregate expr1 exprN aggr

261 -> aggr ('Null 'PGfloat8)

246 -> aggr ('Null 'PGfloat8)

262

247

263 {- | average of the dependent variable (sum(Y)/N)

248 {- | average of the dependent variable (sum(Y)/N)

264−

265 >>> :{

249 >>> :{

266 let

250 let

267 winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

251 winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

@@ -275,7 +259,6 @@ class Aggregate expr1 exprN aggr

275 -> aggr ('Null 'PGfloat8)

259 -> aggr ('Null 'PGfloat8)

276

260

277 {- | number of input rows in which both expressions are nonnull

261 {- | number of input rows in which both expressions are nonnull

278−

279 >>> :{

262 >>> :{

280 let

263 let

281 winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGint8)

264 winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGint8)

@@ -434,21 +417,6 @@ unsafeAggregateN

434 -> Expression outer commons ('Grouped bys) schemas params from y

417 -> Expression outer commons ('Grouped bys) schemas params from y

435unsafeAggregateN fun xs = UnsafeExpression $ fun <> parenthesized (renderSQL xs)

418unsafeAggregateN fun xs = UnsafeExpression $ fun <> parenthesized (renderSQL xs)

436

419

437−-- | A type family that calculates `PGSum``PGType` of

438−-- a given argument `PGType`.

439−type family PGSum ty where

440− PGSum 'PGint2 = 'PGint8

441− PGSum 'PGint4 = 'PGint8

442− PGSum 'PGint8 = 'PGnumeric

443− PGSum 'PGfloat4 = 'PGfloat4

444− PGSum 'PGfloat8 = 'PGfloat8

445− PGSum 'PGnumeric = 'PGnumeric

446− PGSum 'PGinterval = 'PGinterval

447− PGSum 'PGmoney = 'PGmoney

448− PGSum pg = TypeError

449− ( 'Text "Squeal type error: Cannot sum with argument type "

450− ':<>: 'ShowType pg )

451−

452-- | A type family that calculates `PGAvg` type of a `PGType`.

420-- | A type family that calculates `PGAvg` type of a `PGType`.

453type family PGAvg ty where

421type family PGAvg ty where

454 PGAvg 'PGint2 = 'PGnumeric

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

11{-# LANGUAGE

1{-# LANGUAGE

12 AllowAmbiguousTypes

2 AllowAmbiguousTypes

13 , DataKinds

3 , DataKinds

14 , FlexibleContexts

4 , FlexibleContexts

15 , FlexibleInstances

5 , FlexibleInstances

16 , MultiParamTypeClasses

6 , MultiParamTypeClasses

17− , OverloadedLabels

18 , OverloadedStrings

7 , OverloadedStrings

19 , RankNTypes

8 , RankNTypes

20 , ScopedTypeVariables

9 , ScopedTypeVariables

@@ -30,7 +19,6 @@ module Squeal.PostgreSQL.Expression.Collection

30 , array2

19 , array2

31 , cardinality

20 , cardinality

32 , index

21 , index

33− , unnest

34 , row

22 , row

35 , field

23 , field

36 ) where

24 ) where

@@ -42,7 +30,6 @@ import qualified Generics.SOP as SOP

43import Squeal.PostgreSQL.Alias

31import Squeal.PostgreSQL.Alias

44import Squeal.PostgreSQL.Expression

32import Squeal.PostgreSQL.Expression

45−import Squeal.PostgreSQL.Expression.Set

46import Squeal.PostgreSQL.List

33import Squeal.PostgreSQL.List

47import Squeal.PostgreSQL.Render

34import Squeal.PostgreSQL.Render

48import Squeal.PostgreSQL.Schema

35import Squeal.PostgreSQL.Schema

@@ -111,21 +98,17 @@ array2 xss = UnsafeExpression $ "ARRAY" <>

111

112-- | >>> printSQL $ cardinality (array [null_, false, true])

99-- | >>> printSQL $ cardinality (array [null_, false, true])

113-- cardinality(ARRAY[NULL, FALSE, TRUE])

100-- cardinality(ARRAY[NULL, FALSE, TRUE])

114−cardinality :: null ('PGvararray ty) --> null 'PGint8

101+cardinality :: null ('PGvararray ty) :--> null 'PGint8

115cardinality = unsafeFunction "cardinality"

102cardinality = unsafeFunction "cardinality"

116

103

117-- | >>> printSQL $ array [null_, false, true] & index 2

104-- | >>> printSQL $ array [null_, false, true] & index 2

118-- (ARRAY[NULL, FALSE, TRUE])[2]

105-- (ARRAY[NULL, FALSE, TRUE])[2]

119index

106index

120 :: Word64 -- ^ index

107 :: Word64 -- ^ index

121− -> null ('PGvararray ty) --> NullifyType ty

108+ -> null ('PGvararray ty) :--> NullifyType ty

122index n expr = UnsafeExpression $

109index n expr = UnsafeExpression $

123 parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"

110 parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"

124

111

125−-- | Expand an array to a set of rows

126−unnest :: SetFunction "unnest" (null ('PGvararray ty)) '["unnest" ::: ty]

127−unnest = unsafeSetFunction

128−

129-- | A row constructor is an expression that builds a row value

112-- | A row constructor is an expression that builds a row value

130-- (also called a composite value) using values for its member fields.

113-- (also called a composite value) using values for its member fields.

131--

114--

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Comparison.hs+40−48

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

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−

11{-# LANGUAGE

1{-# LANGUAGE

12 OverloadedStrings

2 OverloadedStrings

13− , RankNTypes

14 , TypeInType

3 , TypeInType

15 , TypeOperators

4 , TypeOperators

16#-}

5#-}

@@ -24,7 +13,6 @@ module Squeal.PostgreSQL.Expression.Comparison

24 , (.>)

13 , (.>)

25 , greatest

14 , greatest

26 , least

15 , least

27− , BetweenExpr

28 , between

16 , between

29 , notBetween

17 , notBetween

30 , betweenSymmetric

18 , betweenSymmetric

@@ -39,8 +27,6 @@ module Squeal.PostgreSQL.Expression.Comparison

39 , isNotUnknown

27 , isNotUnknown

40 ) where

28 ) where

42−import Data.ByteString

43−

44import Squeal.PostgreSQL.Expression

30import Squeal.PostgreSQL.Expression

45import Squeal.PostgreSQL.Expression.Logic

31import Squeal.PostgreSQL.Expression.Logic

46import Squeal.PostgreSQL.Render

32import Squeal.PostgreSQL.Render

@@ -99,47 +85,53 @@ greatest = unsafeFunctionVar "GREATEST"

99least :: FunctionVar ty ty ty

85least :: FunctionVar ty ty ty

100least = unsafeFunctionVar "LEAST"

86least = unsafeFunctionVar "LEAST"

101

102−{- |

103−A @RankNType@ for comparison expressions like `between`.

104−-}

105−type BetweenExpr

106− = forall outer commons grp schemas params from ty

107− . Expression outer commons grp schemas params from ty

108− -> ( Expression outer commons grp schemas params from ty

109− , Expression outer commons grp schemas params from ty ) -- ^ bounds

110− -> Condition outer commons grp schemas params from

111−

112−unsafeBetweenExpr :: ByteString -> BetweenExpr

113−unsafeBetweenExpr fun a (x,y) = UnsafeExpression $

114− renderSQL a <+> fun <+> renderSQL x <+> "AND" <+> renderSQL y

115−

116{- | >>> printSQL $ true `between` (null_, false)

88{- | >>> printSQL $ true `between` (null_, false)

117TRUE BETWEEN NULL AND FALSE

89TRUE BETWEEN NULL AND FALSE

118-}

90-}

119−between :: BetweenExpr

91+between

120−between = unsafeBetweenExpr "BETWEEN"

92+ :: Expression outer commons grp schemas params from (null ty)

93+ -> ( Expression outer commons grp schemas params from (null ty)

94+ , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds

95+ -> Condition outer commons grp schemas params from

96+between a (x,y) = UnsafeExpression $ renderSQL a <+> "BETWEEN"

97+ <+> renderSQL x <+> "AND" <+> renderSQL y

121

122{- | >>> printSQL $ true `notBetween` (null_, false)

99{- | >>> printSQL $ true `notBetween` (null_, false)

123TRUE NOT BETWEEN NULL AND FALSE

100TRUE NOT BETWEEN NULL AND FALSE

124-}

101-}

125−notBetween :: BetweenExpr

102+notBetween

103+ :: Expression outer commons grp schemas params from (null ty)

104+ -> ( Expression outer commons grp schemas params from (null ty)

105+ , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds

106+ -> Condition outer commons grp schemas params from

126−notBetween = unsafeBetweenExpr "NOT BETWEEN"

107+notBetween a (x,y) = UnsafeExpression $ renderSQL a <+> "NOT BETWEEN"

108+ <+> renderSQL x <+> "AND" <+> renderSQL y

127

109

128{- | between, after sorting the comparison values

110{- | between, after sorting the comparison values

129

111

130>>> printSQL $ true `betweenSymmetric` (null_, false)

112>>> printSQL $ true `betweenSymmetric` (null_, false)

131TRUE BETWEEN SYMMETRIC NULL AND FALSE

113TRUE BETWEEN SYMMETRIC NULL AND FALSE

132-}

114-}

133−betweenSymmetric :: BetweenExpr

115+betweenSymmetric

134−betweenSymmetric = unsafeBetweenExpr "BETWEEN SYMMETRIC"

116+ :: Expression outer commons grp schemas params from (null ty)

117+ -> ( Expression outer commons grp schemas params from (null ty)

118+ , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds

119+ -> Condition outer commons grp schemas params from

120+betweenSymmetric a (x,y) = UnsafeExpression $ renderSQL a

121+ <+> "BETWEEN SYMMETRIC" <+> renderSQL x <+> "AND" <+> renderSQL y

135

122

136{- | not between, after sorting the comparison values

123{- | not between, after sorting the comparison values

137

124

138>>> printSQL $ true `notBetweenSymmetric` (null_, false)

125>>> printSQL $ true `notBetweenSymmetric` (null_, false)

139TRUE NOT BETWEEN SYMMETRIC NULL AND FALSE

126TRUE NOT BETWEEN SYMMETRIC NULL AND FALSE

140-}

127-}

141−notBetweenSymmetric :: BetweenExpr

128+notBetweenSymmetric

142−notBetweenSymmetric = unsafeBetweenExpr "NOT BETWEEN SYMMETRIC"

129+ :: Expression outer commons grp schemas params from (null ty)

130+ -> ( Expression outer commons grp schemas params from (null ty)

131+ , Expression outer commons grp schemas params from (null ty) ) -- ^ bounds

132+ -> Condition outer commons grp schemas params from

133+notBetweenSymmetric a (x,y) = UnsafeExpression $ renderSQL a

134+ <+> "NOT BETWEEN SYMMETRIC" <+> renderSQL x <+> "AND" <+> renderSQL y

143

135

144{- | not equal, treating null like an ordinary value

136{- | not equal, treating null like an ordinary value

145

137

@@ -162,45 +154,45 @@ isNotDistinctFrom = unsafeBinaryOp "IS NOT DISTINCT FROM"

162>>> printSQL $ true & isTrue

154>>> printSQL $ true & isTrue

163(TRUE IS TRUE)

155(TRUE IS TRUE)

164-}

156-}

165−isTrue :: null0 'PGbool --> null1 'PGbool

157+isTrue :: null0 'PGbool :--> null1 'PGbool

166−isTrue = unsafeRightOp "IS TRUE"

158+isTrue = unsafeUnaryOpR "IS TRUE"

167

159

168{- | is false or unknown

160{- | is false or unknown

169

161

170>>> printSQL $ true & isNotTrue

162>>> printSQL $ true & isNotTrue

171(TRUE IS NOT TRUE)

163(TRUE IS NOT TRUE)

172-}

164-}

173−isNotTrue :: null0 'PGbool --> null1 'PGbool

165+isNotTrue :: null0 'PGbool :--> null1 'PGbool

174−isNotTrue = unsafeRightOp "IS NOT TRUE"

166+isNotTrue = unsafeUnaryOpR "IS NOT TRUE"

175

167

176{- | is false

168{- | is false

177

169

178>>> printSQL $ true & isFalse

170>>> printSQL $ true & isFalse

179(TRUE IS FALSE)

171(TRUE IS FALSE)

180-}

172-}

181−isFalse :: null0 'PGbool --> null1 'PGbool

173+isFalse :: null0 'PGbool :--> null1 'PGbool

182−isFalse = unsafeRightOp "IS FALSE"

174+isFalse = unsafeUnaryOpR "IS FALSE"

183

175

184{- | is true or unknown

176{- | is true or unknown

185

177

186>>> printSQL $ true & isNotFalse

178>>> printSQL $ true & isNotFalse

187(TRUE IS NOT FALSE)

179(TRUE IS NOT FALSE)

188-}

180-}

189−isNotFalse :: null0 'PGbool --> null1 'PGbool

181+isNotFalse :: null0 'PGbool :--> null1 'PGbool

190−isNotFalse = unsafeRightOp "IS NOT FALSE"

182+isNotFalse = unsafeUnaryOpR "IS NOT FALSE"

191

183

192{- | is unknown

184{- | is unknown

193

185

194>>> printSQL $ true & isUnknown

186>>> printSQL $ true & isUnknown

195(TRUE IS UNKNOWN)

187(TRUE IS UNKNOWN)

196-}

188-}

197−isUnknown :: null0 'PGbool --> null1 'PGbool

189+isUnknown :: null0 'PGbool :--> null1 'PGbool

198−isUnknown = unsafeRightOp "IS UNKNOWN"

190+isUnknown = unsafeUnaryOpR "IS UNKNOWN"

199

191

200{- | is true or false

192{- | is true or false

201

193

202>>> printSQL $ true & isNotUnknown

194>>> printSQL $ true & isNotUnknown

203(TRUE IS NOT UNKNOWN)

195(TRUE IS NOT UNKNOWN)

204-}

196-}

205−isNotUnknown :: null0 'PGbool --> null1 'PGbool

197+isNotUnknown :: null0 'PGbool :--> null1 'PGbool

206−isNotUnknown = unsafeRightOp "IS NOT UNKNOWN"

198+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−

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , FlexibleContexts

3 , FlexibleContexts

14 , FlexibleInstances

4 , FlexibleInstances

15− , GADTs

16− , OverloadedLabels

17 , OverloadedStrings

5 , OverloadedStrings

18 , PolyKinds

6 , PolyKinds

19− , RankNTypes

20− , ScopedTypeVariables

21− , TypeApplications

22 , TypeOperators

7 , TypeOperators

23 , UndecidableInstances

8 , UndecidableInstances

24− , UndecidableSuperClasses

25#-}

9#-}

27module Squeal.PostgreSQL.Expression.Json

11module Squeal.PostgreSQL.Expression.Json

@@ -43,13 +27,19 @@ module Squeal.PostgreSQL.Expression.Json

43 , rowToJson

27 , rowToJson

44 , jsonBuildArray

28 , jsonBuildArray

45 , jsonbBuildArray

29 , jsonbBuildArray

46− , JsonBuildObject (..)

30+ , PGBuildObject

31+ , jsonBuildObject

32+ , jsonbBuildObject

47 , jsonObject

33 , jsonObject

48 , jsonbObject

34 , jsonbObject

49 , jsonZipObject

35 , jsonZipObject

50 , jsonbZipObject

36 , jsonbZipObject

51 , jsonArrayLength

37 , jsonArrayLength

52 , jsonbArrayLength

38 , jsonbArrayLength

39+ , jsonExtractPath

40+ , jsonbExtractPath

41+ , jsonExtractPathAsText

42+ , jsonbExtractPathAsText

53 , jsonTypeof

43 , jsonTypeof

54 , jsonbTypeof

44 , jsonbTypeof

55 , jsonStripNulls

45 , jsonStripNulls

@@ -57,43 +47,14 @@ module Squeal.PostgreSQL.Expression.Json

57 , jsonbSet

47 , jsonbSet

58 , jsonbInsert

48 , jsonbInsert

59 , jsonbPretty

49 , jsonbPretty

60− -- * Json and Jsonb set returning functions

61− , jsonEach

62− , jsonbEach

63− , jsonEachText

64− , jsonbEachText

65− , jsonObjectKeys

66− , jsonbObjectKeys

67− , JsonPopulateFunction

68− , jsonPopulateRecord

69− , jsonbPopulateRecord

70− , jsonPopulateRecordSet

71− , jsonbPopulateRecordSet

72− , JsonToRecordFunction

73− , jsonToRecord

74− , jsonbToRecord

75− , jsonToRecordSet

76− , jsonbToRecordSet

77 ) where

50 ) where

79−import Data.ByteString (ByteString)

80−import GHC.TypeLits

81−

82−import Squeal.PostgreSQL.Alias

83import Squeal.PostgreSQL.Expression

52import Squeal.PostgreSQL.Expression

84−import Squeal.PostgreSQL.Expression.Set

85−import Squeal.PostgreSQL.Expression.Type

86import Squeal.PostgreSQL.List

53import Squeal.PostgreSQL.List

87−import Squeal.PostgreSQL.Query

88−import Squeal.PostgreSQL.Render

89import Squeal.PostgreSQL.Schema

54import Squeal.PostgreSQL.Schema

91import qualified Generics.SOP as SOP

56import qualified Generics.SOP as SOP

93−-- $setup

94−-- >>> import Squeal.PostgreSQL

95−-- >>> import Data.Aeson

96−

97{-----------------------------------------

58{-----------------------------------------

98 -- json and jsonb support

59 -- json and jsonb support

@@ -156,18 +117,18 @@ infixl 9 .?&

156

117

157-- | Delete a key or keys from a JSON object, or remove an array element.

118-- | Delete a key or keys from a JSON object, or remove an array element.

158--

119--

159−-- If the right operand is

120+-- If the right operand is..

160--

121--

161−-- @ text @: Delete key / value pair or string element from left operand.

122+-- @ text @: Delete key/value pair or string element from left operand. Key/value pairs

162−-- Key / value pairs are matched based on their key value,

123+-- are matched based on their key value.

163--

124--

164−-- @ text[] @: Delete multiple key / value pairs or string elements

125+-- @ text[] @: Delete multiple key/value pairs or string elements

165−-- from left operand. Key / value pairs are matched based on their key value,

126+-- from left operand. Key/value pairs are matched based on their key value.

166--

127--

167-- @ integer @: Delete the array element with specified index (Negative integers

128-- @ integer @: Delete the array element with specified index (Negative integers

168-- count from the end). Throws an error if top level container is not an array.

129-- count from the end). Throws an error if top level container is not an array.

169(.-.)

130(.-.)

170− :: key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]

131+ :: (key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]) -- hlint error without parens here

171 => Operator (null 'PGjsonb) (null key) (null 'PGjsonb)

132 => Operator (null 'PGjsonb) (null key) (null 'PGjsonb)

172infixl 6 .-.

133infixl 6 .-.

173(.-.) = unsafeBinaryOp "-"

134(.-.) = unsafeBinaryOp "-"

@@ -188,7 +149,7 @@ Table 9.45: JSON creation functions

188-- otherwise, a scalar value is produced. For any scalar type other than a

149-- otherwise, a scalar value is produced. For any scalar type other than a

189-- number, a Boolean, or a null value, the text representation will be used, in

150-- number, a Boolean, or a null value, the text representation will be used, in

190-- such a fashion that it is a valid json value.

151-- such a fashion that it is a valid json value.

191−toJson :: null ty --> null 'PGjson

152+toJson :: null ty :--> null 'PGjson

192toJson = unsafeFunction "to_json"

153toJson = unsafeFunction "to_json"

193

154

194-- | Returns the value as jsonb. Arrays and composites are converted

155-- | Returns the value as jsonb. Arrays and composites are converted

@@ -197,42 +158,48 @@ toJson = unsafeFunction "to_json"

197-- otherwise, a scalar value is produced. For any scalar type other than a

158-- otherwise, a scalar value is produced. For any scalar type other than a

198-- number, a Boolean, or a null value, the text representation will be used, in

159-- number, a Boolean, or a null value, the text representation will be used, in

199-- such a fashion that it is a valid jsonb value.

160-- such a fashion that it is a valid jsonb value.

200−toJsonb :: null ty --> null 'PGjsonb

161+toJsonb :: null ty :--> null 'PGjsonb

201toJsonb = unsafeFunction "to_jsonb"

162toJsonb = unsafeFunction "to_jsonb"

202

163

203-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

164-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

204-- becomes a JSON array of arrays.

165-- becomes a JSON array of arrays.

205−arrayToJson :: null ('PGvararray ty) --> null 'PGjson

166+arrayToJson :: null ('PGvararray ty) :--> null 'PGjson

206arrayToJson = unsafeFunction "array_to_json"

167arrayToJson = unsafeFunction "array_to_json"

207

168

208-- | Returns the row as a JSON object.

169-- | Returns the row as a JSON object.

209−rowToJson :: null ('PGcomposite ty) --> null 'PGjson

170+rowToJson :: null ('PGcomposite ty) :--> null 'PGjson

210rowToJson = unsafeFunction "row_to_json"

171rowToJson = unsafeFunction "row_to_json"

211

172

212-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

173-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

213-- argument list.

174-- argument list.

214−jsonBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjson

175+jsonBuildArray :: SOP.SListI tuple => FunctionN tuple (null 'PGjson)

215jsonBuildArray = unsafeFunctionN "json_build_array"

176jsonBuildArray = unsafeFunctionN "json_build_array"

216

177

217-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

178-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

218-- variadic argument list.

179-- variadic argument list.

219−jsonbBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjsonb

180+jsonbBuildArray :: SOP.SListI tuple => FunctionN tuple (null 'PGjsonb)

220jsonbBuildArray = unsafeFunctionN "jsonb_build_array"

181jsonbBuildArray = unsafeFunctionN "jsonb_build_array"

221

182

183+class PGBuildObject tys where

184+instance PGBuildObject '[]

185+instance (PGBuildObject tys, key `In` PGJsonKey)

186+ => PGBuildObject ('NotNull key ': value ': tys)

187+

222-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

188-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

223-- argument list. The elements of the argument list must alternate between text

189-- argument list. The elements of the argument list must alternate between text

224-- and values.

190-- and values.

225−class SOP.SListI tys => JsonBuildObject tys where

191+jsonBuildObject

226−

192+ :: (SOP.SListI elems, PGBuildObject elems)

227− jsonBuildObject :: tys ---> null 'PGjson

193+ => FunctionN elems (null 'PGjson)

228− jsonBuildObject = unsafeFunctionN "json_build_object"

194+jsonBuildObject = unsafeFunctionN "json_build_object"

229−

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)

230− jsonbBuildObject :: tys ---> null 'PGjsonb

201+ => FunctionN elems (null 'PGjsonb)

231− jsonbBuildObject = unsafeFunctionN "jsonb_build_object"

202+jsonbBuildObject = unsafeFunctionN "jsonb_build_object"

232−

233−instance JsonBuildObject '[]

234−instance (JsonBuildObject tys, key `In` PGJsonKey)

235− => JsonBuildObject ('NotNull key ': value ': tys)

236

203

237-- | Builds a JSON object out of a text array.

204-- | Builds a JSON object out of a text array.

238-- The array must have two dimensions

205-- The array must have two dimensions

@@ -240,7 +207,7 @@ instance (JsonBuildObject tys, key `In` PGJsonKey)

240-- which are taken as a key/value pair.

207-- which are taken as a key/value pair.

241jsonObject

208jsonObject

242 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

209 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

243− --> null 'PGjson

210+ :--> null 'PGjson

244jsonObject = unsafeFunction "json_object"

211jsonObject = unsafeFunction "json_object"

245

212

246-- | Builds a binary JSON object out of a text array.

213-- | Builds a binary JSON object out of a text array.

@@ -249,24 +216,24 @@ jsonObject = unsafeFunction "json_object"

249-- which are taken as a key/value pair.

216-- which are taken as a key/value pair.

250jsonbObject

217jsonbObject

251 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

218 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

252− --> null 'PGjsonb

219+ :--> null 'PGjsonb

253jsonbObject = unsafeFunction "jsonb_object"

220jsonbObject = unsafeFunction "jsonb_object"

254

221

255-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

222-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

256-- keys and one for values, that are zipped pairwise to create a JSON object.

223-- keys and one for values, that are zipped pairwise to create a JSON object.

257−jsonZipObject ::

224+jsonZipObject :: FunctionN

258 '[ null ('PGvararray ('NotNull 'PGtext))

225 '[ null ('PGvararray ('NotNull 'PGtext))

259 , null ('PGvararray ('NotNull 'PGtext)) ]

226 , null ('PGvararray ('NotNull 'PGtext)) ]

260− ---> null 'PGjson

227+ ( null 'PGjson )

261jsonZipObject = unsafeFunctionN "json_object"

228jsonZipObject = unsafeFunctionN "json_object"

262

229

263-- | This is an alternate form of 'jsonbObject' that takes two arrays; one for

230-- | This is an alternate form of 'jsonbObject' that takes two arrays; one for

264-- keys and one for values, that are zipped pairwise to create a binary JSON

231-- keys and one for values, that are zipped pairwise to create a binary JSON

265-- object.

232-- object.

266−jsonbZipObject ::

233+jsonbZipObject :: FunctionN

267 '[ null ('PGvararray ('NotNull 'PGtext))

234 '[ null ('PGvararray ('NotNull 'PGtext))

268 , null ('PGvararray ('NotNull 'PGtext)) ]

235 , null ('PGvararray ('NotNull 'PGtext)) ]

269− ---> null 'PGjsonb

236+ ( null 'PGjsonb )

270jsonbZipObject = unsafeFunctionN "jsonb_object"

237jsonbZipObject = unsafeFunctionN "jsonb_object"

271

238

272{-----------------------------------------

239{-----------------------------------------

@@ -274,189 +241,108 @@ Table 9.46: JSON processing functions

274-----------------------------------------}

241-----------------------------------------}

275

242

276-- | Returns the number of elements in the outermost JSON array.

243-- | Returns the number of elements in the outermost JSON array.

277−jsonArrayLength :: null 'PGjson --> null 'PGint4

244+jsonArrayLength :: null 'PGjson :--> null 'PGint4

278jsonArrayLength = unsafeFunction "json_array_length"

245jsonArrayLength = unsafeFunction "json_array_length"

279

246

280-- | Returns the number of elements in the outermost binary JSON array.

247-- | Returns the number of elements in the outermost binary JSON array.

281−jsonbArrayLength :: null 'PGjsonb --> null 'PGint4

248+jsonbArrayLength :: null 'PGjsonb :--> null 'PGint4

282jsonbArrayLength = unsafeFunction "jsonb_array_length"

249jsonbArrayLength = unsafeFunction "jsonb_array_length"

283

250

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+

284-- | Returns the type of the outermost JSON value as a text string. Possible

291-- | Returns the type of the outermost JSON value as a text string. Possible

285-- types are object, array, string, number, boolean, and null.

292-- types are object, array, string, number, boolean, and null.

286−jsonTypeof :: null 'PGjson --> null 'PGtext

293+jsonTypeof :: null 'PGjson :--> null 'PGtext

287jsonTypeof = unsafeFunction "json_typeof"

294jsonTypeof = unsafeFunction "json_typeof"

288

295

289-- | Returns the type of the outermost binary JSON value as a text string.

296-- | Returns the type of the outermost binary JSON value as a text string.

290-- Possible types are object, array, string, number, boolean, and null.

297-- Possible types are object, array, string, number, boolean, and null.

291−jsonbTypeof :: null 'PGjsonb --> null 'PGtext

298+jsonbTypeof :: null 'PGjsonb :--> null 'PGtext

292jsonbTypeof = unsafeFunction "jsonb_typeof"

299jsonbTypeof = unsafeFunction "jsonb_typeof"

293

300

294-- | Returns its argument with all object fields that have null values omitted.

301-- | Returns its argument with all object fields that have null values omitted.

295-- Other null values are untouched.

302-- Other null values are untouched.

296−jsonStripNulls :: null 'PGjson --> null 'PGjson

303+jsonStripNulls :: null 'PGjson :--> null 'PGjson

297jsonStripNulls = unsafeFunction "json_strip_nulls"

304jsonStripNulls = unsafeFunction "json_strip_nulls"

298

305

299-- | Returns its argument with all object fields that have null values omitted.

306-- | Returns its argument with all object fields that have null values omitted.

300-- Other null values are untouched.

307-- Other null values are untouched.

301−jsonbStripNulls :: null 'PGjsonb --> null 'PGjsonb

308+jsonbStripNulls :: null 'PGjsonb :--> null 'PGjsonb

302jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

309jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

303

310

304-- | @ jsonbSet target path new_value create_missing @

311-- | @ jsonbSet target path new_value create_missing @

305--

312--

306−-- Returns target with the section designated by path replaced by @new_value@,

313+-- Returns target with the section designated by path replaced by new_value,

307−-- or with @new_value@ added if create_missing is

314+-- or with new_value added if create_missing is true ( default is true) and the

308−-- `Squeal.PostgreSQL.Expression.Logic.true` and the

309-- item designated by path does not exist. As with the path orientated

315-- item designated by path does not exist. As with the path orientated

310-- operators, negative integers that appear in path count from the end of JSON

316-- operators, negative integers that appear in path count from the end of JSON

311-- arrays.

317-- arrays.

312−jsonbSet ::

318+jsonbSet

319+ :: Expression outer commons grp schemas params from (null 'PGjsonb)

313− '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

320+ -> Expression outer commons grp schemas params from (null ('PGvararray ('NotNull 'PGtext)))

314− , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

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)

315−jsonbSet = unsafeFunctionN "jsonbSet"

326+ Nothing -> unsafeFunctionN "jsonb_set" (tgt :* path :* val :* Nil)

316

327

317-- | @ jsonbInsert target path new_value insert_after @

328-- | @ jsonbInsert target path new_value insert_after @

318--

329--

319−-- Returns target with @new_value@ inserted. If target section designated by

330+-- 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

331+-- 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

332+-- if insert_after is true (default is false). If target section designated by

323−-- path is in JSONB object, @new_value@ will be inserted only if target does not

333+-- path is in JSONB object, new_value will be inserted only if target does not

324-- exist. As with the path orientated operators, negative integers that appear

334-- exist. As with the path orientated operators, negative integers that appear

325-- in path count from the end of JSON arrays.

335-- in path count from the end of JSON arrays.

326−jsonbInsert ::

336+jsonbInsert

337+ :: Expression outer commons grp schemas params from (null 'PGjsonb)

327− '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

338+ -> Expression outer commons grp schemas params from (null ('PGvararray ('NotNull 'PGtext)))

328− , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

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)

329−jsonbInsert = unsafeFunctionN "jsonb_insert"

344+ Nothing -> unsafeFunctionN "jsonb_insert" (tgt :* path :* val :* Nil)

330

345

331-- | Returns its argument as indented JSON text.

346-- | Returns its argument as indented JSON text.

332−jsonbPretty :: null 'PGjsonb --> null 'PGtext

347+jsonbPretty :: null 'PGjsonb :--> null 'PGtext

333jsonbPretty = unsafeFunction "jsonb_pretty"

348jsonbPretty = 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−

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , OverloadedStrings

3 , OverloadedStrings

@@ -30,7 +20,7 @@ import Squeal.PostgreSQL.Render

30import Squeal.PostgreSQL.Schema

20import Squeal.PostgreSQL.Schema

32-- | A `Condition` is an `Expression`, which can evaluate

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

34-- a three valued logic.

24-- a three valued logic.

35type Condition outer commons grp schemas params from =

25type Condition outer commons grp schemas params from =

36 Expression outer commons grp schemas params from ('Null 'PGbool)

26 Expression outer commons grp schemas params from ('Null 'PGbool)

@@ -47,8 +37,8 @@ false = UnsafeExpression "FALSE"

48-- | >>> printSQL $ not_ true

38-- | >>> printSQL $ not_ true

49-- (NOT TRUE)

39-- (NOT TRUE)

50−not_ :: null 'PGbool --> null 'PGbool

40+not_ :: null 'PGbool :--> null 'PGbool

51−not_ = unsafeLeftOp "NOT"

41+not_ = unsafeUnaryOpL "NOT"

53-- | >>> printSQL $ true .&& false

43-- | >>> printSQL $ true .&& false

54-- (TRUE AND FALSE)

44-- (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−

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , OverloadedStrings

3 , OverloadedStrings

@@ -29,6 +19,7 @@ import Squeal.PostgreSQL.Schema

30-- $setup

20-- $setup

31-- >>> import Squeal.PostgreSQL

21-- >>> import Squeal.PostgreSQL

22+-- >>> import Squeal.PostgreSQL.Render

33-- | >>> :{

24-- | >>> :{

34-- let

25-- let

@@ -37,7 +28,9 @@ import Squeal.PostgreSQL.Schema

37-- in printSQL expression

28-- in printSQL expression

38-- :}

29-- :}

39-- atan2(pi(), 2)

30-- atan2(pi(), 2)

31+atan2_

32+ :: float `In` PGFloating

40−atan2_ :: float `In` PGFloating => '[ null float, null float] ---> null float

33+ => FunctionN '[ null float, null float] (null float)

41atan2_ = unsafeFunctionN "atan2"

34atan2_ = unsafeFunctionN "atan2"

@@ -76,7 +69,7 @@ rem_ = unsafeBinaryOp "%"

76-- in printSQL expression

69-- in printSQL expression

77-- :}

70-- :}

78-- trunc(pi())

71-- trunc(pi())

79−trunc :: frac `In` PGFloating => null frac --> null frac

72+trunc :: frac `In` PGFloating => null frac :--> null frac

80trunc = unsafeFunction "trunc"

73trunc = unsafeFunction "trunc"

82-- | >>> :{

75-- | >>> :{

@@ -86,7 +79,7 @@ trunc = unsafeFunction "trunc"

86-- in printSQL expression

79-- in printSQL expression

87-- :}

80-- :}

88-- round(pi())

81-- round(pi())

89−round_ :: frac `In` PGFloating => null frac --> null frac

82+round_ :: frac `In` PGFloating => null frac :--> null frac

90round_ = unsafeFunction "round"

83round_ = unsafeFunction "round"

92-- | >>> :{

85-- | >>> :{

@@ -96,5 +89,5 @@ round_ = unsafeFunction "round"

96-- in printSQL expression

89-- in printSQL expression

97-- :}

90-- :}

98-- ceiling(pi())

91-- ceiling(pi())

99−ceiling_ :: frac `In` PGFloating => null frac --> null frac

92+ceiling_ :: frac `In` PGFloating => null frac :--> null frac

100ceiling_ = unsafeFunction "ceiling"

93ceiling_ = 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−

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , OverloadedStrings

3 , OverloadedStrings

@@ -44,7 +34,7 @@ null_ = UnsafeExpression "NULL"

44--

34--

45-- >>> printSQL $ notNull true

35-- >>> printSQL $ notNull true

46-- TRUE

36-- TRUE

47−notNull :: 'NotNull ty --> 'Null ty

37+notNull :: 'NotNull ty :--> 'Null ty

48notNull = UnsafeExpression . renderSQL

38notNull = UnsafeExpression . renderSQL

50-- | return the leftmost value which is not NULL

40-- | return the leftmost value which is not NULL

@@ -69,12 +59,12 @@ fromNull notNullx nullx = coalesce [nullx] notNullx

70-- | >>> printSQL $ null_ & isNull

60-- | >>> printSQL $ null_ & isNull

71-- NULL IS NULL

61-- NULL IS NULL

72−isNull :: 'Null ty --> null 'PGbool

62+isNull :: 'Null ty :--> null 'PGbool

73isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"

63isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"

75-- | >>> printSQL $ null_ & isNotNull

65-- | >>> printSQL $ null_ & isNotNull

76-- NULL IS NOT NULL

66-- NULL IS NOT NULL

77−isNotNull :: 'Null ty --> null 'PGbool

67+isNotNull :: 'Null ty :--> null 'PGbool

78isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"

68isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"

80-- | analagous to `maybe` using @IS NULL@

70-- | analagous to `maybe` using @IS NULL@

@@ -100,5 +90,5 @@ matchNull y f x = ifThenElse (isNull x) y

100>>> printSQL expr

90>>> printSQL expr

101NULLIF(FALSE, ($1 :: bool))

91NULLIF(FALSE, ($1 :: bool))

102-}

92-}

103−nullIf :: '[ 'NotNull ty, 'NotNull ty] ---> 'Null ty

93+nullIf :: FunctionN '[ 'NotNull ty, 'NotNull ty] ('Null ty)

104nullIf = unsafeFunctionN "NULLIF"

94nullIf = unsafeFunctionN "NULLIF"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Parameter.hsdeleted−80

@@ -1,80 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Parameter

3−Description: Parameters

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Parameters, out-of-line data values

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , DataKinds

14− , FlexibleContexts

15− , FlexibleInstances

16− , FunctionalDependencies

17− , KindSignatures

18− , MultiParamTypeClasses

19− , OverloadedStrings

20− , RankNTypes

21− , ScopedTypeVariables

22− , TypeApplications

23− , TypeOperators

24− , UndecidableInstances

25−#-}

26−

27−module Squeal.PostgreSQL.Expression.Parameter

28− ( HasParameter (parameter)

29− , param

30− ) where

31−

32−import GHC.TypeLits

33−

34−import Squeal.PostgreSQL.Expression

35−import Squeal.PostgreSQL.Expression.Type

36−import Squeal.PostgreSQL.Render

37−import Squeal.PostgreSQL.Schema

38−

39−-- $setup

40−-- >>> import Squeal.PostgreSQL

41−

42−{- | A `HasParameter` constraint is used to indicate a value that is

43−supplied externally to a SQL statement.

44−`Squeal.PostgreSQL.PQ.manipulateParams`,

45−`Squeal.PostgreSQL.PQ.queryParams` and

46−`Squeal.PostgreSQL.PQ.traversePrepared` support specifying data values

47−separately from the SQL command string, in which case `param`s are used to

48−refer to the out-of-line data values.

49−-}

50−class KnownNat n => HasParameter

51− (n :: Nat)

52− (params :: [NullityType])

53− (ty :: NullityType)

54− | n params -> ty where

55− -- | `parameter` takes a `Nat` using type application and a `TypeExpression`.

56− --

57− -- >>> let expr = parameter @1 int4 :: Expression outer '[] grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)

58− -- >>> printSQL expr

59− -- ($1 :: int4)

60− parameter

61− :: TypeExpression schemas ty

62− -> Expression outer commons grp schemas params from ty

63− parameter ty = UnsafeExpression $ parenthesized $

64− "$" <> renderNat @n <+> "::"

65− <+> renderSQL ty

66−instance {-# OVERLAPPING #-} HasParameter 1 (ty1:tys) ty1

67−instance {-# OVERLAPPABLE #-} (KnownNat n, HasParameter (n-1) params ty)

68− => HasParameter n (ty' : params) ty

69−

70−-- | `param` takes a `Nat` using type application and for basic types,

71−-- infers a `TypeExpression`.

72−--

73−-- >>> let expr = param @1 :: Expression outer commons grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)

74−-- >>> printSQL expr

75−-- ($1 :: int4)

76−param

77− :: forall n outer commons schemas params from grp ty

78− . (PGTyped schemas ty, HasParameter n params ty)

79− => Expression outer commons grp schemas params from ty -- ^ param

80−param = parameter @n (pgtype @schemas)

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Range.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−

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , GADTs

3 , GADTs

@@ -29,10 +19,8 @@ import Squeal.PostgreSQL.Schema

29-- of a `Squeal.PostgreSQL.Query.Query`. `Asc` or `Desc`

19-- of a `Squeal.PostgreSQL.Query.Query`. `Asc` or `Desc`

30-- set the sort direction of a `NotNull` result

20-- set the sort direction of a `NotNull` result

31-- column to ascending or descending. Ascending order puts smaller values

21-- column to ascending or descending. Ascending order puts smaller values

32−-- first, where "smaller" is defined in terms of the

22+-- first, where "smaller" is defined in terms of the `.<` operator. Similarly,

33−-- `Squeal.PostgreSQL.Expression.Comparison..<` operator. Similarly,

34−-- descending order is determined with the

23+-- descending order is determined with the `.>` operator. `AscNullsFirst`,

35−-- `Squeal.PostgreSQL.Expression.Comparison..>` operator. `AscNullsFirst`,

36-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to

24-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to

37-- determine whether nulls appear before or after non-null values in the sort

25-- determine whether nulls appear before or after non-null values in the sort

38-- ordering of a `Null` result column.

26-- ordering of a `Null` result column.

@@ -56,16 +44,6 @@ data SortExpression outer commons grp schemas params from where

56 :: Expression outer commons grp schemas params from ('Null ty)

44 :: Expression outer commons grp schemas params from ('Null ty)

57 -> SortExpression outer commons grp schemas params from

45 -> SortExpression outer commons grp schemas params from

58deriving instance Show (SortExpression outer commons grp schemas params from)

46deriving 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"

70{- |

48{- |

71The `orderBy` clause causes the result rows of a `Squeal.PostgreSQL.Query.TableExpression`

49The `orderBy` clause causes the result rows of a `Squeal.PostgreSQL.Query.TableExpression`

@@ -83,3 +61,15 @@ class OrderBy expr where

83 :: [SortExpression outer commons grp schemas params from]

61 :: [SortExpression outer commons grp schemas params from]

84 -> expr outer commons grp schemas params from

62 -> expr outer commons grp schemas params from

85 -> expr outer commons grp schemas params from

63 -> 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.hsdeleted−120

@@ -1,120 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression.Subquery

3−Description: Subquery expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Subquery expressions

9−-}

10−

11−{-# LANGUAGE

12− DataKinds

13− , OverloadedStrings

14− , RankNTypes

15− , TypeOperators

16−#-}

17−

18−module Squeal.PostgreSQL.Expression.Subquery

19− ( exists

20− , in_

21− , notIn

22− , subAll

23− , subAny

24− ) where

25−

26−import Squeal.PostgreSQL.Alias

27−import Squeal.PostgreSQL.Expression

28−import Squeal.PostgreSQL.Expression.Logic

29−import Squeal.PostgreSQL.List

30−import Squeal.PostgreSQL.Query

31−import Squeal.PostgreSQL.Render

32−import Squeal.PostgreSQL.Schema

33−

34−-- $setup

35−-- >>> import Squeal.PostgreSQL

36−

37−{- |

38−The argument of `exists` is an arbitrary subquery. The subquery is evaluated

39−to determine whether it returns any rows. If it returns at least one row,

40−the result of `exists` is `true`; if the subquery returns no rows,

41−the result of `exists` is `false`.

42−

43−The subquery can refer to variables from the surrounding query,

44−which will act as constants during any one evaluation of the subquery.

45−

46−The subquery will generally only be executed long enough to determine whether

47−at least one row is returned, not all the way to completion.

48−-}

49−exists

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

51− -> Condition outer commons grp schemas params from

52−exists query = UnsafeExpression $ "EXISTS" <+> parenthesized (renderSQL query)

53−

54−{- |

55−The right-hand side is a parenthesized subquery, which must return

56−exactly one column. The left-hand expression is evaluated and compared to each

57−row of the subquery result using the given `Operator`,

58−which must yield a Boolean result. The result of `subAll` is `true`

59−if all rows yield true (including the case where the subquery returns no rows).

60−The result is `false` if any `false` result is found.

61−The result is `Squeal.PostgreSQL.Expression.Null.null_` if

62− no comparison with a subquery row returns `false`,

63−and at least one comparison returns `Squeal.PostgreSQL.Expression.Null.null_`.

64−

65−>>> printSQL $ subAll true (.==) (values_ (true `as` #foo))

66−(TRUE = ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo")))

67−-}

68−subAll

69− :: Expression outer commons grp schemas params from ty1 -- ^ expression

70− -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator

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

72− -> Condition outer commons grp schemas params from

73−subAll expr (?) qry = expr ?

74− (UnsafeExpression $ "ALL" <+> parenthesized (renderSQL qry))

75−

76−{- |

77−The right-hand side is a parenthesized subquery, which must return exactly one column.

78−The left-hand expression is evaluated and compared to each row of the subquery result

79−using the given `Operator`, which must yield a Boolean result. The result of `subAny` is `true`

80−if any `true` result is obtained. The result is `false` if no true result is found

81−(including the case where the subquery returns no rows).

82−

83−>>> printSQL $ subAny "foo" like (values_ ("foobar" `as` #foo))

84−(E'foo' LIKE ANY (SELECT * FROM (VALUES (E'foobar')) AS t ("foo")))

85−-}

86−subAny

87− :: Expression outer commons grp schemas params from ty1 -- ^ expression

88− -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator

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

90− -> Condition outer commons grp schemas params from

91−subAny expr (?) qry = expr ?

92− (UnsafeExpression $ "ANY" <+> parenthesized (renderSQL qry))

93−

94−{- |

95−The result is `true` if the left-hand expression's result is equal

96−to any of the right-hand expressions.

97−

98−>>> printSQL $ true `in_` [true, false, null_]

99−TRUE IN (TRUE, FALSE, NULL)

100−-}

101−in_

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

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

104− -> Condition outer commons grp schemas params from

105−expr `in_` exprs = UnsafeExpression $ renderSQL expr <+> "IN"

106− <+> parenthesized (commaSeparated (renderSQL <$> exprs))

107−

108−{- |

109−The result is `true` if the left-hand expression's result is not equal

110−to any of the right-hand expressions.

111−

112−>>> printSQL $ true `notIn` [false, null_]

113−TRUE NOT IN (FALSE, NULL)

114−-}

115−notIn

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

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

118− -> Condition outer commons grp schemas params from

119−expr `notIn` exprs = UnsafeExpression $ renderSQL expr <+> "NOT IN"

120− <+> parenthesized (commaSeparated (renderSQL <$> exprs))

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Text.hs+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−

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , OverloadedStrings

3 , OverloadedStrings

@@ -27,20 +17,21 @@ import Squeal.PostgreSQL.Schema

28-- $setup

18-- $setup

29-- >>> import Squeal.PostgreSQL

19-- >>> import Squeal.PostgreSQL

20+-- >>> import Squeal.PostgreSQL.Render

31-- | >>> printSQL $ lower "ARRRGGG"

22-- | >>> printSQL $ lower "ARRRGGG"

32-- lower(E'ARRRGGG')

23-- lower(E'ARRRGGG')

33−lower :: null 'PGtext --> null 'PGtext

24+lower :: null 'PGtext :--> null 'PGtext

34lower = unsafeFunction "lower"

25lower = unsafeFunction "lower"

36-- | >>> printSQL $ upper "eeee"

27-- | >>> printSQL $ upper "eeee"

37-- upper(E'eeee')

28-- upper(E'eeee')

38−upper :: null 'PGtext --> null 'PGtext

29+upper :: null 'PGtext :--> null 'PGtext

39upper = unsafeFunction "upper"

30upper = unsafeFunction "upper"

41-- | >>> printSQL $ charLength "four"

32-- | >>> printSQL $ charLength "four"

42-- char_length(E'four')

33-- char_length(E'four')

43−charLength :: null 'PGtext --> null 'PGint4

34+charLength :: null 'PGtext :--> null 'PGint4

44charLength = unsafeFunction "char_length"

35charLength = unsafeFunction "char_length"

46-- | The `like` expression returns true if the @string@ matches

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

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , OverloadedStrings

3 , OverloadedStrings

@@ -42,116 +32,76 @@ import Squeal.PostgreSQL.Expression

42import Squeal.PostgreSQL.List

32import Squeal.PostgreSQL.List

43import Squeal.PostgreSQL.Schema

33import Squeal.PostgreSQL.Schema

45−-- | `Squeal.PostgreSQL.Expression.Type.tsvector` matches tsquery ?

46(@@) :: Operator (null 'PGtsvector) (null 'PGtsquery) ('Null 'PGbool)

35(@@) :: Operator (null 'PGtsvector) (null 'PGtsquery) ('Null 'PGbool)

47(@@) = unsafeBinaryOp "@@"

36(@@) = unsafeBinaryOp "@@"

49−-- | AND `Squeal.PostgreSQL.Expression.Type.tsquery`s together

50(.&) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

38(.&) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

51(.&) = unsafeBinaryOp "&&"

39(.&) = unsafeBinaryOp "&&"

53−-- | OR `Squeal.PostgreSQL.Expression.Type.tsquery`s together

54(.|) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

41(.|) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

55(.|) = unsafeBinaryOp "||"

42(.|) = unsafeBinaryOp "||"

57−-- | negate a `Squeal.PostgreSQL.Expression.Type.tsquery`

58−(.!) :: null 'PGtsquery --> null 'PGtsquery

44+(.!) :: null 'PGtsquery :--> null 'PGtsquery

59−(.!) = unsafeLeftOp "!!"

45+(.!) = unsafeUnaryOpL "!!"

61−-- | `Squeal.PostgreSQL.Expression.Type.tsquery` followed by

62−-- `Squeal.PostgreSQL.Expression.Type.tsquery`

63(<->) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

47(<->) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

64(<->) = unsafeBinaryOp "<->"

48(<->) = unsafeBinaryOp "<->"

66−-- | convert array of lexemes to `Squeal.PostgreSQL.Expression.Type.tsvector`

67arrayToTSvector

50arrayToTSvector

68 :: null ('PGvararray ('NotNull 'PGtext))

51 :: null ('PGvararray ('NotNull 'PGtext))

69− --> null 'PGtsvector

52+ :--> null 'PGtsvector

70arrayToTSvector = unsafeFunction "array_to_tsvector"

53arrayToTSvector = unsafeFunction "array_to_tsvector"

72−-- | number of lexemes in `Squeal.PostgreSQL.Expression.Type.tsvector`

73−tsvectorLength :: null 'PGtsvector --> null 'PGint4

55+tsvectorLength :: null 'PGtsvector :--> null 'PGint4

74tsvectorLength = unsafeFunction "length"

56tsvectorLength = unsafeFunction "length"

76−-- | number of lexemes plus operators in `Squeal.PostgreSQL.Expression.Type.tsquery`

77−numnode :: null 'PGtsquery --> null 'PGint4

58+numnode :: null 'PGtsquery :--> null 'PGint4

78numnode = unsafeFunction "numnode"

59numnode = unsafeFunction "numnode"

80−-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` ignoring punctuation

81−plainToTSquery :: null 'PGtext --> null 'PGtsquery

61+plainToTSquery :: null 'PGtext :--> null 'PGtsquery

82plainToTSquery = unsafeFunction "plainto_tsquery"

62plainToTSquery = unsafeFunction "plainto_tsquery"

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

87phraseToTSquery = unsafeFunction "phraseto_tsquery"

65phraseToTSquery = unsafeFunction "phraseto_tsquery"

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

91websearchToTSquery = unsafeFunction "websearch_to_tsquery"

68websearchToTSquery = unsafeFunction "websearch_to_tsquery"

93−-- | get indexable part of a `Squeal.PostgreSQL.Expression.Type.tsquery`

94−queryTree :: null 'PGtsquery --> null 'PGtext

70+queryTree :: null 'PGtsquery :--> null 'PGtext

95queryTree = unsafeFunction "query_tree"

71queryTree = unsafeFunction "query_tree"

97−-- | normalize words and convert to `Squeal.PostgreSQL.Expression.Type.tsquery`

98−toTSquery :: null 'PGtext --> null 'PGtsquery

73+toTSquery :: null 'PGtext :--> null 'PGtsquery

99toTSquery = unsafeFunction "to_tsquery"

74toTSquery = unsafeFunction "to_tsquery"

100

101−-- | reduce document text to `Squeal.PostgreSQL.Expression.Type.tsvector`

102toTSvector

76toTSvector

103 :: ty `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

77 :: ty `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

104− => null ty --> null 'PGtsvector

78+ => null ty :--> null 'PGtsvector

105toTSvector = unsafeFunction "to_tsvector"

79toTSvector = unsafeFunction "to_tsvector"

106

107−-- | assign weight to each element of `Squeal.PostgreSQL.Expression.Type.tsvector`

81+setWeight

108−setWeight :: '[null 'PGtsvector, null ('PGchar 1)] ---> null 'PGtsvector

82+ :: FunctionN '[null 'PGtsvector, null ('PGchar 1)] (null 'PGtsvector)

109setWeight = unsafeFunctionN "set_weight"

83setWeight = unsafeFunctionN "set_weight"

110

111−-- | remove positions and weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

112−strip :: null 'PGtsvector --> null 'PGtsvector

85+strip :: null 'PGtsvector :--> null 'PGtsvector

113strip = unsafeFunction "strip"

86strip = unsafeFunction "strip"

114

115−-- | @jsonToTSvector (document *: filter)@

116−-- reduce each value in the document, specified by filter to a `Squeal.PostgreSQL.Expression.Type.tsvector`,

117−-- and then concatenate those in document order to produce a single `Squeal.PostgreSQL.Expression.Type.tsvector`.

118−-- filter is a `Squeal.PostgreSQL.Expression.Type.json` array, that enumerates what kind of elements

119−-- need to be included into the resulting `Squeal.PostgreSQL.Expression.Type.tsvector`.

120−-- Possible values for filter are "string" (to include all string values),

121−-- "numeric" (to include all numeric values in the string format),

122−-- "boolean" (to include all Boolean values in the string format "true"/"false"),

123−-- "key" (to include all keys) or "all" (to include all above).

124−-- These values can be combined together to include, e.g. all string and numeric values.

125−jsonToTSvector :: '[null 'PGjson, null 'PGjson] ---> null 'PGtsvector

88+jsonToTSvector :: FunctionN '[null 'PGjson, null 'PGjson] (null 'PGtsvector)

126jsonToTSvector = unsafeFunctionN "json_to_tsvector"

89jsonToTSvector = unsafeFunctionN "json_to_tsvector"

127

128−-- | @jsonbToTSvector (document *: filter)@

129−-- reduce each value in the document, specified by filter to a `Squeal.PostgreSQL.Expression.Type.tsvector`,

130−-- and then concatenate those in document order to produce a single `Squeal.PostgreSQL.Expression.Type.tsvector`.

131−-- filter is a `Squeal.PostgreSQL.Expression.Type.jsonb` array, that enumerates what kind of elements

132−-- need to be included into the resulting `Squeal.PostgreSQL.Expression.Type.tsvector`.

133−-- Possible values for filter are "string" (to include all string values),

134−-- "numeric" (to include all numeric values in the string format),

135−-- "boolean" (to include all Boolean values in the string format "true"/"false"),

136−-- "key" (to include all keys) or "all" (to include all above).

137−-- These values can be combined together to include, e.g. all string and numeric values.

138−jsonbToTSvector :: '[null 'PGjsonb, null 'PGjsonb] ---> null 'PGtsvector

91+jsonbToTSvector :: FunctionN '[null 'PGjsonb, null 'PGjsonb] (null 'PGtsvector)

139jsonbToTSvector = unsafeFunctionN "jsonb_to_tsvector"

92jsonbToTSvector = unsafeFunctionN "jsonb_to_tsvector"

140

141−-- | remove given lexeme from `Squeal.PostgreSQL.Expression.Type.tsvector`

142−tsDelete ::

94+tsDelete :: FunctionN

143 '[null 'PGtsvector, null ('PGvararray ('NotNull 'PGtext))]

95 '[null 'PGtsvector, null ('PGvararray ('NotNull 'PGtext))]

144− ---> null 'PGtsvector

96+ (null 'PGtsvector)

145tsDelete = unsafeFunctionN "ts_delete"

97tsDelete = unsafeFunctionN "ts_delete"

146

147−-- | select only elements with given weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

148−tsFilter ::

99+tsFilter :: FunctionN

149 '[null 'PGtsvector, null ('PGvararray ('NotNull ('PGchar 1)))]

100 '[null 'PGtsvector, null ('PGvararray ('NotNull ('PGchar 1)))]

150− ---> null 'PGtsvector

101+ (null 'PGtsvector)

151tsFilter = unsafeFunctionN "ts_filter"

102tsFilter = unsafeFunctionN "ts_filter"

152

103

153−-- | display a `Squeal.PostgreSQL.Expression.Type.tsquery` match

154tsHeadline

104tsHeadline

155 :: document `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

105 :: document `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

156− => '[null document, null 'PGtsquery] ---> null 'PGtext

106+ => FunctionN '[null document, null 'PGtsquery] (null 'PGtext)

157tsHeadline = unsafeFunctionN "ts_headline"

107tsHeadline = 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−

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , DeriveGeneric

3 , DeriveGeneric

@@ -17,7 +7,6 @@ Date/Time functions and operators

17 , OverloadedStrings

7 , OverloadedStrings

18 , PolyKinds

8 , PolyKinds

19 , RankNTypes

9 , RankNTypes

20− , TypeOperators

21#-}

10#-}

23module Squeal.PostgreSQL.Expression.Time

12module Squeal.PostgreSQL.Expression.Time

@@ -86,7 +75,9 @@ Create date from year, month and day fields

86>>> printSQL (makeDate (1984 :* 7 *: 3))

75>>> printSQL (makeDate (1984 :* 7 *: 3))

87make_date(1984, 7, 3)

76make_date(1984, 7, 3)

88-}

77-}

78+makeDate :: FunctionN

89−makeDate :: '[ null 'PGint4, null 'PGint4, null 'PGint4 ] ---> null 'PGdate

79+ '[ null 'PGint4, null 'PGint4, null 'PGint4 ]

80+ ( null 'PGdate )

90makeDate = unsafeFunctionN "make_date"

81makeDate = unsafeFunctionN "make_date"

92{-|

83{-|

@@ -95,7 +86,9 @@ Create time from hour, minute and seconds fields

95>>> printSQL (makeTime (8 :* 15 *: 23.5))

86>>> printSQL (makeTime (8 :* 15 *: 23.5))

96make_time(8, 15, 23.5)

87make_time(8, 15, 23.5)

97-}

88-}

89+makeTime :: FunctionN

98−makeTime :: '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtime

90+ '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ]

91+ ( null 'PGtime )

99makeTime = unsafeFunctionN "make_time"

92makeTime = unsafeFunctionN "make_time"

100

101{-|

94{-|

@@ -104,9 +97,10 @@ Create timestamp from year, month, day, hour, minute and seconds fields

104>>> printSQL (makeTimestamp (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

97>>> printSQL (makeTimestamp (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

105make_timestamp(2013, 7, 15, 8, 15, 23.5)

98make_timestamp(2013, 7, 15, 8, 15, 23.5)

106-}

99-}

107−makeTimestamp ::

100+makeTimestamp :: FunctionN

108 '[ null 'PGint4, null 'PGint4, null 'PGint4

101 '[ 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 )

110makeTimestamp = unsafeFunctionN "make_timestamp"

104makeTimestamp = unsafeFunctionN "make_timestamp"

111

105

112{-|

106{-|

@@ -117,9 +111,10 @@ the current time zone is used

117>>> printSQL (makeTimestamptz (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

111>>> printSQL (makeTimestamptz (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

118make_timestamptz(2013, 7, 15, 8, 15, 23.5)

112make_timestamptz(2013, 7, 15, 8, 15, 23.5)

119-}

113-}

120−makeTimestamptz ::

114+makeTimestamptz :: FunctionN

121 '[ null 'PGint4, null 'PGint4, null 'PGint4

115 '[ 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 )

123makeTimestamptz = unsafeFunctionN "make_timestamptz"

118makeTimestamptz = unsafeFunctionN "make_timestamptz"

124

119

125{-|

120{-|

@@ -161,7 +156,6 @@ infixl 6 +!

161infixl 6 !-

156infixl 6 !-

162infixl 6 !-!

157infixl 6 !-!

163

158

164−-- | A `TimeUnit` to use in `interval_` construction.

165data TimeUnit

159data TimeUnit

166 = Years | Months | Weeks | Days

160 = Years | Months | Weeks | Days

167 | Hours | Minutes | Seconds

161 | Hours | Minutes | Seconds

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Type.hsdeleted−446

@@ -1,446 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Expression

3−Description: Type expressions

4−Copyright: (c) Eitan Chatav, 2019

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Type expressions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , DataKinds

14− , DeriveGeneric

15− , FlexibleContexts

16− , FlexibleInstances

17− , GADTs

18− , GeneralizedNewtypeDeriving

19− , KindSignatures

20− , MultiParamTypeClasses

21− , OverloadedStrings

22− , RankNTypes

23− , ScopedTypeVariables

24− , TypeApplications

25− , TypeOperators

26− , UndecidableInstances

27−#-}

28−

29−module Squeal.PostgreSQL.Expression.Type

30− ( -- * type casting

31− cast

32− , astype

33− , inferredtype

34− -- * type expressions

35− , TypeExpression (..)

36− , typedef

37− , typetable

38− , typeview

39− , bool

40− , int2

41− , smallint

42− , int4

43− , int

44− , integer

45− , int8

46− , bigint

47− , numeric

48− , float4

49− , real

50− , float8

51− , doublePrecision

52− , money

53− , text

54− , char

55− , character

56− , varchar

57− , characterVarying

58− , bytea

59− , timestamp

60− , timestampWithTimeZone

61− , timestamptz

62− , date

63− , time

64− , timeWithTimeZone

65− , timetz

66− , interval

67− , uuid

68− , inet

69− , json

70− , jsonb

71− , vararray

72− , fixarray

73− , tsvector

74− , tsquery

75− , oid

76− , int4range

77− , int8range

78− , numrange

79− , tsrange

80− , tstzrange

81− , daterange

82− -- * column type definitions

83− , ColumnTypeExpression (..)

84− , nullable

85− , notNullable

86− , default_

87− , serial2

88− , smallserial

89− , serial4

90− , serial

91− , serial8

92− , bigserial

93− , hask

94− -- * type inference

95− , PGTyped (..)

96− , PGNullityTyped (..)

97− , FieldTyped (..)

98− ) where

99−

100−import Control.DeepSeq

101−import Data.ByteString

102−import Data.String

103−import GHC.TypeLits

104−

105−import qualified Data.ByteString as ByteString

106−import qualified GHC.Generics as GHC

107−import qualified Generics.SOP as SOP

108−

109−import Squeal.PostgreSQL.Alias

110−import Squeal.PostgreSQL.Expression

111−import Squeal.PostgreSQL.PG

112−import Squeal.PostgreSQL.Render

113−import Squeal.PostgreSQL.Schema

114−

115−-- $setup

116−-- >>> import Squeal.PostgreSQL

117−

118−-- When a `cast` is applied to an `Expression` of a known type, it

119−-- represents a run-time type conversion. The cast will succeed only if a

120−-- suitable type conversion operation has been defined.

121−--

122−-- | >>> printSQL $ true & cast int4

123−-- (TRUE :: int4)

124−cast

125− :: TypeExpression schemas ty1

126− -- ^ type to cast as

127− -> Expression outer commons grp schemas params from ty0

128− -- ^ value to convert

129− -> Expression outer commons grp schemas params from ty1

130−cast ty x = UnsafeExpression $ parenthesized $

131− renderSQL x <+> "::" <+> renderSQL ty

132−

133−-- | A safe version of `cast` which just matches a value with its type.

134−--

135−-- >>> printSQL (1 & astype int)

136−-- (1 :: int)

137−astype

138− :: TypeExpression schemas ty

139− -- ^ type to specify as

140− -> Expression outer commons grp schemas params from ty

141− -- ^ value

142− -> Expression outer commons grp schemas params from ty

143−astype = cast

144−

145−-- | `inferredtype` will add a type annotation to an `Expression`

146−-- which can be useful for fixing the storage type of a value.

147−--

148−-- >>> printSQL (inferredtype true)

149−-- (TRUE :: bool)

150−inferredtype

151− :: PGTyped schemas ty

152− => Expression outer common grp schemas params from ty

153− -- ^ value

154− -> Expression outer common grp schemas params from ty

155−inferredtype = astype pgtype

156−

157−{-----------------------------------------

158−type expressions

159−-----------------------------------------}

160−

161−-- | `TypeExpression`s are used in `cast`s and

162−-- `Squeal.PostgreSQL.Definition.createTable` commands.

163−newtype TypeExpression (schemas :: SchemasType) (ty :: NullityType)

164− = UnsafeTypeExpression { renderTypeExpression :: ByteString }

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

166−instance RenderSQL (TypeExpression schemas ty) where

167− renderSQL = renderTypeExpression

168−

169−-- | The enum or composite type in a `Typedef` can be expressed by its alias.

170−typedef

171− :: (Has sch schemas schema, Has td schema ('Typedef ty))

172− => QualifiedAlias sch td

173− -- ^ type alias

174− -> TypeExpression schemas (null ty)

175−typedef = UnsafeTypeExpression . renderSQL

176−

177−-- | The composite type corresponding to a `Table` definition can be expressed

178−-- by its alias.

179−typetable

180− :: (Has sch schemas schema, Has tab schema ('Table table))

181− => QualifiedAlias sch tab

182− -- ^ table alias

183− -> TypeExpression schemas (null ('PGcomposite (TableToRow table)))

184−typetable = UnsafeTypeExpression . renderSQL

185−

186−-- | The composite type corresponding to a `View` definition can be expressed

187−-- by its alias.

188−typeview

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

190− => QualifiedAlias sch vw

191− -- ^ view alias

192− -> TypeExpression schemas (null ('PGcomposite view))

193−typeview = UnsafeTypeExpression . renderSQL

194−

195−-- | logical Boolean (true/false)

196−bool :: TypeExpression schemas (null 'PGbool)

197−bool = UnsafeTypeExpression "bool"

198−-- | signed two-byte integer

199−int2, smallint :: TypeExpression schemas (null 'PGint2)

200−int2 = UnsafeTypeExpression "int2"

201−smallint = UnsafeTypeExpression "smallint"

202−-- | signed four-byte integer

203−int4, int, integer :: TypeExpression schemas (null 'PGint4)

204−int4 = UnsafeTypeExpression "int4"

205−int = UnsafeTypeExpression "int"

206−integer = UnsafeTypeExpression "integer"

207−-- | signed eight-byte integer

208−int8, bigint :: TypeExpression schemas (null 'PGint8)

209−int8 = UnsafeTypeExpression "int8"

210−bigint = UnsafeTypeExpression "bigint"

211−-- | arbitrary precision numeric type

212−numeric :: TypeExpression schemas (null 'PGnumeric)

213−numeric = UnsafeTypeExpression "numeric"

214−-- | single precision floating-point number (4 bytes)

215−float4, real :: TypeExpression schemas (null 'PGfloat4)

216−float4 = UnsafeTypeExpression "float4"

217−real = UnsafeTypeExpression "real"

218−-- | double precision floating-point number (8 bytes)

219−float8, doublePrecision :: TypeExpression schemas (null 'PGfloat8)

220−float8 = UnsafeTypeExpression "float8"

221−doublePrecision = UnsafeTypeExpression "double precision"

222−-- | currency amount

223−money :: TypeExpression schema (null 'PGmoney)

224−money = UnsafeTypeExpression "money"

225−-- | variable-length character string

226−text :: TypeExpression schemas (null 'PGtext)

227−text = UnsafeTypeExpression "text"

228−-- | fixed-length character string

229−char, character

230− :: forall n schemas null. (KnownNat n, 1 <= n)

231− => TypeExpression schemas (null ('PGchar n))

232−char = UnsafeTypeExpression $ "char(" <> renderNat @n <> ")"

233−character = UnsafeTypeExpression $ "character(" <> renderNat @n <> ")"

234−-- | variable-length character string

235−varchar, characterVarying

236− :: forall n schemas null. (KnownNat n, 1 <= n)

237− => TypeExpression schemas (null ('PGvarchar n))

238−varchar = UnsafeTypeExpression $ "varchar(" <> renderNat @n <> ")"

239−characterVarying = UnsafeTypeExpression $

240− "character varying(" <> renderNat @n <> ")"

241−-- | binary data ("byte array")

242−bytea :: TypeExpression schemas (null 'PGbytea)

243−bytea = UnsafeTypeExpression "bytea"

244−-- | date and time (no time zone)

245−timestamp :: TypeExpression schemas (null 'PGtimestamp)

246−timestamp = UnsafeTypeExpression "timestamp"

247−-- | date and time, including time zone

248−timestampWithTimeZone, timestamptz :: TypeExpression schemas (null 'PGtimestamptz)

249−timestampWithTimeZone = UnsafeTypeExpression "timestamp with time zone"

250−timestamptz = UnsafeTypeExpression "timestamptz"

251−-- | calendar date (year, month, day)

252−date :: TypeExpression schemas (null 'PGdate)

253−date = UnsafeTypeExpression "date"

254−-- | time of day (no time zone)

255−time :: TypeExpression schemas (null 'PGtime)

256−time = UnsafeTypeExpression "time"

257−-- | time of day, including time zone

258−timeWithTimeZone, timetz :: TypeExpression schemas (null 'PGtimetz)

259−timeWithTimeZone = UnsafeTypeExpression "time with time zone"

260−timetz = UnsafeTypeExpression "timetz"

261−-- | time span

262−interval :: TypeExpression schemas (null 'PGinterval)

263−interval = UnsafeTypeExpression "interval"

264−-- | universally unique identifier

265−uuid :: TypeExpression schemas (null 'PGuuid)

266−uuid = UnsafeTypeExpression "uuid"

267−-- | IPv4 or IPv6 host address

268−inet :: TypeExpression schemas (null 'PGinet)

269−inet = UnsafeTypeExpression "inet"

270−-- | textual JSON data

271−json :: TypeExpression schemas (null 'PGjson)

272−json = UnsafeTypeExpression "json"

273−-- | binary JSON data, decomposed

274−jsonb :: TypeExpression schemas (null 'PGjsonb)

275−jsonb = UnsafeTypeExpression "jsonb"

276−-- | variable length array

277−vararray

278− :: TypeExpression schemas pg

279− -> TypeExpression schemas (null ('PGvararray pg))

280−vararray ty = UnsafeTypeExpression $ renderSQL ty <> "[]"

281−-- | fixed length array

282−--

283−-- >>> renderSQL (fixarray @'[2] json)

284−-- "json[2]"

285−fixarray

286− :: forall dims schemas null pg. SOP.All KnownNat dims

287− => TypeExpression schemas pg

288− -> TypeExpression schemas (null ('PGfixarray dims pg))

289−fixarray ty = UnsafeTypeExpression $

290− renderSQL ty <> renderDims @dims

291− where

292− renderDims :: forall ns. SOP.All KnownNat ns => ByteString

293− renderDims =

294− ("[" <>)

295− . (<> "]")

296− . ByteString.intercalate "]["

297− . SOP.hcollapse

298− $ SOP.hcmap (SOP.Proxy @KnownNat)

299− (K . fromString . show . natVal)

300− (SOP.hpure SOP.Proxy :: SOP.NP SOP.Proxy ns)

301−-- | text search query

302−tsvector :: TypeExpression schemas (null 'PGtsvector)

303−tsvector = UnsafeTypeExpression "tsvector"

304−-- | text search document

305−tsquery :: TypeExpression schemas (null 'PGtsquery)

306−tsquery = UnsafeTypeExpression "tsquery"

307−-- | Object identifiers (OIDs) are used internally by PostgreSQL

308−-- as primary keys for various system tables.

309−oid :: TypeExpression schemas (null 'PGoid)

310−oid = UnsafeTypeExpression "oid"

311−-- | Range of integer

312−int4range :: TypeExpression schemas (null ('PGrange 'PGint4))

313−int4range = UnsafeTypeExpression "int4range"

314−-- | Range of bigint

315−int8range :: TypeExpression schemas (null ('PGrange 'PGint8))

316−int8range = UnsafeTypeExpression "int8range"

317−-- | Range of numeric

318−numrange :: TypeExpression schemas (null ('PGrange 'PGnumeric))

319−numrange = UnsafeTypeExpression "numrange"

320−-- | Range of timestamp without time zone

321−tsrange :: TypeExpression schemas (null ('PGrange 'PGtimestamp))

322−tsrange = UnsafeTypeExpression "tsrange"

323−-- | Range of timestamp with time zone

324−tstzrange :: TypeExpression schemas (null ('PGrange 'PGtimestamptz))

325−tstzrange = UnsafeTypeExpression "tstzrange"

326−-- | Range of date

327−daterange :: TypeExpression schemas (null ('PGrange 'PGdate))

328−daterange = UnsafeTypeExpression "daterange"

329−

330−-- | `pgtype` is a demoted version of a `PGType`

331−class PGTyped schemas (ty :: NullityType) where

332− pgtype :: TypeExpression schemas ty

333−instance PGTyped schemas (null 'PGbool) where pgtype = bool

334−instance PGTyped schemas (null 'PGint2) where pgtype = int2

335−instance PGTyped schemas (null 'PGint4) where pgtype = int4

336−instance PGTyped schemas (null 'PGint8) where pgtype = int8

337−instance PGTyped schemas (null 'PGnumeric) where pgtype = numeric

338−instance PGTyped schemas (null 'PGfloat4) where pgtype = float4

339−instance PGTyped schemas (null 'PGfloat8) where pgtype = float8

340−instance PGTyped schemas (null 'PGmoney) where pgtype = money

341−instance PGTyped schemas (null 'PGtext) where pgtype = text

342−instance (KnownNat n, 1 <= n)

343− => PGTyped schemas (null ('PGchar n)) where pgtype = char @n

344−instance (KnownNat n, 1 <= n)

345− => PGTyped schemas (null ('PGvarchar n)) where pgtype = varchar @n

346−instance PGTyped schemas (null 'PGbytea) where pgtype = bytea

347−instance PGTyped schemas (null 'PGtimestamp) where pgtype = timestamp

348−instance PGTyped schemas (null 'PGtimestamptz) where pgtype = timestampWithTimeZone

349−instance PGTyped schemas (null 'PGdate) where pgtype = date

350−instance PGTyped schemas (null 'PGtime) where pgtype = time

351−instance PGTyped schemas (null 'PGtimetz) where pgtype = timeWithTimeZone

352−instance PGTyped schemas (null 'PGinterval) where pgtype = interval

353−instance PGTyped schemas (null 'PGuuid) where pgtype = uuid

354−instance PGTyped schemas (null 'PGjson) where pgtype = json

355−instance PGTyped schemas (null 'PGjsonb) where pgtype = jsonb

356−instance PGTyped schemas ty

357− => PGTyped schemas (null ('PGvararray ty)) where

358− pgtype = vararray (pgtype @schemas @ty)

359−instance (SOP.All KnownNat dims, PGTyped schemas ty)

360− => PGTyped schemas (null ('PGfixarray dims ty)) where

361− pgtype = fixarray @dims (pgtype @schemas @ty)

362−instance PGTyped schemas (null 'PGtsvector) where pgtype = tsvector

363−instance PGTyped schemas (null 'PGtsquery) where pgtype = tsquery

364−instance PGTyped schemas (null 'PGoid) where pgtype = oid

365−instance PGTyped schemas (null ('PGrange 'PGint4)) where pgtype = int4range

366−instance PGTyped schemas (null ('PGrange 'PGint8)) where pgtype = int8range

367−instance PGTyped schemas (null ('PGrange 'PGnumeric)) where pgtype = numrange

368−instance PGTyped schemas (null ('PGrange 'PGtimestamp)) where pgtype = tsrange

369−instance PGTyped schemas (null ('PGrange 'PGtimestamptz)) where pgtype = tstzrange

370−instance PGTyped schemas (null ('PGrange 'PGdate)) where pgtype = daterange

371−

372−-- | Lift `PGTyped` to a field

373−class FieldTyped schemas ty where

374− fieldtype :: Aliased (TypeExpression schemas) ty

375−instance (KnownSymbol alias, PGTyped schemas ty)

376− => FieldTyped schemas (alias ::: ty) where

377− fieldtype = pgtype `As` Alias

378−

379−-- | `ColumnTypeExpression`s are used in `createTable` commands.

380−newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)

381− = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }

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

383−instance RenderSQL (ColumnTypeExpression schemas ty) where

384− renderSQL = renderColumnTypeExpression

385−

386−-- | used in `createTable` commands as a column constraint to note that

387−-- @NULL@ may be present in a column

388−nullable

389− :: TypeExpression schemas (nullity ty)

390− -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)

391−nullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NULL"

392−

393−-- | used in `createTable` commands as a column constraint to ensure

394−-- @NULL@ is not present in a column

395−notNullable

396− :: TypeExpression schemas (nullity ty)

397− -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)

398−notNullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NOT NULL"

399−

400−-- | used in `createTable` commands as a column constraint to give a default

401−default_

402− :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty

403− -> ColumnTypeExpression schemas ('NoDef :=> ty)

404− -> ColumnTypeExpression schemas ('Def :=> ty)

405−default_ x ty = UnsafeColumnTypeExpression $

406− renderSQL ty <+> "DEFAULT" <+> renderExpression x

407−

408−-- | not a true type, but merely a notational convenience for creating

409−-- unique identifier columns with type `PGint2`

410−serial2, smallserial

411− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)

412−serial2 = UnsafeColumnTypeExpression "serial2"

413−smallserial = UnsafeColumnTypeExpression "smallserial"

414−-- | not a true type, but merely a notational convenience for creating

415−-- unique identifier columns with type `PGint4`

416−serial4, serial

417− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)

418−serial4 = UnsafeColumnTypeExpression "serial4"

419−serial = UnsafeColumnTypeExpression "serial"

420−-- | not a true type, but merely a notational convenience for creating

421−-- unique identifier columns with type `PGint8`

422−serial8, bigserial

423− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)

424−serial8 = UnsafeColumnTypeExpression "serial8"

425−bigserial = UnsafeColumnTypeExpression "bigserial"

426−

427−-- | Like @PGTyped@ but also accounts for nullity.

428−class PGNullityTyped schemas (nullty :: NullityType) where

429− pgNullityType :: ColumnTypeExpression schemas ('NoDef :=> nullty)

430−

431−instance PGTyped schemas ('Null ty) => PGNullityTyped schemas ('Null ty) where

432− pgNullityType = nullable (pgtype @_ @('Null ty))

433−

434−instance PGTyped schemas ('NotNull ty) => PGNullityTyped schemas ('NotNull ty) where

435− pgNullityType = notNullable (pgtype @_ @('NotNull ty))

436−

437−-- | Allow you to specify pg column types in relation to haskell types.

438−-- >>> printSQL $ hask @(Maybe String)

439−-- text NULL

440−--

441−-- >>> printSQL $ hask @Double

442−-- float8 NOT NULL

443−hask

444− :: forall hask schemas. PGNullityTyped schemas (NullPG hask)

445− => ColumnTypeExpression schemas ('NoDef :=> NullPG hask)

446−hask = pgNullityType

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Window.hs+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−

11{-# LANGUAGE

1{-# LANGUAGE

12 DataKinds

2 DataKinds

13 , DeriveGeneric

3 , DeriveGeneric

@@ -23,8 +13,9 @@ Window functions and definitions

23#-}

13#-}

25module Squeal.PostgreSQL.Expression.Window

15module Squeal.PostgreSQL.Expression.Window

26− ( -- * functions

16+ ( WindowDefinition (..)

27− partitionBy

17+ , partitionBy

18+ , WindowFunction (..)

28 , rank

19 , rank

29 , rowNumber

20 , rowNumber

30 , denseRank

21 , denseRank

@@ -36,14 +27,6 @@ module Squeal.PostgreSQL.Expression.Window

36 , firstValue

27 , firstValue

37 , lastValue

28 , lastValue

38 , nthValue

29 , nthValue

39− , unsafeWindowFunction1

40− , unsafeWindowFunctionN

41− -- * types

42− , WindowFunction (..)

43− , WindowDefinition (..)

44− , WinFun0

45− , WinFun1

46− , WinFunN

47 ) where

30 ) where

49import Control.DeepSeq

32import Control.DeepSeq

@@ -97,15 +80,14 @@ instance Aggregate

97 varPop = unsafeWindowFunction1 "var_pop"

80 varPop = unsafeWindowFunction1 "var_pop"

98 varSamp = unsafeWindowFunction1 "var_samp"

81 varSamp = unsafeWindowFunction1 "var_samp"

83+

100-- | A `WindowDefinition` is a set of table rows that are somehow related

84-- | A `WindowDefinition` is a set of table rows that are somehow related

101-- to the current row

85-- to the current row

102data WindowDefinition outer commons grp schemas params from where

86data WindowDefinition outer commons grp schemas params from where

103 WindowDefinition

87 WindowDefinition

104 :: SOP.SListI bys

88 :: SOP.SListI bys

105 => NP (Expression outer commons grp schemas params from) bys

89 => NP (Expression outer commons grp schemas params from) bys

106− -- ^ `partitionBy` clause

107 -> [SortExpression outer commons grp schemas params from]

90 -> [SortExpression outer commons grp schemas params from]

108− -- ^ `Squeal.PostgreSQL.Expression.Sort.orderBy` clause

109 -> WindowDefinition outer commons grp schemas params from

91 -> WindowDefinition outer commons grp schemas params from

110

111instance OrderBy WindowDefinition where

93instance OrderBy WindowDefinition where

@@ -132,7 +114,7 @@ the same partition as the current row.

132-}

114-}

133partitionBy

115partitionBy

134 :: SOP.SListI bys

116 :: SOP.SListI bys

135− => NP (Expression outer commons grp schemas params from) bys -- ^ partitions

117+ => NP (Expression outer commons grp schemas params from) bys

136 -> WindowDefinition outer commons grp schemas params from

118 -> WindowDefinition outer commons grp schemas params from

137partitionBy bys = WindowDefinition bys []

119partitionBy bys = WindowDefinition bys []

138

120

@@ -160,17 +142,11 @@ newtype WindowFunction

160instance RenderSQL (WindowFunction outer commons grp schemas params from ty) where

142instance RenderSQL (WindowFunction outer commons grp schemas params from ty) where

161 renderSQL = renderWindowFunction

143 renderSQL = renderWindowFunction

162

144

163−{- |

164−A @RankNType@ for window functions with no arguments.

165−-}

166type WinFun0 x

145type WinFun0 x

167 = forall outer commons grp schemas params from

146 = forall outer commons grp schemas params from

168 . WindowFunction outer commons grp schemas params from x

147 . WindowFunction outer commons grp schemas params from x

169 -- ^ cannot reference aliases

148 -- ^ cannot reference aliases

170

149

171−{- |

172−A @RankNType@ for window functions with 1 argument.

173−-}

174type WinFun1 x y

150type WinFun1 x y

175 = forall outer commons grp schemas params from

151 = forall outer commons grp schemas params from

176 . Expression outer commons grp schemas params from x

152 . Expression outer commons grp schemas params from x

@@ -178,10 +154,6 @@ type WinFun1 x y

178 -> WindowFunction outer commons grp schemas params from y

154 -> WindowFunction outer commons grp schemas params from y

179 -- ^ output

155 -- ^ output

180

156

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

185type WinFunN xs y

157type WinFunN xs y

186 = forall outer commons grp schemas params from

158 = forall outer commons grp schemas params from

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

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

@@ -189,18 +161,15 @@ type WinFunN xs y

189 -> WindowFunction outer commons grp schemas params from y

161 -> WindowFunction outer commons grp schemas params from y

190 -- ^ output

162 -- ^ output

191

163

192−-- | escape hatch for defining window functions

193unsafeWindowFunction1 :: ByteString -> WinFun1 x y

164unsafeWindowFunction1 :: ByteString -> WinFun1 x y

194unsafeWindowFunction1 fun x

165unsafeWindowFunction1 fun x

195 = UnsafeWindowFunction $ fun <> parenthesized (renderSQL x)

166 = UnsafeWindowFunction $ fun <> parenthesized (renderSQL x)

196

167

197−-- | escape hatch for defining multi-argument window functions

198unsafeWindowFunctionN :: SOP.SListI xs => ByteString -> WinFunN xs y

168unsafeWindowFunctionN :: SOP.SListI xs => ByteString -> WinFunN xs y

199unsafeWindowFunctionN fun xs = UnsafeWindowFunction $ fun <>

169unsafeWindowFunctionN fun xs = UnsafeWindowFunction $ fun <>

200 parenthesized (renderCommaSeparated renderSQL xs)

170 parenthesized (renderCommaSeparated renderSQL xs)

201

171

202{- | rank of the current row with gaps; same as `rowNumber` of its first peer

172{- | rank of the current row with gaps; same as `rowNumber` of its first peer

203−

204>>> printSQL rank

173>>> printSQL rank

205rank()

174rank()

206-}

175-}

@@ -208,7 +177,6 @@ rank :: WinFun0 ('NotNull 'PGint8)

208rank = UnsafeWindowFunction "rank()"

177rank = UnsafeWindowFunction "rank()"

209

178

210{- | number of the current row within its partition, counting from 1

179{- | number of the current row within its partition, counting from 1

211−

212>>> printSQL rowNumber

180>>> printSQL rowNumber

213row_number()

181row_number()

214-}

182-}

@@ -216,7 +184,6 @@ rowNumber :: WinFun0 ('NotNull 'PGint8)

216rowNumber = UnsafeWindowFunction "row_number()"

184rowNumber = UnsafeWindowFunction "row_number()"

217

185

218{- | rank of the current row without gaps; this function counts peer groups

186{- | rank of the current row without gaps; this function counts peer groups

219−

220>>> printSQL denseRank

187>>> printSQL denseRank

221dense_rank()

188dense_rank()

222-}

189-}

@@ -224,7 +191,6 @@ denseRank :: WinFun0 ('NotNull 'PGint8)

224denseRank = UnsafeWindowFunction "dense_rank()"

191denseRank = UnsafeWindowFunction "dense_rank()"

225

192

226{- | relative rank of the current row: (rank - 1) / (total partition rows - 1)

193{- | relative rank of the current row: (rank - 1) / (total partition rows - 1)

227−

228>>> printSQL percentRank

194>>> printSQL percentRank

229percent_rank()

195percent_rank()

230-}

196-}

@@ -233,7 +199,6 @@ percentRank = UnsafeWindowFunction "percent_rank()"

233

199

234{- | cumulative distribution: (number of partition rows

200{- | cumulative distribution: (number of partition rows

235preceding or peer with current row) / total partition rows

201preceding or peer with current row) / total partition rows

236−

237>>> printSQL cumeDist

202>>> printSQL cumeDist

238cume_dist()

203cume_dist()

239-}

204-}

@@ -242,9 +207,6 @@ cumeDist = UnsafeWindowFunction "cume_dist()"

242

207

243{- | integer ranging from 1 to the argument value,

208{- | integer ranging from 1 to the argument value,

244dividing the partition as equally as possible

209dividing the partition as equally as possible

245−

246−>>> printSQL $ ntile 5

247−ntile(5)

248-}

210-}

249ntile :: WinFun1 ('NotNull 'PGint4) ('NotNull 'PGint4)

211ntile :: WinFun1 ('NotNull 'PGint4) ('NotNull 'PGint4)

250ntile = unsafeWindowFunction1 "ntile"

212ntile = unsafeWindowFunction1 "ntile"

@@ -263,7 +225,7 @@ row within the partition; if there is no such row, instead return default

263evaluated with respect to the current row.

225evaluated with respect to the current row.

264-}

226-}

265lead :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

227lead :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

266−lead = unsafeWindowFunctionN "lead"

228+lead = unsafeWindowFunctionN "lag"

267

229

268{- | returns value evaluated at the row that is the

230{- | returns value evaluated at the row that is the

269first row of the window frame

231first 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−

13{-# LANGUAGE

1{-# LANGUAGE

14 DataKinds

2 DataKinds

15 , FlexibleContexts

3 , FlexibleContexts

@@ -31,31 +19,39 @@ module Squeal.PostgreSQL.List

31 ( SOP.NP (..)

19 ( SOP.NP (..)

32 , (*:)

20 , (*:)

33 , Join

21 , Join

22+ , (+++)

34 , disjoin

23 , disjoin

35− , Additional (..)

24+ , AlignedList (..)

36− , Path (..)

25+ , single

37− , CFunctor (..)

26+ , extractList

38− , CFoldable (..)

27+ , alignedMap

39− , CFree (..)

40 , Elem

28 , Elem

41 , In

29 , In

42 , Length

30 , Length

43 ) where

31 ) where

45−import Control.Category.Free

33+import Control.Category

46−import Data.Function ((&))

47import Data.Kind

34import Data.Kind

48import Data.Type.Bool

35import Data.Type.Bool

49import GHC.TypeLits

36import GHC.TypeLits

51import Generics.SOP as SOP

38import Generics.SOP as SOP

40+import Squeal.PostgreSQL.Render

41+

53-- | `Join` is simply promoted `++` and is used in @JOIN@s in

42-- | `Join` is simply promoted `++` and is used in @JOIN@s in

54-- `Squeal.PostgreSQL.Query.FromClause`s.

43-- `Squeal.PostgreSQL.Query.FromClause`s.

55type family Join xs ys where

44type family Join xs ys where

56 Join '[] ys = ys

45 Join '[] ys = ys

57 Join (x ': xs) ys = x ': Join xs ys

46 Join (x ': xs) ys = x ': Join xs ys

48+-- | Concatenate `NP` lists.

49+(+++) :: NP f xs -> NP f ys -> NP f (Join xs ys)

50+xs +++ ys = case xs of

51+ Nil -> ys

52+ x :* xs' -> x :* (xs' +++ ys)

53+infixr 5 +++

54+

59-- | `disjoin` is a utility function for splitting an `NP` list into pieces.

55-- | `disjoin` is a utility function for splitting an `NP` list into pieces.

60disjoin

56disjoin

61 :: forall xs ys expr. SListI xs

57 :: forall xs ys expr. SListI xs

@@ -66,15 +62,39 @@ disjoin = case sList @xs of

66 SCons -> \(x :* xsys) ->

62 SCons -> \(x :* xsys) ->

67 case disjoin xsys of (xs,ys) -> (x :* xs, ys)

63 case disjoin xsys of (xs,ys) -> (x :* xs, ys)

69−-- | The `Additional` class is for appending

65+-- | An `AlignedList` is a type-aligned list or free category.

70−-- type-level list parameterized constructors such as `NP`,

66+data AlignedList p x0 x1 where

71−-- `Squeal.PostgreSQL.Query.Selection`, and `Squeal.PostgreSQL.Query.FromClause`.

67+ Done :: AlignedList p x x

72−class Additional expr where

68+ (:>>) :: p x0 x1 -> AlignedList p x1 x2 -> AlignedList p x0 x2

73− also :: expr ys -> expr xs -> expr (Join xs ys)

69+infixr 7 :>>

74−instance Additional (NP expr) where

70+instance Category (AlignedList p) where

75− also ys = \case

71+ id = Done

76− Nil -> ys

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

77− x :* xs -> x :* (xs & also ys)

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

79-- | A useful operator for ending an `NP` list of length at least 2 without `Nil`.

99-- | A useful operator for ending an `NP` list of length at least 2 without `Nil`.

80(*:) :: f x -> f y -> NP f '[x,y]

100(*:) :: f x -> f y -> NP f '[x,y]

@@ -84,18 +104,13 @@ infixl 9 *:

84-- | @Elem@ is a promoted `Data.List.elem`.

104-- | @Elem@ is a promoted `Data.List.elem`.

85type family Elem x xs where

105type family Elem x xs where

86 Elem x '[] = 'False

106 Elem x '[] = 'False

87− Elem x (x ': _) = 'True

107+ Elem x (x ': xs) = '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

93 Elem x (_ ': xs) = Elem x xs

108 Elem x (_ ': xs) = Elem x xs

109

95-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.

110-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.

96type family In x xs :: Constraint where

111type family In x xs :: Constraint where

97 In x xs = If (Elem x xs) (() :: Constraint)

112 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))

114

100{- | Calculate the `Length` of a type level list

115{- | Calculate the `Length` of a type level list

101

116

@@ -104,9 +119,5 @@ Length '[Char,String,Bool,Double] :: Nat

104= 4

119= 4

105-}

120-}

106type family Length (xs :: [k]) :: Nat where

121type 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

112 Length '[] = 0

123 Length '[] = 0

squeal-postgresql/src/Squeal/PostgreSQL/Manipulation.hs+168−155

@@ -18,7 +18,6 @@ Squeal data manipulation language.

18 , MultiParamTypeClasses

19 , OverloadedStrings

20 , PatternSynonyms

21− , QuantifiedConstraints

22 , RankNTypes

21 , RankNTypes

23 , ScopedTypeVariables

22 , ScopedTypeVariables

24 , TypeApplications

23 , TypeApplications

@@ -30,9 +29,19 @@ Squeal data manipulation language.

31module Squeal.PostgreSQL.Manipulation

30module Squeal.PostgreSQL.Manipulation

32 ( -- * Manipulation

31 ( -- * Manipulation

33− Manipulation_

32+ Manipulation (..)

34− , Manipulation (..)

33+ , Manipulation_

35 , queryStatement

34 , queryStatement

35+ , QueryClause (..)

36+ , pattern Values_

37+ , DefaultAliasable (..)

38+ , ColumnExpression (..)

39+ , ReturningClause (..)

40+ , pattern Returning_

41+ , ConflictClause (..)

42+ , ConflictTarget (..)

43+ , ConflictAction (..)

44+ , UsingClause (..)

36 -- * Insert

45 -- * Insert

37 , insertInto

46 , insertInto

38 , insertInto_

47 , insertInto_

@@ -42,21 +51,13 @@ module Squeal.PostgreSQL.Manipulation

42 -- * Delete

51 -- * Delete

43 , deleteFrom

52 , deleteFrom

44 , deleteFrom_

53 , deleteFrom_

45− -- * Clauses

54+ , also

46− , Optional (..)

47− , QueryClause (..)

48− , pattern Values_

49− , ReturningClause (..)

50− , pattern Returning_

51− , ConflictClause (..)

52− , ConflictTarget (..)

53− , ConflictAction (..)

54− , UsingClause (..)

55 ) where

57import Control.DeepSeq

58import Data.ByteString hiding (foldr)

59import Data.Kind (Type)

60+import GHC.TypeLits (KnownSymbol)

61import qualified Generics.SOP as SOP

62import qualified Generics.SOP as SOP

62import qualified GHC.Generics as GHC

63import qualified GHC.Generics as GHC

@@ -72,65 +73,21 @@ import Squeal.PostgreSQL.Schema

73-- $setup

74-- $setup

74-- >>> import Squeal.PostgreSQL

75-- >>> import Squeal.PostgreSQL

75−-- >>> import Data.Int

76−-- >>> import Data.Time

78{- |

77{- |

79A `Manipulation` is a statement which may modify data in the database,

78A `Manipulation` is a statement which may modify data in the database,

80but does not alter its schemas. Examples are inserts, updates and deletes.

79but does not alter its schemas. Examples are inserts, updates and deletes.

81A `Query` is also considered a `Manipulation` even though it does not modify data.

80A `Query` is also considered a `Manipulation` even though it does not modify data.

83−The general `Manipulation` type is parameterized by

84−

85−* @commons :: FromType@ - scope for all `common` table expressions,

86−* @schemas :: SchemasType@ - scope for all `table`s and `view`s,

87−* @params :: [NullityType]@ - scope for all `Squeal.Expression.Parameter.parameter`s,

88−* @row :: RowType@ - return type of the `Query`.

89−-}

90−newtype Manipulation

91− (commons :: FromType)

92− (schemas :: SchemasType)

93− (params :: [NullityType])

94− (columns :: RowType)

95− = UnsafeManipulation { renderManipulation :: ByteString }

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

97−instance RenderSQL (Manipulation commons schemas params columns) where

98− renderSQL = renderManipulation

99−instance With Manipulation where

100− with Done manip = manip

101− with ctes manip = UnsafeManipulation $

102− "WITH" <+> commaSeparated (ctoList renderSQL ctes) <+> renderSQL manip

103−

104−{- |

105−The top level `Manipulation_` type is parameterized by a @schemas@ `SchemasType`,

106−against which the query is type-checked, an input @parameters@ Haskell `Type`,

107−and an ouput row Haskell `Type`.

108−

109−A top-level `Manipulation_` can be run

110−using `Squeal.PostgreSQL.PQ.manipulateParams`, or if @parameters = ()@

111−using `Squeal.PostgreSQL.PQ.manipulate`.

112−

113−Generally, @parameters@ will be a Haskell tuple or record whose entries

114−may be referenced using positional

115−`Squeal.PostgreSQL.Expression.Parameter.parameter`s and @row@ will be a

116−Haskell record, whose entries will be targeted using overloaded labels.

117−

118−>>> :set -XDeriveAnyClass -XDerivingStrategies

119−>>> :{

120−data Row a b = Row { col1 :: a, col2 :: b }

121− deriving stock (GHC.Generic)

122− deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)

123−:}

124−

125simple insert:

82simple insert:

126

127>>> type Columns = '["col1" ::: 'NoDef :=> 'Null 'PGint4, "col2" ::: 'Def :=> 'NotNull 'PGint4]

84>>> type Columns = '["col1" ::: 'NoDef :=> 'Null 'PGint4, "col2" ::: 'Def :=> 'NotNull 'PGint4]

128>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

85>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

129>>> :{

86>>> :{

130let

87let

131− manipulation :: Manipulation_ (Public Schema) () ()

88+ manipulation :: Manipulation '[] (Public Schema) '[] '[]

132 manipulation =

89 manipulation =

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

90+ insertInto_ #tab (Values_ (2 `as` #col1 :* defaultAs #col2))

134in printSQL manipulation

91in printSQL manipulation

135:}

92:}

136INSERT INTO "tab" ("col1", "col2") VALUES (2, DEFAULT)

93INSERT INTO "tab" ("col1", "col2") VALUES (2, DEFAULT)

@@ -141,9 +98,9 @@ parameterized insert:

141>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

98>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

142>>> :{

99>>> :{

143let

100let

144− manipulation :: Manipulation_ (Public Schema) (Int32, Int32) ()

101+ manipulation :: Manipulation '[] (Public Schema) '[ 'NotNull 'PGint4, 'NotNull 'PGint4 ] '[]

145 manipulation =

102 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))

147in printSQL manipulation

104in printSQL manipulation

148:}

105:}

149INSERT INTO "tab" ("col1", "col2") VALUES (($1 :: int4), ($2 :: int4))

106INSERT INTO "tab" ("col1", "col2") VALUES (($1 :: int4), ($2 :: int4))

@@ -152,9 +109,9 @@ returning insert:

152

109

153>>> :{

110>>> :{

154let

111let

155− manipulation :: Manipulation_ (Public Schema) () (Only Int32)

112+ manipulation :: Manipulation '[] (Public Schema) '[] '["fromOnly" ::: 'NotNull 'PGint4]

156 manipulation =

113 manipulation =

157− insertInto #tab (Values_ (Set 2 `as` #col1 :* Set 3 `as` #col2))

114+ insertInto #tab (Values_ (2 `as` #col1 :* 3 `as` #col2))

158 OnConflictDoRaise (Returning (#col1 `as` #fromOnly))

115 OnConflictDoRaise (Returning (#col1 `as` #fromOnly))

159in printSQL manipulation

116in printSQL manipulation

160:}

117:}

@@ -167,12 +124,12 @@ upsert:

167>>> type CustomersSchema = '["customers" ::: 'Table (CustomersConstraints :=> CustomersColumns)]

124>>> type CustomersSchema = '["customers" ::: 'Table (CustomersConstraints :=> CustomersColumns)]

168>>> :{

125>>> :{

169let

126let

170− manipulation :: Manipulation_ (Public CustomersSchema) () ()

127+ manipulation :: Manipulation '[] (Public CustomersSchema) '[] '[]

171 manipulation =

128 manipulation =

172 insertInto #customers

129 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))

174 (OnConflict (OnConstraint #uq)

131 (OnConflict (OnConstraint #uq)

175− (DoUpdate (Set (#excluded ! #email <> "; " <> #customers ! #email) `as` #email) []))

132+ (DoUpdate (((#excluded ! #email) <> "; " <> (#customers ! #email)) `as` #email) []))

176 (Returning_ Nil)

133 (Returning_ Nil)

177in printSQL manipulation

134in printSQL manipulation

178:}

135:}

@@ -182,7 +139,7 @@ query insert:

182

139

183>>> :{

140>>> :{

184let

141let

185− manipulation :: Manipulation_ (Public Schema) () ()

142+ manipulation :: Manipulation '[] (Public Schema) '[] '[]

186 manipulation = insertInto_ #tab (Subquery (select Star (from (table #tab))))

143 manipulation = insertInto_ #tab (Subquery (select Star (from (table #tab))))

187in printSQL manipulation

144in printSQL manipulation

188:}

145:}

@@ -192,8 +149,8 @@ update:

192

149

193>>> :{

150>>> :{

194let

151let

195− manipulation :: Manipulation_ (Public Schema) () ()

152+ manipulation :: Manipulation '[] (Public Schema) '[] '[]

196− manipulation = update_ #tab (Set 2 `as` #col1) (#col1 ./= #col2)

153+ manipulation = update_ #tab (2 `as` #col1) (#col1 ./= #col2)

197in printSQL manipulation

154in printSQL manipulation

198:}

155:}

199UPDATE "tab" SET "col1" = 2 WHERE ("col1" <> "col2")

156UPDATE "tab" SET "col1" = 2 WHERE ("col1" <> "col2")

@@ -202,7 +159,9 @@ delete:

202

159

203>>> :{

160>>> :{

204let

161let

205− manipulation :: Manipulation_ (Public Schema) () (Row Int32 Int32)

162+ manipulation :: Manipulation '[] (Public Schema) '[]

163+ '[ "col1" ::: 'NotNull 'PGint4

164+ , "col2" ::: 'NotNull 'PGint4 ]

206 manipulation = deleteFrom #tab NoUsing (#col1 .== #col2) (Returning Star)

165 manipulation = deleteFrom #tab NoUsing (#col1 .== #col2) (Returning Star)

207in printSQL manipulation

166in printSQL manipulation

208:}

167:}

@@ -213,13 +172,13 @@ delete and using clause:

213>>> :{

172>>> :{

214type Schema3 =

173type Schema3 =

215 '[ "tab" ::: 'Table ('[] :=> Columns)

174 '[ "tab" ::: 'Table ('[] :=> Columns)

216− , "other_tab" ::: 'Table ('[] :=> Columns)

175+ , "other_tab" ::: 'Table ('[] :=> Columns)

217− , "third_tab" ::: 'Table ('[] :=> Columns) ]

176+ , "third_tab" ::: 'Table ('[] :=> Columns) ]

218:}

177:}

219

178

220>>> :{

179>>> :{

221let

180let

222− manipulation :: Manipulation_ (Public Schema3) () ()

181+ manipulation :: Manipulation '[] (Public Schema3) '[] '[]

223 manipulation =

182 manipulation =

224 deleteFrom #tab (Using (table #other_tab & also (table #third_tab)))

183 deleteFrom #tab (Using (table #other_tab & also (table #third_tab)))

225 ( (#tab ! #col2 .== #other_tab ! #col2)

184 ( (#tab ! #col2 .== #other_tab ! #col2)

@@ -235,7 +194,7 @@ with manipulation:

235>>> type ProductsSchema = '["products" ::: 'Table ('[] :=> ProductsColumns), "products_deleted" ::: 'Table ('[] :=> ProductsColumns)]

194>>> type ProductsSchema = '["products" ::: 'Table ('[] :=> ProductsColumns), "products_deleted" ::: 'Table ('[] :=> ProductsColumns)]

236>>> :{

195>>> :{

237let

196let

238− manipulation :: Manipulation_ (Public ProductsSchema) (Only Day) ()

197+ manipulation :: Manipulation '[] (Public ProductsSchema) '[ 'NotNull 'PGdate] '[]

239 manipulation = with

198 manipulation = with

240 (deleteFrom #products NoUsing (#date .< param @1) (Returning Star) `as` #del)

199 (deleteFrom #products NoUsing (#date .< param @1) (Returning Star) `as` #del)

241 (insertInto_ #products_deleted (Subquery (select Star (from (common #del)))))

200 (insertInto_ #products_deleted (Subquery (select Star (from (common #del)))))

@@ -243,13 +202,26 @@ in printSQL manipulation

243:}

202:}

244WITH "del" AS (DELETE FROM "products" WHERE ("date" < ($1 :: date)) RETURNING *) INSERT INTO "products_deleted" SELECT * FROM "del" AS "del"

203WITH "del" AS (DELETE FROM "products" WHERE ("date" < ($1 :: date)) RETURNING *) INSERT INTO "products_deleted" SELECT * FROM "del" AS "del"

245-}

204-}

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+

246type family Manipulation_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

219type family Manipulation_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

247 Manipulation_ schemas params row = Manipulation '[] schemas (TuplePG params) (RowPG row)

220 Manipulation_ schemas params row = Manipulation '[] schemas (TuplePG params) (RowPG row)

248

221

249-- | Convert a `Query` into a `Manipulation`.

222-- | Convert a `Query` into a `Manipulation`.

250queryStatement

223queryStatement

251 :: Query '[] commons schemas params columns

224 :: Query '[] commons schemas params columns

252− -- ^ `Query` to embed as a `Manipulation`

253 -> Manipulation commons schemas params columns

225 -> Manipulation commons schemas params columns

254queryStatement q = UnsafeManipulation $ renderSQL q

226queryStatement q = UnsafeManipulation $ renderSQL q

255

227

@@ -272,13 +244,9 @@ insertInto

272 , SOP.SListI columns

244 , SOP.SListI columns

273 , SOP.SListI row1 )

245 , SOP.SListI row1 )

274 => QualifiedAlias sch tab

246 => QualifiedAlias sch tab

275− -- ^ table

276 -> QueryClause commons schemas params columns

247 -> QueryClause commons schemas params columns

277− -- ^ what to insert

278 -> ConflictClause tab commons schemas params table

248 -> ConflictClause tab commons schemas params table

279− -- ^ what to do in case of conflict

280 -> ReturningClause commons schemas params '[tab ::: row0] row1

249 -> ReturningClause commons schemas params '[tab ::: row0] row1

281− -- ^ what to return

282 -> Manipulation commons schemas params row1

250 -> Manipulation commons schemas params row1

283insertInto tab qry conflict ret = UnsafeManipulation $

251insertInto tab qry conflict ret = UnsafeManipulation $

284 "INSERT" <+> "INTO" <+> renderSQL tab

252 "INSERT" <+> "INTO" <+> renderSQL tab

@@ -286,7 +254,6 @@ insertInto tab qry conflict ret = UnsafeManipulation $

286 <> renderSQL conflict

254 <> renderSQL conflict

287 <> renderSQL ret

255 <> renderSQL ret

288

256

289−-- | Like `insertInto` but with `OnConflictDoRaise` and `no` `ReturningClause`.

290insertInto_

257insertInto_

291 :: ( Has sch schemas schema

258 :: ( Has sch schemas schema

292 , Has tab schema ('Table table)

259 , Has tab schema ('Table table)

@@ -294,33 +261,25 @@ insertInto_

294 , row ~ TableToRow table

261 , row ~ TableToRow table

295 , SOP.SListI columns )

262 , SOP.SListI columns )

296 => QualifiedAlias sch tab

263 => QualifiedAlias sch tab

297− -- ^ table

298 -> QueryClause commons schemas params columns

264 -> QueryClause commons schemas params columns

299− -- ^ what to insert

300 -> Manipulation commons schemas params '[]

265 -> Manipulation commons schemas params '[]

301insertInto_ tab qry =

266insertInto_ tab qry =

302 insertInto tab qry OnConflictDoRaise (Returning_ Nil)

267 insertInto tab qry OnConflictDoRaise (Returning_ Nil)

303

268

304−-- | A `QueryClause` describes what to `insertInto` a table.

305data QueryClause commons schemas params columns where

269data QueryClause commons schemas params columns where

306 Values

270 Values

307 :: SOP.SListI columns

271 :: SOP.SListI columns

308− => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

272+ => NP (ColumnExpression 'Ungrouped schemas params '[]) columns

309− -- ^ row of values

310− -> [NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns]

273+ -> [NP (ColumnExpression 'Ungrouped schemas params '[]) columns]

311− -- ^ additional rows of values

312 -> QueryClause commons schemas params columns

274 -> QueryClause commons schemas params columns

313 Select

275 Select

314 :: SOP.SListI columns

276 :: SOP.SListI columns

315− => NP (Aliased (Optional (Expression '[] commons grp schemas params from))) columns

277+ => NP (ColumnExpression grp schemas params from) columns

316− -- ^ row of values

317 -> TableExpression '[] commons grp schemas params from

278 -> TableExpression '[] commons grp schemas params from

318− -- ^ from a table expression

319 -> QueryClause commons schemas params columns

279 -> QueryClause commons schemas params columns

320 Subquery

280 Subquery

321 :: ColumnsToRow columns ~ row

281 :: ColumnsToRow columns ~ row

322 => Query '[] commons schemas params row

282 => Query '[] commons schemas params row

323− -- ^ subquery to insert

324 -> QueryClause commons schemas params columns

283 -> QueryClause commons schemas params columns

325

284

326instance RenderSQL (QueryClause commons schemas params columns) where

285instance RenderSQL (QueryClause commons schemas params columns) where

@@ -339,41 +298,109 @@ instance RenderSQL (QueryClause commons schemas params columns) where

339 Subquery qry -> renderQuery qry

298 Subquery qry -> renderQuery qry

340 where

299 where

341 renderSQLPartMaybe, renderValuePartMaybe

300 renderSQLPartMaybe, renderValuePartMaybe

342− :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

301+ :: ColumnExpression grp schemas params from column -> Maybe ByteString

343− -> Maybe ByteString

344 renderSQLPartMaybe = \case

302 renderSQLPartMaybe = \case

345− Default `As` _ -> Nothing

303+ DefaultAs _ -> Nothing

346− Set _ `As` name -> Just $ renderSQL name

304+ Specific (_ `As` name) -> Just $ renderSQL name

347 renderValuePartMaybe = \case

305 renderValuePartMaybe = \case

348− Default `As` _ -> Nothing

306+ DefaultAs _ -> Nothing

349− Set value `As` _ -> Just $ renderExpression value

307+ Specific (value `As` _) -> Just $ renderExpression value

350 renderSQLPart, renderValuePart

308 renderSQLPart, renderValuePart

351− :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

309+ :: ColumnExpression grp schemas params from column -> ByteString

352− -> ByteString

310+ renderSQLPart = \case

311+ DefaultAs name -> renderSQL name

353− renderSQLPart (_ `As` name) = renderSQL name

312+ Specific (_ `As` name) -> renderSQL name

354− renderValuePart (value `As` _) = renderSQL value

313+ renderValuePart = \case

314+ DefaultAs _ -> "DEFAULT"

315+ Specific (value `As` _) -> renderExpression value

355

316

356−-- | `Values_` describes a single `NP` list of `Aliased` `Optional` `Expression`s

357−-- whose `ColumnsType` must match the tables'.

358pattern Values_

317pattern Values_

359 :: SOP.SListI columns

318 :: SOP.SListI columns

360− => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

319+ => NP (ColumnExpression 'Ungrouped schemas params '[]) columns

361− -- ^ row of values

362 -> QueryClause commons schemas params columns

320 -> QueryClause commons schemas params columns

363pattern Values_ vals = Values vals []

321pattern Values_ vals = Values vals []

364

322

365−-- | `Optional` is either `Default` or a value, parameterized by an appropriate

323+data ColumnExpression grp schemas params from column where

366−-- `ColumnConstraint`.

324+ DefaultAs

367−data Optional expr ty where

325+ :: KnownSymbol col

368− -- | Use the `Default` value for a column.

326+ => Alias col

369− Default :: Optional expr ('Def :=> ty)

327+ -> ColumnExpression grp schemas params from (col ::: 'Def :=> ty)

370− -- | `Set` a value for a column.

328+ Specific

371− Set :: expr ty -> Optional expr (def :=> ty)

329+ :: Aliased (Expression '[] '[] grp schemas params from) (col ::: ty)

372−

330+ -> ColumnExpression grp schemas params from (col ::: defness :=> ty)

373−instance (forall x. RenderSQL (expr x)) => RenderSQL (Optional expr ty) where

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

374 renderSQL = \case

399 renderSQL = \case

400+ DefaultAs col ->

375− Default -> "DEFAULT"

401+ renderSQL col <+> "=" <+> "DEFAULT"

376− Set expr -> renderSQL expr

402+ Specific (expression `As` col) ->

403+ renderSQL col <+> "=" <+> renderSQL expression

377

404

378-- | A `ReturningClause` computes and return value(s) based

405-- | A `ReturningClause` computes and return value(s) based

379-- on each row actually inserted, updated or deleted. This is primarily

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

383-- deleted will be returned. For example, if a row was locked

410-- deleted will be returned. For example, if a row was locked

384-- but not updated because an `OnConflict` `DoUpdate` condition was not satisfied,

411-- but not updated because an `OnConflict` `DoUpdate` condition was not satisfied,

385-- the row will not be returned. `Returning` `Star` will return all columns

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

387-- values are desired.

414-- values are desired.

388newtype ReturningClause commons schemas params from row =

415newtype ReturningClause commons schemas params from row =

389 Returning (Selection '[] commons 'Ungrouped schemas params from row)

416 Returning (Selection '[] commons 'Ungrouped schemas params from row)

@@ -393,11 +420,9 @@ instance RenderSQL (ReturningClause commons schemas params from row) where

393 Returning (List Nil) -> ""

420 Returning (List Nil) -> ""

394 Returning selection -> " RETURNING" <+> renderSQL selection

421 Returning selection -> " RETURNING" <+> renderSQL selection

395

422

396−-- | `Returning` a `List`

397pattern Returning_

423pattern Returning_

398 :: SOP.SListI row

424 :: SOP.SListI row

399 => NP (Aliased (Expression '[] commons 'Ungrouped schemas params from)) row

425 => NP (Aliased (Expression '[] commons 'Ungrouped schemas params from)) row

400− -- ^ row of values

401 -> ReturningClause commons schemas params from row

426 -> ReturningClause commons schemas params from row

402pattern Returning_ list = Returning (List list)

427pattern Returning_ list = Returning (List list)

403

428

@@ -410,9 +435,7 @@ data ConflictClause tab commons schemas params table where

410 OnConflictDoRaise :: ConflictClause tab commons schemas params table

435 OnConflictDoRaise :: ConflictClause tab commons schemas params table

411 OnConflict

436 OnConflict

412 :: ConflictTarget constraints

437 :: ConflictTarget constraints

413− -- ^ conflict target

414 -> ConflictAction tab commons schemas params columns

438 -> ConflictAction tab commons schemas params columns

415− -- ^ conflict action

416 -> ConflictClause tab commons schemas params (constraints :=> columns)

439 -> ConflictClause tab commons schemas params (constraints :=> columns)

417

440

418-- | Render a `ConflictClause`.

441-- | Render a `ConflictClause`.

@@ -423,17 +446,6 @@ instance SOP.SListI (TableToColumns table)

423 OnConflict target action -> " ON CONFLICT"

446 OnConflict target action -> " ON CONFLICT"

424 <+> renderSQL target <+> renderSQL action

447 <+> renderSQL target <+> renderSQL action

425

448

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

437data ConflictAction tab commons schemas params columns where

449data ConflictAction tab commons schemas params columns where

438 DoNothing :: ConflictAction tab commons schemas params columns

450 DoNothing :: ConflictAction tab commons schemas params columns

439 DoUpdate

451 DoUpdate

@@ -442,9 +454,8 @@ data ConflictAction tab commons schemas params columns where

442 , columns ~ (col0 ': cols)

454 , columns ~ (col0 ': cols)

443 , SOP.All (HasIn columns) subcolumns

455 , SOP.All (HasIn columns) subcolumns

444 , AllUnique subcolumns )

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

446 -> [Condition '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]]

458 -> [Condition '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]]

447− -- ^ WHERE `Condition`s

448 -> ConflictAction tab commons schemas params columns

459 -> ConflictAction tab commons schemas params columns

449

460

450instance RenderSQL (ConflictAction tab commons schemas params columns) where

461instance RenderSQL (ConflictAction tab commons schemas params columns) where

@@ -452,17 +463,11 @@ instance RenderSQL (ConflictAction tab commons schemas params columns) where

452 DoNothing -> "DO NOTHING"

463 DoNothing -> "DO NOTHING"

453 DoUpdate updates whs'

464 DoUpdate updates whs'

454 -> "DO UPDATE SET"

465 -> "DO UPDATE SET"

455− <+> renderCommaSeparated renderUpdate updates

466+ <+> renderCommaSeparated renderSQL updates

456 <> case whs' of

467 <> case whs' of

457 [] -> ""

468 [] -> ""

458 wh:whs -> " WHERE" <+> renderSQL (foldr (.&&) wh whs)

469 wh:whs -> " WHERE" <+> renderSQL (foldr (.&&) wh whs)

459

470

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−

466-- | A `ConflictTarget` specifies the constraint violation that triggers a

471-- | A `ConflictTarget` specifies the constraint violation that triggers a

467-- `ConflictAction`.

472-- `ConflictAction`.

468data ConflictTarget constraints where

473data ConflictTarget constraints where

@@ -485,6 +490,7 @@ UPDATE statements

485update

490update

486 :: ( SOP.SListI columns

491 :: ( SOP.SListI columns

487 , SOP.SListI row1

492 , SOP.SListI row1

493+ , db ~ (commons :=> schemas)

488 , Has sch schemas schema

494 , Has sch schemas schema

489 , Has tab schema ('Table table)

495 , Has tab schema ('Table table)

490 , row0 ~ TableToRow table

496 , row0 ~ TableToRow table

@@ -492,7 +498,7 @@ update

492 , SOP.All (HasIn columns) subcolumns

498 , SOP.All (HasIn columns) subcolumns

493 , AllUnique subcolumns )

499 , AllUnique subcolumns )

494 => QualifiedAlias sch tab -- ^ table to update

500 => 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

496 -- ^ modified values to replace old values

502 -- ^ modified values to replace old values

497 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row0]

503 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row0]

498 -- ^ condition under which to perform update on a row

504 -- ^ condition under which to perform update on a row

@@ -502,13 +508,14 @@ update tab columns wh returning = UnsafeManipulation $

502 "UPDATE"

508 "UPDATE"

503 <+> renderSQL tab

509 <+> renderSQL tab

504 <+> "SET"

510 <+> "SET"

505− <+> renderCommaSeparated renderUpdate columns

511+ <+> renderCommaSeparated renderSQL columns

506 <+> "WHERE" <+> renderSQL wh

512 <+> "WHERE" <+> renderSQL wh

507 <> renderSQL returning

513 <> renderSQL returning

508

514

509-- | Update a row returning `Nil`.

515-- | Update a row returning `Nil`.

510update_

516update_

511 :: ( SOP.SListI columns

517 :: ( SOP.SListI columns

518+ , db ~ (commons :=> schemas)

512 , Has sch schemas schema

519 , Has sch schemas schema

513 , Has tab schema ('Table table)

520 , Has tab schema ('Table table)

514 , row ~ TableToRow table

521 , row ~ TableToRow table

@@ -516,7 +523,7 @@ update_

516 , SOP.All (HasIn columns) subcolumns

523 , SOP.All (HasIn columns) subcolumns

517 , AllUnique subcolumns )

524 , AllUnique subcolumns )

518 => QualifiedAlias sch tab -- ^ table to update

525 => 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

520 -- ^ modified values to replace old values

527 -- ^ modified values to replace old values

521 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]

528 -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]

522 -- ^ condition under which to perform update on a row

529 -- ^ condition under which to perform update on a row

@@ -527,25 +534,16 @@ update_ tab columns wh = update tab columns wh (Returning_ Nil)

527DELETE statements

534DELETE statements

528-----------------------------------------}

535-----------------------------------------}

529

536

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.

539data UsingClause commons schemas params from where

537data UsingClause commons schemas params from where

540 NoUsing :: UsingClause commons schemas params '[]

538 NoUsing :: UsingClause commons schemas params '[]

541 Using

539 Using

542 :: FromClause '[] commons schemas params from

540 :: FromClause '[] commons schemas params from

543− -- ^ what to use

544 -> UsingClause commons schemas params from

541 -> UsingClause commons schemas params from

545

542

546-- | Delete rows from a table.

543-- | Delete rows from a table.

547deleteFrom

544deleteFrom

548 :: ( SOP.SListI row1

545 :: ( SOP.SListI row1

546+ , db ~ (commons :=> schemas)

549 , Has sch schemas schema

547 , Has sch schemas schema

550 , Has tab schema ('Table table)

548 , Has tab schema ('Table table)

551 , row0 ~ TableToRow table

549 , row0 ~ TableToRow table

@@ -567,7 +565,8 @@ deleteFrom tab using wh returning = UnsafeManipulation $

567

565

568-- | Delete rows returning `Nil`.

566-- | Delete rows returning `Nil`.

569deleteFrom_

567deleteFrom_

568+ :: ( db ~ (commons :=> schemas)

570− :: ( Has sch schemas schema

569+ , Has sch schemas schema

571 , Has tab schema ('Table table)

570 , Has tab schema ('Table table)

572 , row ~ TableToRow table

571 , row ~ TableToRow table

573 , columns ~ TableToColumns table )

572 , columns ~ TableToColumns table )

@@ -576,3 +575,17 @@ deleteFrom_

576 -- ^ condition under which to delete a row

575 -- ^ condition under which to delete a row

577 -> Manipulation commons schemas params '[]

576 -> Manipulation commons schemas params '[]

578deleteFrom_ tab wh = deleteFrom tab NoUsing wh (Returning_ Nil)

577deleteFrom_ 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

66 }

67:}

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`.

71>>> let migrations = makeUsers :>> makeEmails :>> Done

@@ -156,6 +156,7 @@ import Data.Function ((&))

156import Data.List ((\\))

157import Data.Text (Text)

158import Data.Time (UTCTime)

159+import Generics.SOP (K (..))

159import Prelude hiding ((.), id)

160import Prelude hiding ((.), id)

160import System.Environment

161import System.Environment

161import UnliftIO (MonadIO (..))

162import UnliftIO (MonadIO (..))

@@ -164,21 +165,7 @@ import qualified Data.Text.IO as Text (putStrLn)

164import qualified Generics.SOP as SOP

165import qualified Generics.SOP as SOP

165import qualified GHC.Generics as GHC

166import qualified GHC.Generics as GHC

166

167

167−import Squeal.PostgreSQL.Alias

168+import Squeal.PostgreSQL

168−import Squeal.PostgreSQL.Binary

169−import Squeal.PostgreSQL.Definition

170−import Squeal.PostgreSQL.Definition.Table

171−import Squeal.PostgreSQL.Definition.Table.Constraint

172−import Squeal.PostgreSQL.Expression.Comparison

173−import Squeal.PostgreSQL.Expression.Parameter

174−import Squeal.PostgreSQL.Expression.Time

175−import Squeal.PostgreSQL.Expression.Type

176−import Squeal.PostgreSQL.List

177−import Squeal.PostgreSQL.Manipulation

178−import Squeal.PostgreSQL.PQ

179−import Squeal.PostgreSQL.Query

180−import Squeal.PostgreSQL.Schema

181−import Squeal.PostgreSQL.Transaction

182

169

183-- | A `Migration` is a named "isomorphism" over a given category.

170-- | A `Migration` is a named "isomorphism" over a given category.

184-- It should contain an inverse pair of `up` and `down`

171-- It should contain an inverse pair of `up` and `down`

@@ -192,34 +179,34 @@ data Migration p schemas0 schemas1 = Migration

192

179

193{- |

180{- |

194A `Migratory` @p@ is a `Category` for which one can execute or rewind

181A `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

196SQL `Definition`s and the category of impure `Terminally` `PQ` `IO` actions.

183SQL `Definition`s and the category of impure `Terminally` `PQ` `IO` actions.

197-}

184-}

198class Category p => Migratory p where

185class Category p => Migratory p where

199

186

200 {- |

187 {- |

201− Run a `Path` of `Migration`s.

188+ Run an `AlignedList` of `Migration`s.

202 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

189 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;

190+ In a 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`.

191+ if not, execute the `Migration` and insert a row in the `MigrationsTable`.

205 -}

192 -}

206 migrateUp

193 migrateUp

207− :: Path (Migration p) schemas0 schemas1

194+ :: AlignedList (Migration p) schemas0 schemas1

208 -> PQ schemas0 schemas1 IO ()

195 -> PQ schemas0 schemas1 IO ()

209

196

210 {- |

197 {- |

211− Rewind a `Path` of `Migration`s.

198+ Rewind an `AlignedList` of `Migration`s.

212 Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

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

200+ In a 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`.

201+ if so, rewind the `Migration` and delete its row in the `MigrationsTable`.

215 -}

202 -}

216 migrateDown

203 migrateDown

217− :: Path (Migration p) schemas0 schemas1

204+ :: AlignedList (Migration p) schemas0 schemas1

218 -> PQ schemas1 schemas0 IO ()

205 -> PQ schemas1 schemas0 IO ()

219

206

220instance Migratory Definition where

207instance Migratory Definition where

221− migrateUp = migrateUp . cmap pureMigration

208+ migrateUp = migrateUp . alignedMap pureMigration

222− migrateDown = migrateDown . cmap pureMigration

209+ migrateDown = migrateDown . alignedMap pureMigration

223

210

224{- | `Terminally` turns an indexed monad transformer and the monad it transforms

211{- | `Terminally` turns an indexed monad transformer and the monad it transforms

225into a category by restricting the return type to @()@ and permuting the type variables.

212into a category by restricting the return type to @()@ and permuting the type variables.

@@ -251,8 +238,8 @@ terminally = Terminally . void

251-- | A `pureMigration` turns a `Migration` involving only pure SQL

238-- | A `pureMigration` turns a `Migration` involving only pure SQL

252-- `Definition`s into a `Migration` that may be combined with arbitrary `IO`.

239-- `Definition`s into a `Migration` that may be combined with arbitrary `IO`.

253pureMigration

240pureMigration

254− :: Migration Definition schemas0 schemas1

241+ :: Migration Definition schema0 schema1

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

242+ -> Migration (Terminally PQ IO) schema0 schema1

256pureMigration migration = Migration

243pureMigration migration = Migration

257 { name = name migration

244 { name = name migration

258 , up = terminally . define $ up migration

245 , up = terminally . define $ up migration

@@ -261,64 +248,81 @@ pureMigration migration = Migration

261

248

262instance Migratory (Terminally PQ IO) where

249instance Migratory (Terminally PQ IO) where

263

250

264− migrateUp migration = unsafePQ . transactionally_ $ do

251+ migrateUp migration = unsafePQ $

265 define createMigrations

252 define createMigrations

253+ & pqBind okResult

266− upMigrations migration

254+ & pqThen (transactionallySchema_ (upMigrations migration))

267

255

268 where

256 where

269

257

270 upMigrations

258 upMigrations

271− :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

259+ :: AlignedList (Migration (Terminally PQ IO)) schemas0 schemas1

272 -> PQ MigrationsSchemas MigrationsSchemas IO ()

260 -> PQ MigrationsSchemas MigrationsSchemas IO ()

273 upMigrations = \case

261 upMigrations = \case

274 Done -> return ()

262 Done -> return ()

275− step :>> steps -> upMigration step >> upMigrations steps

263+ step :>> steps -> upMigration step & pqThen (upMigrations steps)

276

264

277 upMigration

265 upMigration

278 :: Migration (Terminally PQ IO) schemas0 schemas1

266 :: Migration (Terminally PQ IO) schemas0 schemas1

279 -> PQ MigrationsSchemas MigrationsSchemas IO ()

267 -> PQ MigrationsSchemas MigrationsSchemas IO ()

280− upMigration step = do

268+ upMigration step =

281− executed <- queryExecuted step

269+ queryExecuted step

282− unless (executed == 1) $ do

270+ & pqBind ( \ executed -> unless (executed == 1)

283− unsafePQ . runTerminally $ up step

271+ $ unsafePQ (runTerminally (up step))

284− manipulateParams_ insertMigration (Only (name step))

272+ & pqThen (manipulateParams insertMigration (Only (name step)))

273+ -- insert execution record

274+ & pqBind okResult )

285

275

286 queryExecuted

276 queryExecuted

287 :: Migration (Terminally PQ IO) schemas0 schemas1

277 :: Migration (Terminally PQ IO) schemas0 schemas1

288 -> PQ MigrationsSchemas MigrationsSchemas IO Row

278 -> PQ MigrationsSchemas MigrationsSchemas IO Row

289 queryExecuted step = do

279 queryExecuted step = do

290 result <- runQueryParams selectMigration (Only (name step))

280 result <- runQueryParams selectMigration (Only (name step))

281+ okResult result

291 ntuples result

282 ntuples result

292

283

293− migrateDown migrations = unsafePQ . transactionally_ $ do

284+ migrateDown migrations = unsafePQ $

294 define createMigrations

285 define createMigrations

286+ & pqBind okResult

295− downMigrations migrations

287+ & pqThen (transactionallySchema_ (downMigrations migrations))

296

288

297 where

289 where

298

290

299 downMigrations

291 downMigrations

300− :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

292+ :: AlignedList (Migration (Terminally PQ IO)) schemas0 schemas1

301 -> PQ MigrationsSchemas MigrationsSchemas IO ()

293 -> PQ MigrationsSchemas MigrationsSchemas IO ()

302 downMigrations = \case

294 downMigrations = \case

303 Done -> return ()

295 Done -> return ()

304− step :>> steps -> downMigrations steps >> downMigration step

296+ step :>> steps -> downMigrations steps & pqThen (downMigration step)

305

297

306 downMigration

298 downMigration

307 :: Migration (Terminally PQ IO) schemas0 schemas1

299 :: Migration (Terminally PQ IO) schemas0 schemas1

308 -> PQ MigrationsSchemas MigrationsSchemas IO ()

300 -> PQ MigrationsSchemas MigrationsSchemas IO ()

309− downMigration step = do

301+ downMigration step =

310− executed <- queryExecuted step

302+ queryExecuted step

311− unless (executed == 0) $ do

303+ & pqBind ( \ executed -> unless (executed == 0)

312− unsafePQ . runTerminally $ down step

304+ $ unsafePQ (runTerminally (down step))

313− manipulateParams_ deleteMigration (Only (name step))

305+ & pqThen (manipulateParams deleteMigration (Only (name step)))

306+ -- delete execution record

307+ & pqBind okResult )

314

308

315 queryExecuted

309 queryExecuted

316 :: Migration (Terminally PQ IO) schemas0 schemas1

310 :: Migration (Terminally PQ IO) schemas0 schemas1

317 -> PQ MigrationsSchemas MigrationsSchemas IO Row

311 -> PQ MigrationsSchemas MigrationsSchemas IO Row

318 queryExecuted step = do

312 queryExecuted step = do

319 result <- runQueryParams selectMigration (Only (name step))

313 result <- runQueryParams selectMigration (Only (name step))

314+ okResult result

320 ntuples result

315 ntuples result

321

316

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+

322unsafePQ :: (Functor m) => PQ db0 db1 m x -> PQ db0' db1' m x

326unsafePQ :: (Functor m) => PQ db0 db1 m x -> PQ db0' db1' m x

323unsafePQ (PQ pq) = PQ $ fmap (SOP.K . SOP.unK) . pq . SOP.K . SOP.unK

327unsafePQ (PQ pq) = PQ $ fmap (SOP.K . SOP.unK) . pq . SOP.K . SOP.unK

324

328

@@ -353,7 +357,7 @@ createMigrations =

353-- the time at which it was inserted.

357-- the time at which it was inserted.

354insertMigration :: Manipulation_ MigrationsSchemas (Only Text) ()

358insertMigration :: Manipulation_ MigrationsSchemas (Only Text) ()

355insertMigration = insertInto_ #schema_migrations

359insertMigration = insertInto_ #schema_migrations

356− (Values_ (Set (param @1) `as` #name :* Default `as` #executed_at))

360+ (Values_ ((param @1) `as` #name :* defaultAs #executed_at))

357

361

358-- | Deletes a `Migration` from the `MigrationsTable`, returning

362-- | Deletes a `Migration` from the `MigrationsTable`, returning

359-- the time at which it was inserted.

363-- the time at which it was inserted.

@@ -363,8 +367,8 @@ deleteMigration = deleteFrom_ #schema_migrations (#name .== param @1)

363-- | Selects a `Migration` from the `MigrationsTable`, returning

367-- | Selects a `Migration` from the `MigrationsTable`, returning

364-- the time at which it was inserted.

368-- the time at which it was inserted.

365selectMigration

369selectMigration

366− :: Query_ MigrationsSchemas (Only Text) (Only UTCTime)

370+ :: Query_ MigrationsSchemas (Only Text) (P ("executed_at" ::: UTCTime))

367−selectMigration = select_ (#executed_at `as` #fromOnly)

371+selectMigration = select_ #executed_at

368 $ from (table (#schema_migrations))

372 $ from (table (#schema_migrations))

369 & where_ (#name .== param @1)

373 & where_ (#name .== param @1)

370

374

@@ -384,7 +388,7 @@ defaultMain

384 :: Migratory p

388 :: Migratory p

385 => ByteString

389 => ByteString

386 -- ^ connection string

390 -- ^ connection string

387− -> Path (Migration p) db0 db1

391+ -> AlignedList (Migration p) db0 db1

388 -- ^ migrations

392 -- ^ migrations

389 -> IO ()

393 -> IO ()

390defaultMain connectTo migrations = do

394defaultMain connectTo migrations = do

@@ -405,12 +409,12 @@ defaultMain connectTo migrations = do

405 migrateStatus :: PQ schema schema IO ()

409 migrateStatus :: PQ schema schema IO ()

406 migrateStatus = unsafePQ $ do

410 migrateStatus = unsafePQ $ do

407 runNames <- getRunMigrationNames

411 runNames <- getRunMigrationNames

408− let names = ctoList name migrations

412+ let names = extractList name migrations

409 unrunNames = names \\ runNames

413 unrunNames = names \\ runNames

410 liftIO $ displayRunned runNames >> displayUnrunned unrunNames

414 liftIO $ displayRunned runNames >> displayUnrunned unrunNames

411

415

412 suppressNotices :: PQ schema schema IO ()

416 suppressNotices :: PQ schema schema IO ()

413− suppressNotices = manipulate_ $

417+ suppressNotices = void . manipulate $

414 UnsafeManipulation "SET client_min_messages TO WARNING;"

418 UnsafeManipulation "SET client_min_messages TO WARNING;"

415

419

416 readCommandFromArgs :: IO (Maybe MigrateCommand)

420 readCommandFromArgs :: IO (Maybe MigrateCommand)

squeal-postgresql/src/Squeal/PostgreSQL/PG.hs+92−102

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

11{-# LANGUAGE

2{-# LANGUAGE

12 AllowAmbiguousTypes

3 AllowAmbiguousTypes

13− , DeriveAnyClass

14 , DeriveFoldable

4 , DeriveFoldable

15 , DeriveFunctor

5 , DeriveFunctor

16 , DeriveGeneric

6 , DeriveGeneric

17 , DeriveTraversable

7 , DeriveTraversable

18− , DerivingStrategies

19 , DefaultSignatures

8 , DefaultSignatures

20 , FlexibleContexts

9 , FlexibleContexts

21 , FlexibleInstances

10 , FlexibleInstances

22 , FunctionalDependencies

11 , FunctionalDependencies

23 , GADTs

12 , GADTs

24 , LambdaCase

13 , LambdaCase

25− , MultiParamTypeClasses

26 , OverloadedStrings

14 , OverloadedStrings

15+ , MultiParamTypeClasses

27 , ScopedTypeVariables

16 , ScopedTypeVariables

28 , TypeApplications

17 , TypeApplications

29 , TypeFamilies

18 , TypeFamilies

@@ -39,6 +28,7 @@ module Squeal.PostgreSQL.PG

39 , NullPG

28 , NullPG

40 , TuplePG

29 , TuplePG

41 , RowPG

30 , RowPG

31+ , Entity

42 -- * Storage newtypes

32 -- * Storage newtypes

43 , Money (..)

33 , Money (..)

44 , Json (..)

34 , Json (..)

@@ -47,14 +37,13 @@ module Squeal.PostgreSQL.PG

47 , Enumerated (..)

37 , Enumerated (..)

48 , VarArray (..)

38 , VarArray (..)

49 , FixArray (..)

39 , FixArray (..)

50− , LibPQ.Oid (..)

40+ , SOP.P (..)

51 -- * Type families

41 -- * Type families

52 , LabelsPG

42 , LabelsPG

53 , DimPG

43 , DimPG

54 , FixPG

44 , FixPG

55 , TupleOf

45 , TupleOf

56 , TupleCodeOf

46 , TupleCodeOf

57− , RowOf

58 , ConstructorsOf

47 , ConstructorsOf

59 , ConstructorNameOf

48 , ConstructorNameOf

60 , ConstructorNamesOf

49 , ConstructorNamesOf

@@ -66,6 +55,7 @@ import Data.Int (Int16, Int32, Int64)

66import Data.Scientific (Scientific)

55import Data.Scientific (Scientific)

67import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime)

56import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime)

68import Data.Vector (Vector)

57import Data.Vector (Vector)

58+import Data.Word (Word16, Word32, Word64)

69import Data.UUID.Types (UUID)

59import Data.UUID.Types (UUID)

70import GHC.TypeLits

60import GHC.TypeLits

71import Network.IP.Addr (NetAddr, IP)

61import Network.IP.Addr (NetAddr, IP)

@@ -74,19 +64,15 @@ import qualified Data.ByteString.Lazy as Lazy (ByteString)

74import qualified Data.ByteString as Strict (ByteString)

64import qualified Data.ByteString as Strict (ByteString)

75import qualified Data.Text.Lazy as Lazy (Text)

65import qualified Data.Text.Lazy as Lazy (Text)

76import qualified Data.Text as Strict (Text)

66import qualified Data.Text as Strict (Text)

77−import qualified Database.PostgreSQL.LibPQ as LibPQ

78import qualified GHC.Generics as GHC

67import qualified GHC.Generics as GHC

79import qualified Generics.SOP as SOP

68import qualified Generics.SOP as SOP

80import qualified Generics.SOP.Record as SOP

69import qualified Generics.SOP.Record as SOP

81import qualified Generics.SOP.Type.Metadata as Type

70import qualified Generics.SOP.Type.Metadata as Type

83import Squeal.PostgreSQL.Alias

72import Squeal.PostgreSQL.Alias

73+import Squeal.PostgreSQL.List

84import Squeal.PostgreSQL.Schema

74import Squeal.PostgreSQL.Schema

86−-- $setup

87−-- >>> import Squeal.PostgreSQL

88−-- >>> import Data.Text (Text)

89−

90{- | The `PG` type family embeds a subset of Haskell types

76{- | The `PG` type family embeds a subset of Haskell types

91as Postgres types. As an open type family, `PG` is extensible.

77as Postgres types. As an open type family, `PG` is extensible.

@@ -99,51 +85,30 @@ PG LocalTime :: PGType

99>>> type instance PG MyDouble = 'PGfloat8

85>>> type instance PG MyDouble = 'PGfloat8

100-}

86-}

101type family PG (hask :: Type) :: PGType

87type family PG (hask :: Type) :: PGType

102−-- | `PGbool`

103type instance PG Bool = 'PGbool

88type instance PG Bool = 'PGbool

104−-- | `PGint2`

105type instance PG Int16 = 'PGint2

89type instance PG Int16 = 'PGint2

106−-- | `PGint4`

107type instance PG Int32 = 'PGint4

90type instance PG Int32 = 'PGint4

108−-- | `PGint8`

109type instance PG Int64 = 'PGint8

91type instance PG Int64 = 'PGint8

110−-- | `PGint2`

92+type instance PG Word16 = 'PGint2

111−type instance PG LibPQ.Oid = 'PGoid

93+type instance PG Word32 = 'PGint4

112−-- | `PGnumeric`

94+type instance PG Word64 = 'PGint8

113type instance PG Scientific = 'PGnumeric

95type instance PG Scientific = 'PGnumeric

114−-- | `PGfloat4`

115type instance PG Float = 'PGfloat4

96type instance PG Float = 'PGfloat4

116−-- | `PGfloat8`

117type instance PG Double = 'PGfloat8

97type instance PG Double = 'PGfloat8

118−-- | `PGchar` @1@

119type instance PG Char = 'PGchar 1

98type instance PG Char = 'PGchar 1

120−-- | `PGtext`

121type instance PG Strict.Text = 'PGtext

99type instance PG Strict.Text = 'PGtext

122−-- | `PGtext`

123type instance PG Lazy.Text = 'PGtext

100type instance PG Lazy.Text = 'PGtext

124−-- | `PGtext`

125type instance PG String = 'PGtext

101type instance PG String = 'PGtext

126−-- | `PGbytea`

127type instance PG Strict.ByteString = 'PGbytea

102type instance PG Strict.ByteString = 'PGbytea

128−-- | `PGbytea`

129type instance PG Lazy.ByteString = 'PGbytea

103type instance PG Lazy.ByteString = 'PGbytea

130−-- | `PGtimestamp`

131type instance PG LocalTime = 'PGtimestamp

104type instance PG LocalTime = 'PGtimestamp

132−-- | `PGtimestamptz`

133type instance PG UTCTime = 'PGtimestamptz

105type instance PG UTCTime = 'PGtimestamptz

134−-- | `PGdate`

135type instance PG Day = 'PGdate

106type instance PG Day = 'PGdate

136−-- | `PGtime`

137type instance PG TimeOfDay = 'PGtime

107type instance PG TimeOfDay = 'PGtime

138−-- | `PGtimetz`

139type instance PG (TimeOfDay, TimeZone) = 'PGtimetz

108type instance PG (TimeOfDay, TimeZone) = 'PGtimetz

140−-- | `PGinterval`

141type instance PG DiffTime = 'PGinterval

109type instance PG DiffTime = 'PGinterval

142−-- | `PGuuid`

143type instance PG UUID = 'PGuuid

110type instance PG UUID = 'PGuuid

144−-- | `PGinet`

145type instance PG (NetAddr IP) = 'PGinet

111type instance PG (NetAddr IP) = 'PGinet

146−-- | `PGjson`

147type instance PG Value = 'PGjson

112type instance PG Value = 'PGjson

148

113

149{-| The `LabelsPG` type family calculates the constructors of a

114{-| The `LabelsPG` type family calculates the constructors of a

@@ -164,7 +129,7 @@ type family LabelsPG (hask :: Type) :: [Type.ConstructorName] where

164`RowPG` turns a Haskell `Type` into a `RowType`.

129`RowPG` turns a Haskell `Type` into a `RowType`.

165

130

166`RowPG` may be applied to normal Haskell record types provided they

131`RowPG` may be applied to normal Haskell record types provided they

167−have `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

132+have the `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

168

133

169>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic

134>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic

170>>> instance SOP.Generic Person

135>>> instance SOP.Generic Person

@@ -172,22 +137,84 @@ have `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

172>>> :kind! RowPG Person

137>>> :kind! RowPG Person

173RowPG Person :: [(Symbol, NullityType)]

138RowPG Person :: [(Symbol, NullityType)]

174= '["name" ::: 'NotNull 'PGtext, "age" ::: 'NotNull 'PGint4]

139= '["name" ::: 'NotNull 'PGtext, "age" ::: 'NotNull 'PGint4]

140+

141+Or to tuples of `SOP.P` types;

142+

143+>>> :kind! RowPG (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32))

144+RowPG (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

145+ NullityType)]

146+= '[ '("id", 'NotNull 'PGint4), "foreign_id" ::: 'NotNull 'PGint4]

147+

148+Or to tuples which mix `SOP.P` types and record types.

149+

150+>>> :kind! RowPG (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32))

151+RowPG (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

152+ NullityType)]

153+= '[ '("id", 'NotNull 'PGint4), '("name", 'NotNull 'PGtext),

154+ '("age", 'NotNull 'PGint4), "foreign_id" ::: 'NotNull 'PGint4]

175-}

155-}

176type family RowPG (hask :: Type) :: RowType where

156type family RowPG (hask :: Type) :: RowType where

157+ RowPG (hask1, hask2) = Join (RowPG hask1) (RowPG hask2)

158+ RowPG (hask1, hask2, hask3) =

159+ Join (RowPG hask1) (RowPG (hask2, hask3))

160+ RowPG (hask1, hask2, hask3, hask4) =

161+ Join (RowPG hask1) (RowPG (hask2, hask3, hask4))

162+ RowPG (hask1, hask2, hask3, hask4, hask5) =

163+ Join (RowPG hask1) (RowPG (hask2, hask3, hask4, hask5))

164+ RowPG (SOP.P (col ::: ty)) = '[col ::: NullPG ty]

177 RowPG hask = RowOf (SOP.RecordCodeOf hask)

165 RowPG hask = RowOf (SOP.RecordCodeOf hask)

178

166

179−-- | `RowOf` applies `NullPG` to the fields of a list.

180type family RowOf (record :: [(Symbol, Type)]) :: RowType where

167type 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

190 RowOf '[] = '[]

168 RowOf '[] = '[]

169+ RowOf (col ::: ty ': record) = col ::: NullPG ty ': RowOf record

170+

171+type family ColumnsOf (record :: [(Symbol, Type)]) :: ColumnsType where

172+ ColumnsOf '[] = '[]

173+ ColumnsOf (col ::: ty ': record) =

174+ col ::: 'NoDef :=> NullPG ty ': ColumnsOf record

175+

176+{- |

177+`Entity` turns a Haskell `Type` into a `ColumnsType`.

178+

179+`Entity` may be applied to normal Haskell record types provided they

180+have the `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

181+

182+>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic

183+>>> instance SOP.Generic Person

184+>>> instance SOP.HasDatatypeInfo Person

185+>>> :kind! Entity Person

186+Entity Person :: [(Symbol, (ColumnConstraint, NullityType))]

187+= '["name" ::: ('NoDef :=> 'NotNull 'PGtext),

188+ "age" ::: ('NoDef :=> 'NotNull 'PGint4)]

189+

190+Or to tuples of `SOP.P` types;

191+

192+>>> :kind! Entity (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32))

193+Entity (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

194+ ColumnType)]

195+= '[ '("id", 'Def :=> 'NotNull 'PGint4),

196+ "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]

197+

198+Or to tuples which mix `SOP.P` types and record types.

199+

200+>>> :kind! Entity (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32))

201+Entity (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

202+ ColumnType)]

203+= '[ '("id", 'Def :=> 'NotNull 'PGint4),

204+ '("name", 'NoDef :=> 'NotNull 'PGtext),

205+ '("age", 'NoDef :=> 'NotNull 'PGint4),

206+ "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]

207+-}

208+type family Entity (hask :: Type) :: ColumnsType where

209+ Entity (hask1, hask2) = Join (Entity hask1) (Entity hask2)

210+ Entity (hask1, hask2, hask3) =

211+ Join (Entity hask1) (Entity (hask2, hask3))

212+ Entity (hask1, hask2, hask3, hask4) =

213+ Join (Entity hask1) (Entity (hask2, hask3, hask4))

214+ Entity (hask1, hask2, hask3, hask4, hask5) =

215+ Join (Entity hask1) (Entity (hask2, hask3, hask4, hask5))

216+ Entity (SOP.P (col ::: ty)) = '[col ::: 'Def :=> NullPG ty]

217+ Entity hask = ColumnsOf (SOP.RecordCodeOf hask)

191

218

192{- | `NullPG` turns a Haskell type into a `NullityType`.

219{- | `NullPG` turns a Haskell type into a `NullityType`.

193

220

@@ -212,22 +239,10 @@ TuplePG (Double, Maybe Char) :: [NullityType]

212type family TuplePG (hask :: Type) :: [NullityType] where

239type family TuplePG (hask :: Type) :: [NullityType] where

213 TuplePG hask = TupleOf (TupleCodeOf hask (SOP.Code hask))

240 TuplePG hask = TupleOf (TupleCodeOf hask (SOP.Code hask))

214

241

215−-- | `TupleOf` turns a list of Haskell `Type`s into a list of `NullityType`s.

216type family TupleOf (tuple :: [Type]) :: [NullityType] where

242type 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

227 TupleOf '[] = '[]

243 TupleOf '[] = '[]

244+ TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple

228

245

229−-- | `TupleCodeOf` takes the `SOP.Code` of a haskell `Type`

230−-- and if it's a simple product returns it, otherwise giving a `TypeError`.

231type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where

246type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where

232 TupleCodeOf hask '[tuple] = tuple

247 TupleCodeOf hask '[tuple] = tuple

233 TupleCodeOf hask '[] =

248 TupleCodeOf hask '[] =

@@ -268,7 +283,6 @@ type family ConstructorNamesOf (constructors :: [Type.ConstructorInfo])

268 ConstructorNamesOf (constructor ': constructors) =

283 ConstructorNamesOf (constructor ': constructors) =

269 ConstructorNameOf constructor ': ConstructorNamesOf constructors

284 ConstructorNameOf constructor ': ConstructorNamesOf constructors

270

285

271−-- | `DimPG` turns Haskell nested homogeneous tuples into a list of lengths.

272type family DimPG (hask :: Type) :: [Nat] where

286type family DimPG (hask :: Type) :: [Nat] where

273 DimPG (x,x) = 2 ': DimPG x

287 DimPG (x,x) = 2 ': DimPG x

274 DimPG (x,x,x) = 3 ': DimPG x

288 DimPG (x,x,x) = 3 ': DimPG x

@@ -281,7 +295,6 @@ type family DimPG (hask :: Type) :: [Nat] where

281 DimPG (x,x,x,x,x,x,x,x,x,x) = 10 ': DimPG x

295 DimPG (x,x,x,x,x,x,x,x,x,x) = 10 ': DimPG x

282 DimPG x = '[]

296 DimPG x = '[]

283

297

284−-- | `FixPG` extracts `NullPG` of the base type of nested homogeneous tuples.

285type family FixPG (hask :: Type) :: NullityType where

298type family FixPG (hask :: Type) :: NullityType where

286 FixPG (x,x) = FixPG x

299 FixPG (x,x) = FixPG x

287 FixPG (x,x,x) = FixPG x

300 FixPG (x,x,x) = FixPG x

@@ -311,7 +324,7 @@ let

311>>> let input = Only (Money 20020)

324>>> let input = Only (Money 20020)

312

325

313>>> :{

326>>> :{

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

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

315 result <- runQueryParams roundTrip input

328 result <- runQueryParams roundTrip input

316 Just output <- firstRow result

329 Just output <- firstRow result

317 liftIO . print $ input == output

330 liftIO . print $ input == output

@@ -319,70 +332,47 @@ withConnection "host=localhost port=5432 dbname=exampledb" $ do

319True

332True

320-}

333-}

321newtype Money = Money { cents :: Int64 }

334newtype Money = Money { cents :: Int64 }

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

335+ deriving (Eq, Ord, Show, Read, GHC.Generic)

323− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

324−-- | `PGmoney`

325type instance PG Money = 'PGmoney

336type instance PG Money = 'PGmoney

326

337

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

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

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

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

329-}

340-}

330newtype Json hask = Json {getJson :: hask}

341newtype Json hask = Json {getJson :: hask}

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

342+ deriving (Eq, Ord, Show, Read, GHC.Generic)

332− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

333−-- | `PGjson`

334type instance PG (Json hask) = 'PGjson

343type instance PG (Json hask) = 'PGjson

335

344

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

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

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

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

338-}

347-}

339newtype Jsonb hask = Jsonb {getJsonb :: hask}

348newtype Jsonb hask = Jsonb {getJsonb :: hask}

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

349+ deriving (Eq, Ord, Show, Read, GHC.Generic)

341− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

342−-- | `PGjsonb`

343type instance PG (Jsonb hask) = 'PGjsonb

350type instance PG (Jsonb hask) = 'PGjsonb

344

351

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

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

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

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

347-}

354-}

348newtype Composite record = Composite {getComposite :: record}

355newtype Composite record = Composite {getComposite :: record}

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

356+ deriving (Eq, Ord, Show, Read, GHC.Generic)

350− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

351−-- | `PGcomposite` @(@`RowPG` @hask)@

352type instance PG (Composite hask) = 'PGcomposite (RowPG hask)

357type instance PG (Composite hask) = 'PGcomposite (RowPG hask)

353

358

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

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

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

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

356-}

361-}

357newtype Enumerated enum = Enumerated {getEnumerated :: enum}

362newtype Enumerated enum = Enumerated {getEnumerated :: enum}

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

363+ deriving (Eq, Ord, Show, Read, GHC.Generic)

359− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

360−-- | `PGenum` @(@`LabelsPG` @hask)@

361type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)

364type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)

362

365

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

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

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

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

365−

366−>>> :kind! PG (VarArray (Vector Double))

367−PG (VarArray (Vector Double)) :: PGType

368−= 'PGvararray ('NotNull 'PGfloat8)

369-}

368-}

370newtype VarArray arr = VarArray {getVarArray :: arr}

369newtype VarArray arr = VarArray {getVarArray :: arr}

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

370+ deriving (Eq, Ord, Show, Read, GHC.Generic)

372− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

373−-- | `PGvararray` @(@`NullPG` @hask)@

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

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

375−type instance PG (VarArray [hask]) = 'PGvararray (NullPG hask)

376

372

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

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

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

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

379−

380−>>> :kind! PG (FixArray ((Double, Double), (Double, Double)))

381−PG (FixArray ((Double, Double), (Double, Double))) :: PGType

382−= 'PGfixarray '[2, 2] ('NotNull 'PGfloat8)

383-}

375-}

384newtype FixArray arr = FixArray {getFixArray :: arr}

376newtype FixArray arr = FixArray {getFixArray :: arr}

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

377+ deriving (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)

378+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

64 , resultErrorCode

65 -- * Exceptions

66 , SquealException (..)

67− , PQState (..)

68− , okResult

69 , catchSqueal

67 , catchSqueal

70 , handleSqueal

68 , handleSqueal

71− , trySqueal

72 ) where

69 ) where

74import Control.Exception (Exception, throw)

71import Control.Exception (Exception, throw)

75import Control.Monad.Except

72import Control.Monad.Except

76import Control.Monad.Morph

73import Control.Monad.Morph

77−import UnliftIO (MonadUnliftIO (..), bracket, catch, handle, try)

74+import UnliftIO (MonadUnliftIO (..), bracket, catch, handle)

78import Data.ByteString (ByteString)

75import Data.ByteString (ByteString)

79import Data.Foldable

76import Data.Foldable

80import Data.Function ((&))

77import Data.Function ((&))

81−import Data.Functor ((<&>))

82import Data.Kind

78import Data.Kind

83import Data.Text (pack, Text)

79import Data.Text (pack, Text)

84import Data.Traversable

80import Data.Traversable

@@ -87,7 +83,6 @@ import PostgreSQL.Binary.Encoding (encodingBytes)

88import qualified Control.Monad.Fail as Fail

84import qualified Control.Monad.Fail as Fail

89import qualified Database.PostgreSQL.LibPQ as LibPQ

85import qualified Database.PostgreSQL.LibPQ as LibPQ

90−import qualified PostgreSQL.Binary.Encoding as Encoding

92import Squeal.PostgreSQL.Binary

87import Squeal.PostgreSQL.Binary

93import Squeal.PostgreSQL.Definition

88import Squeal.PostgreSQL.Definition

@@ -248,16 +243,13 @@ class IndexedMonadTransPQ pq where

248 -> x -> pq schemas0 schemas2 m z

243 -> x -> pq schemas0 schemas2 m z

249 pqAndThen g f x = pqBind g (f x)

244 pqAndThen g f x = pqBind g (f x)

250

245

251− -- | Run a `Definition` with `LibPQ.exec`.

246+ -- | Run a `Definition` with `LibPQ.exec`, we expect that libpq obeys the law

252 --

247 --

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

257 define

249 define

258 :: MonadIO io

250 :: MonadIO io

259 => Definition schemas0 schemas1

251 => Definition schemas0 schemas1

260− -> pq schemas0 schemas1 io ()

252+ -> pq schemas0 schemas1 io (K LibPQ.Result '[])

261

253

262instance IndexedMonadTransPQ PQ where

254instance IndexedMonadTransPQ PQ where

263

255

@@ -275,7 +267,7 @@ instance IndexedMonadTransPQ PQ where

275 case resultMaybe of

267 case resultMaybe of

276 Nothing -> throw $ ResultException

268 Nothing -> throw $ ResultException

277 "define: LibPQ.exec returned no results"

269 "define: LibPQ.exec returned no results"

278− Just result -> K <$> okResult_ result

270+ Just result -> return $ K (K result)

279

271

280{- | `MonadPQ` is an @mtl@ style constraint, similar to

272{- | `MonadPQ` is an @mtl@ style constraint, similar to

281`Control.Monad.State.Class.MonadState`, for using `Database.PostgreSQL.LibPQ` to

273`Control.Monad.State.Class.MonadState`, for using `Database.PostgreSQL.LibPQ` to

@@ -284,12 +276,8 @@ instance IndexedMonadTransPQ PQ where

284 with a `ToParams` constraint. It calls `LibPQ.execParams` and

276 with a `ToParams` constraint. It calls `LibPQ.execParams` and

285 doesn't afraid of anything.

277 doesn't afraid of anything.

286

278

287−* `manipulateParams_` is like `manipulateParams` for a returning-free statement.

288−

289* `manipulate` is like `manipulateParams` for a parameter-free statement.

279* `manipulate` is like `manipulateParams` for a parameter-free statement.

290

280

291−* `manipulate_` is like `manipulate` for a returning-free statement.

292−

293* `runQueryParams` is like `manipulateParams` for query statements.

281* `runQueryParams` is like `manipulateParams` for query statements.

294

282

295* `runQuery` is like `runQueryParams` for a parameter-free statement.

283* `runQuery` is like `runQueryParams` for a parameter-free statement.

@@ -303,7 +291,7 @@ instance IndexedMonadTransPQ PQ where

303* `forPrepared` is a flipped `traversePrepared`

291* `forPrepared` is a flipped `traversePrepared`

304

292

305* `traversePrepared_` is like `traversePrepared` but works on `Foldable`

293* `traversePrepared_` is like `traversePrepared` but works on `Foldable`

306− containers for a returning-free statement.

294+ containers and returns unit.

307

295

308* `forPrepared_` is a flipped `traversePrepared_`.

296* `forPrepared_` is a flipped `traversePrepared_`.

309

297

@@ -317,34 +305,24 @@ a default instance.

317-}

305-}

318class Monad pq => MonadPQ schemas pq | pq -> schemas where

306class Monad pq => MonadPQ schemas pq | pq -> schemas where

319 manipulateParams

307 manipulateParams

320− :: (ToParams x params, All OidOfParam params)

308+ :: ToParams x params

321 => Manipulation '[] schemas params ys

309 => Manipulation '[] schemas params ys

322 -- ^ `insertInto`, `update` or `deleteFrom`

310 -- ^ `insertInto`, `update` or `deleteFrom`

323 -> x -> pq (K LibPQ.Result ys)

311 -> x -> pq (K LibPQ.Result ys)

324 default manipulateParams

312 default manipulateParams

325 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

313 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

326− => (ToParams x params, All OidOfParam params)

314+ => ToParams x params

327 => Manipulation '[] schemas params ys

315 => Manipulation '[] schemas params ys

328 -- ^ `insertInto`, `update` or `deleteFrom`

316 -- ^ `insertInto`, `update` or `deleteFrom`

329 -> x -> pq (K LibPQ.Result ys)

317 -> x -> pq (K LibPQ.Result ys)

330 manipulateParams manipulation params = lift $

318 manipulateParams manipulation params = lift $

331 manipulateParams manipulation params

319 manipulateParams manipulation params

332

320

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−

340 manipulate :: Manipulation '[] schemas '[] ys -> pq (K LibPQ.Result ys)

321 manipulate :: Manipulation '[] schemas '[] ys -> pq (K LibPQ.Result ys)

341 manipulate statement = manipulateParams statement ()

322 manipulate statement = manipulateParams statement ()

342

323

343− manipulate_ :: Manipulation '[] schemas '[] '[] -> pq ()

344− manipulate_ = void . manipulate

345−

346 runQueryParams

324 runQueryParams

347− :: (ToParams x params, All OidOfParam params)

325+ :: ToParams x params

348 => Query '[] '[] schemas params ys

326 => Query '[] '[] schemas params ys

349 -- ^ `select` and friends

327 -- ^ `select` and friends

350 -> x -> pq (K LibPQ.Result ys)

328 -> x -> pq (K LibPQ.Result ys)

@@ -357,19 +335,19 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

357 runQuery q = runQueryParams q ()

335 runQuery q = runQueryParams q ()

358

336

359 traversePrepared

337 traversePrepared

360− :: (ToParams x params, Traversable list, All OidOfParam params)

338+ :: (ToParams x params, Traversable list)

361 => Manipulation '[] schemas params ys

339 => Manipulation '[] schemas params ys

362 -- ^ `insertInto`, `update`, or `deleteFrom`, and friends

340 -- ^ `insertInto`, `update`, or `deleteFrom`, and friends

363 -> list x -> pq (list (K LibPQ.Result ys))

341 -> list x -> pq (list (K LibPQ.Result ys))

364 default traversePrepared

342 default traversePrepared

365 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

343 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

366− => (ToParams x params, Traversable list, All OidOfParam params)

344+ => (ToParams x params, Traversable list)

367 => Manipulation '[] schemas params ys -> list x -> pq (list (K LibPQ.Result ys))

345 => Manipulation '[] schemas params ys -> list x -> pq (list (K LibPQ.Result ys))

368 traversePrepared manipulation params = lift $

346 traversePrepared manipulation params = lift $

369 traversePrepared manipulation params

347 traversePrepared manipulation params

370

348

371 forPrepared

349 forPrepared

372− :: (ToParams x params, Traversable list, All OidOfParam params)

350+ :: (ToParams x params, Traversable list)

373 => list x

351 => list x

374 -> Manipulation '[] schemas params ys

352 -> Manipulation '[] schemas params ys

375 -- ^ `insertInto`, `update` or `deleteFrom`

353 -- ^ `insertInto`, `update` or `deleteFrom`

@@ -377,13 +355,13 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

377 forPrepared = flip traversePrepared

355 forPrepared = flip traversePrepared

378

356

379 traversePrepared_

357 traversePrepared_

380− :: (ToParams x params, Foldable list, All OidOfParam params)

358+ :: (ToParams x params, Foldable list)

381 => Manipulation '[] schemas params '[]

359 => Manipulation '[] schemas params '[]

382 -- ^ `insertInto`, `update` or `deleteFrom`

360 -- ^ `insertInto`, `update` or `deleteFrom`

383 -> list x -> pq ()

361 -> list x -> pq ()

384 default traversePrepared_

362 default traversePrepared_

385 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

363 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

386− => (ToParams x params, Foldable list, All OidOfParam params)

364+ => (ToParams x params, Foldable list)

387 => Manipulation '[] schemas params '[]

365 => Manipulation '[] schemas params '[]

388 -- ^ `insertInto`, `update` or `deleteFrom`

366 -- ^ `insertInto`, `update` or `deleteFrom`

389 -> list x -> pq ()

367 -> list x -> pq ()

@@ -391,7 +369,7 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

391 traversePrepared_ manipulation params

369 traversePrepared_ manipulation params

392

370

393 forPrepared_

371 forPrepared_

394− :: (ToParams x params, Foldable list, All OidOfParam params)

372+ :: (ToParams x params, Foldable list)

395 => list x

373 => list x

396 -> Manipulation '[] schemas params '[]

374 -> Manipulation '[] schemas params '[]

397 -- ^ `insertInto`, `update` or `deleteFrom`

375 -- ^ `insertInto`, `update` or `deleteFrom`

@@ -411,76 +389,54 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

411 (UnsafeManipulation q :: Manipulation '[] schemas ps ys) (params :: x) =

389 (UnsafeManipulation q :: Manipulation '[] schemas ps ys) (params :: x) =

412 PQ $ \ (K conn) -> do

390 PQ $ \ (K conn) -> do

413 let

391 let

414− paramSet

392+ toParam' encoding =

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)

393+ (LibPQ.invalidOid, encodingBytes encoding, LibPQ.Binary)

421− params'

422− = hcollapse

423− . hcmap (Proxy @OidOfParam) paramSet

424− $ toParams @x @ps params

394+ params' = fmap (fmap toParam') (hcollapse (toParams @x @ps params))

425 q' = q <> ";"

395 q' = q <> ";"

426 resultMaybe <- liftIO $ LibPQ.execParams conn q' params' LibPQ.Binary

396 resultMaybe <- liftIO $ LibPQ.execParams conn q' params' LibPQ.Binary

427 case resultMaybe of

397 case resultMaybe of

428 Nothing -> throw $ ResultException

398 Nothing -> throw $ ResultException

429 "manipulateParams: LibPQ.execParams returned no results"

399 "manipulateParams: LibPQ.execParams returned no results"

430 Just result -> do

400 Just result -> do

431− okResult_ result

401+ tryResult result

432 return $ K (K result)

402 return $ K (K result)

433

403

434 traversePrepared

404 traversePrepared

435 (UnsafeManipulation q :: Manipulation '[] schemas xs ys) (list :: list x) =

405 (UnsafeManipulation q :: Manipulation '[] schemas xs ys) (list :: list x) =

436 PQ $ \ (K conn) -> liftIO $ do

406 PQ $ \ (K conn) -> liftIO $ do

437− let

438− temp = "temporary_statement"

407+ let 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')

408+ prepResultMaybe <- LibPQ.prepare conn temp q Nothing

446 case prepResultMaybe of

409 case prepResultMaybe of

447 Nothing -> throw $ ResultException

410 Nothing -> throw $ ResultException

448 "traversePrepared: LibPQ.prepare returned no results"

411 "traversePrepared: LibPQ.prepare returned no results"

449− Just prepResult -> okResult_ prepResult

412+ Just prepResult -> tryResult prepResult

450 results <- for list $ \ params -> do

413 results <- for list $ \ params -> do

451 let

414 let

452− toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

415+ toParam' encoding = (encodingBytes encoding,LibPQ.Binary)

453 params' = fmap (fmap toParam') (hcollapse (toParams @x @xs params))

416 params' = fmap (fmap toParam') (hcollapse (toParams @x @xs params))

454 resultMaybe <- LibPQ.execPrepared conn temp params' LibPQ.Binary

417 resultMaybe <- LibPQ.execPrepared conn temp params' LibPQ.Binary

455 case resultMaybe of

418 case resultMaybe of

456 Nothing -> throw $ ResultException

419 Nothing -> throw $ ResultException

457 "traversePrepared: LibPQ.execParams returned no results"

420 "traversePrepared: LibPQ.execParams returned no results"

458 Just result -> do

421 Just result -> do

459− okResult_ result

422+ tryResult result

460 return $ K result

423 return $ K result

461 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

424 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

462 case deallocResultMaybe of

425 case deallocResultMaybe of

463 Nothing -> throw $ ResultException

426 Nothing -> throw $ ResultException

464 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

427 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

465− Just deallocResult -> okResult_ deallocResult

428+ Just deallocResult -> tryResult deallocResult

466 return (K results)

429 return (K results)

467

430

468 traversePrepared_

431 traversePrepared_

469 (UnsafeManipulation q :: Manipulation '[] schemas xs '[]) (list :: list x) =

432 (UnsafeManipulation q :: Manipulation '[] schemas xs '[]) (list :: list x) =

470 PQ $ \ (K conn) -> liftIO $ do

433 PQ $ \ (K conn) -> liftIO $ do

471− let

472− temp = "temporary_statement"

434+ let 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')

435+ prepResultMaybe <- LibPQ.prepare conn temp q Nothing

480 case prepResultMaybe of

436 case prepResultMaybe of

481 Nothing -> throw $ ResultException

437 Nothing -> throw $ ResultException

482 "traversePrepared_: LibPQ.prepare returned no results"

438 "traversePrepared_: LibPQ.prepare returned no results"

483− Just prepResult -> okResult_ prepResult

439+ Just prepResult -> tryResult prepResult

484 for_ list $ \ params -> do

440 for_ list $ \ params -> do

485 let

441 let

486 toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

442 toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

@@ -489,12 +445,12 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

489 case resultMaybe of

445 case resultMaybe of

490 Nothing -> throw $ ResultException

446 Nothing -> throw $ ResultException

491 "traversePrepared_: LibPQ.execParams returned no results"

447 "traversePrepared_: LibPQ.execParams returned no results"

492− Just result -> okResult_ result

448+ Just result -> tryResult result

493 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

449 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

494 case deallocResultMaybe of

450 case deallocResultMaybe of

495 Nothing -> throw $ ResultException

451 Nothing -> throw $ ResultException

496 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

452 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

497− Just deallocResult -> okResult_ deallocResult

453+ Just deallocResult -> tryResult deallocResult

498 return (K ())

454 return (K ())

499

455

500 liftPQ pq = PQ $ \ (K conn) -> do

456 liftPQ pq = PQ $ \ (K conn) -> do

@@ -657,24 +613,24 @@ resultErrorCode

657 -> io (Maybe ByteString)

613 -> io (Maybe ByteString)

658resultErrorCode = liftResult (flip LibPQ.resultErrorField LibPQ.DiagSqlstate)

614resultErrorCode = liftResult (flip LibPQ.resultErrorField LibPQ.DiagSqlstate)

659

615

660−-- | the state of LibPQ

616+-- | `Exception`s that can be thrown by Squeal.

661−data PQState = PQState

617+data SquealException

618+ = PQException

662 { sqlExecStatus :: LibPQ.ExecStatus

619 { sqlExecStatus :: LibPQ.ExecStatus

663 , sqlStateCode :: Maybe ByteString

620 , sqlStateCode :: Maybe ByteString

664 -- ^ https://www.postgresql.org/docs/current/static/errcodes-appendix.html

621 -- ^ https://www.postgresql.org/docs/current/static/errcodes-appendix.html

665 , sqlErrorMessage :: Maybe ByteString

622 , sqlErrorMessage :: Maybe ByteString

666− } deriving (Eq, Show)

623+ }

667−

668−-- | `Exception`s that can be thrown by Squeal.

669−data SquealException

670− = PQException PQState

671 | ResultException Text

624 | ResultException Text

672 | ParseException Text

625 | ParseException Text

673 deriving (Eq, Show)

626 deriving (Eq, Show)

674instance Exception SquealException

627instance Exception SquealException

675

628

629+tryResult

630+ :: MonadIO io

676−okResult_ :: MonadIO io => LibPQ.Result -> io ()

631+ => LibPQ.Result

632+ -> io ()

677−okResult_ result = liftIO $ do

633+tryResult result = liftIO $ do

678 status <- LibPQ.resultStatus result

634 status <- LibPQ.resultStatus result

679 case status of

635 case status of

680 LibPQ.CommandOk -> return ()

636 LibPQ.CommandOk -> return ()

@@ -682,12 +638,7 @@ okResult_ result = liftIO $ do

682 _ -> do

638 _ -> do

683 stateCode <- LibPQ.resultErrorField result LibPQ.DiagSqlstate

639 stateCode <- LibPQ.resultErrorField result LibPQ.DiagSqlstate

684 msg <- LibPQ.resultErrorMessage result

640 msg <- LibPQ.resultErrorMessage result

685− throw . PQException $ PQState status stateCode msg

641+ throw $ PQException 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

691

642

692-- | Catch `SquealException`s.

643-- | Catch `SquealException`s.

693catchSqueal

644catchSqueal

@@ -703,10 +654,3 @@ handleSqueal

703 => (SquealException -> io a) -- ^ handler

654 => (SquealException -> io a) -- ^ handler

704 -> io a -> io a

655 -> io a -> io a

705handleSqueal = handle

656handleSqueal = 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 @@

1{-|

2−Module: Squeal.PostgreSQL.Pool

2+Module: Squeal.PostgreSQL.Definition

3−Description: Connection pools

3+Description: Pooled connections

4Copyright: (c) Eitan Chatav, 2017

5Maintainer: eitan@morphism.tech

6Stability: experimental

8−Connection pools.

8+A `MonadPQ` for pooled connections.

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

31-}

9-}

33{-# LANGUAGE

11{-# LANGUAGE

@@ -45,19 +23,51 @@ a

46module Squeal.PostgreSQL.Pool

24module Squeal.PostgreSQL.Pool

47 ( -- * Pools

25 ( -- * Pools

48− Pool

26+ PoolPQ (..)

49 , createConnectionPool

27 , createConnectionPool

50− , usingConnectionPool

28+ , Pool

51− , destroyConnectionPool

29+ , destroyAllResources

52 ) where

30 ) where

32+import Control.Monad.Trans

54import Data.ByteString

33import Data.ByteString

55import Data.Time

34import Data.Time

56−import Generics.SOP (K(..), unK)

35+import Generics.SOP (K(..))

57import UnliftIO (MonadUnliftIO (..))

36import UnliftIO (MonadUnliftIO (..))

58import UnliftIO.Pool (Pool, createPool, destroyAllResources, withResource)

37import UnliftIO.Pool (Pool, createPool, destroyAllResources, withResource)

39+import qualified Control.Monad.Fail as Fail

40+

60import Squeal.PostgreSQL.PQ

41import 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

62-- | Create a striped pool of connections.

72-- | Create a striped pool of connections.

63-- Although the garbage collector will destroy all idle connections when the pool is garbage collected it's recommended to manually `destroyAllResources` when you're done with the pool so that the connections are freed up as soon as possible.

73-- Although the garbage collector will destroy all idle connections when the pool is garbage collected it's recommended to manually `destroyAllResources` when you're done with the pool so that the connections are freed up as soon as possible.

@@ -82,41 +92,63 @@ createConnectionPool

82createConnectionPool conninfo stripes idle maxResrc =

92createConnectionPool conninfo stripes idle maxResrc =

83 createPool (connectdb conninfo) finish stripes idle maxResrc

93 createPool (connectdb conninfo) finish stripes idle maxResrc

85−{-|

95+-- | `Applicative` instance for `PoolPQ`.

86−Temporarily take a connection from a `Pool`, perform an action with it,

96+instance Monad m => Applicative (PoolPQ schemas m) where

87−and return it to the pool afterwards.

97+ pure x = PoolPQ $ \ _ -> pure x

88−

98+ PoolPQ f <*> PoolPQ x = PoolPQ $ \ pool -> do

89−If the pool has an idle connection available, it is used immediately.

99+ f' <- f pool

90−Otherwise, if the maximum number of connections has not yet been reached,

100+ x' <- x pool

91−a new connection is created and used.

101+ return $ f' x'

92−If the maximum number of connections has been reached, this function blocks

102+

93−until a connection becomes available.

103+-- | `Monad` instance for `PoolPQ`.

94−-}

104+instance Monad m => Monad (PoolPQ schemas m) where

95−usingConnectionPool

105+ return = pure

96− :: MonadUnliftIO io

106+ PoolPQ x >>= f = PoolPQ $ \ pool -> do

97− => Pool (K Connection schemas) -- ^ pool

107+ x' <- x pool

98− -> PQ schemas schemas io x -- ^ session

108+ runPoolPQ (f x') pool

99− -> io x

109+

100−usingConnectionPool pool (PQ session) = unK <$> withResource pool session

110+-- | `Fail.MonadFail` instance for `PoolPQ`.

101−

111+instance Monad m => Fail.MonadFail (PoolPQ schemas m) where

102−{- |

112+ fail = Fail.fail

103−Destroy all connections in all stripes in the pool.

113+

104−Note that this will ignore any exceptions in the destroy function.

114+-- | `MonadTrans` instance for `PoolPQ`.

105−

115+instance MonadTrans (PoolPQ schemas) where

106−This function is useful when you detect that all connections

116+ lift m = PoolPQ $ \ _pool -> m

107−in the pool are broken. For example after a database has been

117+

108−restarted all connections opened before the restart will be broken.

118+-- | `MonadPQ` instance for `PoolPQ`.

109−In that case it's better to close those connections so that

119+instance MonadUnliftIO io => MonadPQ schemas (PoolPQ schemas io) where

110−`usingConnectionPool` won't take a broken connection from the pool

120+ manipulateParams manipulation params = PoolPQ $ \ pool -> do

111−but will open a new connection instead.

121+ withResource pool $ \ conn -> do

112−

122+ (K result :: K (K Result ys) schemas) <- flip unPQ conn $

113−Another use-case for this function is that when you know you are done

123+ manipulateParams manipulation params

114−with the pool you can destroy all idle connections immediately

124+ return result

115−instead of waiting on the garbage collector to destroy them,

125+ traversePrepared manipulation params = PoolPQ $ \ pool ->

116−thus freeing up those connections sooner.

126+ withResource pool $ \ conn -> do

117−-}

127+ (K result :: K (list (K Result ys)) schemas) <- flip unPQ conn $

118−destroyConnectionPool

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+

119− :: MonadUnliftIO io

146+-- | 'MonadUnliftIO' instance for 'PoolPQ'.

120− => Pool (K Connection schemas) -- ^ pool

147+instance (MonadUnliftIO m)

121− -> io ()

148+ => MonadUnliftIO (PoolPQ schemas m) where

122−destroyConnectionPool = destroyAllResources

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+370−247

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

1{-|

2Module: Squeal.PostgreSQL.Query

3Description: Squeal queries

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

5Maintainer: eitan@morphism.tech

6Stability: experimental

@@ -32,15 +32,13 @@ Squeal queries.

33module Squeal.PostgreSQL.Query

34 ( -- * Queries

35− Query_

35+ Query (..)

36− , Query (..)

36+ , Query_

37 -- ** Select

38 , select

39 , select_

40 , selectDistinct

41 , selectDistinct_

42− , selectDistinctOn

43− , selectDistinctOn_

44 , Selection (..)

42 , Selection (..)

45 -- ** Values

43 -- ** Values

46 , values

44 , values

@@ -55,7 +53,23 @@ module Squeal.PostgreSQL.Query

55 -- ** With

53 -- ** With

56 , With (..)

54 , With (..)

57 , CommonTableExpression (..)

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

59 -- * Table Expressions

73 -- * Table Expressions

60 , TableExpression (..)

74 , TableExpression (..)

61 , from

75 , from

@@ -79,6 +93,13 @@ module Squeal.PostgreSQL.Query

79 , By (..)

93 , By (..)

80 , GroupByClause (..)

94 , GroupByClause (..)

81 , HavingClause (..)

95 , HavingClause (..)

96+ -- * Subquery Expressions

97+ , exists

98+ , in_

99+ , notIn

100+ , Operator

101+ , subAll

102+ , subAny

82 ) where

103 ) where

104

84import Control.DeepSeq

105import Control.DeepSeq

@@ -103,55 +124,10 @@ import Squeal.PostgreSQL.Schema

103

124

104-- $setup

125-- $setup

105-- >>> import Squeal.PostgreSQL

126-- >>> import Squeal.PostgreSQL

106−-- >>> import Data.Int (Int32, Int64)

107−-- >>> import Data.Monoid (Sum (..))

108−-- >>> import Data.Text (Text)

109−-- >>> import qualified Generics.SOP as SOP

110

127

111{- |

128{- |

112−The process of retrieving or the command to retrieve data from

129+The process of retrieving or the command to retrieve data from a database

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.

130+is called a `Query`. 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−:}

155

131

156simple query:

132simple query:

157

133

@@ -159,7 +135,7 @@ simple query:

159>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

135>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

160>>> :{

136>>> :{

161let

137let

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

138+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

163 query = select Star (from (table #tab))

139 query = select Star (from (table #tab))

164in printSQL query

140in printSQL query

165:}

141:}

@@ -169,21 +145,21 @@ restricted query:

169

145

170>>> :{

146>>> :{

171let

147let

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

148+ query :: Query '[] '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4]

173 query =

149 query =

174− select_ ((#col1 + #col2) `as` #col1 :* #col1 `as` #col2)

150+ select_ ((#col1 + #col2) `as` #sum :* #col1)

175 ( from (table #tab)

151 ( from (table #tab)

176 & where_ (#col1 .> #col2)

152 & where_ (#col1 .> #col2)

177 & where_ (#col2 .> 0) )

153 & where_ (#col2 .> 0) )

178in printSQL query

154in printSQL query

179:}

155:}

180−SELECT ("col1" + "col2") AS "col1", "col1" AS "col2" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))

156+SELECT ("col1" + "col2") AS "sum", "col1" AS "col1" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))

181

157

182subquery:

158subquery:

183

159

184>>> :{

160>>> :{

185let

161let

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

162+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

187 query = select Star (from (subquery (select Star (from (table #tab)) `as` #sub)))

163 query = select Star (from (subquery (select Star (from (table #tab)) `as` #sub)))

188in printSQL query

164in printSQL query

189:}

165:}

@@ -193,7 +169,7 @@ limits and offsets:

193

169

194>>> :{

170>>> :{

195let

171let

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

172+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

197 query = select Star (from (table #tab) & limit 100 & offset 2 & limit 50 & offset 2)

173 query = select Star (from (table #tab) & limit 100 & offset 2 & limit 50 & offset 2)

198in printSQL query

174in printSQL query

199:}

175:}

@@ -203,7 +179,7 @@ parameterized query:

203

179

204>>> :{

180>>> :{

205let

181let

206− query :: Query_ (Public Schema) (Only Int32) (Row Int32 Int32)

182+ query :: Query '[] '[] (Public Schema) '[ 'NotNull 'PGint4] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

207 query = select Star (from (table #tab) & where_ (#col1 .> param @1))

183 query = select Star (from (table #tab) & where_ (#col1 .> param @1))

208in printSQL query

184in printSQL query

209:}

185:}

@@ -213,21 +189,21 @@ aggregation query:

213

189

214>>> :{

190>>> :{

215let

191let

216− query :: Query_ (Public Schema) () (Row Int64 Int32)

192+ query :: Query '[] '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4 ]

217 query =

193 query =

218− select_ ((fromNull 0 (sum_ (All #col2))) `as` #col1 :* #col1 `as` #col2)

194+ select_ (sum_ (All #col2) `as` #sum :* #col1)

219 ( from (table (#tab `as` #table1))

195 ( from (table (#tab `as` #table1))

220 & groupBy #col1

196 & groupBy #col1

221− & having (sum_ (Distinct #col2) .> 1) )

197+ & having (#col1 + sum_ (Distinct #col2) .> 1) )

222in printSQL query

198in printSQL query

223:}

199:}

224−SELECT COALESCE(sum(ALL "col2"), 0) AS "col1", "col1" AS "col2" FROM "tab" AS "table1" GROUP BY "col1" HAVING (sum(DISTINCT "col2") > 1)

200+SELECT sum(ALL "col2") AS "sum", "col1" AS "col1" FROM "tab" AS "table1" GROUP BY "col1" HAVING (("col1" + sum(DISTINCT "col2")) > 1)

225

201

226sorted query:

202sorted query:

227

203

228>>> :{

204>>> :{

229let

205let

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

206+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

231 query = select Star (from (table #tab) & orderBy [#col1 & Asc])

207 query = select Star (from (table #tab) & orderBy [#col1 & Asc])

232in printSQL query

208in printSQL query

233:}

209:}

@@ -235,12 +211,14 @@ SELECT * FROM "tab" AS "tab" ORDER BY "col1" ASC

235

211

236joins:

212joins:

237

213

214+>>> :set -XFlexibleContexts

238>>> :{

215>>> :{

239type OrdersColumns =

216type OrdersColumns =

240 '[ "id" ::: 'NoDef :=> 'NotNull 'PGint4

217 '[ "id" ::: 'NoDef :=> 'NotNull 'PGint4

241− , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

218+ , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

242− , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

219+ , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

243− , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4 ]

220+ , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4

221+ ]

244:}

222:}

245

223

246>>> :{

224>>> :{

@@ -256,27 +234,22 @@ type OrdersConstraints =

256>>> :{

234>>> :{

257type OrdersSchema =

235type OrdersSchema =

258 '[ "orders" ::: 'Table (OrdersConstraints :=> OrdersColumns)

236 '[ "orders" ::: 'Table (OrdersConstraints :=> OrdersColumns)

259− , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

237+ , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

260− , "shippers" ::: 'Table (ShippersConstraints :=> NamesColumns) ]

238+ , "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

271:}

239:}

272

240

273>>> :{

241>>> :{

274let

242let

275− query :: Query_ (Public OrdersSchema) () Order

243+ query :: Query '[] '[] (Public OrdersSchema)

244+ '[]

245+ '[ "order_price" ::: 'NotNull 'PGfloat4

246+ , "customer_name" ::: 'NotNull 'PGtext

247+ , "shipper_name" ::: 'NotNull 'PGtext

248+ ]

276 query = select_

249 query = select_

277− ( #o ! #price `as` #price :*

250+ ( #o ! #price `as` #order_price :*

278− #c ! #name `as` #customerName :*

251+ #c ! #name `as` #customer_name :*

279− #s ! #name `as` #shipperName )

252+ #s ! #name `as` #shipper_name )

280 ( from (table (#orders `as` #o)

253 ( from (table (#orders `as` #o)

281 & innerJoin (table (#customers `as` #c))

254 & innerJoin (table (#customers `as` #c))

282 (#o ! #customer_id .== #c ! #id)

255 (#o ! #customer_id .== #c ! #id)

@@ -284,16 +257,14 @@ let

284 (#o ! #shipper_id .== #s ! #id)) )

257 (#o ! #shipper_id .== #s ! #id)) )

285in printSQL query

258in printSQL query

286:}

259:}

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

260+SELECT "o"."price" AS "order_price", "c"."name" AS "customer_name", "s"."name" AS "shipper_name" FROM "orders" AS "o" INNER JOIN "customers" AS "c" ON ("o"."customer_id" = "c"."id") INNER JOIN "shippers" AS "s" ON ("o"."shipper_id" = "s"."id")

288

261

289self-join:

262self-join:

290

263

291>>> :{

264>>> :{

292let

265let

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

266+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

294− query = select

295− (#t1 & DotStar)

296− (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

267+ query = select (#t1 & DotStar) (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

297in printSQL query

268in printSQL query

298:}

269:}

299SELECT "t1".* FROM "tab" AS "t1" CROSS JOIN "tab" AS "t2"

270SELECT "t1".* FROM "tab" AS "t1" CROSS JOIN "tab" AS "t2"

@@ -302,19 +273,17 @@ value queries:

302

273

303>>> :{

274>>> :{

304let

275let

305− query :: Query_ schemas () (Row String Bool)

276+ query :: Query '[] commons schemas '[] '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

306− query = values

277+ query = values (1 `as` #foo :* true `as` #bar) [2 `as` #foo :* false `as` #bar]

307− ("true" `as` #col1 :* true `as` #col2)

308− ["false" `as` #col1 :* false `as` #col2]

309in printSQL query

278in printSQL query

310:}

279:}

311−SELECT * FROM (VALUES (E'true', TRUE), (E'false', FALSE)) AS t ("col1", "col2")

280+SELECT * FROM (VALUES (1, TRUE), (2, FALSE)) AS t ("foo", "bar")

312

281

313set operations:

282set operations:

314

283

315>>> :{

284>>> :{

316let

285let

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

286+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

318 query = select Star (from (table #tab)) `unionAll` select Star (from (table #tab))

287 query = select Star (from (table #tab)) `unionAll` select Star (from (table #tab))

319in printSQL query

288in printSQL query

320:}

289:}

@@ -324,7 +293,7 @@ with queries:

324

293

325>>> :{

294>>> :{

326let

295let

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

296+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

328 query = with (

297 query = with (

329 select Star (from (table #tab)) `as` #cte1 :>>

298 select Star (from (table #tab)) `as` #cte1 :>>

330 select Star (from (common #cte1)) `as` #cte2

299 select Star (from (common #cte1)) `as` #cte2

@@ -337,35 +306,40 @@ window function queries

337

306

338>>> :{

307>>> :{

339let

308let

340− query :: Query_ (Public Schema) () (Row Int32 Int64)

309+ query :: Query '[] '[] (Public Schema) '[] ["col1" ::: 'NotNull 'PGint4, "rank" ::: 'NotNull 'PGint8]

341 query = select

310 query = select

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

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

343 (from (table #tab))

312 (from (table #tab))

344in printSQL query

313in printSQL query

345:}

314:}

346−SELECT "col1" AS "col1", rank() OVER (PARTITION BY "col1" ORDER BY "col2" ASC) AS "col2" FROM "tab" AS "tab"

315+SELECT "col1" AS "col1", rank() OVER (PARTITION BY "col1" ORDER BY "col2" ASC) AS "rank" FROM "tab" AS "tab"

347

316

348correlated subqueries

317correlated subqueries

349

318

350>>> :{

319>>> :{

351let

320let

352− query :: Query_ (Public Schema) () (Only Int32)

321+ query :: Query '[] '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4]

353 query =

322 query =

354− select (#col1 `as` #fromOnly) (from (table (#tab `as` #t1))

323+ select #col1 (from (table (#tab `as` #t1))

355 & where_ (exists (

324 & where_ (exists (

356 select Star (from (table (#tab `as` #t2))

325 select Star (from (table (#tab `as` #t2))

357 & where_ (#t2 ! #col2 .== #t1 ! #col1)))))

326 & where_ (#t2 ! #col2 .== #t1 ! #col1)))))

358in printSQL query

327in printSQL query

359:}

328:}

360−SELECT "col1" AS "fromOnly" FROM "tab" AS "t1" WHERE EXISTS (SELECT * FROM "tab" AS "t2" WHERE ("t2"."col2" = "t1"."col1"))

329+SELECT "col1" AS "col1" FROM "tab" AS "t1" WHERE EXISTS (SELECT * FROM "tab" AS "t2" WHERE ("t2"."col2" = "t1"."col1"))

361−

362-}

330-}

363−type family Query_

331+newtype Query

332+ (outer :: FromType)

333+ (commons :: FromType)

364 (schemas :: SchemasType)

334 (schemas :: SchemasType)

365− (parameters :: Type)

335+ (params :: [NullityType])

366− (row :: Type) where

336+ (row :: RowType)

367− Query_ schemas params row =

337+ = UnsafeQuery { renderQuery :: ByteString }

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

339+instance RenderSQL (Query outer commons schemas params row) where renderSQL = renderQuery

340+

341+type family Query_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

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

342+ Query_ schemas params row = Query '[] '[] schemas (TuplePG params) (RowPG row)

369

343

370-- | The results of two queries can be combined using the set operation

344-- | The results of two queries can be combined using the set operation

371-- `union`. Duplicate rows are eliminated.

345-- `union`. Duplicate rows are eliminated.

@@ -437,40 +411,27 @@ q1 `exceptAll` q2 = UnsafeQuery $

437SELECT queries

411SELECT queries

438-----------------------------------------}

412-----------------------------------------}

439

413

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

446data Selection outer commons grp schemas params from row where

414data Selection outer commons grp schemas params from row where

415+ List

416+ :: SListI row

417+ => NP (Aliased (Expression outer commons grp schemas params from)) row

418+ -> Selection outer commons grp schemas params from row

447 Star

419 Star

448 :: HasUnique tab from row

420 :: HasUnique tab from row

449 => Selection outer commons 'Ungrouped schemas params from row

421 => Selection outer commons 'Ungrouped schemas params from row

450− -- ^ `HasUnique` table in the `FromClause`

451 DotStar

422 DotStar

452 :: Has tab from row

423 :: Has tab from row

453 => Alias tab

424 => Alias tab

454− -- ^ `Has` table with `Alias`

455 -> Selection outer commons 'Ungrouped schemas params from row

425 -> Selection outer commons 'Ungrouped schemas params from row

456− List

426+ Also

457− :: SListI row

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

427+ :: Selection outer commons grp schemas params from right

459− -- ^ `NP` list of `Aliased` `Expression`s

428+ -> Selection outer commons grp schemas params from left

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

429+ -> Selection outer commons grp schemas params from (Join left right)

461 Over

430 Over

462 :: SListI row

431 :: SListI row

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

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

464− -- ^ `NP` list of `Aliased` `WindowFunction`s

465 -> WindowDefinition outer commons grp schemas params from

433 -> WindowDefinition outer commons grp schemas params from

466 -> Selection outer commons grp schemas params from row

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

474instance (KnownSymbol col, row ~ '[col ::: ty])

435instance (KnownSymbol col, row ~ '[col ::: ty])

475 => Aliasable col

436 => Aliasable col

476 (Expression outer commons grp schemas params from ty)

437 (Expression outer commons grp schemas params from ty)

@@ -530,7 +491,7 @@ instance IsString

530select

491select

531 :: (SListI row, row ~ (x ': xs))

492 :: (SListI row, row ~ (x ': xs))

532 => Selection outer commons grp schemas params from row

493 => Selection outer commons grp schemas params from row

533− -- ^ selection

494+ -- ^ select list

534 -> TableExpression outer commons grp schemas params from

495 -> TableExpression outer commons grp schemas params from

535 -- ^ intermediate virtual table

496 -- ^ intermediate virtual table

536 -> Query outer commons schemas params row

497 -> Query outer commons schemas params row

@@ -539,24 +500,20 @@ select selection tabexpr = UnsafeQuery $

539 <+> renderSQL selection

500 <+> renderSQL selection

540 <+> renderSQL tabexpr

501 <+> renderSQL tabexpr

541

502

542−-- | Like `select` but takes an `NP` list of `Expression`s instead

543−-- of a general `Selection`.

544select_

503select_

545 :: (SListI row, row ~ (x ': xs))

504 :: (SListI row, row ~ (x ': xs))

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

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

547− -- ^ select list

548 -> TableExpression outer commons grp schemas params from

506 -> TableExpression outer commons grp schemas params from

549− -- ^ intermediate virtual table

550 -> Query outer commons schemas params row

507 -> Query outer commons schemas params row

551−select_ = select . List

508+select_ list = select (List list)

552

509

553-- | After the select list has been processed, the result table can

510-- | After the select list has been processed, the result table can

554-- be subject to the elimination of duplicate rows using `selectDistinct`.

511-- be subject to the elimination of duplicate rows using `selectDistinct`.

555selectDistinct

512selectDistinct

556 :: (SListI columns, columns ~ (col ': cols))

513 :: (SListI columns, columns ~ (col ': cols))

557− => Selection outer commons grp schemas params from columns

514+ => Selection outer commons 'Ungrouped schemas params from columns

558− -- ^ selection

515+ -- ^ select list

559− -> TableExpression outer commons grp schemas params from

516+ -> TableExpression outer commons 'Ungrouped schemas params from

560 -- ^ intermediate virtual table

517 -- ^ intermediate virtual table

561 -> Query outer commons schemas params columns

518 -> Query outer commons schemas params columns

562selectDistinct selection tabexpr = UnsafeQuery $

519selectDistinct selection tabexpr = UnsafeQuery $

@@ -564,65 +521,14 @@ selectDistinct selection tabexpr = UnsafeQuery $

564 <+> renderSQL selection

521 <+> renderSQL selection

565 <+> renderSQL tabexpr

522 <+> renderSQL tabexpr

566

523

567−-- | Like `selectDistinct` but takes an `NP` list of `Expression`s instead

568−-- of a general `Selection`.

569selectDistinct_

524selectDistinct_

570 :: (SListI columns, columns ~ (col ': cols))

525 :: (SListI columns, columns ~ (col ': cols))

571− => NP (Aliased (Expression outer commons grp schemas params from)) columns

526+ => NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns

572 -- ^ select list

527 -- ^ select list

573− -> TableExpression outer commons grp schemas params from

528+ -> TableExpression outer commons 'Ungrouped 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

623 -- ^ intermediate virtual table

529 -- ^ intermediate virtual table

624 -> Query outer commons schemas params columns

530 -> Query outer commons schemas params columns

625−selectDistinctOn_ distincts = selectDistinctOn distincts . List

531+selectDistinct_ list = select (List list)

626

532

627-- | `values` computes a row value or set of row values

533-- | `values` computes a row value or set of row values

628-- specified by value expressions. It is most commonly used

534-- specified by value expressions. It is most commonly used

@@ -757,7 +663,7 @@ instance RenderSQL (TableExpression outer commons grp schemas params from) where

757from

663from

758 :: FromClause outer commons schemas params from -- ^ table reference

664 :: FromClause outer commons schemas params from -- ^ table reference

759 -> TableExpression outer commons 'Ungrouped schemas params from

665 -> TableExpression outer commons 'Ungrouped schemas params from

760−from tab = TableExpression tab [] noGroups NoHaving [] [] []

666+from tab = TableExpression tab [] NoGroups NoHaving [] [] []

761

667

762-- | A `where_` is an endomorphism of `TableExpression`s which adds a

668-- | A `where_` is an endomorphism of `TableExpression`s which adds a

763-- search condition to the `whereClause`.

669-- search condition to the `whereClause`.

@@ -778,7 +684,7 @@ groupBy

778groupBy bys rels = TableExpression

684groupBy bys rels = TableExpression

779 { fromClause = fromClause rels

685 { fromClause = fromClause rels

780 , whereClause = whereClause rels

686 , whereClause = whereClause rels

781− , groupByClause = group bys

687+ , groupByClause = Group bys

782 , havingClause = Having []

688 , havingClause = Having []

783 , orderByClause = []

689 , orderByClause = []

784 , limitClause = limitClause rels

690 , limitClause = limitClause rels

@@ -813,6 +719,170 @@ offset

813 -> TableExpression outer commons grp schemas params from

719 -> TableExpression outer commons grp schemas params from

814offset off rels = rels {offsetClause = off : offsetClause rels}

720offset off rels = rels {offsetClause = off : offsetClause rels}

815

721

722+{-----------------------------------------

723+JSON stuff

724+-----------------------------------------}

725+

726+unsafeSetOfFunction

727+ :: ByteString

728+ -> Expression outer commons 'Ungrouped schemas params '[] ty

729+ -> FromClause outer commons schemas params from

730+unsafeSetOfFunction fun expr = UnsafeFromClause $

731+ fun <> "(" <> renderSQL expr <> ")"

732+

733+-- | Expand an array to a set of rows

734+unnest

735+ :: Expression outer commons 'Ungrouped schemas params '[] (nullity ('PGvararray ty))

736+ -> FromClause outer commons schemas params '["unnest" ::: '["unnest" ::: ty]]

737+unnest = unsafeSetOfFunction "unnest"

738+

739+-- | Expands the outermost JSON object into a set of key/value pairs.

740+-- >>> import Data.Aeson

741+-- >>> printSQL (select Star (from (jsonEach (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))

742+-- SELECT * FROM json_each(('{"a":"foo","b":"bar"}' :: json))

743+jsonEach

744+ :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

745+ -> FromClause outer commons schemas params

746+ '["json_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]]

747+jsonEach = unsafeSetOfFunction "json_each"

748+

749+-- | Expands the outermost binary JSON object into a set of key/value pairs.

750+-- >>> import Data.Aeson

751+-- >>> printSQL (select Star (from (jsonbEach (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))

752+-- SELECT * FROM jsonb_each(('{"a":"foo","b":"bar"}' :: jsonb))

753+jsonbEach

754+ :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

755+ -> FromClause outer commons schemas params

756+ '["jsonb_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]]

757+jsonbEach = unsafeSetOfFunction "jsonb_each"

758+

759+-- | Expands the outermost JSON object into a set of key/value pairs.-- | Expands the outermost binary JSON object into a set of key/value pairs.

760+-- >>> import Data.Aeson

761+-- >>> printSQL (select Star (from (jsonEachText (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))

762+-- SELECT * FROM json_each_text(('{"a":"foo","b":"bar"}' :: json))

763+jsonEachText

764+ :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

765+ -> FromClause outer commons schemas params

766+ '["json_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]]

767+jsonEachText = unsafeSetOfFunction "json_each_text"

768+

769+-- | Expands the outermost binary JSON object into a set of key/value pairs.

770+-- >>> import Data.Aeson

771+-- >>> printSQL (select Star (from (jsonbEachText (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))

772+-- SELECT * FROM jsonb_each_text(('{"a":"foo","b":"bar"}' :: jsonb))

773+jsonbEachText

774+ :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

775+ -> FromClause outer commons schemas params

776+ '["jsonb_each" ::: '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]]

777+jsonbEachText = unsafeSetOfFunction "jsonb_each_text"

778+

779+-- | Returns set of keys in the outermost JSON object.

780+-- >>> import Data.Aeson

781+-- >>> printSQL (jsonObjectKeys (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))

782+-- json_object_keys(('{"a":"foo","b":"bar"}' :: json))

783+jsonObjectKeys

784+ :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

785+ -> FromClause outer commons schemas params

786+ '["json_object_keys" ::: '["json_object_keys" ::: 'NotNull 'PGtext]]

787+jsonObjectKeys = unsafeSetOfFunction "json_object_keys"

788+

789+-- | Returns set of keys in the outermost JSON object.

790+-- >>> import Data.Aeson

791+-- >>> printSQL (jsonbObjectKeys (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))

792+-- jsonb_object_keys(('{"a":"foo","b":"bar"}' :: jsonb))

793+jsonbObjectKeys

794+ :: Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

795+ -> FromClause outer commons schemas params

796+ '["jsonb_object_keys" ::: '["jsonb_object_keys" ::: 'NotNull 'PGtext]]

797+jsonbObjectKeys = unsafeSetOfFunction "jsonb_object_keys"

798+

799+unsafePopulateFunction

800+ :: KnownSymbol fun

801+ => Alias fun

802+ -> TypeExpression schemas (nullity ('PGcomposite row))

803+ -> Expression outer commons 'Ungrouped schemas params '[] ty

804+ -> FromClause outer commons schemas params '[fun ::: row]

805+unsafePopulateFunction fun ty expr = UnsafeFromClause $ renderSQL fun

806+ <> parenthesized ("null::" <> renderSQL ty <> ", " <> renderSQL expr)

807+

808+-- | Expands the JSON expression to a row whose columns match the record

809+-- type defined by the given table.

810+jsonPopulateRecord

811+ :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

812+ -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

813+ -> FromClause outer commons schemas params '["json_populate_record" ::: row]

814+jsonPopulateRecord = unsafePopulateFunction #json_populate_record

815+

816+-- | Expands the binary JSON expression to a row whose columns match the record

817+-- type defined by the given table.

818+jsonbPopulateRecord

819+ :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

820+ -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

821+ -> FromClause outer commons schemas params '["jsonb_populate_record" ::: row]

822+jsonbPopulateRecord = unsafePopulateFunction #jsonb_populate_record

823+

824+-- | Expands the outermost array of objects in the given JSON expression to a

825+-- set of rows whose columns match the record type defined by the given table.

826+jsonPopulateRecordSet

827+ :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

828+ -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json array

829+ -> FromClause outer commons schemas params '["json_populate_record_set" ::: row]

830+jsonPopulateRecordSet = unsafePopulateFunction #json_populate_record_set

831+

832+-- | Expands the outermost array of objects in the given binary JSON expression

833+-- to a set of rows whose columns match the record type defined by the given

834+-- table.

835+jsonbPopulateRecordSet

836+ :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

837+ -> Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb array

838+ -> FromClause outer commons schemas params '["jsonb_populate_record_set" ::: row]

839+jsonbPopulateRecordSet = unsafePopulateFunction #jsonb_populate_record_set

840+

841+unsafeRecordFunction

842+ :: (SListI record, json `In` PGJsonType)

843+ => ByteString

844+ -> Expression outer commons 'Ungrouped schemas params '[] (nullity json)

845+ -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

846+ -> FromClause outer commons schemas params '[tab ::: record]

847+unsafeRecordFunction fun expr (types `As` tab) = UnsafeFromClause $

848+ fun <> parenthesized (renderSQL expr) <+> "AS" <+> renderSQL tab

849+ <> parenthesized (renderCommaSeparated renderTy types)

850+ where

851+ renderTy :: Aliased (TypeExpression schemas) ty -> ByteString

852+ renderTy (ty `As` alias) = renderSQL alias <+> renderSQL ty

853+

854+-- | Builds an arbitrary record from a JSON object.

855+jsonToRecord

856+ :: SListI record

857+ => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json object

858+ -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

859+ -> FromClause outer commons schemas params '[tab ::: record]

860+jsonToRecord = unsafeRecordFunction "json_to_record"

861+

862+-- | Builds an arbitrary record from a binary JSON object.

863+jsonbToRecord

864+ :: SListI record

865+ => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

866+ -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

867+ -> FromClause outer commons schemas params '[tab ::: record]

868+jsonbToRecord = unsafeRecordFunction "jsonb_to_record"

869+

870+-- | Builds an arbitrary set of records from a JSON array of objects.

871+jsonToRecordSet

872+ :: SListI record

873+ => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjson) -- ^ json array

874+ -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

875+ -> FromClause outer commons schemas params '[tab ::: record]

876+jsonToRecordSet = unsafeRecordFunction "json_to_record_set"

877+

878+-- | Builds an arbitrary set of records from a binary JSON array of objects.

879+jsonbToRecordSet

880+ :: SListI record

881+ => Expression outer commons 'Ungrouped schemas params '[] (nullity 'PGjsonb) -- ^ jsonb array

882+ -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: record)

883+ -> FromClause outer commons schemas params '[tab ::: record]

884+jsonbToRecordSet = unsafeRecordFunction "jsonb_to_record_set"

885+

816{-----------------------------------------

886{-----------------------------------------

817FROM clauses

887FROM clauses

818-----------------------------------------}

888-----------------------------------------}

@@ -839,7 +909,7 @@ table (tab `As` alias) = UnsafeFromClause $

839subquery

909subquery

840 :: Aliased (Query outer commons schemas params) query

910 :: Aliased (Query outer commons schemas params) query

841 -> FromClause outer commons schemas params '[query]

911 -> FromClause outer commons schemas params '[query]

842−subquery = UnsafeFromClause . renderAliased (parenthesized . renderSQL)

912+subquery = UnsafeFromClause . renderAliased (parenthesized . renderQuery)

843

913

844-- | `view` derives a table from a `View`.

914-- | `view` derives a table from a `View`.

845view

915view

@@ -857,16 +927,11 @@ common

857common (cte `As` alias) = UnsafeFromClause $

927common (cte `As` alias) = UnsafeFromClause $

858 renderSQL cte <+> "AS" <+> renderSQL alias

928 renderSQL cte <+> "AS" <+> renderSQL alias

859

929

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

930+{- | @left & crossJoin right@. For every possible combination of rows from

866−@left@ and @right@ (i.e., a Cartesian product), the joined table will contain

931+ @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@.

932+ 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

933+ If the tables have @n@ and @m@ rows respectively, the joined table will

869−have @n * m@ rows.

934+ have @n * m@ rows.

870-}

935-}

871crossJoin

936crossJoin

872 :: FromClause outer commons schemas params right

937 :: FromClause outer commons schemas params right

@@ -992,20 +1057,19 @@ instance (Has rel rels cols, Has col cols ty, bys ~ '[ '(rel, col)])

992-- done on @NoGroups@ while all output `Expression`s must be aggregated

1057-- done on @NoGroups@ while all output `Expression`s must be aggregated

993-- in @Group Nil@. In general, all output `Expression`s in the

1058-- in @Group Nil@. In general, all output `Expression`s in the

994-- complement of @bys@ must be aggregated in @Group bys@.

1059-- complement of @bys@ must be aggregated in @Group bys@.

995−newtype GroupByClause grp from = UnsafeGroupByClause

1060+data GroupByClause grp from where

996− { renderGroupByClause :: ByteString }

1061+ NoGroups :: GroupByClause 'Ungrouped from

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

1062+ Group

1063+ :: SListI bys

1064+ => NP (By from) bys

1065+ -> GroupByClause ('Grouped bys) from

1066+

1067+-- | Renders a `GroupByClause`.

998instance RenderSQL (GroupByClause grp from) where

1068instance RenderSQL (GroupByClause grp from) where

999− renderSQL = renderGroupByClause

1069+ renderSQL = \case

1000−noGroups :: GroupByClause 'Ungrouped from

1070+ NoGroups -> ""

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

1071+ Group Nil -> ""

1008− bys' -> " GROUP BY" <+> renderCommaSeparated renderSQL bys'

1072+ Group bys -> " GROUP BY" <+> renderCommaSeparated renderSQL bys

1009

1073

1010-- | A `HavingClause` is used to eliminate groups that are not of interest.

1074-- | A `HavingClause` is used to eliminate groups that are not of interest.

1011-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`

1075-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`

@@ -1028,6 +1092,90 @@ instance RenderSQL (HavingClause outer commons grp schemas params from) where

1028 Having conditions ->

1092 Having conditions ->

1029 " HAVING" <+> commaSeparated (renderSQL <$> conditions)

1093 " HAVING" <+> commaSeparated (renderSQL <$> conditions)

1030

1094

1095+{- |

1096+The argument of `exists` is an arbitrary subquery. The subquery is evaluated

1097+to determine whether it returns any rows. If it returns at least one row,

1098+the result of `exists` is `true`; if the subquery returns no rows,

1099+the result of `exists` is `false`.

1100+

1101+The subquery can refer to variables from the surrounding query,

1102+which will act as constants during any one evaluation of the subquery.

1103+

1104+The subquery will generally only be executed long enough to determine whether

1105+at least one row is returned, not all the way to completion.

1106+-}

1107+exists

1108+ :: Query (Join outer from) commons schemas params row

1109+ -> Condition outer commons grp schemas params from

1110+exists query = UnsafeExpression $ "EXISTS" <+> parenthesized (renderSQL query)

1111+

1112+{- |

1113+The right-hand side is a parenthesized subquery, which must return

1114+exactly one column. The left-hand expression is evaluated and compared to each

1115+row of the subquery result using the given `Operator`,

1116+which must yield a Boolean result. The result of `subAll` is `true`

1117+if all rows yield true (including the case where the subquery returns no rows).

1118+The result is `false` if any `false` result is found.

1119+The result is `null_` if no comparison with a subquery row returns `false`,

1120+and at least one comparison returns `null_`.

1121+

1122+>>> printSQL $ subAll true (.==) (values_ (true `as` #foo))

1123+(TRUE = ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo")))

1124+-}

1125+subAll

1126+ :: Expression outer commons grp schemas params from ty1 -- ^ expression

1127+ -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator

1128+ -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery

1129+ -> Condition outer commons grp schemas params from

1130+subAll expr (?) qry = expr ?

1131+ (UnsafeExpression $ "ALL" <+> parenthesized (renderSQL qry))

1132+

1133+{- |

1134+The right-hand side is a parenthesized subquery, which must return exactly one column.

1135+The left-hand expression is evaluated and compared to each row of the subquery result

1136+using the given `Operator`, which must yield a Boolean result. The result of `subAny` is `true`

1137+if any `true` result is obtained. The result is `false` if no true result is found

1138+(including the case where the subquery returns no rows).

1139+

1140+>>> printSQL $ subAll "foo" like (values_ ("foobar" `as` #foo))

1141+(E'foo' LIKE ALL (SELECT * FROM (VALUES (E'foobar')) AS t ("foo")))

1142+-}

1143+subAny

1144+ :: Expression outer commons grp schemas params from ty1 -- ^ expression

1145+ -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator

1146+ -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery

1147+ -> Condition outer commons grp schemas params from

1148+subAny expr (?) qry = expr ?

1149+ (UnsafeExpression $ "ANY" <+> parenthesized (renderSQL qry))

1150+

1151+{- |

1152+The result is `true` if the left-hand expression's result is equal

1153+to any of the right-hand expressions.

1154+

1155+>>> printSQL $ true `in_` [true, false, null_]

1156+TRUE IN (TRUE, FALSE, NULL)

1157+-}

1158+in_

1159+ :: Expression outer commons grp schemas params from ty -- ^ expression

1160+ -> [Expression outer commons grp schemas params from ty]

1161+ -> Condition outer commons grp schemas params from

1162+expr `in_` exprs = UnsafeExpression $ renderSQL expr <+> "IN"

1163+ <+> parenthesized (commaSeparated (renderSQL <$> exprs))

1164+

1165+{- |

1166+The result is `true` if the left-hand expression's result is not equal

1167+to any of the right-hand expressions.

1168+

1169+>>> printSQL $ true `notIn` [false, null_]

1170+TRUE NOT IN (FALSE, NULL)

1171+-}

1172+notIn

1173+ :: Expression outer commons grp schemas params from ty -- ^ expression

1174+ -> [Expression outer commons grp schemas params from ty]

1175+ -> Condition outer commons grp schemas params from

1176+expr `notIn` exprs = UnsafeExpression $ renderSQL expr <+> "NOT IN"

1177+ <+> parenthesized (commaSeparated (renderSQL <$> exprs))

1178+

1031-- | A `CommonTableExpression` is an auxiliary statement in a `with` clause.

1179-- | A `CommonTableExpression` is an auxiliary statement in a `with` clause.

1032data CommonTableExpression statement

1180data CommonTableExpression statement

1033 (schemas :: SchemasType)

1181 (schemas :: SchemasType)

@@ -1049,8 +1197,8 @@ instance

1049 , commons1 ~ (cte ::: common ': commons)

1197 , commons1 ~ (cte ::: common ': commons)

1050 ) => Aliasable cte

1198 ) => Aliasable cte

1051 (statement commons schemas params common)

1199 (statement commons schemas params common)

1052− (Path (CommonTableExpression statement schemas params) commons commons1) where

1200+ (AlignedList (CommonTableExpression statement schemas params) commons commons1) where

1053− statement `as` cte = csingleton (statement `as` cte)

1201+ statement `as` cte = single (statement `as` cte)

1054

1202

1055instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

1203instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

1056 (CommonTableExpression statement schemas params commons0 commons1) where

1204 (CommonTableExpression statement schemas params commons0 commons1) where

@@ -1062,7 +1210,7 @@ instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

1062-- defining temporary tables that exist just for one query.

1210-- defining temporary tables that exist just for one query.

1063class With statement where

1211class With statement where

1064 with

1212 with

1065− :: Path (CommonTableExpression statement schemas params) commons0 commons1

1213+ :: AlignedList (CommonTableExpression statement schemas params) commons0 commons1

1066 -- ^ common table expressions

1214 -- ^ common table expressions

1067 -> statement commons1 schemas params row

1215 -> statement commons1 schemas params row

1068 -- ^ larger query

1216 -- ^ larger query

@@ -1070,29 +1218,4 @@ class With statement where

1070instance With (Query outer) where

1218instance With (Query outer) where

1071 with Done query = query

1219 with Done query = query

1072 with ctes query = UnsafeQuery $

1220 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

1221+ "WITH" <+> renderSQL ctes <+> renderSQL query

squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+62−164

@@ -1,11 +1,11 @@

1{-|

2Module: Squeal.PostgreSQL.Schema

3Description: Embedding of PostgreSQL type and alias system

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

5Maintainer: eitan@morphism.tech

6Stability: 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,

9tables, schema, constraints, aliases, enumerated labels, and groupings.

10It also defines useful type families to operate on these. Finally,

11it defines an embedding of Haskell types into Postgres types.

@@ -44,10 +44,6 @@ module Squeal.PostgreSQL.Schema

44 , ColumnsType

45 , TableType

46 , SchemumType (..)

47− , IndexType (..)

48− , FunctionType

49− , OperatorType (..)

50− , ReturnsType (..)

51 , SchemaType

47 , SchemaType

52 , SchemasType

48 , SchemasType

53 , Public

49 , Public

@@ -62,21 +58,15 @@ module Squeal.PostgreSQL.Schema

62 , PGlabel (..)

58 , PGlabel (..)

63 -- * Data Definitions

59 -- * Data Definitions

64 , Create

60 , Create

65− , CreateIfNotExists

66− , CreateOrReplace

67 , Drop

61 , Drop

68− , DropSchemum

69− , DropIfExists

70− , DropSchemumIfExists

71 , Alter

62 , Alter

72− , AlterIfExists

73 , Rename

63 , Rename

74− , RenameIfExists

75 , ConstraintInvolves

64 , ConstraintInvolves

76 , DropIfConstraintsInvolve

65 , DropIfConstraintsInvolve

77 , IsNotElem

66 , IsNotElem

78 , AllUnique

67 , AllUnique

79 -- * Type Classifications

68 -- * Type Classifications

69+ , HasOid (..)

80 , PGNum

70 , PGNum

81 , PGIntegral

71 , PGIntegral

82 , PGFloating

72 , PGFloating

@@ -100,19 +90,17 @@ import Control.Category

100import Data.Kind

90import Data.Kind

101import Data.Monoid hiding (All)

91import Data.Monoid hiding (All)

102import Data.Type.Bool

92import Data.Type.Bool

93+import Data.Word (Word32)

103import Generics.SOP

94import Generics.SOP

104import GHC.TypeLits

95import GHC.TypeLits

105import Prelude hiding (id, (.))

96import Prelude hiding (id, (.))

106

107import Squeal.PostgreSQL.Alias

98import Squeal.PostgreSQL.Alias

108−import Squeal.PostgreSQL.List

109import Squeal.PostgreSQL.Render

99import Squeal.PostgreSQL.Render

110

100

111−-- $setup

112−-- >>> import Squeal.PostgreSQL

113−

114-- | `PGType` is the promoted datakind of PostgreSQL types.

101-- | `PGType` is the promoted datakind of PostgreSQL types.

115--

102--

103+-- >>> import Squeal.PostgreSQL.Schema

116-- >>> :kind 'PGbool

104-- >>> :kind 'PGbool

117-- 'PGbool :: PGType

105-- 'PGbool :: PGType

118data PGType

106data PGType

@@ -143,11 +131,37 @@ data PGType

143 | PGenum [Symbol] -- ^ enumerated (enum) types are data types that comprise a static, ordered set of values.

131 | PGenum [Symbol] -- ^ enumerated (enum) types are data types that comprise a static, ordered set of values.

144 | PGcomposite RowType -- ^ a composite type represents the structure of a row or record; it is essentially just a list of field names and their data types.

132 | PGcomposite RowType -- ^ a composite type represents the structure of a row or record; it is essentially just a list of field names and their data types.

145 | PGtsvector -- ^ A tsvector value is a sorted list of distinct lexemes, which are words that have been normalized to merge different variants of the same word.

133 | PGtsvector -- ^ A tsvector value is a sorted list of distinct lexemes, which are words that have been normalized to merge different variants of the same word.

146− | PGtsquery -- ^ A tsquery value stores lexemes that are to be searched for.

134+ | 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).

149 | UnsafePGType Symbol -- ^ an escape hatch for unsupported PostgreSQL types

135 | UnsafePGType Symbol -- ^ an escape hatch for unsupported PostgreSQL types

150

136

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+

151-- | `NullityType` encodes the potential presence or definite absence of a

165-- | `NullityType` encodes the potential presence or definite absence of a

152-- @NULL@ allowing operations which are sensitive to such to be well typed.

166-- @NULL@ allowing operations which are sensitive to such to be well typed.

153--

167--

@@ -260,19 +274,9 @@ type FromType = [(Symbol,RowType)]

260

274

261-- | `ColumnsToRow` removes column constraints.

275-- | `ColumnsToRow` removes column constraints.

262type family ColumnsToRow (columns :: ColumnsType) :: RowType where

276type 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

275 ColumnsToRow '[] = '[]

277 ColumnsToRow '[] = '[]

278+ ColumnsToRow (column ::: constraint :=> ty ': columns) =

279+ column ::: ty ': ColumnsToRow columns

276

280

277-- | `TableToColumns` removes table constraints.

281-- | `TableToColumns` removes table constraints.

278type family TableToColumns (table :: TableType) :: ColumnsType where

282type family TableToColumns (table :: TableType) :: ColumnsType where

@@ -282,6 +286,15 @@ type family TableToColumns (table :: TableType) :: ColumnsType where

282type family TableToRow (table :: TableType) :: RowType where

286type family TableToRow (table :: TableType) :: RowType where

283 TableToRow tab = ColumnsToRow (TableToColumns tab)

287 TableToRow tab = ColumnsToRow (TableToColumns tab)

284

288

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+

285-- | Numeric Postgres types.

298-- | Numeric Postgres types.

286type PGNum =

299type PGNum =

287 '[ 'PGint2, 'PGint4, 'PGint8, 'PGnumeric, 'PGfloat4, 'PGfloat8]

300 '[ 'PGint2, 'PGint4, 'PGint8, 'PGnumeric, 'PGfloat4, 'PGfloat8]

@@ -305,24 +318,14 @@ instance ty0 ~ ty1 => SamePGType

305

318

306-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.

319-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.

307type family AllNotNull (columns :: ColumnsType) :: Constraint where

320type 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

314 AllNotNull '[] = ()

321 AllNotNull '[] = ()

322+ AllNotNull (column ::: def :=> 'NotNull ty ': columns) = AllNotNull columns

315

323

316-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some

324-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some

317-- @NOT NULL@.

325-- @NOT NULL@.

318type family NotAllNull (columns :: ColumnsType) :: Constraint where

326type family NotAllNull (columns :: ColumnsType) :: Constraint where

319− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

327+ NotAllNull (column ::: def :=> 'NotNull ty ': columns) = ()

320− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

321− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

322− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

323− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

324− NotAllNull (_ ::: _ :=> 'NotNull _ ': _) = ()

325− NotAllNull (_ ::: _ :=> 'Null _ ': columns) = NotAllNull columns

328+ NotAllNull (column ::: def :=> 'Null ty ': columns) = NotAllNull columns

326

329

327-- | `NullifyType` is an idempotent that nullifies a `NullityType`.

330-- | `NullifyType` is an idempotent that nullifies a `NullityType`.

328type family NullifyType (ty :: NullityType) :: NullityType where

331type family NullifyType (ty :: NullityType) :: NullityType where

@@ -331,37 +334,17 @@ type family NullifyType (ty :: NullityType) :: NullityType where

331

334

332-- | `NullifyRow` is an idempotent that nullifies a `RowType`.

335-- | `NullifyRow` is an idempotent that nullifies a `RowType`.

333type family NullifyRow (columns :: RowType) :: RowType where

336type family NullifyRow (columns :: RowType) :: RowType where

334− NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': column5 ::: ty5 ': columns) =

337+ NullifyRow '[] = '[]

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

344 NullifyRow (column ::: ty ': columns) =

338 NullifyRow (column ::: ty ': columns) =

345 column ::: NullifyType ty ': NullifyRow columns

339 column ::: NullifyType ty ': NullifyRow columns

346− NullifyRow '[] = '[]

347

340

348-- | `NullifyFrom` is an idempotent that nullifies a `FromType`

341-- | `NullifyFrom` is an idempotent that nullifies a `FromType`

349-- used to nullify the left or right hand side of an outer join

342-- used to nullify the left or right hand side of an outer join

350-- in a `Squeal.PostgreSQL.Query.FromClause`.

343-- in a `Squeal.PostgreSQL.Query.FromClause`.

351type family NullifyFrom (tables :: FromType) :: FromType where

344type family NullifyFrom (tables :: FromType) :: FromType where

352− NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': table4 ::: columns4 ': table5 ::: columns5 ': tables) =

345+ NullifyFrom '[] = '[]

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

362 NullifyFrom (table ::: columns ': tables) =

346 NullifyFrom (table ::: columns ': tables) =

363 table ::: NullifyRow columns ': NullifyFrom tables

347 table ::: NullifyRow columns ': NullifyFrom tables

364− NullifyFrom '[] = '[]

365

348

366-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in

349-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in

367-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@

350-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@

@@ -371,101 +354,30 @@ type family Create alias x xs where

371 Create alias x (alias ::: y ': xs) = TypeError

354 Create alias x (alias ::: y ': xs) = TypeError

372 ('Text "Create: alias "

355 ('Text "Create: alias "

373 ':<>: 'ShowType alias

356 ':<>: 'ShowType alias

374− ':<>: 'Text "already exists")

357+ ':<>: 'Text "already in use")

375 Create alias y (x ': xs) = x ': Create alias y xs

358 Create alias y (x ': xs) = x ': Create alias y xs

376

359

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−

394-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@

360-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@

395-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements

361-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements

396-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.

362-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.

397type family Drop alias xs where

363type 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

403 Drop alias (x ': xs) = x ': Drop alias xs

365 Drop alias (x ': xs) = x ': Drop alias xs

404

366

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−

437-- | @Alter alias x xs@ replaces the type associated with an @alias@ in @xs@

367-- | @Alter alias x xs@ replaces the type associated with an @alias@ in @xs@

438-- with the type @x@ and is used in `Squeal.PostgreSQL.Definition.alterTable`

368-- with the type @x@ and is used in `Squeal.PostgreSQL.Definition.alterTable`

439-- and `Squeal.PostgreSQL.Definition.alterColumn`.

369-- and `Squeal.PostgreSQL.Definition.alterColumn`.

440type family Alter alias x xs where

370type family Alter alias x xs where

441− Alter alias x '[] = TypeError

442− ('Text "Alter: alias "

443− ':<>: 'ShowType alias

444− ':<>: 'Text " does not exist" )

445 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

371 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

446 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

372 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

447

373

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−

453-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@

374-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@

454-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and

375-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and

455-- `Squeal.PostgreSQL.Definition.renameColumn`.

376-- `Squeal.PostgreSQL.Definition.renameColumn`.

456type family Rename alias0 alias1 xs where

377type family Rename alias0 alias1 xs where

457− Rename alias0 alias1 '[] = TypeError

458− ('Text "Rename: alias "

459− ':<>: 'ShowType alias0

460− ':<>: 'Text " does not exist" )

461 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

378 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

462 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

379 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

463

380

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−

469-- | Check if a `TableConstraint` involves a column

381-- | Check if a `TableConstraint` involves a column

470type family ConstraintInvolves column constraint where

382type family ConstraintInvolves column constraint where

471 ConstraintInvolves column ('Check columns) = column `Elem` columns

383 ConstraintInvolves column ('Check columns) = column `Elem` columns

@@ -482,35 +394,22 @@ type family DropIfConstraintsInvolve column constraints where

482 (DropIfConstraintsInvolve column constraints)

394 (DropIfConstraintsInvolve column constraints)

483 (alias ::: constraint ': DropIfConstraintsInvolve column constraints)

395 (alias ::: constraint ': DropIfConstraintsInvolve column constraints)

484

396

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+

485-- | A `SchemumType` is a user-defined type, either a `Table`,

407-- | A `SchemumType` is a user-defined type, either a `Table`,

486-- `View` or `Typedef`.

408-- `View` or `Typedef`.

487data SchemumType

409data SchemumType

488 = Table TableType

410 = Table TableType

489 | View RowType

411 | View RowType

490 | Typedef PGType

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

514

413

515{- | The schema of a database consists of a list of aliased,

414{- | The schema of a database consists of a list of aliased,

516user-defined `SchemumType`s.

415user-defined `SchemumType`s.

@@ -553,7 +452,6 @@ There are several reasons why one might want to use schemas:

553-}

452-}

554type SchemasType = [(Symbol,SchemaType)]

453type SchemasType = [(Symbol,SchemaType)]

555

454

556−-- | A type family to use for a single schema database.

557type family Public (schema :: SchemaType) :: SchemasType

455type family Public (schema :: SchemaType) :: SchemasType

558 where Public schema = '["public" ::: schema]

456 where Public schema = '["public" ::: schema]

559

457

squeal-postgresql/src/Squeal/PostgreSQL/Transaction.hs+44−76

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

1{-|

2Module: Squeal.PostgreSQL.Transaction

3Description: Squeal transaction control language

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

5Maintainer: eitan@morphism.tech

6Stability: experimental

@@ -20,12 +20,11 @@ module Squeal.PostgreSQL.Transaction

20 ( -- * Transaction

21 transactionally

22 , transactionally_

23− , transactionallyRetry

24− , ephemerally

25− , ephemerally_

26 , begin

23 , begin

27 , commit

24 , commit

28 , rollback

25 , rollback

26+ , transactionallySchema

27+ , transactionallySchema_

29 -- * Transaction Mode

28 -- * Transaction Mode

30 , TransactionMode (..)

29 , TransactionMode (..)

31 , defaultMode

30 , defaultMode

@@ -35,99 +34,68 @@ module Squeal.PostgreSQL.Transaction

35 , DeferrableMode (..)

34 , DeferrableMode (..)

36 ) where

35 ) where

38−import UnliftIO

37+import Generics.SOP

38+import UnliftIO (MonadUnliftIO, liftIO, mask, onException)

39+

40+import qualified Database.PostgreSQL.LibPQ as LibPQ

40import Squeal.PostgreSQL.Manipulation

42import Squeal.PostgreSQL.Manipulation

41import Squeal.PostgreSQL.Render

43import Squeal.PostgreSQL.Render

42import Squeal.PostgreSQL.PQ

44import Squeal.PostgreSQL.PQ

45+import Squeal.PostgreSQL.Schema

44−{- | Run a computation `transactionally`;

47+-- | Run a schema invariant 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−-}

50transactionally

48transactionally

51 :: (MonadUnliftIO tx, MonadPQ schemas tx)

49 :: (MonadUnliftIO tx, MonadPQ schemas tx)

52 => TransactionMode

50 => TransactionMode

53 -> tx x -- ^ run inside a transaction

51 -> tx x -- ^ run inside a transaction

54 -> tx x

52 -> tx x

55transactionally mode tx = mask $ \restore -> do

53transactionally mode tx = mask $ \restore -> do

56− manipulate_ $ begin mode

54+ _ <- begin mode

57− result <- restore tx `onException` (manipulate_ rollback)

55+ result <- restore tx `onException` rollback

58− manipulate_ commit

56+ _ <- commit

59 return result

57 return result

61−-- | Run a computation `transactionally_`, in `defaultMode`.

59+-- | Run a schema invariant computation `transactionally_` in `defaultMode`.

62transactionally_

60transactionally_

63 :: (MonadUnliftIO tx, MonadPQ schemas tx)

61 :: (MonadUnliftIO tx, MonadPQ schemas tx)

64 => tx x -- ^ run inside a transaction

62 => tx x -- ^ run inside a transaction

65 -> tx x

63 -> tx x

66transactionally_ = transactionally defaultMode

64transactionally_ = transactionally defaultMode

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−

120-- | @BEGIN@ a transaction.

66-- | @BEGIN@ a transaction.

121−begin :: TransactionMode -> Manipulation_ schemas () ()

67+begin :: MonadPQ schemas tx => TransactionMode -> tx (K Result ('[] :: RowType))

122−begin mode = UnsafeManipulation $ "BEGIN" <+> renderSQL mode

68+begin mode = manipulate . UnsafeManipulation $

69+ "BEGIN" <+> renderSQL mode <> ";"

123

124−-- | @COMMIT@ a transaction.

71+-- | @COMMIT@ a schema invariant transaction.

125−commit :: Manipulation_ schemas () ()

72+commit :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

126−commit = UnsafeManipulation "COMMIT"

73+commit = manipulate $ UnsafeManipulation "COMMIT;"

127

128−-- | @ROLLBACK@ a transaction.

75+-- | @ROLLBACK@ a schema invariant transaction.

129−rollback :: Manipulation_ schemas () ()

76+rollback :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

130−rollback = UnsafeManipulation "ROLLBACK"

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

131

132-- | The available transaction characteristics are the transaction `IsolationLevel`,

100-- | The available transaction characteristics are the transaction `IsolationLevel`,

133-- the transaction `AccessMode` (`ReadWrite` or `ReadOnly`), and the `DeferrableMode`.

101-- the transaction `AccessMode` (`ReadWrite` or `ReadOnly`), and the `DeferrableMode`.

@@ -140,7 +108,7 @@ data TransactionMode = TransactionMode

140-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

108-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

141-- `ReadWrite` `AccessMode` and `NotDeferrable` `DeferrableMode`.

109-- `ReadWrite` `AccessMode` and `NotDeferrable` `DeferrableMode`.

142defaultMode :: TransactionMode

110defaultMode :: TransactionMode

143−defaultMode = TransactionMode ReadCommitted ReadWrite NotDeferrable

111+defaultMode = TransactionMode Serializable ReadWrite NotDeferrable

144

112

145-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

113-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

146-- `ReadOnly` `AccessMode` and `Deferrable` `DeferrableMode`.

114-- `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

2packages:

3- squeal-postgresql

5extra-deps:

6- unliftio-pool-0.2.1.0

7−- github: morphismtech/free-categories

8− commit: c0e555fbefb5c21619e532264c4dfeac556d0630