dev..96360bf · squeal · git.iko.soy

git.iko.soy/squeal

52 files changed+5051−8844

unifiedsplit

.circleci/config.yml+1−1

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

22jobs:

33 build:

44 docker:

5− - image: haskell:8.6.5

5+ - image: haskell:8.4.3

66 - image: circleci/postgres:latest

77 environment:

88 POSTGRES_USER: root

README.md+75−64

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

4646* transactions

4747* views

4848* array, composite and enumerated types

49−* json functions and operations

50−* multischema support

51−* correlated subqueries

52−* window functions

53−* text search

49+* json operations

5450

5551## installation

5652

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

7672features.

7773

7874```Haskell

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

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

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

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

8177```

8278

8379We'll need some imports.

8480

8581```Haskell

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

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

83+>>> import Control.Monad.Base (liftBase)

8784>>> import Data.Int (Int32)

8885>>> import Data.Text (Text)

8986>>> import Squeal.PostgreSQL

87+>>> import Squeal.PostgreSQL.Render

9088```

9189

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

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

10199

102100```Haskell

103101>>> :{

104−type UsersColumns =

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

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

107−type UsersConstraints = '[ "pk_users" ::: 'PrimaryKey '["id"] ]

108−type EmailsColumns =

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

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

111− , "email" ::: 'NoDef :=> 'Null 'PGtext ]

112−type EmailsConstraints =

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

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

115102type Schema =

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

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

118−type Schemas = Public Schema

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

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

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

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

107+ ])

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

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

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

111+ ] :=>

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

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

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

115+ ])

116+ ]

119117:}

120118```

121119

122120Notice the use of type operators.

123121

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

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

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

126124operator.

127125

@@ -130,7 +128,7 @@ yielding a `TableType`, or to pair a `ColumnConstraint` with a `NullityType`,

130128yielding a `ColumnType`. It is intended to connote Haskell's `=>` operator

131129

132130Next, we'll write `Definition`s to set up and tear down the schema. In

133−Squeal, a `Definition` like `createTable`, `alterTable` or `dropTable`

131+Squeal, a `Definition` like `createTable`, `alterTable` or `dropTable`

134132has two type parameters, corresponding to the schema

135133before being run and the schema after. We can compose definitions using `>>>`.

136134Here and in the rest of our commands we make use of overloaded

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

139137```Haskell

140138>>> :{

141139let

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

143− setup =

140+ setup :: Definition '[] Schema

141+ setup =

144142 createTable #users

145143 ( serial `as` #id :*

146144 (text & notNullable) `as` #name )

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

171169```Haskell

172170>>> :{

173171let

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

172+ teardown :: Definition Schema '[]

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

176174:}

177175

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

180178DROP TABLE "users";

181179```

182180

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

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

185−

186−```Haskell

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

188−>>> instance SOP.Generic User

189−>>> instance SOP.HasDatatypeInfo User

190−```

191−

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

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

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

195−and an output row. When

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

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

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

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

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

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

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

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

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

201−`with` statement.

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

190+of our inserts.

202191

203192```Haskell

204193>>> :{

205194let

206− insertUser :: Manipulation_ Schemas User ()

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

208− where

209− u = insertInto #users

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

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

212− e = insertInto_ #emails $ Select

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

214− (from (common #u))

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

196+ insertUser = insertRow #users

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

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

199+:}

200+

201+>>> :{

202+let

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

204+ insertEmail = insertRow #emails

205+ ( Default `as` #id :*

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

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

208+ OnConflictDoNothing (Returning Nil)

215209:}

216210

217211>>> printSQL insertUser

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

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

213+>>> printSQL insertEmail

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

219215```

220216

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

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

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

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

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

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

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

225221

226222```Haskell

227223>>> :{

228224let

229− getUsers :: Query_ Schemas () User

230− getUsers = select_

225+ getUsers :: Query Schema '[]

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

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

228+ getUsers = select

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

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

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

@@ -238,13 +236,25 @@ let

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

239237```

240238

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

239+Now that we've defined the SQL side of things, we'll need a Haskell type

240+for users. We give the type `Generics.SOP.Generic` and

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

242+we receive when we run `getUsers`. Notice that the record fields of the

243+`User` type match the column names of `getUsers`.

244+

245+```Haskell

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

247+>>> instance SOP.Generic User

248+>>> instance SOP.HasDatatypeInfo User

249+```

250+

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

242252

243253```Haskell

244254>>> :{

245255let

246256 users :: [User]

247− users =

257+ users =

248258 [ User "Alice" (Just "alice@gmail.com")

249259 , User "Bob" Nothing

250260 , User "Carole" (Just "carole@hotmail.com")

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

263273```Haskell

264274>>> :{

265275let

266− session :: PQ Schemas Schemas IO ()

276+ session :: PQ Schema Schema IO ()

267277 session = do

268− _ <- traversePrepared_ insertUser users

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

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

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

269281 usersResult <- runQuery getUsers

270282 usersRows <- getRows usersResult

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

283+ liftBase $ print (usersRows :: [User])

272284in

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

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

274286 define setup

275287 & pqThen session

276288 & pqThen (define teardown)

277289:}

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

279−-}

280291```

RELEASE NOTES.md−400

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

11## RELEASE NOTES

3−### Version 0.5

4−

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

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

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

8−

9−**Multi-schema support**

10−

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

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

13−

14−```Haskell

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

16−```

17−

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

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

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

21−

22−```Haskell

23−-- Squeal 0.4

24−setup :: Definition '[] Schema

25−

26−-- Squeal 0.5

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

28−```

29−

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

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

32−`createSchemaIfNotExists`.

33−

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

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

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

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

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

39−

40−**Top-level statements**

41−

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

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

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

45−will be discussed in the next section.

46−

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

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

49−type families.

50−

51−```

52−type family Query_

53− (schemas :: SchemasType)

54− (parameters :: Type)

55− (row :: Type) where

56− Query_ schemas params row =

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

58−```

59−

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

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

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

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

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

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

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

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

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

69−only a scope for common table expressions.

70−

71−**Subquery expressions**

72−

73−Previous versions of Squeal offered subquery expression support

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

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

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

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

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

79−for a query was not available.

80−

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

82−

83−```Haskell

84−newtype Query

85− (outer :: FromType)

86− (commons :: FromType)

87− (schemas :: SchemasType)

88− (params :: [NullityType])

89− (row :: RowType)

90− = UnsafeQuery { renderQuery :: ByteString }

91−```

92−

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

94−

95−```Haskell

96−exists

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

98− -> Condition outer commons grp schemas params from

99−```

100−

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

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

103−

104−```Haskell

105−in_

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

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

108− -> Condition outer commons grp schemas params from

109−```

110−

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

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

113−the next section.

114−

115−```Haskell

116−subAll

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

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

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

120− -> Condition outer commons grp schemas params from

121−

122−subAny

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

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

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

126− -> Condition outer commons grp schemas params from

127−```

128−

129−**Expression RankNTypes**

130−

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

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

133−that cannot reference any aliases or parameters.

134−

135−```Haskell

136−type Expr x

137− = forall outer commons grp schemas params from

138− . Expression outer commons grp schemas params from x

139−```

140−

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

142−type `(->)`.

143−

144−```Haskell

145−type (-->) x y

146− = forall outer commons grp schemas params from

147− . Expression outer commons grp schemas params from x

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

149−```

150−

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

152−

153−```Haskell

154−type Operator x1 x2 y

155− = forall outer commons grp schemas params from

156− . Expression outer commons grp schemas params from x1

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

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

159−```

160−

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

162−and variadic functions.

163−

164−```

165−type FunctionN xs y

166− = forall outer commons grp schemas params from

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

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

169−```

170−

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

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

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

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

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

176−

177−**Selections**

178−

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

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

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

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

183−

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

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

186−

187−```Haskell

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

189− Star

190− :: HasUnique tab from row

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

192− DotStar

193− :: Has tab from row

194− => Alias tab

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

196− List

197− :: SListI row

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

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

200− Over

201− :: SListI row

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

203− -> WindowDefinition outer commons grp schemas params from

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

205− Also

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

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

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

209−```

210−

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

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

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

214−window functions, described in the next section.

215−

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

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

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

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

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

221−functions to filter out duplicate rows.

222−

223−**Query clauses**

224−

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

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

227−

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

229−

230−```

231−-- Squeal 0.4

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

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

234−

235−-- Squeal 0.5

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

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

238−```

239−

240−**Window functions and aggregation**

241−

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

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

244−previous section.

245−

246−```Haskell

247−Over

248− :: SListI row

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

250− -> WindowDefinition outer commons grp schemas params from

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

252−```

253−

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

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

256−clause. For example,

257−

258−```Haskell

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

260−query = select

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

262− (from (table #tab))

263−```

264−

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

266−

267−```Haskell

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

269−rank = UnsafeWindowFunction "rank()"

270−```

271−

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

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

274−window functions and n-ary window functions.

275−

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

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

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

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

280−

281−```

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

283− = All (expr ty)

284− | Distinct (expr ty)

285−```

286−

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

288−while window functions bear no such distinction.

289−

290−**Migrations**

291−

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

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

294−run or rewind your migrations.

295−

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

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

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

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

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

301−

302−```Haskell

303−data Migration p schemas0 schemas1 = Migration

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

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

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

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

308− } deriving (GHC.Generic)

309−```

310−

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

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

313−introduces the `Terminally` type.

314−

315−```Haskell

316−newtype Terminally trans monad x0 x1 = Terminally

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

318−```

319−

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

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

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

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

324−

325−```Haskell

326−pureMigration

327− :: Migration Definition schemas0 schemas1

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

329−```

330−

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

332−a typeclass, `Migratory`.

333−

334−```

335−class Category p => Migratory p where

336−

337− migrateUp

338− :: AlignedList (Migration p) schemas0 schemas1

339− -> PQ schemas0 schemas1 IO ()

340−

341− migrateDown

342− :: AlignedList (Migration p) schemas0 schemas1

343− -> PQ schemas1 schemas0 IO ()

344−```

345−

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

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

348−

349−**Transactions**

350−

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

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

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

354−`transactionallyRetry` computations, retrying the transaction if

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

356−

357−**Types**

358−

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

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

361−with `createDomain`.

362−

363−**Time**

364−

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

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

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

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

369−differences.

370−

371−**Literals**

372−

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

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

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

376−

377−**Set returning functions**

378−

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

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

381−

382−**Text search**

383−

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

385−

386−**Much more**

387−

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

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

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

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

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

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

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

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

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

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

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

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

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

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

402−

4033### Version 0.4

4044

4055Version 0.4 strengthens Squeal's type system, adds

squeal-postgresql/exe/Example.hs+21−19

@@ -11,7 +11,8 @@

1111

1212module Main (main, main2) where

1313

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

14+import Control.Monad (void)

15+import Control.Monad.Base (liftBase, MonadBase)

1516import Data.Int (Int16, Int32)

1617import Data.Monoid ((<>))

1718import Data.Text (Text)

@@ -38,13 +39,12 @@ type Schema =

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

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

4041 ])

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

4242 ]

4343

4444type Schemas = Public Schema

4545

4646setup :: Definition (Public '[]) Schemas

47−setup =

47+setup =

4848 createTable #users

4949 ( serial `as` #id :*

5050 (text & notNullable) `as` #name :*

@@ -53,27 +53,29 @@ setup =

5353 >>>

5454 createTable #emails

5555 ( serial `as` #id :*

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

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

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

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

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

5959 foreignKey #user_id #users #id

6060 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

61− >>>

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

6361

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

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

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

6664

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

65+insertUser :: Manipulation '[] Schemas '[ 'NotNull 'PGtext, 'NotNull ('PGvararray ('Null 'PGint2))]

66+ '[ "fromOnly" ::: 'NotNull 'PGint4 ]

6867insertUser = insertInto #users

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

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

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

7170

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

71+insertEmail :: Manipulation '[] Schemas '[ 'NotNull 'PGint4, 'Null 'PGtext] '[]

7372insertEmail = insertInto_ #emails

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

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

7574

76−getUsers :: Query_ Schemas () User

75+getUsers :: Query '[] Schemas '[]

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

77+ , "userEmail" ::: 'Null 'PGtext

78+ , "userVec" ::: 'NotNull ('PGvararray ('Null 'PGint2))]

7779getUsers = select_

7880 (#u ! #name `as` #userName :* #e ! #email `as` #userEmail :* #u ! #vec `as` #userVec)

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

@@ -86,22 +88,22 @@ instance SOP.Generic User

8688instance SOP.HasDatatypeInfo User

8789

8890users :: [User]

89−users =

91+users =

9092 [ User "Alice" (Just "alice@gmail.com") (VarArray [Nothing, Just 1])

9193 , User "Bob" Nothing (VarArray [Just 2, Nothing])

9294 , User "Carole" (Just "carole@hotmail.com") (VarArray [Just 3])

9395 ]

9496

95−session :: (MonadIO pq, MonadPQ Schemas pq) => pq ()

97+session :: (MonadBase IO pq, MonadPQ Schemas pq) => pq ()

9698session = do

97− liftIO $ Char8.putStrLn "manipulating"

99+ liftBase $ Char8.putStrLn "manipulating"

98100 idResults <- traversePrepared insertUser ([(userName user, userVec user) | user <- users])

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

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

101− liftIO $ Char8.putStrLn "querying"

103+ liftBase $ Char8.putStrLn "querying"

102104 usersResult <- runQuery getUsers

103105 usersRows <- getRows usersResult

104− liftIO $ print (usersRows :: [User])

106+ liftBase $ print (usersRows :: [User])

105107

106108main :: IO ()

107109main = do

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

119121

120122main2 :: IO ()

121123main2 =

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

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

123125 define setup

124126 & pqThen session

125127 & pqThen (define teardown)

squeal-postgresql/squeal-postgresql.cabal+16−58

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

11name: squeal-postgresql

2−version: 0.5.1.0

2+version: 0.4.9.0

33synopsis: Squeal PostgreSQL Library

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

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

@@ -22,40 +22,12 @@ library

2222 hs-source-dirs: src

2323 exposed-modules:

2424 Squeal.PostgreSQL

25− Squeal.PostgreSQL.Alias

2625 Squeal.PostgreSQL.Binary

2726 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

3527 Squeal.PostgreSQL.Expression

36− Squeal.PostgreSQL.Expression.Aggregate

37− Squeal.PostgreSQL.Expression.Collection

38− Squeal.PostgreSQL.Expression.Comparison

39− Squeal.PostgreSQL.Expression.Json

40− Squeal.PostgreSQL.Expression.Literal

41− Squeal.PostgreSQL.Expression.Logic

42− Squeal.PostgreSQL.Expression.Math

43− Squeal.PostgreSQL.Expression.Null

44− Squeal.PostgreSQL.Expression.Parameter

45− Squeal.PostgreSQL.Expression.Range

46− Squeal.PostgreSQL.Expression.Set

47− Squeal.PostgreSQL.Expression.Sort

48− Squeal.PostgreSQL.Expression.Subquery

49− Squeal.PostgreSQL.Expression.Text

50− Squeal.PostgreSQL.Expression.TextSearch

51− Squeal.PostgreSQL.Expression.Time

52− Squeal.PostgreSQL.Expression.Type

53− Squeal.PostgreSQL.Expression.Window

54− Squeal.PostgreSQL.List

5528 Squeal.PostgreSQL.Manipulation

5629 Squeal.PostgreSQL.Migration

5730 Squeal.PostgreSQL.Pool

58− Squeal.PostgreSQL.PG

5931 Squeal.PostgreSQL.PQ

6032 Squeal.PostgreSQL.Render

6133 Squeal.PostgreSQL.Query

@@ -70,9 +42,10 @@ library

7042 , bytestring >= 0.10.8.2

7143 , bytestring-strict-builder >= 0.4.5

7244 , deepseq >= 1.4.3.0

73− , free-categories >= 0.1.0.0

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

45+ , generics-sop >= 0.3.2.0

46+ , lifted-base >= 0.2.3.12

7547 , mmorph >= 1.1.1

48+ , monad-control >= 1.0.2.3

7649 , mtl >= 2.2.2

7750 , network-ip >= 0.3.0.2

7851 , postgresql-binary >= 0.12.1

@@ -83,55 +56,39 @@ library

8356 , text >= 1.2.3.0

8457 , time >= 1.8.0.2

8558 , transformers >= 0.5.2.0

86− , unliftio >= 0.2.10

87− , unliftio-pool >= 0.2.1.0

59+ , transformers-base >= 0.4.4

8860 , uuid-types >= 1.0.3

8961 , vector >= 0.12.0.1

9062

91−test-suite doctest

63+test-suite squeal-postgresql-doctest

9264 default-language: Haskell2010

9365 type: exitcode-stdio-1.0

9466 hs-source-dirs: test

9567 ghc-options: -Wall

96− main-is: Doc.hs

68+ main-is: DocTest.hs

9769 build-depends:

9870 base >= 4.10.0.0

9971 , doctest >= 0.11.4

100− , squeal-postgresql

10172

102−test-suite properties

73+test-suite squeal-postgresql-specs

10374 default-language: Haskell2010

10475 type: exitcode-stdio-1.0

105− hs-source-dirs: test

106− ghc-options: -Wall

107− main-is: Property.hs

76+ hs-source-dirs: test/Specs

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

78+ main-is: Specs.hs

79+ other-modules: ExceptionHandling

10880 build-depends:

10981 base >= 4.10.0.0

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

12783 , generics-sop >= 0.3.1.0

12884 , hspec >= 2.4.8

129− , mtl >= 2.2.2

13085 , squeal-postgresql

13186 , text >= 1.2.2.2

87+ , transformers >= 0.5.2.0

88+ , transformers-base >= 0.4.4

13289 , vector >= 0.12.0.1

13390

134−executable example

91+executable squeal-postgresql-example

13592 default-language: Haskell2010

13693 hs-source-dirs: exe

13794 ghc-options: -Wall

@@ -144,4 +101,5 @@ executable example

144101 , squeal-postgresql

145102 , text >= 1.2.2.2

146103 , transformers >= 0.5.2.0

104+ , transformers-base >= 0.4.4

147105 , vector >= 0.12.0.1

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

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

11{-|

22Module: Squeal.PostgreSQL

3−Description: Squeal export module

4−Copyright: (c) Eitan Chatav, 2019

3+Description: Squeel export module

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

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

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

1212features.

1313

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

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

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

16−

16+

1717We'll need some imports.

1818

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

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

20+>>> import Control.Monad.Base (liftBase)

2021>>> import Data.Int (Int32)

2122>>> import Data.Text (Text)

2223>>> import Squeal.PostgreSQL

24+>>> import Squeal.PostgreSQL.Render

2325

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

2527

@@ -58,7 +60,7 @@ yielding a `TableType`, or to pair a `ColumnConstraint` with a `NullityType`,

5860yielding a `ColumnType`. It is intended to connote Haskell's @=>@ operator

5961

6062Next, we'll write `Definition`s to set up and tear down the schema. In

61−Squeal, a `Definition` like `createTable`, `alterTable` or `dropTable`

63+Squeal, a `Definition` like `createTable`, `alterTable` or `dropTable`

6264has two type parameters, corresponding to the schema

6365before being run and the schema after. We can compose definitions using `>>>`.

6466Here and in the rest of our commands we make use of overloaded

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

6769>>> :{

6870let

6971 setup :: Definition (Public '[]) Schemas

70− setup =

72+ setup =

7173 createTable #users

7274 ( serial `as` #id :*

7375 (text & notNullable) `as` #name )

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

102104DROP TABLE "emails";

103105DROP TABLE "users";

104106

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

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

107−

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

109−>>> instance SOP.Generic User

110−>>> instance SOP.HasDatatypeInfo User

111−

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

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

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

115−and an output row. When

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

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

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

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

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

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

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

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

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

121−`with` statement.

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

116+of our inserts.

117+

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

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

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

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

122+

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

124+>>> instance SOP.Generic User

125+>>> instance SOP.HasDatatypeInfo User

122126

123127>>> :{

124128let

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

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

127131 where

128132 u = insertInto #users

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

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

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

131− e = insertInto_ #emails $ Select

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

133− (from (common #u))

135+ e = insertInto_ #emails

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

134137:}

135138

136139>>> printSQL insertUser

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

138141

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

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

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

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

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

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

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

143146

144147>>> :{

145148let

@@ -159,7 +162,7 @@ Let's create some users to add to the database.

159162>>> :{

160163let

161164 users :: [User]

162− users =

165+ users =

163166 [ User "Alice" (Just "alice@gmail.com")

164167 , User "Bob" Nothing

165168 , User "Carole" (Just "carole@hotmail.com")

@@ -181,53 +184,31 @@ let

181184 _ <- traversePrepared_ insertUser users

182185 usersResult <- runQuery getUsers

183186 usersRows <- getRows usersResult

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

187+ liftBase $ print (usersRows :: [User])

185188in

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

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

187190 define setup

188191 & pqThen session

189192 & pqThen (define teardown)

190193:}

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

192195-}

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

194−

195−import Squeal.PostgreSQL.Alias as X

196−import Squeal.PostgreSQL.Binary as X

197−import Squeal.PostgreSQL.Definition as X

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

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

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

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

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

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

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

205−import Squeal.PostgreSQL.Expression as X

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

224−import Squeal.PostgreSQL.List as X

225−import Squeal.PostgreSQL.Manipulation as X

226−import Squeal.PostgreSQL.Migration as X

227−import Squeal.PostgreSQL.PG as X

228−import Squeal.PostgreSQL.Pool as X

229−import Squeal.PostgreSQL.PQ as X

230−import Squeal.PostgreSQL.Query as X

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

232−import Squeal.PostgreSQL.Schema as X

233−import Squeal.PostgreSQL.Transaction as X

196+module Squeal.PostgreSQL

197+ ( module Squeal.PostgreSQL.Binary

198+ , module Squeal.PostgreSQL.Definition

199+ , module Squeal.PostgreSQL.Expression

200+ , module Squeal.PostgreSQL.Manipulation

201+ , module Squeal.PostgreSQL.PQ

202+ , module Squeal.PostgreSQL.Query

203+ , module Squeal.PostgreSQL.Schema

204+ , module Squeal.PostgreSQL.Transaction

205+ ) where

206+

207+import Squeal.PostgreSQL.Binary

208+import Squeal.PostgreSQL.Definition

209+import Squeal.PostgreSQL.Expression

210+import Squeal.PostgreSQL.Manipulation

211+import Squeal.PostgreSQL.PQ

212+import Squeal.PostgreSQL.Query

213+import Squeal.PostgreSQL.Schema

214+import Squeal.PostgreSQL.Transaction

squeal-postgresql/src/Squeal/PostgreSQL/Alias.hsdeleted−249

@@ -1,249 +0,0 @@

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

14− AllowAmbiguousTypes

15− , ConstraintKinds

16− , DeriveAnyClass

17− , DeriveGeneric

18− , FlexibleContexts

19− , FlexibleInstances

20− , FunctionalDependencies

21− , GADTs

22− , LambdaCase

23− , OverloadedStrings

24− , QuantifiedConstraints

25− , RankNTypes

26− , ScopedTypeVariables

27− , StandaloneDeriving

28− , TypeApplications

29− , TypeFamilyDependencies

30− , TypeInType

31− , TypeOperators

32− , UndecidableInstances

33− , UndecidableSuperClasses

34−#-}

35−

36−module Squeal.PostgreSQL.Alias

37− ( (:::)

38− , Alias (..)

39− , IsLabel (..)

40− , Aliased (As)

41− , Aliasable (as)

42− , renderAliased

43− , Has

44− , HasUnique

45− , HasAll

46− , HasIn

47− , QualifiedAlias (..)

48− , IsQualified (..)

49− -- * Grouping

50− , Grouping (..)

51− , GroupedBy

52− ) where

53−

54−import Control.DeepSeq

55−import Data.ByteString (ByteString)

56−import Data.String (fromString)

57−import GHC.OverloadedLabels

58−import GHC.TypeLits

59−

60−import qualified Generics.SOP as SOP

61−import qualified GHC.Generics as GHC

62−

63−import Squeal.PostgreSQL.List

64−import Squeal.PostgreSQL.Render

65−

66−-- $setup

67−-- >>> import Squeal.PostgreSQL

68−

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

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

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

72−infixr 6 :::

73−

74−

75−-- | `Grouping` is an auxiliary namespace, created by

76−-- @GROUP BY@ clauses (`Squeal.PostgreSQL.Query.group`), and used

77−-- for typesafe aggregation

78−data Grouping

79− = Ungrouped -- ^ no aggregation permitted

80− | Grouped [(Symbol,Symbol)] -- ^ aggregation required for any column which is not grouped

81−

82−{- | A `GroupedBy` constraint indicates that a table qualified column is

83−a member of the auxiliary namespace created by @GROUP BY@ clauses and thus,

84−may be called in an output `Squeal.PostgreSQL.Expression.Expression` without aggregating.

85−-}

86−class (KnownSymbol table, KnownSymbol column)

87− => GroupedBy table column bys where

88−instance {-# OVERLAPPING #-} (KnownSymbol table, KnownSymbol column)

89− => GroupedBy table column ('(table,column) ': bys)

90−instance {-# OVERLAPPABLE #-}

91− ( KnownSymbol table

92− , KnownSymbol column

93− , GroupedBy table column bys

94− ) => GroupedBy table column (tabcol ': bys)

95−

96−-- | `Alias`es are proxies for a type level string or `Symbol`

97−-- and have an `IsLabel` instance so that with @-XOverloadedLabels@

98−--

99−-- >>> :set -XOverloadedLabels

100−-- >>> #foobar :: Alias "foobar"

101−-- Alias

102−data Alias (alias :: Symbol) = Alias

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

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

105− fromLabel = Alias

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

107− fromLabel = fromLabel SOP.:* Nil

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

109−-- "jimbob"

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

111− renderSQL = doubleQuoted . fromString . symbolVal

112−

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

114−-- "jimbob", "kandi"

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

116− renderSQL

117− = commaSeparated

118− . SOP.hcollapse

119− . SOP.hcmap (SOP.Proxy @KnownSymbol) (SOP.K . renderSQL)

120−

121−-- | The `As` operator is used to name an expression. `As` is like a demoted

122−-- version of `:::`.

123−--

124−-- >>> Just "hello" `As` #hi :: Aliased Maybe ("hi" ::: String)

125−-- As (Just "hello") Alias

126−data Aliased expression aliased where

127− As

128− :: KnownSymbol alias

129− => expression ty

130− -> Alias alias

131− -> Aliased expression (alias ::: ty)

132−deriving instance Show (expression ty)

133− => Show (Aliased expression (alias ::: ty))

134−deriving instance Eq (expression ty)

135− => Eq (Aliased expression (alias ::: ty))

136−deriving instance Ord (expression ty)

137− => Ord (Aliased expression (alias ::: ty))

138−instance (alias0 ~ alias1, alias0 ~ alias2, KnownSymbol alias2)

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

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

141−

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

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

144−class KnownSymbol alias => Aliasable alias expression aliased

145− | aliased -> expression

146− , aliased -> alias

147− where as :: expression -> Alias alias -> aliased

148−instance (KnownSymbol alias, aliased ~ (alias ::: ty)) => Aliasable alias

149− (expression ty)

150− (Aliased expression aliased)

151− where

152− as = As

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

154− (expression ty)

155− (NP (Aliased expression) tys)

156− where

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

158−

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

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

161−-- "Just AS \"an_int\""

162−renderAliased

163− :: (forall ty. expression ty -> ByteString)

164− -> Aliased expression aliased

165− -> ByteString

166−renderAliased render (expression `As` alias) =

167− render expression <> " AS " <> renderSQL alias

168−

169−-- | @HasUnique alias fields field@ is a constraint that proves that

170−-- @fields@ is a singleton of @alias ::: field@.

171−type HasUnique alias fields field = fields ~ '[alias ::: field]

172−

173−-- | @Has alias fields field@ is a constraint that proves that

174−-- @fields@ has a field of @alias ::: field@, inferring @field@

175−-- from @alias@ and @fields@.

176−class KnownSymbol alias =>

177− Has (alias :: Symbol) (fields :: [(Symbol,kind)]) (field :: kind)

178− | alias fields -> field where

179−instance {-# OVERLAPPING #-} KnownSymbol alias

180− => Has alias (alias ::: field ': fields) field

181−instance {-# OVERLAPPABLE #-} (KnownSymbol alias, Has alias fields field)

182− => Has alias (field' ': fields) field

183−

184−{-| @HasIn fields (alias ::: field)@ is a constraint that proves that

185−@fields@ has a field of @alias ::: field@. It is used in @UPDATE@s to

186−choose which subfields to update.

187−-}

188−class HasIn fields field where

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

190−

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

192−-- a list of @subfields@.

193−class

194− ( SOP.All KnownSymbol aliases

195− ) => HasAll

196− (aliases :: [Symbol])

197− (fields :: [(Symbol,kind)])

198− (subfields :: [(Symbol,kind)])

199− | aliases fields -> subfields where

200−instance {-# OVERLAPPING #-} HasAll '[] fields '[]

201−instance {-# OVERLAPPABLE #-}

202− (Has alias fields field, HasAll aliases fields subfields)

203− => HasAll (alias ': aliases) fields (alias ::: field ': subfields)

204−

205−-- | Analagous to `IsLabel`, the constraint

206−-- `IsQualified` defines `!` for a column alias qualified

207−-- by a table alias.

208−class IsQualified table column expression where

209− (!) :: Alias table -> Alias column -> expression

210− infixl 9 !

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

212−

213−{-| `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,

216−a qualifier of @public@ is provided.

217−

218−>>> :{

219−let

220− alias1 :: QualifiedAlias "sch" "tab"

221− alias1 = #sch ! #tab

222− alias2 :: QualifiedAlias "public" "vw"

223− alias2 = #vw

224−in printSQL alias1 >> printSQL alias2

225−:}

226−"sch"."tab"

227−"vw"

228−-}

229−data QualifiedAlias (qualifier :: Symbol) (alias :: Symbol) = QualifiedAlias

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

231−instance (q ~ q', a ~ a') => IsQualified q a (QualifiedAlias q' a') where

232− _!_ = QualifiedAlias

233−instance (q' ~ "public", a ~ a') => IsLabel a (QualifiedAlias q' a') where

234− fromLabel = QualifiedAlias

235−instance (q0 ~ q1, a0 ~ a1, a1 ~ a2, KnownSymbol a2) =>

236− IsQualified q0 a0 (Aliased (QualifiedAlias q1) (a1 ::: a2)) where

237− _!_ = QualifiedAlias `As` Alias

238−instance (q ~ "public", a0 ~ a1, a1 ~ a2, KnownSymbol a2) =>

239− IsLabel a0 (Aliased (QualifiedAlias q) (a1 ::: a2)) where

240− fromLabel = QualifiedAlias `As` Alias

241−

242−instance (KnownSymbol q, KnownSymbol a)

243− => RenderSQL (QualifiedAlias q a) where

244− renderSQL _ =

245− let

246− qualifier = renderSQL (Alias @q)

247− alias = renderSQL (Alias @a)

248− in

249− if qualifier == "\"public\"" then alias else qualifier <> "." <> alias

squeal-postgresql/src/Squeal/PostgreSQL/Binary.hs+113−233

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

1+{-# LANGUAGE

2+ TypeFamilies

3+#-}

15{-|

26Module: Squeal.PostgreSQL.Binary

37Description: Binary encoding and decoding

@@ -7,7 +11,7 @@ Stability: experimental

711

812This module provides binary encoding and decoding between Haskell and PostgreSQL types.

913

10−Instances are governed by the `SOP.Generic` and `SOP.HasDatatypeInfo` typeclasses, so you absolutely

14+Instances are governed by the `Generic` and `HasDatatypeInfo` typeclasses, so you absolutely

1115do not need to define your own instances to decode retrieved rows into Haskell values or

1216to encode Haskell values into statement parameters.

1317

@@ -16,10 +20,10 @@ Let's see some examples. We'll need some imports

1620>>> import Data.Int (Int16)

1721>>> import Data.Text (Text)

1822>>> import Control.Monad (void)

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

23+>>> import Control.Monad.Base (liftBase)

2024>>> import Squeal.PostgreSQL

2125

22−Define a Haskell datatype @Row@ that will serve as both the input and output of a simple

26+Define a Haskell datatype `Row` that will serve as both the input and output of a simple

2327round trip query.

2428

2529>>> data Row = Row { col1 :: Int16, col2 :: Text, col3 :: Maybe Bool } deriving (Eq, GHC.Generic)

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

3943

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

4145>>> :{

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

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

4347 result <- runQueryParams roundTrip input

4448 Just output <- firstRow result

45− liftIO . print $ input == output

49+ liftBase . print $ input == output

4650:}

4751True

4852

4953In addition to being able to encode and decode basic Haskell types

50−like `Int16` and `Data.Text.Text`, Squeal permits you to encode and decode Haskell types to

54+like `Int16` and `Text`, Squeal permits you to encode and decode Haskell types to

5155Postgres array, enumerated and composite types and json. Let's see another example,

5256this time using the `Vector` type which corresponds to variable length arrays

5357and homogeneous tuples which correspond to fixed length arrays. We can even

@@ -78,10 +82,10 @@ let

7882>>> :set -XOverloadedLists

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

8084>>> :{

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

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

8286 result <- runQueryParams roundTrip input

8387 Just output <- firstRow result

84− liftIO . print $ input == output

88+ liftBase . print $ input == output

8589:}

8690True

8791

@@ -120,9 +124,9 @@ let

120124 createTypeCompositeFrom @Person #person

121125:}

122126

123−Let's demonstrate how to associate our Haskell types @Schwarma@ and @Person@

127+Let's demonstrate how to associate our Haskell types `Schwarma` and `Person`

124128with enumerated, composite or json types in Postgres. First create a Haskell

125−@Row@ type using the `Enumerated`, `Composite` and `Json` newtypes as fields.

129+`Row` type using the `Enumerated`, `Composite` and `Json` newtypes as fields.

126130

127131>>> :{

128132data Row = Row

@@ -168,9 +172,9 @@ let

168172 session = do

169173 result <- runQueryParams roundTrip input

170174 Just output <- firstRow result

171− liftIO . print $ input == output

175+ liftBase . print $ input == output

172176in

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

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

174178 define setup

175179 & pqThen session

176180 & pqThen (define teardown)

@@ -194,31 +198,25 @@ True

194198 , MultiParamTypeClasses

195199 , ScopedTypeVariables

196200 , TypeApplications

197− , TypeFamilies

198201 , TypeInType

199202 , TypeOperators

200203 , UndecidableInstances

201− , UndecidableSuperClasses

202204#-}

203205

204206module Squeal.PostgreSQL.Binary

205− ( -- * Encoding

206− ToParam (..)

207+ ( Json (..)

208+ , Jsonb (..)

209+ , Composite (..)

210+ , Enumerated (..)

211+ , VarArray (..)

212+ -- * Encoding

213+ , ToParam (..)

207214 , ToParams (..)

208− , ToNullityParam (..)

209− , ToField (..)

210− , ToFixArray (..)

211215 -- * Decoding

212216 , FromValue (..)

213217 , FromRow (..)

214− , FromField (..)

215− , FromFixArray (..)

216218 -- * Only

217219 , Only (..)

218− -- * Oid

219− , OidOf (..)

220− , OidOfParam (..)

221− , OidOfField (..)

222220 ) where

223221

224222import BinaryParser

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

232230import Data.UUID.Types

233231import Data.Vector (Vector)

234232import Data.Word

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

236233import Generics.SOP

237234import Generics.SOP.Record

238235import GHC.TypeLits

@@ -246,14 +243,10 @@ import qualified Data.Text.Lazy as Lazy (Text)

246243import qualified Data.Text as Strict (Text)

247244import qualified Data.Text as Strict.Text

248245import qualified Data.Vector as Vector

249−import qualified Database.PostgreSQL.LibPQ as LibPQ

250246import qualified GHC.Generics as GHC

251247import qualified PostgreSQL.Binary.Decoding as Decoding

252248import qualified PostgreSQL.Binary.Encoding as Encoding

253249

254−import Squeal.PostgreSQL.Alias

255−import Squeal.PostgreSQL.List

256−import Squeal.PostgreSQL.PG

257250import Squeal.PostgreSQL.Schema

258251

259252-- | A `ToParam` constraint gives an encoding of a Haskell `Type` into

@@ -277,13 +270,14 @@ class ToParam (x :: Type) (pg :: PGType) where

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

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

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

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

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

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

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

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

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

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

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

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

286−instance ToParam Money 'PGmoney where toParam = K . Encoding.int8_int64 . cents

287281instance ToParam UUID 'PGuuid where toParam = K . Encoding.uuid

288282instance ToParam (NetAddr IP) 'PGinet where toParam = K . Encoding.inet

289283instance ToParam Char ('PGchar 1) where toParam = K . Encoding.char_utf8

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

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

313307 toParam = K . Encoding.jsonb_bytes

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

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

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

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

317311 toParam = K

318− . Encoding.array_foldable

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

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

320313 . getVarArray

321−instance (ToParam x pg, OidOf pg)

314+instance (ToParam x pg, HasOid pg)

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

323316 toParam = K

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

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

325318 . getVarArray

326−instance (ToParam x pg, OidOf pg)

319+instance (ToParam x pg, HasOid pg)

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

328321 toParam = K

329− . Encoding.nullableArray_vector

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

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

331323 . getVarArray

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

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

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

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

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

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

336328instance

337329 ( IsEnumType x

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

356348 ( SListI fields

357349 , IsRecord x xs

358350 , AllZip ToField xs fields

359− , All OidOfField fields

351+ , All HasAliasedOid fields

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

361353 toParam =

362354 let

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

364356 encoders = htrans (Proxy @ToField) toField

365357

366358 composite

367− :: All OidOfField row

359+ :: All HasAliasedOid row

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

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

370362 composite fields = K $

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

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

382374 let

383375 each

384− :: OidOfField field

376+ :: HasAliasedOid field

385377 => K (Maybe Encoding.Encoding) field

386378 -> Encoding.Encoding

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

388− word32BE (getOid (oidOfField @field))

380+ word32BE (aliasedOid @field)

389381 <> case field of

390382 Nothing -> int64BE (-1)

391383 Just value ->

392384 int32BE (fromIntegral (builderLength value))

393385 <> value

394386 in

395− hcfoldMap (Proxy @OidOfField) each fields

387+ hcfoldMap (Proxy @HasAliasedOid) each fields

396388

397389 in

398390 composite . encoders . toRecord . getComposite

399391

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

401−--

402−-- >>> :set -XTypeApplications

403−-- >>> oidOf @'PGbool

404−-- Oid 16

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

508−

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

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

511−

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

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

514− oidOfField :: Oid

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

516− oidOfField = oidOf @ty

517−

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

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

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

393+ aliasedOid :: Word32

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

395+ aliasedOid = oid @ty

396+

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

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

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

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

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

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

526403

527−-- | A `ToField` constraint lifts the `ToParam` parser

528−-- to an encoding of a @(Symbol, Type)@ to a @(Symbol, NullityType)@,

529−-- encoding `Null`s to `Maybe`s. You should not define instances for

530−-- `FromField`, just use the provided instances.

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

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

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

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

535408

536−-- | A `ToFixArray` constraint gives an encoding of a Haskell `Type`

537−-- into the binary format of a PostgreSQL fixed-length array.

538−-- You should not define instances for

539−-- `ToFixArray`, just use the provided instances.

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

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

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

@@ -553,7 +422,7 @@ instance

553422

554423-- | A `ToParams` constraint generically sequences the encodings of `Type`s

555424-- of the fields of a tuple or record to a row of `ColumnType`s. You should

556−-- not define instances of `ToParams`. Instead define `SOP.Generic` instances

425+-- not define instances of `ToParams`. Instead define `Generic` instances

557426-- which in turn provide `ToParams` instances.

558427class SListI tys => ToParams (x :: Type) (tys :: [NullityType]) where

559428 -- | >>> type Params = '[ 'NotNull 'PGbool, 'Null 'PGint2]

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

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

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

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

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

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

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

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

589−instance FromValue 'PGmoney Money where fromValue = Money <$> Decoding.int

590457instance FromValue 'PGuuid UUID where fromValue = Decoding.uuid

591458instance FromValue 'PGinet (NetAddr IP) where fromValue = Decoding.inet

592459instance FromValue ('PGchar 1) Char where fromValue = Decoding.char

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

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

722589 Decoding.valueParser (fromValue @pg) bytestring

723590

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.

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

729592 fromFixArray :: Decoding.Array y

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

@@ -746,7 +609,7 @@ instance

746609-- | A `FromRow` constraint generically sequences the parsings of the columns

747610-- of a `RowType` into the fields of a record `Type` provided they have

748611-- the same field names. You should not define instances of `FromRow`.

749−-- Instead define `SOP.Generic` and `SOP.HasDatatypeInfo` instances which in turn

612+-- Instead define `Generic` and `HasDatatypeInfo` instances which in turn

750613-- provide `FromRow` instances.

751614class SListI result => FromRow (result :: RowType) y where

752615 -- | >>> :set -XOverloadedStrings

@@ -769,53 +632,6 @@ instance

769632 = fmap fromRecord

770633 . hsequence'

771634 . htrans (Proxy @FromField) fromField

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

773−-- P records

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

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

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

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

778−-- instance

779−-- ( row ~ Join row1 row2

780−-- , FromRow row1 hask1

781−-- , FromRow row2 hask2

782−-- , SListI row

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

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

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

786−-- instance

787−-- ( row ~ Join row1 row23

788−-- , FromRow row1 hask1

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

790−-- , SListI row

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

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

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

794−-- hask1 <- fromRow row1

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

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

797−-- instance

798−-- ( row ~ Join row1 row234

799−-- , FromRow row1 hask1

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

801−-- , SListI row

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

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

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

805−-- hask1 <- fromRow row1

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

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

808−-- instance

809−-- ( row ~ Join row1 row2345

810−-- , FromRow row1 hask1

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

812−-- , SListI row

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

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

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

816−-- hask1 <- fromRow row1

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

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

819635

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

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

@@ -842,7 +658,71 @@ replicateMN

842658 :: forall x xs m. (All ((~) x) xs, Monad m, SListI xs)

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

844660replicateMN mx = hsequence' $

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

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

662+

663+{- | The `Json` newtype is an indication that the Haskell

664+type it's applied to should be stored as a `PGjson`.

665+-}

666+newtype Json hask = Json {getJson :: hask}

667+ deriving (Eq, Ord, Show, Read, GHC.Generic)

668+type instance PG (Json hask) = 'PGjson

846669

847−getOid :: LibPQ.Oid -> Word32

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

670+{- | The `Jsonb` newtype is an indication that the Haskell

671+type it's applied to should be stored as a `PGjsonb`.

672+-}

673+newtype Jsonb hask = Jsonb {getJsonb :: hask}

674+ deriving (Eq, Ord, Show, Read, GHC.Generic)

675+type instance PG (Jsonb hask) = 'PGjsonb

676+

677+{- | The `Composite` newtype is an indication that the Haskell

678+type it's applied to should be stored as a `PGcomposite`.

679+-}

680+newtype Composite record = Composite {getComposite :: record}

681+ deriving (Eq, Ord, Show, Read, GHC.Generic)

682+type instance PG (Composite hask) = 'PGcomposite (RowPG hask)

683+

684+{- | The `Enumerated` newtype is an indication that the Haskell

685+type it's applied to should be stored as a `PGenum`.

686+-}

687+newtype Enumerated enum = Enumerated {getEnumerated :: enum}

688+ deriving (Eq, Ord, Show, Read, GHC.Generic)

689+type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)

690+

691+{- | The `VarArray` newtype is an indication that the Haskell

692+type it's applied to should be stored as a `PGvararray`.

693+-}

694+newtype VarArray arr = VarArray {getVarArray :: arr}

695+ deriving (Eq, Ord, Show, Read, GHC.Generic)

696+type instance PG (VarArray (Vector hask)) = 'PGvararray (NullPG hask)

697+

698+{- | The `FixArray` newtype is an indication that the Haskell

699+type it's applied to should be stored as a `PGfixarray`.

700+-}

701+newtype FixArray arr = FixArray {getFixArray :: arr}

702+ deriving (Eq, Ord, Show, Read, GHC.Generic)

703+type instance PG (FixArray x) = 'PGfixarray (DimPG x) (FixPG x)

704+

705+type family DimPG (hask :: Type) :: [Nat] where

706+ DimPG (x,x) = 2 ': DimPG x

707+ DimPG (x,x,x) = 3 ': DimPG x

708+ DimPG (x,x,x,x) = 4 ': DimPG x

709+ DimPG (x,x,x,x,x) = 5 ': DimPG x

710+ DimPG (x,x,x,x,x,x) = 6 ': DimPG x

711+ DimPG (x,x,x,x,x,x,x) = 7 ': DimPG x

712+ DimPG (x,x,x,x,x,x,x,x) = 8 ': DimPG x

713+ DimPG (x,x,x,x,x,x,x,x,x) = 9 ': DimPG x

714+ DimPG (x,x,x,x,x,x,x,x,x,x) = 10 ': DimPG x

715+ DimPG x = '[]

716+

717+type family FixPG (hask :: Type) :: NullityType where

718+ FixPG (x,x) = FixPG x

719+ FixPG (x,x,x) = FixPG x

720+ FixPG (x,x,x,x) = FixPG x

721+ FixPG (x,x,x,x,x) = FixPG x

722+ FixPG (x,x,x,x,x,x) = FixPG x

723+ FixPG (x,x,x,x,x,x,x) = FixPG x

724+ FixPG (x,x,x,x,x,x,x,x) = FixPG x

725+ FixPG (x,x,x,x,x,x,x,x,x) = FixPG x

726+ FixPG (x,x,x,x,x,x,x,x,x,x) = FixPG x

727+ FixPG (x,x,x,x,x,x,x,x,x,x,x) = FixPG x

728+ FixPG x = NullPG x

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

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

1111{-# LANGUAGE

1212 AllowAmbiguousTypes

1313 , ConstraintKinds

14− , DeriveAnyClass

1514 , DeriveGeneric

16− , DerivingStrategies

1715 , FlexibleContexts

1816 , FlexibleInstances

1917 , GADTs

18+ , GeneralizedNewtypeDeriving

2019 , LambdaCase

2120 , MultiParamTypeClasses

22− , OverloadedLabels

2321 , OverloadedStrings

2422 , RankNTypes

2523 , ScopedTypeVariables

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

2725 , TypeInType

2826 , TypeOperators

2927 , UndecidableSuperClasses

30− , UndecidableInstances

3128#-}

3229

3330module Squeal.PostgreSQL.Definition

3431 ( -- * Definition

3532 Definition (..)

3633 , (>>>)

37− , manipDefinition

34+ -- * Tables

35+ -- ** Create

36+ , createSchema

37+ , createSchemaIfNotExists

38+ , createTable

39+ , createTableIfNotExists

40+ , TableConstraintExpression (..)

41+ , check

42+ , unique

43+ , primaryKey

44+ , foreignKey

45+ , ForeignKeyed

46+ , OnDeleteClause (..)

47+ , OnUpdateClause (..)

48+ -- ** Drop

49+ , dropTable

50+ -- ** Alter

51+ , alterTable

52+ , alterTableRename

53+ , AlterTable (..)

54+ , addConstraint

55+ , dropConstraint

56+ , AddColumn (..)

57+ , dropColumn

58+ , renameColumn

59+ , alterColumn

60+ , AlterColumn (..)

61+ , setDefault

62+ , dropDefault

63+ , setNotNull

64+ , dropNotNull

65+ , alterType

66+ -- * Views

67+ , createView

68+ , dropView

69+ -- * Types

70+ , createTypeEnum

71+ , createTypeEnumFrom

72+ , createTypeComposite

73+ , createTypeCompositeFrom

74+ , dropType

75+ -- * Columns

76+ , ColumnTypeExpression (..)

77+ , nullable

78+ , notNullable

79+ , default_

80+ , serial2

81+ , smallserial

82+ , serial4

83+ , serial

84+ , serial8

85+ , bigserial

3886 ) where

3987

4088import Control.Category

4189import Control.DeepSeq

4290import Data.ByteString

4391import Data.Monoid

92+import GHC.TypeLits

4493import Prelude hiding ((.), id)

4594

95+import qualified Generics.SOP as SOP

4696import qualified GHC.Generics as GHC

4797

48−import Squeal.PostgreSQL.Manipulation

98+import Squeal.PostgreSQL.Binary

99+import Squeal.PostgreSQL.Expression

100+import Squeal.PostgreSQL.Query

49101import Squeal.PostgreSQL.Render

50102import Squeal.PostgreSQL.Schema

51103

52−-- $setup

53−-- >>> import Squeal.PostgreSQL

54−

55104{-----------------------------------------

56105statements

57106-----------------------------------------}

@@ -73,10 +122,915 @@ instance Category Definition where

73122 ddl1 . ddl0 = UnsafeDefinition $

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

75124

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

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

78−manipDefinition

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

80− -- ^ no input or output

125+{-----------------------------------------

126+CREATE statements

127+-----------------------------------------}

128+

129+createSchema

130+ :: KnownSymbol sch

131+ => Alias sch

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

133+createSchema sch = UnsafeDefinition $

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

135+

136+createSchemaIfNotExists

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

138+ => Alias sch

139+ -> Definition schemas schemas

140+createSchemaIfNotExists sch = UnsafeDefinition $

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

142+ <+> renderSQL sch <> ";"

143+

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

145+

146+>>> :set -XOverloadedLabels

147+>>> :{

148+type Table = '[] :=>

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

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

151+:}

152+

153+>>> :{

154+let

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

156+ setup = createTable #tab

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

158+in printSQL setup

159+:}

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

161+-}

162+createTable

163+ :: ( KnownSymbol sch

164+ , KnownSymbol tab

165+ , columns ~ (col ': cols)

166+ , SOP.SListI columns

167+ , SOP.SListI constraints

168+ , Has sch schemas0 schema0

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

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

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

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

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

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

175+ -> Definition schemas0 schemas1

176+createTable tab columns constraints = UnsafeDefinition $

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

178+

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

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

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

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

183+

184+>>> :set -XOverloadedLabels -XTypeApplications

185+>>> :{

186+type Table = '[] :=>

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

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

189+:}

190+

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

192+

193+>>> :{

194+let

195+ setup :: Definition Schemas Schemas

196+ setup = createTableIfNotExists #tab

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

198+in printSQL setup

199+:}

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

201+-}

202+createTableIfNotExists

203+ :: ( Has sch schemas schema

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

205+ , SOP.SListI columns

206+ , SOP.SListI constraints )

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

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

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

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

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

81212 -> Definition schemas schemas

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

213+createTableIfNotExists tab columns constraints = UnsafeDefinition $

214+ "CREATE TABLE IF NOT EXISTS"

215+ <+> renderCreation tab columns constraints

216+

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

218+renderCreation

219+ :: ( KnownSymbol sch

220+ , KnownSymbol tab

221+ , SOP.SListI columns

222+ , SOP.SListI constraints )

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

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

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

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

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

228+ -> ByteString

229+renderCreation tab columns constraints = renderSQL tab

230+ <+> parenthesized

231+ ( renderCommaSeparated renderColumnDef columns

232+ <> ( case constraints of

233+ Nil -> ""

234+ _ -> ", " <>

235+ renderCommaSeparated renderConstraint constraints ) )

236+ <> ";"

237+ where

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

239+ renderColumnDef (ty `As` column) =

240+ renderSQL column <+> renderColumnTypeExpression ty

241+ renderConstraint

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

243+ -> ByteString

244+ renderConstraint (constraint `As` alias) =

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

246+

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

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

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

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

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

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

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

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

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

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

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

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

259+newtype TableConstraintExpression

260+ (sch :: Symbol)

261+ (tab :: Symbol)

262+ (schemas :: SchemasType)

263+ (constraint :: TableConstraint)

264+ = UnsafeTableConstraintExpression

265+ { renderTableConstraintExpression :: ByteString }

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

267+instance RenderSQL

268+ (TableConstraintExpression sch tab schemas constraint) where

269+ renderSQL = renderTableConstraintExpression

270+

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

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

273+a Boolean (truth-value) expression.

274+

275+>>> :{

276+type Schema = '[

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

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

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

280+ ])]

281+:}

282+

283+>>> :{

284+let

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

286+ definition = createTable #tab

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

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

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

290+:}

291+

292+>>> printSQL definition

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

294+-}

295+check

296+ :: ( Has sch schemas schema

297+ , Has tab schema ('Table table)

298+ , HasAll aliases (TableToRow table) subcolumns )

299+ => NP Alias aliases

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

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

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

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

304+check _cols condition = UnsafeTableConstraintExpression $

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

306+

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

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

309+

310+>>> :{

311+type Schema = '[

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

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

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

315+ ])]

316+:}

317+

318+>>> :{

319+let

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

321+ definition = createTable #tab

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

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

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

325+:}

326+

327+>>> printSQL definition

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

329+-}

330+unique

331+ :: ( Has sch schemas schema

332+ , Has tab schema('Table table)

333+ , HasAll aliases (TableToRow table) subcolumns )

334+ => NP Alias aliases

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

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

337+unique columns = UnsafeTableConstraintExpression $

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

339+

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

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

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

343+

344+>>> :{

345+type Schema = '[

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

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

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

349+ ])]

350+:}

351+

352+>>> :{

353+let

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

355+ definition = createTable #tab

356+ ( serial `as` #id :*

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

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

359+:}

360+

361+>>> printSQL definition

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

363+-}

364+primaryKey

365+ :: ( Has sch schemas schema

366+ , Has tab schema ('Table table)

367+ , HasAll aliases (TableToColumns table) subcolumns

368+ , AllNotNull subcolumns )

369+ => NP Alias aliases

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

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

372+primaryKey columns = UnsafeTableConstraintExpression $

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

374+

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

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

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

378+between two related tables.

379+

380+>>> :{

381+type Schema =

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

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

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

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

386+ ])

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

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

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

390+ ] :=>

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

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

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

394+ ])

395+ ]

396+:}

397+

398+>>> :{

399+let

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

401+ setup =

402+ createTable #users

403+ ( serial `as` #id :*

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

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

406+ createTable #emails

407+ ( serial `as` #id :*

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

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

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

411+ foreignKey #user_id #users #id

412+ OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

413+in printSQL setup

414+:}

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

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

417+

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

419+

420+>>> :{

421+type Schema =

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

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

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

425+ ] :=>

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

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

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

429+ ])

430+ ]

431+:}

432+

433+>>> :{

434+let

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

436+ setup =

437+ createTable #employees

438+ ( serial `as` #id :*

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

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

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

442+ foreignKey #employer_id #employees #id

443+ OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )

444+in printSQL setup

445+:}

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

447+-}

448+foreignKey

449+ :: (ForeignKeyed schemas sch schema child parent

450+ table reftable

451+ columns refcolumns

452+ constraints cols

453+ reftys tys )

454+ => NP Alias columns

455+ -- ^ column or columns in the table

456+ -> Alias parent

457+ -- ^ reference table

458+ -> NP Alias refcolumns

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

460+ -> OnDeleteClause

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

462+ -> OnUpdateClause

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

464+ -> TableConstraintExpression sch child schemas

465+ ('ForeignKey columns parent refcolumns)

466+foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $

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

468+ <+> "REFERENCES" <+> renderSQL parent

469+ <+> parenthesized (renderSQL refs)

470+ <+> renderSQL ondel

471+ <+> renderSQL onupd

472+

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

474+type ForeignKeyed schemas

475+ sch

476+ schema

477+ child parent

478+ table reftable

479+ columns refcolumns

480+ constraints cols

481+ reftys tys =

482+ ( Has sch schemas schema

483+ , Has child schema ('Table table)

484+ , Has parent schema ('Table reftable)

485+ , HasAll columns (TableToColumns table) tys

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

487+ , HasAll refcolumns cols reftys

488+ , SOP.AllZip SamePGType tys reftys

489+ , Uniquely refcolumns constraints )

490+

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

492+data OnDeleteClause

493+ = OnDeleteNoAction

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

495+ -- an error is raised

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

497+ | OnDeleteCascade

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

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

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

501+instance NFData OnDeleteClause

502+-- | Render `OnDeleteClause`.

503+instance RenderSQL OnDeleteClause where

504+ renderSQL = \case

505+ OnDeleteNoAction -> "ON DELETE NO ACTION"

506+ OnDeleteRestrict -> "ON DELETE RESTRICT"

507+ OnDeleteCascade -> "ON DELETE CASCADE"

508+

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

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

511+data OnUpdateClause

512+ = OnUpdateNoAction

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

514+ -- an error is raised

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

516+ | OnUpdateCascade

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

518+ -- into the referencing row(s)

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

520+instance NFData OnUpdateClause

521+

522+-- | Render `OnUpdateClause`.

523+instance RenderSQL OnUpdateClause where

524+ renderSQL = \case

525+ OnUpdateNoAction -> "ON UPDATE NO ACTION"

526+ OnUpdateRestrict -> "ON UPDATE RESTRICT"

527+ OnUpdateCascade -> "ON UPDATE CASCADE"

528+

529+{-----------------------------------------

530+DROP statements

531+-----------------------------------------}

532+

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

534+--

535+-- >>> :{

536+-- let

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

538+-- definition = dropTable #muh_table

539+-- :}

540+--

541+-- >>> printSQL definition

542+-- DROP TABLE "muh_table";

543+dropTable

544+ :: ( Has sch schemas schema

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

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

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

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

549+

550+{-----------------------------------------

551+ALTER statements

552+-----------------------------------------}

553+

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

555+alterTable

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

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

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

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

560+alterTable tab alteration = UnsafeDefinition $

561+ "ALTER TABLE"

562+ <+> renderSQL tab

563+ <+> renderAlterTable alteration

564+ <> ";"

565+

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

567+--

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

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

570+alterTableRename

571+ :: (KnownSymbol table0, KnownSymbol table1)

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

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

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

575+alterTableRename table0 table1 = UnsafeDefinition $

576+ "ALTER TABLE" <+> renderSQL table0

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

578+

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

580+-- of a table.

581+newtype AlterTable

582+ (sch :: Symbol)

583+ (tab :: Symbol)

584+ (schemas :: SchemasType)

585+ (table :: TableType) =

586+ UnsafeAlterTable {renderAlterTable :: ByteString}

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

588+

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

590+--

591+-- >>> :{

592+-- let

593+-- definition :: Definition

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

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

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

597+-- in printSQL definition

598+-- :}

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

600+addConstraint

601+ :: ( KnownSymbol alias

602+ , Has sch schemas schema

603+ , Has tab schema ('Table table0)

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

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

606+ => Alias alias

607+ -> TableConstraintExpression sch tab schemas constraint

608+ -- ^ constraint to add

609+ -> AlterTable sch tab schemas table1

610+addConstraint alias constraint = UnsafeAlterTable $

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

612+ <+> renderSQL constraint

613+

614+-- | A `dropConstraint` drops a table constraint.

615+--

616+-- >>> :{

617+-- let

618+-- definition :: Definition

619+-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

620+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

621+-- definition = alterTable #tab (dropConstraint #positive)

622+-- in printSQL definition

623+-- :}

624+-- ALTER TABLE "tab" DROP CONSTRAINT "positive";

625+dropConstraint

626+ :: ( KnownSymbol constraint

627+ , Has sch schemas schema

628+ , Has tab schema ('Table table0)

629+ , table0 ~ (constraints :=> columns)

630+ , table1 ~ (Drop constraint constraints :=> columns) )

631+ => Alias constraint

632+ -- ^ constraint to drop

633+ -> AlterTable sch tab schemas table1

634+dropConstraint constraint = UnsafeAlterTable $

635+ "DROP" <+> "CONSTRAINT" <+> renderSQL constraint

636+

637+-- | An `AddColumn` is either @NULL@ or has @DEFAULT@.

638+class AddColumn ty where

639+ -- | `addColumn` adds a new column, initially filled with whatever

640+ -- default value is given or with @NULL@.

641+ --

642+ -- >>> :{

643+ -- let

644+ -- definition :: Definition

645+ -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

646+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>

647+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

648+ -- , "col2" ::: 'Def :=> 'Null 'PGtext ])]]

649+ -- definition = alterTable #tab (addColumn #col2 (text & nullable & default_ "foo"))

650+ -- in printSQL definition

651+ -- :}

652+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL DEFAULT E'foo';

653+ --

654+ -- >>> :{

655+ -- let

656+ -- definition :: Definition

657+ -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

658+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>

659+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

660+ -- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

661+ -- definition = alterTable #tab (addColumn #col2 (text & nullable))

662+ -- in printSQL definition

663+ -- :}

664+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL;

665+ addColumn

666+ :: ( KnownSymbol column

667+ , Has sch schemas schema

668+ , Has tab schema ('Table table0)

669+ , table0 ~ (constraints :=> columns) )

670+ => Alias column -- ^ column to add

671+ -> ColumnTypeExpression schemas ty -- ^ type of the new column

672+ -> AlterTable sch tab schemas (constraints :=> Create column ty columns)

673+ addColumn column ty = UnsafeAlterTable $

674+ "ADD COLUMN" <+> renderSQL column <+> renderColumnTypeExpression ty

675+instance {-# OVERLAPPING #-} AddColumn ('Def :=> ty)

676+instance {-# OVERLAPPABLE #-} AddColumn ('NoDef :=> 'Null ty)

677+

678+-- | A `dropColumn` removes a column. Whatever data was in the column

679+-- disappears. Table constraints involving the column are dropped, too.

680+-- However, if the column is referenced by a foreign key constraint of

681+-- another table, PostgreSQL will not silently drop that constraint.

682+--

683+-- >>> :{

684+-- let

685+-- definition :: Definition

686+-- '["public" ::: '["tab" ::: 'Table ('[] :=>

687+-- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

688+-- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

689+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

690+-- definition = alterTable #tab (dropColumn #col2)

691+-- in printSQL definition

692+-- :}

693+-- ALTER TABLE "tab" DROP COLUMN "col2";

694+dropColumn

695+ :: ( KnownSymbol column

696+ , Has sch schemas schema

697+ , Has tab schema ('Table table0)

698+ , table0 ~ (constraints :=> columns)

699+ , table1 ~ (constraints :=> Drop column columns) )

700+ => Alias column -- ^ column to remove

701+ -> AlterTable sch tab schemas table1

702+dropColumn column = UnsafeAlterTable $

703+ "DROP COLUMN" <+> renderSQL column

704+

705+-- | A `renameColumn` renames a column.

706+--

707+-- >>> :{

708+-- let

709+-- definition :: Definition

710+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["foo" ::: 'NoDef :=> 'Null 'PGint4])]]

711+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["bar" ::: 'NoDef :=> 'Null 'PGint4])]]

712+-- definition = alterTable #tab (renameColumn #foo #bar)

713+-- in printSQL definition

714+-- :}

715+-- ALTER TABLE "tab" RENAME COLUMN "foo" TO "bar";

716+renameColumn

717+ :: ( KnownSymbol column0

718+ , KnownSymbol column1

719+ , Has sch schemas schema

720+ , Has tab schema ('Table table0)

721+ , table0 ~ (constraints :=> columns)

722+ , table1 ~ (constraints :=> Rename column0 column1 columns) )

723+ => Alias column0 -- ^ column to rename

724+ -> Alias column1 -- ^ what to rename the column

725+ -> AlterTable sch tab schemas table1

726+renameColumn column0 column1 = UnsafeAlterTable $

727+ "RENAME COLUMN" <+> renderSQL column0 <+> "TO" <+> renderSQL column1

728+

729+-- | An `alterColumn` alters a single column.

730+alterColumn

731+ :: ( KnownSymbol column

732+ , Has sch schemas schema

733+ , Has tab schema ('Table table0)

734+ , table0 ~ (constraints :=> columns)

735+ , Has column columns ty0

736+ , table1 ~ (constraints :=> Alter column ty1 columns))

737+ => Alias column -- ^ column to alter

738+ -> AlterColumn schemas ty0 ty1 -- ^ alteration to perform

739+ -> AlterTable sch tab schemas table1

740+alterColumn column alteration = UnsafeAlterTable $

741+ "ALTER COLUMN" <+> renderSQL column <+> renderAlterColumn alteration

742+

743+-- | An `AlterColumn` describes the alteration to perform on a single column.

744+newtype AlterColumn (schemas :: SchemasType) (ty0 :: ColumnType) (ty1 :: ColumnType) =

745+ UnsafeAlterColumn {renderAlterColumn :: ByteString}

746+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

747+

748+-- | A `setDefault` sets a new default for a column. Note that this doesn't

749+-- affect any existing rows in the table, it just changes the default for

750+-- future insert and update commands.

751+--

752+-- >>> :{

753+-- let

754+-- definition :: Definition

755+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

756+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]

757+-- definition = alterTable #tab (alterColumn #col (setDefault 5))

758+-- in printSQL definition

759+-- :}

760+-- ALTER TABLE "tab" ALTER COLUMN "col" SET DEFAULT 5;

761+setDefault

762+ :: Expression 'Ungrouped '[] schemas '[] '[] ty -- ^ default value to set

763+ -> AlterColumn schemas (constraint :=> ty) ('Def :=> ty)

764+setDefault expression = UnsafeAlterColumn $

765+ "SET DEFAULT" <+> renderExpression expression

766+

767+-- | A `dropDefault` removes any default value for a column.

768+--

769+-- >>> :{

770+-- let

771+-- definition :: Definition

772+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]

773+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

774+-- definition = alterTable #tab (alterColumn #col dropDefault)

775+-- in printSQL definition

776+-- :}

777+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP DEFAULT;

778+dropDefault :: AlterColumn schemas ('Def :=> ty) ('NoDef :=> ty)

779+dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"

780+

781+-- | A `setNotNull` adds a @NOT NULL@ constraint to a column.

782+-- The constraint will be checked immediately, so the table data must satisfy

783+-- the constraint before it can be added.

784+--

785+-- >>> :{

786+-- let

787+-- definition :: Definition

788+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

789+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

790+-- definition = alterTable #tab (alterColumn #col setNotNull)

791+-- in printSQL definition

792+-- :}

793+-- ALTER TABLE "tab" ALTER COLUMN "col" SET NOT NULL;

794+setNotNull

795+ :: AlterColumn schemas (constraint :=> 'Null ty) (constraint :=> 'NotNull ty)

796+setNotNull = UnsafeAlterColumn $ "SET NOT NULL"

797+

798+-- | A `dropNotNull` drops a @NOT NULL@ constraint from a column.

799+--

800+-- >>> :{

801+-- let

802+-- definition :: Definition

803+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

804+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

805+-- definition = alterTable #tab (alterColumn #col dropNotNull)

806+-- in printSQL definition

807+-- :}

808+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP NOT NULL;

809+dropNotNull

810+ :: AlterColumn schemas (constraint :=> 'NotNull ty) (constraint :=> 'Null ty)

811+dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"

812+

813+-- | An `alterType` converts a column to a different data type.

814+-- This will succeed only if each existing entry in the column can be

815+-- converted to the new type by an implicit cast.

816+--

817+-- >>> :{

818+-- let

819+-- definition :: Definition

820+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

821+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGnumeric])]]

822+-- definition =

823+-- alterTable #tab (alterColumn #col (alterType (numeric & notNullable)))

824+-- in printSQL definition

825+-- :}

826+-- ALTER TABLE "tab" ALTER COLUMN "col" TYPE numeric NOT NULL;

827+alterType :: ColumnTypeExpression schemas ty -> AlterColumn schemas ty0 ty

828+alterType ty = UnsafeAlterColumn $ "TYPE" <+> renderColumnTypeExpression ty

829+

830+{- | Create a view.

831+>>> type ABC = '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4]

832+>>> type BC = '["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4]

833+>>> :{

834+let

835+ definition :: Definition

836+ '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC)]]

837+ '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC), "bc" ::: 'View BC]]

838+ definition =

839+ createView #bc (select_ (#b :* #c) (from (table #abc)))

840+in printSQL definition

841+:}

842+CREATE VIEW "bc" AS SELECT "b" AS "b", "c" AS "c" FROM "abc" AS "abc";

843+-}

844+createView

845+ :: (KnownSymbol sch, KnownSymbol vw, Has sch schemas schema)

846+ => QualifiedAlias sch vw -- ^ the name of the view to add

847+ -> Query '[] schemas '[] view -- ^ query

848+ -> Definition schemas (Alter sch (Create vw ('View view) schema) schemas)

849+createView alias query = UnsafeDefinition $

850+ "CREATE" <+> "VIEW" <+> renderSQL alias <+> "AS"

851+ <+> renderQuery query <> ";"

852+

853+-- | Drop a view.

854+--

855+-- >>> :{

856+-- let

857+-- definition :: Definition

858+-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])

859+-- , "bc" ::: 'View ('["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4])]]

860+-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])]]

861+-- definition = dropView #bc

862+-- in printSQL definition

863+-- :}

864+-- DROP VIEW "bc";

865+dropView

866+ :: (Has sch schemas schema, Has vw schema ('View view))

867+ => QualifiedAlias sch vw -- ^ view to remove

868+ -> Definition schemas (Alter sch (Drop vw schema) schemas)

869+dropView vw = UnsafeDefinition $ "DROP VIEW" <+> renderSQL vw <> ";"

870+

871+-- | Enumerated types are created using the `createTypeEnum` command, for example

872+--

873+-- >>> printSQL $ (createTypeEnum #mood (label @"sad" :* label @"ok" :* label @"happy") :: Definition (Public '[]) '["public" ::: '["mood" ::: 'Typedef ('PGenum '["sad","ok","happy"])]])

874+-- CREATE TYPE "mood" AS ENUM ('sad', 'ok', 'happy');

875+createTypeEnum

876+ :: (KnownSymbol enum, Has sch schemas schema, SOP.All KnownSymbol labels)

877+ => QualifiedAlias sch enum

878+ -- ^ name of the user defined enumerated type

879+ -> NP PGlabel labels

880+ -- ^ labels of the enumerated type

881+ -> Definition schemas (Alter sch (Create enum ('Typedef ('PGenum labels)) schema) schemas)

882+createTypeEnum enum labels = UnsafeDefinition $

883+ "CREATE" <+> "TYPE" <+> renderSQL enum <+> "AS" <+> "ENUM" <+>

884+ parenthesized (renderSQL labels) <> ";"

885+

886+-- | Enumerated types can also be generated from a Haskell type, for example

887+--

888+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

889+-- >>> instance SOP.Generic Schwarma

890+-- >>> instance SOP.HasDatatypeInfo Schwarma

891+-- >>> :{

892+-- let

893+-- createSchwarma :: Definition (Public '[]) '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]]

894+-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma

895+-- in

896+-- printSQL createSchwarma

897+-- :}

898+-- CREATE TYPE "schwarma" AS ENUM ('Beef', 'Lamb', 'Chicken');

899+createTypeEnumFrom

900+ :: forall hask sch enum schemas schema.

901+ ( SOP.Generic hask

902+ , SOP.All KnownSymbol (LabelsPG hask)

903+ , KnownSymbol enum

904+ , Has sch schemas schema )

905+ => QualifiedAlias sch enum

906+ -- ^ name of the user defined enumerated type

907+ -> Definition schemas (Alter sch (Create enum ('Typedef (PG (Enumerated hask))) schema) schemas)

908+createTypeEnumFrom enum = createTypeEnum enum

909+ (SOP.hpure label :: NP PGlabel (LabelsPG hask))

910+

911+{- | `createTypeComposite` creates a composite type. The composite type is

912+specified by a list of attribute names and data types.

913+

914+>>> :{

915+type PGcomplex = 'PGcomposite

916+ '[ "real" ::: 'NotNull 'PGfloat8

917+ , "imaginary" ::: 'NotNull 'PGfloat8 ]

918+:}

919+

920+>>> :{

921+let

922+ setup :: Definition (Public '[]) '["public" ::: '["complex" ::: 'Typedef PGcomplex]]

923+ setup = createTypeComposite #complex

924+ (float8 `as` #real :* float8 `as` #imaginary)

925+in printSQL setup

926+:}

927+CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

928+-}

929+createTypeComposite

930+ :: (KnownSymbol ty, Has sch schemas schema, SOP.SListI fields)

931+ => QualifiedAlias sch ty

932+ -- ^ name of the user defined composite type

933+ -> NP (Aliased (TypeExpression schemas)) fields

934+ -- ^ list of attribute names and data types

935+ -> Definition schemas (Alter sch (Create ty ('Typedef ('PGcomposite fields)) schema) schemas)

936+createTypeComposite ty fields = UnsafeDefinition $

937+ "CREATE" <+> "TYPE" <+> renderSQL ty <+> "AS" <+> parenthesized

938+ (renderCommaSeparated renderField fields) <> ";"

939+ where

940+ renderField :: Aliased (TypeExpression schemas) x -> ByteString

941+ renderField (typ `As` alias) =

942+ renderSQL alias <+> renderSQL typ

943+

944+-- | Composite types can also be generated from a Haskell type, for example

945+--

946+-- >>> data Complex = Complex {real :: Double, imaginary :: Double} deriving GHC.Generic

947+-- >>> instance SOP.Generic Complex

948+-- >>> instance SOP.HasDatatypeInfo Complex

949+-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]

950+-- >>> :{

951+-- let

952+-- createComplex :: Definition (Public '[]) (Public Schema)

953+-- createComplex = createTypeCompositeFrom @Complex #complex

954+-- in

955+-- printSQL createComplex

956+-- :}

957+-- CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

958+createTypeCompositeFrom

959+ :: forall hask sch ty schemas schema.

960+ ( SOP.All (FieldTyped schemas) (RowPG hask)

961+ , KnownSymbol ty

962+ , Has sch schemas schema )

963+ => QualifiedAlias sch ty

964+ -- ^ name of the user defined composite type

965+ -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)

966+createTypeCompositeFrom ty = createTypeComposite ty

967+ (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype

968+ :: NP (Aliased (TypeExpression schemas)) (RowPG hask))

969+

970+class FieldTyped schemas ty where

971+ fieldtype :: Aliased (TypeExpression schemas) ty

972+instance (KnownSymbol alias, PGTyped schemas ty)

973+ => FieldTyped schemas (alias ::: ty) where

974+ fieldtype = pgtype `As` Alias

975+

976+-- | Drop a type.

977+--

978+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

979+-- >>> instance SOP.Generic Schwarma

980+-- >>> instance SOP.HasDatatypeInfo Schwarma

981+-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))

982+-- DROP TYPE "schwarma";

983+dropType

984+ :: (Has sch schemas schema, Has td schema ('Typedef ty))

985+ => QualifiedAlias sch td

986+ -- ^ name of the user defined type

987+ -> Definition schemas (Alter sch (Drop td schema) schemas)

988+dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

989+

990+-- | `ColumnTypeExpression`s are used in `createTable` commands.

991+newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)

992+ = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }

993+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

994+instance RenderSQL (ColumnTypeExpression schemas ty) where

995+ renderSQL = renderColumnTypeExpression

996+

997+-- | used in `createTable` commands as a column constraint to note that

998+-- @NULL@ may be present in a column

999+nullable

1000+ :: TypeExpression schemas (nullity ty)

1001+ -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)

1002+nullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NULL"

1003+

1004+-- | used in `createTable` commands as a column constraint to ensure

1005+-- @NULL@ is not present in a column

1006+notNullable

1007+ :: TypeExpression schemas (nullity ty)

1008+ -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)

1009+notNullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NOT NULL"

1010+

1011+-- | used in `createTable` commands as a column constraint to give a default

1012+default_

1013+ :: Expression 'Ungrouped '[] schemas '[] '[] ty

1014+ -> ColumnTypeExpression schemas ('NoDef :=> ty)

1015+ -> ColumnTypeExpression schemas ('Def :=> ty)

1016+default_ x ty = UnsafeColumnTypeExpression $

1017+ renderSQL ty <+> "DEFAULT" <+> renderExpression x

1018+

1019+-- | not a true type, but merely a notational convenience for creating

1020+-- unique identifier columns with type `PGint2`

1021+serial2, smallserial

1022+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)

1023+serial2 = UnsafeColumnTypeExpression "serial2"

1024+smallserial = UnsafeColumnTypeExpression "smallserial"

1025+-- | not a true type, but merely a notational convenience for creating

1026+-- unique identifier columns with type `PGint4`

1027+serial4, serial

1028+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)

1029+serial4 = UnsafeColumnTypeExpression "serial4"

1030+serial = UnsafeColumnTypeExpression "serial"

1031+-- | not a true type, but merely a notational convenience for creating

1032+-- unique identifier columns with type `PGint8`

1033+serial8, bigserial

1034+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)

1035+serial8 = UnsafeColumnTypeExpression "serial8"

1036+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+1827−283

@@ -1,13 +1,14 @@

11{-|

2−Module: Squeal.PostgreSQL.Expression

2+Module: Squeal.PostgreSQL.Query

33Description: Squeal expressions

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

88Squeal expressions are the atoms used to build statements.

99-}

1010

11+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}

1112{-# LANGUAGE

1213 AllowAmbiguousTypes

1314 , ConstraintKinds

@@ -33,350 +34,565 @@ Squeal expressions are the atoms used to build statements.

3334module Squeal.PostgreSQL.Expression

3435 ( -- * Expression

3536 Expression (..)

36− , Expr

37− , type (-->)

38− , FunctionDB

39− , unsafeFunction

40− , function

41− , unsafeLeftOp

42− , leftOp

43− , unsafeRightOp

44− , rightOp

45− , Operator

46− , OperatorDB

37+ , HasParameter (parameter)

38+ , param

39+ -- ** Null

40+ , null_

41+ , notNull

42+ , coalesce

43+ , fromNull

44+ , isNull

45+ , isNotNull

46+ , matchNull

47+ , nullIf

48+ -- ** Collections

49+ , array

50+ , index

51+ , row

52+ , field

53+ -- ** Functions

4754 , unsafeBinaryOp

48− , binaryOp

49− , FunctionVar

50− , unsafeFunctionVar

51− , type (--->)

52− , FunctionNDB

53− , unsafeFunctionN

54− , functionN

55− , PGSubset (..)

56− , PGIntersect (..)

55+ , unsafeUnaryOp

56+ , unsafeFunction

57+ , unsafeVariadicFunction

58+ , atan2_

59+ , cast

60+ , quot_

61+ , rem_

62+ , trunc

63+ , round_

64+ , ceiling_

65+ , greatest

66+ , least

67+ -- ** Conditions

68+ , true

69+ , false

70+ , not_

71+ , (.&&)

72+ , (.||)

73+ , Condition

74+ , caseWhenThenElse

75+ , ifThenElse

76+ , (.==)

77+ , (./=)

78+ , (.>=)

79+ , (.<)

80+ , (.<=)

81+ , (.>)

82+ -- ** Time

83+ , currentDate

84+ , currentTime

85+ , currentTimestamp

86+ , localTime

87+ , localTimestamp

88+ -- ** Text

89+ , lower

90+ , upper

91+ , charLength

92+ , like

93+ , ilike

94+ -- ** Json

95+ -- *** Json and Jsonb operators

96+ , (.->)

97+ , (.->>)

98+ , (.#>)

99+ , (.#>>)

100+ -- *** Jsonb operators

101+ , (.@>)

102+ , (.<@)

103+ , (.?)

104+ , (.?|)

105+ , (.?&)

106+ , (.-.)

107+ , (#-.)

108+ -- *** Functions

109+ , jsonLit

110+ , jsonbLit

111+ , toJson

112+ , toJsonb

113+ , arrayToJson

114+ , rowToJson

115+ , jsonBuildArray

116+ , jsonbBuildArray

117+ , jsonBuildObject

118+ , jsonbBuildObject

119+ , jsonObject

120+ , jsonbObject

121+ , jsonZipObject

122+ , jsonbZipObject

123+ , jsonArrayLength

124+ , jsonbArrayLength

125+ , jsonExtractPath

126+ , jsonbExtractPath

127+ , jsonExtractPathAsText

128+ , jsonbExtractPathAsText

129+ , jsonTypeof

130+ , jsonbTypeof

131+ , jsonStripNulls

132+ , jsonbStripNulls

133+ , jsonbSet

134+ , jsonbInsert

135+ , jsonbPretty

136+ -- ** Aggregation

137+ , unsafeAggregate, unsafeAggregateDistinct

138+ , sum_, sumDistinct

139+ , PGAvg (avg, avgDistinct)

140+ , bitAnd, bitOr, boolAnd, boolOr

141+ , bitAndDistinct, bitOrDistinct, boolAndDistinct, boolOrDistinct

142+ , countStar

143+ , count, countDistinct

144+ , every, everyDistinct

145+ , max_, maxDistinct, min_, minDistinct

146+ -- * Window Functions

147+ , WindowDefinition (..)

148+ , partitionBy

149+ , WindowFunction (..)

150+ , rank

151+ , rowNumber

152+ , denseRank

153+ , percentRank

154+ , cumeDist

155+ , ntile

156+ , lag

157+ , lead

158+ , firstValue

159+ , lastValue

160+ , nthValue

161+ -- * Sorting

162+ , SortExpression (..)

163+ , OrderBy (..)

164+ -- * Types

165+ , TypeExpression (..)

166+ , PGTyped (..)

167+ , typedef

168+ , typetable

169+ , typeview

170+ , bool

171+ , int2

172+ , smallint

173+ , int4

174+ , int

175+ , integer

176+ , int8

177+ , bigint

178+ , numeric

179+ , float4

180+ , real

181+ , float8

182+ , doublePrecision

183+ , text

184+ , char

185+ , character

186+ , varchar

187+ , characterVarying

188+ , bytea

189+ , timestamp

190+ , timestampWithTimeZone

191+ , date

192+ , time

193+ , timeWithTimeZone

194+ , interval

195+ , uuid

196+ , inet

197+ , json

198+ , jsonb

199+ , vararray

200+ , fixarray

57201 -- * Re-export

58202 , (&)

59− , K (..)

60− , unK

203+ , NP ((:*), Nil)

61204 ) where

62205

63206import Control.Category

64207import Control.DeepSeq

65208import Data.ByteString (ByteString)

209+import Data.ByteString.Lazy (toStrict)

66210import Data.Function ((&))

67211import Data.Semigroup hiding (All)

212+import qualified Data.Aeson as JSON

213+import Data.Ratio

68214import Data.String

69−import Generics.SOP hiding (All, from)

215+import Data.Word

216+import Generics.SOP hiding (from)

70217import GHC.OverloadedLabels

71218import GHC.TypeLits

72−import Numeric

73219import Prelude hiding (id, (.))

74220

221+import qualified Data.ByteString as ByteString

75222import qualified GHC.Generics as GHC

76223

77−import Squeal.PostgreSQL.Alias

78−import Squeal.PostgreSQL.List

79224import Squeal.PostgreSQL.Render

80225import Squeal.PostgreSQL.Schema

81226

82−-- $setup

83−-- >>> import Squeal.PostgreSQL

84−

85227{-----------------------------------------

86228column expressions

87229-----------------------------------------}

88230

89231{- | `Expression`s are used in a variety of contexts,

90−such as in the target `Squeal.PostgreSQL.Query.List` of the

91−`Squeal.PostgreSQL.Query.select` command,

232+such as in the target list of the `Squeal.PostgreSQL.Query.select` command,

92233as new column values in `Squeal.PostgreSQL.Manipulation.insertRow` or

93234`Squeal.PostgreSQL.Manipulation.update`,

94−or in search `Squeal.PostgreSQL.Logic.Condition`s in a number of commands.

235+or in search `Condition`s in a number of commands.

95236

96237The expression syntax allows the calculation of

97238values from primitive expression using arithmetic, logical,

98239and other operations.

99−

100−The type parameters of `Expression` are

101−

102−* @outer :: @ `FromType`, the @from@ clauses of any outer queries in which

103− the `Expression` is a correlated subquery expression;

104−* @commons :: @ `FromType`, the `Squeal.PostgreSQL.Query.CommonTableExpression`s

105− that are in scope for the `Expression`;

106−* @grp :: @ `Grouping`, the `Grouping` of the @from@ clause which may limit

107− which columns may be referenced by alias;

108−* @schemas :: @ `SchemasType`, the schemas of your database that are in

109− scope for the `Expression`;

110−* @from :: @ `FromType`, the @from@ clause which the `Expression` may use

111− to reference columns by alias;

112−* @ty :: @ `NullityType`, the type of the `Expression`.

113240-}

114241newtype Expression

115− (outer :: FromType)

116− (commons :: FromType)

117242 (grp :: Grouping)

243+ (commons :: FromType)

118244 (schemas :: SchemasType)

119245 (params :: [NullityType])

120246 (from :: FromType)

121247 (ty :: NullityType)

122248 = UnsafeExpression { renderExpression :: ByteString }

123249 deriving (GHC.Generic,Show,Eq,Ord,NFData)

124−instance RenderSQL (Expression outer commons grp schemas params from ty) where

250+

251+instance RenderSQL (Expression grp commons schemas params from ty) where

125252 renderSQL = renderExpression

126253

127−-- | An `Expr` is a closed `Expression`.

128−-- It is a F@RankNType@ but don't be scared.

129−-- Think of it as an expression which sees no

130−-- namespaces, so you can't use parameters

131−-- or alias references. It can be used as

132−-- a simple piece of more complex `Expression`s.

133−type Expr x

134− = forall outer commons grp schemas params from

135− . Expression outer commons grp schemas params from x

136− -- ^ cannot reference aliases

137−

138−-- | A @RankNType@ for binary operators.

139−type Operator x1 x2 y

140− = forall outer commons grp schemas params from

141− . Expression outer commons grp schemas params from x1

142− -- ^ left input

143− -> Expression outer commons grp schemas params from x2

144− -- ^ right input

145− -> Expression outer commons grp schemas params from y

146− -- ^ output

147−

148−type OperatorDB schemas x1 x2 y

149− = forall outer commons grp params from

150− . Expression outer commons grp schemas params from x1

151− -- ^ left input

152− -> Expression outer commons grp schemas params from x2

153− -- ^ right input

154− -> Expression outer commons grp schemas params from y

155− -- ^ output

156−

157−-- | A @RankNType@ for functions with a single argument.

158−-- These could be either function calls or unary operators.

159−-- This is a subtype of the usual Haskell function type `Prelude.->`,

160−-- indeed a subcategory as it is closed under the usual

161−-- `Prelude..` and `Prelude.id`.

162−type (-->) x y

163− = forall outer commons grp schemas params from

164− . Expression outer commons grp schemas params from x

165− -- ^ input

166− -> Expression outer commons grp schemas params from y

167− -- ^ output

168−

169−type FunctionDB schemas x y

170− = forall outer commons grp params from

171− . Expression outer commons grp schemas params from x

172− -- ^ input

173− -> Expression outer commons grp schemas params from y

174− -- ^ output

175−

176−{- | A @RankNType@ for functions with a fixed-length list of heterogeneous arguments.

177−Use the `*:` operator to end your argument lists, like so.

178−

179−>>> printSQL (unsafeFunctionN "fun" (true :* false :* localTime *: true))

180−fun(TRUE, FALSE, LOCALTIME, TRUE)

181−-}

182−type (--->) xs y

183− = forall outer commons grp schemas params from

184− . NP (Expression outer commons grp schemas params from) xs

185− -- ^ inputs

186− -> Expression outer commons grp schemas params from y

187− -- ^ output

188−

189−type FunctionNDB schemas xs y

190− = forall outer commons grp params from

191− . NP (Expression outer commons grp schemas params from) xs

192− -- ^ inputs

193− -> Expression outer commons grp schemas params from y

194− -- ^ output

195−

196−{- | A @RankNType@ for functions with a variable-length list of

197−homogeneous arguments and at least 1 more argument.

254+{- | A `HasParameter` constraint is used to indicate a value that is

255+supplied externally to a SQL statement.

256+`Squeal.PostgreSQL.PQ.manipulateParams`,

257+`Squeal.PostgreSQL.PQ.queryParams` and

258+`Squeal.PostgreSQL.PQ.traversePrepared` support specifying data values

259+separately from the SQL command string, in which case `param`s are used to

260+refer to the out-of-line data values.

198261-}

199−type FunctionVar x0 x1 y

200− = forall outer commons grp schemas params from

201− . [Expression outer commons grp schemas params from x0]

202− -- ^ inputs

203− -> Expression outer commons grp schemas params from x1

204− -- ^ must have at least 1 input

205− -> Expression outer commons grp schemas params from y

206− -- ^ output

207−

208−{- | >>> printSQL (unsafeFunctionVar "greatest" [true, null_] false)

209−greatest(TRUE, NULL, FALSE)

210−-}

211−unsafeFunctionVar :: ByteString -> FunctionVar x0 x1 y

212−unsafeFunctionVar fun xs x = UnsafeExpression $ fun <> parenthesized

213− (commaSeparated (renderSQL <$> xs) <> ", " <> renderSQL x)

262+class KnownNat n => HasParameter

263+ (n :: Nat)

264+ (params :: [NullityType])

265+ (ty :: NullityType)

266+ | n params -> ty where

267+ -- | `parameter` takes a `Nat` using type application and a `TypeExpression`.

268+ --

269+ -- >>> let expr = parameter @1 int4 :: Expression '[] schemas '[ 'Null 'PGint4] grp from ('Null 'PGint4)

270+ -- >>> printSQL expr

271+ -- ($1 :: int4)

272+ parameter

273+ :: TypeExpression schemas ty

274+ -> Expression grp commons schemas params from ty

275+ parameter ty = UnsafeExpression $ parenthesized $

276+ "$" <> renderNat @n <+> "::"

277+ <+> renderSQL ty

278+instance {-# OVERLAPPING #-} HasParameter 1 (ty1:tys) ty1

279+instance {-# OVERLAPPABLE #-} (KnownNat n, HasParameter (n-1) params ty)

280+ => HasParameter n (ty' : params) ty

281+

282+-- | `param` takes a `Nat` using type application and for basic types,

283+-- infers a `TypeExpression`.

284+--

285+-- >>> let expr = param @1 :: Expression commons schemas '[ 'Null 'PGint4] grp from ('Null 'PGint4)

286+-- >>> printSQL expr

287+-- ($1 :: int4)

288+param

289+ :: forall n commons schemas params from grp ty

290+ . (PGTyped schemas ty, HasParameter n params ty)

291+ => Expression grp commons schemas params from ty -- ^ param

292+param = parameter @n (pgtype @schemas)

214293

215−instance (HasUnique tab (Join outer from) row, Has col row ty)

216− => IsLabel col (Expression outer commons 'Ungrouped schemas params from ty) where

294+instance (HasUnique tab from row, Has col row ty)

295+ => IsLabel col (Expression 'Ungrouped commons schemas params from ty) where

217296 fromLabel = UnsafeExpression $ renderSQL (Alias @col)

218−instance (HasUnique tab (Join outer from) row, Has col row ty, tys ~ '[ty])

219− => IsLabel col (NP (Expression outer commons 'Ungrouped schemas params from) tys) where

220− fromLabel = fromLabel @col :* Nil

221−instance (HasUnique tab (Join outer from) row, Has col row ty, column ~ (col ::: ty))

297+instance (HasUnique tab from row, Has col row ty, column ~ (col ::: ty))

222298 => IsLabel col

223− (Aliased (Expression outer commons 'Ungrouped schemas params from) column) where

299+ (Aliased (Expression 'Ungrouped commons schemas params from) column) where

224300 fromLabel = fromLabel @col `As` Alias

225−instance (HasUnique tab (Join outer from) row, Has col row ty, columns ~ '[col ::: ty])

301+instance (HasUnique tab from row, Has col row ty, columns ~ '[col ::: ty])

226302 => IsLabel col

227− (NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns) where

303+ (NP (Aliased (Expression 'Ungrouped commons schemas params from)) columns) where

228304 fromLabel = fromLabel @col :* Nil

229305

230−instance (Has tab (Join outer from) row, Has col row ty)

231− => IsQualified tab col (Expression outer commons 'Ungrouped schemas params from ty) where

306+instance (Has tab from row, Has col row ty)

307+ => IsQualified tab col (Expression 'Ungrouped commons schemas params from ty) where

232308 tab ! col = UnsafeExpression $

233309 renderSQL tab <> "." <> renderSQL col

234−instance (Has tab (Join outer from) row, Has col row ty, tys ~ '[ty])

235− => IsQualified tab col (NP (Expression outer commons 'Ungrouped schemas params from) tys) where

236− tab ! col = tab ! col :* Nil

237−instance (Has tab (Join outer from) row, Has col row ty, column ~ (col ::: ty))

310+instance (Has tab from row, Has col row ty, column ~ (col ::: ty))

238311 => IsQualified tab col

239− (Aliased (Expression outer commons 'Ungrouped schemas params from) column) where

312+ (Aliased (Expression 'Ungrouped commons schemas params from) column) where

240313 tab ! col = tab ! col `As` col

241−instance (Has tab (Join outer from) row, Has col row ty, columns ~ '[col ::: ty])

314+instance (Has tab from row, Has col row ty, columns ~ '[col ::: ty])

242315 => IsQualified tab col

243− (NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns) where

316+ (NP (Aliased (Expression 'Ungrouped commons schemas params from)) columns) where

244317 tab ! col = tab ! col :* Nil

245318

246319instance

247− ( HasUnique tab (Join outer from) row

320+ ( HasUnique tab from row

248321 , Has col row ty

249322 , GroupedBy tab col bys

250323 ) => IsLabel col

251− (Expression outer commons ('Grouped bys) schemas params from ty) where

324+ (Expression ('Grouped bys) commons schemas params from ty) where

252325 fromLabel = UnsafeExpression $ renderSQL (Alias @col)

253326instance

254− ( HasUnique tab (Join outer from) row

255− , Has col row ty

256− , GroupedBy tab col bys

257− , tys ~ '[ty]

258− ) => IsLabel col

259− (NP (Expression outer commons ('Grouped bys) schemas params from) tys) where

260− fromLabel = fromLabel @col :* Nil

261−instance

262− ( HasUnique tab (Join outer from) row

327+ ( HasUnique tab from row

263328 , Has col row ty

264329 , GroupedBy tab col bys

265330 , column ~ (col ::: ty)

266331 ) => IsLabel col

267− (Aliased (Expression outer commons ('Grouped bys) schemas params from) column) where

332+ (Aliased (Expression ('Grouped bys) commons schemas params from) column) where

268333 fromLabel = fromLabel @col `As` Alias

269334instance

270− ( HasUnique tab (Join outer from) row

335+ ( HasUnique tab from row

271336 , Has col row ty

272337 , GroupedBy tab col bys

273338 , columns ~ '[col ::: ty]

274339 ) => IsLabel col

275− (NP (Aliased (Expression outer commons ('Grouped bys) schemas params from)) columns) where

340+ (NP (Aliased (Expression ('Grouped bys) commons schemas params from)) columns) where

276341 fromLabel = fromLabel @col :* Nil

277342

278343instance

279− ( Has tab (Join outer from) row

344+ ( Has tab from row

280345 , Has col row ty

281346 , GroupedBy tab col bys

282347 ) => IsQualified tab col

283− (Expression outer commons ('Grouped bys) schemas params from ty) where

348+ (Expression ('Grouped bys) commons schemas params from ty) where

284349 tab ! col = UnsafeExpression $

285350 renderSQL tab <> "." <> renderSQL col

286351instance

287− ( Has tab (Join outer from) row

288− , Has col row ty

289− , GroupedBy tab col bys

290− , tys ~ '[ty]

291− ) => IsQualified tab col

292− (NP (Expression outer commons ('Grouped bys) schemas params from) tys) where

293− tab ! col = tab ! col :* Nil

294−instance

295− ( Has tab (Join outer from) row

352+ ( Has tab from row

296353 , Has col row ty

297354 , GroupedBy tab col bys

298355 , column ~ (col ::: ty)

299356 ) => IsQualified tab col

300− (Aliased (Expression outer commons ('Grouped bys) schemas params from) column) where

357+ (Aliased (Expression ('Grouped bys) commons schemas params from) column) where

301358 tab ! col = tab ! col `As` col

302359instance

303− ( Has tab (Join outer from) row

360+ ( Has tab from row

304361 , Has col row ty

305362 , GroupedBy tab col bys

306363 , columns ~ '[col ::: ty]

307364 ) => IsQualified tab col

308− (NP (Aliased (Expression outer commons ('Grouped bys) schemas params from)) columns) where

365+ (NP (Aliased (Expression ('Grouped bys) commons schemas params from)) columns) where

309366 tab ! col = tab ! col :* Nil

310367

368+-- | analagous to `Nothing`

369+--

370+-- >>> printSQL null_

371+-- NULL

372+null_ :: Expression commons schemas rels grouping params ('Null ty)

373+null_ = UnsafeExpression "NULL"

374+

375+-- | analagous to `Just`

376+--

377+-- >>> printSQL $ notNull true

378+-- TRUE

379+notNull

380+ :: Expression commons schemas rels grouping params ('NotNull ty)

381+ -> Expression commons schemas rels grouping params ('Null ty)

382+notNull = UnsafeExpression . renderSQL

383+

384+-- | return the leftmost value which is not NULL

385+--

386+-- >>> printSQL $ coalesce [null_, true] false

387+-- COALESCE(NULL, TRUE, FALSE)

388+coalesce

389+ :: [Expression grp commons schemas params from ('Null ty)]

390+ -- ^ @NULL@s may be present

391+ -> Expression grp commons schemas params from ('NotNull ty)

392+ -- ^ @NULL@ is absent

393+ -> Expression grp commons schemas params from ('NotNull ty)

394+coalesce nullxs notNullx = UnsafeExpression $

395+ "COALESCE" <> parenthesized (commaSeparated

396+ ((renderSQL <$> nullxs) <> [renderSQL notNullx]))

397+

398+-- | analagous to `Data.Maybe.fromMaybe` using @COALESCE@

399+--

400+-- >>> printSQL $ fromNull true null_

401+-- COALESCE(NULL, TRUE)

402+fromNull

403+ :: Expression grp commons schemas params from ('NotNull ty)

404+ -- ^ what to convert @NULL@ to

405+ -> Expression grp commons schemas params from ('Null ty)

406+ -> Expression grp commons schemas params from ('NotNull ty)

407+fromNull notNullx nullx = coalesce [nullx] notNullx

408+

409+-- | >>> printSQL $ null_ & isNull

410+-- NULL IS NULL

411+isNull

412+ :: Expression grp commons schemas params from ('Null ty)

413+ -- ^ possibly @NULL@

414+ -> Condition grp commons schemas params from

415+isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"

416+

417+-- | >>> printSQL $ null_ & isNotNull

418+-- NULL IS NOT NULL

419+isNotNull

420+ :: Expression grp commons schemas params from ('Null ty)

421+ -- ^ possibly @NULL@

422+ -> Condition grp commons schemas params from

423+isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"

424+

425+-- | analagous to `maybe` using @IS NULL@

426+--

427+-- >>> printSQL $ matchNull true not_ null_

428+-- CASE WHEN NULL IS NULL THEN TRUE ELSE (NOT NULL) END

429+matchNull

430+ :: Expression grp commons schemas params from (nullty)

431+ -- ^ what to convert @NULL@ to

432+ -> ( Expression grp commons schemas params from ('NotNull ty)

433+ -> Expression grp commons schemas params from (nullty) )

434+ -- ^ function to perform when @NULL@ is absent

435+ -> Expression grp commons schemas params from ('Null ty)

436+ -> Expression grp commons schemas params from (nullty)

437+matchNull y f x = ifThenElse (isNull x) y

438+ (f (UnsafeExpression (renderSQL x)))

439+

440+{-| right inverse to `fromNull`, if its arguments are equal then

441+`nullIf` gives @NULL@.

442+

443+>>> :set -XTypeApplications -XDataKinds

444+>>> let expr = nullIf false (param @1) :: Expression commons schemas '[ 'NotNull 'PGbool] grp from ('Null 'PGbool)

445+>>> printSQL expr

446+NULL IF (FALSE, ($1 :: bool))

447+-}

448+nullIf

449+ :: Expression grp commons schemas params from ('NotNull ty)

450+ -- ^ @NULL@ is absent

451+ -> Expression grp commons schemas params from ('NotNull ty)

452+ -- ^ @NULL@ is absent

453+ -> Expression grp commons schemas params from ('Null ty)

454+nullIf x y = UnsafeExpression $ "NULL IF" <+> parenthesized

455+ (renderSQL x <> ", " <> renderSQL y)

456+

457+-- | >>> printSQL $ array [null_, false, true]

458+-- ARRAY[NULL, FALSE, TRUE]

459+array

460+ :: [Expression grp commons schemas params from ty]

461+ -- ^ array elements

462+ -> Expression grp commons schemas params from (nullity ('PGvararray ty))

463+array xs = UnsafeExpression $

464+ "ARRAY[" <> commaSeparated (renderSQL <$> xs) <> "]"

465+

466+-- | >>> printSQL $ array [null_, false, true] & index 2

467+-- (ARRAY[NULL, FALSE, TRUE])[2]

468+index

469+ :: Word64 -- ^ index

470+ -> Expression grp commons schemas params from (nullity ('PGvararray ty)) -- ^ array

471+ -> Expression grp commons schemas params from (NullifyType ty)

472+index n expr = UnsafeExpression $

473+ parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"

474+

311475instance (KnownSymbol label, label `In` labels) => IsPGlabel label

312− (Expression outer commons grp schemas params from (null ('PGenum labels))) where

476+ (Expression grp commons schemas params from (nullity ('PGenum labels))) where

313477 label = UnsafeExpression $ renderSQL (PGlabel @label)

314478

479+-- | A row constructor is an expression that builds a row value

480+-- (also called a composite value) using values for its member fields.

481+--

482+-- >>> :{

483+-- type Complex = 'PGcomposite

484+-- '[ "real" ::: 'NotNull 'PGfloat8

485+-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

486+-- :}

487+--

488+-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression grp commons schemas params from ('NotNull Complex)

489+-- >>> printSQL i

490+-- ROW(0, 1)

491+row

492+ :: SListI row

493+ => NP (Aliased (Expression grp commons schemas params from)) row

494+ -- ^ zero or more expressions for the row field values

495+ -> Expression grp commons schemas params from (nullity ('PGcomposite row))

496+row exprs = UnsafeExpression $ "ROW" <> parenthesized

497+ (renderCommaSeparated (\ (expr `As` _) -> renderSQL expr) exprs)

498+

499+-- | >>> :{

500+-- type Complex = 'PGcomposite

501+-- '[ "real" ::: 'NotNull 'PGfloat8

502+-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

503+-- type Schema = '["complex" ::: 'Typedef Complex]

504+-- :}

505+--

506+-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression '[] (Public Schema) from grp params ('NotNull Complex)

507+-- >>> printSQL $ i & field #complex #imaginary

508+-- (ROW(0, 1)::"complex")."imaginary"

509+field

510+ :: ( Has sch schemas schema

511+ , Has tydef schema ('Typedef ('PGcomposite row))

512+ , Has field row ty)

513+ => QualifiedAlias sch tydef -- ^ row type

514+ -> Alias field -- ^ field name

515+ -> Expression grp commons schemas params from ('NotNull ('PGcomposite row))

516+ -> Expression grp commons schemas params from ty

517+field td fld expr = UnsafeExpression $

518+ parenthesized (renderSQL expr <> "::" <> renderSQL td)

519+ <> "." <> renderSQL fld

520+

521+instance Semigroup

522+ (Expression grp commons schemas params from (nullity ('PGvararray ty))) where

523+ (<>) = unsafeBinaryOp "||"

524+

525+instance Monoid

526+ (Expression grp commons schemas params from (nullity ('PGvararray ty))) where

527+ mempty = array []

528+ mappend = (<>)

529+

530+-- | >>> let expr = greatest currentTimestamp [param @1] :: Expression commons schemas '[ 'NotNull 'PGtimestamptz] grp from ('NotNull 'PGtimestamptz)

531+-- >>> printSQL expr

532+-- GREATEST(CURRENT_TIMESTAMP, ($1 :: timestamp with time zone))

533+greatest

534+ :: Expression grp commons schemas params from (nullty)

535+ -- ^ needs at least 1 argument

536+ -> [Expression grp commons schemas params from (nullty)]

537+ -- ^ or more

538+ -> Expression grp commons schemas params from (nullty)

539+greatest x xs = UnsafeExpression $ "GREATEST("

540+ <> commaSeparated (renderSQL <$> (x:xs)) <> ")"

541+

542+-- | >>> printSQL $ least currentTimestamp [null_]

543+-- LEAST(CURRENT_TIMESTAMP, NULL)

544+least

545+ :: Expression grp commons schemas params from (nullty)

546+ -- ^ needs at least 1 argument

547+ -> [Expression grp commons schemas params from (nullty)]

548+ -- ^ or more

549+ -> Expression grp commons schemas params from (nullty)

550+least x xs = UnsafeExpression $ "LEAST("

551+ <> commaSeparated (renderSQL <$> (x:xs)) <> ")"

552+

315553-- | >>> printSQL $ unsafeBinaryOp "OR" true false

316554-- (TRUE OR FALSE)

317−unsafeBinaryOp :: ByteString -> Operator ty0 ty1 ty2

555+unsafeBinaryOp

556+ :: ByteString

557+ -- ^ operator

558+ -> Expression grp commons schemas params from (ty0)

559+ -> Expression grp commons schemas params from (ty1)

560+ -> Expression grp commons schemas params from (ty2)

318561unsafeBinaryOp op x y = UnsafeExpression $ parenthesized $

319562 renderSQL x <+> op <+> renderSQL y

320563

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

564+-- | >>> printSQL $ unsafeUnaryOp "NOT" true

329565-- (NOT TRUE)

330−unsafeLeftOp :: ByteString -> x --> y

331−unsafeLeftOp op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x

332−

333−leftOp

334− :: forall op sch schemas schema x y.

335− ( Has sch schemas schema

336− , Has op schema ('Operator ('LeftOp x y)) )

337− => FunctionDB schemas x y

338−leftOp = unsafeLeftOp $ renderSymbol @op

339−

340−-- | >>> printSQL $ true & unsafeRightOp "IS NOT TRUE"

341−-- (TRUE IS NOT TRUE)

342−unsafeRightOp :: ByteString -> x --> y

343−unsafeRightOp op x = UnsafeExpression $ parenthesized $ renderSQL x <+> op

344−

345−rightOp

346− :: forall op sch schemas schema x y.

347− ( Has sch schemas schema

348− , Has op schema ('Operator ('RightOp x y)) )

349− => FunctionDB schemas x y

350−rightOp = unsafeRightOp $ renderSymbol @op

566+unsafeUnaryOp

567+ :: ByteString

568+ -- ^ operator

569+ -> Expression grp commons schemas params from (ty0)

570+ -> Expression grp commons schemas params from (ty1)

571+unsafeUnaryOp op x = UnsafeExpression $ parenthesized $

572+ op <+> renderSQL x

351573

352574-- | >>> printSQL $ unsafeFunction "f" true

353575-- f(TRUE)

354−unsafeFunction :: ByteString -> x --> y

576+unsafeFunction

577+ :: ByteString

578+ -- ^ function

579+ -> Expression grp commons schemas params from (xty)

580+ -> Expression grp commons schemas params from (yty)

355581unsafeFunction fun x = UnsafeExpression $

356582 fun <> parenthesized (renderSQL x)

357583

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')

365−-- f(CURRENT_TIME, LOCALTIMESTAMP, FALSE, E'a')

366−unsafeFunctionN :: SListI xs => ByteString -> xs ---> y

367−unsafeFunctionN fun xs = UnsafeExpression $

368− fun <> parenthesized (renderCommaSeparated renderSQL xs)

369−

370−functionN

371− :: ( Has sch schemas schema

372− , Has fun schema ('Function (xs :=> 'Returns y))

373− , SListI xs )

374− => QualifiedAlias sch fun

375− -> FunctionNDB schemas xs y

376−functionN = unsafeFunctionN . renderSQL

584+-- | Helper for defining variadic functions.

585+unsafeVariadicFunction

586+ :: SListI elems

587+ => ByteString

588+ -- ^ function

589+ -> NP (Expression grp commons schemas params from) elems

590+ -> Expression grp commons schemas params from ret

591+unsafeVariadicFunction fun x = UnsafeExpression $

592+ fun <> parenthesized (commaSeparated (hcollapse (hmap (K . renderSQL) x)))

377593

378594instance ty `In` PGNum

379− => Num (Expression outer commons grp schemas params from (null ty)) where

595+ => Num (Expression grp commons schemas params from (nullity ty)) where

380596 (+) = unsafeBinaryOp "+"

381597 (-) = unsafeBinaryOp "-"

382598 (*) = unsafeBinaryOp "*"

@@ -388,17 +604,12 @@ instance ty `In` PGNum

388604 . show

389605

390606instance (ty `In` PGNum, ty `In` PGFloating) => Fractional

391− (Expression outer commons grp schemas params from (null ty)) where

607+ (Expression grp commons schemas params from (nullity ty)) where

392608 (/) = unsafeBinaryOp "/"

393− fromRational

394− = UnsafeExpression

395− . fromString

396− . ($ "")

397− . showFFloat Nothing

398− . fromRat @Double

609+ fromRational x = fromInteger (numerator x) / fromInteger (denominator x)

399610

400611instance (ty `In` PGNum, ty `In` PGFloating) => Floating

401− (Expression outer commons grp schemas params from (null ty)) where

612+ (Expression grp commons schemas params from (nullity ty)) where

402613 pi = UnsafeExpression "pi()"

403614 exp = unsafeFunction "exp"

404615 log = unsafeFunction "ln"

@@ -419,54 +630,1387 @@ instance (ty `In` PGNum, ty `In` PGFloating) => Floating

419630 acosh x = log (x + sqrt (x*x - 1))

420631 atanh x = log ((1 + x) / (1 - x)) / 2

421632

422−-- | Contained by operators

423−class PGSubset ty where

424− (@>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

425− (@>) = unsafeBinaryOp "@>"

426− (<@) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

427− (<@) = unsafeBinaryOp "<@"

428−instance PGSubset 'PGjsonb

429−instance PGSubset 'PGtsquery

430−instance PGSubset ('PGvararray ty)

431−instance PGSubset ('PGrange ty)

432−

433−class PGIntersect ty where

434− (@&&) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

435− (@&&) = unsafeBinaryOp "&&"

436−instance PGIntersect ('PGvararray ty)

437−instance PGIntersect ('PGrange ty)

633+-- | >>> :{

634+-- let

635+-- expression :: Expression grp commons schemas params from (nullity 'PGfloat4)

636+-- expression = atan2_ pi 2

637+-- in printSQL expression

638+-- :}

639+-- atan2(pi(), 2)

640+atan2_

641+ :: float `In` PGFloating

642+ => Expression grp commons schemas params from (nullity float)

643+ -- ^ numerator

644+ -> Expression grp commons schemas params from (nullity float)

645+ -- ^ denominator

646+ -> Expression grp commons schemas params from (nullity float)

647+atan2_ y x = UnsafeExpression $

648+ "atan2(" <> renderSQL y <> ", " <> renderSQL x <> ")"

649+

650+-- When a `cast` is applied to an `Expression` of a known type, it

651+-- represents a run-time type conversion. The cast will succeed only if a

652+-- suitable type conversion operation has been defined.

653+--

654+-- | >>> printSQL $ true & cast int4

655+-- (TRUE :: int4)

656+cast

657+ :: TypeExpression schemas ty1

658+ -- ^ type to cast as

659+ -> Expression grp commons schemas params from ty0

660+ -- ^ value to convert

661+ -> Expression grp commons schemas params from ty1

662+cast ty x = UnsafeExpression $ parenthesized $

663+ renderSQL x <+> "::" <+> renderSQL ty

664+

665+-- | integer division, truncates the result

666+--

667+-- >>> :{

668+-- let

669+-- expression :: Expression grp commons schemas params from (nullity 'PGint2)

670+-- expression = 5 `quot_` 2

671+-- in printSQL expression

672+-- :}

673+-- (5 / 2)

674+quot_

675+ :: int `In` PGIntegral

676+ => Expression grp commons schemas params from (nullity int)

677+ -- ^ numerator

678+ -> Expression grp commons schemas params from (nullity int)

679+ -- ^ denominator

680+ -> Expression grp commons schemas params from (nullity int)

681+quot_ = unsafeBinaryOp "/"

682+

683+-- | remainder upon integer division

684+--

685+-- >>> :{

686+-- let

687+-- expression :: Expression grp commons schemas params from (nullity 'PGint2)

688+-- expression = 5 `rem_` 2

689+-- in printSQL expression

690+-- :}

691+-- (5 % 2)

692+rem_

693+ :: int `In` PGIntegral

694+ => Expression grp commons schemas params from (nullity int)

695+ -- ^ numerator

696+ -> Expression grp commons schemas params from (nullity int)

697+ -- ^ denominator

698+ -> Expression grp commons schemas params from (nullity int)

699+rem_ = unsafeBinaryOp "%"

700+

701+-- | >>> :{

702+-- let

703+-- expression :: Expression grp commons schemas params from (nullity 'PGfloat4)

704+-- expression = trunc pi

705+-- in printSQL expression

706+-- :}

707+-- trunc(pi())

708+trunc

709+ :: frac `In` PGFloating

710+ => Expression grp commons schemas params from (nullity frac)

711+ -- ^ fractional number

712+ -> Expression grp commons schemas params from (nullity frac)

713+trunc = unsafeFunction "trunc"

714+

715+-- | >>> :{

716+-- let

717+-- expression :: Expression grp commons schemas params from (nullity 'PGfloat4)

718+-- expression = round_ pi

719+-- in printSQL expression

720+-- :}

721+-- round(pi())

722+round_

723+ :: frac `In` PGFloating

724+ => Expression grp commons schemas params from (nullity frac)

725+ -- ^ fractional number

726+ -> Expression grp commons schemas params from (nullity frac)

727+round_ = unsafeFunction "round"

728+

729+-- | >>> :{

730+-- let

731+-- expression :: Expression grp commons schemas params from (nullity 'PGfloat4)

732+-- expression = ceiling_ pi

733+-- in printSQL expression

734+-- :}

735+-- ceiling(pi())

736+ceiling_

737+ :: frac `In` PGFloating

738+ => Expression grp commons schemas params from (nullity frac)

739+ -- ^ fractional number

740+ -> Expression grp commons schemas params from (nullity frac)

741+ceiling_ = unsafeFunction "ceiling"

742+

743+-- | A `Condition` is an `Expression`, which can evaluate

744+-- to `true`, `false` or `null_`. This is because SQL uses

745+-- a three valued logic.

746+type Condition grp commons schemas params from =

747+ Expression grp commons schemas params from ('Null 'PGbool)

748+

749+-- | >>> printSQL true

750+-- TRUE

751+true :: Expression grp commons schemas params from (nullity 'PGbool)

752+true = UnsafeExpression "TRUE"

753+

754+-- | >>> printSQL false

755+-- FALSE

756+false :: Expression grp commons schemas params from (nullity 'PGbool)

757+false = UnsafeExpression "FALSE"

758+

759+-- | >>> printSQL $ not_ true

760+-- (NOT TRUE)

761+not_

762+ :: Expression grp commons schemas params from (nullity 'PGbool)

763+ -> Expression grp commons schemas params from (nullity 'PGbool)

764+not_ = unsafeUnaryOp "NOT"

765+

766+-- | >>> printSQL $ true .&& false

767+-- (TRUE AND FALSE)

768+(.&&)

769+ :: Expression grp commons schemas params from (nullity 'PGbool)

770+ -> Expression grp commons schemas params from (nullity 'PGbool)

771+ -> Expression grp commons schemas params from (nullity 'PGbool)

772+infixr 3 .&&

773+(.&&) = unsafeBinaryOp "AND"

774+

775+-- | >>> printSQL $ true .|| false

776+-- (TRUE OR FALSE)

777+(.||)

778+ :: Expression grp commons schemas params from (nullity 'PGbool)

779+ -> Expression grp commons schemas params from (nullity 'PGbool)

780+ -> Expression grp commons schemas params from (nullity 'PGbool)

781+infixr 2 .||

782+(.||) = unsafeBinaryOp "OR"

783+

784+-- | >>> :{

785+-- let

786+-- expression :: Expression grp commons schemas params from (nullity 'PGint2)

787+-- expression = caseWhenThenElse [(true, 1), (false, 2)] 3

788+-- in printSQL expression

789+-- :}

790+-- CASE WHEN TRUE THEN 1 WHEN FALSE THEN 2 ELSE 3 END

791+caseWhenThenElse

792+ :: [ ( Condition grp commons schemas params from

793+ , Expression grp commons schemas params from ty

794+ ) ]

795+ -- ^ whens and thens

796+ -> Expression grp commons schemas params from ty

797+ -- ^ else

798+ -> Expression grp commons schemas params from ty

799+caseWhenThenElse whenThens else_ = UnsafeExpression $ mconcat

800+ [ "CASE"

801+ , mconcat

802+ [ mconcat

803+ [ " WHEN ", renderSQL when_

804+ , " THEN ", renderSQL then_

805+ ]

806+ | (when_,then_) <- whenThens

807+ ]

808+ , " ELSE ", renderSQL else_

809+ , " END"

810+ ]

811+

812+-- | >>> :{

813+-- let

814+-- expression :: Expression grp commons schemas params from (nullity 'PGint2)

815+-- expression = ifThenElse true 1 0

816+-- in printSQL expression

817+-- :}

818+-- CASE WHEN TRUE THEN 1 ELSE 0 END

819+ifThenElse

820+ :: Condition grp commons schemas params from

821+ -> Expression grp commons schemas params from ty -- ^ then

822+ -> Expression grp commons schemas params from ty -- ^ else

823+ -> Expression grp commons schemas params from ty

824+ifThenElse if_ then_ else_ = caseWhenThenElse [(if_,then_)] else_

825+

826+-- | Comparison operations like `.==`, `./=`, `.>`, `.>=`, `.<` and `.<=`

827+-- will produce @NULL@s if one of their arguments is @NULL@.

828+--

829+-- >>> printSQL $ true .== null_

830+-- (TRUE = NULL)

831+(.==)

832+ :: Expression grp commons schemas params from (nullity0 ty) -- ^ lhs

833+ -> Expression grp commons schemas params from (nullity1 ty) -- ^ rhs

834+ -> Condition grp commons schemas params from

835+(.==) = unsafeBinaryOp "="

836+infix 4 .==

837+

838+-- | >>> printSQL $ true ./= null_

839+-- (TRUE <> NULL)

840+(./=)

841+ :: Expression grp commons schemas params from (nullity0 ty) -- ^ lhs

842+ -> Expression grp commons schemas params from (nullity1 ty) -- ^ rhs

843+ -> Condition grp commons schemas params from

844+(./=) = unsafeBinaryOp "<>"

845+infix 4 ./=

846+

847+-- | >>> printSQL $ true .>= null_

848+-- (TRUE >= NULL)

849+(.>=)

850+ :: Expression grp commons schemas params from (nullity0 ty) -- ^ lhs

851+ -> Expression grp commons schemas params from (nullity1 ty) -- ^ rhs

852+ -> Condition grp commons schemas params from

853+(.>=) = unsafeBinaryOp ">="

854+infix 4 .>=

855+

856+-- | >>> printSQL $ true .< null_

857+-- (TRUE < NULL)

858+(.<)

859+ :: Expression grp commons schemas params from (nullity0 ty) -- ^ lhs

860+ -> Expression grp commons schemas params from (nullity1 ty) -- ^ rhs

861+ -> Condition grp commons schemas params from

862+(.<) = unsafeBinaryOp "<"

863+infix 4 .<

864+

865+-- | >>> printSQL $ true .<= null_

866+-- (TRUE <= NULL)

867+(.<=)

868+ :: Expression grp commons schemas params from (nullity0 ty) -- ^ lhs

869+ -> Expression grp commons schemas params from (nullity1 ty) -- ^ rhs

870+ -> Condition grp commons schemas params from

871+(.<=) = unsafeBinaryOp "<="

872+infix 4 .<=

873+

874+-- | >>> printSQL $ true .> null_

875+-- (TRUE > NULL)

876+(.>)

877+ :: Expression grp commons schemas params from (nullity0 ty) -- ^ lhs

878+ -> Expression grp commons schemas params from (nullity1 ty) -- ^ rhs

879+ -> Condition grp commons schemas params from

880+(.>) = unsafeBinaryOp ">"

881+infix 4 .>

882+

883+-- | >>> printSQL currentDate

884+-- CURRENT_DATE

885+currentDate

886+ :: Expression grp commons schemas params from (nullity 'PGdate)

887+currentDate = UnsafeExpression "CURRENT_DATE"

888+

889+-- | >>> printSQL currentTime

890+-- CURRENT_TIME

891+currentTime

892+ :: Expression grp commons schemas params from (nullity 'PGtimetz)

893+currentTime = UnsafeExpression "CURRENT_TIME"

894+

895+-- | >>> printSQL currentTimestamp

896+-- CURRENT_TIMESTAMP

897+currentTimestamp

898+ :: Expression grp commons schemas params from (nullity 'PGtimestamptz)

899+currentTimestamp = UnsafeExpression "CURRENT_TIMESTAMP"

900+

901+-- | >>> printSQL localTime

902+-- LOCALTIME

903+localTime

904+ :: Expression grp commons schemas params from (nullity 'PGtime)

905+localTime = UnsafeExpression "LOCALTIME"

906+

907+-- | >>> printSQL localTimestamp

908+-- LOCALTIMESTAMP

909+localTimestamp

910+ :: Expression grp commons schemas params from (nullity 'PGtimestamp)

911+localTimestamp = UnsafeExpression "LOCALTIMESTAMP"

912+

913+{-----------------------------------------

914+text

915+-----------------------------------------}

438916

439917instance IsString

440− (Expression outer commons grp schemas params from (null 'PGtext)) where

918+ (Expression grp commons schemas params from (nullity 'PGtext)) where

441919 fromString str = UnsafeExpression $

442920 "E\'" <> fromString (escape =<< str) <> "\'"

443−instance IsString

444− (Expression outer commons grp schemas params from (null 'PGtsvector)) where

445− fromString str = UnsafeExpression . parenthesized . (<> " :: tsvector") $

446− "E\'" <> fromString (escape =<< str) <> "\'"

447−instance IsString

448− (Expression outer commons grp schemas params from (null 'PGtsquery)) where

449− fromString str = UnsafeExpression . parenthesized . (<> " :: tsquery") $

450− "E\'" <> fromString (escape =<< str) <> "\'"

921+ where

922+ escape = \case

923+ '\NUL' -> "\\0"

924+ '\'' -> "''"

925+ '"' -> "\\\""

926+ '\b' -> "\\b"

927+ '\n' -> "\\n"

928+ '\r' -> "\\r"

929+ '\t' -> "\\t"

930+ '\\' -> "\\\\"

931+ c -> [c]

451932

452933instance Semigroup

453− (Expression outer commons grp schemas params from (null ('PGvararray ty))) where

454− (<>) = unsafeBinaryOp "||"

455−instance Semigroup

456− (Expression outer commons grp schemas params from (null 'PGjsonb)) where

457− (<>) = unsafeBinaryOp "||"

458−instance Semigroup

459− (Expression outer commons grp schemas params from (null 'PGtext)) where

460− (<>) = unsafeBinaryOp "||"

461−instance Semigroup

462− (Expression outer commons grp schemas params from (null 'PGtsvector)) where

934+ (Expression grp commons schemas params from (nullity 'PGtext)) where

463935 (<>) = unsafeBinaryOp "||"

464936

465937instance Monoid

466− (Expression outer commons grp schemas params from (null 'PGtext)) where

467− mempty = fromString ""

468− mappend = (<>)

469−instance Monoid

470− (Expression outer commons grp schemas params from (null 'PGtsvector)) where

938+ (Expression grp commons schemas params from (nullity 'PGtext)) where

471939 mempty = fromString ""

472940 mappend = (<>)

941+

942+-- | >>> printSQL $ lower "ARRRGGG"

943+-- lower(E'ARRRGGG')

944+lower

945+ :: Expression grp commons schemas params from (nullity 'PGtext)

946+ -- ^ string to lower case

947+ -> Expression grp commons schemas params from (nullity 'PGtext)

948+lower = unsafeFunction "lower"

949+

950+-- | >>> printSQL $ upper "eeee"

951+-- upper(E'eeee')

952+upper

953+ :: Expression grp commons schemas params from (nullity 'PGtext)

954+ -- ^ string to upper case

955+ -> Expression grp commons schemas params from (nullity 'PGtext)

956+upper = unsafeFunction "upper"

957+

958+-- | >>> printSQL $ charLength "four"

959+-- char_length(E'four')

960+charLength

961+ :: Expression grp commons schemas params from (nullity 'PGtext)

962+ -- ^ string to measure

963+ -> Expression grp commons schemas params from (nullity 'PGint4)

964+charLength = unsafeFunction "char_length"

965+

966+-- | The `like` expression returns true if the @string@ matches

967+-- the supplied @pattern@. If @pattern@ does not contain percent signs

968+-- or underscores, then the pattern only represents the string itself;

969+-- in that case `like` acts like the equals operator. An underscore (_)

970+-- in pattern stands for (matches) any single character; a percent sign (%)

971+-- matches any sequence of zero or more characters.

972+--

973+-- >>> printSQL $ "abc" `like` "a%"

974+-- (E'abc' LIKE E'a%')

975+like

976+ :: Expression grp commons schemas params from (nullity 'PGtext)

977+ -- ^ string

978+ -> Expression grp commons schemas params from (nullity 'PGtext)

979+ -- ^ pattern

980+ -> Expression grp commons schemas params from (nullity 'PGbool)

981+like = unsafeBinaryOp "LIKE"

982+

983+-- | The key word ILIKE can be used instead of LIKE to make the

984+-- match case-insensitive according to the active locale.

985+--

986+-- >>> printSQL $ "abc" `ilike` "a%"

987+-- (E'abc' ILIKE E'a%')

988+ilike

989+ :: Expression grp commons schemas params from (nullity 'PGtext)

990+ -- ^ string

991+ -> Expression grp commons schemas params from (nullity 'PGtext)

992+ -- ^ pattern

993+ -> Expression grp commons schemas params from (nullity 'PGbool)

994+ilike = unsafeBinaryOp "ILIKE"

995+

996+{-----------------------------------------

997+ -- json and jsonb support

998+

999+See https://www.postgresql.org/docs/10/static/functions-json.html -- most

1000+comments lifted directly from this page.

1001+

1002+Table 9.44: json and jsonb operators

1003+-----------------------------------------}

1004+

1005+-- | Get JSON value (object field or array element) at a key.

1006+(.->)

1007+ :: (json `In` PGJsonType, key `In` PGJsonKey)

1008+ => Expression grp commons schemas params from (nullity json)

1009+ -> Expression grp commons schemas params from (nullity key)

1010+ -> Expression grp commons schemas params from ('Null json)

1011+infixl 8 .->

1012+(.->) = unsafeBinaryOp "->"

1013+

1014+-- | Get JSON value (object field or array element) at a key, as text.

1015+(.->>)

1016+ :: (json `In` PGJsonType, key `In` PGJsonKey)

1017+ => Expression grp commons schemas params from (nullity json)

1018+ -> Expression grp commons schemas params from (nullity key)

1019+ -> Expression grp commons schemas params from ('Null 'PGtext)

1020+infixl 8 .->>

1021+(.->>) = unsafeBinaryOp "->>"

1022+

1023+-- | Get JSON value at a specified path.

1024+(.#>)

1025+ :: (json `In` PGJsonType, PGTextArray "(.#>)" path)

1026+ => Expression grp commons schemas params from (nullity json)

1027+ -> Expression grp commons schemas params from (nullity path)

1028+ -> Expression grp commons schemas params from ('Null json)

1029+infixl 8 .#>

1030+(.#>) = unsafeBinaryOp "#>"

1031+

1032+-- | Get JSON value at a specified path as text.

1033+(.#>>)

1034+ :: (json `In` PGJsonType, PGTextArray "(.#>>)" path)

1035+ => Expression grp commons schemas params from (nullity json)

1036+ -> Expression grp commons schemas params from (nullity path)

1037+ -> Expression grp commons schemas params from ('Null 'PGtext)

1038+infixl 8 .#>>

1039+(.#>>) = unsafeBinaryOp "#>>"

1040+

1041+-- Additional jsonb operators

1042+

1043+-- | Does the left JSON value contain the right JSON path/value entries at the

1044+-- top level?

1045+(.@>)

1046+ :: Expression grp commons schemas params from (nullity 'PGjsonb)

1047+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1048+ -> Condition grp commons schemas params from

1049+infixl 9 .@>

1050+(.@>) = unsafeBinaryOp "@>"

1051+

1052+-- | Are the left JSON path/value entries contained at the top level within the

1053+-- right JSON value?

1054+(.<@)

1055+ :: Expression grp commons schemas params from (nullity 'PGjsonb)

1056+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1057+ -> Condition grp commons schemas params from

1058+infixl 9 .<@

1059+(.<@) = unsafeBinaryOp "<@"

1060+

1061+-- | Does the string exist as a top-level key within the JSON value?

1062+(.?)

1063+ :: Expression grp commons schemas params from (nullity 'PGjsonb)

1064+ -> Expression grp commons schemas params from (nullity 'PGtext)

1065+ -> Condition grp commons schemas params from

1066+infixl 9 .?

1067+(.?) = unsafeBinaryOp "?"

1068+

1069+-- | Do any of these array strings exist as top-level keys?

1070+(.?|)

1071+ :: Expression grp commons schemas params from (nullity 'PGjsonb)

1072+ -> Expression grp commons schemas params from (nullity ('PGvararray ('NotNull 'PGtext)))

1073+ -> Condition grp commons schemas params from

1074+infixl 9 .?|

1075+(.?|) = unsafeBinaryOp "?|"

1076+

1077+-- | Do all of these array strings exist as top-level keys?

1078+(.?&)

1079+ :: Expression grp commons schemas params from (nullity 'PGjsonb)

1080+ -> Expression grp commons schemas params from (nullity ('PGvararray ('NotNull 'PGtext)))

1081+ -> Condition grp commons schemas params from

1082+infixl 9 .?&

1083+(.?&) = unsafeBinaryOp "?&"

1084+

1085+-- | Concatenate two jsonb values into a new jsonb value.

1086+instance

1087+ Semigroup (Expression commons schemas from grouping param (nullity 'PGjsonb)) where

1088+ (<>) = unsafeBinaryOp "||"

1089+

1090+-- | Delete a key or keys from a JSON object, or remove an array element.

1091+--

1092+-- If the right operand is..

1093+--

1094+-- @ text @: Delete key/value pair or string element from left operand. Key/value pairs

1095+-- are matched based on their key value.

1096+--

1097+-- @ text[] @: Delete multiple key/value pairs or string elements

1098+-- from left operand. Key/value pairs are matched based on their key value.

1099+--

1100+-- @ integer @: Delete the array element with specified index (Negative integers

1101+-- count from the end). Throws an error if top level container is not an array.

1102+(.-.)

1103+ :: (key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]) -- hlint error without parens here

1104+ => Expression grp commons schemas params from (nullity 'PGjsonb)

1105+ -> Expression grp commons schemas params from (nullity key)

1106+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1107+infixl 6 .-.

1108+(.-.) = unsafeBinaryOp "-"

1109+

1110+-- | Delete the field or element with specified path (for JSON arrays, negative

1111+-- integers count from the end)

1112+(#-.)

1113+ :: PGTextArray "(#-.)" arrayty

1114+ => Expression grp commons schemas params from (nullity 'PGjsonb)

1115+ -> Expression grp commons schemas params from (nullity arrayty)

1116+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1117+infixl 6 #-.

1118+(#-.) = unsafeBinaryOp "#-"

1119+

1120+{-----------------------------------------

1121+Table 9.45: JSON creation functions

1122+-----------------------------------------}

1123+

1124+-- | Literal binary JSON

1125+jsonbLit

1126+ :: JSON.ToJSON x

1127+ => x -> Expression grp commons schemas params from (nullity 'PGjsonb)

1128+jsonbLit = cast jsonb . UnsafeExpression

1129+ . singleQuotedUtf8 . toStrict . JSON.encode

1130+

1131+-- | Literal JSON

1132+jsonLit

1133+ :: JSON.ToJSON x

1134+ => x -> Expression grp commons schemas params from (nullity 'PGjson)

1135+jsonLit = cast json . UnsafeExpression

1136+ . singleQuotedUtf8 . toStrict . JSON.encode

1137+

1138+-- | Returns the value as json. Arrays and composites are converted

1139+-- (recursively) to arrays and objects; otherwise, if there is a cast from the

1140+-- type to json, the cast function will be used to perform the conversion;

1141+-- otherwise, a scalar value is produced. For any scalar type other than a

1142+-- number, a Boolean, or a null value, the text representation will be used, in

1143+-- such a fashion that it is a valid json value.

1144+toJson

1145+ :: Expression grp commons schemas params from (nullity ty)

1146+ -> Expression grp commons schemas params from (nullity 'PGjson)

1147+toJson = unsafeFunction "to_json"

1148+

1149+-- | Returns the value as jsonb. Arrays and composites are converted

1150+-- (recursively) to arrays and objects; otherwise, if there is a cast from the

1151+-- type to json, the cast function will be used to perform the conversion;

1152+-- otherwise, a scalar value is produced. For any scalar type other than a

1153+-- number, a Boolean, or a null value, the text representation will be used, in

1154+-- such a fashion that it is a valid jsonb value.

1155+toJsonb

1156+ :: Expression grp commons schemas params from (nullity ty)

1157+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1158+toJsonb = unsafeFunction "to_jsonb"

1159+

1160+-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

1161+-- becomes a JSON array of arrays.

1162+arrayToJson

1163+ :: PGArray "arrayToJson" arr

1164+ => Expression grp commons schemas params from (nullity arr)

1165+ -> Expression grp commons schemas params from (nullity 'PGjson)

1166+arrayToJson = unsafeFunction "array_to_json"

1167+

1168+-- | Returns the row as a JSON object.

1169+rowToJson

1170+ :: Expression grp commons schemas params from (nullity ('PGcomposite ty))

1171+ -> Expression grp commons schemas params from (nullity 'PGjson)

1172+rowToJson = unsafeFunction "row_to_json"

1173+

1174+-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

1175+-- argument list.

1176+jsonBuildArray

1177+ :: SListI elems

1178+ => NP (Expression grp commons schemas params from) elems

1179+ -> Expression grp commons schemas params from (nullity 'PGjson)

1180+jsonBuildArray = unsafeVariadicFunction "json_build_array"

1181+

1182+-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

1183+-- variadic argument list.

1184+jsonbBuildArray

1185+ :: SListI elems

1186+ => NP (Expression grp commons schemas params from) elems

1187+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1188+jsonbBuildArray = unsafeVariadicFunction "jsonb_build_array"

1189+

1190+unsafeRowFunction

1191+ :: All Top elems

1192+ => NP (Aliased (Expression grp commons schemas params from)) elems

1193+ -> [ByteString]

1194+unsafeRowFunction =

1195+ (`appEndo` []) . hcfoldMap (Proxy :: Proxy Top)

1196+ (\(col `As` name) -> Endo $ \xs ->

1197+ renderAliasString name : renderSQL col : xs)

1198+ where

1199+ renderAliasString :: KnownSymbol alias => Alias alias -> ByteString

1200+ renderAliasString = singleQuotedText . fromString . symbolVal

1201+

1202+-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

1203+-- argument list. The elements of the argument list must alternate between text

1204+-- and values.

1205+jsonBuildObject

1206+ :: All Top elems

1207+ => NP (Aliased (Expression grp commons schemas params from)) elems

1208+ -> Expression grp commons schemas params from (nullity 'PGjson)

1209+jsonBuildObject

1210+ = unsafeFunction "json_build_object"

1211+ . UnsafeExpression

1212+ . commaSeparated

1213+ . unsafeRowFunction

1214+

1215+-- | Builds a possibly-heterogeneously-typed (binary) JSON object out of a

1216+-- variadic argument list. The elements of the argument list must alternate

1217+-- between text and values.

1218+jsonbBuildObject

1219+ :: All Top elems

1220+ => NP (Aliased (Expression grp commons schemas params from)) elems

1221+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1222+jsonbBuildObject

1223+ = unsafeFunction "jsonb_build_object"

1224+ . UnsafeExpression

1225+ . commaSeparated

1226+ . unsafeRowFunction

1227+

1228+-- | Builds a JSON object out of a text array. The array must have either

1229+-- exactly one dimension with an even number of members, in which case they are

1230+-- taken as alternating key/value pairs, or two dimensions such that each inner

1231+-- array has exactly two elements, which are taken as a key/value pair.

1232+jsonObject

1233+ :: PGArrayOf "jsonObject" arr ('NotNull 'PGtext)

1234+ => Expression grp commons schemas params from (nullity arr)

1235+ -> Expression grp commons schemas params from (nullity 'PGjson)

1236+jsonObject = unsafeFunction "json_object"

1237+

1238+-- | Builds a binary JSON object out of a text array. The array must have either

1239+-- exactly one dimension with an even number of members, in which case they are

1240+-- taken as alternating key/value pairs, or two dimensions such that each inner

1241+-- array has exactly two elements, which are taken as a key/value pair.

1242+jsonbObject

1243+ :: PGArrayOf "jsonbObject" arr ('NotNull 'PGtext)

1244+ => Expression grp commons schemas params from (nullity arr)

1245+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1246+jsonbObject = unsafeFunction "jsonb_object"

1247+

1248+-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

1249+-- keys and one for values, that are zipped pairwise to create a JSON object.

1250+jsonZipObject

1251+ :: ( PGArrayOf "jsonZipObject" keysArray ('NotNull 'PGtext)

1252+ , PGArrayOf "jsonZipObject" valuesArray ('NotNull 'PGtext))

1253+ => Expression grp commons schemas params from (nullity keysArray)

1254+ -> Expression grp commons schemas params from (nullity valuesArray)

1255+ -> Expression grp commons schemas params from (nullity 'PGjson)

1256+jsonZipObject ks vs =

1257+ unsafeVariadicFunction "json_object" (ks :* vs :* Nil)

1258+

1259+-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

1260+-- keys and one for values, that are zipped pairwise to create a binary JSON

1261+-- object.

1262+jsonbZipObject

1263+ :: ( PGArrayOf "jsonbZipObject" keysArray ('NotNull 'PGtext)

1264+ , PGArrayOf "jsonbZipObject" valuesArray ('NotNull 'PGtext))

1265+ => Expression grp commons schemas params from (nullity keysArray)

1266+ -> Expression grp commons schemas params from (nullity valuesArray)

1267+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1268+jsonbZipObject ks vs =

1269+ unsafeVariadicFunction "jsonb_object" (ks :* vs :* Nil)

1270+

1271+{-----------------------------------------

1272+Table 9.46: JSON processing functions

1273+-----------------------------------------}

1274+

1275+-- | Returns the number of elements in the outermost JSON array.

1276+jsonArrayLength

1277+ :: Expression grp commons schemas params from (nullity 'PGjson)

1278+ -> Expression grp commons schemas params from (nullity 'PGint4)

1279+jsonArrayLength = unsafeFunction "json_array_length"

1280+

1281+-- | Returns the number of elements in the outermost binary JSON array.

1282+jsonbArrayLength

1283+ :: Expression grp commons schemas params from (nullity 'PGjsonb)

1284+ -> Expression grp commons schemas params from (nullity 'PGint4)

1285+jsonbArrayLength = unsafeFunction "jsonb_array_length"

1286+

1287+-- | Returns JSON value pointed to by the given path (equivalent to #>

1288+-- operator).

1289+jsonExtractPath

1290+ :: SListI elems

1291+ => Expression grp commons schemas params from (nullity 'PGjson)

1292+ -> NP (Expression grp commons schemas params from) elems

1293+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1294+jsonExtractPath x xs =

1295+ unsafeVariadicFunction "json_extract_path" (x :* xs)

1296+

1297+-- | Returns JSON value pointed to by the given path (equivalent to #>

1298+-- operator).

1299+jsonbExtractPath

1300+ :: SListI elems

1301+ => Expression grp commons schemas params from (nullity 'PGjsonb)

1302+ -> NP (Expression grp commons schemas params from) elems

1303+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1304+jsonbExtractPath x xs =

1305+ unsafeVariadicFunction "jsonb_extract_path" (x :* xs)

1306+

1307+-- | Returns JSON value pointed to by the given path (equivalent to #>

1308+-- operator), as text.

1309+jsonExtractPathAsText

1310+ :: SListI elems

1311+ => Expression grp commons schemas params from (nullity 'PGjson)

1312+ -> NP (Expression grp commons schemas params from) elems

1313+ -> Expression grp commons schemas params from (nullity 'PGjson)

1314+jsonExtractPathAsText x xs =

1315+ unsafeVariadicFunction "json_extract_path_text" (x :* xs)

1316+

1317+-- | Returns JSON value pointed to by the given path (equivalent to #>

1318+-- operator), as text.

1319+jsonbExtractPathAsText

1320+ :: SListI elems

1321+ => Expression grp commons schemas params from (nullity 'PGjsonb)

1322+ -> NP (Expression grp commons schemas params from) elems

1323+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1324+jsonbExtractPathAsText x xs =

1325+ unsafeVariadicFunction "jsonb_extract_path_text" (x :* xs)

1326+

1327+-- | Returns the type of the outermost JSON value as a text string. Possible

1328+-- types are object, array, string, number, boolean, and null.

1329+jsonTypeof

1330+ :: Expression grp commons schemas params from (nullity 'PGjson)

1331+ -> Expression grp commons schemas params from (nullity 'PGtext)

1332+jsonTypeof = unsafeFunction "json_typeof"

1333+

1334+-- | Returns the type of the outermost binary JSON value as a text string.

1335+-- Possible types are object, array, string, number, boolean, and null.

1336+jsonbTypeof

1337+ :: Expression grp commons schemas params from (nullity 'PGjsonb)

1338+ -> Expression grp commons schemas params from (nullity 'PGtext)

1339+jsonbTypeof = unsafeFunction "jsonb_typeof"

1340+

1341+-- | Returns its argument with all object fields that have null values omitted.

1342+-- Other null values are untouched.

1343+jsonStripNulls

1344+ :: Expression grp commons schemas params from (nullity 'PGjson)

1345+ -> Expression grp commons schemas params from (nullity 'PGjson)

1346+jsonStripNulls = unsafeFunction "json_strip_nulls"

1347+

1348+-- | Returns its argument with all object fields that have null values omitted.

1349+-- Other null values are untouched.

1350+jsonbStripNulls

1351+ :: Expression grp commons schemas params from (nullity 'PGjsonb)

1352+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1353+jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

1354+

1355+-- | @ jsonbSet target path new_value create_missing @

1356+--

1357+-- Returns target with the section designated by path replaced by new_value,

1358+-- or with new_value added if create_missing is true ( default is true) and the

1359+-- item designated by path does not exist. As with the path orientated

1360+-- operators, negative integers that appear in path count from the end of JSON

1361+-- arrays.

1362+jsonbSet

1363+ :: PGTextArray "jsonbSet" arr

1364+ => Expression grp commons schemas params from (nullity 'PGjsonb)

1365+ -> Expression grp commons schemas params from (nullity arr)

1366+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1367+ -> Maybe (Expression grp commons schemas params from (nullity 'PGbool))

1368+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1369+jsonbSet tgt path val createMissing = case createMissing of

1370+ Just m -> unsafeVariadicFunction "jsonb_set" (tgt :* path :* val :* m :* Nil)

1371+ Nothing -> unsafeVariadicFunction "jsonb_set" (tgt :* path :* val :* Nil)

1372+

1373+-- | @ jsonbInsert target path new_value insert_after @

1374+--

1375+-- Returns target with new_value inserted. If target section designated by

1376+-- path is in a JSONB array, new_value will be inserted before target or after

1377+-- if insert_after is true (default is false). If target section designated by

1378+-- path is in JSONB object, new_value will be inserted only if target does not

1379+-- exist. As with the path orientated operators, negative integers that appear

1380+-- in path count from the end of JSON arrays.

1381+jsonbInsert

1382+ :: PGTextArray "jsonbInsert" arr

1383+ => Expression grp commons schemas params from (nullity 'PGjsonb)

1384+ -> Expression grp commons schemas params from (nullity arr)

1385+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1386+ -> Maybe (Expression grp commons schemas params from (nullity 'PGbool))

1387+ -> Expression grp commons schemas params from (nullity 'PGjsonb)

1388+jsonbInsert tgt path val insertAfter = case insertAfter of

1389+ Just i -> unsafeVariadicFunction "jsonb_insert" (tgt :* path :* val :* i :* Nil)

1390+ Nothing -> unsafeVariadicFunction "jsonb_insert" (tgt :* path :* val :* Nil)

1391+

1392+-- | Returns its argument as indented JSON text.

1393+jsonbPretty

1394+ :: Expression grp commons schemas params from (nullity 'PGjsonb)

1395+ -> Expression grp commons schemas params from (nullity 'PGtext)

1396+jsonbPretty = unsafeFunction "jsonb_pretty"

1397+

1398+{-----------------------------------------

1399+aggregation

1400+-----------------------------------------}

1401+

1402+-- | escape hatch to define aggregate functions

1403+unsafeAggregate

1404+ :: ByteString -- ^ aggregate function

1405+ -> Expression 'Ungrouped commons schemas params from xty

1406+ -> Expression ('Grouped bys) commons schemas params from yty

1407+unsafeAggregate fun x = UnsafeExpression $ mconcat

1408+ [fun, "(", renderSQL x, ")"]

1409+

1410+-- | escape hatch to define aggregate functions over distinct values

1411+unsafeAggregateDistinct

1412+ :: ByteString -- ^ aggregate function

1413+ -> Expression 'Ungrouped commons schemas params from xty

1414+ -> Expression ('Grouped bys) commons schemas params from yty

1415+unsafeAggregateDistinct fun x = UnsafeExpression $ mconcat

1416+ [fun, "(DISTINCT ", renderSQL x, ")"]

1417+

1418+-- | >>> :{

1419+-- let

1420+-- expression :: Expression ('Grouped bys) commons schemas params '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('Null 'PGnumeric)

1421+-- expression = sum_ #col

1422+-- in printSQL expression

1423+-- :}

1424+-- sum("col")

1425+sum_

1426+ :: ty `In` PGNum

1427+ => Expression 'Ungrouped commons schemas params from (nullity ty)

1428+ -- ^ what to sum

1429+ -> Expression ('Grouped bys) commons schemas params from (nullity ty)

1430+sum_ = unsafeAggregate "sum"

1431+

1432+-- | >>> :{

1433+-- let

1434+-- expression :: Expression ('Grouped bys) commons schemas params '[tab ::: '["col" ::: nullity 'PGnumeric]] (nullity 'PGnumeric)

1435+-- expression = sumDistinct #col

1436+-- in printSQL expression

1437+-- :}

1438+-- sum(DISTINCT "col")

1439+sumDistinct

1440+ :: ty `In` PGNum

1441+ => Expression 'Ungrouped commons schemas params from (nullity ty)

1442+ -- ^ what to sum

1443+ -> Expression ('Grouped bys) commons schemas params from (nullity ty)

1444+sumDistinct = unsafeAggregateDistinct "sum"

1445+

1446+-- | A constraint for `PGType`s that you can take averages of and the resulting

1447+-- `PGType`.

1448+class PGAvg ty avg | ty -> avg where

1449+ avg, avgDistinct

1450+ :: Expression 'Ungrouped commons schemas params from (nullity ty)

1451+ -- ^ what to average

1452+ -> Expression ('Grouped bys) commons schemas params from (nullity avg)

1453+ avg = unsafeAggregate "avg"

1454+ avgDistinct = unsafeAggregateDistinct "avg"

1455+instance PGAvg 'PGint2 'PGnumeric

1456+instance PGAvg 'PGint4 'PGnumeric

1457+instance PGAvg 'PGint8 'PGnumeric

1458+instance PGAvg 'PGnumeric 'PGnumeric

1459+instance PGAvg 'PGfloat4 'PGfloat8

1460+instance PGAvg 'PGfloat8 'PGfloat8

1461+instance PGAvg 'PGinterval 'PGinterval

1462+

1463+-- | >>> :{

1464+-- let

1465+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity 'PGint4]] (nullity 'PGint4)

1466+-- expression = bitAnd #col

1467+-- in printSQL expression

1468+-- :}

1469+-- bit_and("col")

1470+bitAnd

1471+ :: int `In` PGIntegral

1472+ => Expression 'Ungrouped commons schemas params from (nullity int)

1473+ -- ^ what to aggregate

1474+ -> Expression ('Grouped bys) commons schemas params from (nullity int)

1475+bitAnd = unsafeAggregate "bit_and"

1476+

1477+-- | >>> :{

1478+-- let

1479+-- expression :: Expression ('Grouped bys) commons schemas params '[tab ::: '["col" ::: nullity 'PGint4]] (nullity 'PGint4)

1480+-- expression = bitOr #col

1481+-- in printSQL expression

1482+-- :}

1483+-- bit_or("col")

1484+bitOr

1485+ :: int `In` PGIntegral

1486+ => Expression 'Ungrouped commons schemas params from (nullity int)

1487+ -- ^ what to aggregate

1488+ -> Expression ('Grouped bys) commons schemas params from (nullity int)

1489+bitOr = unsafeAggregate "bit_or"

1490+

1491+-- | >>> :{

1492+-- let

1493+-- expression :: Expression ('Grouped bys) commons schemas params '[tab ::: '["col" ::: nullity 'PGint4]] (nullity 'PGint4)

1494+-- expression = bitAndDistinct #col

1495+-- in printSQL expression

1496+-- :}

1497+-- bit_and(DISTINCT "col")

1498+bitAndDistinct

1499+ :: int `In` PGIntegral

1500+ => Expression 'Ungrouped commons schemas params from (nullity int)

1501+ -- ^ what to aggregate

1502+ -> Expression ('Grouped bys) commons schemas params from (nullity int)

1503+bitAndDistinct = unsafeAggregateDistinct "bit_and"

1504+

1505+-- | >>> :{

1506+-- let

1507+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity 'PGint4]] (nullity 'PGint4)

1508+-- expression = bitOrDistinct #col

1509+-- in printSQL expression

1510+-- :}

1511+-- bit_or(DISTINCT "col")

1512+bitOrDistinct

1513+ :: int `In` PGIntegral

1514+ => Expression 'Ungrouped commons schemas params from (nullity int)

1515+ -- ^ what to aggregate

1516+ -> Expression ('Grouped bys) commons schemas params from (nullity int)

1517+bitOrDistinct = unsafeAggregateDistinct "bit_or"

1518+

1519+-- | >>> :{

1520+-- let

1521+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity 'PGbool]] (nullity 'PGbool)

1522+-- expression = boolAnd #col

1523+-- in printSQL expression

1524+-- :}

1525+-- bool_and("col")

1526+boolAnd

1527+ :: Expression 'Ungrouped commons schemas params from (nullity 'PGbool)

1528+ -- ^ what to aggregate

1529+ -> Expression ('Grouped bys) commons schemas params from (nullity 'PGbool)

1530+boolAnd = unsafeAggregate "bool_and"

1531+

1532+-- | >>> :{

1533+-- let

1534+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity 'PGbool]] (nullity 'PGbool)

1535+-- expression = boolOr #col

1536+-- in printSQL expression

1537+-- :}

1538+-- bool_or("col")

1539+boolOr

1540+ :: Expression 'Ungrouped commons schemas params from (nullity 'PGbool)

1541+ -- ^ what to aggregate

1542+ -> Expression ('Grouped bys) commons schemas params from (nullity 'PGbool)

1543+boolOr = unsafeAggregate "bool_or"

1544+

1545+-- | >>> :{

1546+-- let

1547+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity 'PGbool]] (nullity 'PGbool)

1548+-- expression = boolAndDistinct #col

1549+-- in printSQL expression

1550+-- :}

1551+-- bool_and(DISTINCT "col")

1552+boolAndDistinct

1553+ :: Expression 'Ungrouped commons schemas params from (nullity 'PGbool)

1554+ -- ^ what to aggregate

1555+ -> Expression ('Grouped bys) commons schemas params from (nullity 'PGbool)

1556+boolAndDistinct = unsafeAggregateDistinct "bool_and"

1557+

1558+-- | >>> :{

1559+-- let

1560+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity 'PGbool]] (nullity 'PGbool)

1561+-- expression = boolOrDistinct #col

1562+-- in printSQL expression

1563+-- :}

1564+-- bool_or(DISTINCT "col")

1565+boolOrDistinct

1566+ :: Expression 'Ungrouped commons schemas params from (nullity 'PGbool)

1567+ -- ^ what to aggregate

1568+ -> Expression ('Grouped bys) commons schemas params from (nullity 'PGbool)

1569+boolOrDistinct = unsafeAggregateDistinct "bool_or"

1570+

1571+-- | A special aggregation that does not require an input

1572+--

1573+-- >>> printSQL countStar

1574+-- count(*)

1575+countStar

1576+ :: Expression ('Grouped bys) commons schemas params from ('NotNull 'PGint8)

1577+countStar = UnsafeExpression $ "count(*)"

1578+

1579+-- | >>> :{

1580+-- let

1581+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity ty]] ('NotNull 'PGint8)

1582+-- expression = count #col

1583+-- in printSQL expression

1584+-- :}

1585+-- count("col")

1586+count

1587+ :: Expression 'Ungrouped commons schemas params from ty

1588+ -- ^ what to count

1589+ -> Expression ('Grouped bys) commons schemas params from ('NotNull 'PGint8)

1590+count = unsafeAggregate "count"

1591+

1592+-- | >>> :{

1593+-- let

1594+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity ty]] ('NotNull 'PGint8)

1595+-- expression = countDistinct #col

1596+-- in printSQL expression

1597+-- :}

1598+-- count(DISTINCT "col")

1599+countDistinct

1600+ :: Expression 'Ungrouped commons schemas params from ty

1601+ -- ^ what to count

1602+ -> Expression ('Grouped bys) commons schemas params from ('NotNull 'PGint8)

1603+countDistinct = unsafeAggregateDistinct "count"

1604+

1605+-- | synonym for `boolAnd`

1606+--

1607+-- >>> :{

1608+-- let

1609+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity 'PGbool]] (nullity 'PGbool)

1610+-- expression = every #col

1611+-- in printSQL expression

1612+-- :}

1613+-- every("col")

1614+every

1615+ :: Expression 'Ungrouped commons schemas params from (nullity 'PGbool)

1616+ -- ^ what to aggregate

1617+ -> Expression ('Grouped bys) commons schemas params from (nullity 'PGbool)

1618+every = unsafeAggregate "every"

1619+

1620+-- | synonym for `boolAndDistinct`

1621+--

1622+-- >>> :{

1623+-- let

1624+-- expression :: Expression commons schemas params (Grouped bys) '[tab ::: '["col" ::: nullity 'PGbool]] (nullity 'PGbool)

1625+-- expression = everyDistinct #col

1626+-- in printSQL expression

1627+-- :}

1628+-- every(DISTINCT "col")

1629+everyDistinct

1630+ :: Expression 'Ungrouped commons schemas params from (nullity 'PGbool)

1631+ -- ^ what to aggregate

1632+ -> Expression ('Grouped bys) commons schemas params from (nullity 'PGbool)

1633+everyDistinct = unsafeAggregateDistinct "every"

1634+

1635+-- | minimum and maximum aggregation

1636+max_, min_, maxDistinct, minDistinct

1637+ :: Expression 'Ungrouped commons schemas params from (nullity ty)

1638+ -- ^ what to aggregate

1639+ -> Expression ('Grouped bys) commons schemas params from (nullity ty)

1640+max_ = unsafeAggregate "max"

1641+min_ = unsafeAggregate "min"

1642+maxDistinct = unsafeAggregateDistinct "max"

1643+minDistinct = unsafeAggregateDistinct "min"

1644+

1645+{-----------------------------------------

1646+type expressions

1647+-----------------------------------------}

1648+

1649+-- | `TypeExpression`s are used in `cast`s and `createTable` commands.

1650+newtype TypeExpression (schemas :: SchemasType) (ty :: NullityType)

1651+ = UnsafeTypeExpression { renderTypeExpression :: ByteString }

1652+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

1653+instance RenderSQL (TypeExpression schemas ty) where

1654+ renderSQL = renderTypeExpression

1655+

1656+-- | The enum or composite type in a `Typedef` can be expressed by its alias.

1657+typedef

1658+ :: (Has sch schemas schema, Has td schema ('Typedef ty))

1659+ => QualifiedAlias sch td

1660+ -> TypeExpression schemas (nullity ty)

1661+typedef = UnsafeTypeExpression . renderSQL

1662+

1663+-- | The composite type corresponding to a `Table` definition can be expressed

1664+-- by its alias.

1665+typetable

1666+ :: (Has sch schemas schema, Has tab schema ('Table table))

1667+ => QualifiedAlias sch tab

1668+ -> TypeExpression schemas (nullity ('PGcomposite (TableToRow table)))

1669+typetable = UnsafeTypeExpression . renderSQL

1670+

1671+-- | The composite type corresponding to a `View` definition can be expressed

1672+-- by its alias.

1673+typeview

1674+ :: (Has sch schemas schema, Has vw schema ('View view))

1675+ => QualifiedAlias sch vw

1676+ -> TypeExpression schemas (nullity ('PGcomposite view))

1677+typeview = UnsafeTypeExpression . renderSQL

1678+

1679+-- | logical Boolean (true/false)

1680+bool :: TypeExpression schemas (nullity 'PGbool)

1681+bool = UnsafeTypeExpression "bool"

1682+-- | signed two-byte integer

1683+int2, smallint :: TypeExpression schemas (nullity 'PGint2)

1684+int2 = UnsafeTypeExpression "int2"

1685+smallint = UnsafeTypeExpression "smallint"

1686+-- | signed four-byte integer

1687+int4, int, integer :: TypeExpression schemas (nullity 'PGint4)

1688+int4 = UnsafeTypeExpression "int4"

1689+int = UnsafeTypeExpression "int"

1690+integer = UnsafeTypeExpression "integer"

1691+-- | signed eight-byte integer

1692+int8, bigint :: TypeExpression schemas (nullity 'PGint8)

1693+int8 = UnsafeTypeExpression "int8"

1694+bigint = UnsafeTypeExpression "bigint"

1695+-- | arbitrary precision numeric type

1696+numeric :: TypeExpression schemas (nullity 'PGnumeric)

1697+numeric = UnsafeTypeExpression "numeric"

1698+-- | single precision floating-point number (4 bytes)

1699+float4, real :: TypeExpression schemas (nullity 'PGfloat4)

1700+float4 = UnsafeTypeExpression "float4"

1701+real = UnsafeTypeExpression "real"

1702+-- | double precision floating-point number (8 bytes)

1703+float8, doublePrecision :: TypeExpression schemas (nullity 'PGfloat8)

1704+float8 = UnsafeTypeExpression "float8"

1705+doublePrecision = UnsafeTypeExpression "double precision"

1706+-- | variable-length character string

1707+text :: TypeExpression schemas (nullity 'PGtext)

1708+text = UnsafeTypeExpression "text"

1709+-- | fixed-length character string

1710+char, character

1711+ :: forall n schemas nullity. (KnownNat n, 1 <= n)

1712+ => TypeExpression schemas (nullity ('PGchar n))

1713+char = UnsafeTypeExpression $ "char(" <> renderNat @n <> ")"

1714+character = UnsafeTypeExpression $ "character(" <> renderNat @n <> ")"

1715+-- | variable-length character string

1716+varchar, characterVarying

1717+ :: forall n schemas nullity. (KnownNat n, 1 <= n)

1718+ => TypeExpression schemas (nullity ('PGvarchar n))

1719+varchar = UnsafeTypeExpression $ "varchar(" <> renderNat @n <> ")"

1720+characterVarying = UnsafeTypeExpression $

1721+ "character varying(" <> renderNat @n <> ")"

1722+-- | binary data ("byte array")

1723+bytea :: TypeExpression schemas (nullity 'PGbytea)

1724+bytea = UnsafeTypeExpression "bytea"

1725+-- | date and time (no time zone)

1726+timestamp :: TypeExpression schemas (nullity 'PGtimestamp)

1727+timestamp = UnsafeTypeExpression "timestamp"

1728+-- | date and time, including time zone

1729+timestampWithTimeZone :: TypeExpression schemas (nullity 'PGtimestamptz)

1730+timestampWithTimeZone = UnsafeTypeExpression "timestamp with time zone"

1731+-- | calendar date (year, month, day)

1732+date :: TypeExpression schemas (nullity 'PGdate)

1733+date = UnsafeTypeExpression "date"

1734+-- | time of day (no time zone)

1735+time :: TypeExpression schemas (nullity 'PGtime)

1736+time = UnsafeTypeExpression "time"

1737+-- | time of day, including time zone

1738+timeWithTimeZone :: TypeExpression schemas (nullity 'PGtimetz)

1739+timeWithTimeZone = UnsafeTypeExpression "time with time zone"

1740+-- | time span

1741+interval :: TypeExpression schemas (nullity 'PGinterval)

1742+interval = UnsafeTypeExpression "interval"

1743+-- | universally unique identifier

1744+uuid :: TypeExpression schemas (nullity 'PGuuid)

1745+uuid = UnsafeTypeExpression "uuid"

1746+-- | IPv4 or IPv6 host address

1747+inet :: TypeExpression schemas (nullity 'PGinet)

1748+inet = UnsafeTypeExpression "inet"

1749+-- | textual JSON data

1750+json :: TypeExpression schemas (nullity 'PGjson)

1751+json = UnsafeTypeExpression "json"

1752+-- | binary JSON data, decomposed

1753+jsonb :: TypeExpression schemas (nullity 'PGjsonb)

1754+jsonb = UnsafeTypeExpression "jsonb"

1755+-- | variable length array

1756+vararray

1757+ :: TypeExpression schemas pg

1758+ -> TypeExpression schemas (nullity ('PGvararray pg))

1759+vararray ty = UnsafeTypeExpression $ renderSQL ty <> "[]"

1760+-- | fixed length array

1761+--

1762+-- >>> renderSQL (fixarray @'[2] json)

1763+-- "json[2]"

1764+fixarray

1765+ :: forall dims schemas nullity pg. All KnownNat dims

1766+ => TypeExpression schemas pg

1767+ -> TypeExpression schemas (nullity ('PGfixarray dims pg))

1768+fixarray ty = UnsafeTypeExpression $

1769+ renderSQL ty <> renderDims @dims

1770+ where

1771+ renderDims :: forall ns. All KnownNat ns => ByteString

1772+ renderDims =

1773+ ("[" <>)

1774+ . (<> "]")

1775+ . ByteString.intercalate "]["

1776+ . hcollapse

1777+ $ hcmap (Proxy @KnownNat)

1778+ (K . fromString . show . natVal)

1779+ (hpure Proxy :: NP Proxy ns)

1780+

1781+-- | `pgtype` is a demoted version of a `PGType`

1782+class PGTyped schemas (ty :: NullityType) where

1783+ pgtype :: TypeExpression schemas ty

1784+instance PGTyped schemas (nullity 'PGbool) where pgtype = bool

1785+instance PGTyped schemas (nullity 'PGint2) where pgtype = int2

1786+instance PGTyped schemas (nullity 'PGint4) where pgtype = int4

1787+instance PGTyped schemas (nullity 'PGint8) where pgtype = int8

1788+instance PGTyped schemas (nullity 'PGnumeric) where pgtype = numeric

1789+instance PGTyped schemas (nullity 'PGfloat4) where pgtype = float4

1790+instance PGTyped schemas (nullity 'PGfloat8) where pgtype = float8

1791+instance PGTyped schemas (nullity 'PGtext) where pgtype = text

1792+instance (KnownNat n, 1 <= n)

1793+ => PGTyped schemas (nullity ('PGchar n)) where pgtype = char @n

1794+instance (KnownNat n, 1 <= n)

1795+ => PGTyped schemas (nullity ('PGvarchar n)) where pgtype = varchar @n

1796+instance PGTyped schemas (nullity 'PGbytea) where pgtype = bytea

1797+instance PGTyped schemas (nullity 'PGtimestamp) where pgtype = timestamp

1798+instance PGTyped schemas (nullity 'PGtimestamptz) where pgtype = timestampWithTimeZone

1799+instance PGTyped schemas (nullity 'PGdate) where pgtype = date

1800+instance PGTyped schemas (nullity 'PGtime) where pgtype = time

1801+instance PGTyped schemas (nullity 'PGtimetz) where pgtype = timeWithTimeZone

1802+instance PGTyped schemas (nullity 'PGinterval) where pgtype = interval

1803+instance PGTyped schemas (nullity 'PGuuid) where pgtype = uuid

1804+instance PGTyped schemas (nullity 'PGjson) where pgtype = json

1805+instance PGTyped schemas (nullity 'PGjsonb) where pgtype = jsonb

1806+instance PGTyped schemas ty

1807+ => PGTyped schemas (nullity ('PGvararray ty)) where

1808+ pgtype = vararray (pgtype @schemas @ty)

1809+instance (All KnownNat dims, PGTyped schemas ty)

1810+ => PGTyped schemas (nullity ('PGfixarray dims ty)) where

1811+ pgtype = fixarray @dims (pgtype @schemas @ty)

1812+

1813+{-----------------------------------------

1814+Sorting

1815+-----------------------------------------}

1816+

1817+-- | `SortExpression`s are used by `sortBy` to optionally sort the results

1818+-- of a `Query`. `Asc` or `Desc` set the sort direction of a `NotNull` result

1819+-- column to ascending or descending. Ascending order puts smaller values

1820+-- first, where "smaller" is defined in terms of the `.<` operator. Similarly,

1821+-- descending order is determined with the `.>` operator. `AscNullsFirst`,

1822+-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to

1823+-- determine whether nulls appear before or after non-null values in the sort

1824+-- ordering of a `Null` result column.

1825+data SortExpression grp commons schemas params from where

1826+ Asc

1827+ :: Expression grp commons schemas params from ('NotNull ty)

1828+ -> SortExpression grp commons schemas params from

1829+ Desc

1830+ :: Expression grp commons schemas params from ('NotNull ty)

1831+ -> SortExpression grp commons schemas params from

1832+ AscNullsFirst

1833+ :: Expression grp commons schemas params from ('Null ty)

1834+ -> SortExpression grp commons schemas params from

1835+ AscNullsLast

1836+ :: Expression grp commons schemas params from ('Null ty)

1837+ -> SortExpression grp commons schemas params from

1838+ DescNullsFirst

1839+ :: Expression grp commons schemas params from ('Null ty)

1840+ -> SortExpression grp commons schemas params from

1841+ DescNullsLast

1842+ :: Expression grp commons schemas params from ('Null ty)

1843+ -> SortExpression grp commons schemas params from

1844+deriving instance Show (SortExpression grp commons schemas params from)

1845+

1846+class OrderBy expr where

1847+ orderBy

1848+ :: [SortExpression grp commons schemas params from]

1849+ -> expr grp commons schemas params from

1850+ -> expr grp commons schemas params from

1851+

1852+-- | Render a `SortExpression`.

1853+instance RenderSQL (SortExpression grp commons schemas params from) where

1854+ renderSQL = \case

1855+ Asc expression -> renderSQL expression <+> "ASC"

1856+ Desc expression -> renderSQL expression <+> "DESC"

1857+ AscNullsFirst expression -> renderSQL expression

1858+ <+> "ASC NULLS FIRST"

1859+ DescNullsFirst expression -> renderSQL expression

1860+ <+> "DESC NULLS FIRST"

1861+ AscNullsLast expression -> renderSQL expression <+> "ASC NULLS LAST"

1862+ DescNullsLast expression -> renderSQL expression <+> "DESC NULLS LAST"

1863+

1864+data WindowDefinition grp commons schemas params from where

1865+ WindowDefinition

1866+ :: SListI bys

1867+ => NP (Expression grp commons schemas params from) bys

1868+ -> [SortExpression grp commons schemas params from]

1869+ -> WindowDefinition grp commons schemas params from

1870+

1871+instance OrderBy WindowDefinition where

1872+ orderBy sortsR (WindowDefinition parts sortsL)

1873+ = WindowDefinition parts (sortsL ++ sortsR)

1874+

1875+instance RenderSQL (WindowDefinition commons schemas from grp params) where

1876+ renderSQL (WindowDefinition part ord) =

1877+ renderPartitionByClause part <> renderOrderByClause ord

1878+ where

1879+ renderPartitionByClause = \case

1880+ Nil -> ""

1881+ parts -> "PARTITION" <+> "BY" <+> renderCommaSeparated renderExpression parts

1882+ renderOrderByClause = \case

1883+ [] -> ""

1884+ srts -> " ORDER" <+> "BY"

1885+ <+> commaSeparated (renderSQL <$> srts)

1886+

1887+partitionBy

1888+ :: SListI bys

1889+ => NP (Expression grp commons schemas params from) bys

1890+ -> WindowDefinition grp commons schemas params from

1891+partitionBy bys = WindowDefinition bys []

1892+

1893+newtype WindowFunction

1894+ (grp :: Grouping)

1895+ (commons :: FromType)

1896+ (schemas :: SchemasType)

1897+ (params :: [NullityType])

1898+ (from :: FromType)

1899+ (ty :: NullityType)

1900+ = UnsafeWindowFunction { renderWindowFunction :: ByteString }

1901+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

1902+

1903+instance RenderSQL (WindowFunction grp commons schemas params from ty) where

1904+ renderSQL = renderWindowFunction

1905+

1906+{- | rank of the current row with gaps; same as `rowNumber` of its first peer

1907+>>> printSQL rank

1908+rank()

1909+-}

1910+rank :: WindowFunction grp commons schemas params from ('NotNull 'PGint8)

1911+rank = UnsafeWindowFunction "rank()"

1912+

1913+{- | number of the current row within its partition, counting from 1

1914+>>> printSQL rowNumber

1915+row_number()

1916+-}

1917+rowNumber :: WindowFunction grp commons schemas params from ('NotNull 'PGint8)

1918+rowNumber = UnsafeWindowFunction "row_number()"

1919+

1920+{- | rank of the current row without gaps; this function counts peer groups

1921+>>> printSQL denseRank

1922+dense_rank()

1923+-}

1924+denseRank :: WindowFunction grp commons schemas params from ('NotNull 'PGint8)

1925+denseRank = UnsafeWindowFunction "dense_rank()"

1926+

1927+{- | relative rank of the current row: (rank - 1) / (total partition rows - 1)

1928+>>> printSQL percentRank

1929+percent_rank()

1930+-}

1931+percentRank :: WindowFunction grp commons schemas params from ('NotNull 'PGfloat8)

1932+percentRank = UnsafeWindowFunction "percent_rank()"

1933+

1934+{- | cumulative distribution: (number of partition rows

1935+preceding or peer with current row) / total partition rows

1936+>>> printSQL cumeDist

1937+cume_dist()

1938+-}

1939+cumeDist :: WindowFunction grp commons schemas params from ('NotNull 'PGfloat8)

1940+cumeDist = UnsafeWindowFunction "cume_dist()"

1941+

1942+{- | integer ranging from 1 to the argument value,

1943+dividing the partition as equally as possible

1944+-}

1945+ntile

1946+ :: Expression grp commons schemas params from ('NotNull 'PGint4)

1947+ -- ^ numuckets

1948+ -> WindowFunction grp commons schemas params from ('NotNull 'PGint4)

1949+ntile numBuckets = UnsafeWindowFunction $ "ntile"

1950+ <> parenthesized (renderSQL numBuckets)

1951+

1952+{- | returns value evaluated at the row that is offset rows before the current

1953+row within the partition; if there is no such row, instead return default

1954+(which must be of the same type as value). Both offset and default are

1955+evaluated with respect to the current row.

1956+-}

1957+lag

1958+ :: Expression grp commons schemas params from ty

1959+ -- ^ value

1960+ -> Expression grp commons schemas params from ('NotNull 'PGint4)

1961+ -- ^ offset

1962+ -> Expression grp commons schemas params from ty

1963+ -- ^ default

1964+ -> WindowFunction grp commons schemas params from ty

1965+lag value offset def = UnsafeWindowFunction $ "lag"

1966+ <> parenthesized

1967+ (commaSeparated ([renderSQL value, renderSQL offset, renderSQL def]))

1968+

1969+{- | returns value evaluated at the row that is offset rows after the current

1970+row within the partition; if there is no such row, instead return default

1971+(which must be of the same type as value). Both offset and default are

1972+evaluated with respect to the current row.

1973+-}

1974+lead

1975+ :: Expression grp commons schemas params from ty

1976+ -- ^ value

1977+ -> Expression grp commons schemas params from ('NotNull 'PGint4)

1978+ -- ^ offset

1979+ -> Expression grp commons schemas params from ty

1980+ -- ^ default

1981+ -> WindowFunction grp commons schemas params from ty

1982+lead value offset def = UnsafeWindowFunction $ "lag"

1983+ <> parenthesized

1984+ (commaSeparated ([renderSQL value, renderSQL offset, renderSQL def]))

1985+

1986+{- | returns value evaluated at the row that is the

1987+first row of the window frame

1988+-}

1989+firstValue

1990+ :: Expression grp commons schemas params from ty

1991+ -- ^ value

1992+ -> WindowFunction grp commons schemas params from ty

1993+firstValue value = UnsafeWindowFunction $ "first_value"

1994+ <> parenthesized (renderSQL value)

1995+

1996+{- | returns value evaluated at the row that is the

1997+last row of the window frame

1998+-}

1999+lastValue

2000+ :: Expression grp commons schemas params from ty

2001+ -- ^ value

2002+ -> WindowFunction grp commons schemas params from ty

2003+lastValue value = UnsafeWindowFunction $ "last_value"

2004+ <> parenthesized (renderSQL value)

2005+

2006+{- | returns value evaluated at the row that is the nth

2007+row of the window frame (counting from 1); null if no such row

2008+-}

2009+nthValue

2010+ :: Expression grp commons schemas params from (nullity ty)

2011+ -- ^ value

2012+ -> Expression grp commons schemas params from ('NotNull 'PGint4)

2013+ -- ^ nth

2014+ -> WindowFunction grp commons schemas params from ('Null ty)

2015+nthValue value nth = UnsafeWindowFunction $ "nth_value"

2016+ <> parenthesized (commaSeparated [renderSQL value, renderSQL nth])

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Aggregate.hsdeleted−462

@@ -1,462 +0,0 @@

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

12− DataKinds

13− , DeriveGeneric

14− , FlexibleContexts

15− , FlexibleInstances

16− , FunctionalDependencies

17− , LambdaCase

18− , MultiParamTypeClasses

19− , OverloadedStrings

20− , PolyKinds

21− , TypeFamilies

22− , TypeOperators

23− , UndecidableInstances

24−#-}

25−

26−module Squeal.PostgreSQL.Expression.Aggregate

27− ( Aggregate (..)

28− , Distinction (..)

29− , PGSum

30− , PGAvg

31− ) where

32−

33−import Control.DeepSeq

34−import Data.ByteString (ByteString)

35−import Data.Kind

36−import GHC.TypeLits

37−

38−import qualified GHC.Generics as GHC

39−import qualified Generics.SOP as SOP

40−

41−import Squeal.PostgreSQL.Alias

42−import Squeal.PostgreSQL.Expression

43−import Squeal.PostgreSQL.List

44−import Squeal.PostgreSQL.Render

45−import Squeal.PostgreSQL.Schema

46−

47−-- $setup

48−-- >>> import Squeal.PostgreSQL

49−

50−{- |

51−`Aggregate` functions compute a single result from a set of input values.

52−`Aggregate` functions can be used as `GroupedBy` `Expression`s as well

53−as `Squeal.PostgreSQL.Expression.Window.WindowFunction`s.

54−-}

55−class Aggregate expr1 exprN aggr

56− | aggr -> expr1, aggr -> exprN where

57−

58− -- | A special aggregation that does not require an input

59− --

60− -- >>> :{

61− -- let

62− -- expression :: Expression '[] commons ('Grouped bys) schemas params from ('NotNull 'PGint8)

63− -- expression = countStar

64− -- in printSQL expression

65− -- :}

66− -- count(*)

67− countStar :: aggr ('NotNull 'PGint8)

68−

69− -- | >>> :{

70− -- let

71− -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null ty]] ('NotNull 'PGint8)

72− -- expression = count (All #col)

73− -- in printSQL expression

74− -- :}

75− -- count(ALL "col")

76− count

77− :: expr1 ty

78− -- ^ what to count

79− -> aggr ('NotNull 'PGint8)

80−

81− -- | >>> :{

82− -- let

83− -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('Null 'PGnumeric)

84− -- expression = sum_ (Distinct #col)

85− -- in printSQL expression

86− -- :}

87− -- sum(DISTINCT "col")

88− sum_

89− :: expr1 (null ty)

90− -> aggr ('Null (PGSum ty))

91−

92− -- | input values, including nulls, concatenated into an array

93− arrayAgg

94− :: expr1 ty

95− -> aggr ('Null ('PGvararray ty))

96−

97− -- | aggregates values as a JSON array

98− jsonAgg

99− :: expr1 ty

100− -> aggr ('Null 'PGjson)

101−

102− -- | aggregates values as a JSON array

103− jsonbAgg

104− :: expr1 ty

105− -> aggr ('Null 'PGjsonb)

106−

107− {- |

108− the bitwise AND of all non-null input values, or null if none

109−

110− >>> :{

111− let

112− expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

113− expression = bitAnd (Distinct #col)

114− in printSQL expression

115− :}

116− bit_and(DISTINCT "col")

117− -}

118− bitAnd

119− :: int `In` PGIntegral

120− => expr1 (null int)

121− -- ^ what to aggregate

122− -> aggr ('Null int)

123−

124− {- |

125− the bitwise OR of all non-null input values, or null if none

126−

127− >>> :{

128− let

129− expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

130− expression = bitOr (All #col)

131− in printSQL expression

132− :}

133− bit_or(ALL "col")

134− -}

135− bitOr

136− :: int `In` PGIntegral

137− => expr1 (null int)

138− -- ^ what to aggregate

139− -> aggr ('Null int)

140−

141− {- |

142− true if all input values are true, otherwise false

143−

144− >>> :{

145− let

146− winFun :: WindowFunction '[] commons 'Ungrouped schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

147− winFun = boolAnd #col

148− in printSQL winFun

149− :}

150− bool_and("col")

151− -}

152− boolAnd

153− :: expr1 (null 'PGbool)

154− -- ^ what to aggregate

155− -> aggr ('Null 'PGbool)

156−

157− {- |

158− true if at least one input value is true, otherwise false

159−

160− >>> :{

161− let

162− expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

163− expression = boolOr (All #col)

164− in printSQL expression

165− :}

166− bool_or(ALL "col")

167− -}

168− boolOr

169− :: expr1 (null 'PGbool)

170− -- ^ what to aggregate

171− -> aggr ('Null 'PGbool)

172−

173− {- |

174− equivalent to `boolAnd`

175−

176− >>> :{

177− let

178− expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

179− expression = every (Distinct #col)

180− in printSQL expression

181− :}

182− every(DISTINCT "col")

183− -}

184− every

185− :: expr1 (null 'PGbool)

186− -- ^ what to aggregate

187− -> aggr ('Null 'PGbool)

188−

189− {- |maximum value of expression across all input values-}

190− max_

191− :: expr1 (null ty)

192− -- ^ what to maximize

193− -> aggr ('Null ty)

194−

195− -- | minimum value of expression across all input values

196− min_

197− :: expr1 (null ty)

198− -- ^ what to minimize

199− -> aggr ('Null ty)

200−

201− -- | the average (arithmetic mean) of all input values

202− avg

203− :: expr1 (null ty)

204− -- ^ what to average

205− -> aggr ('Null (PGAvg ty))

206−

207− {- | correlation coefficient

208−

209− >>> :{

210− let

211− expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

212− expression = corr (All (#y *: #x))

213− in printSQL expression

214− :}

215− corr(ALL "y", "x")

216− -}

217− corr

218− :: exprN '[null 'PGfloat8, null 'PGfloat8]

219− -> aggr ('Null 'PGfloat8)

220−

221− {- | population covariance

222−

223− >>> :{

224− let

225− expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

226− expression = covarPop (All (#y *: #x))

227− in printSQL expression

228− :}

229− covar_pop(ALL "y", "x")

230− -}

231− covarPop

232− :: exprN '[null 'PGfloat8, null 'PGfloat8]

233− -> aggr ('Null 'PGfloat8)

234−

235− {- | sample covariance

236−

237− >>> :{

238− let

239− winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

240− winFun = covarSamp (#y *: #x)

241− in printSQL winFun

242− :}

243− covar_samp("y", "x")

244− -}

245− covarSamp

246− :: exprN '[null 'PGfloat8, null 'PGfloat8]

247− -> aggr ('Null 'PGfloat8)

248−

249− {- | average of the independent variable (sum(X)/N)

250−

251− >>> :{

252− let

253− expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

254− expression = regrAvgX (All (#y *: #x))

255− in printSQL expression

256− :}

257− regr_avgx(ALL "y", "x")

258− -}

259− regrAvgX

260− :: exprN '[null 'PGfloat8, null 'PGfloat8]

261− -> aggr ('Null 'PGfloat8)

262−

263− {- | average of the dependent variable (sum(Y)/N)

264−

265− >>> :{

266− let

267− winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

268− winFun = regrAvgY (#y *: #x)

269− in printSQL winFun

270− :}

271− regr_avgy("y", "x")

272− -}

273− regrAvgY

274− :: exprN '[null 'PGfloat8, null 'PGfloat8]

275− -> aggr ('Null 'PGfloat8)

276−

277− {- | number of input rows in which both expressions are nonnull

278−

279− >>> :{

280− let

281− winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGint8)

282− winFun = regrCount (#y *: #x)

283− in printSQL winFun

284− :}

285− regr_count("y", "x")

286− -}

287− regrCount

288− :: exprN '[null 'PGfloat8, null 'PGfloat8]

289− -> aggr ('Null 'PGint8)

290−

291− {- | y-intercept of the least-squares-fit linear equation determined by the (X, Y) pairs

292− >>> :{

293− let

294− expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

295− expression = regrIntercept (All (#y *: #x))

296− in printSQL expression

297− :}

298− regr_intercept(ALL "y", "x")

299− -}

300− regrIntercept

301− :: exprN '[null 'PGfloat8, null 'PGfloat8]

302− -> aggr ('Null 'PGfloat8)

303−

304− -- | @regr_r2(Y, X)@, square of the correlation coefficient

305− regrR2

306− :: exprN '[null 'PGfloat8, null 'PGfloat8]

307− -> aggr ('Null 'PGfloat8)

308−

309− -- | @regr_slope(Y, X)@, slope of the least-squares-fit linear equation

310− -- determined by the (X, Y) pairs

311− regrSlope

312− :: exprN '[null 'PGfloat8, null 'PGfloat8]

313− -> aggr ('Null 'PGfloat8)

314−

315− -- | @regr_sxx(Y, X)@, sum(X^2) - sum(X)^2/N

316− -- (“sum of squares” of the independent variable)

317− regrSxx

318− :: exprN '[null 'PGfloat8, null 'PGfloat8]

319− -> aggr ('Null 'PGfloat8)

320−

321− -- | @regr_sxy(Y, X)@, sum(X*Y) - sum(X) * sum(Y)/N

322− -- (“sum of products” of independent times dependent variable)

323− regrSxy

324− :: exprN '[null 'PGfloat8, null 'PGfloat8]

325− -> aggr ('Null 'PGfloat8)

326−

327− -- | @regr_syy(Y, X)@, sum(Y^2) - sum(Y)^2/N

328− -- (“sum of squares” of the dependent variable)

329− regrSyy

330− :: exprN '[null 'PGfloat8, null 'PGfloat8]

331− -> aggr ('Null 'PGfloat8)

332−

333− -- | historical alias for `stddevSamp`

334− stddev

335− :: expr1 (null ty)

336− -> aggr ('Null (PGAvg ty))

337−

338− -- | population standard deviation of the input values

339− stddevPop

340− :: expr1 (null ty)

341− -> aggr ('Null (PGAvg ty))

342−

343− -- | sample standard deviation of the input values

344− stddevSamp

345− :: expr1 (null ty)

346− -> aggr ('Null (PGAvg ty))

347−

348− -- | historical alias for `varSamp`

349− variance

350− :: expr1 (null ty)

351− -> aggr ('Null (PGAvg ty))

352−

353− -- | population variance of the input values

354− -- (square of the population standard deviation)

355− varPop

356− :: expr1 (null ty)

357− -> aggr ('Null (PGAvg ty))

358−

359− -- | sample variance of the input values

360− -- (square of the sample standard deviation)

361− varSamp

362− :: expr1 (null ty)

363− -> aggr ('Null (PGAvg ty))

364−

365−{- |

366−`Distinction`s are used for the input of `Aggregate` `Expression`s.

367−`All` invokes the aggregate once for each input row.

368−`Distinct` invokes the aggregate once for each distinct value of the expression

369−(or distinct set of values, for multiple expressions) found in the input

370−-}

371−data Distinction (expr :: kind -> Type) (ty :: kind)

372− = All (expr ty)

373− | Distinct (expr ty)

374− deriving (GHC.Generic,Show,Eq,Ord)

375−instance NFData (Distinction (Expression outer commons grp schemas params from) ty)

376−instance RenderSQL (Distinction (Expression outer commons grp schemas params from) ty) where

377− renderSQL = \case

378− All x -> "ALL" <+> renderSQL x

379− Distinct x -> "DISTINCT" <+> renderSQL x

380−instance SOP.SListI tys => RenderSQL

381− (Distinction (NP (Expression outer commons grp schemas params from)) tys) where

382− renderSQL = \case

383− All xs -> "ALL" <+> renderCommaSeparated renderSQL xs

384− Distinct xs -> "DISTINCT" <+> renderCommaSeparated renderSQL xs

385−

386−instance Aggregate

387− (Distinction (Expression outer commons 'Ungrouped schemas params from))

388− (Distinction (NP (Expression outer commons 'Ungrouped schemas params from)))

389− (Expression outer commons ('Grouped bys) schemas params from) where

390− countStar = UnsafeExpression "count(*)"

391− count = unsafeAggregate1 "count"

392− sum_ = unsafeAggregate1 "sum"

393− arrayAgg = unsafeAggregate1 "array_agg"

394− jsonAgg = unsafeAggregate1 "json_agg"

395− jsonbAgg = unsafeAggregate1 "jsonb_agg"

396− bitAnd = unsafeAggregate1 "bit_and"

397− bitOr = unsafeAggregate1 "bit_or"

398− boolAnd = unsafeAggregate1 "bool_and"

399− boolOr = unsafeAggregate1 "bool_or"

400− every = unsafeAggregate1 "every"

401− max_ = unsafeAggregate1 "max"

402− min_ = unsafeAggregate1 "min"

403− avg = unsafeAggregate1 "avg"

404− corr = unsafeAggregateN "corr"

405− covarPop = unsafeAggregateN "covar_pop"

406− covarSamp = unsafeAggregateN "covar_samp"

407− regrAvgX = unsafeAggregateN "regr_avgx"

408− regrAvgY = unsafeAggregateN "regr_avgy"

409− regrCount = unsafeAggregateN "regr_count"

410− regrIntercept = unsafeAggregateN "regr_intercept"

411− regrR2 = unsafeAggregateN "regr_r2"

412− regrSlope = unsafeAggregateN "regr_slope"

413− regrSxx = unsafeAggregateN "regr_sxx"

414− regrSxy = unsafeAggregateN "regr_sxy"

415− regrSyy = unsafeAggregateN "regr_syy"

416− stddev = unsafeAggregate1 "stddev"

417− stddevPop = unsafeAggregate1 "stddev_pop"

418− stddevSamp = unsafeAggregate1 "stddev_samp"

419− variance = unsafeAggregate1 "variance"

420− varPop = unsafeAggregate1 "var_pop"

421− varSamp = unsafeAggregate1 "var_samp"

422−

423−-- | escape hatch to define aggregate functions

424−unsafeAggregate1

425− :: ByteString -- ^ aggregate function

426− -> Distinction (Expression outer commons 'Ungrouped schemas params from) x

427− -> Expression outer commons ('Grouped bys) schemas params from y

428−unsafeAggregate1 fun x = UnsafeExpression $ fun <> parenthesized (renderSQL x)

429−

430−unsafeAggregateN

431− :: SOP.SListI xs

432− => ByteString -- ^ function

433− -> Distinction (NP (Expression outer commons 'Ungrouped schemas params from)) xs

434− -> Expression outer commons ('Grouped bys) schemas params from y

435−unsafeAggregateN fun xs = UnsafeExpression $ fun <> parenthesized (renderSQL xs)

436−

437−-- | A type family that calculates `PGSum``PGType` of

438−-- a given argument `PGType`.

439−type family PGSum ty where

440− PGSum 'PGint2 = 'PGint8

441− PGSum 'PGint4 = 'PGint8

442− PGSum 'PGint8 = 'PGnumeric

443− PGSum 'PGfloat4 = 'PGfloat4

444− PGSum 'PGfloat8 = 'PGfloat8

445− PGSum 'PGnumeric = 'PGnumeric

446− PGSum 'PGinterval = 'PGinterval

447− PGSum 'PGmoney = 'PGmoney

448− PGSum pg = TypeError

449− ( 'Text "Squeal type error: Cannot sum with argument type "

450− ':<>: 'ShowType pg )

451−

452−-- | A type family that calculates `PGAvg` type of a `PGType`.

453−type family PGAvg ty where

454− PGAvg 'PGint2 = 'PGnumeric

455− PGAvg 'PGint4 = 'PGnumeric

456− PGAvg 'PGint8 = 'PGnumeric

457− PGAvg 'PGnumeric = 'PGnumeric

458− PGAvg 'PGfloat4 = 'PGfloat8

459− PGAvg 'PGfloat8 = 'PGfloat8

460− PGAvg 'PGinterval = 'PGinterval

461− PGAvg pg = TypeError

462− ('Text "Squeal type error: No average for " ':<>: 'ShowType pg)

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Collection.hsdeleted−169

@@ -1,169 +0,0 @@

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

12− AllowAmbiguousTypes

13− , DataKinds

14− , FlexibleContexts

15− , FlexibleInstances

16− , MultiParamTypeClasses

17− , OverloadedLabels

18− , OverloadedStrings

19− , RankNTypes

20− , ScopedTypeVariables

21− , TypeApplications

22− , TypeFamilies

23− , TypeOperators

24− , UndecidableInstances

25−#-}

26−

27−module Squeal.PostgreSQL.Expression.Collection

28− ( array

29− , array1

30− , array2

31− , cardinality

32− , index

33− , unnest

34− , row

35− , field

36− ) where

37−

38−import Data.String

39−import Data.Word (Word64)

40−

41−import qualified Generics.SOP as SOP

42−

43−import Squeal.PostgreSQL.Alias

44−import Squeal.PostgreSQL.Expression

45−import Squeal.PostgreSQL.Expression.Set

46−import Squeal.PostgreSQL.List

47−import Squeal.PostgreSQL.Render

48−import Squeal.PostgreSQL.Schema

49−

50−-- $setup

51−-- >>> import Squeal.PostgreSQL

52−

53−-- | >>> printSQL $ array [null_, false, true]

54−-- ARRAY[NULL, FALSE, TRUE]

55−array

56− :: [Expression outer commons grp schemas params from ty]

57− -- ^ array elements

58− -> Expression outer commons grp schemas params from (null ('PGvararray ty))

59−array xs = UnsafeExpression $ "ARRAY" <>

60− bracketed (commaSeparated (renderSQL <$> xs))

61−

62−{- | construct a 1-dimensional fixed length array

63−

64−>>> printSQL $ array1 (null_ :* false *: true)

65−ARRAY[NULL, FALSE, TRUE]

66−

67−>>> :type array1 (null_ :* false *: true)

68−array1 (null_ :* false *: true)

69− :: Expression

70− outer

71− commons

72− grp

73− schemas

74− params

75− from

76− (null ('PGfixarray '[3] ('Null 'PGbool)))

77−-}

78−array1

79− :: (n ~ Length tys, SOP.All ((~) ty) tys)

80− => NP (Expression outer commons grp schemas params from) tys

81− -> Expression outer commons grp schemas params from (null ('PGfixarray '[n] ty))

82−array1 xs = UnsafeExpression $ "ARRAY" <>

83− bracketed (renderCommaSeparated renderSQL xs)

84−

85−{- | construct a 2-dimensional fixed length array

86−

87−>>> printSQL $ array2 ((null_ :* false *: true) *: (false :* null_ *: true))

88−ARRAY[[NULL, FALSE, TRUE], [FALSE, NULL, TRUE]]

89−

90−>>> :type array2 ((null_ :* false *: true) *: (false :* null_ *: true))

91−array2 ((null_ :* false *: true) *: (false :* null_ *: true))

92− :: Expression

93− outer

94− commons

95− grp

96− schemas

97− params

98− from

99− (null ('PGfixarray '[2, 3] ('Null 'PGbool)))

100−-}

101−array2

102− :: ( SOP.All ((~) tys) tyss

103− , SOP.All SOP.SListI tyss

104− , Length tyss ~ n1

105− , SOP.All ((~) ty) tys

106− , Length tys ~ n2 )

107− => NP (NP (Expression outer commons grp schemas params from)) tyss

108− -> Expression outer commons grp schemas params from (null ('PGfixarray '[n1,n2] ty))

109−array2 xss = UnsafeExpression $ "ARRAY" <>

110− bracketed (renderCommaSeparatedConstraint @SOP.SListI (bracketed . renderCommaSeparated renderSQL) xss)

111−

112−-- | >>> printSQL $ cardinality (array [null_, false, true])

113−-- cardinality(ARRAY[NULL, FALSE, TRUE])

114−cardinality :: null ('PGvararray ty) --> null 'PGint8

115−cardinality = unsafeFunction "cardinality"

116−

117−-- | >>> printSQL $ array [null_, false, true] & index 2

118−-- (ARRAY[NULL, FALSE, TRUE])[2]

119−index

120− :: Word64 -- ^ index

121− -> null ('PGvararray ty) --> NullifyType ty

122−index n expr = UnsafeExpression $

123− parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"

124−

125−-- | Expand an array to a set of rows

126−unnest :: SetFunction "unnest" (null ('PGvararray ty)) '["unnest" ::: ty]

127−unnest = unsafeSetFunction

128−

129−-- | A row constructor is an expression that builds a row value

130−-- (also called a composite value) using values for its member fields.

131−--

132−-- >>> :{

133−-- type Complex = 'PGcomposite

134−-- '[ "real" ::: 'NotNull 'PGfloat8

135−-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

136−-- :}

137−--

138−-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression outer commons grp schemas params from ('NotNull Complex)

139−-- >>> printSQL i

140−-- ROW(0, 1)

141−row

142− :: SOP.SListI row

143− => NP (Aliased (Expression outer commons grp schemas params from)) row

144− -- ^ zero or more expressions for the row field values

145− -> Expression outer commons grp schemas params from (null ('PGcomposite row))

146−row exprs = UnsafeExpression $ "ROW" <> parenthesized

147− (renderCommaSeparated (\ (expr `As` _) -> renderSQL expr) exprs)

148−

149−-- | >>> :{

150−-- type Complex = 'PGcomposite

151−-- '[ "real" ::: 'NotNull 'PGfloat8

152−-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

153−-- type Schema = '["complex" ::: 'Typedef Complex]

154−-- :}

155−--

156−-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression outer '[] grp (Public Schema) from params ('NotNull Complex)

157−-- >>> printSQL $ i & field #complex #imaginary

158−-- (ROW(0, 1)::"complex")."imaginary"

159−field

160− :: ( Has sch schemas schema

161− , Has tydef schema ('Typedef ('PGcomposite row))

162− , Has field row ty)

163− => QualifiedAlias sch tydef -- ^ row type

164− -> Alias field -- ^ field name

165− -> Expression outer commons grp schemas params from ('NotNull ('PGcomposite row))

166− -> Expression outer commons grp schemas params from ty

167−field td fld expr = UnsafeExpression $

168− parenthesized (renderSQL expr <> "::" <> renderSQL td)

169− <> "." <> renderSQL fld

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Comparison.hsdeleted−206

@@ -1,206 +0,0 @@

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

12− OverloadedStrings

13− , RankNTypes

14− , TypeInType

15− , TypeOperators

16−#-}

17−

18−module Squeal.PostgreSQL.Expression.Comparison

19− ( (.==)

20− , (./=)

21− , (.>=)

22− , (.<)

23− , (.<=)

24− , (.>)

25− , greatest

26− , least

27− , BetweenExpr

28− , between

29− , notBetween

30− , betweenSymmetric

31− , notBetweenSymmetric

32− , isDistinctFrom

33− , isNotDistinctFrom

34− , isTrue

35− , isNotTrue

36− , isFalse

37− , isNotFalse

38− , isUnknown

39− , isNotUnknown

40− ) where

41−

42−import Data.ByteString

43−

44−import Squeal.PostgreSQL.Expression

45−import Squeal.PostgreSQL.Expression.Logic

46−import Squeal.PostgreSQL.Render

47−import Squeal.PostgreSQL.Schema

48−

49−-- $setup

50−-- >>> import Squeal.PostgreSQL

51−

52−-- | Comparison operations like `.==`, `./=`, `.>`, `.>=`, `.<` and `.<=`

53−-- will produce @NULL@s if one of their arguments is @NULL@.

54−--

55−-- >>> printSQL $ true .== null_

56−-- (TRUE = NULL)

57−(.==) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

58−(.==) = unsafeBinaryOp "="

59−infix 4 .==

60−

61−-- | >>> printSQL $ true ./= null_

62−-- (TRUE <> NULL)

63−(./=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

64−(./=) = unsafeBinaryOp "<>"

65−infix 4 ./=

66−

67−-- | >>> printSQL $ true .>= null_

68−-- (TRUE >= NULL)

69−(.>=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

70−(.>=) = unsafeBinaryOp ">="

71−infix 4 .>=

72−

73−-- | >>> printSQL $ true .< null_

74−-- (TRUE < NULL)

75−(.<) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

76−(.<) = unsafeBinaryOp "<"

77−infix 4 .<

78−

79−-- | >>> printSQL $ true .<= null_

80−-- (TRUE <= NULL)

81−(.<=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

82−(.<=) = unsafeBinaryOp "<="

83−infix 4 .<=

84−

85−-- | >>> printSQL $ true .> null_

86−-- (TRUE > NULL)

87−(.>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

88−(.>) = unsafeBinaryOp ">"

89−infix 4 .>

90−

91−-- | >>> let expr = greatest [param @1] currentTimestamp :: Expression outer commons grp schemas '[ 'NotNull 'PGtimestamptz] from ('NotNull 'PGtimestamptz)

92−-- >>> printSQL expr

93−-- GREATEST(($1 :: timestamp with time zone), CURRENT_TIMESTAMP)

94−greatest :: FunctionVar ty ty ty

95−greatest = unsafeFunctionVar "GREATEST"

96−

97−-- | >>> printSQL $ least [null_] currentTimestamp

98−-- LEAST(NULL, CURRENT_TIMESTAMP)

99−least :: FunctionVar ty ty ty

100−least = unsafeFunctionVar "LEAST"

101−

102−{- |

103−A @RankNType@ for comparison expressions like `between`.

104−-}

105−type BetweenExpr

106− = forall outer commons grp schemas params from ty

107− . Expression outer commons grp schemas params from ty

108− -> ( Expression outer commons grp schemas params from ty

109− , Expression outer commons grp schemas params from ty ) -- ^ bounds

110− -> Condition outer commons grp schemas params from

111−

112−unsafeBetweenExpr :: ByteString -> BetweenExpr

113−unsafeBetweenExpr fun a (x,y) = UnsafeExpression $

114− renderSQL a <+> fun <+> renderSQL x <+> "AND" <+> renderSQL y

115−

116−{- | >>> printSQL $ true `between` (null_, false)

117−TRUE BETWEEN NULL AND FALSE

118−-}

119−between :: BetweenExpr

120−between = unsafeBetweenExpr "BETWEEN"

121−

122−{- | >>> printSQL $ true `notBetween` (null_, false)

123−TRUE NOT BETWEEN NULL AND FALSE

124−-}

125−notBetween :: BetweenExpr

126−notBetween = unsafeBetweenExpr "NOT BETWEEN"

127−

128−{- | between, after sorting the comparison values

129−

130−>>> printSQL $ true `betweenSymmetric` (null_, false)

131−TRUE BETWEEN SYMMETRIC NULL AND FALSE

132−-}

133−betweenSymmetric :: BetweenExpr

134−betweenSymmetric = unsafeBetweenExpr "BETWEEN SYMMETRIC"

135−

136−{- | not between, after sorting the comparison values

137−

138−>>> printSQL $ true `notBetweenSymmetric` (null_, false)

139−TRUE NOT BETWEEN SYMMETRIC NULL AND FALSE

140−-}

141−notBetweenSymmetric :: BetweenExpr

142−notBetweenSymmetric = unsafeBetweenExpr "NOT BETWEEN SYMMETRIC"

143−

144−{- | not equal, treating null like an ordinary value

145−

146−>>> printSQL $ true `isDistinctFrom` null_

147−(TRUE IS DISTINCT FROM NULL)

148−-}

149−isDistinctFrom :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

150−isDistinctFrom = unsafeBinaryOp "IS DISTINCT FROM"

151−

152−{- | equal, treating null like an ordinary value

153−

154−>>> printSQL $ true `isNotDistinctFrom` null_

155−(TRUE IS NOT DISTINCT FROM NULL)

156−-}

157−isNotDistinctFrom :: Operator (null0 ty) (null1 ty) ('NotNull 'PGbool)

158−isNotDistinctFrom = unsafeBinaryOp "IS NOT DISTINCT FROM"

159−

160−{- | is true

161−

162−>>> printSQL $ true & isTrue

163−(TRUE IS TRUE)

164−-}

165−isTrue :: null0 'PGbool --> null1 'PGbool

166−isTrue = unsafeRightOp "IS TRUE"

167−

168−{- | is false or unknown

169−

170−>>> printSQL $ true & isNotTrue

171−(TRUE IS NOT TRUE)

172−-}

173−isNotTrue :: null0 'PGbool --> null1 'PGbool

174−isNotTrue = unsafeRightOp "IS NOT TRUE"

175−

176−{- | is false

177−

178−>>> printSQL $ true & isFalse

179−(TRUE IS FALSE)

180−-}

181−isFalse :: null0 'PGbool --> null1 'PGbool

182−isFalse = unsafeRightOp "IS FALSE"

183−

184−{- | is true or unknown

185−

186−>>> printSQL $ true & isNotFalse

187−(TRUE IS NOT FALSE)

188−-}

189−isNotFalse :: null0 'PGbool --> null1 'PGbool

190−isNotFalse = unsafeRightOp "IS NOT FALSE"

191−

192−{- | is unknown

193−

194−>>> printSQL $ true & isUnknown

195−(TRUE IS UNKNOWN)

196−-}

197−isUnknown :: null0 'PGbool --> null1 'PGbool

198−isUnknown = unsafeRightOp "IS UNKNOWN"

199−

200−{- | is true or false

201−

202−>>> printSQL $ true & isNotUnknown

203−(TRUE IS NOT UNKNOWN)

204−-}

205−isNotUnknown :: null0 'PGbool --> null1 'PGbool

206−isNotUnknown = unsafeRightOp "IS NOT UNKNOWN"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Json.hsdeleted−462

@@ -1,462 +0,0 @@

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

12− DataKinds

13− , FlexibleContexts

14− , FlexibleInstances

15− , GADTs

16− , OverloadedLabels

17− , OverloadedStrings

18− , PolyKinds

19− , RankNTypes

20− , ScopedTypeVariables

21− , TypeApplications

22− , TypeOperators

23− , UndecidableInstances

24− , UndecidableSuperClasses

25−#-}

26−

27−module Squeal.PostgreSQL.Expression.Json

28− ( -- * Json and Jsonb operators

29− (.->)

30− , (.->>)

31− , (.#>)

32− , (.#>>)

33− -- * Jsonb operators

34− , (.?)

35− , (.?|)

36− , (.?&)

37− , (.-.)

38− , (#-.)

39− -- * Json and Jsonb functions

40− , toJson

41− , toJsonb

42− , arrayToJson

43− , rowToJson

44− , jsonBuildArray

45− , jsonbBuildArray

46− , JsonBuildObject (..)

47− , jsonObject

48− , jsonbObject

49− , jsonZipObject

50− , jsonbZipObject

51− , jsonArrayLength

52− , jsonbArrayLength

53− , jsonTypeof

54− , jsonbTypeof

55− , jsonStripNulls

56− , jsonbStripNulls

57− , jsonbSet

58− , jsonbInsert

59− , jsonbPretty

60− -- * Json and Jsonb set returning functions

61− , jsonEach

62− , jsonbEach

63− , jsonEachText

64− , jsonbEachText

65− , jsonObjectKeys

66− , jsonbObjectKeys

67− , JsonPopulateFunction

68− , jsonPopulateRecord

69− , jsonbPopulateRecord

70− , jsonPopulateRecordSet

71− , jsonbPopulateRecordSet

72− , JsonToRecordFunction

73− , jsonToRecord

74− , jsonbToRecord

75− , jsonToRecordSet

76− , jsonbToRecordSet

77− ) where

78−

79−import Data.ByteString (ByteString)

80−import GHC.TypeLits

81−

82−import Squeal.PostgreSQL.Alias

83−import Squeal.PostgreSQL.Expression

84−import Squeal.PostgreSQL.Expression.Set

85−import Squeal.PostgreSQL.Expression.Type

86−import Squeal.PostgreSQL.List

87−import Squeal.PostgreSQL.Query

88−import Squeal.PostgreSQL.Render

89−import Squeal.PostgreSQL.Schema

90−

91−import qualified Generics.SOP as SOP

92−

93−-- $setup

94−-- >>> import Squeal.PostgreSQL

95−-- >>> import Data.Aeson

96−

97−{-----------------------------------------

98− -- json and jsonb support

99−

100−See https://www.postgresql.org/docs/10/static/functions-json.html -- most

101−comments lifted directly from this page.

102−

103−Table 9.44: json and jsonb operators

104−-----------------------------------------}

105−

106−-- | Get JSON value (object field or array element) at a key.

107−(.->)

108− :: (json `In` PGJsonType, key `In` PGJsonKey)

109− => Operator (null json) (null key) ('Null json)

110−infixl 8 .->

111−(.->) = unsafeBinaryOp "->"

112−

113−-- | Get JSON value (object field or array element) at a key, as text.

114−(.->>)

115− :: (json `In` PGJsonType, key `In` PGJsonKey)

116− => Operator (null json) (null key) ('Null 'PGtext)

117−infixl 8 .->>

118−(.->>) = unsafeBinaryOp "->>"

119−

120−-- | Get JSON value at a specified path.

121−(.#>)

122− :: json `In` PGJsonType

123− => Operator (null json) (null ('PGvararray ('NotNull 'PGtext))) ('Null json)

124−infixl 8 .#>

125−(.#>) = unsafeBinaryOp "#>"

126−

127−-- | Get JSON value at a specified path as text.

128−(.#>>)

129− :: json `In` PGJsonType

130− => Operator (null json) (null ('PGvararray ('NotNull 'PGtext))) ('Null 'PGtext)

131−infixl 8 .#>>

132−(.#>>) = unsafeBinaryOp "#>>"

133−

134−-- Additional jsonb operators

135−

136−-- | Does the string exist as a top-level key within the JSON value?

137−(.?) :: Operator (null 'PGjsonb) (null 'PGtext) ('Null 'PGbool)

138−infixl 9 .?

139−(.?) = unsafeBinaryOp "?"

140−

141−-- | Do any of these array strings exist as top-level keys?

142−(.?|) :: Operator

143− (null 'PGjsonb)

144− (null ('PGvararray ('NotNull 'PGtext)))

145− ('Null 'PGbool)

146−infixl 9 .?|

147−(.?|) = unsafeBinaryOp "?|"

148−

149−-- | Do all of these array strings exist as top-level keys?

150−(.?&) :: Operator

151− (null 'PGjsonb)

152− (null ('PGvararray ('NotNull 'PGtext)))

153− ('Null 'PGbool)

154−infixl 9 .?&

155−(.?&) = unsafeBinaryOp "?&"

156−

157−-- | Delete a key or keys from a JSON object, or remove an array element.

158−--

159−-- If the right operand is

160−--

161−-- @ text @: Delete key / value pair or string element from left operand.

162−-- Key / value pairs are matched based on their key value,

163−--

164−-- @ text[] @: Delete multiple key / value pairs or string elements

165−-- from left operand. Key / value pairs are matched based on their key value,

166−--

167−-- @ integer @: Delete the array element with specified index (Negative integers

168−-- count from the end). Throws an error if top level container is not an array.

169−(.-.)

170− :: key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]

171− => Operator (null 'PGjsonb) (null key) (null 'PGjsonb)

172−infixl 6 .-.

173−(.-.) = unsafeBinaryOp "-"

174−

175−-- | Delete the field or element with specified path (for JSON arrays, negative

176−-- integers count from the end)

177−(#-.) :: Operator (null 'PGjsonb) (null ('PGvararray ('NotNull 'PGtext))) (null 'PGjsonb)

178−infixl 6 #-.

179−(#-.) = unsafeBinaryOp "#-"

180−

181−{-----------------------------------------

182−Table 9.45: JSON creation functions

183−-----------------------------------------}

184−

185−-- | Returns the value as json. Arrays and composites are converted

186−-- (recursively) to arrays and objects; otherwise, if there is a cast from the

187−-- type to json, the cast function will be used to perform the conversion;

188−-- otherwise, a scalar value is produced. For any scalar type other than a

189−-- number, a Boolean, or a null value, the text representation will be used, in

190−-- such a fashion that it is a valid json value.

191−toJson :: null ty --> null 'PGjson

192−toJson = unsafeFunction "to_json"

193−

194−-- | Returns the value as jsonb. Arrays and composites are converted

195−-- (recursively) to arrays and objects; otherwise, if there is a cast from the

196−-- type to json, the cast function will be used to perform the conversion;

197−-- otherwise, a scalar value is produced. For any scalar type other than a

198−-- number, a Boolean, or a null value, the text representation will be used, in

199−-- such a fashion that it is a valid jsonb value.

200−toJsonb :: null ty --> null 'PGjsonb

201−toJsonb = unsafeFunction "to_jsonb"

202−

203−-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

204−-- becomes a JSON array of arrays.

205−arrayToJson :: null ('PGvararray ty) --> null 'PGjson

206−arrayToJson = unsafeFunction "array_to_json"

207−

208−-- | Returns the row as a JSON object.

209−rowToJson :: null ('PGcomposite ty) --> null 'PGjson

210−rowToJson = unsafeFunction "row_to_json"

211−

212−-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

213−-- argument list.

214−jsonBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjson

215−jsonBuildArray = unsafeFunctionN "json_build_array"

216−

217−-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

218−-- variadic argument list.

219−jsonbBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjsonb

220−jsonbBuildArray = unsafeFunctionN "jsonb_build_array"

221−

222−-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

223−-- argument list. The elements of the argument list must alternate between text

224−-- and values.

225−class SOP.SListI tys => JsonBuildObject tys where

226−

227− jsonBuildObject :: tys ---> null 'PGjson

228− jsonBuildObject = unsafeFunctionN "json_build_object"

229−

230− jsonbBuildObject :: tys ---> null 'PGjsonb

231− jsonbBuildObject = unsafeFunctionN "jsonb_build_object"

232−

233−instance JsonBuildObject '[]

234−instance (JsonBuildObject tys, key `In` PGJsonKey)

235− => JsonBuildObject ('NotNull key ': value ': tys)

236−

237−-- | Builds a JSON object out of a text array.

238−-- The array must have two dimensions

239−-- such that each inner array has exactly two elements,

240−-- which are taken as a key/value pair.

241−jsonObject

242− :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

243− --> null 'PGjson

244−jsonObject = unsafeFunction "json_object"

245−

246−-- | Builds a binary JSON object out of a text array.

247−-- The array must have two dimensions

248−-- such that each inner array has exactly two elements,

249−-- which are taken as a key/value pair.

250−jsonbObject

251− :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

252− --> null 'PGjsonb

253−jsonbObject = unsafeFunction "jsonb_object"

254−

255−-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

256−-- keys and one for values, that are zipped pairwise to create a JSON object.

257−jsonZipObject ::

258− '[ null ('PGvararray ('NotNull 'PGtext))

259− , null ('PGvararray ('NotNull 'PGtext)) ]

260− ---> null 'PGjson

261−jsonZipObject = unsafeFunctionN "json_object"

262−

263−-- | This is an alternate form of 'jsonbObject' that takes two arrays; one for

264−-- keys and one for values, that are zipped pairwise to create a binary JSON

265−-- object.

266−jsonbZipObject ::

267− '[ null ('PGvararray ('NotNull 'PGtext))

268− , null ('PGvararray ('NotNull 'PGtext)) ]

269− ---> null 'PGjsonb

270−jsonbZipObject = unsafeFunctionN "jsonb_object"

271−

272−{-----------------------------------------

273−Table 9.46: JSON processing functions

274−-----------------------------------------}

275−

276−-- | Returns the number of elements in the outermost JSON array.

277−jsonArrayLength :: null 'PGjson --> null 'PGint4

278−jsonArrayLength = unsafeFunction "json_array_length"

279−

280−-- | Returns the number of elements in the outermost binary JSON array.

281−jsonbArrayLength :: null 'PGjsonb --> null 'PGint4

282−jsonbArrayLength = unsafeFunction "jsonb_array_length"

283−

284−-- | Returns the type of the outermost JSON value as a text string. Possible

285−-- types are object, array, string, number, boolean, and null.

286−jsonTypeof :: null 'PGjson --> null 'PGtext

287−jsonTypeof = unsafeFunction "json_typeof"

288−

289−-- | Returns the type of the outermost binary JSON value as a text string.

290−-- Possible types are object, array, string, number, boolean, and null.

291−jsonbTypeof :: null 'PGjsonb --> null 'PGtext

292−jsonbTypeof = unsafeFunction "jsonb_typeof"

293−

294−-- | Returns its argument with all object fields that have null values omitted.

295−-- Other null values are untouched.

296−jsonStripNulls :: null 'PGjson --> null 'PGjson

297−jsonStripNulls = unsafeFunction "json_strip_nulls"

298−

299−-- | Returns its argument with all object fields that have null values omitted.

300−-- Other null values are untouched.

301−jsonbStripNulls :: null 'PGjsonb --> null 'PGjsonb

302−jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

303−

304−-- | @ jsonbSet target path new_value create_missing @

305−--

306−-- Returns target with the section designated by path replaced by @new_value@,

307−-- or with @new_value@ added if create_missing is

308−-- `Squeal.PostgreSQL.Expression.Logic.true` and the

309−-- item designated by path does not exist. As with the path orientated

310−-- operators, negative integers that appear in path count from the end of JSON

311−-- arrays.

312−jsonbSet ::

313− '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

314− , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

315−jsonbSet = unsafeFunctionN "jsonbSet"

316−

317−-- | @ jsonbInsert target path new_value insert_after @

318−--

319−-- Returns target with @new_value@ inserted. If target section designated by

320−-- path is in a JSONB array, @new_value@ will be inserted before target or after

321−-- if @insert_after@ is `Squeal.PostgreSQL.Expression.Logic.true`.

322−-- If target section designated by

323−-- path is in JSONB object, @new_value@ will be inserted only if target does not

324−-- exist. As with the path orientated operators, negative integers that appear

325−-- in path count from the end of JSON arrays.

326−jsonbInsert ::

327− '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

328− , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

329−jsonbInsert = unsafeFunctionN "jsonb_insert"

330−

331−-- | Returns its argument as indented JSON text.

332−jsonbPretty :: null 'PGjsonb --> null 'PGtext

333−jsonbPretty = unsafeFunction "jsonb_pretty"

334−

335−{- | Expands the outermost JSON object into a set of key/value pairs.

336−

337−>>> printSQL (select Star (from (jsonEach (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))

338−SELECT * FROM json_each(('{"a":"foo","b":"bar"}' :: json))

339−-}

340−jsonEach :: SetFunction "json_each" (null 'PGjson)

341− '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]

342−jsonEach = unsafeSetFunction

343−

344−{- | Expands the outermost binary JSON object into a set of key/value pairs.

345−

346−>>> printSQL (select Star (from (jsonbEach (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))

347−SELECT * FROM jsonb_each(('{"a":"foo","b":"bar"}' :: jsonb))

348−-}

349−jsonbEach

350− :: SetFunction "jsonb_each" (nullity 'PGjsonb)

351− '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]

352−jsonbEach = unsafeSetFunction

353−

354−{- | Expands the outermost JSON object into a set of key/value pairs.

355−

356−>>> printSQL (select Star (from (jsonEachText (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))

357−SELECT * FROM json_each_text(('{"a":"foo","b":"bar"}' :: json))

358−-}

359−jsonEachText

360− :: SetFunction "json_each_text" (null 'PGjson)

361− '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

362−jsonEachText = unsafeSetFunction

363−

364−{- | Expands the outermost binary JSON object into a set of key/value pairs.

365−

366−>>> printSQL (select Star (from (jsonbEachText (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))

367−SELECT * FROM jsonb_each_text(('{"a":"foo","b":"bar"}' :: jsonb))

368−-}

369−jsonbEachText

370− :: SetFunction "jsonb_each_text" (null 'PGjsonb)

371− '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

372−jsonbEachText = unsafeSetFunction

373−

374−{- | Returns set of keys in the outermost JSON object.

375−

376−>>> printSQL (jsonObjectKeys (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))

377−json_object_keys(('{"a":"foo","b":"bar"}' :: json))

378−-}

379−jsonObjectKeys

380− :: SetFunction "json_object_keys" (nullity 'PGjson)

381− '["json_object_keys" ::: 'NotNull 'PGtext]

382−jsonObjectKeys = unsafeSetFunction

383−

384−{- | Returns set of keys in the outermost JSON object.

385−

386−>>> printSQL (jsonbObjectKeys (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))

387−jsonb_object_keys(('{"a":"foo","b":"bar"}' :: jsonb))

388−-}

389−jsonbObjectKeys

390− :: SetFunction "jsonb_object_keys" (null 'PGjsonb)

391− '["jsonb_object_keys" ::: 'NotNull 'PGtext]

392−jsonbObjectKeys = unsafeSetFunction

393−

394−-- | Build rows from Json types.

395−type JsonPopulateFunction fun json

396− = forall schemas row outer commons params

397− . json `In` PGJsonType

398− => TypeExpression schemas ('NotNull ('PGcomposite row)) -- ^ row type

399− -> Expression outer commons 'Ungrouped schemas params '[] ('NotNull json)

400− -- ^ json type

401− -> FromClause outer commons schemas params '[fun ::: row]

402−

403−unsafePopulateFunction

404− :: forall fun ty

405− . KnownSymbol fun => Alias fun -> JsonPopulateFunction fun ty

406−unsafePopulateFunction _fun ty expr = UnsafeFromClause $ renderSymbol @fun

407− <> parenthesized ("null::" <> renderSQL ty <> ", " <> renderSQL expr)

408−

409−-- | Expands the JSON expression to a row whose columns match the record

410−-- type defined by the given table.

411−jsonPopulateRecord :: JsonPopulateFunction "json_populate_record" 'PGjson

412−jsonPopulateRecord = unsafePopulateFunction #json_populate_record

413−

414−-- | Expands the binary JSON expression to a row whose columns match the record

415−-- type defined by the given table.

416−jsonbPopulateRecord :: JsonPopulateFunction "jsonb_populate_record" 'PGjsonb

417−jsonbPopulateRecord = unsafePopulateFunction #jsonb_populate_record

418−

419−-- | Expands the outermost array of objects in the given JSON expression to a

420−-- set of rows whose columns match the record type defined by the given table.

421−jsonPopulateRecordSet :: JsonPopulateFunction "json_populate_record_set" 'PGjson

422−jsonPopulateRecordSet = unsafePopulateFunction #json_populate_record_set

423−

424−-- | Expands the outermost array of objects in the given binary JSON expression

425−-- to a set of rows whose columns match the record type defined by the given

426−-- table.

427−jsonbPopulateRecordSet :: JsonPopulateFunction "jsonb_populate_record_set" 'PGjsonb

428−jsonbPopulateRecordSet = unsafePopulateFunction #jsonb_populate_record_set

429−

430−-- | Build rows from Json types.

431−type JsonToRecordFunction json

432− = forall outer commons schemas params tab row

433− . (SOP.SListI row, json `In` PGJsonType)

434− => Expression outer commons 'Ungrouped schemas params '[] ('NotNull json)

435− -- ^ json type

436− -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: row)

437− -- ^ row type

438− -> FromClause outer commons schemas params '[tab ::: row]

439−

440−unsafeRecordFunction :: ByteString -> JsonToRecordFunction json

441−unsafeRecordFunction fun expr (types `As` tab) = UnsafeFromClause $

442− fun <> parenthesized (renderSQL expr) <+> "AS" <+> renderSQL tab

443− <> parenthesized (renderCommaSeparated renderTy types)

444− where

445− renderTy :: Aliased (TypeExpression schemas) ty -> ByteString

446− renderTy (ty `As` alias) = renderSQL alias <+> renderSQL ty

447−

448−-- | Builds an arbitrary record from a JSON object.

449−jsonToRecord :: JsonToRecordFunction 'PGjson

450−jsonToRecord = unsafeRecordFunction "json_to_record"

451−

452−-- | Builds an arbitrary record from a binary JSON object.

453−jsonbToRecord :: JsonToRecordFunction 'PGjsonb

454−jsonbToRecord = unsafeRecordFunction "jsonb_to_record"

455−

456−-- | Builds an arbitrary set of records from a JSON array of objects.

457−jsonToRecordSet :: JsonToRecordFunction 'PGjson

458−jsonToRecordSet = unsafeRecordFunction "json_to_record_set"

459−

460−-- | Builds an arbitrary set of records from a binary JSON array of objects.

461−jsonbToRecordSet :: JsonToRecordFunction 'PGjsonb

462−jsonbToRecordSet = unsafeRecordFunction "jsonb_to_record_set"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Literal.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.hsdeleted−105

@@ -1,105 +0,0 @@

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

12− DataKinds

13− , OverloadedStrings

14− , TypeOperators

15−#-}

16−

17−module Squeal.PostgreSQL.Expression.Logic

18− ( Condition

19− , true

20− , false

21− , not_

22− , (.&&)

23− , (.||)

24− , caseWhenThenElse

25− , ifThenElse

26− ) where

27−

28−import Squeal.PostgreSQL.Expression

29−import Squeal.PostgreSQL.Render

30−import Squeal.PostgreSQL.Schema

31−

32−-- | A `Condition` is an `Expression`, which can evaluate

33−-- to `true`, `false` or `Squeal.PostgreSQL.Null.null_`. This is because SQL uses

34−-- a three valued logic.

35−type Condition outer commons grp schemas params from =

36− Expression outer commons grp schemas params from ('Null 'PGbool)

37−

38−-- | >>> printSQL true

39−-- TRUE

40−true :: Expr (null 'PGbool)

41−true = UnsafeExpression "TRUE"

42−

43−-- | >>> printSQL false

44−-- FALSE

45−false :: Expr (null 'PGbool)

46−false = UnsafeExpression "FALSE"

47−

48−-- | >>> printSQL $ not_ true

49−-- (NOT TRUE)

50−not_ :: null 'PGbool --> null 'PGbool

51−not_ = unsafeLeftOp "NOT"

52−

53−-- | >>> printSQL $ true .&& false

54−-- (TRUE AND FALSE)

55−(.&&) :: Operator (null 'PGbool) (null 'PGbool) (null 'PGbool)

56−infixr 3 .&&

57−(.&&) = unsafeBinaryOp "AND"

58−

59−-- | >>> printSQL $ true .|| false

60−-- (TRUE OR FALSE)

61−(.||) :: Operator (null 'PGbool) (null 'PGbool) (null 'PGbool)

62−infixr 2 .||

63−(.||) = unsafeBinaryOp "OR"

64−

65−-- | >>> :{

66−-- let

67−-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

68−-- expression = caseWhenThenElse [(true, 1), (false, 2)] 3

69−-- in printSQL expression

70−-- :}

71−-- CASE WHEN TRUE THEN 1 WHEN FALSE THEN 2 ELSE 3 END

72−caseWhenThenElse

73− :: [ ( Condition outer commons grp schemas params from

74− , Expression outer commons grp schemas params from ty

75− ) ]

76− -- ^ whens and thens

77− -> Expression outer commons grp schemas params from ty

78− -- ^ else

79− -> Expression outer commons grp schemas params from ty

80−caseWhenThenElse whenThens else_ = UnsafeExpression $ mconcat

81− [ "CASE"

82− , mconcat

83− [ mconcat

84− [ " WHEN ", renderSQL when_

85− , " THEN ", renderSQL then_

86− ]

87− | (when_,then_) <- whenThens

88− ]

89− , " ELSE ", renderSQL else_

90− , " END"

91− ]

92−

93−-- | >>> :{

94−-- let

95−-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

96−-- expression = ifThenElse true 1 0

97−-- in printSQL expression

98−-- :}

99−-- CASE WHEN TRUE THEN 1 ELSE 0 END

100−ifThenElse

101− :: Condition outer commons grp schemas params from

102− -> Expression outer commons grp schemas params from ty -- ^ then

103− -> Expression outer commons grp schemas params from ty -- ^ else

104− -> Expression outer commons grp schemas params from ty

105−ifThenElse if_ then_ else_ = caseWhenThenElse [(if_,then_)] else_

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Math.hsdeleted−100

@@ -1,100 +0,0 @@

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

12− DataKinds

13− , OverloadedStrings

14− , TypeOperators

15−#-}

16−

17−module Squeal.PostgreSQL.Expression.Math

18− ( atan2_

19− , quot_

20− , rem_

21− , trunc

22− , round_

23− , ceiling_

24− ) where

25−

26−import Squeal.PostgreSQL.Expression

27−import Squeal.PostgreSQL.List

28−import Squeal.PostgreSQL.Schema

29−

30−-- $setup

31−-- >>> import Squeal.PostgreSQL

32−

33−-- | >>> :{

34−-- let

35−-- expression :: Expr (null 'PGfloat4)

36−-- expression = atan2_ (pi *: 2)

37−-- in printSQL expression

38−-- :}

39−-- atan2(pi(), 2)

40−atan2_ :: float `In` PGFloating => '[ null float, null float] ---> null float

41−atan2_ = unsafeFunctionN "atan2"

42−

43−

44−-- | integer division, truncates the result

45−--

46−-- >>> :{

47−-- let

48−-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

49−-- expression = 5 `quot_` 2

50−-- in printSQL expression

51−-- :}

52−-- (5 / 2)

53−quot_

54− :: int `In` PGIntegral

55− => Operator (null int) (null int) (null int)

56−quot_ = unsafeBinaryOp "/"

57−

58−-- | remainder upon integer division

59−--

60−-- >>> :{

61−-- let

62−-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

63−-- expression = 5 `rem_` 2

64−-- in printSQL expression

65−-- :}

66−-- (5 % 2)

67−rem_

68− :: int `In` PGIntegral

69− => Operator (null int) (null int) (null int)

70−rem_ = unsafeBinaryOp "%"

71−

72−-- | >>> :{

73−-- let

74−-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

75−-- expression = trunc pi

76−-- in printSQL expression

77−-- :}

78−-- trunc(pi())

79−trunc :: frac `In` PGFloating => null frac --> null frac

80−trunc = unsafeFunction "trunc"

81−

82−-- | >>> :{

83−-- let

84−-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

85−-- expression = round_ pi

86−-- in printSQL expression

87−-- :}

88−-- round(pi())

89−round_ :: frac `In` PGFloating => null frac --> null frac

90−round_ = unsafeFunction "round"

91−

92−-- | >>> :{

93−-- let

94−-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

95−-- expression = ceiling_ pi

96−-- in printSQL expression

97−-- :}

98−-- ceiling(pi())

99−ceiling_ :: frac `In` PGFloating => null frac --> null frac

100−ceiling_ = unsafeFunction "ceiling"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Null.hsdeleted−104

@@ -1,104 +0,0 @@

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

12− DataKinds

13− , OverloadedStrings

14− , TypeOperators

15−#-}

16−

17−module Squeal.PostgreSQL.Expression.Null

18− ( null_

19− , notNull

20− , coalesce

21− , fromNull

22− , isNull

23− , isNotNull

24− , matchNull

25− , nullIf

26− ) where

27−

28−import Squeal.PostgreSQL.Expression

29−import Squeal.PostgreSQL.Expression.Logic

30−import Squeal.PostgreSQL.Render

31−import Squeal.PostgreSQL.Schema

32−

33−-- $setup

34−-- >>> import Squeal.PostgreSQL

35−

36−-- | analagous to `Nothing`

37−--

38−-- >>> printSQL null_

39−-- NULL

40−null_ :: Expr ('Null ty)

41−null_ = UnsafeExpression "NULL"

42−

43−-- | analagous to `Just`

44−--

45−-- >>> printSQL $ notNull true

46−-- TRUE

47−notNull :: 'NotNull ty --> 'Null ty

48−notNull = UnsafeExpression . renderSQL

49−

50−-- | return the leftmost value which is not NULL

51−--

52−-- >>> printSQL $ coalesce [null_, true] false

53−-- COALESCE(NULL, TRUE, FALSE)

54−coalesce :: FunctionVar ('Null ty) ('NotNull ty) ('NotNull ty)

55−coalesce nullxs notNullx = UnsafeExpression $

56− "COALESCE" <> parenthesized (commaSeparated

57− ((renderSQL <$> nullxs) <> [renderSQL notNullx]))

58−

59−-- | analagous to `Data.Maybe.fromMaybe` using @COALESCE@

60−--

61−-- >>> printSQL $ fromNull true null_

62−-- COALESCE(NULL, TRUE)

63−fromNull

64− :: Expression outer commons grp schemas params from ('NotNull ty)

65− -- ^ what to convert @NULL@ to

66− -> Expression outer commons grp schemas params from ('Null ty)

67− -> Expression outer commons grp schemas params from ('NotNull ty)

68−fromNull notNullx nullx = coalesce [nullx] notNullx

69−

70−-- | >>> printSQL $ null_ & isNull

71−-- NULL IS NULL

72−isNull :: 'Null ty --> null 'PGbool

73−isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"

74−

75−-- | >>> printSQL $ null_ & isNotNull

76−-- NULL IS NOT NULL

77−isNotNull :: 'Null ty --> null 'PGbool

78−isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"

79−

80−-- | analagous to `maybe` using @IS NULL@

81−--

82−-- >>> printSQL $ matchNull true not_ null_

83−-- CASE WHEN NULL IS NULL THEN TRUE ELSE (NOT NULL) END

84−matchNull

85− :: Expression outer commons grp schemas params from (nullty)

86− -- ^ what to convert @NULL@ to

87− -> ( Expression outer commons grp schemas params from ('NotNull ty)

88− -> Expression outer commons grp schemas params from (nullty) )

89− -- ^ function to perform when @NULL@ is absent

90− -> Expression outer commons grp schemas params from ('Null ty)

91− -> Expression outer commons grp schemas params from (nullty)

92−matchNull y f x = ifThenElse (isNull x) y

93− (f (UnsafeExpression (renderSQL x)))

94−

95−{-| right inverse to `fromNull`, if its arguments are equal then

96−`nullIf` gives @NULL@.

97−

98−>>> :set -XTypeApplications -XDataKinds

99−>>> let expr = nullIf (false *: param @1) :: Expression outer commons grp schemas '[ 'NotNull 'PGbool] from ('Null 'PGbool)

100−>>> printSQL expr

101−NULLIF(FALSE, ($1 :: bool))

102−-}

103−nullIf :: '[ 'NotNull ty, 'NotNull ty] ---> 'Null ty

104−nullIf = unsafeFunctionN "NULLIF"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Parameter.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.hsdeleted−85

@@ -1,85 +0,0 @@

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

12− DataKinds

13− , GADTs

14− , LambdaCase

15− , OverloadedStrings

16− , StandaloneDeriving

17−#-}

18−

19−module Squeal.PostgreSQL.Expression.Sort

20− ( SortExpression (..)

21− , OrderBy (..)

22− ) where

23−

24−import Squeal.PostgreSQL.Expression

25−import Squeal.PostgreSQL.Render

26−import Squeal.PostgreSQL.Schema

27−

28−-- | `SortExpression`s are used by `orderBy` to optionally sort the results

29−-- of a `Squeal.PostgreSQL.Query.Query`. `Asc` or `Desc`

30−-- set the sort direction of a `NotNull` result

31−-- column to ascending or descending. Ascending order puts smaller values

32−-- first, where "smaller" is defined in terms of the

33−-- `Squeal.PostgreSQL.Expression.Comparison..<` operator. Similarly,

34−-- descending order is determined with the

35−-- `Squeal.PostgreSQL.Expression.Comparison..>` operator. `AscNullsFirst`,

36−-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to

37−-- determine whether nulls appear before or after non-null values in the sort

38−-- ordering of a `Null` result column.

39−data SortExpression outer commons grp schemas params from where

40− Asc

41− :: Expression outer commons grp schemas params from ('NotNull ty)

42− -> SortExpression outer commons grp schemas params from

43− Desc

44− :: Expression outer commons grp schemas params from ('NotNull ty)

45− -> SortExpression outer commons grp schemas params from

46− AscNullsFirst

47− :: Expression outer commons grp schemas params from ('Null ty)

48− -> SortExpression outer commons grp schemas params from

49− AscNullsLast

50− :: Expression outer commons grp schemas params from ('Null ty)

51− -> SortExpression outer commons grp schemas params from

52− DescNullsFirst

53− :: Expression outer commons grp schemas params from ('Null ty)

54− -> SortExpression outer commons grp schemas params from

55− DescNullsLast

56− :: Expression outer commons grp schemas params from ('Null ty)

57− -> SortExpression outer commons grp schemas params from

58−deriving instance Show (SortExpression outer commons grp schemas params from)

59−instance RenderSQL (SortExpression outer commons grp schemas params from) where

60− renderSQL = \case

61− Asc expression -> renderSQL expression <+> "ASC"

62− Desc expression -> renderSQL expression <+> "DESC"

63− AscNullsFirst expression -> renderSQL expression

64− <+> "ASC NULLS FIRST"

65− DescNullsFirst expression -> renderSQL expression

66− <+> "DESC NULLS FIRST"

67− AscNullsLast expression -> renderSQL expression <+> "ASC NULLS LAST"

68− DescNullsLast expression -> renderSQL expression <+> "DESC NULLS LAST"

69−

70−{- |

71−The `orderBy` clause causes the result rows of a `Squeal.PostgreSQL.Query.TableExpression`

72−to be sorted according to the specified `SortExpression`(s).

73−If two rows are equal according to the leftmost expression,

74−they are compared according to the next expression and so on.

75−If they are equal according to all specified expressions,

76−they are returned in an implementation-dependent order.

77−

78−You can also control the order in which rows are processed by window functions

79−using `orderBy` within `Squeal.PostgreSQL.Query.Over`.

80−-}

81−class OrderBy expr where

82− orderBy

83− :: [SortExpression outer commons grp schemas params from]

84− -> expr outer commons grp schemas params from

85− -> expr outer commons grp schemas params from

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Subquery.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.hsdeleted−64

@@ -1,64 +0,0 @@

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

12− DataKinds

13− , OverloadedStrings

14− , TypeOperators

15−#-}

16−

17−module Squeal.PostgreSQL.Expression.Text

18− ( lower

19− , upper

20− , charLength

21− , like

22− , ilike

23− ) where

24−

25−import Squeal.PostgreSQL.Expression

26−import Squeal.PostgreSQL.Schema

27−

28−-- $setup

29−-- >>> import Squeal.PostgreSQL

30−

31−-- | >>> printSQL $ lower "ARRRGGG"

32−-- lower(E'ARRRGGG')

33−lower :: null 'PGtext --> null 'PGtext

34−lower = unsafeFunction "lower"

35−

36−-- | >>> printSQL $ upper "eeee"

37−-- upper(E'eeee')

38−upper :: null 'PGtext --> null 'PGtext

39−upper = unsafeFunction "upper"

40−

41−-- | >>> printSQL $ charLength "four"

42−-- char_length(E'four')

43−charLength :: null 'PGtext --> null 'PGint4

44−charLength = unsafeFunction "char_length"

45−

46−-- | The `like` expression returns true if the @string@ matches

47−-- the supplied @pattern@. If @pattern@ does not contain percent signs

48−-- or underscores, then the pattern only represents the string itself;

49−-- in that case `like` acts like the equals operator. An underscore (_)

50−-- in pattern stands for (matches) any single character; a percent sign (%)

51−-- matches any sequence of zero or more characters.

52−--

53−-- >>> printSQL $ "abc" `like` "a%"

54−-- (E'abc' LIKE E'a%')

55−like :: Operator (null 'PGtext) (null 'PGtext) ('Null 'PGbool)

56−like = unsafeBinaryOp "LIKE"

57−

58−-- | The key word ILIKE can be used instead of LIKE to make the

59−-- match case-insensitive according to the active locale.

60−--

61−-- >>> printSQL $ "abc" `ilike` "a%"

62−-- (E'abc' ILIKE E'a%')

63−ilike :: Operator (null 'PGtext) (null 'PGtext) ('Null 'PGbool)

64−ilike = unsafeBinaryOp "ILIKE"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/TextSearch.hsdeleted−157

@@ -1,157 +0,0 @@

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

12− DataKinds

13− , OverloadedStrings

14− , TypeOperators

15−#-}

16−

17−module Squeal.PostgreSQL.Expression.TextSearch

18− ( (@@)

19− , (.&)

20− , (.|)

21− , (.!)

22− , (<->)

23− , arrayToTSvector

24− , tsvectorLength

25− , numnode

26− , plainToTSquery

27− , phraseToTSquery

28− , websearchToTSquery

29− , queryTree

30− , toTSquery

31− , toTSvector

32− , setWeight

33− , strip

34− , jsonToTSvector

35− , jsonbToTSvector

36− , tsDelete

37− , tsFilter

38− , tsHeadline

39− ) where

40−

41−import Squeal.PostgreSQL.Expression

42−import Squeal.PostgreSQL.List

43−import Squeal.PostgreSQL.Schema

44−

45−-- | `Squeal.PostgreSQL.Expression.Type.tsvector` matches tsquery ?

46−(@@) :: Operator (null 'PGtsvector) (null 'PGtsquery) ('Null 'PGbool)

47−(@@) = unsafeBinaryOp "@@"

48−

49−-- | AND `Squeal.PostgreSQL.Expression.Type.tsquery`s together

50−(.&) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

51−(.&) = unsafeBinaryOp "&&"

52−

53−-- | OR `Squeal.PostgreSQL.Expression.Type.tsquery`s together

54−(.|) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

55−(.|) = unsafeBinaryOp "||"

56−

57−-- | negate a `Squeal.PostgreSQL.Expression.Type.tsquery`

58−(.!) :: null 'PGtsquery --> null 'PGtsquery

59−(.!) = unsafeLeftOp "!!"

60−

61−-- | `Squeal.PostgreSQL.Expression.Type.tsquery` followed by

62−-- `Squeal.PostgreSQL.Expression.Type.tsquery`

63−(<->) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

64−(<->) = unsafeBinaryOp "<->"

65−

66−-- | convert array of lexemes to `Squeal.PostgreSQL.Expression.Type.tsvector`

67−arrayToTSvector

68− :: null ('PGvararray ('NotNull 'PGtext))

69− --> null 'PGtsvector

70−arrayToTSvector = unsafeFunction "array_to_tsvector"

71−

72−-- | number of lexemes in `Squeal.PostgreSQL.Expression.Type.tsvector`

73−tsvectorLength :: null 'PGtsvector --> null 'PGint4

74−tsvectorLength = unsafeFunction "length"

75−

76−-- | number of lexemes plus operators in `Squeal.PostgreSQL.Expression.Type.tsquery`

77−numnode :: null 'PGtsquery --> null 'PGint4

78−numnode = unsafeFunction "numnode"

79−

80−-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` ignoring punctuation

81−plainToTSquery :: null 'PGtext --> null 'PGtsquery

82−plainToTSquery = unsafeFunction "plainto_tsquery"

83−

84−-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` that searches for a phrase,

85−-- ignoring punctuation

86−phraseToTSquery :: null 'PGtext --> null 'PGtsquery

87−phraseToTSquery = unsafeFunction "phraseto_tsquery"

88−

89−-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` from a web search style query

90−websearchToTSquery :: null 'PGtext --> null 'PGtsquery

91−websearchToTSquery = unsafeFunction "websearch_to_tsquery"

92−

93−-- | get indexable part of a `Squeal.PostgreSQL.Expression.Type.tsquery`

94−queryTree :: null 'PGtsquery --> null 'PGtext

95−queryTree = unsafeFunction "query_tree"

96−

97−-- | normalize words and convert to `Squeal.PostgreSQL.Expression.Type.tsquery`

98−toTSquery :: null 'PGtext --> null 'PGtsquery

99−toTSquery = unsafeFunction "to_tsquery"

100−

101−-- | reduce document text to `Squeal.PostgreSQL.Expression.Type.tsvector`

102−toTSvector

103− :: ty `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

104− => null ty --> null 'PGtsvector

105−toTSvector = unsafeFunction "to_tsvector"

106−

107−-- | assign weight to each element of `Squeal.PostgreSQL.Expression.Type.tsvector`

108−setWeight :: '[null 'PGtsvector, null ('PGchar 1)] ---> null 'PGtsvector

109−setWeight = unsafeFunctionN "set_weight"

110−

111−-- | remove positions and weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

112−strip :: null 'PGtsvector --> null 'PGtsvector

113−strip = unsafeFunction "strip"

114−

115−-- | @jsonToTSvector (document *: filter)@

116−-- reduce each value in the document, specified by filter to a `Squeal.PostgreSQL.Expression.Type.tsvector`,

117−-- and then concatenate those in document order to produce a single `Squeal.PostgreSQL.Expression.Type.tsvector`.

118−-- filter is a `Squeal.PostgreSQL.Expression.Type.json` array, that enumerates what kind of elements

119−-- need to be included into the resulting `Squeal.PostgreSQL.Expression.Type.tsvector`.

120−-- Possible values for filter are "string" (to include all string values),

121−-- "numeric" (to include all numeric values in the string format),

122−-- "boolean" (to include all Boolean values in the string format "true"/"false"),

123−-- "key" (to include all keys) or "all" (to include all above).

124−-- These values can be combined together to include, e.g. all string and numeric values.

125−jsonToTSvector :: '[null 'PGjson, null 'PGjson] ---> null 'PGtsvector

126−jsonToTSvector = unsafeFunctionN "json_to_tsvector"

127−

128−-- | @jsonbToTSvector (document *: filter)@

129−-- reduce each value in the document, specified by filter to a `Squeal.PostgreSQL.Expression.Type.tsvector`,

130−-- and then concatenate those in document order to produce a single `Squeal.PostgreSQL.Expression.Type.tsvector`.

131−-- filter is a `Squeal.PostgreSQL.Expression.Type.jsonb` array, that enumerates what kind of elements

132−-- need to be included into the resulting `Squeal.PostgreSQL.Expression.Type.tsvector`.

133−-- Possible values for filter are "string" (to include all string values),

134−-- "numeric" (to include all numeric values in the string format),

135−-- "boolean" (to include all Boolean values in the string format "true"/"false"),

136−-- "key" (to include all keys) or "all" (to include all above).

137−-- These values can be combined together to include, e.g. all string and numeric values.

138−jsonbToTSvector :: '[null 'PGjsonb, null 'PGjsonb] ---> null 'PGtsvector

139−jsonbToTSvector = unsafeFunctionN "jsonb_to_tsvector"

140−

141−-- | remove given lexeme from `Squeal.PostgreSQL.Expression.Type.tsvector`

142−tsDelete ::

143− '[null 'PGtsvector, null ('PGvararray ('NotNull 'PGtext))]

144− ---> null 'PGtsvector

145−tsDelete = unsafeFunctionN "ts_delete"

146−

147−-- | select only elements with given weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

148−tsFilter ::

149− '[null 'PGtsvector, null ('PGvararray ('NotNull ('PGchar 1)))]

150− ---> null 'PGtsvector

151−tsFilter = unsafeFunctionN "ts_filter"

152−

153−-- | display a `Squeal.PostgreSQL.Expression.Type.tsquery` match

154−tsHeadline

155− :: document `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

156− => '[null document, null 'PGtsquery] ---> null 'PGtext

157−tsHeadline = unsafeFunctionN "ts_headline"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Time.hsdeleted−192

@@ -1,192 +0,0 @@

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

12− DataKinds

13− , DeriveGeneric

14− , FunctionalDependencies

15− , LambdaCase

16− , MultiParamTypeClasses

17− , OverloadedStrings

18− , PolyKinds

19− , RankNTypes

20− , TypeOperators

21−#-}

22−

23−module Squeal.PostgreSQL.Expression.Time

24− ( TimeOp (..)

25− , currentDate

26− , currentTime

27− , currentTimestamp

28− , localTime

29− , localTimestamp

30− , now

31− , makeDate

32− , makeTime

33− , makeTimestamp

34− , makeTimestamptz

35− , interval_

36− , TimeUnit (..)

37− ) where

38−

39−import Data.String

40−

41−import qualified GHC.Generics as GHC

42−import qualified Generics.SOP as SOP

43−

44−import Squeal.PostgreSQL.Expression

45−import Squeal.PostgreSQL.Render

46−import Squeal.PostgreSQL.Schema

47−

48−-- $setup

49−-- >>> import Squeal.PostgreSQL

50−

51−-- | >>> printSQL currentDate

52−-- CURRENT_DATE

53−currentDate :: Expr (null 'PGdate)

54−currentDate = UnsafeExpression "CURRENT_DATE"

55−

56−-- | >>> printSQL currentTime

57−-- CURRENT_TIME

58−currentTime :: Expr (null 'PGtimetz)

59−currentTime = UnsafeExpression "CURRENT_TIME"

60−

61−-- | >>> printSQL currentTimestamp

62−-- CURRENT_TIMESTAMP

63−currentTimestamp :: Expr (null 'PGtimestamptz)

64−currentTimestamp = UnsafeExpression "CURRENT_TIMESTAMP"

65−

66−-- | >>> printSQL localTime

67−-- LOCALTIME

68−localTime :: Expr (null 'PGtime)

69−localTime = UnsafeExpression "LOCALTIME"

70−

71−-- | >>> printSQL localTimestamp

72−-- LOCALTIMESTAMP

73−localTimestamp :: Expr (null 'PGtimestamp)

74−localTimestamp = UnsafeExpression "LOCALTIMESTAMP"

75−

76−-- | Current date and time (equivalent to `currentTimestamp`)

77−--

78−-- >>> printSQL now

79−-- now()

80−now :: Expr (null 'PGtimestamptz)

81−now = UnsafeExpression "now()"

82−

83−{-|

84−Create date from year, month and day fields

85−

86−>>> printSQL (makeDate (1984 :* 7 *: 3))

87−make_date(1984, 7, 3)

88−-}

89−makeDate :: '[ null 'PGint4, null 'PGint4, null 'PGint4 ] ---> null 'PGdate

90−makeDate = unsafeFunctionN "make_date"

91−

92−{-|

93−Create time from hour, minute and seconds fields

94−

95−>>> printSQL (makeTime (8 :* 15 *: 23.5))

96−make_time(8, 15, 23.5)

97−-}

98−makeTime :: '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtime

99−makeTime = unsafeFunctionN "make_time"

100−

101−{-|

102−Create timestamp from year, month, day, hour, minute and seconds fields

103−

104−>>> printSQL (makeTimestamp (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

105−make_timestamp(2013, 7, 15, 8, 15, 23.5)

106−-}

107−makeTimestamp ::

108− '[ null 'PGint4, null 'PGint4, null 'PGint4

109− , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamp

110−makeTimestamp = unsafeFunctionN "make_timestamp"

111−

112−{-|

113−Create timestamp with time zone from

114−year, month, day, hour, minute and seconds fields;

115−the current time zone is used

116−

117−>>> printSQL (makeTimestamptz (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

118−make_timestamptz(2013, 7, 15, 8, 15, 23.5)

119−-}

120−makeTimestamptz ::

121− '[ null 'PGint4, null 'PGint4, null 'PGint4

122− , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamptz

123−makeTimestamptz = unsafeFunctionN "make_timestamptz"

124−

125−{-|

126−Affine space operations on time types.

127−-}

128−class TimeOp time diff | time -> diff where

129− {-|

130− >>> printSQL (makeDate (1984 :* 7 *: 3) !+ 365)

131− (make_date(1984, 7, 3) + 365)

132− -}

133− (!+) :: Operator (null time) (null diff) (null time)

134− (!+) = unsafeBinaryOp "+"

135− {-|

136− >>> printSQL (365 +! makeDate (1984 :* 7 *: 3))

137− (365 + make_date(1984, 7, 3))

138− -}

139− (+!) :: Operator (null diff) (null time) (null time)

140− (+!) = unsafeBinaryOp "+"

141− {-|

142− >>> printSQL (makeDate (1984 :* 7 *: 3) !- 365)

143− (make_date(1984, 7, 3) - 365)

144− -}

145− (!-) :: Operator (null time) (null diff) (null time)

146− (!-) = unsafeBinaryOp "-"

147− {-|

148− >>> printSQL (makeDate (1984 :* 7 *: 3) !-! currentDate)

149− (make_date(1984, 7, 3) - CURRENT_DATE)

150− -}

151− (!-!) :: Operator (null time) (null time) (null diff)

152− (!-!) = unsafeBinaryOp "-"

153−instance TimeOp 'PGtimestamp 'PGinterval

154−instance TimeOp 'PGtimestamptz 'PGinterval

155−instance TimeOp 'PGtime 'PGinterval

156−instance TimeOp 'PGtimetz 'PGinterval

157−instance TimeOp 'PGinterval 'PGinterval

158−instance TimeOp 'PGdate 'PGint4

159−infixl 6 !+

160−infixl 6 +!

161−infixl 6 !-

162−infixl 6 !-!

163−

164−-- | A `TimeUnit` to use in `interval_` construction.

165−data TimeUnit

166− = Years | Months | Weeks | Days

167− | Hours | Minutes | Seconds

168− | Microseconds | Milliseconds

169− | Decades | Centuries | Millennia

170− deriving (Eq, Ord, Show, Read, Enum, GHC.Generic)

171−instance SOP.Generic TimeUnit

172−instance SOP.HasDatatypeInfo TimeUnit

173−instance RenderSQL TimeUnit where

174− renderSQL = \case

175− Years -> "years"

176− Months -> "months"

177− Weeks -> "weeks"

178− Days -> "days"

179− Hours -> "hours"

180− Minutes -> "minutes"

181− Seconds -> "seconds"

182− Microseconds -> "microseconds"

183− Milliseconds -> "milliseconds"

184− Decades -> "decades"

185− Centuries -> "centuries"

186− Millennia -> "millennia"

187−

188−-- | >>> printSQL $ interval_ 7 Days

189−-- (INTERVAL '7.0 days')

190−interval_ :: Double -> TimeUnit -> Expr (null 'PGinterval)

191−interval_ num unit = UnsafeExpression . parenthesized $ "INTERVAL" <+>

192− "'" <> fromString (show num) <+> renderSQL unit <> "'"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Type.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.hsdeleted−284

@@ -1,284 +0,0 @@

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

12− DataKinds

13− , DeriveGeneric

14− , FlexibleContexts

15− , FlexibleInstances

16− , GADTs

17− , GeneralizedNewtypeDeriving

18− , LambdaCase

19− , MultiParamTypeClasses

20− , OverloadedStrings

21− , RankNTypes

22− , KindSignatures

23−#-}

24−

25−module Squeal.PostgreSQL.Expression.Window

26− ( -- * functions

27− partitionBy

28− , rank

29− , rowNumber

30− , denseRank

31− , percentRank

32− , cumeDist

33− , ntile

34− , lag

35− , lead

36− , firstValue

37− , lastValue

38− , nthValue

39− , unsafeWindowFunction1

40− , unsafeWindowFunctionN

41− -- * types

42− , WindowFunction (..)

43− , WindowDefinition (..)

44− , WinFun0

45− , WinFun1

46− , WinFunN

47− ) where

48−

49−import Control.DeepSeq

50−import Data.ByteString

51−

52−import qualified GHC.Generics as GHC

53−import qualified Generics.SOP as SOP

54−

55−import Squeal.PostgreSQL.Alias

56−import Squeal.PostgreSQL.Expression

57−import Squeal.PostgreSQL.Expression.Aggregate

58−import Squeal.PostgreSQL.Expression.Sort

59−import Squeal.PostgreSQL.List

60−import Squeal.PostgreSQL.Render

61−import Squeal.PostgreSQL.Schema

62−

63−instance Aggregate

64− (Expression outer commons grp schemas params from)

65− (NP (Expression outer commons grp schemas params from))

66− (WindowFunction outer commons grp schemas params from) where

67− countStar = UnsafeWindowFunction "count(*)"

68− count = unsafeWindowFunction1 "count"

69− sum_ = unsafeWindowFunction1 "sum"

70− arrayAgg = unsafeWindowFunction1 "array_agg"

71− jsonAgg = unsafeWindowFunction1 "json_agg"

72− jsonbAgg = unsafeWindowFunction1 "jsonb_agg"

73− bitAnd = unsafeWindowFunction1 "bit_and"

74− bitOr = unsafeWindowFunction1 "bit_or"

75− boolAnd = unsafeWindowFunction1 "bool_and"

76− boolOr = unsafeWindowFunction1 "bool_or"

77− every = unsafeWindowFunction1 "every"

78− max_ = unsafeWindowFunction1 "max"

79− min_ = unsafeWindowFunction1 "min"

80− avg = unsafeWindowFunction1 "avg"

81− corr = unsafeWindowFunctionN "corr"

82− covarPop = unsafeWindowFunctionN "covar_pop"

83− covarSamp = unsafeWindowFunctionN "covar_samp"

84− regrAvgX = unsafeWindowFunctionN "regr_avgx"

85− regrAvgY = unsafeWindowFunctionN "regr_avgy"

86− regrCount = unsafeWindowFunctionN "regr_count"

87− regrIntercept = unsafeWindowFunctionN "regr_intercept"

88− regrR2 = unsafeWindowFunctionN "regr_r2"

89− regrSlope = unsafeWindowFunctionN "regr_slope"

90− regrSxx = unsafeWindowFunctionN "regr_sxx"

91− regrSxy = unsafeWindowFunctionN "regr_sxy"

92− regrSyy = unsafeWindowFunctionN "regr_syy"

93− stddev = unsafeWindowFunction1 "stddev"

94− stddevPop = unsafeWindowFunction1 "stddev_pop"

95− stddevSamp = unsafeWindowFunction1 "stddev_samp"

96− variance = unsafeWindowFunction1 "variance"

97− varPop = unsafeWindowFunction1 "var_pop"

98− varSamp = unsafeWindowFunction1 "var_samp"

99−

100−-- | A `WindowDefinition` is a set of table rows that are somehow related

101−-- to the current row

102−data WindowDefinition outer commons grp schemas params from where

103− WindowDefinition

104− :: SOP.SListI bys

105− => NP (Expression outer commons grp schemas params from) bys

106− -- ^ `partitionBy` clause

107− -> [SortExpression outer commons grp schemas params from]

108− -- ^ `Squeal.PostgreSQL.Expression.Sort.orderBy` clause

109− -> WindowDefinition outer commons grp schemas params from

110−

111−instance OrderBy WindowDefinition where

112− orderBy sortsR (WindowDefinition parts sortsL)

113− = WindowDefinition parts (sortsL ++ sortsR)

114−

115−instance RenderSQL (WindowDefinition outer commons schemas from grp params) where

116− renderSQL (WindowDefinition part ord) =

117− renderPartitionByClause part <> renderOrderByClause ord

118− where

119− renderPartitionByClause = \case

120− Nil -> ""

121− parts -> "PARTITION" <+> "BY" <+> renderCommaSeparated renderExpression parts

122− renderOrderByClause = \case

123− [] -> ""

124− srts -> " ORDER" <+> "BY"

125− <+> commaSeparated (renderSQL <$> srts)

126−

127−{- |

128−The `partitionBy` clause within `Squeal.PostgreSQL.Query.Over` divides the rows into groups,

129−or partitions, that share the same values of the `partitionBy` `Expression`(s).

130−For each row, the window function is computed across the rows that fall into

131−the same partition as the current row.

132−-}

133−partitionBy

134− :: SOP.SListI bys

135− => NP (Expression outer commons grp schemas params from) bys -- ^ partitions

136− -> WindowDefinition outer commons grp schemas params from

137−partitionBy bys = WindowDefinition bys []

138−

139−{- |

140−A window function performs a calculation across a set of table rows

141−that are somehow related to the current row. This is comparable to the type

142−of calculation that can be done with an aggregate function.

143−However, window functions do not cause rows to become grouped into a single

144−output row like non-window aggregate calls would.

145−Instead, the rows retain their separate identities.

146−Behind the scenes, the window function is able to access more than

147−just the current row of the query result.

148−-}

149−newtype WindowFunction

150− (outer :: FromType)

151− (commons :: FromType)

152− (grp :: Grouping)

153− (schemas :: SchemasType)

154− (params :: [NullityType])

155− (from :: FromType)

156− (ty :: NullityType)

157− = UnsafeWindowFunction { renderWindowFunction :: ByteString }

158− deriving (GHC.Generic,Show,Eq,Ord,NFData)

159−

160−instance RenderSQL (WindowFunction outer commons grp schemas params from ty) where

161− renderSQL = renderWindowFunction

162−

163−{- |

164−A @RankNType@ for window functions with no arguments.

165−-}

166−type WinFun0 x

167− = forall outer commons grp schemas params from

168− . WindowFunction outer commons grp schemas params from x

169− -- ^ cannot reference aliases

170−

171−{- |

172−A @RankNType@ for window functions with 1 argument.

173−-}

174−type WinFun1 x y

175− = forall outer commons grp schemas params from

176− . Expression outer commons grp schemas params from x

177− -- ^ input

178− -> WindowFunction outer commons grp schemas params from y

179− -- ^ output

180−

181−{- | A @RankNType@ for window functions with a fixed-length

182−list of heterogeneous arguments.

183−Use the `*:` operator to end your argument lists.

184−-}

185−type WinFunN xs y

186− = forall outer commons grp schemas params from

187− . NP (Expression outer commons grp schemas params from) xs

188− -- ^ inputs

189− -> WindowFunction outer commons grp schemas params from y

190− -- ^ output

191−

192−-- | escape hatch for defining window functions

193−unsafeWindowFunction1 :: ByteString -> WinFun1 x y

194−unsafeWindowFunction1 fun x

195− = UnsafeWindowFunction $ fun <> parenthesized (renderSQL x)

196−

197−-- | escape hatch for defining multi-argument window functions

198−unsafeWindowFunctionN :: SOP.SListI xs => ByteString -> WinFunN xs y

199−unsafeWindowFunctionN fun xs = UnsafeWindowFunction $ fun <>

200− parenthesized (renderCommaSeparated renderSQL xs)

201−

202−{- | rank of the current row with gaps; same as `rowNumber` of its first peer

203−

204−>>> printSQL rank

205−rank()

206−-}

207−rank :: WinFun0 ('NotNull 'PGint8)

208−rank = UnsafeWindowFunction "rank()"

209−

210−{- | number of the current row within its partition, counting from 1

211−

212−>>> printSQL rowNumber

213−row_number()

214−-}

215−rowNumber :: WinFun0 ('NotNull 'PGint8)

216−rowNumber = UnsafeWindowFunction "row_number()"

217−

218−{- | rank of the current row without gaps; this function counts peer groups

219−

220−>>> printSQL denseRank

221−dense_rank()

222−-}

223−denseRank :: WinFun0 ('NotNull 'PGint8)

224−denseRank = UnsafeWindowFunction "dense_rank()"

225−

226−{- | relative rank of the current row: (rank - 1) / (total partition rows - 1)

227−

228−>>> printSQL percentRank

229−percent_rank()

230−-}

231−percentRank :: WinFun0 ('NotNull 'PGfloat8)

232−percentRank = UnsafeWindowFunction "percent_rank()"

233−

234−{- | cumulative distribution: (number of partition rows

235−preceding or peer with current row) / total partition rows

236−

237−>>> printSQL cumeDist

238−cume_dist()

239−-}

240−cumeDist :: WinFun0 ('NotNull 'PGfloat8)

241−cumeDist = UnsafeWindowFunction "cume_dist()"

242−

243−{- | integer ranging from 1 to the argument value,

244−dividing the partition as equally as possible

245−

246−>>> printSQL $ ntile 5

247−ntile(5)

248−-}

249−ntile :: WinFun1 ('NotNull 'PGint4) ('NotNull 'PGint4)

250−ntile = unsafeWindowFunction1 "ntile"

251−

252−{- | returns value evaluated at the row that is offset rows before the current

253−row within the partition; if there is no such row, instead return default

254−(which must be of the same type as value). Both offset and default are

255−evaluated with respect to the current row.

256−-}

257−lag :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

258−lag = unsafeWindowFunctionN "lag"

259−

260−{- | returns value evaluated at the row that is offset rows after the current

261−row within the partition; if there is no such row, instead return default

262−(which must be of the same type as value). Both offset and default are

263−evaluated with respect to the current row.

264−-}

265−lead :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

266−lead = unsafeWindowFunctionN "lead"

267−

268−{- | returns value evaluated at the row that is the

269−first row of the window frame

270−-}

271−firstValue :: WinFun1 ty ty

272−firstValue = unsafeWindowFunction1 "first_value"

273−

274−{- | returns value evaluated at the row that is the

275−last row of the window frame

276−-}

277−lastValue :: WinFun1 ty ty

278−lastValue = unsafeWindowFunction1 "last_value"

279−

280−{- | returns value evaluated at the row that is the nth

281−row of the window frame (counting from 1); null if no such row

282−-}

283−nthValue :: WinFunN '[null ty, 'NotNull 'PGint4] ('Null ty)

284−nthValue = unsafeWindowFunctionN "nth_value"

squeal-postgresql/src/Squeal/PostgreSQL/List.hsdeleted−112

@@ -1,112 +0,0 @@

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

14− DataKinds

15− , FlexibleContexts

16− , GADTs

17− , LambdaCase

18− , MultiParamTypeClasses

19− , OverloadedStrings

20− , PolyKinds

21− , QuantifiedConstraints

22− , RankNTypes

23− , ScopedTypeVariables

24− , TypeApplications

25− , TypeFamilies

26− , TypeOperators

27− , UndecidableInstances

28−#-}

29−

30−module Squeal.PostgreSQL.List

31− ( SOP.NP (..)

32− , (*:)

33− , Join

34− , disjoin

35− , Additional (..)

36− , Path (..)

37− , CFunctor (..)

38− , CFoldable (..)

39− , CFree (..)

40− , Elem

41− , In

42− , Length

43− ) where

44−

45−import Control.Category.Free

46−import Data.Function ((&))

47−import Data.Kind

48−import Data.Type.Bool

49−import GHC.TypeLits

50−

51−import Generics.SOP as SOP

52−

53−-- | `Join` is simply promoted `++` and is used in @JOIN@s in

54−-- `Squeal.PostgreSQL.Query.FromClause`s.

55−type family Join xs ys where

56− Join '[] ys = ys

57− Join (x ': xs) ys = x ': Join xs ys

58−

59−-- | `disjoin` is a utility function for splitting an `NP` list into pieces.

60−disjoin

61− :: forall xs ys expr. SListI xs

62− => NP expr (Join xs ys)

63− -> (NP expr xs, NP expr ys)

64−disjoin = case sList @xs of

65− SNil -> \ys -> (Nil, ys)

66− SCons -> \(x :* xsys) ->

67− case disjoin xsys of (xs,ys) -> (x :* xs, ys)

68−

69−-- | The `Additional` class is for appending

70−-- type-level list parameterized constructors such as `NP`,

71−-- `Squeal.PostgreSQL.Query.Selection`, and `Squeal.PostgreSQL.Query.FromClause`.

72−class Additional expr where

73− also :: expr ys -> expr xs -> expr (Join xs ys)

74−instance Additional (NP expr) where

75− also ys = \case

76− Nil -> ys

77− x :* xs -> x :* (xs & also ys)

78−

79−-- | A useful operator for ending an `NP` list of length at least 2 without `Nil`.

80−(*:) :: f x -> f y -> NP f '[x,y]

81−x *: y = x :* y :* Nil

82−infixl 9 *:

83−

84−-- | @Elem@ is a promoted `Data.List.elem`.

85−type family Elem x xs where

86− Elem x '[] = 'False

87− Elem x (x ': _) = 'True

88− Elem x (_ ': x ': _) = 'True

89− Elem x (_ ': _ ': x ': _) = 'True

90− Elem x (_ ': _ ': _ ': x ': _) = 'True

91− Elem x (_ ': _ ': _ ': _ ': x ': _) = 'True

92− Elem x (_ ': _ ': _ ': _ ': _ ': x ': _) = 'True

93− Elem x (_ ': xs) = Elem x xs

94−

95−-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.

96−type family In x xs :: Constraint where

97− In x xs = If (Elem x xs) (() :: Constraint)

98− (TypeError ('ShowType x ':<>: 'Text " is not in " ':<>: 'ShowType xs))

99−

100−{- | Calculate the `Length` of a type level list

101−

102−>>> :kind! Length '[Char,String,Bool,Double]

103−Length '[Char,String,Bool,Double] :: Nat

104−= 4

105−-}

106−type 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

112− Length '[] = 0

squeal-postgresql/src/Squeal/PostgreSQL/Manipulation.hs+188−180

@@ -18,7 +18,6 @@ Squeal data manipulation language.

1818 , MultiParamTypeClasses

1919 , OverloadedStrings

2020 , PatternSynonyms

21− , QuantifiedConstraints

2221 , RankNTypes

2322 , ScopedTypeVariables

2423 , TypeApplications

@@ -30,9 +29,19 @@ Squeal data manipulation language.

3029

3130module Squeal.PostgreSQL.Manipulation

3231 ( -- * Manipulation

33− Manipulation_

34− , Manipulation (..)

32+ Manipulation (..)

33+ , Manipulation_

3534 , queryStatement

35+ , QueryClause (..)

36+ , pattern Values_

37+ , DefaultAliasable (..)

38+ , ColumnExpression (..)

39+ , ReturningClause (..)

40+ , pattern Returning_

41+ , ConflictClause (..)

42+ , ConflictTarget (..)

43+ , ConflictAction (..)

44+ , UsingClause (..)

3645 -- * Insert

3746 , insertInto

3847 , insertInto_

@@ -42,95 +51,36 @@ module Squeal.PostgreSQL.Manipulation

4251 -- * Delete

4352 , deleteFrom

4453 , deleteFrom_

45− -- * Clauses

46− , Optional (..)

47− , QueryClause (..)

48− , pattern Values_

49− , ReturningClause (..)

50− , pattern Returning_

51− , ConflictClause (..)

52− , ConflictTarget (..)

53− , ConflictAction (..)

54− , UsingClause (..)

54+ , also

5555 ) where

5656

5757import Control.DeepSeq

5858import Data.ByteString hiding (foldr)

5959import Data.Kind (Type)

60+import GHC.TypeLits (KnownSymbol)

6061

6162import qualified Generics.SOP as SOP

6263import qualified GHC.Generics as GHC

6364

64−import Squeal.PostgreSQL.Alias

6565import Squeal.PostgreSQL.Expression

66−import Squeal.PostgreSQL.Expression.Logic

67−import Squeal.PostgreSQL.List

68−import Squeal.PostgreSQL.PG

6966import Squeal.PostgreSQL.Render

7067import Squeal.PostgreSQL.Query

7168import Squeal.PostgreSQL.Schema

7269

73−-- $setup

74−-- >>> import Squeal.PostgreSQL

75−-- >>> import Data.Int

76−-- >>> import Data.Time

77−

7870{- |

7971A `Manipulation` is a statement which may modify data in the database,

8072but does not alter its schemas. Examples are inserts, updates and deletes.

8173A `Query` is also considered a `Manipulation` even though it does not modify data.

8274

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−

12575simple insert:

12676

12777>>> type Columns = '["col1" ::: 'NoDef :=> 'Null 'PGint4, "col2" ::: 'Def :=> 'NotNull 'PGint4]

12878>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

12979>>> :{

13080let

131− manipulation :: Manipulation_ (Public Schema) () ()

81+ manipulation :: Manipulation '[] (Public Schema) '[] '[]

13282 manipulation =

133− insertInto_ #tab (Values_ (Set 2 `as` #col1 :* Default `as` #col2))

83+ insertInto_ #tab (Values_ (2 `as` #col1 :* defaultAs #col2))

13484in printSQL manipulation

13585:}

13686INSERT INTO "tab" ("col1", "col2") VALUES (2, DEFAULT)

@@ -141,9 +91,9 @@ parameterized insert:

14191>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

14292>>> :{

14393let

144− manipulation :: Manipulation_ (Public Schema) (Int32, Int32) ()

94+ manipulation :: Manipulation '[] (Public Schema) '[ 'NotNull 'PGint4, 'NotNull 'PGint4 ] '[]

14595 manipulation =

146− insertInto_ #tab (Values_ (Set (param @1) `as` #col1 :* Set (param @2) `as` #col2))

96+ insertInto_ #tab (Values_ (param @1 `as` #col1 :* param @2 `as` #col2))

14797in printSQL manipulation

14898:}

14999INSERT INTO "tab" ("col1", "col2") VALUES (($1 :: int4), ($2 :: int4))

@@ -152,9 +102,9 @@ returning insert:

152102

153103>>> :{

154104let

155− manipulation :: Manipulation_ (Public Schema) () (Only Int32)

105+ manipulation :: Manipulation '[] (Public Schema) '[] '["fromOnly" ::: 'NotNull 'PGint4]

156106 manipulation =

157− insertInto #tab (Values_ (Set 2 `as` #col1 :* Set 3 `as` #col2))

107+ insertInto #tab (Values_ (2 `as` #col1 :* 3 `as` #col2))

158108 OnConflictDoRaise (Returning (#col1 `as` #fromOnly))

159109in printSQL manipulation

160110:}

@@ -167,12 +117,12 @@ upsert:

167117>>> type CustomersSchema = '["customers" ::: 'Table (CustomersConstraints :=> CustomersColumns)]

168118>>> :{

169119let

170− manipulation :: Manipulation_ (Public CustomersSchema) () ()

120+ manipulation :: Manipulation '[] (Public CustomersSchema) '[] '[]

171121 manipulation =

172122 insertInto #customers

173− (Values_ (Set "John Smith" `as` #name :* Set "john@smith.com" `as` #email))

123+ (Values_ ("John Smith" `as` #name :* "john@smith.com" `as` #email))

174124 (OnConflict (OnConstraint #uq)

175− (DoUpdate (Set (#excluded ! #email <> "; " <> #customers ! #email) `as` #email) []))

125+ (DoUpdate (((#excluded ! #email) <> "; " <> (#customers ! #email)) `as` #email) []))

176126 (Returning_ Nil)

177127in printSQL manipulation

178128:}

@@ -182,7 +132,7 @@ query insert:

182132

183133>>> :{

184134let

185− manipulation :: Manipulation_ (Public Schema) () ()

135+ manipulation :: Manipulation '[] (Public Schema) '[] '[]

186136 manipulation = insertInto_ #tab (Subquery (select Star (from (table #tab))))

187137in printSQL manipulation

188138:}

@@ -192,8 +142,8 @@ update:

192142

193143>>> :{

194144let

195− manipulation :: Manipulation_ (Public Schema) () ()

196− manipulation = update_ #tab (Set 2 `as` #col1) (#col1 ./= #col2)

145+ manipulation :: Manipulation '[] (Public Schema) '[] '[]

146+ manipulation = update_ #tab (2 `as` #col1) (#col1 ./= #col2)

197147in printSQL manipulation

198148:}

199149UPDATE "tab" SET "col1" = 2 WHERE ("col1" <> "col2")

@@ -202,7 +152,9 @@ delete:

202152

203153>>> :{

204154let

205− manipulation :: Manipulation_ (Public Schema) () (Row Int32 Int32)

155+ manipulation :: Manipulation '[] (Public Schema) '[]

156+ '[ "col1" ::: 'NotNull 'PGint4

157+ , "col2" ::: 'NotNull 'PGint4 ]

206158 manipulation = deleteFrom #tab NoUsing (#col1 .== #col2) (Returning Star)

207159in printSQL manipulation

208160:}

@@ -213,18 +165,17 @@ delete and using clause:

213165>>> :{

214166type Schema3 =

215167 '[ "tab" ::: 'Table ('[] :=> Columns)

216− , "other_tab" ::: 'Table ('[] :=> Columns)

217− , "third_tab" ::: 'Table ('[] :=> Columns) ]

168+ , "other_tab" ::: 'Table ('[] :=> Columns)

169+ , "third_tab" ::: 'Table ('[] :=> Columns) ]

218170:}

219171

220172>>> :{

221173let

222− manipulation :: Manipulation_ (Public Schema3) () ()

174+ manipulation :: Manipulation '[] (Public Schema3) '[] '[]

223175 manipulation =

224− deleteFrom #tab (Using (table #other_tab & also (table #third_tab)))

176+ deleteFrom_ #tab (Using (table #other_tab & also (table #third_tab)))

225177 ( (#tab ! #col2 .== #other_tab ! #col2)

226178 .&& (#tab ! #col2 .== #third_tab ! #col2) )

227− (Returning_ Nil)

228179in printSQL manipulation

229180:}

230181DELETE FROM "tab" USING "other_tab" AS "other_tab", "third_tab" AS "third_tab" WHERE (("tab"."col2" = "other_tab"."col2") AND ("tab"."col2" = "third_tab"."col2"))

@@ -235,7 +186,7 @@ with manipulation:

235186>>> type ProductsSchema = '["products" ::: 'Table ('[] :=> ProductsColumns), "products_deleted" ::: 'Table ('[] :=> ProductsColumns)]

236187>>> :{

237188let

238− manipulation :: Manipulation_ (Public ProductsSchema) (Only Day) ()

189+ manipulation :: Manipulation '[] (Public ProductsSchema) '[ 'NotNull 'PGdate] '[]

239190 manipulation = with

240191 (deleteFrom #products NoUsing (#date .< param @1) (Returning Star) `as` #del)

241192 (insertInto_ #products_deleted (Subquery (select Star (from (common #del)))))

@@ -243,13 +194,28 @@ in printSQL manipulation

243194:}

244195WITH "del" AS (DELETE FROM "products" WHERE ("date" < ($1 :: date)) RETURNING *) INSERT INTO "products_deleted" SELECT * FROM "del" AS "del"

245196-}

197+

198+newtype Manipulation

199+ (commons :: FromType)

200+ (schemas :: SchemasType)

201+ (params :: [NullityType])

202+ (columns :: RowType)

203+ = UnsafeManipulation { renderManipulation :: ByteString }

204+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

205+instance RenderSQL (Manipulation commons schemas params columns) where

206+ renderSQL = renderManipulation

207+instance With Manipulation where

208+ with Done manip = manip

209+ with (cte :>> ctes) manip = UnsafeManipulation $

210+ "WITH" <+> renderCommonTableExpressions renderSQL cte ctes

211+ <+> renderSQL manip

212+

246213type family Manipulation_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

247214 Manipulation_ schemas params row = Manipulation '[] schemas (TuplePG params) (RowPG row)

248215

249216-- | Convert a `Query` into a `Manipulation`.

250217queryStatement

251− :: Query '[] commons schemas params columns

252− -- ^ `Query` to embed as a `Manipulation`

218+ :: Query commons schemas params columns

253219 -> Manipulation commons schemas params columns

254220queryStatement q = UnsafeManipulation $ renderSQL q

255221

@@ -272,13 +238,9 @@ insertInto

272238 , SOP.SListI columns

273239 , SOP.SListI row1 )

274240 => QualifiedAlias sch tab

275− -- ^ table

276241 -> QueryClause commons schemas params columns

277− -- ^ what to insert

278242 -> ConflictClause tab commons schemas params table

279− -- ^ what to do in case of conflict

280243 -> ReturningClause commons schemas params '[tab ::: row0] row1

281− -- ^ what to return

282244 -> Manipulation commons schemas params row1

283245insertInto tab qry conflict ret = UnsafeManipulation $

284246 "INSERT" <+> "INTO" <+> renderSQL tab

@@ -286,7 +248,6 @@ insertInto tab qry conflict ret = UnsafeManipulation $

286248 <> renderSQL conflict

287249 <> renderSQL ret

288250

289−-- | Like `insertInto` but with `OnConflictDoRaise` and `no` `ReturningClause`.

290251insertInto_

291252 :: ( Has sch schemas schema

292253 , Has tab schema ('Table table)

@@ -294,33 +255,25 @@ insertInto_

294255 , row ~ TableToRow table

295256 , SOP.SListI columns )

296257 => QualifiedAlias sch tab

297− -- ^ table

298258 -> QueryClause commons schemas params columns

299− -- ^ what to insert

300259 -> Manipulation commons schemas params '[]

301260insertInto_ tab qry =

302261 insertInto tab qry OnConflictDoRaise (Returning_ Nil)

303262

304−-- | A `QueryClause` describes what to `insertInto` a table.

305263data QueryClause commons schemas params columns where

306264 Values

307265 :: SOP.SListI columns

308− => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

309− -- ^ row of values

310− -> [NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns]

311− -- ^ additional rows of values

266+ => NP (ColumnExpression 'Ungrouped schemas params '[]) columns

267+ -> [NP (ColumnExpression 'Ungrouped schemas params '[]) columns]

312268 -> QueryClause commons schemas params columns

313269 Select

314270 :: SOP.SListI columns

315− => NP (Aliased (Optional (Expression '[] commons grp schemas params from))) columns

316− -- ^ row of values

317− -> TableExpression '[] commons grp schemas params from

318− -- ^ from a table expression

271+ => NP (ColumnExpression grp schemas params from) columns

272+ -> TableExpression grp commons schemas params from

319273 -> QueryClause commons schemas params columns

320274 Subquery

321275 :: ColumnsToRow columns ~ row

322− => Query '[] commons schemas params row

323− -- ^ subquery to insert

276+ => Query commons schemas params row

324277 -> QueryClause commons schemas params columns

325278

326279instance RenderSQL (QueryClause commons schemas params columns) where

@@ -339,41 +292,109 @@ instance RenderSQL (QueryClause commons schemas params columns) where

339292 Subquery qry -> renderQuery qry

340293 where

341294 renderSQLPartMaybe, renderValuePartMaybe

342− :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

343− -> Maybe ByteString

295+ :: ColumnExpression grp schemas params from column -> Maybe ByteString

344296 renderSQLPartMaybe = \case

345− Default `As` _ -> Nothing

346− Set _ `As` name -> Just $ renderSQL name

297+ DefaultAs _ -> Nothing

298+ Specific (_ `As` name) -> Just $ renderSQL name

347299 renderValuePartMaybe = \case

348− Default `As` _ -> Nothing

349− Set value `As` _ -> Just $ renderExpression value

300+ DefaultAs _ -> Nothing

301+ Specific (value `As` _) -> Just $ renderExpression value

350302 renderSQLPart, renderValuePart

351− :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

352− -> ByteString

353− renderSQLPart (_ `As` name) = renderSQL name

354− renderValuePart (value `As` _) = renderSQL value

303+ :: ColumnExpression grp schemas params from column -> ByteString

304+ renderSQLPart = \case

305+ DefaultAs name -> renderSQL name

306+ Specific (_ `As` name) -> renderSQL name

307+ renderValuePart = \case

308+ DefaultAs _ -> "DEFAULT"

309+ Specific (value `As` _) -> renderExpression value

355310

356−-- | `Values_` describes a single `NP` list of `Aliased` `Optional` `Expression`s

357−-- whose `ColumnsType` must match the tables'.

358311pattern Values_

359312 :: SOP.SListI columns

360− => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

361− -- ^ row of values

313+ => NP (ColumnExpression 'Ungrouped schemas params '[]) columns

362314 -> QueryClause commons schemas params columns

363315pattern Values_ vals = Values vals []

364316

365−-- | `Optional` is either `Default` or a value, parameterized by an appropriate

366−-- `ColumnConstraint`.

367−data Optional expr ty where

368− -- | Use the `Default` value for a column.

369− Default :: Optional expr ('Def :=> ty)

370− -- | `Set` a value for a column.

371− Set :: expr ty -> Optional expr (def :=> ty)

372−

373−instance (forall x. RenderSQL (expr x)) => RenderSQL (Optional expr ty) where

317+data ColumnExpression grp schemas params from column where

318+ DefaultAs

319+ :: KnownSymbol col

320+ => Alias col

321+ -> ColumnExpression grp schemas params from (col ::: 'Def :=> ty)

322+ Specific

323+ :: Aliased (Expression grp '[] schemas params from) (col ::: ty)

324+ -> ColumnExpression grp schemas params from (col ::: defness :=> ty)

325+

326+instance (KnownSymbol col, column ~ (col ::: defness :=> ty))

327+ => Aliasable col

328+ (Expression grp '[] schemas params from ty)

329+ (ColumnExpression grp schemas params from column) where

330+ expression `as` col = Specific (expression `As` col)

331+instance (KnownSymbol col, columns ~ '[col ::: defness :=> ty])

332+ => Aliasable col

333+ (Expression grp '[] schemas params from ty)

334+ (NP (ColumnExpression grp schemas params from) columns) where

335+ expression `as` col = expression `as` col :* Nil

336+instance (KnownSymbol col, column ~ (col ::: 'Def :=> ty))

337+ => DefaultAliasable col (ColumnExpression grp schemas params from column) where

338+ defaultAs = DefaultAs

339+instance (KnownSymbol col, columns ~ '[col ::: 'Def :=> ty])

340+ => DefaultAliasable col (NP (ColumnExpression grp schemas params from) columns) where

341+ defaultAs col = defaultAs col :* Nil

342+

343+instance (HasUnique tab from row, Has col row ty, column ~ (col ::: defness :=> ty))

344+ => IsLabel col (ColumnExpression 'Ungrouped schemas params from column) where

345+ fromLabel = fromLabel @col `as` Alias

346+instance (HasUnique tab from row, Has col row ty, columns ~ '[col ::: defness :=> ty])

347+ => IsLabel col

348+ (NP (ColumnExpression 'Ungrouped schemas params from) columns) where

349+ fromLabel = fromLabel @col `as` Alias

350+

351+instance (Has tab from row, Has col row ty, column ~ (col ::: defness :=> ty))

352+ => IsQualified tab col (ColumnExpression 'Ungrouped schemas params from column) where

353+ tab ! col = tab ! col `as` col

354+instance (Has tab from row, Has col row ty, columns ~ '[col ::: defness :=> ty])

355+ => IsQualified tab col (NP (ColumnExpression 'Ungrouped schemas params from) columns) where

356+ tab ! col = tab ! col `as` col

357+

358+instance

359+ ( HasUnique tab from row

360+ , Has col row ty

361+ , GroupedBy tab col bys

362+ , column ~ (col ::: defness :=> ty)

363+ ) => IsLabel col

364+ (ColumnExpression ('Grouped bys) schemas params from column) where

365+ fromLabel = fromLabel @col `as` Alias

366+instance

367+ ( HasUnique tab from row

368+ , Has col row ty

369+ , GroupedBy tab col bys

370+ , columns ~ '[col ::: defness :=> ty]

371+ ) => IsLabel col

372+ (NP (ColumnExpression ('Grouped bys) schemas params from) columns) where

373+ fromLabel = fromLabel @col `as` Alias

374+

375+instance

376+ ( Has tab from row

377+ , Has col row ty

378+ , GroupedBy tab col bys

379+ , column ~ (col ::: defness :=> ty)

380+ ) => IsQualified tab col

381+ (ColumnExpression ('Grouped bys) schemas params from column) where

382+ tab ! col = tab ! col `as` col

383+instance

384+ ( Has tab from row

385+ , Has col row ty

386+ , GroupedBy tab col bys

387+ , columns ~ '[col ::: defness :=> ty]

388+ ) => IsQualified tab col

389+ (NP (ColumnExpression ('Grouped bys) schemas params from) columns) where

390+ tab ! col = tab ! col :* Nil

391+

392+instance RenderSQL (ColumnExpression grp schemas params from column) where

374393 renderSQL = \case

375− Default -> "DEFAULT"

376− Set expr -> renderSQL expr

394+ DefaultAs col ->

395+ renderSQL col <+> "=" <+> "DEFAULT"

396+ Specific (expression `As` col) ->

397+ renderSQL col <+> "=" <+> renderSQL expression

377398

378399-- | A `ReturningClause` computes and return value(s) based

379400-- on each row actually inserted, updated or deleted. This is primarily

@@ -381,38 +402,34 @@ instance (forall x. RenderSQL (expr x)) => RenderSQL (Optional expr ty) where

381402-- serial sequence number. However, any expression using the table's columns

382403-- is allowed. Only rows that were successfully inserted or updated or

383404-- deleted will be returned. For example, if a row was locked

384−-- but not updated because an `OnConflict` `DoUpdate` condition was not satisfied,

385−-- 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

405+-- but not updated because an `OnConflictDoUpdate` condition was not satisfied,

406+-- the row will not be returned. `ReturningStar` will return all columns

407+-- in the row. Use @Returning Nil@ in the common case where no return

387408-- values are desired.

388409newtype ReturningClause commons schemas params from row =

389− Returning (Selection '[] commons 'Ungrouped schemas params from row)

410+ Returning (Selection 'Ungrouped commons schemas params from row)

390411

391412instance RenderSQL (ReturningClause commons schemas params from row) where

392413 renderSQL = \case

393414 Returning (List Nil) -> ""

394415 Returning selection -> " RETURNING" <+> renderSQL selection

395416

396−-- | `Returning` a `List`

397417pattern Returning_

398418 :: SOP.SListI row

399− => NP (Aliased (Expression '[] commons 'Ungrouped schemas params from)) row

400− -- ^ row of values

419+ => NP (Aliased (Expression 'Ungrouped commons schemas params from)) row

401420 -> ReturningClause commons schemas params from row

402421pattern Returning_ list = Returning (List list)

403422

404423-- | A `ConflictClause` specifies an action to perform upon a constraint

405424-- violation. `OnConflictDoRaise` will raise an error.

406−-- `OnConflict` `DoNothing` simply avoids inserting a row.

407−-- `OnConflict` `DoUpdate` updates the existing row that conflicts with the row

425+-- `OnConflictDoNothing` simply avoids inserting a row.

426+-- `OnConflictDoUpdate` updates the existing row that conflicts with the row

408427-- proposed for insertion.

409428data ConflictClause tab commons schemas params table where

410429 OnConflictDoRaise :: ConflictClause tab commons schemas params table

411430 OnConflict

412431 :: ConflictTarget constraints

413− -- ^ conflict target

414432 -> ConflictAction tab commons schemas params columns

415− -- ^ conflict action

416433 -> ConflictClause tab commons schemas params (constraints :=> columns)

417434

418435-- | Render a `ConflictClause`.

@@ -423,17 +440,6 @@ instance SOP.SListI (TableToColumns table)

423440 OnConflict target action -> " ON CONFLICT"

424441 <+> renderSQL target <+> renderSQL action

425442

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−-}

437443data ConflictAction tab commons schemas params columns where

438444 DoNothing :: ConflictAction tab commons schemas params columns

439445 DoUpdate

@@ -442,9 +448,8 @@ data ConflictAction tab commons schemas params columns where

442448 , columns ~ (col0 ': cols)

443449 , SOP.All (HasIn columns) subcolumns

444450 , AllUnique subcolumns )

445− => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]))) subcolumns

446− -> [Condition '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]]

447− -- ^ WHERE `Condition`s

451+ => NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]) subcolumns

452+ -> [Condition 'Ungrouped commons schemas params '[tab ::: row, "excluded" ::: row]]

448453 -> ConflictAction tab commons schemas params columns

449454

450455instance RenderSQL (ConflictAction tab commons schemas params columns) where

@@ -452,17 +457,11 @@ instance RenderSQL (ConflictAction tab commons schemas params columns) where

452457 DoNothing -> "DO NOTHING"

453458 DoUpdate updates whs'

454459 -> "DO UPDATE SET"

455− <+> renderCommaSeparated renderUpdate updates

460+ <+> renderCommaSeparated renderSQL updates

456461 <> case whs' of

457462 [] -> ""

458463 wh:whs -> " WHERE" <+> renderSQL (foldr (.&&) wh whs)

459464

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−

466465-- | A `ConflictTarget` specifies the constraint violation that triggers a

467466-- `ConflictAction`.

468467data ConflictTarget constraints where

@@ -485,6 +484,7 @@ UPDATE statements

485484update

486485 :: ( SOP.SListI columns

487486 , SOP.SListI row1

487+ , db ~ (commons :=> schemas)

488488 , Has sch schemas schema

489489 , Has tab schema ('Table table)

490490 , row0 ~ TableToRow table

@@ -492,9 +492,9 @@ update

492492 , SOP.All (HasIn columns) subcolumns

493493 , AllUnique subcolumns )

494494 => QualifiedAlias sch tab -- ^ table to update

495− -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row0]))) subcolumns

495+ -> NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row0]) subcolumns

496496 -- ^ modified values to replace old values

497− -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row0]

497+ -> Condition 'Ungrouped commons schemas params '[tab ::: row0]

498498 -- ^ condition under which to perform update on a row

499499 -> ReturningClause commons schemas params '[tab ::: row0] row1 -- ^ results to return

500500 -> Manipulation commons schemas params row1

@@ -502,13 +502,14 @@ update tab columns wh returning = UnsafeManipulation $

502502 "UPDATE"

503503 <+> renderSQL tab

504504 <+> "SET"

505− <+> renderCommaSeparated renderUpdate columns

505+ <+> renderCommaSeparated renderSQL columns

506506 <+> "WHERE" <+> renderSQL wh

507507 <> renderSQL returning

508508

509509-- | Update a row returning `Nil`.

510510update_

511511 :: ( SOP.SListI columns

512+ , db ~ (commons :=> schemas)

512513 , Has sch schemas schema

513514 , Has tab schema ('Table table)

514515 , row ~ TableToRow table

@@ -516,9 +517,9 @@ update_

516517 , SOP.All (HasIn columns) subcolumns

517518 , AllUnique subcolumns )

518519 => QualifiedAlias sch tab -- ^ table to update

519− -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row]))) subcolumns

520+ -> NP (ColumnExpression 'Ungrouped schemas params '[tab ::: row]) subcolumns

520521 -- ^ modified values to replace old values

521− -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]

522+ -> Condition 'Ungrouped commons schemas params '[tab ::: row]

522523 -- ^ condition under which to perform update on a row

523524 -> Manipulation commons schemas params '[]

524525update_ tab columns wh = update tab columns wh (Returning_ Nil)

@@ -527,32 +528,23 @@ update_ tab columns wh = update tab columns wh (Returning_ Nil)

527528DELETE statements

528529-----------------------------------------}

529530

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.

539531data UsingClause commons schemas params from where

540532 NoUsing :: UsingClause commons schemas params '[]

541533 Using

542− :: FromClause '[] commons schemas params from

543− -- ^ what to use

534+ :: FromClause commons schemas params from

544535 -> UsingClause commons schemas params from

545536

546537-- | Delete rows from a table.

547538deleteFrom

548539 :: ( SOP.SListI row1

540+ , db ~ (commons :=> schemas)

549541 , Has sch schemas schema

550542 , Has tab schema ('Table table)

551543 , row0 ~ TableToRow table

552544 , columns ~ TableToColumns table )

553545 => QualifiedAlias sch tab -- ^ table to delete from

554546 -> UsingClause commons schemas params from

555− -> Condition '[] commons 'Ungrouped schemas params (tab ::: row0 ': from)

547+ -> Condition 'Ungrouped commons schemas params (tab ::: row0 ': from)

556548 -- ^ condition under which to delete a row

557549 -> ReturningClause commons schemas params '[tab ::: row0] row1 -- ^ results to return

558550 -> Manipulation commons schemas params row1

@@ -567,12 +559,28 @@ deleteFrom tab using wh returning = UnsafeManipulation $

567559

568560-- | Delete rows returning `Nil`.

569561deleteFrom_

570− :: ( Has sch schemas schema

562+ :: ( db ~ (commons :=> schemas)

563+ , Has sch schemas schema

571564 , Has tab schema ('Table table)

572565 , row ~ TableToRow table

573566 , columns ~ TableToColumns table )

574567 => QualifiedAlias sch tab -- ^ table to delete from

575− -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]

568+ -> UsingClause commons schemas params from

569+ -> Condition 'Ungrouped commons schemas params (tab ::: row ': from)

576570 -- ^ condition under which to delete a row

577571 -> Manipulation commons schemas params '[]

578−deleteFrom_ tab wh = deleteFrom tab NoUsing wh (Returning_ Nil)

572+deleteFrom_ tab uses wh = deleteFrom tab uses wh (Returning_ Nil)

573+

574+-- | This has the behaviour of a cartesian product, taking all

575+-- possible combinations between @left@ and @right@ - exactly like a

576+-- CROSS JOIN. Used when no "CROSS JOIN" syntax is required but simply

577+-- a comma separated list of tables. Typical case is the `USING` clause

578+-- of a DELETE query.

579+also

580+ :: FromClause commons schemas params right

581+ -- ^ right

582+ -> FromClause commons schemas params left

583+ -- ^ left

584+ -> FromClause commons schemas params (Join left right)

585+also right left = UnsafeFromClause $

586+ renderSQL left <> "," <+> renderSQL right

squeal-postgresql/src/Squeal/PostgreSQL/Migration.hs+186−337

@@ -8,13 +8,8 @@ Stability: experimental

88This module defines a `Migration` type to safely

99change the schema of your database over time. Let's see an example!

1010

11−First turn on some extensions.

12−

1311>>> :set -XDataKinds -XOverloadedLabels

1412>>> :set -XOverloadedStrings -XFlexibleContexts -XTypeOperators

15−

16−Next, let's define our `TableType`s.

17−

1813>>> :{

1914type UsersTable =

2015 '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>

@@ -25,7 +20,7 @@ type UsersTable =

2520

2621>>> :{

2722type EmailsTable =

28− '[ "pk_emails" ::: 'PrimaryKey '["id"]

23+ '[ "pk_emails" ::: 'PrimaryKey '["id"]

2924 , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]

3025 ] :=>

3126 '[ "id" ::: 'Def :=> 'NotNull 'PGint4

@@ -34,293 +29,227 @@ type EmailsTable =

3429 ]

3530:}

3631

37−Now we can define some `Migration`s to make our tables.

38−

3932>>> :{

4033let

41− makeUsers :: Migration Definition (Public '[]) '["public" ::: '["users" ::: 'Table UsersTable]]

34+ makeUsers :: Migration IO (Public '[]) '["public" ::: '["users" ::: 'Table UsersTable]]

4235 makeUsers = Migration

4336 { name = "make users table"

44− , up = createTable #users

37+ , up = void . define $

38+ createTable #users

4539 ( serial `as` #id :*

46− notNullable text `as` #name )

40+ (text & notNullable) `as` #name )

4741 ( primaryKey #id `as` #pk_users )

48− , down = dropTable #users

42+ , down = void . define $ dropTable #users

4943 }

5044:}

5145

5246>>> :{

5347let

54− makeEmails :: Migration Definition '["public" ::: '["users" ::: 'Table UsersTable]]

48+ makeEmails :: Migration IO '["public" ::: '["users" ::: 'Table UsersTable]]

5549 '["public" ::: '["users" ::: 'Table UsersTable, "emails" ::: 'Table EmailsTable]]

5650 makeEmails = Migration

5751 { name = "make emails table"

58− , up = createTable #emails

52+ , up = void . define $

53+ createTable #emails

5954 ( serial `as` #id :*

60− notNullable int `as` #user_id :*

61− nullable text `as` #email )

55+ (int & notNullable) `as` #user_id :*

56+ (text & nullable) `as` #email )

6257 ( primaryKey #id `as` #pk_emails :*

6358 foreignKey #user_id #users #id

6459 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

65− , down = dropTable #emails

60+ , down = void . define $ dropTable #emails

6661 }

6762:}

6863

69−Now that we have a couple migrations we can chain them together into a `Path`.

64+Now that we have a couple migrations we can chain them together.

7065

7166>>> let migrations = makeUsers :>> makeEmails :>> Done

7267

73−Now run the migrations.

68+>>> :{

69+let

70+ numMigrations

71+ :: Has "migrations" schemas MigrationsSchema

72+ => PQ schemas schemas IO ()

73+ numMigrations = do

74+ result <- runQuery (select Star (from (table (#migrations ! #schema_migrations `as` #m))))

75+ num <- ntuples result

76+ liftBase $ print num

77+:}

7478

75−>>> import Control.Monad.IO.Class

7679>>> :{

7780withConnection "host=localhost port=5432 dbname=exampledb" $

7881 manipulate (UnsafeManipulation "SET client_min_messages TO WARNING;")

7982 -- suppress notices

80− & pqThen (liftIO (putStrLn "Migrate"))

8183 & pqThen (migrateUp migrations)

82− & pqThen (liftIO (putStrLn "Rollback"))

84+ & pqThen numMigrations

8385 & pqThen (migrateDown migrations)

86+ & pqThen numMigrations

8487:}

85−Migrate

86−Rollback

87−

88−We can also create a simple executable using `defaultMain`.

89−

90−>>> let main = defaultMain "host=localhost port=5432 dbname=exampledb" migrations

91−

92−>>> withArgs [] main

93−Invalid command: "". Use:

94−migrate to run all available migrations

95−rollback to rollback all available migrations

96−status to display migrations run and migrations left to run

97−

98−>>> withArgs ["status"] main

99−Migrations already run:

100− None

101−Migrations left to run:

102− - make users table

103− - make emails table

104−

105−>>> withArgs ["migrate"] main

106−Migrations already run:

107− - make users table

108− - make emails table

109−Migrations left to run:

110− None

111−

112−>>> withArgs ["rollback"] main

113−Migrations already run:

114− None

115−Migrations left to run:

116− - make users table

117− - make emails table

118−

119−In addition to enabling `Migration`s using pure SQL `Definition`s for

120−the `up` and `down` instructions, you can also perform impure `IO` actions

121−by using a `Migration`s over the `Terminally` `PQ` `IO` category.

88+Row 2

89+Row 0

12290-}

12391

12492{-# LANGUAGE

12593 DataKinds

126− , DeriveGeneric

127− , FlexibleContexts

128− , FlexibleInstances

12994 , GADTs

13095 , LambdaCase

131− , OverloadedLabels

132− , OverloadedStrings

13396 , PolyKinds

134− , QuantifiedConstraints

135− , RankNTypes

97+ , OverloadedLabels

13698 , TypeApplications

99+ , FlexibleContexts

137100 , TypeOperators

138101#-}

139102

140103module Squeal.PostgreSQL.Migration

141104 ( -- * Migration

142105 Migration (..)

143− , Migratory (..)

144− , Terminally (..)

145− , terminally

146− , pureMigration

106+ , migrateUp

107+ , migrateDown

108+ -- * Migration table

147109 , MigrationsTable

148− , defaultMain

110+ , createMigrations

111+ , insertMigration

112+ , deleteMigration

113+ , selectMigration

149114 ) where

150115

151−import Control.Category

152116import Control.Monad

153−import Data.ByteString (ByteString)

154−import Data.Foldable (traverse_)

117+import Control.Monad.Base

118+import Control.Monad.Trans.Control

119+import Generics.SOP (K(..))

155120import Data.Function ((&))

156−import Data.List ((\\))

157121import Data.Text (Text)

158−import Data.Time (UTCTime)

159−import Prelude hiding ((.), id)

160−import System.Environment

161−import UnliftIO (MonadIO (..))

162122

163−import qualified Data.Text.IO as Text (putStrLn)

164−import qualified Generics.SOP as SOP

165−import qualified GHC.Generics as GHC

123+import Squeal.PostgreSQL

166124

167−import Squeal.PostgreSQL.Alias

168−import Squeal.PostgreSQL.Binary

169−import Squeal.PostgreSQL.Definition

170−import Squeal.PostgreSQL.Definition.Table

171−import Squeal.PostgreSQL.Definition.Table.Constraint

172−import Squeal.PostgreSQL.Expression.Comparison

173−import Squeal.PostgreSQL.Expression.Parameter

174−import Squeal.PostgreSQL.Expression.Time

175−import Squeal.PostgreSQL.Expression.Type

176−import Squeal.PostgreSQL.List

177−import Squeal.PostgreSQL.Manipulation

178−import Squeal.PostgreSQL.PQ

179−import Squeal.PostgreSQL.Query

180−import Squeal.PostgreSQL.Schema

181−import Squeal.PostgreSQL.Transaction

182−

183−-- | A `Migration` is a named "isomorphism" over a given category.

184−-- It should contain an inverse pair of `up` and `down`

185−-- instructions and a unique `name`.

186−data Migration p schemas0 schemas1 = Migration

125+-- | A `Migration` should contain an inverse pair of

126+-- `up` and `down` instructions and a unique `name`.

127+data Migration io schemas0 schemas1 = Migration

187128 { name :: Text -- ^ The `name` of a `Migration`.

188129 -- Each `name` in a `Migration` should be unique.

189− , up :: p schemas0 schemas1 -- ^ The `up` instruction of a `Migration`.

190− , down :: p schemas1 schemas0 -- ^ The `down` instruction of a `Migration`.

191− } deriving (GHC.Generic)

192−

193−{- |

194−A `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

196−SQL `Definition`s and the category of impure `Terminally` `PQ` `IO` actions.

197−-}

198−class Category p => Migratory p where

199−

200− {- |

201− Run a `Path` of `Migration`s.

202− Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

203− In one transaction, for each each `Migration` query to see if the `Migration` has been executed;

204− if not, `up` the `Migration` and insert its `name` in the `MigrationsTable`.

205− -}

206− migrateUp

207− :: Path (Migration p) schemas0 schemas1

208− -> PQ schemas0 schemas1 IO ()

209−

210− {- |

211− Rewind a `Path` of `Migration`s.

212− Create the `MigrationsTable` as @public.schema_migrations@ if it does not already exist.

213− In one transaction, for each each `Migration` query to see if the `Migration` has been executed;

214− if so, `down` the `Migration` and delete its `name` in the `MigrationsTable`.

215− -}

216− migrateDown

217− :: Path (Migration p) schemas0 schemas1

218− -> PQ schemas1 schemas0 IO ()

219−

220−instance Migratory Definition where

221− migrateUp = migrateUp . cmap pureMigration

222− migrateDown = migrateDown . cmap pureMigration

223−

224−{- | `Terminally` turns an indexed monad transformer and the monad it transforms

225−into a category by restricting the return type to @()@ and permuting the type variables.

226−This is similar to how applying a monad to @()@ yields a monoid.

227−Since a `Terminally` action has a trivial return value, the only reason

228−to run one is for the side effects, in particular database and other IO effects.

229−-}

230−newtype Terminally trans monad x0 x1 = Terminally

231− { runTerminally :: trans x0 x1 monad () }

232− deriving GHC.Generic

233−

234−instance

235− ( IndexedMonadTransPQ trans

236− , Monad monad

237− , forall x0 x1. x0 ~ x1 => Monad (trans x0 x1 monad) )

238− => Category (Terminally trans monad) where

239− id = Terminally (return ())

240− Terminally g . Terminally f = Terminally $ pqThen g f

241−

242−-- | `terminally` ignores the output of a computation, returning @()@ and

243−-- wrapping it up into a `Terminally`. You can lift an action in the base monad

244−-- by using @terminally . lift@.

245−terminally

246− :: Functor (trans x0 x1 monad)

247− => trans x0 x1 monad ignore

248− -> Terminally trans monad x0 x1

249−terminally = Terminally . void

250−

251−-- | A `pureMigration` turns a `Migration` involving only pure SQL

252−-- `Definition`s into a `Migration` that may be combined with arbitrary `IO`.

253−pureMigration

254− :: Migration Definition schemas0 schemas1

255− -> Migration (Terminally PQ IO) schemas0 schemas1

256−pureMigration migration = Migration

257− { name = name migration

258− , up = terminally . define $ up migration

259− , down = terminally . define $ down migration

130+ , up :: PQ schemas0 schemas1 io () -- ^ The `up` instruction of a `Migration`.

131+ , down :: PQ schemas1 schemas0 io () -- ^ The `down` instruction of a `Migration`.

260132 }

261133

262−instance Migratory (Terminally PQ IO) where

263−

264− migrateUp migration = unsafePQ . transactionally_ $ do

265− define createMigrations

266− upMigrations migration

267−

268− where

269−

270− upMigrations

271− :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

272− -> PQ MigrationsSchemas MigrationsSchemas IO ()

273− upMigrations = \case

274− Done -> return ()

275− step :>> steps -> upMigration step >> upMigrations steps

276−

277− upMigration

278− :: Migration (Terminally PQ IO) schemas0 schemas1

279− -> PQ MigrationsSchemas MigrationsSchemas IO ()

280− upMigration step = do

281− executed <- queryExecuted step

282− unless (executed == 1) $ do

283− unsafePQ . runTerminally $ up step

284− manipulateParams_ insertMigration (Only (name step))

285−

286− queryExecuted

287− :: Migration (Terminally PQ IO) schemas0 schemas1

288− -> PQ MigrationsSchemas MigrationsSchemas IO Row

289− queryExecuted step = do

290− result <- runQueryParams selectMigration (Only (name step))

291− ntuples result

292−

293− migrateDown migrations = unsafePQ . transactionally_ $ do

294− define createMigrations

295− downMigrations migrations

296−

297− where

298−

299− downMigrations

300− :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

301− -> PQ MigrationsSchemas MigrationsSchemas IO ()

302− downMigrations = \case

303− Done -> return ()

304− step :>> steps -> downMigrations steps >> downMigration step

305−

306− downMigration

307− :: Migration (Terminally PQ IO) schemas0 schemas1

308− -> PQ MigrationsSchemas MigrationsSchemas IO ()

309− downMigration step = do

310− executed <- queryExecuted step

311− unless (executed == 0) $ do

312− unsafePQ . runTerminally $ down step

313− manipulateParams_ deleteMigration (Only (name step))

134+-- | Run `Migration`s by creating the `MigrationsTable`

135+-- if it does not exist and then in a transaction, for each each `Migration`

136+-- query to see if the `Migration` is executed. If not, then

137+-- execute the `Migration` and insert its row in the `MigrationsTable`.

138+migrateUp

139+ :: MonadBaseControl IO io

140+ => AlignedList (Migration io) schemas0 schemas1 -- ^ migrations to run

141+ -> PQ

142+ ("migrations" ::: MigrationsSchema ': schemas0)

143+ ("migrations" ::: MigrationsSchema ': schemas1)

144+ io ()

145+migrateUp migration =

146+ define createMigrations

147+ & pqBind okResult

148+ & pqThen (transactionallySchema_ (upMigrations migration))

149+ where

314150

315− queryExecuted

316− :: Migration (Terminally PQ IO) schemas0 schemas1

317− -> PQ MigrationsSchemas MigrationsSchemas IO Row

318− queryExecuted step = do

319− result <- runQueryParams selectMigration (Only (name step))

320− ntuples result

151+ upMigrations

152+ :: MonadBaseControl IO io

153+ => AlignedList (Migration io) schemas0 schemas1

154+ -> PQ

155+ ("migrations" ::: MigrationsSchema ': schemas0)

156+ ("migrations" ::: MigrationsSchema ': schemas1)

157+ io ()

158+ upMigrations = \case

159+ Done -> return ()

160+ step :>> steps -> upMigration step & pqThen (upMigrations steps)

161+

162+ upMigration

163+ :: MonadBase IO io

164+ => Migration io schemas0 schemas1 -> PQ

165+ ("migrations" ::: MigrationsSchema ': schemas0)

166+ ("migrations" ::: MigrationsSchema ': schemas1)

167+ io ()

168+ upMigration step =

169+ queryExecuted step

170+ & pqBind (\ executed ->

171+ if executed == 1 -- up step has already been executed

172+ then PQ (\ _ -> return (K ())) -- unsafely switch schemas

173+ else

174+ pqEmbed (up step) -- safely switch schemas

175+ & pqThen (manipulateParams insertMigration (Only (name step)))

176+ -- insert execution record

177+ & pqBind okResult)

178+

179+ queryExecuted

180+ :: MonadBase IO io

181+ => Migration io schemas0 schemas1 -> PQ

182+ ("migrations" ::: MigrationsSchema ': schemas0)

183+ ("migrations" ::: MigrationsSchema ': schemas0)

184+ io Row

185+ queryExecuted step = do

186+ result <- runQueryParams selectMigration (Only (name step))

187+ okResult result

188+ ntuples result

189+

190+-- | Rewind `Migration`s by creating the `MigrationsTable`

191+-- if it does not exist and then in a transaction, for each each `Migration`

192+-- query to see if the `Migration` is executed. If it is, then

193+-- rewind the `Migration` and delete its row in the `MigrationsTable`.

194+migrateDown

195+ :: MonadBaseControl IO io

196+ => AlignedList (Migration io) schemas0 schemas1 -- ^ migrations to rewind

197+ -> PQ

198+ ("migrations" ::: MigrationsSchema ': schemas1)

199+ ("migrations" ::: MigrationsSchema ': schemas0)

200+ io ()

201+migrateDown migrations =

202+ define createMigrations

203+ & pqBind okResult

204+ & pqThen (transactionallySchema_ (downMigrations migrations))

205+ where

321206

322−unsafePQ :: (Functor m) => PQ db0 db1 m x -> PQ db0' db1' m x

323−unsafePQ (PQ pq) = PQ $ fmap (SOP.K . SOP.unK) . pq . SOP.K . SOP.unK

207+ downMigrations

208+ :: MonadBaseControl IO io

209+ => AlignedList (Migration io) schemas0 schemas1 -> PQ

210+ ("migrations" ::: MigrationsSchema ': schemas1)

211+ ("migrations" ::: MigrationsSchema ': schemas0)

212+ io ()

213+ downMigrations = \case

214+ Done -> return ()

215+ step :>> steps -> downMigrations steps & pqThen (downMigration step)

216+

217+ downMigration

218+ :: MonadBase IO io

219+ => Migration io schemas0 schemas1 -> PQ

220+ ("migrations" ::: MigrationsSchema ': schemas1)

221+ ("migrations" ::: MigrationsSchema ': schemas0)

222+ io ()

223+ downMigration step =

224+ queryExecuted step

225+ & pqBind (\ executed ->

226+ if executed == 0 -- up step has not been executed

227+ then PQ (\ _ -> return (K ())) -- unsafely switch schemas

228+ else

229+ pqEmbed (down step) -- safely switch schemas

230+ & pqThen (manipulateParams deleteMigration (Only (name step)))

231+ -- delete execution record

232+ & pqBind okResult)

233+

234+ queryExecuted

235+ :: MonadBase IO io

236+ => Migration io schemas0 schemas1 -> PQ

237+ ("migrations" ::: MigrationsSchema ': schemas1)

238+ ("migrations" ::: MigrationsSchema ': schemas1)

239+ io Row

240+ queryExecuted step = do

241+ result <- runQueryParams selectMigration (Only (name step))

242+ okResult result

243+ ntuples result

244+

245+okResult :: MonadBase IO io => K Result results -> PQ schema schema io ()

246+okResult result = do

247+ status <- resultStatus result

248+ when (not (status `elem` [CommandOk, TuplesOk])) $ do

249+ errorMessageMaybe <- resultErrorMessage result

250+ case errorMessageMaybe of

251+ Nothing -> error "migrateDown: unknown error"

252+ Just msg -> error ("migrationDown: " <> show msg)

324253

325254-- | The `TableType` for a Squeal migration.

326255type MigrationsTable =

@@ -329,120 +258,40 @@ type MigrationsTable =

329258 , "executed_at" ::: 'Def :=> 'NotNull 'PGtimestamptz

330259 ]

331260

332−data MigrationRow =

333− MigrationRow { migrationName :: Text

334− , migrationTime :: UTCTime }

335− deriving (GHC.Generic, Show)

336−

337−instance SOP.Generic MigrationRow

338−instance SOP.HasDatatypeInfo MigrationRow

339−

340261type MigrationsSchema = '["schema_migrations" ::: 'Table MigrationsTable]

341−type MigrationsSchemas = Public MigrationsSchema

342262

343263-- | Creates a `MigrationsTable` if it does not already exist.

344−createMigrations :: Definition MigrationsSchemas MigrationsSchemas

264+createMigrations

265+ :: Has "migrations" schemas MigrationsSchema

266+ => Definition schemas schemas

345267createMigrations =

346− createTableIfNotExists #schema_migrations

268+ createSchemaIfNotExists #migrations >>>

269+ createTableIfNotExists (#migrations ! #schema_migrations)

347270 ( (text & notNullable) `as` #name :*

348271 (timestampWithTimeZone & notNullable & default_ currentTimestamp)

349272 `as` #executed_at )

350273 ( unique #name `as` #migrations_unique_name )

351274

352−-- | Inserts a `Migration` into the `MigrationsTable`, returning

353−-- the time at which it was inserted.

354−insertMigration :: Manipulation_ MigrationsSchemas (Only Text) ()

355−insertMigration = insertInto_ #schema_migrations

356− (Values_ (Set (param @1) `as` #name :* Default `as` #executed_at))

275+-- | Inserts a `Migration` into the `MigrationsTable`

276+insertMigration

277+ :: Has "migrations" schemas MigrationsSchema

278+ => Manipulation '[] schemas '[ 'NotNull 'PGtext] '[]

279+insertMigration = insertInto_ (#migrations ! #schema_migrations) . Values_ $

280+ (param @1) `as` #name :* defaultAs #executed_at

357281

358−-- | Deletes a `Migration` from the `MigrationsTable`, returning

359−-- the time at which it was inserted.

360−deleteMigration :: Manipulation_ MigrationsSchemas (Only Text) ()

361−deleteMigration = deleteFrom_ #schema_migrations (#name .== param @1)

282+-- | Deletes a `Migration` from the `MigrationsTable`

283+deleteMigration

284+ :: Has "migrations" schemas MigrationsSchema

285+ => Manipulation '[] schemas '[ 'NotNull 'PGtext ] '[]

286+deleteMigration = deleteFrom_ (#migrations ! #schema_migrations) NoUsing (#name .== param @1)

362287

363288-- | Selects a `Migration` from the `MigrationsTable`, returning

364−-- the time at which it was inserted.

289+-- the time at which it was executed.

365290selectMigration

366− :: Query_ MigrationsSchemas (Only Text) (Only UTCTime)

367−selectMigration = select_ (#executed_at `as` #fromOnly)

368− $ from (table (#schema_migrations))

369− & where_ (#name .== param @1)

370−

371−selectMigrations :: Query_ MigrationsSchemas () MigrationRow

372−selectMigrations = select_

373− (#name `as` #migrationName :* #executed_at `as` #migrationTime)

374− (from (table #schema_migrations))

375−

376−data MigrateCommand

377− = MigrateStatus

378− | MigrateUp

379− | MigrateDown deriving (GHC.Generic, Show)

380−

381−{- | `defaultMain` creates a simple executable

382−from a connection string and a list of `Migration`s. -}

383−defaultMain

384− :: Migratory p

385− => ByteString

386− -- ^ connection string

387− -> Path (Migration p) db0 db1

388− -- ^ migrations

389− -> IO ()

390−defaultMain connectTo migrations = do

391− command <- readCommandFromArgs

392− maybe (pure ()) performCommand command

393−

394− where

395−

396− performCommand :: MigrateCommand -> IO ()

397− performCommand = \case

398− MigrateStatus -> withConnection connectTo $

399− suppressNotices >> migrateStatus

400− MigrateUp -> withConnection connectTo $

401− suppressNotices & pqThen (migrateUp migrations) & pqThen migrateStatus

402− MigrateDown -> withConnection connectTo $

403− suppressNotices & pqThen (migrateDown migrations) & pqThen migrateStatus

404−

405− migrateStatus :: PQ schema schema IO ()

406− migrateStatus = unsafePQ $ do

407− runNames <- getRunMigrationNames

408− let names = ctoList name migrations

409− unrunNames = names \\ runNames

410− liftIO $ displayRunned runNames >> displayUnrunned unrunNames

411−

412− suppressNotices :: PQ schema schema IO ()

413− suppressNotices = manipulate_ $

414− UnsafeManipulation "SET client_min_messages TO WARNING;"

415−

416− readCommandFromArgs :: IO (Maybe MigrateCommand)

417− readCommandFromArgs = getArgs >>= \case

418− ["migrate"] -> pure . Just $ MigrateUp

419− ["rollback"] -> pure . Just $ MigrateDown

420− ["status"] -> pure . Just $ MigrateStatus

421− args -> displayUsage args >> pure Nothing

422−

423− displayUsage :: [String] -> IO ()

424− displayUsage args = do

425− putStrLn $ "Invalid command: \"" <> unwords args <> "\". Use:"

426− putStrLn "migrate to run all available migrations"

427− putStrLn "rollback to rollback all available migrations"

428− putStrLn "status to display migrations run and migrations left to run"

429−

430− getRunMigrationNames :: (MonadIO m) => PQ db0 db0 m [Text]

431− getRunMigrationNames =

432− fmap migrationName <$> (unsafePQ (define createMigrations & pqThen (runQuery selectMigrations)) >>= getRows)

433−

434− displayListOfNames :: [Text] -> IO ()

435− displayListOfNames [] = Text.putStrLn " None"

436− displayListOfNames xs =

437− let singleName n = Text.putStrLn $ " - " <> n

438− in traverse_ singleName xs

439−

440− displayUnrunned :: [Text] -> IO ()

441− displayUnrunned unrunned =

442− Text.putStrLn "Migrations left to run:"

443− >> displayListOfNames unrunned

444−

445− displayRunned :: [Text] -> IO ()

446− displayRunned runned =

447− Text.putStrLn "Migrations already run:"

448− >> displayListOfNames runned

291+ :: Has "migrations" schemas MigrationsSchema

292+ => Query '[] schemas '[ 'NotNull 'PGtext ]

293+ '[ "executed_at" ::: 'NotNull 'PGtimestamptz ]

294+selectMigration = select_

295+ (#executed_at `as` #executed_at)

296+ ( from (table ((#migrations ! #schema_migrations) `as` #m))

297+ & where_ (#name .== param @1))

squeal-postgresql/src/Squeal/PostgreSQL/PG.hsdeleted−388

@@ -1,388 +0,0 @@

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

12− AllowAmbiguousTypes

13− , DeriveAnyClass

14− , DeriveFoldable

15− , DeriveFunctor

16− , DeriveGeneric

17− , DeriveTraversable

18− , DerivingStrategies

19− , DefaultSignatures

20− , FlexibleContexts

21− , FlexibleInstances

22− , FunctionalDependencies

23− , GADTs

24− , LambdaCase

25− , MultiParamTypeClasses

26− , OverloadedStrings

27− , ScopedTypeVariables

28− , TypeApplications

29− , TypeFamilies

30− , TypeInType

31− , TypeOperators

32− , UndecidableInstances

33− , UndecidableSuperClasses

34−#-}

35−

36−module Squeal.PostgreSQL.PG

37− ( -- * PG embeddings

38− PG

39− , NullPG

40− , TuplePG

41− , RowPG

42− -- * Storage newtypes

43− , Money (..)

44− , Json (..)

45− , Jsonb (..)

46− , Composite (..)

47− , Enumerated (..)

48− , VarArray (..)

49− , FixArray (..)

50− , LibPQ.Oid (..)

51− -- * Type families

52− , LabelsPG

53− , DimPG

54− , FixPG

55− , TupleOf

56− , TupleCodeOf

57− , RowOf

58− , ConstructorsOf

59− , ConstructorNameOf

60− , ConstructorNamesOf

61− ) where

62−

63−import Data.Aeson (Value)

64−import Data.Kind (Type)

65−import Data.Int (Int16, Int32, Int64)

66−import Data.Scientific (Scientific)

67−import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime)

68−import Data.Vector (Vector)

69−import Data.UUID.Types (UUID)

70−import GHC.TypeLits

71−import Network.IP.Addr (NetAddr, IP)

72−

73−import qualified Data.ByteString.Lazy as Lazy (ByteString)

74−import qualified Data.ByteString as Strict (ByteString)

75−import qualified Data.Text.Lazy as Lazy (Text)

76−import qualified Data.Text as Strict (Text)

77−import qualified Database.PostgreSQL.LibPQ as LibPQ

78−import qualified GHC.Generics as GHC

79−import qualified Generics.SOP as SOP

80−import qualified Generics.SOP.Record as SOP

81−import qualified Generics.SOP.Type.Metadata as Type

82−

83−import Squeal.PostgreSQL.Alias

84−import Squeal.PostgreSQL.Schema

85−

86−-- $setup

87−-- >>> import Squeal.PostgreSQL

88−-- >>> import Data.Text (Text)

89−

90−{- | The `PG` type family embeds a subset of Haskell types

91−as Postgres types. As an open type family, `PG` is extensible.

92−

93−>>> :kind! PG LocalTime

94−PG LocalTime :: PGType

95−= 'PGtimestamp

96−

97−>>> newtype MyDouble = My Double

98−>>> :set -XTypeFamilies

99−>>> type instance PG MyDouble = 'PGfloat8

100−-}

101−type family PG (hask :: Type) :: PGType

102−-- | `PGbool`

103−type instance PG Bool = 'PGbool

104−-- | `PGint2`

105−type instance PG Int16 = 'PGint2

106−-- | `PGint4`

107−type instance PG Int32 = 'PGint4

108−-- | `PGint8`

109−type instance PG Int64 = 'PGint8

110−-- | `PGint2`

111−type instance PG LibPQ.Oid = 'PGoid

112−-- | `PGnumeric`

113−type instance PG Scientific = 'PGnumeric

114−-- | `PGfloat4`

115−type instance PG Float = 'PGfloat4

116−-- | `PGfloat8`

117−type instance PG Double = 'PGfloat8

118−-- | `PGchar` @1@

119−type instance PG Char = 'PGchar 1

120−-- | `PGtext`

121−type instance PG Strict.Text = 'PGtext

122−-- | `PGtext`

123−type instance PG Lazy.Text = 'PGtext

124−-- | `PGtext`

125−type instance PG String = 'PGtext

126−-- | `PGbytea`

127−type instance PG Strict.ByteString = 'PGbytea

128−-- | `PGbytea`

129−type instance PG Lazy.ByteString = 'PGbytea

130−-- | `PGtimestamp`

131−type instance PG LocalTime = 'PGtimestamp

132−-- | `PGtimestamptz`

133−type instance PG UTCTime = 'PGtimestamptz

134−-- | `PGdate`

135−type instance PG Day = 'PGdate

136−-- | `PGtime`

137−type instance PG TimeOfDay = 'PGtime

138−-- | `PGtimetz`

139−type instance PG (TimeOfDay, TimeZone) = 'PGtimetz

140−-- | `PGinterval`

141−type instance PG DiffTime = 'PGinterval

142−-- | `PGuuid`

143−type instance PG UUID = 'PGuuid

144−-- | `PGinet`

145−type instance PG (NetAddr IP) = 'PGinet

146−-- | `PGjson`

147−type instance PG Value = 'PGjson

148−

149−{-| The `LabelsPG` type family calculates the constructors of a

150−Haskell enum type.

151−

152−>>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

153−>>> instance SOP.Generic Schwarma

154−>>> instance SOP.HasDatatypeInfo Schwarma

155−>>> :kind! LabelsPG Schwarma

156−LabelsPG Schwarma :: [Type.ConstructorName]

157−= '["Beef", "Lamb", "Chicken"]

158−-}

159−type family LabelsPG (hask :: Type) :: [Type.ConstructorName] where

160− LabelsPG hask =

161− ConstructorNamesOf (ConstructorsOf (SOP.DatatypeInfoOf hask))

162−

163−{- |

164−`RowPG` turns a Haskell `Type` into a `RowType`.

165−

166−`RowPG` may be applied to normal Haskell record types provided they

167−have `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

168−

169−>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic

170−>>> instance SOP.Generic Person

171−>>> instance SOP.HasDatatypeInfo Person

172−>>> :kind! RowPG Person

173−RowPG Person :: [(Symbol, NullityType)]

174−= '["name" ::: 'NotNull 'PGtext, "age" ::: 'NotNull 'PGint4]

175−-}

176−type family RowPG (hask :: Type) :: RowType where

177− RowPG hask = RowOf (SOP.RecordCodeOf hask)

178−

179−-- | `RowOf` applies `NullPG` to the fields of a list.

180−type 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 '[] = '[]

191−

192−{- | `NullPG` turns a Haskell type into a `NullityType`.

193−

194−>>> :kind! NullPG Double

195−NullPG Double :: NullityType

196−= 'NotNull 'PGfloat8

197−>>> :kind! NullPG (Maybe Double)

198−NullPG (Maybe Double) :: NullityType

199−= 'Null 'PGfloat8

200−-}

201−type family NullPG (hask :: Type) :: NullityType where

202− NullPG (Maybe hask) = 'Null (PG hask)

203− NullPG hask = 'NotNull (PG hask)

204−

205−{- | `TuplePG` turns a Haskell tuple type (including record types) into

206−the corresponding list of `NullityType`s.

207−

208−>>> :kind! TuplePG (Double, Maybe Char)

209−TuplePG (Double, Maybe Char) :: [NullityType]

210−= '[ 'NotNull 'PGfloat8, 'Null ('PGchar 1)]

211−-}

212−type family TuplePG (hask :: Type) :: [NullityType] where

213− TuplePG hask = TupleOf (TupleCodeOf hask (SOP.Code hask))

214−

215−-- | `TupleOf` turns a list of Haskell `Type`s into a list of `NullityType`s.

216−type 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 '[] = '[]

228−

229−-- | `TupleCodeOf` takes the `SOP.Code` of a haskell `Type`

230−-- and if it's a simple product returns it, otherwise giving a `TypeError`.

231−type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where

232− TupleCodeOf hask '[tuple] = tuple

233− TupleCodeOf hask '[] =

234− TypeError

235− ( 'Text "The type `" ':<>: 'ShowType hask ':<>: 'Text "' is not a tuple type."

236− ':$$: 'Text "It is a void type with no constructors."

237− )

238− TupleCodeOf hask (_ ': _ ': _) =

239− TypeError

240− ( 'Text "The type `" ':<>: 'ShowType hask ':<>: 'Text "' is not a tuple type."

241− ':$$: 'Text "It is a sum type with more than one constructor."

242− )

243−

244−-- | Calculates constructors of a datatype.

245−type family ConstructorsOf (datatype :: Type.DatatypeInfo)

246− :: [Type.ConstructorInfo] where

247− ConstructorsOf ('Type.ADT _module _datatype constructors) =

248− constructors

249− ConstructorsOf ('Type.Newtype _module _datatype constructor) =

250− '[constructor]

251−

252−-- | Calculates the name of a nullary constructor, otherwise

253−-- generates a type error.

254−type family ConstructorNameOf (constructor :: Type.ConstructorInfo)

255− :: Type.ConstructorName where

256− ConstructorNameOf ('Type.Constructor name) = name

257− ConstructorNameOf ('Type.Infix name _assoc _fix) = TypeError

258− ('Text "ConstructorNameOf error: non-nullary constructor "

259− ':<>: 'Text name)

260− ConstructorNameOf ('Type.Record name _fields) = TypeError

261− ('Text "ConstructorNameOf error: non-nullary constructor "

262− ':<>: 'Text name)

263−

264−-- | Calculate the names of nullary constructors.

265−type family ConstructorNamesOf (constructors :: [Type.ConstructorInfo])

266− :: [Type.ConstructorName] where

267− ConstructorNamesOf '[] = '[]

268− ConstructorNamesOf (constructor ': constructors) =

269− ConstructorNameOf constructor ': ConstructorNamesOf constructors

270−

271−-- | `DimPG` turns Haskell nested homogeneous tuples into a list of lengths.

272−type family DimPG (hask :: Type) :: [Nat] where

273− DimPG (x,x) = 2 ': DimPG x

274− DimPG (x,x,x) = 3 ': DimPG x

275− DimPG (x,x,x,x) = 4 ': DimPG x

276− DimPG (x,x,x,x,x) = 5 ': DimPG x

277− DimPG (x,x,x,x,x,x) = 6 ': DimPG x

278− DimPG (x,x,x,x,x,x,x) = 7 ': DimPG x

279− DimPG (x,x,x,x,x,x,x,x) = 8 ': DimPG x

280− DimPG (x,x,x,x,x,x,x,x,x) = 9 ': DimPG x

281− DimPG (x,x,x,x,x,x,x,x,x,x) = 10 ': DimPG x

282− DimPG x = '[]

283−

284−-- | `FixPG` extracts `NullPG` of the base type of nested homogeneous tuples.

285−type family FixPG (hask :: Type) :: NullityType where

286− FixPG (x,x) = FixPG x

287− FixPG (x,x,x) = FixPG x

288− FixPG (x,x,x,x) = FixPG x

289− FixPG (x,x,x,x,x) = FixPG x

290− FixPG (x,x,x,x,x,x) = FixPG x

291− FixPG (x,x,x,x,x,x,x) = FixPG x

292− FixPG (x,x,x,x,x,x,x,x) = FixPG x

293− FixPG (x,x,x,x,x,x,x,x,x) = FixPG x

294− FixPG (x,x,x,x,x,x,x,x,x,x) = FixPG x

295− FixPG (x,x,x,x,x,x,x,x,x,x,x) = FixPG x

296− FixPG x = NullPG x

297−

298−{- | The `Money` newtype stores a monetary value in terms

299−of the number of cents, i.e. @$2,000.20@ would be expressed as

300−@Money { cents = 200020 }@.

301−

302−>>> import Control.Monad (void)

303−>>> import Control.Monad.IO.Class (liftIO)

304−>>> import Squeal.PostgreSQL

305−>>> :{

306−let

307− roundTrip :: Query_ (Public '[]) (Only Money) (Only Money)

308− roundTrip = values_ $ parameter @1 money `as` #fromOnly

309−:}

310−

311−>>> let input = Only (Money 20020)

312−

313−>>> :{

314−withConnection "host=localhost port=5432 dbname=exampledb" $ do

315− result <- runQueryParams roundTrip input

316− Just output <- firstRow result

317− liftIO . print $ input == output

318−:}

319−True

320−-}

321−newtype Money = Money { cents :: Int64 }

322− deriving stock (Eq, Ord, Show, Read, GHC.Generic)

323− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

324−-- | `PGmoney`

325−type instance PG Money = 'PGmoney

326−

327−{- | The `Json` newtype is an indication that the Haskell

328−type it's applied to should be stored as a `PGjson`.

329−-}

330−newtype Json hask = Json {getJson :: hask}

331− deriving stock (Eq, Ord, Show, Read, GHC.Generic)

332− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

333−-- | `PGjson`

334−type instance PG (Json hask) = 'PGjson

335−

336−{- | The `Jsonb` newtype is an indication that the Haskell

337−type it's applied to should be stored as a `PGjsonb`.

338−-}

339−newtype Jsonb hask = Jsonb {getJsonb :: hask}

340− deriving stock (Eq, Ord, Show, Read, GHC.Generic)

341− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

342−-- | `PGjsonb`

343−type instance PG (Jsonb hask) = 'PGjsonb

344−

345−{- | The `Composite` newtype is an indication that the Haskell

346−type it's applied to should be stored as a `PGcomposite`.

347−-}

348−newtype Composite record = Composite {getComposite :: record}

349− deriving stock (Eq, Ord, Show, Read, GHC.Generic)

350− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

351−-- | `PGcomposite` @(@`RowPG` @hask)@

352−type instance PG (Composite hask) = 'PGcomposite (RowPG hask)

353−

354−{- | The `Enumerated` newtype is an indication that the Haskell

355−type it's applied to should be stored as a `PGenum`.

356−-}

357−newtype Enumerated enum = Enumerated {getEnumerated :: enum}

358− deriving stock (Eq, Ord, Show, Read, GHC.Generic)

359− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

360−-- | `PGenum` @(@`LabelsPG` @hask)@

361−type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)

362−

363−{- | The `VarArray` newtype is an indication that the Haskell

364−type it's applied to should be stored as a `PGvararray`.

365−

366−>>> :kind! PG (VarArray (Vector Double))

367−PG (VarArray (Vector Double)) :: PGType

368−= 'PGvararray ('NotNull 'PGfloat8)

369−-}

370−newtype VarArray arr = VarArray {getVarArray :: arr}

371− deriving stock (Eq, Ord, Show, Read, GHC.Generic)

372− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

373−-- | `PGvararray` @(@`NullPG` @hask)@

374−type instance PG (VarArray (Vector hask)) = 'PGvararray (NullPG hask)

375−type instance PG (VarArray [hask]) = 'PGvararray (NullPG hask)

376−

377−{- | The `FixArray` newtype is an indication that the Haskell

378−type it's applied to should be stored as a `PGfixarray`.

379−

380−>>> :kind! PG (FixArray ((Double, Double), (Double, Double)))

381−PG (FixArray ((Double, Double), (Double, Double))) :: PGType

382−= 'PGfixarray '[2, 2] ('NotNull 'PGfloat8)

383−-}

384−newtype FixArray arr = FixArray {getFixArray :: arr}

385− deriving stock (Eq, Ord, Show, Read, GHC.Generic)

386− deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

387−-- | `PGfixarray` @(@`DimPG` @hask) (@`FixPG` @hask)@

388−type instance PG (FixArray hask) = 'PGfixarray (DimPG hask) (FixPG hask)

squeal-postgresql/src/Squeal/PostgreSQL/PQ.hs+119−159

@@ -6,7 +6,7 @@ Maintainer: eitan@morphism.tech

66Stability: experimental

88This module is where Squeal commands actually get executed by

9−`Database.PostgreSQL.LibPQ`. It containts two typeclasses, `IndexedMonadTransPQ` for executing

9+`LibPQ`. It containts two typeclasses, `IndexedMonadTransPQ` for executing

1010a `Definition` and `MonadPQ` for executing a `Manipulation` or `Query`,

1111and a `PQ` type with instances for them.

1212

@@ -24,7 +24,6 @@ of executing Squeal commands.

2424 , FunctionalDependencies

2525 , FlexibleContexts

2626 , FlexibleInstances

27− , InstanceSigs

2827 , OverloadedStrings

2928 , RankNTypes

3029 , ScopedTypeVariables

@@ -49,6 +48,8 @@ module Squeal.PostgreSQL.PQ

4948 , evalPQ

5049 , IndexedMonadTransPQ (..)

5150 , MonadPQ (..)

51+ , PQRun

52+ , pqliftWith

5253 -- * Results

5354 , LibPQ.Result

5455 , LibPQ.Row

@@ -64,30 +65,25 @@ module Squeal.PostgreSQL.PQ

6465 , resultErrorCode

6566 -- * Exceptions

6667 , SquealException (..)

67− , PQState (..)

68− , okResult

6968 , catchSqueal

7069 , handleSqueal

71− , trySqueal

7270 ) where

7371

74−import Control.Exception (Exception, throw)

72+import Control.Exception.Lifted

73+import Control.Monad.Base

7574import Control.Monad.Except

7675import Control.Monad.Morph

77−import UnliftIO (MonadUnliftIO (..), bracket, catch, handle, try)

76+import Control.Monad.Trans.Control

7877import Data.ByteString (ByteString)

7978import Data.Foldable

8079import Data.Function ((&))

81−import Data.Functor ((<&>))

8280import Data.Kind

8381import Data.Text (pack, Text)

8482import Data.Traversable

8583import Generics.SOP

8684import PostgreSQL.Binary.Encoding (encodingBytes)

8785

88−import qualified Control.Monad.Fail as Fail

8986import qualified Database.PostgreSQL.LibPQ as LibPQ

90−import qualified PostgreSQL.Binary.Encoding as Encoding

9187

9288import Squeal.PostgreSQL.Binary

9389import Squeal.PostgreSQL.Definition

@@ -108,9 +104,6 @@ import qualified Control.Monad.Trans.Writer.Strict as Strict

108104import qualified Control.Monad.Trans.RWS.Lazy as Lazy

109105import qualified Control.Monad.Trans.RWS.Strict as Strict

110106

111−-- $setup

112−-- >>> import Squeal.PostgreSQL

113−

114107{- | Makes a new connection to the database server.

115108

116109This function opens a new database connection using the parameters taken

@@ -138,19 +131,19 @@ with the wrong schema!

138131-}

139132connectdb

140133 :: forall schemas io

141− . MonadIO io

134+ . MonadBase IO io

142135 => ByteString -- ^ conninfo

143136 -> io (K LibPQ.Connection schemas)

144−connectdb = fmap K . liftIO . LibPQ.connectdb

137+connectdb = fmap K . liftBase . LibPQ.connectdb

145138

146139-- | Closes the connection to the server.

147−finish :: MonadIO io => K LibPQ.Connection schemas -> io ()

148−finish = liftIO . LibPQ.finish . unK

140+finish :: MonadBase IO io => K LibPQ.Connection schemas -> io ()

141+finish = liftBase . LibPQ.finish . unK

149142

150143-- | Do `connectdb` and `finish` before and after a computation.

151144withConnection

152145 :: forall schemas0 schemas1 io x

153− . MonadUnliftIO io

146+ . MonadBaseControl IO io

154147 => ByteString

155148 -> PQ schemas0 schemas1 io x

156149 -> io x

@@ -178,7 +171,7 @@ instance Monad m => Functor (PQ schemas0 schemas1 m) where

178171 K x <- pq conn

179172 return $ K (f x)

180173

181−-- | Run a `PQ` and keep the result and the `LibPQ.Connection`.

174+-- | Run a `PQ` and keep the result and the `Connection`.

182175runPQ

183176 :: Functor m

184177 => PQ schemas0 schemas1 m x

@@ -188,7 +181,7 @@ runPQ (PQ pq) conn = (\ x -> (unK x, K (unK conn))) <$> pq conn

188181 -- K x <- pq conn

189182 -- return (x, K (unK conn))

190183

191−-- | Execute a `PQ` and discard the result but keep the `LibPQ.Connection`.

184+-- | Execute a `PQ` and discard the result but keep the `Connection`.

192185execPQ

193186 :: Functor m

194187 => PQ schemas0 schemas1 m x

@@ -196,7 +189,7 @@ execPQ

196189 -> m (K LibPQ.Connection schemas1)

197190execPQ (PQ pq) conn = mapKK (\ _ -> unK conn) <$> pq conn

198191

199−-- | Evaluate a `PQ` and discard the `LibPQ.Connection` but keep the result.

192+-- | Evaluate a `PQ` and discard the `Connection` but keep the result.

200193evalPQ

201194 :: Functor m

202195 => PQ schemas0 schemas1 m x

@@ -208,7 +201,8 @@ evalPQ (PQ pq) conn = unK <$> pq conn

208201-- [enriched category](https://ncatlab.org/nlab/show/enriched+category).

209202-- An indexed monad transformer transforms a `Monad` into an indexed monad.

210203-- And, `IndexedMonadTransPQ` is a class for indexed monad transformers that

211−-- support running `Definition`s using `define`.

204+-- support running `Definition`s using `define` and embedding a computation

205+-- in a larger schema using `pqEmbed`.

212206class IndexedMonadTransPQ pq where

213207

214208 -- | indexed analog of `<*>`

@@ -248,16 +242,19 @@ class IndexedMonadTransPQ pq where

248242 -> x -> pq schemas0 schemas2 m z

249243 pqAndThen g f x = pqBind g (f x)

250244

251− -- | Run a `Definition` with `LibPQ.exec`.

252− --

253− -- It should be functorial in effect.

245+ -- | Safely embed a computation in a larger schema.

246+ pqEmbed

247+ :: Monad m

248+ => pq schemas0 schemas1 m x

249+ -> pq (schema ': schemas0) (schema : schemas1) m x

250+

251+ -- | Run a `Definition` with `LibPQ.exec`, we expect that libpq obeys the law

254252 --

255− -- @define id = return ()@

256− -- @define (statement1 >>> statement2) = define statement1 & pqThen (define statement2)@

253+ -- @define statement1 & pqThen (define statement2) = define (statement1 >>> statement2)@

257254 define

258− :: MonadIO io

255+ :: MonadBase IO io

259256 => Definition schemas0 schemas1

260− -> pq schemas0 schemas1 io ()

257+ -> pq schemas0 schemas1 io (K LibPQ.Result '[])

261258

262259instance IndexedMonadTransPQ PQ where

263260

@@ -270,26 +267,26 @@ instance IndexedMonadTransPQ PQ where

270267 K x' <- x conn

271268 unPQ (f x') (K (unK conn))

272269

270+ pqEmbed (PQ pq) = PQ $ \ (K conn) -> do

271+ K x <- pq (K conn)

272+ return $ K x

273+

273274 define (UnsafeDefinition q) = PQ $ \ (K conn) -> do

274− resultMaybe <- liftIO $ LibPQ.exec conn q

275+ resultMaybe <- liftBase $ LibPQ.exec conn q

275276 case resultMaybe of

276277 Nothing -> throw $ ResultException

277278 "define: LibPQ.exec returned no results"

278− Just result -> K <$> okResult_ result

279+ Just result -> return $ K (K result)

279280

280−{- | `MonadPQ` is an @mtl@ style constraint, similar to

281−`Control.Monad.State.Class.MonadState`, for using `Database.PostgreSQL.LibPQ` to

281+{- | `MonadPQ` is an `mtl` style constraint, similar to

282+`Control.Monad.State.Class.MonadState`, for using `LibPQ` to

282283

283284* `manipulateParams` runs a `Manipulation` with params from a type

284285 with a `ToParams` constraint. It calls `LibPQ.execParams` and

285286 doesn't afraid of anything.

286287

287−* `manipulateParams_` is like `manipulateParams` for a returning-free statement.

288−

289288* `manipulate` is like `manipulateParams` for a parameter-free statement.

290289

291−* `manipulate_` is like `manipulate` for a returning-free statement.

292−

293290* `runQueryParams` is like `manipulateParams` for query statements.

294291

295292* `runQuery` is like `runQueryParams` for a parameter-free statement.

@@ -303,11 +300,11 @@ instance IndexedMonadTransPQ PQ where

303300* `forPrepared` is a flipped `traversePrepared`

304301

305302* `traversePrepared_` is like `traversePrepared` but works on `Foldable`

306− containers for a returning-free statement.

303+ containers and returns unit.

307304

308305* `forPrepared_` is a flipped `traversePrepared_`.

309306

310−* `liftPQ` lets you lift actions from `Database.PostgreSQL.LibPQ` that require a connection

307+* `liftPQ` lets you lift actions from `LibPQ` that require a connection

311308 into your monad.

312309

313310To define an instance, you can minimally define only `manipulateParams`,

@@ -317,84 +314,74 @@ a default instance.

317314-}

318315class Monad pq => MonadPQ schemas pq | pq -> schemas where

319316 manipulateParams

320− :: (ToParams x params, All OidOfParam params)

317+ :: ToParams x params

321318 => Manipulation '[] schemas params ys

322− -- ^ `insertInto`, `update` or `deleteFrom`

319+ -- ^ `insertRows`, `update` or `deleteFrom`

323320 -> x -> pq (K LibPQ.Result ys)

324321 default manipulateParams

325322 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

326− => (ToParams x params, All OidOfParam params)

323+ => ToParams x params

327324 => Manipulation '[] schemas params ys

328− -- ^ `insertInto`, `update` or `deleteFrom`

325+ -- ^ `insertRows`, `update` or `deleteFrom`

329326 -> x -> pq (K LibPQ.Result ys)

330327 manipulateParams manipulation params = lift $

331328 manipulateParams manipulation params

332329

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−

340330 manipulate :: Manipulation '[] schemas '[] ys -> pq (K LibPQ.Result ys)

341331 manipulate statement = manipulateParams statement ()

342332

343− manipulate_ :: Manipulation '[] schemas '[] '[] -> pq ()

344− manipulate_ = void . manipulate

345−

346333 runQueryParams

347− :: (ToParams x params, All OidOfParam params)

348− => Query '[] '[] schemas params ys

334+ :: ToParams x params

335+ => Query '[] schemas params ys

349336 -- ^ `select` and friends

350337 -> x -> pq (K LibPQ.Result ys)

351338 runQueryParams = manipulateParams . queryStatement

352339

353340 runQuery

354− :: Query '[] '[] schemas '[] ys

341+ :: Query '[] schemas '[] ys

355342 -- ^ `select` and friends

356343 -> pq (K LibPQ.Result ys)

357344 runQuery q = runQueryParams q ()

358345

359346 traversePrepared

360− :: (ToParams x params, Traversable list, All OidOfParam params)

347+ :: (ToParams x params, Traversable list)

361348 => Manipulation '[] schemas params ys

362− -- ^ `insertInto`, `update`, or `deleteFrom`, and friends

349+ -- ^ `insertRows`, `update`, or `deleteFrom`, and friends

363350 -> list x -> pq (list (K LibPQ.Result ys))

364351 default traversePrepared

365352 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

366− => (ToParams x params, Traversable list, All OidOfParam params)

353+ => (ToParams x params, Traversable list)

367354 => Manipulation '[] schemas params ys -> list x -> pq (list (K LibPQ.Result ys))

368355 traversePrepared manipulation params = lift $

369356 traversePrepared manipulation params

370357

371358 forPrepared

372− :: (ToParams x params, Traversable list, All OidOfParam params)

359+ :: (ToParams x params, Traversable list)

373360 => list x

374361 -> Manipulation '[] schemas params ys

375− -- ^ `insertInto`, `update` or `deleteFrom`

362+ -- ^ `insertRows`, `update` or `deleteFrom`

376363 -> pq (list (K LibPQ.Result ys))

377364 forPrepared = flip traversePrepared

378365

379366 traversePrepared_

380− :: (ToParams x params, Foldable list, All OidOfParam params)

367+ :: (ToParams x params, Foldable list)

381368 => Manipulation '[] schemas params '[]

382− -- ^ `insertInto`, `update` or `deleteFrom`

369+ -- ^ `insertRows`, `update` or `deleteFrom`

383370 -> list x -> pq ()

384371 default traversePrepared_

385372 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

386− => (ToParams x params, Foldable list, All OidOfParam params)

373+ => (ToParams x params, Foldable list)

387374 => Manipulation '[] schemas params '[]

388− -- ^ `insertInto`, `update` or `deleteFrom`

375+ -- ^ `insertRows`, `update` or `deleteFrom`

389376 -> list x -> pq ()

390377 traversePrepared_ manipulation params = lift $

391378 traversePrepared_ manipulation params

392379

393380 forPrepared_

394− :: (ToParams x params, Foldable list, All OidOfParam params)

381+ :: (ToParams x params, Foldable list)

395382 => list x

396383 -> Manipulation '[] schemas params '[]

397− -- ^ `insertInto`, `update` or `deleteFrom`

384+ -- ^ `insertRows`, `update` or `deleteFrom`

398385 -> pq ()

399386 forPrepared_ = flip traversePrepared_

400387

@@ -404,83 +391,61 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

404391 => (LibPQ.Connection -> IO a) -> pq a

405392 liftPQ = lift . liftPQ

406393

407−instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

394+instance (MonadBase IO io, schemas0 ~ schemas, schemas1 ~ schemas)

408395 => MonadPQ schemas (PQ schemas0 schemas1 io) where

409396

410397 manipulateParams

411398 (UnsafeManipulation q :: Manipulation '[] schemas ps ys) (params :: x) =

412399 PQ $ \ (K conn) -> do

413400 let

414− paramSet

415− :: forall param. OidOfParam param

416− => K (Maybe Encoding.Encoding) param

417− -> K (Maybe (LibPQ.Oid, ByteString, LibPQ.Format)) param

418− paramSet (K maybeEncoding) = K $

419− maybeEncoding <&> \encoding ->

420− (oidOfParam @param, encodingBytes encoding, LibPQ.Binary)

421− params'

422− = hcollapse

423− . hcmap (Proxy @OidOfParam) paramSet

424− $ toParams @x @ps params

401+ toParam' encoding =

402+ (LibPQ.invalidOid, encodingBytes encoding, LibPQ.Binary)

403+ params' = fmap (fmap toParam') (hcollapse (toParams @x @ps params))

425404 q' = q <> ";"

426− resultMaybe <- liftIO $ LibPQ.execParams conn q' params' LibPQ.Binary

405+ resultMaybe <- liftBase $ LibPQ.execParams conn q' params' LibPQ.Binary

427406 case resultMaybe of

428407 Nothing -> throw $ ResultException

429408 "manipulateParams: LibPQ.execParams returned no results"

430409 Just result -> do

431− okResult_ result

410+ tryResult result

432411 return $ K (K result)

433412

434413 traversePrepared

435414 (UnsafeManipulation q :: Manipulation '[] schemas xs ys) (list :: list x) =

436− PQ $ \ (K conn) -> liftIO $ do

437− let

438− temp = "temporary_statement"

439− paramOid :: forall p. OidOfParam p => K LibPQ.Oid p

440− paramOid = K (oidOfParam @p)

441− paramOids :: NP (K LibPQ.Oid) xs

442− paramOids = hcpure (Proxy @OidOfParam) paramOid

443− paramOids' :: [LibPQ.Oid]

444− paramOids' = hcollapse paramOids

445− prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

415+ PQ $ \ (K conn) -> liftBase $ do

416+ let temp = "temporary_statement"

417+ prepResultMaybe <- LibPQ.prepare conn temp q Nothing

446418 case prepResultMaybe of

447419 Nothing -> throw $ ResultException

448420 "traversePrepared: LibPQ.prepare returned no results"

449− Just prepResult -> okResult_ prepResult

421+ Just prepResult -> tryResult prepResult

450422 results <- for list $ \ params -> do

451423 let

452− toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

424+ toParam' encoding = (encodingBytes encoding,LibPQ.Binary)

453425 params' = fmap (fmap toParam') (hcollapse (toParams @x @xs params))

454426 resultMaybe <- LibPQ.execPrepared conn temp params' LibPQ.Binary

455427 case resultMaybe of

456428 Nothing -> throw $ ResultException

457429 "traversePrepared: LibPQ.execParams returned no results"

458430 Just result -> do

459− okResult_ result

431+ tryResult result

460432 return $ K result

461433 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

462434 case deallocResultMaybe of

463435 Nothing -> throw $ ResultException

464436 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

465− Just deallocResult -> okResult_ deallocResult

437+ Just deallocResult -> tryResult deallocResult

466438 return (K results)

467439

468440 traversePrepared_

469441 (UnsafeManipulation q :: Manipulation '[] schemas xs '[]) (list :: list x) =

470− PQ $ \ (K conn) -> liftIO $ do

471− let

472− temp = "temporary_statement"

473− paramOid :: forall p. OidOfParam p => K LibPQ.Oid p

474− paramOid = K (oidOfParam @p)

475− paramOids :: NP (K LibPQ.Oid) xs

476− paramOids = hcpure (Proxy @OidOfParam) paramOid

477− paramOids' :: [LibPQ.Oid]

478− paramOids' = hcollapse paramOids

479− prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

442+ PQ $ \ (K conn) -> liftBase $ do

443+ let temp = "temporary_statement"

444+ prepResultMaybe <- LibPQ.prepare conn temp q Nothing

480445 case prepResultMaybe of

481446 Nothing -> throw $ ResultException

482447 "traversePrepared_: LibPQ.prepare returned no results"

483− Just prepResult -> okResult_ prepResult

448+ Just prepResult -> tryResult prepResult

484449 for_ list $ \ params -> do

485450 let

486451 toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

@@ -489,16 +454,16 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

489454 case resultMaybe of

490455 Nothing -> throw $ ResultException

491456 "traversePrepared_: LibPQ.execParams returned no results"

492− Just result -> okResult_ result

457+ Just result -> tryResult result

493458 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

494459 case deallocResultMaybe of

495460 Nothing -> throw $ ResultException

496461 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

497− Just deallocResult -> okResult_ deallocResult

462+ Just deallocResult -> tryResult deallocResult

498463 return (K ())

499464

500465 liftPQ pq = PQ $ \ (K conn) -> do

501− y <- liftIO $ pq conn

466+ y <- liftBase $ pq conn

502467 return (K y)

503468

504469instance MonadPQ schemas m => MonadPQ schemas (IdentityT m)

@@ -523,10 +488,6 @@ instance (Monad m, schemas0 ~ schemas1)

523488 return = pure

524489 (>>=) = flip pqBind

525490

526−instance (Monad m, schemas0 ~ schemas1)

527− => Fail.MonadFail (PQ schemas0 schemas1 m) where

528− fail = Fail.fail

529−

530491instance schemas0 ~ schemas1 => MFunctor (PQ schemas0 schemas1) where

531492 hoist f (PQ pq) = PQ (f . pq)

532493

@@ -539,29 +500,40 @@ instance schemas0 ~ schemas1 => MMonad (PQ schemas0 schemas1) where

539500 embed f (PQ pq) = PQ $ \ conn -> do

540501 evalPQ (f (pq conn)) conn

541502

503+instance (MonadBase b m, schemas0 ~ schemas1)

504+ => MonadBase b (PQ schemas0 schemas1 m) where

505+ liftBase = lift . liftBase

506+

542507instance (MonadIO m, schema0 ~ schema1)

543508 => MonadIO (PQ schema0 schema1 m) where

544509 liftIO = lift . liftIO

545510

546−instance (MonadUnliftIO m, schemas0 ~ schemas1)

547− => MonadUnliftIO (PQ schemas0 schemas1 m) where

548− withRunInIO

549− :: ((forall a . PQ schemas0 schema1 m a -> IO a) -> IO b)

550− -> PQ schemas0 schema1 m b

551− withRunInIO inner = PQ $ \conn ->

552− withRunInIO $ \(run :: (forall x . m x -> IO x)) ->

553− K <$> inner (\pq -> run $ unK <$> unPQ pq conn)

511+-- | A snapshot of the state of a `PQ` computation.

512+type PQRun schemas =

513+ forall m x. Monad m => PQ schemas schemas m x -> m (K x schemas)

514+

515+-- | Helper function in defining `MonadBaseControl` instance for `PQ`.

516+pqliftWith :: Functor m => (PQRun schemas -> m a) -> PQ schemas schemas m a

517+pqliftWith f = PQ $ \ conn ->

518+ fmap K (f $ \ pq -> unPQ pq conn)

519+

520+instance (MonadBaseControl b m, schemas0 ~ schemas1)

521+ => MonadBaseControl b (PQ schemas0 schemas1 m) where

522+ type StM (PQ schemas0 schemas1 m) x = StM m (K x schemas0)

523+ liftBaseWith f =

524+ pqliftWith $ \ run -> liftBaseWith $ \ runInBase -> f $ runInBase . run

525+ restoreM = PQ . const . restoreM

554526

555527-- | Get a row corresponding to a given row number from a `LibPQ.Result`,

556528-- throwing an exception if the row number is out of bounds.

557529getRow

558− :: (FromRow columns y, MonadIO io)

530+ :: (FromRow columns y, MonadBase IO io)

559531 => LibPQ.Row

560532 -- ^ row number

561533 -> K LibPQ.Result columns

562534 -- ^ result

563535 -> io y

564−getRow r (K result :: K LibPQ.Result columns) = liftIO $ do

536+getRow r (K result :: K LibPQ.Result columns) = liftBase $ do

565537 numRows <- LibPQ.ntuples result

566538 when (numRows < r) $ throw $ ResultException $

567539 "getRow: expected at least " <> pack (show r) <> "rows but only saw "

@@ -579,13 +551,13 @@ getRow r (K result :: K LibPQ.Result columns) = liftIO $ do

579551-- and a `LibPQ.Result` and given a row number if it's too large returns `Nothing`,

580552-- otherwise returning the row along with the next row number.

581553nextRow

582− :: (FromRow columns y, MonadIO io)

554+ :: (FromRow columns y, MonadBase IO io)

583555 => LibPQ.Row -- ^ total number of rows

584556 -> K LibPQ.Result columns -- ^ result

585557 -> LibPQ.Row -- ^ row number

586558 -> io (Maybe (LibPQ.Row,y))

587559nextRow total (K result :: K LibPQ.Result columns) r

588− = liftIO $ if r >= total then return Nothing else do

560+ = liftBase $ if r >= total then return Nothing else do

589561 let len = fromIntegral (lengthSList (Proxy @columns))

590562 row' <- traverse (LibPQ.getvalue result r) [0 .. len - 1]

591563 case fromList row' of

@@ -596,10 +568,10 @@ nextRow total (K result :: K LibPQ.Result columns) r

596568

597569-- | Get all rows from a `LibPQ.Result`.

598570getRows

599− :: (FromRow columns y, MonadIO io)

571+ :: (FromRow columns y, MonadBase IO io)

600572 => K LibPQ.Result columns -- ^ result

601573 -> io [y]

602−getRows (K result :: K LibPQ.Result columns) = liftIO $ do

574+getRows (K result :: K LibPQ.Result columns) = liftBase $ do

603575 let len = fromIntegral (lengthSList (Proxy @columns))

604576 numRows <- LibPQ.ntuples result

605577 for [0 .. numRows - 1] $ \ r -> do

@@ -612,10 +584,10 @@ getRows (K result :: K LibPQ.Result columns) = liftIO $ do

612584

613585-- | Get the first row if possible from a `LibPQ.Result`.

614586firstRow

615− :: (FromRow columns y, MonadIO io)

587+ :: (FromRow columns y, MonadBase IO io)

616588 => K LibPQ.Result columns -- ^ result

617589 -> io (Maybe y)

618−firstRow (K result :: K LibPQ.Result columns) = liftIO $ do

590+firstRow (K result :: K LibPQ.Result columns) = liftBase $ do

619591 numRows <- LibPQ.ntuples result

620592 if numRows <= 0 then return Nothing else do

621593 let len = fromIntegral (lengthSList (Proxy @columns))

@@ -628,23 +600,23 @@ firstRow (K result :: K LibPQ.Result columns) = liftIO $ do

628600

629601-- | Lifts actions on results from @LibPQ@.

630602liftResult

631− :: MonadIO io

603+ :: MonadBase IO io

632604 => (LibPQ.Result -> IO x)

633605 -> K LibPQ.Result results -> io x

634−liftResult f (K result) = liftIO $ f result

606+liftResult f (K result) = liftBase $ f result

635607

636608-- | Returns the number of rows (tuples) in the query result.

637−ntuples :: MonadIO io => K LibPQ.Result columns -> io LibPQ.Row

609+ntuples :: MonadBase IO io => K LibPQ.Result columns -> io LibPQ.Row

638610ntuples = liftResult LibPQ.ntuples

639611

640612-- | Returns the result status of the command.

641−resultStatus :: MonadIO io => K LibPQ.Result results -> io LibPQ.ExecStatus

613+resultStatus :: MonadBase IO io => K LibPQ.Result results -> io LibPQ.ExecStatus

642614resultStatus = liftResult LibPQ.resultStatus

643615

644616-- | Returns the error message most recently generated by an operation

645617-- on the connection.

646618resultErrorMessage

647− :: MonadIO io => K LibPQ.Result results -> io (Maybe ByteString)

619+ :: MonadBase IO io => K LibPQ.Result results -> io (Maybe ByteString)

648620resultErrorMessage = liftResult LibPQ.resultErrorMessage

649621

650622-- | Returns the error code most recently generated by an operation

@@ -652,29 +624,29 @@ resultErrorMessage = liftResult LibPQ.resultErrorMessage

652624--

653625-- https://www.postgresql.org/docs/current/static/errcodes-appendix.html

654626resultErrorCode

655− :: MonadIO io

627+ :: MonadBase IO io

656628 => K LibPQ.Result results

657629 -> io (Maybe ByteString)

658630resultErrorCode = liftResult (flip LibPQ.resultErrorField LibPQ.DiagSqlstate)

659631

660−-- | the state of LibPQ

661−data PQState = PQState

632+-- | `Exception`s that can be thrown by Squeal.

633+data SquealException

634+ = PQException

662635 { sqlExecStatus :: LibPQ.ExecStatus

663636 , sqlStateCode :: Maybe ByteString

664637 -- ^ https://www.postgresql.org/docs/current/static/errcodes-appendix.html

665638 , sqlErrorMessage :: Maybe ByteString

666− } deriving (Eq, Show)

667−

668−-- | `Exception`s that can be thrown by Squeal.

669−data SquealException

670− = PQException PQState

639+ }

671640 | ResultException Text

672641 | ParseException Text

673642 deriving (Eq, Show)

674643instance Exception SquealException

675644

676−okResult_ :: MonadIO io => LibPQ.Result -> io ()

677−okResult_ result = liftIO $ do

645+tryResult

646+ :: MonadBase IO io

647+ => LibPQ.Result

648+ -> io ()

649+tryResult result = liftBase $ do

678650 status <- LibPQ.resultStatus result

679651 case status of

680652 LibPQ.CommandOk -> return ()

@@ -682,16 +654,11 @@ okResult_ result = liftIO $ do

682654 _ -> do

683655 stateCode <- LibPQ.resultErrorField result LibPQ.DiagSqlstate

684656 msg <- LibPQ.resultErrorMessage result

685− throw . PQException $ PQState status stateCode msg

686−

687−-- | Check if a `LibPQ.Result`'s status is either `LibPQ.CommandOk`

688−-- or `LibPQ.TuplesOk` otherwise `throw` a `PQException`.

689−okResult :: MonadIO io => K LibPQ.Result row -> io ()

690−okResult = okResult_ . unK

657+ throw $ PQException status stateCode msg

691658

692659-- | Catch `SquealException`s.

693660catchSqueal

694− :: MonadUnliftIO io

661+ :: MonadBaseControl IO io

695662 => io a

696663 -> (SquealException -> io a) -- ^ handler

697664 -> io a

@@ -699,14 +666,7 @@ catchSqueal = catch

699666

700667-- | Handle `SquealException`s.

701668handleSqueal

702− :: MonadUnliftIO io

669+ :: MonadBaseControl IO io

703670 => (SquealException -> io a) -- ^ handler

704671 -> io a -> io a

705672handleSqueal = 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+103−72

@@ -1,40 +1,17 @@

11{-|

2−Module: Squeal.PostgreSQL.Pool

3−Description: Connection pools

2+Module: Squeal.PostgreSQL.Definition

3+Description: Pooled connections

44Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

8−Connection pools.

9−

10−Typical use case would be to create your pool using `createConnectionPool`

11−and run anything that requires the pool connection with `usingConnectionPool`.

12−

13−Here's a simplified example:

14−

15−>>> import Squeal.PostgreSQL

16−

17−>>> :{

18−do

19− let

20− query :: Query_ (Public '[]) () (Only Char)

21− query = values_ (literal 'a' `as` #fromOnly)

22− pool <- createConnectionPool "host=localhost port=5432 dbname=exampledb" 1 0.5 10

23− chr <- usingConnectionPool pool $ do

24− result <- runQuery query

25− Just (Only a) <- firstRow result

26− return a

27− destroyConnectionPool pool

28− putChar chr

29−:}

30−a

8+A `MonadPQ` for pooled connections.

319-}

3210

3311{-# LANGUAGE

3412 DeriveFunctor

3513 , FlexibleContexts

3614 , FlexibleInstances

37− , InstanceSigs

3815 , MultiParamTypeClasses

3916 , RankNTypes

4017 , ScopedTypeVariables

@@ -45,24 +22,55 @@ a

4522

4623module Squeal.PostgreSQL.Pool

4724 ( -- * Pools

48− Pool

25+ PoolPQ (..)

4926 , createConnectionPool

50− , usingConnectionPool

51− , destroyConnectionPool

27+ , Pool

28+ , destroyAllResources

29+ , PoolPQRun

30+ , poolpqliftWith

5231 ) where

5332

33+import Control.Monad.Base

34+import Control.Monad.Trans

35+import Control.Monad.Trans.Control

5436import Data.ByteString

37+import Data.Pool

5538import Data.Time

56−import Generics.SOP (K(..), unK)

57−import UnliftIO (MonadUnliftIO (..))

58−import UnliftIO.Pool (Pool, createPool, destroyAllResources, withResource)

39+import Generics.SOP (K(..))

5940

6041import Squeal.PostgreSQL.PQ

42+import Squeal.PostgreSQL.Schema

43+

44+{- | `PoolPQ` @schemas@ should be a drop-in replacement for `PQ` @schemas schemas@.

45+

46+Typical use case would be to create your pool using `createConnectionPool` and run anything that requires the pool connection with it.

47+

48+Here's a simplified example:

49+

50+> type Schema = '[ "tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint2])]

51+>

52+> someQuery :: Manipulation Schema '[ 'NotNull 'PGint2] '[]

53+> someQuery = insertRow #tab

54+> (Set (param @1) `As` #col :* Nil)

55+> OnConflictDoNothing (Returning Nil)

56+>

57+> insertOne :: (MonadBaseControl IO m, MonadPQ Schema m) => m ()

58+> insertOne = void $ manipulateParams someQuery . Only $ (1 :: Int16)

59+>

60+> insertOneInPool :: ByteString -> IO ()

61+> insertOneInPool connectionString = do

62+> pool <- createConnectionPool connectionString 1 0.5 10

63+> liftIO $ runPoolPQ (insertOne) pool

64+

65+-}

66+newtype PoolPQ (schemas :: SchemasType) m x =

67+ PoolPQ { runPoolPQ :: Pool (K Connection schemas) -> m x }

68+ deriving Functor

6169

6270-- | Create a striped pool of connections.

6371-- 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.

6472createConnectionPool

65− :: MonadUnliftIO io

73+ :: MonadBase IO io

6674 => ByteString

6775 -- ^ The passed string can be empty to use all default parameters, or it can

6876 -- contain one or more parameter settings separated by whitespace.

@@ -79,44 +87,67 @@ createConnectionPool

7987 -- ^ Maximum number of connections to keep open per stripe. The smallest acceptable value is 1.

8088 -- Requests for connections will block if this limit is reached on a single stripe, even if other stripes have idle connections available.

8189 -> io (Pool (K Connection schemas))

82−createConnectionPool conninfo stripes idle maxResrc =

90+createConnectionPool conninfo stripes idle maxResrc = liftBase $

8391 createPool (connectdb conninfo) finish stripes idle maxResrc

8492

85−{-|

86−Temporarily take a connection from a `Pool`, perform an action with it,

87−and return it to the pool afterwards.

88−

89−If the pool has an idle connection available, it is used immediately.

90−Otherwise, if the maximum number of connections has not yet been reached,

91−a new connection is created and used.

92−If the maximum number of connections has been reached, this function blocks

93−until a connection becomes available.

94−-}

95−usingConnectionPool

96− :: MonadUnliftIO io

97− => Pool (K Connection schemas) -- ^ pool

98− -> PQ schemas schemas io x -- ^ session

99− -> io x

100−usingConnectionPool pool (PQ session) = unK <$> withResource pool session

101−

102−{- |

103−Destroy all connections in all stripes in the pool.

104−Note that this will ignore any exceptions in the destroy function.

105−

106−This function is useful when you detect that all connections

107−in the pool are broken. For example after a database has been

108−restarted all connections opened before the restart will be broken.

109−In that case it's better to close those connections so that

110−`usingConnectionPool` won't take a broken connection from the pool

111−but will open a new connection instead.

112−

113−Another use-case for this function is that when you know you are done

114−with the pool you can destroy all idle connections immediately

115−instead of waiting on the garbage collector to destroy them,

116−thus freeing up those connections sooner.

117−-}

118−destroyConnectionPool

119− :: MonadUnliftIO io

120− => Pool (K Connection schemas) -- ^ pool

121− -> io ()

122−destroyConnectionPool = destroyAllResources

93+-- | `Applicative` instance for `PoolPQ`.

94+instance Monad m => Applicative (PoolPQ schemas m) where

95+ pure x = PoolPQ $ \ _ -> pure x

96+ PoolPQ f <*> PoolPQ x = PoolPQ $ \ pool -> do

97+ f' <- f pool

98+ x' <- x pool

99+ return $ f' x'

100+

101+-- | `Monad` instance for `PoolPQ`.

102+instance Monad m => Monad (PoolPQ schemas m) where

103+ return = pure

104+ PoolPQ x >>= f = PoolPQ $ \ pool -> do

105+ x' <- x pool

106+ runPoolPQ (f x') pool

107+

108+-- | `MonadTrans` instance for `PoolPQ`.

109+instance MonadTrans (PoolPQ schemas) where

110+ lift m = PoolPQ $ \ _pool -> m

111+

112+-- | `MonadBase` instance for `PoolPQ`.

113+instance MonadBase b m => MonadBase b (PoolPQ schemas m) where

114+ liftBase = lift . liftBase

115+

116+-- | `MonadPQ` instance for `PoolPQ`.

117+instance MonadBaseControl IO io => MonadPQ schemas (PoolPQ schemas io) where

118+ manipulateParams manipulation params = PoolPQ $ \ pool -> do

119+ withResource pool $ \ conn -> do

120+ (K result :: K (K Result ys) schemas) <- flip unPQ conn $

121+ manipulateParams manipulation params

122+ return result

123+ traversePrepared manipulation params = PoolPQ $ \ pool ->

124+ withResource pool $ \ conn -> do

125+ (K result :: K (list (K Result ys)) schemas) <- flip unPQ conn $

126+ traversePrepared manipulation params

127+ return result

128+ traversePrepared_ manipulation params = PoolPQ $ \ pool -> do

129+ withResource pool $ \ conn -> do

130+ (_ :: K () schemas) <- flip unPQ conn $

131+ traversePrepared_ manipulation params

132+ return ()

133+ liftPQ m = PoolPQ $ \ pool ->

134+ withResource pool $ \ conn -> do

135+ (K result :: K result schemas) <- flip unPQ conn $

136+ liftPQ m

137+ return result

138+

139+-- | A snapshot of the state of a `PoolPQ` computation.

140+type PoolPQRun schemas =

141+ forall m x. Monad m => PoolPQ schemas m x -> m x

142+

143+-- | Helper function in defining `MonadBaseControl` instance for `PoolPQ`.

144+poolpqliftWith :: Functor m => (PoolPQRun schemas -> m a) -> PoolPQ schemas m a

145+poolpqliftWith f = PoolPQ $ \ pool ->

146+ (f $ \ pq -> runPoolPQ pq pool)

147+

148+-- | `MonadBaseControl` instance for `PoolPQ`.

149+instance MonadBaseControl b m => MonadBaseControl b (PoolPQ schemas m) where

150+ type StM (PoolPQ schemas m) x = StM m x

151+ liftBaseWith f =

152+ poolpqliftWith $ \ run -> liftBaseWith $ \ runInBase -> f $ runInBase . run

153+ restoreM = PoolPQ . const . restoreM

squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+686−401

@@ -1,7 +1,7 @@

11{-|

22Module: Squeal.PostgreSQL.Query

33Description: Squeal queries

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

@@ -17,9 +17,7 @@ Squeal queries.

1717 , GeneralizedNewtypeDeriving

1818 , LambdaCase

1919 , MultiParamTypeClasses

20− , OverloadedLabels

2120 , OverloadedStrings

22− , QuantifiedConstraints

2321 , ScopedTypeVariables

2422 , StandaloneDeriving

2523 , TypeApplications

@@ -32,15 +30,13 @@ Squeal queries.

3230

3331module Squeal.PostgreSQL.Query

3432 ( -- * Queries

35− Query_

36− , Query (..)

33+ Query (..)

34+ , Query_

3735 -- ** Select

3836 , select

3937 , select_

4038 , selectDistinct

4139 , selectDistinct_

42− , selectDistinctOn

43− , selectDistinctOn_

4440 , Selection (..)

4541 -- ** Values

4642 , values

@@ -55,7 +51,23 @@ module Squeal.PostgreSQL.Query

5551 -- ** With

5652 , With (..)

5753 , CommonTableExpression (..)

58− , withRecursive

54+ , renderCommonTableExpression

55+ , renderCommonTableExpressions

56+ -- ** Json

57+ , jsonEach

58+ , jsonbEach

59+ , jsonEachAsText

60+ , jsonbEachAsText

61+ , jsonObjectKeys

62+ , jsonbObjectKeys

63+ , jsonPopulateRecord

64+ , jsonbPopulateRecord

65+ , jsonPopulateRecordSet

66+ , jsonbPopulateRecordSet

67+ , jsonToRecord

68+ , jsonbToRecord

69+ , jsonToRecordSet

70+ , jsonbToRecordSet

5971 -- * Table Expressions

6072 , TableExpression (..)

6173 , from

@@ -79,6 +91,33 @@ module Squeal.PostgreSQL.Query

7991 , By (..)

8092 , GroupByClause (..)

8193 , HavingClause (..)

94+ -- * Subquery Expressions

95+ , in_

96+ , rowIn

97+ , eqAll

98+ , rowEqAll

99+ , eqAny

100+ , rowEqAny

101+ , neqAll

102+ , rowNeqAll

103+ , neqAny

104+ , rowNeqAny

105+ , allLt

106+ , rowLtAll

107+ , ltAny

108+ , rowLtAny

109+ , lteAll

110+ , rowLteAll

111+ , lteAny

112+ , rowLteAny

113+ , gtAll

114+ , rowGtAll

115+ , gtAny

116+ , rowGtAny

117+ , gteAll

118+ , rowGteAll

119+ , gteAny

120+ , rowGteAny

82121 ) where

83122

84123import Control.DeepSeq

@@ -91,67 +130,13 @@ import GHC.TypeLits

91130

92131import qualified GHC.Generics as GHC

93132

94−import Squeal.PostgreSQL.Alias

95133import Squeal.PostgreSQL.Expression

96−import Squeal.PostgreSQL.Expression.Logic

97−import Squeal.PostgreSQL.Expression.Sort

98−import Squeal.PostgreSQL.Expression.Window

99−import Squeal.PostgreSQL.List

100−import Squeal.PostgreSQL.PG

101134import Squeal.PostgreSQL.Render

102135import Squeal.PostgreSQL.Schema

103136

104−-- $setup

105−-- >>> import Squeal.PostgreSQL

106−-- >>> import Data.Int (Int32, Int64)

107−-- >>> import Data.Monoid (Sum (..))

108−-- >>> import Data.Text (Text)

109−-- >>> import qualified Generics.SOP as SOP

110−

111137{- |

112−The process of retrieving or the command to retrieve data from

113−a database is called a `Query`.

114−

115−The general `Query` type is parameterized by

116−

117−* @outer :: FromType@ - outer scope for a correlated subquery,

118−* @commons :: FromType@ - scope for all `common` table expressions,

119−* @schemas :: SchemasType@ - scope for all `table`s and `view`s,

120−* @params :: [NullityType]@ - scope for all `Squeal.Expression.Parameter.parameter`s,

121−* @row :: RowType@ - return type of the `Query`.

122−-}

123−newtype Query

124− (outer :: FromType)

125− (commons :: FromType)

126− (schemas :: SchemasType)

127− (params :: [NullityType])

128− (row :: RowType)

129− = UnsafeQuery { renderQuery :: ByteString }

130− deriving (GHC.Generic,Show,Eq,Ord,NFData)

131−instance RenderSQL (Query outer commons schemas params row) where renderSQL = renderQuery

132−

133−{- |

134−The top level `Query_` type is parameterized by a @schemas@ `SchemasType`,

135−against which the query is type-checked, an input @parameters@ Haskell `Type`,

136−and an ouput row Haskell `Type`.

137−

138−A top-level query can be run

139−using `Squeal.PostgreSQL.PQ.runQueryParams`, or if @parameters = ()@

140−using `Squeal.PostgreSQL.PQ.runQuery`.

141−

142−Generally, @parameters@ will be a Haskell tuple or record whose entries

143−may be referenced using positional

144−`Squeal.PostgreSQL.Expression.Parameter.parameter`s and @row@ will be a

145−Haskell record, whose entries will be targeted using overloaded labels.

146−

147−Let's see some examples of queries.

148−

149−>>> :set -XDeriveAnyClass -XDerivingStrategies

150−>>> :{

151−data Row a b = Row { col1 :: a, col2 :: b }

152− deriving stock (GHC.Generic)

153− deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)

154−:}

138+The process of retrieving or the command to retrieve data from a database

139+is called a `Query`. Let's see some examples of queries.

155140

156141simple query:

157142

@@ -159,7 +144,7 @@ simple query:

159144>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

160145>>> :{

161146let

162− query :: Query_ (Public Schema) () (Row Int32 Int32)

147+ query :: Query '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

163148 query = select Star (from (table #tab))

164149in printSQL query

165150:}

@@ -169,21 +154,21 @@ restricted query:

169154

170155>>> :{

171156let

172− query :: Query_ (Public Schema) () (Row Int32 Int32)

157+ query :: Query '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4]

173158 query =

174− select_ ((#col1 + #col2) `as` #col1 :* #col1 `as` #col2)

159+ select_ ((#col1 + #col2) `as` #sum :* #col1)

175160 ( from (table #tab)

176161 & where_ (#col1 .> #col2)

177162 & where_ (#col2 .> 0) )

178163in printSQL query

179164:}

180−SELECT ("col1" + "col2") AS "col1", "col1" AS "col2" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))

165+SELECT ("col1" + "col2") AS "sum", "col1" AS "col1" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))

181166

182167subquery:

183168

184169>>> :{

185170let

186− query :: Query_ (Public Schema) () (Row Int32 Int32)

171+ query :: Query '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

187172 query = select Star (from (subquery (select Star (from (table #tab)) `as` #sub)))

188173in printSQL query

189174:}

@@ -193,7 +178,7 @@ limits and offsets:

193178

194179>>> :{

195180let

196− query :: Query_ (Public Schema) () (Row Int32 Int32)

181+ query :: Query '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

197182 query = select Star (from (table #tab) & limit 100 & offset 2 & limit 50 & offset 2)

198183in printSQL query

199184:}

@@ -203,7 +188,7 @@ parameterized query:

203188

204189>>> :{

205190let

206− query :: Query_ (Public Schema) (Only Int32) (Row Int32 Int32)

191+ query :: Query '[] (Public Schema) '[ 'NotNull 'PGint4] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

207192 query = select Star (from (table #tab) & where_ (#col1 .> param @1))

208193in printSQL query

209194:}

@@ -213,21 +198,21 @@ aggregation query:

213198

214199>>> :{

215200let

216− query :: Query_ (Public Schema) () (Row Int64 Int32)

201+ query :: Query '[] (Public Schema) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4 ]

217202 query =

218− select_ ((fromNull 0 (sum_ (All #col2))) `as` #col1 :* #col1 `as` #col2)

203+ select_ (sum_ #col2 `as` #sum :* #col1)

219204 ( from (table (#tab `as` #table1))

220205 & groupBy #col1

221− & having (sum_ (Distinct #col2) .> 1) )

206+ & having (#col1 + sum_ #col2 .> 1) )

222207in printSQL query

223208:}

224−SELECT COALESCE(sum(ALL "col2"), 0) AS "col1", "col1" AS "col2" FROM "tab" AS "table1" GROUP BY "col1" HAVING (sum(DISTINCT "col2") > 1)

209+SELECT sum("col2") AS "sum", "col1" AS "col1" FROM "tab" AS "table1" GROUP BY "col1" HAVING (("col1" + sum("col2")) > 1)

225210

226211sorted query:

227212

228213>>> :{

229214let

230− query :: Query_ (Public Schema) () (Row Int32 Int32)

215+ query :: Query '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

231216 query = select Star (from (table #tab) & orderBy [#col1 & Asc])

232217in printSQL query

233218:}

@@ -235,12 +220,14 @@ SELECT * FROM "tab" AS "tab" ORDER BY "col1" ASC

235220

236221joins:

237222

223+>>> :set -XFlexibleContexts

238224>>> :{

239225type OrdersColumns =

240226 '[ "id" ::: 'NoDef :=> 'NotNull 'PGint4

241− , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

242− , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

243− , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4 ]

227+ , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

228+ , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

229+ , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4

230+ ]

244231:}

245232

246233>>> :{

@@ -256,27 +243,22 @@ type OrdersConstraints =

256243>>> :{

257244type OrdersSchema =

258245 '[ "orders" ::: 'Table (OrdersConstraints :=> OrdersColumns)

259− , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

260− , "shippers" ::: 'Table (ShippersConstraints :=> NamesColumns) ]

261−:}

262−

263−>>> :{

264−data Order = Order

265− { price :: Float

266− , customerName :: Text

267− , shipperName :: Text

268− } deriving GHC.Generic

269−instance SOP.Generic Order

270−instance SOP.HasDatatypeInfo Order

246+ , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

247+ , "shippers" ::: 'Table (ShippersConstraints :=> NamesColumns) ]

271248:}

272249

273250>>> :{

274251let

275− query :: Query_ (Public OrdersSchema) () Order

252+ query :: Query '[] (Public OrdersSchema)

253+ '[]

254+ '[ "order_price" ::: 'NotNull 'PGfloat4

255+ , "customer_name" ::: 'NotNull 'PGtext

256+ , "shipper_name" ::: 'NotNull 'PGtext

257+ ]

276258 query = select_

277− ( #o ! #price `as` #price :*

278− #c ! #name `as` #customerName :*

279− #s ! #name `as` #shipperName )

259+ ( #o ! #price `as` #order_price :*

260+ #c ! #name `as` #customer_name :*

261+ #s ! #name `as` #shipper_name )

280262 ( from (table (#orders `as` #o)

281263 & innerJoin (table (#customers `as` #c))

282264 (#o ! #customer_id .== #c ! #id)

@@ -284,16 +266,14 @@ let

284266 (#o ! #shipper_id .== #s ! #id)) )

285267in printSQL query

286268:}

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")

269+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")

288270

289271self-join:

290272

291273>>> :{

292274let

293− query :: Query_ (Public Schema) () (Row Int32 Int32)

294− query = select

295− (#t1 & DotStar)

296− (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

275+ query :: Query '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

276+ query = select (#t1 & DotStar) (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

297277in printSQL query

298278:}

299279SELECT "t1".* FROM "tab" AS "t1" CROSS JOIN "tab" AS "t2"

@@ -302,19 +282,17 @@ value queries:

302282

303283>>> :{

304284let

305− query :: Query_ schemas () (Row String Bool)

306− query = values

307− ("true" `as` #col1 :* true `as` #col2)

308− ["false" `as` #col1 :* false `as` #col2]

285+ query :: Query commons schemas '[] '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

286+ query = values (1 `as` #foo :* true `as` #bar) [2 `as` #foo :* false `as` #bar]

309287in printSQL query

310288:}

311−SELECT * FROM (VALUES (E'true', TRUE), (E'false', FALSE)) AS t ("col1", "col2")

289+SELECT * FROM (VALUES (1, TRUE), (2, FALSE)) AS t ("foo", "bar")

312290

313291set operations:

314292

315293>>> :{

316294let

317− query :: Query_ (Public Schema) () (Row Int32 Int32)

295+ query :: Query '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

318296 query = select Star (from (table #tab)) `unionAll` select Star (from (table #tab))

319297in printSQL query

320298:}

@@ -324,7 +302,7 @@ with queries:

324302

325303>>> :{

326304let

327− query :: Query_ (Public Schema) () (Row Int32 Int32)

305+ query :: Query '[] (Public Schema) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

328306 query = with (

329307 select Star (from (table #tab)) `as` #cte1 :>>

330308 select Star (from (common #cte1)) `as` #cte2

@@ -337,42 +315,32 @@ window function queries

337315

338316>>> :{

339317let

340− query :: Query_ (Public Schema) () (Row Int32 Int64)

318+ query :: Query '[] (Public Schema) '[] ["col1" ::: 'NotNull 'PGint4, "rank" ::: 'NotNull 'PGint8]

341319 query = select

342− (#col1 & Also (rank `as` #col2 `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))

320+ (List #col1 & Also ((rank `as` #rank) `Over` (partitionBy (#col1 :* Nil) & orderBy [#col2 & Asc])))

343321 (from (table #tab))

344322in printSQL query

345323:}

346−SELECT "col1" AS "col1", rank() OVER (PARTITION BY "col1" ORDER BY "col2" ASC) AS "col2" FROM "tab" AS "tab"

347−

348−correlated subqueries

349−

350−>>> :{

351−let

352− query :: Query_ (Public Schema) () (Only Int32)

353− query =

354− select (#col1 `as` #fromOnly) (from (table (#tab `as` #t1))

355− & where_ (exists (

356− select Star (from (table (#tab `as` #t2))

357− & where_ (#t2 ! #col2 .== #t1 ! #col1)))))

358−in printSQL query

359−:}

360−SELECT "col1" AS "fromOnly" FROM "tab" AS "t1" WHERE EXISTS (SELECT * FROM "tab" AS "t2" WHERE ("t2"."col2" = "t1"."col1"))

361−

324+SELECT "col1" AS "col1", rank() OVER (PARTITION BY "col1" ORDER BY "col2" ASC) AS "rank" FROM "tab" AS "tab"

362325-}

363−type family Query_

326+newtype Query

327+ (commons :: FromType)

364328 (schemas :: SchemasType)

365− (parameters :: Type)

366− (row :: Type) where

367− Query_ schemas params row =

368− Query '[] '[] schemas (TuplePG params) (RowPG row)

329+ (params :: [NullityType])

330+ (row :: RowType)

331+ = UnsafeQuery { renderQuery :: ByteString }

332+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

333+instance RenderSQL (Query commons schemas params row) where renderSQL = renderQuery

334+

335+type family Query_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

336+ Query_ schemas params row = Query '[] schemas (TuplePG params) (RowPG row)

369337

370338-- | The results of two queries can be combined using the set operation

371339-- `union`. Duplicate rows are eliminated.

372340union

373− :: Query outer commons schemas params columns

374− -> Query outer commons schemas params columns

375− -> Query outer commons schemas params columns

341+ :: Query commons schemas params columns

342+ -> Query commons schemas params columns

343+ -> Query commons schemas params columns

376344q1 `union` q2 = UnsafeQuery $

377345 parenthesized (renderSQL q1)

378346 <+> "UNION"

@@ -381,9 +349,9 @@ q1 `union` q2 = UnsafeQuery $

381349-- | The results of two queries can be combined using the set operation

382350-- `unionAll`, the disjoint union. Duplicate rows are retained.

383351unionAll

384− :: Query outer commons schemas params columns

385− -> Query outer commons schemas params columns

386− -> Query outer commons schemas params columns

352+ :: Query commons schemas params columns

353+ -> Query commons schemas params columns

354+ -> Query commons schemas params columns

387355q1 `unionAll` q2 = UnsafeQuery $

388356 parenthesized (renderSQL q1)

389357 <+> "UNION" <+> "ALL"

@@ -392,9 +360,9 @@ q1 `unionAll` q2 = UnsafeQuery $

392360-- | The results of two queries can be combined using the set operation

393361-- `intersect`, the intersection. Duplicate rows are eliminated.

394362intersect

395− :: Query outer commons schemas params columns

396− -> Query outer commons schemas params columns

397− -> Query outer commons schemas params columns

363+ :: Query commons schemas params columns

364+ -> Query commons schemas params columns

365+ -> Query commons schemas params columns

398366q1 `intersect` q2 = UnsafeQuery $

399367 parenthesized (renderSQL q1)

400368 <+> "INTERSECT"

@@ -403,9 +371,9 @@ q1 `intersect` q2 = UnsafeQuery $

403371-- | The results of two queries can be combined using the set operation

404372-- `intersectAll`, the intersection. Duplicate rows are retained.

405373intersectAll

406− :: Query outer commons schemas params columns

407− -> Query outer commons schemas params columns

408− -> Query outer commons schemas params columns

374+ :: Query commons schemas params columns

375+ -> Query commons schemas params columns

376+ -> Query commons schemas params columns

409377q1 `intersectAll` q2 = UnsafeQuery $

410378 parenthesized (renderSQL q1)

411379 <+> "INTERSECT" <+> "ALL"

@@ -414,9 +382,9 @@ q1 `intersectAll` q2 = UnsafeQuery $

414382-- | The results of two queries can be combined using the set operation

415383-- `except`, the set difference. Duplicate rows are eliminated.

416384except

417− :: Query outer commons schemas params columns

418− -> Query outer commons schemas params columns

419− -> Query outer commons schemas params columns

385+ :: Query commons schemas params columns

386+ -> Query commons schemas params columns

387+ -> Query commons schemas params columns

420388q1 `except` q2 = UnsafeQuery $

421389 parenthesized (renderSQL q1)

422390 <+> "EXCEPT"

@@ -425,9 +393,9 @@ q1 `except` q2 = UnsafeQuery $

425393-- | The results of two queries can be combined using the set operation

426394-- `exceptAll`, the set difference. Duplicate rows are retained.

427395exceptAll

428− :: Query outer commons schemas params columns

429− -> Query outer commons schemas params columns

430− -> Query outer commons schemas params columns

396+ :: Query commons schemas params columns

397+ -> Query commons schemas params columns

398+ -> Query commons schemas params columns

431399q1 `exceptAll` q2 = UnsafeQuery $

432400 parenthesized (renderSQL q1)

433401 <+> "EXCEPT" <+> "ALL"

@@ -437,71 +405,54 @@ q1 `exceptAll` q2 = UnsafeQuery $

437405SELECT queries

438406-----------------------------------------}

439407

440−{- | The simplest kinds of `Selection` are `Star` and `DotStar` which

441−emits all columns that a `TableExpression` produces. A select `List`

442−is a list of `Expression`s. A `Selection` could be a list of

443−`WindowFunction`s `Over` `WindowDefinition`. `Additional` `Selection`s can

444−be selected with `Also`.

445−-}

446−data Selection outer commons grp schemas params from row where

408+data Selection grp commons schemas params from row where

409+ List

410+ :: SListI row

411+ => NP (Aliased (Expression grp commons schemas params from)) row

412+ -> Selection grp commons schemas params from row

447413 Star

448414 :: HasUnique tab from row

449− => Selection outer commons 'Ungrouped schemas params from row

450− -- ^ `HasUnique` table in the `FromClause`

415+ => Selection 'Ungrouped commons schemas params from row

451416 DotStar

452417 :: Has tab from row

453418 => Alias tab

454− -- ^ `Has` table with `Alias`

455− -> Selection outer commons 'Ungrouped schemas params from row

456− List

457− :: SListI row

458− => NP (Aliased (Expression outer commons grp schemas params from)) row

459− -- ^ `NP` list of `Aliased` `Expression`s

460− -> Selection outer commons grp schemas params from row

419+ -> Selection 'Ungrouped commons schemas params from row

420+ Also

421+ :: Selection grp commons schemas params from right

422+ -> Selection grp commons schemas params from left

423+ -> Selection grp commons schemas params from (Join left right)

461424 Over

462425 :: SListI row

463− => 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

466− -> Selection outer commons grp schemas params from row

467− Also

468− :: Selection outer commons grp schemas params from right

469− -- ^ `Additional` `Selection`

470− -> Selection outer commons grp schemas params from left

471− -> Selection outer commons grp schemas params from (Join left right)

472−instance Additional (Selection outer commons grp schemas params from) where

473− also = Also

426+ => NP (Aliased (WindowFunction grp commons schemas params from)) row

427+ -> WindowDefinition grp commons schemas params from

428+ -> Selection grp commons schemas params from row

474429instance (KnownSymbol col, row ~ '[col ::: ty])

475430 => Aliasable col

476− (Expression outer commons grp schemas params from ty)

477− (Selection outer commons grp schemas params from row) where

431+ (Expression grp commons schemas params from ty)

432+ (Selection grp commons schemas params from row) where

478433 expr `as` col = List (expr `as` col)

479−instance (Has tab (Join outer from) row0, Has col row0 ty, row1 ~ '[col ::: ty])

480− => IsQualified tab col

481− (Selection outer commons 'Ungrouped schemas params from row1) where

482− tab ! col = tab ! col `as` col

434+instance (Has tab from row0, Has col row0 ty, row1 ~ '[col ::: ty])

435+ => IsQualified tab col (Selection 'Ungrouped commons schemas params from row1) where

436+ tab ! col = tab ! col `as` col

483437instance

484− ( Has tab (Join outer from) row0

438+ ( Has tab from row0

485439 , Has col row0 ty

486440 , row1 ~ '[col ::: ty]

487441 , GroupedBy tab col bys )

488− => IsQualified tab col

489− (Selection outer commons ('Grouped bys) schemas params from row1) where

490− tab ! col = tab ! col `as` col

491−instance (HasUnique tab (Join outer from) row0, Has col row0 ty, row1 ~ '[col ::: ty])

492− => IsLabel col

493− (Selection outer commons 'Ungrouped schemas params from row1) where

494− fromLabel = fromLabel @col `as` Alias

442+ => IsQualified tab col (Selection ('Grouped bys) commons schemas params from row1) where

443+ tab ! col = tab ! col `as` col

444+instance (HasUnique tab from row0, Has col row0 ty, row1 ~ '[col ::: ty])

445+ => IsLabel col (Selection 'Ungrouped commons schemas params from row1) where

446+ fromLabel = fromLabel @col `as` Alias

495447instance

496− ( HasUnique tab (Join outer from) row0

448+ ( HasUnique tab from row0

497449 , Has col row0 ty

498450 , row1 ~ '[col ::: ty]

499451 , GroupedBy tab col bys )

500− => IsLabel col

501− (Selection outer commons ('Grouped bys) schemas params from row1) where

502− fromLabel = fromLabel @col `as` Alias

452+ => IsLabel col (Selection ('Grouped bys) commons schemas params from row1) where

453+ fromLabel = fromLabel @col `as` Alias

503454

504−instance RenderSQL (Selection outer commons grp schemas params from row) where

455+instance RenderSQL (Selection grp commons schemas params from row) where

505456 renderSQL = \case

506457 List list -> renderCommaSeparated (renderAliased renderSQL) list

507458 Star -> "*"

@@ -510,7 +461,7 @@ instance RenderSQL (Selection outer commons grp schemas params from row) where

510461 Over winFns winDef ->

511462 let

512463 renderOver

513− :: Aliased (WindowFunction outer commons grp schemas params from) field

464+ :: Aliased (WindowFunction grp commons schemas params from) field

514465 -> ByteString

515466 renderOver (winFn `As` col) = renderSQL winFn

516467 <+> "OVER" <+> parenthesized (renderSQL winDef)

@@ -518,10 +469,6 @@ instance RenderSQL (Selection outer commons grp schemas params from row) where

518469 in

519470 renderCommaSeparated renderOver winFns

520471

521−instance IsString

522− (Selection outer commons grp schemas params from '["fromOnly" ::: 'NotNull 'PGtext]) where

523− fromString str = fromString str `as` Alias

524−

525472-- | the `TableExpression` in the `select` command constructs an intermediate

526473-- virtual table by possibly combining tables, views, eliminating rows,

527474-- grouping, etc. This table is finally passed on to processing by

@@ -529,100 +476,45 @@ instance IsString

529476-- the intermediate table are actually output.

530477select

531478 :: (SListI row, row ~ (x ': xs))

532− => Selection outer commons grp schemas params from row

533− -- ^ selection

534− -> TableExpression outer commons grp schemas params from

479+ => Selection grp commons schemas params from row

480+ -- ^ select list

481+ -> TableExpression grp commons schemas params from

535482 -- ^ intermediate virtual table

536− -> Query outer commons schemas params row

483+ -> Query commons schemas params row

537484select selection tabexpr = UnsafeQuery $

538485 "SELECT"

539486 <+> renderSQL selection

540487 <+> renderSQL tabexpr

541488

542−-- | Like `select` but takes an `NP` list of `Expression`s instead

543−-- of a general `Selection`.

544489select_

545490 :: (SListI row, row ~ (x ': xs))

546− => NP (Aliased (Expression outer commons grp schemas params from)) row

547− -- ^ select list

548− -> TableExpression outer commons grp schemas params from

549− -- ^ intermediate virtual table

550− -> Query outer commons schemas params row

551−select_ = select . List

491+ => NP (Aliased (Expression grp commons schemas params from)) row

492+ -> TableExpression grp commons schemas params from

493+ -> Query commons schemas params row

494+select_ list = select (List list)

552495

553496-- | After the select list has been processed, the result table can

554497-- be subject to the elimination of duplicate rows using `selectDistinct`.

555498selectDistinct

556499 :: (SListI columns, columns ~ (col ': cols))

557− => Selection outer commons grp schemas params from columns

558− -- ^ selection

559− -> TableExpression outer commons grp schemas params from

500+ => Selection 'Ungrouped commons schemas params from columns

501+ -- ^ select list

502+ -> TableExpression 'Ungrouped commons schemas params from

560503 -- ^ intermediate virtual table

561− -> Query outer commons schemas params columns

504+ -> Query commons schemas params columns

562505selectDistinct selection tabexpr = UnsafeQuery $

563506 "SELECT DISTINCT"

564507 <+> renderSQL selection

565508 <+> renderSQL tabexpr

566509

567−-- | Like `selectDistinct` but takes an `NP` list of `Expression`s instead

568−-- of a general `Selection`.

569510selectDistinct_

570511 :: (SListI columns, columns ~ (col ': cols))

571− => NP (Aliased (Expression outer commons grp schemas params from)) columns

512+ => NP (Aliased (Expression 'Ungrouped commons schemas params from)) columns

572513 -- ^ select list

573− -> TableExpression outer commons grp schemas params from

574− -- ^ intermediate virtual table

575− -> Query outer commons schemas params columns

576−selectDistinct_ = selectDistinct . List

577−

578−{-|

579−`selectDistinctOn` keeps only the first row of each set of rows where

580−the given expressions evaluate to equal. The DISTINCT ON expressions are

581−interpreted using the same rules as for ORDER BY. ORDER BY is used to

582−ensure that the desired row appears first.

583−

584−The DISTINCT ON expression(s) must match the leftmost ORDER BY expression(s).

585−The ORDER BY clause will normally contain additional expression(s) that

586−determine the desired precedence of rows within each DISTINCT ON group.

587−

588−In order to guarantee they match and reduce redundancy, this function

589−will prepend the The DISTINCT ON expressions to the ORDER BY clause.

590−-}

591−selectDistinctOn

592− :: (SListI columns, columns ~ (col ': cols))

593− => [SortExpression outer commons grp schemas params from]

594− -- ^ DISTINCT ON expression(s) and prepended to ORDER BY clause

595− -> Selection outer commons grp schemas params from columns

596− -- ^ selection

597− -> TableExpression outer commons grp schemas params from

598− -- ^ intermediate virtual table

599− -> Query outer commons schemas params columns

600−selectDistinctOn distincts selection tab = UnsafeQuery $

601− "SELECT DISTINCT ON"

602− <+> parenthesized (commaSeparated (renderDistinctOn <$> distincts))

603− <+> renderSQL selection

604− <+> renderSQL (tab {orderByClause = distincts <> orderByClause tab})

605− where

606− renderDistinctOn = \case

607− Asc expression -> renderSQL expression

608− Desc expression -> renderSQL expression

609− AscNullsFirst expression -> renderSQL expression

610− DescNullsFirst expression -> renderSQL expression

611− AscNullsLast expression -> renderSQL expression

612− DescNullsLast expression -> renderSQL expression

613−

614−-- | Like `selectDistinctOn` but takes an `NP` list of `Expression`s instead

615−-- of a general `Selection`.

616−selectDistinctOn_

617− :: (SListI columns, columns ~ (col ': cols))

618− => [SortExpression outer commons grp schemas params from]

619− -- ^ distinct on and return the first row in ordering

620− -> NP (Aliased (Expression outer commons grp schemas params from)) columns

621− -- ^ selection

622− -> TableExpression outer commons grp schemas params from

514+ -> TableExpression 'Ungrouped commons schemas params from

623515 -- ^ intermediate virtual table

624− -> Query outer commons schemas params columns

625−selectDistinctOn_ distincts = selectDistinctOn distincts . List

516+ -> Query commons schemas params columns

517+selectDistinct_ list = select (List list)

626518

627519-- | `values` computes a row value or set of row values

628520-- specified by value expressions. It is most commonly used

@@ -630,16 +522,16 @@ selectDistinctOn_ distincts = selectDistinctOn distincts . List

630522-- but it can be used on its own.

631523--

632524-- >>> type Row = '["a" ::: 'NotNull 'PGint4, "b" ::: 'NotNull 'PGtext]

633−-- >>> let query = values (1 `as` #a :* "one" `as` #b) [] :: Query outer commons schemas '[] Row

525+-- >>> let query = values (1 `as` #a :* "one" `as` #b) [] :: Query commons schemas '[] Row

634526-- >>> printSQL query

635527-- SELECT * FROM (VALUES (1, E'one')) AS t ("a", "b")

636528values

637529 :: SListI cols

638− => NP (Aliased (Expression outer commons 'Ungrouped schemas params '[] )) cols

639− -> [NP (Aliased (Expression outer commons 'Ungrouped schemas params '[] )) cols]

530+ => NP (Aliased (Expression 'Ungrouped commons schemas params '[] )) cols

531+ -> [NP (Aliased (Expression 'Ungrouped commons schemas params '[] )) cols]

640532 -- ^ When more than one row is specified, all the rows must

641533 -- must have the same number of elements

642− -> Query outer commons schemas params cols

534+ -> Query commons schemas params cols

643535values rw rws = UnsafeQuery $ "SELECT * FROM"

644536 <+> parenthesized (

645537 "VALUES"

@@ -650,7 +542,7 @@ values rw rws = UnsafeQuery $ "SELECT * FROM"

650542 <+> parenthesized (renderCommaSeparated renderAliasPart rw)

651543 where

652544 renderAliasPart, renderValuePart

653− :: Aliased (Expression outer commons 'Ungrouped schemas params '[] ) ty -> ByteString

545+ :: Aliased (Expression 'Ungrouped commons schemas params '[] ) ty -> ByteString

654546 renderAliasPart (_ `As` name) = renderSQL name

655547 renderValuePart (value `As` _) = renderSQL value

656548

@@ -658,9 +550,9 @@ values rw rws = UnsafeQuery $ "SELECT * FROM"

658550-- specified by value expressions.

659551values_

660552 :: SListI cols

661− => NP (Aliased (Expression outer commons 'Ungrouped schemas params '[] )) cols

553+ => NP (Aliased (Expression 'Ungrouped commons schemas params '[] )) cols

662554 -- ^ one row of values

663− -> Query outer commons schemas params cols

555+ -> Query commons schemas params cols

664556values_ rw = values rw []

665557

666558{-----------------------------------------

@@ -674,17 +566,16 @@ Table Expressions

674566-- to a table on disk, a so-called base table, but more complex expressions

675567-- can be used to modify or combine base tables in various ways.

676568data TableExpression

677− (outer :: FromType)

678− (commons :: FromType)

679569 (grp :: Grouping)

570+ (commons :: FromType)

680571 (schemas :: SchemasType)

681572 (params :: [NullityType])

682573 (from :: FromType)

683574 = TableExpression

684− { fromClause :: FromClause outer commons schemas params from

575+ { fromClause :: FromClause commons schemas params from

685576 -- ^ A table reference that can be a table name, or a derived table such

686577 -- as a subquery, a @JOIN@ construct, or complex combinations of these.

687− , whereClause :: [Condition outer commons 'Ungrouped schemas params from]

578+ , whereClause :: [Condition 'Ungrouped commons schemas params from]

688579 -- ^ optional search coditions, combined with `.&&`. After the processing

689580 -- of the `fromClause` is done, each row of the derived virtual table

690581 -- is checked against the search condition. If the result of the

@@ -700,13 +591,13 @@ data TableExpression

700591 -- set of rows having common values into one group row that represents all

701592 -- rows in the group. This is done to eliminate redundancy in the output

702593 -- and/or compute aggregates that apply to these groups.

703− , havingClause :: HavingClause outer commons grp schemas params from

594+ , havingClause :: HavingClause grp commons schemas params from

704595 -- ^ If a table has been grouped using `groupBy`, but only certain groups

705596 -- are of interest, the `havingClause` can be used, much like a

706597 -- `whereClause`, to eliminate groups from the result. Expressions in the

707598 -- `havingClause` can refer both to grouped expressions and to ungrouped

708599 -- expressions (which necessarily involve an aggregate function).

709− , orderByClause :: [SortExpression outer commons grp schemas params from]

600+ , orderByClause :: [SortExpression grp commons schemas params from]

710601 -- ^ The `orderByClause` is for optional sorting. When more than one

711602 -- `SortExpression` is specified, the later (right) values are used to sort

712603 -- rows that are equal according to the earlier (left) values.

@@ -716,14 +607,14 @@ data TableExpression

716607 -- will be returned (but possibly fewer, if the query itself yields

717608 -- fewer rows).

718609 , offsetClause :: [Word64]

719− -- ^ The `offsetClause` is combined with `Prelude.+` to give an offset count

610+ -- ^ The `offsetClause` is combined with `+` to give an offset count

720611 -- if nonempty. The offset count says to skip that many rows before

721612 -- beginning to return rows. The rows are skipped before the limit count

722613 -- is applied.

723− } deriving (GHC.Generic)

614+ }

724615

725616-- | Render a `TableExpression`

726−instance RenderSQL (TableExpression outer commons grp schemas params from) where

617+instance RenderSQL (TableExpression grp commons schemas params from) where

727618 renderSQL

728619 (TableExpression frm' whs' grps' hvs' srts' lims' offs') = mconcat

729620 [ "FROM ", renderSQL frm'

@@ -732,7 +623,8 @@ instance RenderSQL (TableExpression outer commons grp schemas params from) where

732623 , renderSQL hvs'

733624 , renderOrderByClause srts'

734625 , renderLimits lims'

735− , renderOffsets offs' ]

626+ , renderOffsets offs'

627+ ]

736628 where

737629 renderWheres = \case

738630 [] -> ""

@@ -752,33 +644,33 @@ instance RenderSQL (TableExpression outer commons grp schemas params from) where

752644-- | A `from` generates a `TableExpression` from a table reference that can be

753645-- a table name, or a derived table such as a subquery, a JOIN construct,

754646-- or complex combinations of these. A `from` may be transformed by `where_`,

755−-- `groupBy`, `having`, `orderBy`, `limit` and `offset`, using the `&` operator

647+-- `group`, `having`, `orderBy`, `limit` and `offset`, using the `&` operator

756648-- to match the left-to-right sequencing of their placement in SQL.

757649from

758− :: FromClause outer commons schemas params from -- ^ table reference

759− -> TableExpression outer commons 'Ungrouped schemas params from

760−from tab = TableExpression tab [] noGroups NoHaving [] [] []

650+ :: FromClause commons schemas params from -- ^ table reference

651+ -> TableExpression 'Ungrouped commons schemas params from

652+from rels = TableExpression rels [] NoGroups NoHaving [] [] []

761653

762654-- | A `where_` is an endomorphism of `TableExpression`s which adds a

763655-- search condition to the `whereClause`.

764656where_

765− :: Condition outer commons 'Ungrouped schemas params from -- ^ filtering condition

766− -> TableExpression outer commons grp schemas params from

767− -> TableExpression outer commons grp schemas params from

657+ :: Condition 'Ungrouped commons schemas params from -- ^ filtering condition

658+ -> TableExpression grp commons schemas params from

659+ -> TableExpression grp commons schemas params from

768660where_ wh rels = rels {whereClause = wh : whereClause rels}

769661

770662-- | A `groupBy` is a transformation of `TableExpression`s which switches

771−-- its `Grouping` from `Ungrouped` to `Grouped`. Use @groupBy Nil@ to perform

663+-- its `Grouping` from `Ungrouped` to `Grouped`. Use @group Nil@ to perform

772664-- a "grand total" aggregation query.

773665groupBy

774666 :: SListI bys

775667 => NP (By from) bys -- ^ grouped columns

776− -> TableExpression outer commons 'Ungrouped schemas params from

777− -> TableExpression outer commons ('Grouped bys) schemas params from

668+ -> TableExpression 'Ungrouped commons schemas params from

669+ -> TableExpression ('Grouped bys) commons schemas params from

778670groupBy bys rels = TableExpression

779671 { fromClause = fromClause rels

780672 , whereClause = whereClause rels

781− , groupByClause = group bys

673+ , groupByClause = Group bys

782674 , havingClause = Having []

783675 , orderByClause = []

784676 , limitClause = limitClause rels

@@ -788,9 +680,9 @@ groupBy bys rels = TableExpression

788680-- | A `having` is an endomorphism of `TableExpression`s which adds a

789681-- search condition to the `havingClause`.

790682having

791− :: Condition outer commons ('Grouped bys) schemas params from -- ^ having condition

792− -> TableExpression outer commons ('Grouped bys) schemas params from

793− -> TableExpression outer commons ('Grouped bys) schemas params from

683+ :: Condition ('Grouped bys) commons schemas params from -- ^ having condition

684+ -> TableExpression ('Grouped bys) commons schemas params from

685+ -> TableExpression ('Grouped bys) commons schemas params from

794686having hv rels = rels

795687 { havingClause = case havingClause rels of Having hvs -> Having (hv:hvs) }

796688

@@ -801,18 +693,159 @@ instance OrderBy TableExpression where

801693-- `limitClause`.

802694limit

803695 :: Word64 -- ^ limit parameter

804− -> TableExpression outer commons grp schemas params from

805− -> TableExpression outer commons grp schemas params from

696+ -> TableExpression grp commons schemas params from

697+ -> TableExpression grp commons schemas params from

806698limit lim rels = rels {limitClause = lim : limitClause rels}

807699

808700-- | An `offset` is an endomorphism of `TableExpression`s which adds to the

809701-- `offsetClause`.

810702offset

811703 :: Word64 -- ^ offset parameter

812− -> TableExpression outer commons grp schemas params from

813− -> TableExpression outer commons grp schemas params from

704+ -> TableExpression grp commons schemas params from

705+ -> TableExpression grp commons schemas params from

814706offset off rels = rels {offsetClause = off : offsetClause rels}

815707

708+{-----------------------------------------

709+JSON stuff

710+-----------------------------------------}

711+

712+unsafeSetOfFunction

713+ :: ByteString

714+ -> Expression 'Ungrouped commons schemas params '[] ty

715+ -> Query commons schemas params row

716+unsafeSetOfFunction fun expr = UnsafeQuery $

717+ "SELECT * FROM " <> fun <> "(" <> renderSQL expr <> ")"

718+

719+-- | Expands the outermost JSON object into a set of key/value pairs.

720+jsonEach

721+ :: Expression 'Ungrouped commons schemas params '[] (nullity 'PGjson) -- ^ json object

722+ -> Query commons schemas params

723+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]

724+jsonEach = unsafeSetOfFunction "json_each"

725+

726+-- | Expands the outermost binary JSON object into a set of key/value pairs.

727+jsonbEach

728+ :: Expression 'Ungrouped commons schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

729+ -> Query commons schemas params

730+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjsonb]

731+jsonbEach = unsafeSetOfFunction "jsonb_each"

732+

733+-- | Expands the outermost JSON object into a set of key/value pairs.

734+jsonEachAsText

735+ :: Expression 'Ungrouped commons schemas params '[] (nullity 'PGjson) -- ^ json object

736+ -> Query commons schemas params

737+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

738+jsonEachAsText = unsafeSetOfFunction "json_each_text"

739+

740+-- | Expands the outermost binary JSON object into a set of key/value pairs.

741+jsonbEachAsText

742+ :: Expression 'Ungrouped commons schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

743+ -> Query commons schemas params

744+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

745+jsonbEachAsText = unsafeSetOfFunction "jsonb_each_text"

746+

747+-- | Returns set of keys in the outermost JSON object.

748+jsonObjectKeys

749+ :: Expression 'Ungrouped commons schemas params '[] (nullity 'PGjson) -- ^ json object

750+ -> Query commons schemas params '["json_object_keys" ::: 'NotNull 'PGtext]

751+jsonObjectKeys = unsafeSetOfFunction "json_object_keys"

752+

753+-- | Returns set of keys in the outermost JSON object.

754+jsonbObjectKeys

755+ :: Expression 'Ungrouped commons schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

756+ -> Query commons schemas params '["jsonb_object_keys" ::: 'NotNull 'PGtext]

757+jsonbObjectKeys = unsafeSetOfFunction "jsonb_object_keys"

758+

759+unsafePopulateFunction

760+ :: ByteString

761+ -> TypeExpression schemas (nullity ('PGcomposite row))

762+ -> Expression 'Ungrouped commons schemas params '[] ty

763+ -> Query commons schemas params row

764+unsafePopulateFunction fun ty expr = UnsafeQuery $

765+ "SELECT * FROM " <> fun <> "("

766+ <> "null::" <> renderSQL ty <> ", "

767+ <> renderSQL expr <> ")"

768+

769+-- | Expands the JSON expression to a row whose columns match the record

770+-- type defined by the given table.

771+jsonPopulateRecord

772+ :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

773+ -> Expression 'Ungrouped commons schemas params '[] (nullity 'PGjson) -- ^ json object

774+ -> Query commons schemas params row

775+jsonPopulateRecord = unsafePopulateFunction "json_populate_record"

776+

777+-- | Expands the binary JSON expression to a row whose columns match the record

778+-- type defined by the given table.

779+jsonbPopulateRecord

780+ :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

781+ -> Expression 'Ungrouped commons schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

782+ -> Query commons schemas params row

783+jsonbPopulateRecord = unsafePopulateFunction "jsonb_populate_record"

784+

785+-- | Expands the outermost array of objects in the given JSON expression to a

786+-- set of rows whose columns match the record type defined by the given table.

787+jsonPopulateRecordSet

788+ :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

789+ -> Expression 'Ungrouped commons schemas params '[] (nullity 'PGjson) -- ^ json array

790+ -> Query commons schemas params row

791+jsonPopulateRecordSet = unsafePopulateFunction "json_populate_record_set"

792+

793+-- | Expands the outermost array of objects in the given binary JSON expression

794+-- to a set of rows whose columns match the record type defined by the given

795+-- table.

796+jsonbPopulateRecordSet

797+ :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

798+ -> Expression 'Ungrouped commons schemas params '[] (nullity 'PGjsonb) -- ^ jsonb array

799+ -> Query commons schemas params row

800+jsonbPopulateRecordSet = unsafePopulateFunction "jsonb_populate_record_set"

801+

802+unsafeRecordFunction

803+ :: (SListI record, json `In` PGJsonType)

804+ => ByteString

805+ -> Expression 'Ungrouped commons schemas params '[] (nullity json)

806+ -> NP (Aliased (TypeExpression schemas)) record

807+ -> Query commons schemas params record

808+unsafeRecordFunction fun expr types = UnsafeQuery $

809+ "SELECT * FROM " <> fun <> "("

810+ <> renderSQL expr <> ")"

811+ <+> "AS" <+> "x" <> parenthesized (renderCommaSeparated renderTy types)

812+ where

813+ renderTy :: Aliased (TypeExpression schemas) ty -> ByteString

814+ renderTy (ty `As` alias) =

815+ renderSQL alias <+> renderSQL ty

816+

817+-- | Builds an arbitrary record from a JSON object.

818+jsonToRecord

819+ :: SListI record

820+ => Expression 'Ungrouped commons schemas params '[] (nullity 'PGjson) -- ^ json object

821+ -> NP (Aliased (TypeExpression schemas)) record -- ^ record types

822+ -> Query commons schemas params record

823+jsonToRecord = unsafeRecordFunction "json_to_record"

824+

825+-- | Builds an arbitrary record from a binary JSON object.

826+jsonbToRecord

827+ :: SListI record

828+ => Expression 'Ungrouped commons schemas params '[] (nullity 'PGjsonb) -- ^ jsonb object

829+ -> NP (Aliased (TypeExpression schemas)) record -- ^ record types

830+ -> Query commons schemas params record

831+jsonbToRecord = unsafeRecordFunction "jsonb_to_record"

832+

833+-- | Builds an arbitrary set of records from a JSON array of objects.

834+jsonToRecordSet

835+ :: SListI record

836+ => Expression 'Ungrouped commons schemas params '[] (nullity 'PGjson) -- ^ json array

837+ -> NP (Aliased (TypeExpression schemas)) record -- ^ record types

838+ -> Query commons schemas params record

839+jsonToRecordSet = unsafeRecordFunction "json_to_record_set"

840+

841+-- | Builds an arbitrary set of records from a binary JSON array of objects.

842+jsonbToRecordSet

843+ :: SListI record

844+ => Expression 'Ungrouped commons schemas params '[] (nullity 'PGjsonb) -- ^ jsonb array

845+ -> NP (Aliased (TypeExpression schemas)) record -- ^ record types

846+ -> Query commons schemas params record

847+jsonbToRecordSet = unsafeRecordFunction "jsonb_to_record_set"

848+

816849{-----------------------------------------

817850FROM clauses

818851-----------------------------------------}

@@ -821,59 +854,53 @@ FROM clauses

821854A `FromClause` can be a table name, or a derived table such

822855as a subquery, a @JOIN@ construct, or complex combinations of these.

823856-}

824−newtype FromClause outer commons schemas params from

857+newtype FromClause commons schemas params from

825858 = UnsafeFromClause { renderFromClause :: ByteString }

826859 deriving (GHC.Generic,Show,Eq,Ord,NFData)

827−instance RenderSQL (FromClause outer commons schemas params from) where

860+instance RenderSQL (FromClause commons schemas params from) where

828861 renderSQL = renderFromClause

829862

830863-- | A real `table` is a table from the database.

831864table

832865 :: (Has sch schemas schema, Has tab schema ('Table table))

833866 => Aliased (QualifiedAlias sch) (alias ::: tab)

834− -> FromClause outer commons schemas params '[alias ::: TableToRow table]

867+ -> FromClause commons schemas params '[alias ::: TableToRow table]

835868table (tab `As` alias) = UnsafeFromClause $

836869 renderSQL tab <+> "AS" <+> renderSQL alias

837870

838871-- | `subquery` derives a table from a `Query`.

839872subquery

840− :: Aliased (Query outer commons schemas params) query

841− -> FromClause outer commons schemas params '[query]

842−subquery = UnsafeFromClause . renderAliased (parenthesized . renderSQL)

873+ :: Aliased (Query commons schemas params) query

874+ -> FromClause commons schemas params '[query]

875+subquery = UnsafeFromClause . renderAliased (parenthesized . renderQuery)

843876

844877-- | `view` derives a table from a `View`.

845878view

846879 :: (Has sch schemas schema, Has vw schema ('View view))

847880 => Aliased (QualifiedAlias sch) (alias ::: vw)

848− -> FromClause outer commons schemas params '[alias ::: view]

881+ -> FromClause commons schemas params '[alias ::: view]

849882view (vw `As` alias) = UnsafeFromClause $

850883 renderSQL vw <+> "AS" <+> renderSQL alias

851884

852−-- | `common` derives a table from a common table expression.

853885common

854886 :: Has cte commons common

855887 => Aliased Alias (alias ::: cte)

856− -> FromClause outer commons schemas params '[alias ::: common]

888+ -> FromClause commons schemas params '[alias ::: common]

857889common (cte `As` alias) = UnsafeFromClause $

858890 renderSQL cte <+> "AS" <+> renderSQL alias

859891

860−instance Additional (FromClause outer commons schemas params) where

861− also right left = UnsafeFromClause $

862− renderSQL left <> ", " <> renderSQL right

863−

864−{- |

865−@left & crossJoin right@. For every possible combination of rows from

866−@left@ and @right@ (i.e., a Cartesian product), the joined table will contain

867−a row consisting of all columns in @left@ followed by all columns in @right@.

868−If the tables have @n@ and @m@ rows respectively, the joined table will

869−have @n * m@ rows.

892+{- | @left & crossJoin right@. For every possible combination of rows from

893+ @left@ and @right@ (i.e., a Cartesian product), the joined table will contain

894+ a row consisting of all columns in @left@ followed by all columns in @right@.

895+ If the tables have @n@ and @m@ rows respectively, the joined table will

896+ have @n * m@ rows.

870897-}

871898crossJoin

872− :: FromClause outer commons schemas params right

899+ :: FromClause commons schemas params right

873900 -- ^ right

874− -> FromClause outer commons schemas params left

901+ -> FromClause commons schemas params left

875902 -- ^ left

876− -> FromClause outer commons schemas params (Join left right)

903+ -> FromClause commons schemas params (Join left right)

877904crossJoin right left = UnsafeFromClause $

878905 renderSQL left <+> "CROSS JOIN" <+> renderSQL right

879906

@@ -881,13 +908,13 @@ crossJoin right left = UnsafeFromClause $

881908the @on@ condition.

882909-}

883910innerJoin

884− :: FromClause outer commons schemas params right

911+ :: FromClause commons schemas params right

885912 -- ^ right

886− -> Condition outer commons 'Ungrouped schemas params (Join left right)

913+ -> Condition 'Ungrouped commons schemas params (Join left right)

887914 -- ^ @on@ condition

888− -> FromClause outer commons schemas params left

915+ -> FromClause commons schemas params left

889916 -- ^ left

890− -> FromClause outer commons schemas params (Join left right)

917+ -> FromClause commons schemas params (Join left right)

891918innerJoin right on left = UnsafeFromClause $

892919 renderSQL left <+> "INNER JOIN" <+> renderSQL right

893920 <+> "ON" <+> renderSQL on

@@ -898,13 +925,13 @@ innerJoin right on left = UnsafeFromClause $

898925 Thus, the joined table always has at least one row for each row in @left@.

899926-}

900927leftOuterJoin

901− :: FromClause outer commons schemas params right

928+ :: FromClause commons schemas params right

902929 -- ^ right

903− -> Condition outer commons 'Ungrouped schemas params (Join left right)

930+ -> Condition 'Ungrouped commons schemas params (Join left right)

904931 -- ^ @on@ condition

905− -> FromClause outer commons schemas params left

932+ -> FromClause commons schemas params left

906933 -- ^ left

907− -> FromClause outer commons schemas params (Join left (NullifyFrom right))

934+ -> FromClause commons schemas params (Join left (NullifyFrom right))

908935leftOuterJoin right on left = UnsafeFromClause $

909936 renderSQL left <+> "LEFT OUTER JOIN" <+> renderSQL right

910937 <+> "ON" <+> renderSQL on

@@ -916,13 +943,13 @@ leftOuterJoin right on left = UnsafeFromClause $

916943 have a row for each row in @right@.

917944-}

918945rightOuterJoin

919− :: FromClause outer commons schemas params right

946+ :: FromClause commons schemas params right

920947 -- ^ right

921− -> Condition outer commons 'Ungrouped schemas params (Join left right)

948+ -> Condition 'Ungrouped commons schemas params (Join left right)

922949 -- ^ @on@ condition

923− -> FromClause outer commons schemas params left

950+ -> FromClause commons schemas params left

924951 -- ^ left

925− -> FromClause outer commons schemas params (Join (NullifyFrom left) right)

952+ -> FromClause commons schemas params (Join (NullifyFrom left) right)

926953rightOuterJoin right on left = UnsafeFromClause $

927954 renderSQL left <+> "RIGHT OUTER JOIN" <+> renderSQL right

928955 <+> "ON" <+> renderSQL on

@@ -935,13 +962,13 @@ rightOuterJoin right on left = UnsafeFromClause $

935962 is added.

936963-}

937964fullOuterJoin

938− :: FromClause outer commons schemas params right

965+ :: FromClause commons schemas params right

939966 -- ^ right

940− -> Condition outer commons 'Ungrouped schemas params (Join left right)

967+ -> Condition 'Ungrouped commons schemas params (Join left right)

941968 -- ^ @on@ condition

942− -> FromClause outer commons schemas params left

969+ -> FromClause commons schemas params left

943970 -- ^ left

944− -> FromClause outer commons schemas params

971+ -> FromClause commons schemas params

945972 (Join (NullifyFrom left) (NullifyFrom right))

946973fullOuterJoin right on left = UnsafeFromClause $

947974 renderSQL left <+> "FULL OUTER JOIN" <+> renderSQL right

@@ -951,7 +978,7 @@ fullOuterJoin right on left = UnsafeFromClause $

951978Grouping

952979-----------------------------------------}

953980

954−-- | `By`s are used in `groupBy` to reference a list of columns which are then

981+-- | `By`s are used in `group` to reference a list of columns which are then

955982-- used to group together those rows in a table that have the same values

956983-- in all the columns listed. @By \#col@ will reference an unambiguous

957984-- column @col@; otherwise @By2 (\#tab \! \#col)@ will reference a table

@@ -992,42 +1019,309 @@ instance (Has rel rels cols, Has col cols ty, bys ~ '[ '(rel, col)])

9921019-- done on @NoGroups@ while all output `Expression`s must be aggregated

9931020-- in @Group Nil@. In general, all output `Expression`s in the

9941021-- complement of @bys@ must be aggregated in @Group bys@.

995−newtype GroupByClause grp from = UnsafeGroupByClause

996− { renderGroupByClause :: ByteString }

997− deriving (GHC.Generic,Show,Eq,Ord,NFData)

1022+data GroupByClause grp from where

1023+ NoGroups :: GroupByClause 'Ungrouped from

1024+ Group

1025+ :: SListI bys

1026+ => NP (By from) bys

1027+ -> GroupByClause ('Grouped bys) from

1028+

1029+-- | Renders a `GroupByClause`.

9981030instance RenderSQL (GroupByClause grp from) where

999− renderSQL = renderGroupByClause

1000−noGroups :: GroupByClause 'Ungrouped from

1001−noGroups = UnsafeGroupByClause ""

1002−group

1003− :: SListI bys

1004− => NP (By from) bys

1005− -> GroupByClause ('Grouped bys) from

1006−group bys = UnsafeGroupByClause $ case bys of

1007− Nil -> ""

1008− bys' -> " GROUP BY" <+> renderCommaSeparated renderSQL bys'

1031+ renderSQL = \case

1032+ NoGroups -> ""

1033+ Group Nil -> ""

1034+ Group bys -> " GROUP BY" <+> renderCommaSeparated renderSQL bys

10091035

10101036-- | A `HavingClause` is used to eliminate groups that are not of interest.

10111037-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`

10121038-- `TableExpression` must use `Having` whose conditions are combined with

10131039-- `.&&`.

1014−data HavingClause outer commons grp schemas params from where

1015− NoHaving :: HavingClause outer commons 'Ungrouped schemas params from

1040+data HavingClause grp commons schemas params from where

1041+ NoHaving :: HavingClause 'Ungrouped commons schemas params from

10161042 Having

1017− :: [Condition outer commons ('Grouped bys) schemas params from]

1018− -> HavingClause outer commons ('Grouped bys) schemas params from

1019−deriving instance Show (HavingClause outer commons grp schemas params from)

1020−deriving instance Eq (HavingClause outer commons grp schemas params from)

1021−deriving instance Ord (HavingClause outer commons grp schemas params from)

1043+ :: [Condition ('Grouped bys) commons schemas params from]

1044+ -> HavingClause ('Grouped bys) commons schemas params from

1045+deriving instance Show (HavingClause grp commons schemas params from)

1046+deriving instance Eq (HavingClause grp commons schemas params from)

1047+deriving instance Ord (HavingClause grp commons schemas params from)

10221048

10231049-- | Render a `HavingClause`.

1024−instance RenderSQL (HavingClause outer commons grp schemas params from) where

1050+instance RenderSQL (HavingClause grp commons schemas params from) where

10251051 renderSQL = \case

10261052 NoHaving -> ""

10271053 Having [] -> ""

10281054 Having conditions ->

10291055 " HAVING" <+> commaSeparated (renderSQL <$> conditions)

10301056

1057+unsafeSubqueryExpression

1058+ :: ByteString

1059+ -> Expression grp commons schemas params from ty

1060+ -> Query commons schemas params '[alias ::: ty]

1061+ -> Expression grp commons schemas params from (nullity 'PGbool)

1062+unsafeSubqueryExpression op x q = UnsafeExpression $

1063+ renderSQL x <+> op <+> parenthesized (renderSQL q)

1064+

1065+unsafeRowSubqueryExpression

1066+ :: SListI row

1067+ => ByteString

1068+ -> NP (Aliased (Expression grp commons schemas params from)) row

1069+ -> Query commons schemas params row

1070+ -> Expression grp commons schemas params from (nullity 'PGbool)

1071+unsafeRowSubqueryExpression op xs q = UnsafeExpression $

1072+ renderSQL (row xs) <+> op <+> parenthesized (renderSQL q)

1073+

1074+-- | The right-hand side is a sub`Query`, which must return exactly one column.

1075+-- The left-hand expression is evaluated and compared to each row of the

1076+-- sub`Query` result. The result of `in_` is `true` if any equal subquery row is found.

1077+-- The result is `false` if no equal row is found

1078+-- (including the case where the subquery returns no rows).

1079+--

1080+-- >>> printSQL $ true `in_` values_ (true `as` #foo)

1081+-- TRUE IN (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1082+in_

1083+ :: Expression grp commons schemas params from ty -- ^ expression

1084+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1085+ -> Expression grp commons schemas params from (nullity 'PGbool)

1086+in_ = unsafeSubqueryExpression "IN"

1087+

1088+{- | The left-hand side of this form of `rowIn` is a row constructor.

1089+The right-hand side is a sub`Query`,

1090+which must return exactly as many columns as

1091+there are expressions in the left-hand row.

1092+The left-hand expressions are evaluated and compared row-wise to each row

1093+of the subquery result. The result of `rowIn`

1094+is `true` if any equal subquery row is found.

1095+The result is `false` if no equal row is found

1096+(including the case where the subquery returns no rows).

1097+

1098+>>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1099+>>> printSQL $ myRow `rowIn` values_ myRow

1100+ROW(1, FALSE) IN (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1101+-}

1102+rowIn

1103+ :: SListI row

1104+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1105+ -> Query commons schemas params row -- ^ subquery

1106+ -> Expression grp commons schemas params from (nullity 'PGbool)

1107+rowIn = unsafeRowSubqueryExpression "IN"

1108+

1109+-- | >>> printSQL $ true `eqAll` values_ (true `as` #foo)

1110+-- TRUE = ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1111+eqAll

1112+ :: Expression grp commons schemas params from ty -- ^ expression

1113+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1114+ -> Expression grp commons schemas params from (nullity 'PGbool)

1115+eqAll = unsafeSubqueryExpression "= ALL"

1116+

1117+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1118+-- >>> printSQL $ myRow `rowEqAll` values_ myRow

1119+-- ROW(1, FALSE) = ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1120+rowEqAll

1121+ :: SListI row

1122+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1123+ -> Query commons schemas params row -- ^ subquery

1124+ -> Expression grp commons schemas params from (nullity 'PGbool)

1125+rowEqAll = unsafeRowSubqueryExpression "= ALL"

1126+

1127+-- | >>> printSQL $ true `eqAny` values_ (true `as` #foo)

1128+-- TRUE = ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1129+eqAny

1130+ :: Expression grp commons schemas params from ty -- ^ expression

1131+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1132+ -> Expression grp commons schemas params from (nullity 'PGbool)

1133+eqAny = unsafeSubqueryExpression "= ANY"

1134+

1135+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1136+-- >>> printSQL $ myRow `rowEqAny` values_ myRow

1137+-- ROW(1, FALSE) = ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1138+rowEqAny

1139+ :: SListI row

1140+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1141+ -> Query commons schemas params row -- ^ subquery

1142+ -> Expression grp commons schemas params from (nullity 'PGbool)

1143+rowEqAny = unsafeRowSubqueryExpression "= ANY"

1144+

1145+-- | >>> printSQL $ true `neqAll` values_ (true `as` #foo)

1146+-- TRUE <> ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1147+neqAll

1148+ :: Expression grp commons schemas params from ty -- ^ expression

1149+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1150+ -> Expression grp commons schemas params from (nullity 'PGbool)

1151+neqAll = unsafeSubqueryExpression "<> ALL"

1152+

1153+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1154+-- >>> printSQL $ myRow `rowNeqAll` values_ myRow

1155+-- ROW(1, FALSE) <> ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1156+rowNeqAll

1157+ :: SListI row

1158+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1159+ -> Query commons schemas params row -- ^ subquery

1160+ -> Expression grp commons schemas params from (nullity 'PGbool)

1161+rowNeqAll = unsafeRowSubqueryExpression "<> ALL"

1162+

1163+-- | >>> printSQL $ true `neqAny` values_ (true `as` #foo)

1164+-- TRUE <> ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1165+neqAny

1166+ :: Expression grp commons schemas params from ty -- ^ expression

1167+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1168+ -> Expression grp commons schemas params from (nullity 'PGbool)

1169+neqAny = unsafeSubqueryExpression "<> ANY"

1170+

1171+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1172+-- >>> printSQL $ myRow `rowNeqAny` values_ myRow

1173+-- ROW(1, FALSE) <> ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1174+rowNeqAny

1175+ :: SListI row

1176+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1177+ -> Query commons schemas params row -- ^ subquery

1178+ -> Expression grp commons schemas params from (nullity 'PGbool)

1179+rowNeqAny = unsafeRowSubqueryExpression "<> ANY"

1180+

1181+-- | >>> printSQL $ true `allLt` values_ (true `as` #foo)

1182+-- TRUE ALL < (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1183+allLt

1184+ :: Expression grp commons schemas params from ty -- ^ expression

1185+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1186+ -> Expression grp commons schemas params from (nullity 'PGbool)

1187+allLt = unsafeSubqueryExpression "ALL <"

1188+

1189+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1190+-- >>> printSQL $ myRow `rowLtAll` values_ myRow

1191+-- ROW(1, FALSE) ALL < (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1192+rowLtAll

1193+ :: SListI row

1194+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1195+ -> Query commons schemas params row -- ^ subquery

1196+ -> Expression grp commons schemas params from (nullity 'PGbool)

1197+rowLtAll = unsafeRowSubqueryExpression "ALL <"

1198+

1199+-- | >>> printSQL $ true `ltAny` values_ (true `as` #foo)

1200+-- TRUE ANY < (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1201+ltAny

1202+ :: Expression grp commons schemas params from ty -- ^ expression

1203+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1204+ -> Expression grp commons schemas params from (nullity 'PGbool)

1205+ltAny = unsafeSubqueryExpression "ANY <"

1206+

1207+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1208+-- >>> printSQL $ myRow `rowLtAll` values_ myRow

1209+-- ROW(1, FALSE) ALL < (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1210+rowLtAny

1211+ :: SListI row

1212+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1213+ -> Query commons schemas params row -- ^ subquery

1214+ -> Expression grp commons schemas params from (nullity 'PGbool)

1215+rowLtAny = unsafeRowSubqueryExpression "ANY <"

1216+

1217+-- | >>> printSQL $ true `lteAll` values_ (true `as` #foo)

1218+-- TRUE <= ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1219+lteAll

1220+ :: Expression grp commons schemas params from ty -- ^ expression

1221+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1222+ -> Expression grp commons schemas params from (nullity 'PGbool)

1223+lteAll = unsafeSubqueryExpression "<= ALL"

1224+

1225+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1226+-- >>> printSQL $ myRow `rowLteAll` values_ myRow

1227+-- ROW(1, FALSE) <= ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1228+rowLteAll

1229+ :: SListI row

1230+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1231+ -> Query commons schemas params row -- ^ subquery

1232+ -> Expression grp commons schemas params from (nullity 'PGbool)

1233+rowLteAll = unsafeRowSubqueryExpression "<= ALL"

1234+

1235+-- | >>> printSQL $ true `lteAny` values_ (true `as` #foo)

1236+-- TRUE <= ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1237+lteAny

1238+ :: Expression grp commons schemas params from ty -- ^ expression

1239+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1240+ -> Expression grp commons schemas params from (nullity 'PGbool)

1241+lteAny = unsafeSubqueryExpression "<= ANY"

1242+

1243+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1244+-- >>> printSQL $ myRow `rowLteAny` values_ myRow

1245+-- ROW(1, FALSE) <= ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1246+rowLteAny

1247+ :: SListI row

1248+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1249+ -> Query commons schemas params row -- ^ subquery

1250+ -> Expression grp commons schemas params from (nullity 'PGbool)

1251+rowLteAny = unsafeRowSubqueryExpression "<= ANY"

1252+

1253+-- | >>> printSQL $ true `gtAll` values_ (true `as` #foo)

1254+-- TRUE > ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1255+gtAll

1256+ :: Expression grp commons schemas params from ty -- ^ expression

1257+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1258+ -> Expression grp commons schemas params from (nullity 'PGbool)

1259+gtAll = unsafeSubqueryExpression "> ALL"

1260+

1261+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1262+-- >>> printSQL $ myRow `rowGtAll` values_ myRow

1263+-- ROW(1, FALSE) > ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1264+rowGtAll

1265+ :: SListI row

1266+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1267+ -> Query commons schemas params row -- ^ subquery

1268+ -> Expression grp commons schemas params from (nullity 'PGbool)

1269+rowGtAll = unsafeRowSubqueryExpression "> ALL"

1270+

1271+-- | >>> printSQL $ true `gtAny` values_ (true `as` #foo)

1272+-- TRUE > ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1273+gtAny

1274+ :: Expression grp commons schemas params from ty -- ^ expression

1275+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1276+ -> Expression grp commons schemas params from (nullity 'PGbool)

1277+gtAny = unsafeSubqueryExpression "> ANY"

1278+

1279+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1280+-- >>> printSQL $ myRow `rowGtAny` values_ myRow

1281+-- ROW(1, FALSE) > ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1282+rowGtAny

1283+ :: SListI row

1284+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1285+ -> Query commons schemas params row -- ^ subquery

1286+ -> Expression grp commons schemas params from (nullity 'PGbool)

1287+rowGtAny = unsafeRowSubqueryExpression "> ANY"

1288+

1289+-- | >>> printSQL $ true `gteAll` values_ (true `as` #foo)

1290+-- TRUE >= ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1291+gteAll

1292+ :: Expression grp commons schemas params from ty -- ^ expression

1293+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1294+ -> Expression grp commons schemas params from (nullity 'PGbool)

1295+gteAll = unsafeSubqueryExpression ">= ALL"

1296+

1297+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1298+-- >>> printSQL $ myRow `rowGteAll` values_ myRow

1299+-- ROW(1, FALSE) >= ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1300+rowGteAll

1301+ :: SListI row

1302+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1303+ -> Query commons schemas params row -- ^ subquery

1304+ -> Expression grp commons schemas params from (nullity 'PGbool)

1305+rowGteAll = unsafeRowSubqueryExpression ">= ALL"

1306+

1307+-- | >>> printSQL $ true `gteAny` values_ (true `as` #foo)

1308+-- TRUE >= ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1309+gteAny

1310+ :: Expression grp commons schemas params from ty -- ^ expression

1311+ -> Query commons schemas params '[alias ::: ty] -- ^ subquery

1312+ -> Expression grp commons schemas params from (nullity 'PGbool)

1313+gteAny = unsafeSubqueryExpression ">= ANY"

1314+

1315+-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression grp commons schemas params from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1316+-- >>> printSQL $ myRow `rowGteAny` values_ myRow

1317+-- ROW(1, FALSE) >= ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1318+rowGteAny

1319+ :: SListI row

1320+ => NP (Aliased (Expression grp commons schemas params from)) row -- ^ row constructor

1321+ -> Query commons schemas params row -- ^ subquery

1322+ -> Expression grp commons schemas params from (nullity 'PGbool)

1323+rowGteAny = unsafeRowSubqueryExpression ">= ANY"

1324+

10311325-- | A `CommonTableExpression` is an auxiliary statement in a `with` clause.

10321326data CommonTableExpression statement

10331327 (schemas :: SchemasType)

@@ -1049,50 +1343,41 @@ instance

10491343 , commons1 ~ (cte ::: common ': commons)

10501344 ) => Aliasable cte

10511345 (statement commons schemas params common)

1052− (Path (CommonTableExpression statement schemas params) commons commons1) where

1053− statement `as` cte = csingleton (statement `as` cte)

1054−

1055−instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

1056− (CommonTableExpression statement schemas params commons0 commons1) where

1057− renderSQL (CommonTableExpression (statement `As` cte)) =

1058− renderSQL cte <+> "AS" <+> parenthesized (renderSQL statement)

1346+ (AlignedList (CommonTableExpression statement schemas params) commons commons1) where

1347+ statement `as` cte = single (statement `as` cte)

1348+

1349+-- | render a `CommonTableExpression`.

1350+renderCommonTableExpression

1351+ :: (forall cs ss ps row. statement cs ss ps row -> ByteString) -- ^ render statement

1352+ -> CommonTableExpression statement schemas params commons0 commons1 -> ByteString

1353+renderCommonTableExpression renderStatement

1354+ (CommonTableExpression (statement `As` alias)) =

1355+ renderSQL alias <+> "AS" <+> parenthesized (renderStatement statement)

1356+

1357+-- | render a non-empty `AlignedList` of `CommonTableExpression`s.

1358+renderCommonTableExpressions

1359+ :: (forall cs ss ps row. statement cs ss ps row -> ByteString) -- ^ render statement

1360+ -> CommonTableExpression statement schemas params commons0 commons1

1361+ -> AlignedList (CommonTableExpression statement schemas params) commons1 commons2

1362+ -> ByteString

1363+renderCommonTableExpressions renderStatement cte ctes =

1364+ renderCommonTableExpression renderStatement cte <> case ctes of

1365+ Done -> ""

1366+ cte' :>> ctes' -> "," <+>

1367+ renderCommonTableExpressions renderStatement cte' ctes'

10591368

10601369-- | `with` provides a way to write auxiliary statements for use in a larger query.

10611370-- These statements, referred to as `CommonTableExpression`s, can be thought of as

10621371-- defining temporary tables that exist just for one query.

10631372class With statement where

10641373 with

1065− :: Path (CommonTableExpression statement schemas params) commons0 commons1

1374+ :: AlignedList (CommonTableExpression statement schemas params) commons0 commons1

10661375 -- ^ common table expressions

10671376 -> statement commons1 schemas params row

10681377 -- ^ larger query

10691378 -> statement commons0 schemas params row

1070−instance With (Query outer) where

1379+instance With Query where

10711380 with Done query = query

1072− with ctes query = UnsafeQuery $

1073− "WITH" <+> commaSeparated (ctoList renderSQL ctes) <+> renderSQL query

1074−

1075−{- |

1076−>>> import Data.Monoid (Sum (..))

1077−>>> import Data.Int (Int64)

1078−>>> :{

1079− let

1080− query :: Query_ schema () (Sum Int64)

1081− query = withRecursive

1082− ( values_ ((1 & astype int) `as` #n)

1083− `unionAll`

1084− select_ ((#n + 1) `as` #n)

1085− (from (common #t) & where_ (#n .< 100)) `as` #t )

1086− ( select_ (fromNull 0 (sum_ (All #n)) `as` #getSum) (from (common #t) & groupBy Nil))

1087− in printSQL query

1088−:}

1089−WITH RECURSIVE "t" AS ((SELECT * FROM (VALUES ((1 :: int))) AS t ("n")) UNION ALL (SELECT ("n" + 1) AS "n" FROM "t" AS "t" WHERE ("n" < 100))) SELECT COALESCE(sum(ALL "n"), 0) AS "getSum" FROM "t" AS "t"

1090−-}

1091−withRecursive

1092− :: Aliased (Query outer (recursive ': commons) schemas params) recursive

1093− -> Query outer (recursive ': commons) schemas params row

1094− -> Query outer commons schemas params row

1095−withRecursive (recursive `As` cte) query = UnsafeQuery $

1096− "WITH RECURSIVE" <+> renderSQL cte

1097− <+> "AS" <+> parenthesized (renderSQL recursive)

1098− <+> renderSQL query

1381+ with (cte :>> ctes) query = UnsafeQuery $

1382+ "WITH" <+> renderCommonTableExpressions renderSQL cte ctes

1383+ <+> renderSQL query

squeal-postgresql/src/Squeal/PostgreSQL/Render.hs+11−46

@@ -10,47 +10,40 @@ Rendering helper functions.

1010

1111{-# LANGUAGE

1212 AllowAmbiguousTypes

13− , ConstraintKinds

1413 , FlexibleContexts

15− , LambdaCase

1614 , MagicHash

1715 , OverloadedStrings

1816 , PolyKinds

1917 , RankNTypes

2018 , ScopedTypeVariables

21− , TypeApplications

2219#-}

2320

2421module Squeal.PostgreSQL.Render

2522 ( -- * Render

26− RenderSQL (..)

27− , printSQL

28− , escape

29− , parenthesized

30− , bracketed

23+ parenthesized

3124 , (<+>)

3225 , commaSeparated

3326 , doubleQuoted

3427 , singleQuotedText

3528 , singleQuotedUtf8

3629 , renderCommaSeparated

37− , renderCommaSeparatedConstraint

3830 , renderCommaSeparatedMaybe

3931 , renderNat

4032 , renderSymbol

33+ , RenderSQL (..)

34+ , printSQL

4135 ) where

4236

43−import Control.Monad.IO.Class (MonadIO (..))

37+import Control.Monad.Base

4438import Data.ByteString (ByteString)

4539import Data.Maybe (catMaybes)

4640import Data.Monoid ((<>))

4741import Data.Text (Text)

4842import Generics.SOP

4943import GHC.Exts

50−import GHC.TypeLits hiding (Text)

51−

52−import qualified Data.Text as Text

53−import qualified Data.Text.Encoding as Text

44+import GHC.TypeLits

45+import qualified Data.Text as T

46+import qualified Data.Text.Encoding as T

5447import qualified Data.ByteString as ByteString

5548import qualified Data.ByteString.Char8 as Char8

5649

@@ -58,10 +51,6 @@ import qualified Data.ByteString.Char8 as Char8

5851parenthesized :: ByteString -> ByteString

5952parenthesized str = "(" <> str <> ")"

6053

61−-- | Square bracket a `ByteString`

62−bracketed :: ByteString -> ByteString

63−bracketed str = "[" <> str <> "]"

64−

6554-- | Concatenate two `ByteString`s with a space between.

6655(<+>) :: ByteString -> ByteString -> ByteString

6756infixr 7 <+>

@@ -77,12 +66,11 @@ doubleQuoted str = "\"" <> str <> "\""

7766

7867-- | Add single quotes around a `Text` and escape single quotes within it.

7968singleQuotedText :: Text -> ByteString

80−singleQuotedText str =

81− "'" <> Text.encodeUtf8 (Text.replace "'" "''" str) <> "'"

69+singleQuotedText str = "'" <> T.encodeUtf8 (T.replace "'" "''" str) <> "'"

8270

8371-- | Add single quotes around a `ByteString` and escape single quotes within it.

8472singleQuotedUtf8 :: ByteString -> ByteString

85−singleQuotedUtf8 = singleQuotedText . Text.decodeUtf8

73+singleQuotedUtf8 = singleQuotedText . T.decodeUtf8

8674

8775-- | Comma separate the renderings of a heterogeneous list.

8876renderCommaSeparated

@@ -94,16 +82,6 @@ renderCommaSeparated render

9482 . hcollapse

9583 . hmap (K . render)

9684

97−-- | Comma separate the renderings of a heterogeneous list.

98−renderCommaSeparatedConstraint

99− :: forall c xs expression. (All c xs, SListI xs)

100− => (forall x. c x => expression x -> ByteString)

101− -> NP expression xs -> ByteString

102−renderCommaSeparatedConstraint render

103− = commaSeparated

104− . hcollapse

105− . hcmap (Proxy @c) (K . render)

106−

10785-- | Comma separate the `Maybe` renderings of a heterogeneous list, dropping

10886-- `Nothing`s.

10987renderCommaSeparatedMaybe

@@ -128,18 +106,5 @@ renderSymbol = fromString (symbolVal' (proxy# :: Proxy# s))

128106class RenderSQL sql where renderSQL :: sql -> ByteString

129107

130108-- | Print SQL.

131−printSQL :: (RenderSQL sql, MonadIO io) => sql -> io ()

132−printSQL = liftIO . Char8.putStrLn . renderSQL

133−

134−-- | `escape` a character to prevent injection

135−escape :: Char -> String

136−escape = \case

137− '\NUL' -> "\\0"

138− '\'' -> "''"

139− '"' -> "\\\""

140− '\b' -> "\\b"

141− '\n' -> "\\n"

142− '\r' -> "\\r"

143− '\t' -> "\\t"

144− '\\' -> "\\\\"

145− c -> [c]

109+printSQL :: (RenderSQL sql, MonadBase IO io) => sql -> io ()

110+printSQL = liftBase . Char8.putStrLn . renderSQL

squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+484−207

@@ -1,15 +1,16 @@

11{-|

22Module: Squeal.PostgreSQL.Schema

33Description: Embedding of PostgreSQL type and alias system

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

8−`Squeal.PostgreSQL.Schema` provides a type-level DSL for kinds of Postgres types,

8+This module provides a type-level DSL for kinds of Postgres types,

99tables, schema, constraints, aliases, enumerated labels, and groupings.

1010It also defines useful type families to operate on these. Finally,

1111it defines an embedding of Haskell types into Postgres types.

1212-}

13+{-# OPTIONS_GHC -fno-warn-unticked-promoted-constructors #-}

1314{-# LANGUAGE

1415 AllowAmbiguousTypes

1516 , ConstraintKinds

@@ -21,7 +22,6 @@ it defines an embedding of Haskell types into Postgres types.

2122 , GADTs

2223 , LambdaCase

2324 , OverloadedStrings

24− , QuantifiedConstraints

2525 , RankNTypes

2626 , ScopedTypeVariables

2727 , StandaloneDeriving

@@ -39,15 +39,16 @@ module Squeal.PostgreSQL.Schema

3939 , NullityType (..)

4040 , RowType

4141 , FromType

42+ -- * Haskell to Postgres Types

43+ , PG

44+ , NullPG

45+ , TuplePG

46+ , RowPG

4247 -- * Schema Types

4348 , ColumnType

4449 , ColumnsType

4550 , TableType

4651 , SchemumType (..)

47− , IndexType (..)

48− , FunctionType

49− , OperatorType (..)

50− , ReturnsType (..)

5152 , SchemaType

5253 , SchemasType

5354 , Public

@@ -57,30 +58,52 @@ module Squeal.PostgreSQL.Schema

5758 , TableConstraint (..)

5859 , TableConstraints

5960 , Uniquely

61+ -- * Aliases

62+ , (:::)

63+ , Alias (..)

64+ , IsLabel (..)

65+ , Aliased (As)

66+ , Aliasable (as)

67+ , renderAliased

68+ , Has

69+ , HasUnique

70+ , HasAll

71+ , QualifiedAlias (..)

72+ , IsQualified (..)

73+ , HasIn

74+ , IsNotElem

75+ , AllUnique

76+ , DefaultAliasable (..)

6077 -- * Enumerated Labels

6178 , IsPGlabel (..)

6279 , PGlabel (..)

80+ , LabelsPG

81+ -- * Grouping

82+ , Grouping (..)

83+ , GroupedBy

84+ -- * Aligned lists

85+ , AlignedList (..)

86+ , single

6387 -- * Data Definitions

6488 , Create

65− , CreateIfNotExists

66− , CreateOrReplace

6789 , Drop

68− , DropSchemum

69− , DropIfExists

70− , DropSchemumIfExists

7190 , Alter

72− , AlterIfExists

7391 , Rename

74− , RenameIfExists

75− , ConstraintInvolves

7692 , DropIfConstraintsInvolve

77− , IsNotElem

78− , AllUnique

93+ -- * Lists

94+ , Join

95+ , Elem

96+ , In

97+ , Length

7998 -- * Type Classifications

99+ , HasOid (..)

80100 , PGNum

81101 , PGIntegral

82102 , PGFloating

83103 , PGTypeOf

104+ , PGArrayOf

105+ , PGArray

106+ , PGTextArray

84107 , PGJsonType

85108 , PGJsonKey

86109 , SamePGType

@@ -97,22 +120,36 @@ module Squeal.PostgreSQL.Schema

97120 ) where

98121

99122import Control.Category

123+import Control.DeepSeq

124+import Data.Aeson (Value)

125+import Data.ByteString (ByteString)

126+import Data.Int (Int16, Int32, Int64)

100127import Data.Kind

101128import Data.Monoid hiding (All)

129+import Data.Scientific (Scientific)

130+import Data.String

131+import Data.Text (Text)

132+import Data.Time

133+import Data.Word (Word16, Word32, Word64)

102134import Data.Type.Bool

135+import Data.UUID.Types (UUID)

103136import Generics.SOP

137+import Generics.SOP.Record

138+import GHC.OverloadedLabels

104139import GHC.TypeLits

140+import Network.IP.Addr

105141import Prelude hiding (id, (.))

106142

107−import Squeal.PostgreSQL.Alias

108−import Squeal.PostgreSQL.List

109−import Squeal.PostgreSQL.Render

143+import qualified Data.ByteString.Lazy as Lazy

144+import qualified Data.Text.Lazy as Lazy

145+import qualified GHC.Generics as GHC

146+import qualified Generics.SOP.Type.Metadata as Type

110147

111−-- $setup

112−-- >>> import Squeal.PostgreSQL

148+import Squeal.PostgreSQL.Render

113149

114150-- | `PGType` is the promoted datakind of PostgreSQL types.

115151--

152+-- >>> import Squeal.PostgreSQL.Schema

116153-- >>> :kind 'PGbool

117154-- 'PGbool :: PGType

118155data PGType

@@ -123,7 +160,6 @@ data PGType

123160 | PGnumeric -- ^ arbitrary precision numeric type

124161 | PGfloat4 -- ^ single precision floating-point number (4 bytes)

125162 | PGfloat8 -- ^ double precision floating-point number (8 bytes)

126− | PGmoney -- ^ currency amount

127163 | PGchar Nat -- ^ fixed-length character string

128164 | PGvarchar Nat -- ^ variable-length character string

129165 | PGtext -- ^ variable-length character string

@@ -142,12 +178,36 @@ data PGType

142178 | PGfixarray [Nat] NullityType -- ^ fixed length array

143179 | PGenum [Symbol] -- ^ enumerated (enum) types are data types that comprise a static, ordered set of values.

144180 | 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.

146− | PGtsquery -- ^ A tsquery value stores lexemes that are to be searched for.

147− | PGoid -- Object identifiers (OIDs) are used internally by PostgreSQL as primary keys for various system tables.

148− | PGrange PGType -- ^ Range types are data types representing a range of values of some element type (called the range's subtype).

149181 | UnsafePGType Symbol -- ^ an escape hatch for unsupported PostgreSQL types

150182

183+-- | The object identifier of a `PGType`.

184+--

185+-- >>> :set -XTypeApplications

186+-- >>> oid @'PGbool

187+-- 16

188+class HasOid (ty :: PGType) where oid :: Word32

189+instance HasOid 'PGbool where oid = 16

190+instance HasOid 'PGint2 where oid = 21

191+instance HasOid 'PGint4 where oid = 23

192+instance HasOid 'PGint8 where oid = 20

193+instance HasOid 'PGnumeric where oid = 1700

194+instance HasOid 'PGfloat4 where oid = 700

195+instance HasOid 'PGfloat8 where oid = 701

196+instance HasOid ('PGchar n) where oid = 18

197+instance HasOid ('PGvarchar n) where oid = 1043

198+instance HasOid 'PGtext where oid = 25

199+instance HasOid 'PGbytea where oid = 17

200+instance HasOid 'PGtimestamp where oid = 1114

201+instance HasOid 'PGtimestamptz where oid = 1184

202+instance HasOid 'PGdate where oid = 1082

203+instance HasOid 'PGtime where oid = 1083

204+instance HasOid 'PGtimetz where oid = 1266

205+instance HasOid 'PGinterval where oid = 1186

206+instance HasOid 'PGuuid where oid = 2950

207+instance HasOid 'PGinet where oid = 869

208+instance HasOid 'PGjson where oid = 114

209+instance HasOid 'PGjsonb where oid = 3802

210+

151211-- | `NullityType` encodes the potential presence or definite absence of a

152212-- @NULL@ allowing operations which are sensitive to such to be well typed.

153213--

@@ -166,6 +226,11 @@ data NullityType

166226type (:=>) constraint ty = '(constraint,ty)

167227infixr 7 :=>

168228

229+-- | The alias operator `:::` is like a promoted version of `As`,

230+-- a type level pair between an alias and some type.

231+type (:::) (alias :: Symbol) ty = '(alias,ty)

232+infixr 6 :::

233+

169234-- | `ColumnConstraint` encodes the availability of @DEFAULT@ for inserts and updates.

170235-- A column can be assigned a default value.

171236-- A data `Squeal.PostgreSQL.Manipulations.Manipulation` command can also

@@ -207,13 +272,7 @@ data TableConstraint

207272 | PrimaryKey [Symbol]

208273 | ForeignKey [Symbol] Symbol [Symbol]

209274

210−{- | A `TableConstraints` is a row of `TableConstraint`s.

211−

212−>>> :{

213−type family UsersConstraints :: TableConstraints where

214− UsersConstraints = '[ "pk_users" ::: 'PrimaryKey '["id"] ]

215−:}

216−-}

275+-- | A `TableConstraints` is a row of `TableConstraint`s.

217276type TableConstraints = [(Symbol,TableConstraint)]

218277

219278-- | A `ForeignKey` must reference columns that either are

@@ -239,7 +298,7 @@ type family Uniquely

239298type TableType = (TableConstraints,ColumnsType)

240299

241300{- | A `RowType` is a row of `NullityType`. They correspond to Haskell

242−record types by means of `Squeal.PostgreSQL.Binary.RowPG` and are used in many places.

301+record types by means of `RowPG` and are used in many places.

243302

244303>>> :{

245304type family PersonRow :: RowType where

@@ -260,19 +319,9 @@ type FromType = [(Symbol,RowType)]

260319

261320-- | `ColumnsToRow` removes column constraints.

262321type 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

275322 ColumnsToRow '[] = '[]

323+ ColumnsToRow (column ::: constraint :=> ty ': columns) =

324+ column ::: ty ': ColumnsToRow columns

276325

277326-- | `TableToColumns` removes table constraints.

278327type family TableToColumns (table :: TableType) :: ColumnsType where

@@ -282,6 +331,188 @@ type family TableToColumns (table :: TableType) :: ColumnsType where

282331type family TableToRow (table :: TableType) :: RowType where

283332 TableToRow tab = ColumnsToRow (TableToColumns tab)

284333

334+-- | `Grouping` is an auxiliary namespace, created by

335+-- @GROUP BY@ clauses (`Squeal.PostgreSQL.Query.group`), and used

336+-- for typesafe aggregation

337+data Grouping

338+ = Ungrouped -- ^ no aggregation permitted

339+ | Grouped [(Symbol,Symbol)] -- ^ aggregation required for any column which is not grouped

340+

341+{- | A `GroupedBy` constraint indicates that a table qualified column is

342+a member of the auxiliary namespace created by @GROUP BY@ clauses and thus,

343+may be called in an output `Squeal.PostgreSQL.Expression.Expression` without aggregating.

344+-}

345+class (KnownSymbol table, KnownSymbol column)

346+ => GroupedBy table column bys where

347+instance {-# OVERLAPPING #-} (KnownSymbol table, KnownSymbol column)

348+ => GroupedBy table column ('(table,column) ': bys)

349+instance {-# OVERLAPPABLE #-}

350+ ( KnownSymbol table

351+ , KnownSymbol column

352+ , GroupedBy table column bys

353+ ) => GroupedBy table column (tabcol ': bys)

354+

355+-- | `Alias`es are proxies for a type level string or `Symbol`

356+-- and have an `IsLabel` instance so that with @-XOverloadedLabels@

357+--

358+-- >>> :set -XOverloadedLabels

359+-- >>> #foobar :: Alias "foobar"

360+-- Alias

361+data Alias (alias :: Symbol) = Alias

362+ deriving (Eq,GHC.Generic,Ord,Show,NFData)

363+instance alias1 ~ alias2 => IsLabel alias1 (Alias alias2) where

364+ fromLabel = Alias

365+instance aliases ~ '[alias] => IsLabel alias (NP Alias aliases) where

366+ fromLabel = fromLabel :* Nil

367+-- | >>> printSQL (#jimbob :: Alias "jimbob")

368+-- "jimbob"

369+instance KnownSymbol alias => RenderSQL (Alias alias) where

370+ renderSQL = doubleQuoted . fromString . symbolVal

371+

372+-- | >>> import Generics.SOP (NP(..))

373+-- >>> printSQL (#jimbob :* #kandi :: NP Alias '["jimbob", "kandi"])

374+-- "jimbob", "kandi"

375+instance All KnownSymbol aliases => RenderSQL (NP Alias aliases) where

376+ renderSQL

377+ = commaSeparated

378+ . hcollapse

379+ . hcmap (Proxy @KnownSymbol) (K . renderSQL)

380+

381+-- | The `As` operator is used to name an expression. `As` is like a demoted

382+-- version of `:::`.

383+--

384+-- >>> Just "hello" `As` #hi :: Aliased Maybe ("hi" ::: String)

385+-- As (Just "hello") Alias

386+data Aliased expression aliased where

387+ As

388+ :: KnownSymbol alias

389+ => expression ty

390+ -> Alias alias

391+ -> Aliased expression (alias ::: ty)

392+deriving instance Show (expression ty)

393+ => Show (Aliased expression (alias ::: ty))

394+deriving instance Eq (expression ty)

395+ => Eq (Aliased expression (alias ::: ty))

396+deriving instance Ord (expression ty)

397+ => Ord (Aliased expression (alias ::: ty))

398+instance (alias0 ~ alias1, alias0 ~ alias2, KnownSymbol alias2)

399+ => IsLabel alias0 (Aliased Alias (alias1 ::: alias2)) where

400+ fromLabel = fromLabel @alias2 `As` fromLabel @alias1

401+

402+-- | The `Aliasable` class provides a way to scrap your `Nil`s

403+-- in an `NP` list of `Aliased` expressions.

404+class KnownSymbol alias => Aliasable alias expression aliased

405+ | aliased -> expression

406+ , aliased -> alias

407+ where as :: expression -> Alias alias -> aliased

408+instance (KnownSymbol alias, aliased ~ (alias ::: ty)) => Aliasable alias

409+ (expression ty)

410+ (Aliased expression aliased)

411+ where

412+ as = As

413+instance (KnownSymbol alias, tys ~ '[alias ::: ty]) => Aliasable alias

414+ (expression ty)

415+ (NP (Aliased expression) tys)

416+ where

417+ expression `as` alias = expression `As` alias :* Nil

418+

419+-- | >>> let renderMaybe = fromString . maybe "Nothing" (const "Just")

420+-- >>> renderAliased renderMaybe (Just (3::Int) `As` #an_int)

421+-- "Just AS \"an_int\""

422+renderAliased

423+ :: (forall ty. expression ty -> ByteString)

424+ -> Aliased expression aliased

425+ -> ByteString

426+renderAliased render (expression `As` alias) =

427+ render expression <> " AS " <> renderSQL alias

428+

429+-- | @HasUnique alias fields field@ is a constraint that proves that

430+-- @fields@ is a singleton of @alias ::: field@.

431+type HasUnique alias fields field = fields ~ '[alias ::: field]

432+

433+-- | @Has alias fields field@ is a constraint that proves that

434+-- @fields@ has a field of @alias ::: field@, inferring @field@

435+-- from @alias@ and @fields@.

436+class KnownSymbol alias =>

437+ Has (alias :: Symbol) (fields :: [(Symbol,kind)]) (field :: kind)

438+ | alias fields -> field where

439+instance {-# OVERLAPPING #-} KnownSymbol alias

440+ => Has alias (alias ::: field ': fields) field

441+instance {-# OVERLAPPABLE #-} (KnownSymbol alias, Has alias fields field)

442+ => Has alias (field' ': fields) field

443+

444+class HasIn fields (x :: (Symbol, a)) where

445+instance (Has alias fields field) => HasIn fields '(alias, field) where

446+

447+-- | Utility class for `AllUnique` to provide nicer error messages.

448+class IsNotElem x isElem where

449+instance IsNotElem x 'False where

450+instance (TypeError ( 'Text "Cannot assign to "

451+ ':<>: 'ShowType alias

452+ ':<>: 'Text " more than once"))

453+ => IsNotElem '(alias, a) 'True where

454+ -- | No elem of @xs@ appears more than once, in the context of assignment.

455+class AllUnique (xs :: [(Symbol, a)]) where

456+instance AllUnique '[] where

457+instance (IsNotElem x (Elem x xs), AllUnique xs) => AllUnique (x ': xs) where

458+

459+class KnownSymbol alias

460+ => DefaultAliasable alias aliased | aliased -> alias where

461+ defaultAs :: Alias alias -> aliased

462+

463+-- | `HasAll` extends `Has` to take lists of @aliases@ and @fields@ and infer

464+-- a list of @subfields@.

465+class

466+ ( All KnownSymbol aliases

467+ ) => HasAll

468+ (aliases :: [Symbol])

469+ (fields :: [(Symbol,kind)])

470+ (subfields :: [(Symbol,kind)])

471+ | aliases fields -> subfields where

472+instance {-# OVERLAPPING #-} HasAll '[] fields '[]

473+instance {-# OVERLAPPABLE #-}

474+ (Has alias fields field, HasAll aliases fields subfields)

475+ => HasAll (alias ': aliases) fields (alias ::: field ': subfields)

476+

477+-- | Analagous to `IsLabel`, the constraint

478+-- `IsQualified` defines `!` for a column alias qualified

479+-- by a table alias.

480+class IsQualified table column expression where

481+ (!) :: Alias table -> Alias column -> expression

482+ infixl 9 !

483+instance IsQualified table column (Alias table, Alias column) where (!) = (,)

484+

485+data QualifiedAlias (qualifier :: Symbol) (alias :: Symbol) = QualifiedAlias

486+ deriving (Eq,GHC.Generic,Ord,Show,NFData)

487+instance (q ~ q', a ~ a') => IsQualified q a (QualifiedAlias q' a') where

488+ _!_ = QualifiedAlias

489+instance (q' ~ "public", a ~ a') => IsLabel a (QualifiedAlias q' a') where

490+ fromLabel = QualifiedAlias

491+instance (q0 ~ q1, a0 ~ a1, a1 ~ a2, KnownSymbol a2) =>

492+ IsQualified q0 a0 (Aliased (QualifiedAlias q1) (a1 ::: a2)) where

493+ _!_ = QualifiedAlias `As` Alias

494+instance (q ~ "public", a0 ~ a1, a1 ~ a2, KnownSymbol a2) =>

495+ IsLabel a0 (Aliased (QualifiedAlias q) (a1 ::: a2)) where

496+ fromLabel = QualifiedAlias `As` Alias

497+

498+instance (KnownSymbol q, KnownSymbol a)

499+ => RenderSQL (QualifiedAlias q a) where

500+ renderSQL _ =

501+ let

502+ qualifier = renderSQL (Alias @q)

503+ alias = renderSQL (Alias @a)

504+ in

505+ if qualifier == "\"public\"" then alias else qualifier <> "." <> alias

506+

507+-- | @Elem@ is a promoted `Data.List.elem`.

508+type family Elem x xs where

509+ Elem x '[] = 'False

510+ Elem x (x ': xs) = 'True

511+ Elem x (_ ': xs) = Elem x xs

512+

513+-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.

514+type family In x xs :: Constraint where In x xs = Elem x xs ~ 'True

515+

285516-- | Numeric Postgres types.

286517type PGNum =

287518 '[ 'PGint2, 'PGint4, 'PGint8, 'PGnumeric, 'PGfloat4, 'PGfloat8]

@@ -292,6 +523,37 @@ type PGFloating = '[ 'PGfloat4, 'PGfloat8, 'PGnumeric]

292523-- | Integral Postgres types.

293524type PGIntegral = '[ 'PGint2, 'PGint4, 'PGint8]

294525

526+-- | Error message helper for displaying unavailable\/unknown\/placeholder type

527+-- variables whose kind is known.

528+type Placeholder k = 'Text "(_::" :<>: 'ShowType k :<>: 'Text ")"

529+

530+type ErrArrayOf arr ty = arr :<>: 'Text " " :<>: ty

531+type ErrPGfixarrayOf t = ErrArrayOf ('ShowType 'PGfixarray :<>: 'Text " " :<>: Placeholder Nat) t

532+type ErrPGvararrayOf t = ErrArrayOf ('ShowType 'PGvararray) t

533+

534+-- | Ensure a type is a valid array type.

535+type family PGArray name arr :: Constraint where

536+ PGArray name ('PGvararray x) = ()

537+ PGArray name ('PGfixarray n x) = ()

538+ PGArray name val = TypeError

539+ ('Text name :<>: 'Text ": Unsatisfied PGArray constraint. Expected either: "

540+ :$$: 'Text " • " :<>: ErrPGvararrayOf (Placeholder PGType)

541+ :$$: 'Text " • " :<>: ErrPGfixarrayOf (Placeholder PGType)

542+ :$$: 'Text "But got: " :<>: 'ShowType val)

543+

544+-- | Ensure a type is a valid array type with a specific element type.

545+type family PGArrayOf name arr ty :: Constraint where

546+ PGArrayOf name ('PGvararray x) ty = x ~ ty

547+ PGArrayOf name ('PGfixarray n x) ty = x ~ ty

548+ PGArrayOf name val ty = TypeError

549+ ( 'Text name :<>: 'Text "Unsatisfied PGArrayOf constraint. Expected either: "

550+ :$$: 'Text " • " :<>: ErrPGvararrayOf ( 'ShowType ty )

551+ :$$: 'Text " • " :<>: ErrPGfixarrayOf ( 'ShowType ty )

552+ :$$: 'Text "But got: " :<>: 'ShowType val)

553+

554+-- | Ensure a type is a valid array type whose elements are text.

555+type PGTextArray name arr = PGArrayOf name arr ('NotNull 'PGtext)

556+

295557-- | `PGTypeOf` forgets about @NULL@ and any column constraints.

296558type family PGTypeOf (ty :: NullityType) :: PGType where

297559 PGTypeOf (nullity pg) = pg

@@ -305,24 +567,14 @@ instance ty0 ~ ty1 => SamePGType

305567

306568-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.

307569type 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

314570 AllNotNull '[] = ()

571+ AllNotNull (column ::: def :=> 'NotNull ty ': columns) = AllNotNull columns

315572

316573-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some

317574-- @NOT NULL@.

318575type family NotAllNull (columns :: ColumnsType) :: Constraint where

319− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

320− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

321− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

322− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

323− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

324− NotAllNull (_ ::: _ :=> 'NotNull _ ': _) = ()

325− NotAllNull (_ ::: _ :=> 'Null _ ': columns) = NotAllNull columns

576+ NotAllNull (column ::: def :=> 'NotNull ty ': columns) = ()

577+ NotAllNull (column ::: def :=> 'Null ty ': columns) = NotAllNull columns

326578

327579-- | `NullifyType` is an idempotent that nullifies a `NullityType`.

328580type family NullifyType (ty :: NullityType) :: NullityType where

@@ -331,37 +583,23 @@ type family NullifyType (ty :: NullityType) :: NullityType where

331583

332584-- | `NullifyRow` is an idempotent that nullifies a `RowType`.

333585type family NullifyRow (columns :: RowType) :: RowType where

334− NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': column5 ::: ty5 ': columns) =

335− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': column4 ::: NullifyType ty4 ': column5 ::: NullifyType ty5 ': NullifyRow columns

336− NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': columns) =

337− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': column4 ::: NullifyType ty4 ': NullifyRow columns

338− NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': columns) =

339− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': NullifyRow columns

340− NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': columns) =

341− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': NullifyRow columns

342− NullifyRow (column ::: ty ': column1 ::: ty1 ': columns) =

343− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': NullifyRow columns

586+ NullifyRow '[] = '[]

344587 NullifyRow (column ::: ty ': columns) =

345588 column ::: NullifyType ty ': NullifyRow columns

346− NullifyRow '[] = '[]

347589

348590-- | `NullifyFrom` is an idempotent that nullifies a `FromType`

349591-- used to nullify the left or right hand side of an outer join

350592-- in a `Squeal.PostgreSQL.Query.FromClause`.

351593type family NullifyFrom (tables :: FromType) :: FromType where

352− NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': table4 ::: columns4 ': table5 ::: columns5 ': tables) =

353− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': table4 ::: NullifyRow columns5 ': table5 ::: NullifyRow columns4 ': NullifyFrom tables

354− NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': table4 ::: columns4 ': tables) =

355− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': table4 ::: NullifyRow columns4 ': NullifyFrom tables

356− NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': tables) =

357− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': NullifyFrom tables

358− NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': tables) =

359− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': NullifyFrom tables

360− NullifyFrom (table ::: columns ': table1 ::: columns1 ': tables) =

361− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': NullifyFrom tables

594+ NullifyFrom '[] = '[]

362595 NullifyFrom (table ::: columns ': tables) =

363596 table ::: NullifyRow columns ': NullifyFrom tables

364− NullifyFrom '[] = '[]

597+

598+-- | `Join` is simply promoted `++` and is used in @JOIN@s in

599+-- `Squeal.PostgreSQL.Query.FromClause`s.

600+type family Join xs ys where

601+ Join '[] ys = ys

602+ Join (x ': xs) ys = x ': Join xs ys

365603

366604-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in

367605-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@

@@ -371,101 +609,30 @@ type family Create alias x xs where

371609 Create alias x (alias ::: y ': xs) = TypeError

372610 ('Text "Create: alias "

373611 ':<>: 'ShowType alias

374− ':<>: 'Text "already exists")

612+ ':<>: 'Text "already in use")

375613 Create alias y (x ': xs) = x ': Create alias y xs

376614

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−

394615-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@

395616-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements

396617-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.

397618type 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

619+ Drop alias ((alias ::: x) ': xs) = xs

403620 Drop alias (x ': xs) = x ': Drop alias xs

404621

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−

437622-- | @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`

623+-- with the type `x` and is used in `Squeal.PostgreSQL.Definition.alterTable`

439624-- and `Squeal.PostgreSQL.Definition.alterColumn`.

440625type family Alter alias x xs where

441− Alter alias x '[] = TypeError

442− ('Text "Alter: alias "

443− ':<>: 'ShowType alias

444− ':<>: 'Text " does not exist" )

445626 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

446627 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

447628

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−

453629-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@

454630-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and

455631-- `Squeal.PostgreSQL.Definition.renameColumn`.

456632type family Rename alias0 alias1 xs where

457− Rename alias0 alias1 '[] = TypeError

458− ('Text "Rename: alias "

459− ':<>: 'ShowType alias0

460− ':<>: 'Text " does not exist" )

461633 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

462634 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

463635

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−

469636-- | Check if a `TableConstraint` involves a column

470637type family ConstraintInvolves column constraint where

471638 ConstraintInvolves column ('Check columns) = column `Elem` columns

@@ -482,35 +649,22 @@ type family DropIfConstraintsInvolve column constraints where

482649 (DropIfConstraintsInvolve column constraints)

483650 (alias ::: constraint ': DropIfConstraintsInvolve column constraints)

484651

652+{- | Calculate the `Length` of a type level list

653+

654+>>> :kind! Length '[Char,String,Bool,Double]

655+Length '[Char,String,Bool,Double] :: Nat

656+= 4

657+-}

658+type family Length (xs :: [k]) :: Nat where

659+ Length (x : xs) = 1 + Length xs

660+ Length '[] = 0

661+

485662-- | A `SchemumType` is a user-defined type, either a `Table`,

486663-- `View` or `Typedef`.

487664data SchemumType

488665 = Table TableType

489666 | View RowType

490667 | 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

514668

515669{- | The schema of a database consists of a list of aliased,

516670user-defined `SchemumType`s.

@@ -536,24 +690,8 @@ type family Schema :: SchemaType where

536690-}

537691type SchemaType = [(Symbol,SchemumType)]

538692

539−{- |

540−A database contains one or more named schemas, which in turn contain tables.

541−The same object name can be used in different schemas without conflict;

542−for example, both schema1 and myschema can contain tables named mytable.

543−Unlike databases, schemas are not rigidly separated:

544−a user can access objects in any of the schemas in the database they are connected to,

545−if they have privileges to do so.

546−

547−There are several reasons why one might want to use schemas:

548−

549− * To allow many users to use one database without interfering with each other.

550− * To organize database objects into logical groups to make them more manageable.

551− * Third-party applications can be put into separate schemas

552− so they do not collide with the names of other objects.

553−-}

554693type SchemasType = [(Symbol,SchemaType)]

555694

556−-- | A type family to use for a single schema database.

557695type family Public (schema :: SchemaType) :: SchemasType

558696 where Public schema = '["public" ::: schema]

559697

@@ -576,21 +714,160 @@ instance All KnownSymbol labels => RenderSQL (NP PGlabel labels) where

576714 . hcollapse

577715 . hcmap (Proxy @KnownSymbol) (K . renderSQL)

578716

717+{- | The `PG` type family embeds a subset of Haskell types

718+as Postgres types. As an open type family, `PG` is extensible.

719+

720+>>> :kind! PG LocalTime

721+PG LocalTime :: PGType

722+= 'PGtimestamp

723+

724+>>> newtype MyDouble = My Double

725+>>> type instance PG MyDouble = 'PGfloat8

726+-}

727+type family PG (hask :: Type) :: PGType

728+type instance PG Bool = 'PGbool

729+type instance PG Int16 = 'PGint2

730+type instance PG Int32 = 'PGint4

731+type instance PG Int64 = 'PGint8

732+type instance PG Word16 = 'PGint2

733+type instance PG Word32 = 'PGint4

734+type instance PG Word64 = 'PGint8

735+type instance PG Scientific = 'PGnumeric

736+type instance PG Float = 'PGfloat4

737+type instance PG Double = 'PGfloat8

738+type instance PG Char = 'PGchar 1

739+type instance PG Text = 'PGtext

740+type instance PG Lazy.Text = 'PGtext

741+type instance PG String = 'PGtext

742+type instance PG ByteString = 'PGbytea

743+type instance PG Lazy.ByteString = 'PGbytea

744+type instance PG LocalTime = 'PGtimestamp

745+type instance PG UTCTime = 'PGtimestamptz

746+type instance PG Day = 'PGdate

747+type instance PG TimeOfDay = 'PGtime

748+type instance PG (TimeOfDay, TimeZone) = 'PGtimetz

749+type instance PG DiffTime = 'PGinterval

750+type instance PG UUID = 'PGuuid

751+type instance PG (NetAddr IP) = 'PGinet

752+type instance PG Value = 'PGjson

753+

754+{-| The `LabelsPG` type family calculates the constructors of a

755+Haskell enum type.

756+

757+>>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

758+>>> instance Generic Schwarma

759+>>> instance HasDatatypeInfo Schwarma

760+>>> :kind! LabelsPG Schwarma

761+LabelsPG Schwarma :: [Type.ConstructorName]

762+= '["Beef", "Lamb", "Chicken"]

763+-}

764+type family LabelsPG (hask :: Type) :: [Type.ConstructorName] where

765+ LabelsPG hask =

766+ ConstructorNamesOf (ConstructorsOf (DatatypeInfoOf hask))

767+

768+{- | `RowPG` turns a Haskell record type into a `RowType`.

769+

770+>>> data Person = Person { name :: Text, age :: Int32 } deriving GHC.Generic

771+>>> instance Generic Person

772+>>> instance HasDatatypeInfo Person

773+>>> :kind! RowPG Person

774+RowPG Person :: [(Symbol, NullityType)]

775+= '["name" ::: 'NotNull 'PGtext, "age" ::: 'NotNull 'PGint4]

776+-}

777+type family RowPG (hask :: Type) :: RowType where

778+ RowPG hask = RowOf (RecordCodeOf hask)

779+

780+type family RowOf (fields :: [(Symbol, Type)]) :: RowType where

781+ RowOf '[] = '[]

782+ RowOf (field ': fields) = FieldPG field ': RowOf fields

783+

784+type family FieldPG (field :: (Symbol, Type)) :: (Symbol, NullityType) where

785+ FieldPG (field ::: hask) = field ::: NullPG hask

786+

787+{- | `NullPG` turns a Haskell type into a `NullityType`.

788+

789+>>> :kind! NullPG Double

790+NullPG Double :: NullityType

791+= 'NotNull 'PGfloat8

792+>>> :kind! NullPG (Maybe Double)

793+NullPG (Maybe Double) :: NullityType

794+= 'Null 'PGfloat8

795+-}

796+type family NullPG (hask :: Type) :: NullityType where

797+ NullPG (Maybe hask) = 'Null (PG hask)

798+ NullPG hask = 'NotNull (PG hask)

799+

800+{- | `TuplePG` turns a Haskell tuple type (including record types) into

801+the corresponding list of `NullityType`s.

802+

803+>>> :kind! TuplePG (Double, Maybe Char)

804+TuplePG (Double, Maybe Char) :: [NullityType]

805+= '['NotNull 'PGfloat8, 'Null ('PGchar 1)]

806+-}

807+type family TuplePG (hask :: Type) :: [NullityType] where

808+ TuplePG hask = TupleOf (TupleCodeOf hask (Code hask))

809+

810+type family TupleOf (tuple :: [Type]) :: [NullityType] where

811+ TupleOf '[] = '[]

812+ TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple

813+

814+type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where

815+ TupleCodeOf hask '[tuple] = tuple

816+ TupleCodeOf hask '[] =

817+ TypeError

818+ ( 'Text "The type `" :<>: 'ShowType hask :<>: 'Text "' is not a tuple type."

819+ :$$: 'Text "It is a void type with no constructors."

820+ )

821+ TupleCodeOf hask (_ ': _ ': _) =

822+ TypeError

823+ ( 'Text "The type `" :<>: 'ShowType hask :<>: 'Text "' is not a tuple type."

824+ :$$: 'Text "It is a sum type with more than one constructor."

825+ )

826+

827+-- | Calculates constructors of a datatype.

828+type family ConstructorsOf (datatype :: Type.DatatypeInfo)

829+ :: [Type.ConstructorInfo] where

830+ ConstructorsOf ('Type.ADT _module _datatype constructors) =

831+ constructors

832+ ConstructorsOf ('Type.Newtype _module _datatype constructor) =

833+ '[constructor]

834+

835+-- | Calculates the name of a nullary constructor, otherwise

836+-- generates a type error.

837+type family ConstructorNameOf (constructors :: Type.ConstructorInfo)

838+ :: Type.ConstructorName where

839+ ConstructorNameOf ('Type.Constructor name) = name

840+ ConstructorNameOf ('Type.Infix name _assoc _fix) = TypeError

841+ ('Text "ConstructorNameOf error: non-nullary constructor "

842+ ':<>: 'Text name)

843+ ConstructorNameOf ('Type.Record name _fields) = TypeError

844+ ('Text "ConstructorNameOf error: non-nullary constructor "

845+ ':<>: 'Text name)

846+

847+-- | Calculate the names of nullary constructors.

848+type family ConstructorNamesOf (constructors :: [Type.ConstructorInfo])

849+ :: [Type.ConstructorName] where

850+ ConstructorNamesOf '[] = '[]

851+ ConstructorNamesOf (constructor ': constructors) =

852+ ConstructorNameOf constructor ': ConstructorNamesOf constructors

853+

579854-- | Is a type a valid JSON key?

580855type PGJsonKey = '[ 'PGint2, 'PGint4, 'PGtext ]

581856

582857-- | Is a type a valid JSON type?

583858type PGJsonType = '[ 'PGjson, 'PGjsonb ]

584859

585−-- | Utility class for `AllUnique` to provide nicer error messages.

586−class IsNotElem x isElem where

587−instance IsNotElem x 'False where

588−instance (TypeError ( 'Text "Cannot assign to "

589− ':<>: 'ShowType alias

590− ':<>: 'Text " more than once"))

591− => IsNotElem '(alias, a) 'True where

592−

593−-- | No elem of @xs@ appears more than once, in the context of assignment.

594−class AllUnique (xs :: [(Symbol, a)]) where

595−instance AllUnique '[] where

596−instance (IsNotElem x (Elem x xs), AllUnique xs) => AllUnique (x ': xs) where

860+-- | An `AlignedList` is a type-aligned list or free category.

861+data AlignedList p x0 x1 where

862+ Done :: AlignedList p x x

863+ (:>>) :: p x0 x1 -> AlignedList p x1 x2 -> AlignedList p x0 x2

864+infixr 7 :>>

865+instance Category (AlignedList p) where

866+ id = Done

867+ (.) list = \case

868+ Done -> list

869+ step :>> steps -> step :>> (steps >>> list)

870+

871+-- | A `single` step.

872+single :: p x0 x1 -> AlignedList p x0 x1

873+single step = step :>> Done

squeal-postgresql/src/Squeal/PostgreSQL/Transaction.hs+48−78

@@ -1,7 +1,7 @@

11{-|

22Module: Squeal.PostgreSQL.Transaction

33Description: Squeal transaction control language

4−Copyright: (c) Eitan Chatav, 2019

4+Copyright: (c) Eitan Chatav, 2017

55Maintainer: eitan@morphism.tech

66Stability: experimental

@@ -20,12 +20,11 @@ module Squeal.PostgreSQL.Transaction

2020 ( -- * Transaction

2121 transactionally

2222 , transactionally_

23− , transactionallyRetry

24− , ephemerally

25− , ephemerally_

2623 , begin

2724 , commit

2825 , rollback

26+ , transactionallySchema

27+ , transactionallySchema_

2928 -- * Transaction Mode

3029 , TransactionMode (..)

3130 , defaultMode

@@ -35,99 +34,70 @@ module Squeal.PostgreSQL.Transaction

3534 , DeferrableMode (..)

3635 ) where

3736

38−import UnliftIO

37+import Control.Exception.Lifted

38+import Control.Monad.Base

39+import Control.Monad.Trans.Control

40+import Generics.SOP

41+

42+import qualified Database.PostgreSQL.LibPQ as LibPQ

3943

4044import Squeal.PostgreSQL.Manipulation

4145import Squeal.PostgreSQL.Render

4246import Squeal.PostgreSQL.PQ

47+import Squeal.PostgreSQL.Schema

4348

44−{- | Run a computation `transactionally`;

45−first `begin`,

46−then run the computation,

47−`onException` `rollback` and rethrow the exception,

48−otherwise `commit` and `return` the result.

49−-}

49+-- | Run a schema invariant computation `transactionally`.

5050transactionally

51− :: (MonadUnliftIO tx, MonadPQ schemas tx)

51+ :: (MonadBaseControl IO tx, MonadPQ schemas tx)

5252 => TransactionMode

5353 -> tx x -- ^ run inside a transaction

5454 -> tx x

5555transactionally mode tx = mask $ \restore -> do

56− manipulate_ $ begin mode

57− result <- restore tx `onException` (manipulate_ rollback)

58− manipulate_ commit

56+ _ <- begin mode

57+ result <- restore tx `onException` rollback

58+ _ <- commit

5959 return result

6060

61−-- | Run a computation `transactionally_`, in `defaultMode`.

61+-- | Run a schema invariant computation `transactionally_` in `defaultMode`.

6262transactionally_

63− :: (MonadUnliftIO tx, MonadPQ schemas tx)

63+ :: (MonadBaseControl IO tx, MonadPQ schemas tx)

6464 => tx x -- ^ run inside a transaction

6565 -> tx x

6666transactionally_ = transactionally defaultMode

6767

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−

12068-- | @BEGIN@ a transaction.

121−begin :: TransactionMode -> Manipulation_ schemas () ()

122−begin mode = UnsafeManipulation $ "BEGIN" <+> renderSQL mode

69+begin :: MonadPQ schemas tx => TransactionMode -> tx (K Result ('[] :: RowType))

70+begin mode = manipulate . UnsafeManipulation $

71+ "BEGIN" <+> renderSQL mode <> ";"

12372

124−-- | @COMMIT@ a transaction.

125−commit :: Manipulation_ schemas () ()

126−commit = UnsafeManipulation "COMMIT"

73+-- | @COMMIT@ a schema invariant transaction.

74+commit :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

75+commit = manipulate $ UnsafeManipulation "COMMIT;"

12776

128−-- | @ROLLBACK@ a transaction.

129−rollback :: Manipulation_ schemas () ()

130−rollback = UnsafeManipulation "ROLLBACK"

77+-- | @ROLLBACK@ a schema invariant transaction.

78+rollback :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

79+rollback = manipulate $ UnsafeManipulation "ROLLBACK;"

80+

81+-- | Run a schema changing computation `transactionallySchema`.

82+transactionallySchema

83+ :: MonadBaseControl IO io

84+ => TransactionMode

85+ -> PQ schemas0 schemas1 io x

86+ -> PQ schemas0 schemas1 io x

87+transactionallySchema mode u = PQ $ \ conn -> mask $ \ restore -> do

88+ _ <- liftBase . LibPQ.exec (unK conn) $

89+ "BEGIN" <+> renderSQL mode <> ";"

90+ x <- restore (unPQ u conn)

91+ `onException` (liftBase (LibPQ.exec (unK conn) "ROLLBACK"))

92+ _ <- liftBase $ LibPQ.exec (unK conn) "COMMIT"

93+ return x

94+

95+-- | Run a schema changing computation `transactionallySchema_` in `DefaultMode`.

96+transactionallySchema_

97+ :: MonadBaseControl IO io

98+ => PQ schemas0 schemas1 io x

99+ -> PQ schemas0 schemas1 io x

100+transactionallySchema_ = transactionallySchema defaultMode

131101

132102-- | The available transaction characteristics are the transaction `IsolationLevel`,

133103-- the transaction `AccessMode` (`ReadWrite` or `ReadOnly`), and the `DeferrableMode`.

@@ -140,7 +110,7 @@ data TransactionMode = TransactionMode

140110-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

141111-- `ReadWrite` `AccessMode` and `NotDeferrable` `DeferrableMode`.

142112defaultMode :: TransactionMode

143−defaultMode = TransactionMode ReadCommitted ReadWrite NotDeferrable

113+defaultMode = TransactionMode Serializable ReadWrite NotDeferrable

144114

145115-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

146116-- `ReadOnly` `AccessMode` and `Deferrable` `DeferrableMode`.

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.Base (MonadBase)

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 IO (Public '[]) Schemas

86+migration = Migration { name = "test"

87+ , up = void $ define setup

88+ , down = void $ define 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 :: (MonadBase IO m, MonadPQ Schemas m) => User -> m ()

107+newUser u = void $ manipulateParams insertUser (userName u, userVec u)

108+

109+insertUserTwice :: (MonadBase IO 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−6

@@ -1,8 +1,3 @@

1−resolver: nightly-2019-07-14

1+resolver: nightly-2018-09-03

22packages:

33- squeal-postgresql

4−

5−extra-deps:

6−- unliftio-pool-0.2.1.0

7−- github: morphismtech/free-categories

8− commit: c0e555fbefb5c21619e532264c4dfeac556d0630