27b0a3a..dev · squeal · git.iko.soy

git.iko.soy/squeal

on dev help sign in

.circleci/config.yml+1−1

since splitsnapshots

unifiedsplit

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

2jobs:

3 build:

4 docker:

5− - image: haskell:8.4.3

5+ - image: haskell:8.6.5

6 - image: circleci/postgres:latest

7 environment:

8 POSTGRES_USER: root

README.md+64−75

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

46* transactions

47* views

48* array, composite and enumerated types

49−* json operations

49+* json functions and operations

50+* multischema support

51+* correlated subqueries

52+* window functions

53+* text search

51## installation

55## installation

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

72features.

76features.

74```Haskell

78```Haskell

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

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

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

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

77```

81```

79We'll need some imports.

83We'll need some imports.

81```Haskell

85```Haskell

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

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

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

84>>> import Data.Int (Int32)

87>>> import Data.Int (Int32)

85>>> import Data.Text (Text)

88>>> import Data.Text (Text)

86>>> import Squeal.PostgreSQL

89>>> import Squeal.PostgreSQL

87−>>> import Squeal.PostgreSQL.Render

88```

90```

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

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

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

101

100```Haskell

102```Haskell

101>>> :{

103>>> :{

104+type UsersColumns =

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

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

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

108+type EmailsColumns =

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

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

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

112+type EmailsConstraints =

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

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

102type Schema =

115type Schema =

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

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

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

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

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

107− ])

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

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

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

118+type Schemas = Public Schema

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

111− ] :=>

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

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

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

115− ])

116− ]

117:}

119:}

118```

120```

119

121

120Notice the use of type operators.

122Notice the use of type operators.

121

123

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

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

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

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

124operator.

126operator.

125

127

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

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

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

129

131

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

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

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

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

132has two type parameters, corresponding to the schema

134has two type parameters, corresponding to the schema

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

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

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

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

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

137```Haskell

139```Haskell

138>>> :{

140>>> :{

139let

141let

140− setup :: Definition '[] Schema

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

141− setup =

143+ setup =

142 createTable #users

144 createTable #users

143 ( serial `as` #id :*

145 ( serial `as` #id :*

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

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

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

169```Haskell

171```Haskell

170>>> :{

172>>> :{

171let

173let

172− teardown :: Definition Schema '[]

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

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

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

174:}

176:}

175

177

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

178DROP TABLE "users";

180DROP TABLE "users";

179```

181```

180

182

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

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

185+

186+```Haskell

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

188+>>> instance SOP.Generic User

189+>>> instance SOP.HasDatatypeInfo User

190+```

191+

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

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

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

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

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

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

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

195+and an output row. When

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

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

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

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

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

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

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

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

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

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

190−of our inserts.

201+`with` statement.

191

202

192```Haskell

203```Haskell

193>>> :{

204>>> :{

194let

205let

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

206+ insertUser :: Manipulation_ Schemas User ()

196− insertUser = insertRow #users

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

208+ where

209+ u = insertInto #users

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

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

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

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

199−:}

212+ e = insertInto_ #emails $ Select

200−

201−>>> :{

202−let

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

204− insertEmail = insertRow #emails

205− ( Default `as` #id :*

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

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

214+ (from (common #u))

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

208− OnConflictDoNothing (Returning Nil)

209:}

215:}

210

216

211>>> printSQL insertUser

217>>> printSQL insertUser

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

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

213−>>> printSQL insertEmail

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

215```

219```

216

220

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

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

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

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

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

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

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

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

221

225

222```Haskell

226```Haskell

223>>> :{

227>>> :{

224let

228let

225− getUsers :: Query Schema '[]

229+ getUsers :: Query_ Schemas () User

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

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

228− getUsers = select

230+ getUsers = select_

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

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

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

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

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

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

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

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

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

237```

239```

238

240

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

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

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

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

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

244−

245−```Haskell

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

247−>>> instance SOP.Generic User

248−>>> instance SOP.HasDatatypeInfo User

249−```

250−

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

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

252

242

253```Haskell

243```Haskell

254>>> :{

244>>> :{

255let

245let

256 users :: [User]

246 users :: [User]

257− users =

247+ users =

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

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

259 , User "Bob" Nothing

249 , User "Bob" Nothing

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

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

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

273```Haskell

263```Haskell

274>>> :{

264>>> :{

275let

265let

276− session :: PQ Schema Schema IO ()

266+ session :: PQ Schemas Schemas IO ()

277 session = do

267 session = do

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

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

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

268+ _ <- traversePrepared_ insertUser users

281 usersResult <- runQuery getUsers

269 usersResult <- runQuery getUsers

282 usersRows <- getRows usersResult

270 usersRows <- getRows usersResult

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

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

284in

272in

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

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

286 define setup

274 define setup

287 & pqThen session

275 & pqThen session

288 & pqThen (define teardown)

276 & pqThen (define teardown)

289:}

277:}

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

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

279+-}

291```

280```

RELEASE NOTES.md+400

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

1## RELEASE NOTES

3+### Version 0.5

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

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

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

9+**Multi-schema support**

10+

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

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

13+

14+```Haskell

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

16+```

17+

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

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

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

21+

22+```Haskell

23+-- Squeal 0.4

24+setup :: Definition '[] Schema

25+

26+-- Squeal 0.5

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

28+```

29+

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

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

32+`createSchemaIfNotExists`.

33+

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

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

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

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

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

39+

40+**Top-level statements**

41+

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

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

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

45+will be discussed in the next section.

46+

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

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

49+type families.

50+

51+```

52+type family Query_

53+ (schemas :: SchemasType)

54+ (parameters :: Type)

55+ (row :: Type) where

56+ Query_ schemas params row =

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

58+```

59+

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

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

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

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

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

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

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

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

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

69+only a scope for common table expressions.

70+

71+**Subquery expressions**

72+

73+Previous versions of Squeal offered subquery expression support

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

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

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

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

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

79+for a query was not available.

80+

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

82+

83+```Haskell

84+newtype Query

85+ (outer :: FromType)

86+ (commons :: FromType)

87+ (schemas :: SchemasType)

88+ (params :: [NullityType])

89+ (row :: RowType)

90+ = UnsafeQuery { renderQuery :: ByteString }

91+```

92+

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

94+

95+```Haskell

96+exists

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

98+ -> Condition outer commons grp schemas params from

99+```

100+

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

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

103+

104+```Haskell

105+in_

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

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

108+ -> Condition outer commons grp schemas params from

109+```

110+

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

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

113+the next section.

114+

115+```Haskell

116+subAll

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

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

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

120+ -> Condition outer commons grp schemas params from

121+

122+subAny

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

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

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

126+ -> Condition outer commons grp schemas params from

127+```

128+

129+**Expression RankNTypes**

130+

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

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

133+that cannot reference any aliases or parameters.

134+

135+```Haskell

136+type Expr x

137+ = forall outer commons grp schemas params from

138+ . Expression outer commons grp schemas params from x

139+```

140+

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

142+type `(->)`.

143+

144+```Haskell

145+type (-->) x y

146+ = forall outer commons grp schemas params from

147+ . Expression outer commons grp schemas params from x

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

149+```

150+

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

152+

153+```Haskell

154+type Operator x1 x2 y

155+ = forall outer commons grp schemas params from

156+ . Expression outer commons grp schemas params from x1

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

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

159+```

160+

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

162+and variadic functions.

163+

164+```

165+type FunctionN xs y

166+ = forall outer commons grp schemas params from

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

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

169+```

170+

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

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

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

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

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

176+

177+**Selections**

178+

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

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

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

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

183+

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

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

186+

187+```Haskell

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

189+ Star

190+ :: HasUnique tab from row

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

192+ DotStar

193+ :: Has tab from row

194+ => Alias tab

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

196+ List

197+ :: SListI row

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

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

200+ Over

201+ :: SListI row

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

203+ -> WindowDefinition outer commons grp schemas params from

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

205+ Also

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

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

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

209+```

210+

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

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

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

214+window functions, described in the next section.

215+

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

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

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

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

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

221+functions to filter out duplicate rows.

222+

223+**Query clauses**

224+

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

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

227+

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

229+

230+```

231+-- Squeal 0.4

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

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

234+

235+-- Squeal 0.5

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

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

238+```

239+

240+**Window functions and aggregation**

241+

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

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

244+previous section.

245+

246+```Haskell

247+Over

248+ :: SListI row

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

250+ -> WindowDefinition outer commons grp schemas params from

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

252+```

253+

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

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

256+clause. For example,

257+

258+```Haskell

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

260+query = select

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

262+ (from (table #tab))

263+```

264+

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

266+

267+```Haskell

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

269+rank = UnsafeWindowFunction "rank()"

270+```

271+

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

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

274+window functions and n-ary window functions.

275+

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

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

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

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

280+

281+```

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

283+ = All (expr ty)

284+ | Distinct (expr ty)

285+```

286+

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

288+while window functions bear no such distinction.

289+

290+**Migrations**

291+

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

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

294+run or rewind your migrations.

295+

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

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

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

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

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

301+

302+```Haskell

303+data Migration p schemas0 schemas1 = Migration

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

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

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

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

308+ } deriving (GHC.Generic)

309+```

310+

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

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

313+introduces the `Terminally` type.

314+

315+```Haskell

316+newtype Terminally trans monad x0 x1 = Terminally

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

318+```

319+

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

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

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

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

324+

325+```Haskell

326+pureMigration

327+ :: Migration Definition schemas0 schemas1

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

329+```

330+

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

332+a typeclass, `Migratory`.

333+

334+```

335+class Category p => Migratory p where

336+

337+ migrateUp

338+ :: AlignedList (Migration p) schemas0 schemas1

339+ -> PQ schemas0 schemas1 IO ()

340+

341+ migrateDown

342+ :: AlignedList (Migration p) schemas0 schemas1

343+ -> PQ schemas1 schemas0 IO ()

344+```

345+

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

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

348+

349+**Transactions**

350+

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

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

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

354+`transactionallyRetry` computations, retrying the transaction if

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

356+

357+**Types**

358+

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

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

361+with `createDomain`.

362+

363+**Time**

364+

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

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

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

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

369+differences.

370+

371+**Literals**

372+

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

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

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

376+

377+**Set returning functions**

378+

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

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

381+

382+**Text search**

383+

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

385+

386+**Much more**

387+

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

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

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

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

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

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

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

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

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

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

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

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

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

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

402+

3### Version 0.4

403### Version 0.4

404

5Version 0.4 strengthens Squeal's type system, adds

405Version 0.4 strengthens Squeal's type system, adds

squeal-postgresql/exe/Example.hs+27−32

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

12module Main (main, main2) where

14−import Control.Monad (void)

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

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

16import Data.Int (Int16, Int32)

15import Data.Int (Int16, Int32)

17import Data.Monoid ((<>))

16import Data.Monoid ((<>))

18import Data.Text (Text)

17import Data.Text (Text)

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

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

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

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

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

41 ])

40 ])

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

42 ]

44type Schemas = Public Schema

46−type DB = DBof Schemas

47−

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

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

49−setup =

47+setup =

50 createTable #users

48 createTable #users

51 ( serial `as` #id :*

49 ( serial `as` #id :*

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

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

@@ -55,58 +53,55 @@ setup =

55 >>>

53 >>>

56 createTable #emails

54 createTable #emails

57 ( serial `as` #id :*

55 ( serial `as` #id :*

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

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

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

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

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

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

61 foreignKey #user_id #users #id

59 foreignKey #user_id #users #id

62 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

60 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

61+ >>>

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

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

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

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

67−insertUser :: Manipulation DB '[ 'NotNull 'PGtext, 'NotNull ('PGvararray ('Null 'PGint2))]

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

68− '[ "fromOnly" ::: 'NotNull 'PGint4 ]

69insertUser = insertInto #users

68insertUser = insertInto #users

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

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

71− (OnConflict (OnConstraint #pk_users) DoNothing) (Returning (#id `as` #fromOnly))

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

72−

71+

73−insertEmail :: Manipulation DB '[ 'NotNull 'PGint4, 'Null 'PGtext] '[]

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

74−insertEmail = insertInto #emails

73+insertEmail = insertInto_ #emails

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

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

76− (OnConflict (OnConstraint #pk_emails) DoNothing) (Returning Nil)

75+

77−

78−getUsers :: Query DB '[]

76+getUsers :: Query_ Schemas () User

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

80− , "userEmail" ::: 'Null 'PGtext

81− , "userVec" ::: 'NotNull ('PGvararray ('Null 'PGint2))]

82getUsers = select_

77getUsers = select_

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

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

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

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

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

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

86 (#u ! #id .== #e ! #user_id)) )

81 (#u ! #id .== #e ! #user_id)) )

88−data User = User { userName :: Text, userEmail :: Maybe Text, userVec :: Vector (Maybe Int16) }

83+data User = User { userName :: Text, userEmail :: Maybe Text, userVec :: VarArray (Vector (Maybe Int16)) }

89 deriving (Show, GHC.Generic)

84 deriving (Show, GHC.Generic)

90instance SOP.Generic User

85instance SOP.Generic User

91instance SOP.HasDatatypeInfo User

86instance SOP.HasDatatypeInfo User

93users :: [User]

88users :: [User]

94−users =

89+users =

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

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

96− , User "Bob" Nothing [Just 2, Nothing]

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

97− , User "Carole" (Just "carole@hotmail.com") [Just 3]

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

98 ]

93 ]

100−session :: (MonadBase IO pq, MonadPQ Schemas pq) => pq ()

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

101session = do

96session = do

102− liftBase $ Char8.putStrLn "manipulating"

97+ liftIO $ Char8.putStrLn "manipulating"

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

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

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

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

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

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

106− liftBase $ Char8.putStrLn "querying"

101+ liftIO $ Char8.putStrLn "querying"

107 usersResult <- runQuery getUsers

102 usersResult <- runQuery getUsers

108 usersRows <- getRows usersResult

103 usersRows <- getRows usersResult

109− liftBase $ print (usersRows :: [User])

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

110

105

111main :: IO ()

106main :: IO ()

112main = do

107main = do

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

124

119

125main2 :: IO ()

120main2 :: IO ()

126main2 =

121main2 =

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

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

128 define setup

123 define setup

129 & pqThen session

124 & pqThen session

130 & pqThen (define teardown)

125 & pqThen (define teardown)

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

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

1name: squeal-postgresql

2−version: 0.4.9.0

2+version: 0.5.1.0

3synopsis: Squeal PostgreSQL Library

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

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

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

22 hs-source-dirs: src

23 exposed-modules:

24 Squeal.PostgreSQL

25+ Squeal.PostgreSQL.Alias

25 Squeal.PostgreSQL.Binary

26 Squeal.PostgreSQL.Binary

26 Squeal.PostgreSQL.Definition

27 Squeal.PostgreSQL.Definition

28+ Squeal.PostgreSQL.Definition.Function

29+ Squeal.PostgreSQL.Definition.Index

30+ Squeal.PostgreSQL.Definition.Table

31+ Squeal.PostgreSQL.Definition.Table.Constraint

32+ Squeal.PostgreSQL.Definition.Type

33+ Squeal.PostgreSQL.Definition.Schema

34+ Squeal.PostgreSQL.Definition.View

27 Squeal.PostgreSQL.Expression

35 Squeal.PostgreSQL.Expression

36+ Squeal.PostgreSQL.Expression.Aggregate

37+ Squeal.PostgreSQL.Expression.Collection

38+ Squeal.PostgreSQL.Expression.Comparison

39+ Squeal.PostgreSQL.Expression.Json

40+ Squeal.PostgreSQL.Expression.Literal

41+ Squeal.PostgreSQL.Expression.Logic

42+ Squeal.PostgreSQL.Expression.Math

43+ Squeal.PostgreSQL.Expression.Null

44+ Squeal.PostgreSQL.Expression.Parameter

45+ Squeal.PostgreSQL.Expression.Range

46+ Squeal.PostgreSQL.Expression.Set

47+ Squeal.PostgreSQL.Expression.Sort

48+ Squeal.PostgreSQL.Expression.Subquery

49+ Squeal.PostgreSQL.Expression.Text

50+ Squeal.PostgreSQL.Expression.TextSearch

51+ Squeal.PostgreSQL.Expression.Time

52+ Squeal.PostgreSQL.Expression.Type

53+ Squeal.PostgreSQL.Expression.Window

54+ Squeal.PostgreSQL.List

28 Squeal.PostgreSQL.Manipulation

55 Squeal.PostgreSQL.Manipulation

29 Squeal.PostgreSQL.Migration

56 Squeal.PostgreSQL.Migration

30 Squeal.PostgreSQL.Pool

57 Squeal.PostgreSQL.Pool

58+ Squeal.PostgreSQL.PG

31 Squeal.PostgreSQL.PQ

59 Squeal.PostgreSQL.PQ

32 Squeal.PostgreSQL.Render

60 Squeal.PostgreSQL.Render

33 Squeal.PostgreSQL.Query

61 Squeal.PostgreSQL.Query

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

42 , bytestring >= 0.10.8.2

70 , bytestring >= 0.10.8.2

43 , bytestring-strict-builder >= 0.4.5

71 , bytestring-strict-builder >= 0.4.5

44 , deepseq >= 1.4.3.0

72 , deepseq >= 1.4.3.0

73+ , free-categories >= 0.1.0.0

45− , generics-sop >= 0.3.2.0

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

46− , lifted-base >= 0.2.3.12

47 , mmorph >= 1.1.1

75 , mmorph >= 1.1.1

48− , monad-control >= 1.0.2.3

49 , mtl >= 2.2.2

76 , mtl >= 2.2.2

50 , network-ip >= 0.3.0.2

77 , network-ip >= 0.3.0.2

51 , postgresql-binary >= 0.12.1

78 , postgresql-binary >= 0.12.1

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

56 , text >= 1.2.3.0

83 , text >= 1.2.3.0

57 , time >= 1.8.0.2

84 , time >= 1.8.0.2

58 , transformers >= 0.5.2.0

85 , transformers >= 0.5.2.0

59− , transformers-base >= 0.4.4

86+ , unliftio >= 0.2.10

87+ , unliftio-pool >= 0.2.1.0

60 , uuid-types >= 1.0.3

88 , uuid-types >= 1.0.3

61 , vector >= 0.12.0.1

89 , vector >= 0.12.0.1

63−test-suite squeal-postgresql-doctest

91+test-suite doctest

64 default-language: Haskell2010

92 default-language: Haskell2010

65 type: exitcode-stdio-1.0

93 type: exitcode-stdio-1.0

66 hs-source-dirs: test

94 hs-source-dirs: test

67 ghc-options: -Wall

95 ghc-options: -Wall

68− main-is: DocTest.hs

96+ main-is: Doc.hs

69 build-depends:

97 build-depends:

70 base >= 4.10.0.0

98 base >= 4.10.0.0

71 , doctest >= 0.11.4

99 , doctest >= 0.11.4

100+ , squeal-postgresql

101

73−test-suite squeal-postgresql-specs

102+test-suite properties

74 default-language: Haskell2010

103 default-language: Haskell2010

75 type: exitcode-stdio-1.0

104 type: exitcode-stdio-1.0

76− hs-source-dirs: test/Specs

105+ hs-source-dirs: test

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

106+ ghc-options: -Wall

78− main-is: Specs.hs

107+ main-is: Property.hs

79− other-modules: ExceptionHandling

80 build-depends:

108 build-depends:

81 base >= 4.10.0.0

109 base >= 4.10.0.0

82 , bytestring >= 0.10.8.2

110 , bytestring >= 0.10.8.2

111+ , hedgehog >= 1.0

112+ , mtl >= 2.2.2

113+ , scientific >= 0.3.5.3

114+ , squeal-postgresql

115+ , time >= 1.8.0.2

116+

117+test-suite spec

118+ default-language: Haskell2010

119+ type: exitcode-stdio-1.0

120+ hs-source-dirs: test

121+ ghc-options: -Wall

122+ main-is: Spec.hs

123+ build-depends:

124+ base >= 4.10.0.0

125+ , async >= 2.2.2

126+ , bytestring >= 0.10.8.2

83 , generics-sop >= 0.3.1.0

127 , generics-sop >= 0.3.1.0

84 , hspec >= 2.4.8

128 , hspec >= 2.4.8

129+ , mtl >= 2.2.2

85 , squeal-postgresql

130 , squeal-postgresql

86 , text >= 1.2.2.2

131 , text >= 1.2.2.2

87− , transformers >= 0.5.2.0

88− , transformers-base >= 0.4.4

89 , vector >= 0.12.0.1

132 , vector >= 0.12.0.1

133

91−executable squeal-postgresql-example

134+executable example

92 default-language: Haskell2010

135 default-language: Haskell2010

93 hs-source-dirs: exe

136 hs-source-dirs: exe

94 ghc-options: -Wall

137 ghc-options: -Wall

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

101 , squeal-postgresql

144 , squeal-postgresql

102 , text >= 1.2.2.2

145 , text >= 1.2.2.2

103 , transformers >= 0.5.2.0

146 , transformers >= 0.5.2.0

104− , transformers-base >= 0.4.4

105 , vector >= 0.12.0.1

147 , vector >= 0.12.0.1

squeal-postgresql/src/Squeal/PostgreSQL.hs+76−61

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

1{-|

2Module: Squeal.PostgreSQL

3−Description: Squeel export module

3+Description: Squeal export module

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

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

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

12features.

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

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

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

16−

16+

17We'll need some imports.

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

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

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

21>>> import Data.Int (Int32)

20>>> import Data.Int (Int32)

22>>> import Data.Text (Text)

21>>> import Data.Text (Text)

23>>> import Squeal.PostgreSQL

22>>> import Squeal.PostgreSQL

24−>>> import Squeal.PostgreSQL.Render

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

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

@@ -47,7 +45,6 @@ type Schema =

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

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

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

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

49type Schemas = Public Schema

47type Schemas = Public Schema

50−type DB = DBof Schemas

51:}

48:}

53Notice the use of type operators.

50Notice the use of type operators.

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

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

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

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

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

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

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

65has two type parameters, corresponding to the schema

62has two type parameters, corresponding to the schema

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

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

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

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

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

70>>> :{

67>>> :{

71let

68let

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

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

73− setup =

70+ setup =

74 createTable #users

71 createTable #users

75 ( serial `as` #id :*

72 ( serial `as` #id :*

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

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

@@ -105,43 +102,49 @@ let

105DROP TABLE "emails";

102DROP TABLE "emails";

106DROP TABLE "users";

103DROP TABLE "users";

107

104

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+

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

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

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

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

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

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

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

115+and an output row. When

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

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

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

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

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

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

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

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

116−the emails table. Take a careful look at the type and definition of both

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

117−of our inserts.

121+`with` statement.

118

122

119>>> :{

123>>> :{

120let

124let

121− insertUser :: Manipulation DB '[ 'NotNull 'PGtext, 'Null 'PGtext ] '[]

125+ insertUser :: Manipulation_ Schemas User ()

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

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

123 where

127 where

124 u = insertInto #users

128 u = insertInto #users

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

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

126− OnConflictDoRaise (Returning (#id :* param @2 `as` #email))

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

127− e = insertInto_ #emails

131+ e = insertInto_ #emails $ Select

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

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

133+ (from (common #u))

129:}

134:}

130

135

131>>> printSQL insertUser

136>>> printSQL insertUser

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

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

133

138

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

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

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

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

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

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

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

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

138

143

139>>> :{

144>>> :{

140let

145let

141− getUsers :: Query DB '[]

146+ getUsers :: Query_ Schemas () User

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

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

144− getUsers = select

147+ getUsers = select_

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

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

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

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

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

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

@@ -151,22 +154,12 @@ let

151>>> printSQL getUsers

154>>> printSQL getUsers

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

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

153

156

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

155−for users. We give the type `Generics.SOP.Generic` and

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

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

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

159−

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

161−>>> instance SOP.Generic User

162−>>> instance SOP.HasDatatypeInfo User

163−

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

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

165

158

166>>> :{

159>>> :{

167let

160let

168 users :: [User]

161 users :: [User]

169− users =

162+ users =

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

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

171 , User "Bob" Nothing

164 , User "Bob" Nothing

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

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

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

188 _ <- traversePrepared_ insertUser users

181 _ <- traversePrepared_ insertUser users

189 usersResult <- runQuery getUsers

182 usersResult <- runQuery getUsers

190 usersRows <- getRows usersResult

183 usersRows <- getRows usersResult

191− liftBase $ print (usersRows :: [User])

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

192in

185in

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

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

194 define setup

187 define setup

195 & pqThen session

188 & pqThen session

196 & pqThen (define teardown)

189 & pqThen (define teardown)

197:}

190:}

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

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

199-}

192-}

200−module Squeal.PostgreSQL

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

201− ( module Squeal.PostgreSQL.Binary

194+

202− , module Squeal.PostgreSQL.Definition

203− , module Squeal.PostgreSQL.Expression

204− , module Squeal.PostgreSQL.Manipulation

205− , module Squeal.PostgreSQL.PQ

206− , module Squeal.PostgreSQL.Query

207− , module Squeal.PostgreSQL.Schema

208− , module Squeal.PostgreSQL.Transaction

209− ) where

210−

211−import Squeal.PostgreSQL.Binary

195+import Squeal.PostgreSQL.Alias as X

196+import Squeal.PostgreSQL.Binary as X

212−import Squeal.PostgreSQL.Definition

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

213−import Squeal.PostgreSQL.Expression

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

214−import Squeal.PostgreSQL.Manipulation

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

215−import Squeal.PostgreSQL.PQ

229+import Squeal.PostgreSQL.PQ as X

216−import Squeal.PostgreSQL.Query

230+import Squeal.PostgreSQL.Query as X

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

217−import Squeal.PostgreSQL.Schema

232+import Squeal.PostgreSQL.Schema as X

218−import Squeal.PostgreSQL.Transaction

233+import Squeal.PostgreSQL.Transaction as X

squeal-postgresql/src/Squeal/PostgreSQL/Alias.hsnew file+249

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

1+{-|

2+Module: Squeal.PostgreSQL.Alias

3+Description: Aliases

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

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

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

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

11+-}

12+

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+312−126

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

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

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

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

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

12to encode Haskell values into statement parameters.

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

16>>> import Data.Int (Int16)

17>>> import Data.Text (Text)

18>>> import Control.Monad (void)

19−>>> import Control.Monad.Base (liftBase)

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

20>>> import Squeal.PostgreSQL

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

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

23round trip query.

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

@@ -27,7 +27,7 @@ round trip query.

27>>> instance HasDatatypeInfo Row

28>>> :{

29let

30− roundTrip :: Query (DBof (Public '[])) (TuplePG Row) (RowPG Row)

30+ roundTrip :: Query_ (Public '[]) Row Row

31 roundTrip = values_ $

32 parameter @1 int2 `as` #col1 :*

33 parameter @2 text `as` #col2 :*

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

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

41>>> :{

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

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

43 result <- runQueryParams roundTrip input

44 Just output <- firstRow result

45− liftBase . print $ input == output

45+ liftIO . print $ input == output

46:}

47True

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

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

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

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

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

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

@@ -55,9 +55,9 @@ create multi-dimensional fixed length arrays.

56>>> :{

57data Row = Row

58− { col1 :: Vector Int16

58+ { col1 :: VarArray (Vector Int16)

59− , col2 :: (Maybe Int16,Maybe Int16)

59+ , col2 :: FixArray (Maybe Int16,Maybe Int16)

60− , col3 :: ((Int16,Int16),(Int16,Int16),(Int16,Int16))

60+ , col3 :: FixArray ((Int16,Int16),(Int16,Int16),(Int16,Int16))

61 } deriving (Eq, GHC.Generic)

62:}

@@ -68,20 +68,20 @@ Once again, we define a simple round trip query.

69>>> :{

70let

71− roundTrip :: Query (DBof (Public '[])) (TuplePG Row) (RowPG Row)

71+ roundTrip :: Query_ (Public '[]) Row Row

72 roundTrip = values_ $

73− parameter @1 (int2 & vararray) `as` #col1 :*

73+ parameter @1 (int2 & vararray) `as` #col1 :*

74− parameter @2 (int2 & fixarray @2) `as` #col2 :*

74+ parameter @2 (int2 & fixarray @'[2]) `as` #col2 :*

75− parameter @3 (int2 & fixarray @2 & fixarray @3) `as` #col3

75+ parameter @3 (int2 & fixarray @'[3,2]) `as` #col3

76:}

78>>> :set -XOverloadedLists

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

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

80>>> :{

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

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

82 result <- runQueryParams roundTrip input

83 Just output <- firstRow result

84− liftBase . print $ input == output

84+ liftIO . print $ input == output

85:}

86True

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

120 createTypeCompositeFrom @Person #person

121:}

122

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

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

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

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

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

126

127>>> :{

128data Row = Row

@@ -146,7 +146,7 @@ Once again, define a round trip query.

146

147>>> :{

148let

149− roundTrip :: Query (DBof (Public Schema)) (TuplePG Row) (RowPG Row)

149+ roundTrip :: Query_ (Public Schema) Row Row

150 roundTrip = values_ $

151 parameter @1 (typedef #schwarma) `as` #schwarma :*

152 parameter @2 (typedef #person) `as` #person1 :*

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

168 session = do

169 result <- runQueryParams roundTrip input

170 Just output <- firstRow result

171− liftBase . print $ input == output

171+ liftIO . print $ input == output

172in

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

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

174 define setup

175 & pqThen session

176 & pqThen (define teardown)

@@ -194,20 +194,31 @@ True

194 , MultiParamTypeClasses

195 , ScopedTypeVariables

196 , TypeApplications

197+ , TypeFamilies

197 , TypeInType

198 , TypeInType

198 , TypeOperators

199 , TypeOperators

199 , UndecidableInstances

200 , UndecidableInstances

201+ , UndecidableSuperClasses

200#-}

202#-}

201

203

202module Squeal.PostgreSQL.Binary

204module Squeal.PostgreSQL.Binary

203 ( -- * Encoding

205 ( -- * Encoding

204 ToParam (..)

206 ToParam (..)

205 , ToParams (..)

207 , ToParams (..)

208+ , ToNullityParam (..)

209+ , ToField (..)

210+ , ToFixArray (..)

206 -- * Decoding

211 -- * Decoding

207 , FromValue (..)

212 , FromValue (..)

208 , FromRow (..)

213 , FromRow (..)

214+ , FromField (..)

215+ , FromFixArray (..)

209 -- * Only

216 -- * Only

210 , Only (..)

217 , Only (..)

218+ -- * Oid

219+ , OidOf (..)

220+ , OidOfParam (..)

221+ , OidOfField (..)

211 ) where

222 ) where

212

223

213import BinaryParser

224import BinaryParser

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

221import Data.UUID.Types

232import Data.UUID.Types

222import Data.Vector (Vector)

233import Data.Vector (Vector)

223import Data.Word

234import Data.Word

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

224import Generics.SOP

236import Generics.SOP

225import Generics.SOP.Record

237import Generics.SOP.Record

226import GHC.TypeLits

238import GHC.TypeLits

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

234import qualified Data.Text as Strict (Text)

246import qualified Data.Text as Strict (Text)

235import qualified Data.Text as Strict.Text

247import qualified Data.Text as Strict.Text

236import qualified Data.Vector as Vector

248import qualified Data.Vector as Vector

249+import qualified Database.PostgreSQL.LibPQ as LibPQ

237import qualified GHC.Generics as GHC

250import qualified GHC.Generics as GHC

238import qualified PostgreSQL.Binary.Decoding as Decoding

251import qualified PostgreSQL.Binary.Decoding as Decoding

239import qualified PostgreSQL.Binary.Encoding as Encoding

252import qualified PostgreSQL.Binary.Encoding as Encoding

240

253

254+import Squeal.PostgreSQL.Alias

255+import Squeal.PostgreSQL.List

256+import Squeal.PostgreSQL.PG

241import Squeal.PostgreSQL.Schema

257import Squeal.PostgreSQL.Schema

242

258

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -297,16 +312,27 @@ instance Aeson.ToJSON x => ToParam (Json x) 'PGjson where

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

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

298 toParam = K . Encoding.jsonb_bytes

313 toParam = K . Encoding.jsonb_bytes

299 . Lazy.ByteString.toStrict . Aeson.encode . getJsonb

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

300−instance ToArray x ('NotNull ('PGvararray ty))

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

301− => ToParam x ('PGvararray ty) where

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

302− toParam

317+ toParam = K

303− = K . Encoding.array (baseOid @x @('NotNull ('PGvararray ty)))

318+ . Encoding.array_foldable

304− . unK . toArray @x @('NotNull ('PGvararray ty))

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

305−instance ToArray x ('NotNull ('PGfixarray n ty))

320+ . getVarArray

321+instance (ToParam x pg, OidOf pg)

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

323+ toParam = K

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

325+ . getVarArray

326+instance (ToParam x pg, OidOf pg)

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

328+ toParam = K

329+ . Encoding.nullableArray_vector

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

331+ . getVarArray

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

306− => ToParam x ('PGfixarray n ty) where

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

307− toParam

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

308− = K . Encoding.array (baseOid @x @('NotNull ('PGfixarray n ty)))

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

309− . unK . toArray @x @('NotNull ('PGfixarray n ty))

310instance

336instance

311 ( IsEnumType x

337 ( IsEnumType x

312 , HasDatatypeInfo x

338 , HasDatatypeInfo x

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

330 ( SListI fields

356 ( SListI fields

331 , IsRecord x xs

357 , IsRecord x xs

332 , AllZip ToField xs fields

358 , AllZip ToField xs fields

333− , All HasAliasedOid fields

359+ , All OidOfField fields

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

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

335 toParam =

361 toParam =

336 let

362 let

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

338 encoders = htrans (Proxy @ToField) toField

364 encoders = htrans (Proxy @ToField) toField

339

365

340 composite

366 composite

341− :: All HasAliasedOid row

367+ :: All OidOfField row

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

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

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

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

344 composite fields = K $

370 composite fields = K $

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

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

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

356 let

382 let

357 each

383 each

358− :: HasAliasedOid field

384+ :: OidOfField field

359 => K (Maybe Encoding.Encoding) field

385 => K (Maybe Encoding.Encoding) field

360 -> Encoding.Encoding

386 -> Encoding.Encoding

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

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

362− word32BE (aliasedOid @field)

388+ word32BE (getOid (oidOfField @field))

363 <> case field of

389 <> case field of

364 Nothing -> int64BE (-1)

390 Nothing -> int64BE (-1)

365 Just value ->

391 Just value ->

366 int32BE (fromIntegral (builderLength value))

392 int32BE (fromIntegral (builderLength value))

367 <> value

393 <> value

368 in

394 in

369− hcfoldMap (Proxy @HasAliasedOid) each fields

395+ hcfoldMap (Proxy @OidOfField) each fields

370

396

371 in

397 in

372 composite . encoders . toRecord . getComposite

398 composite . encoders . toRecord . getComposite

373

399

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

401+--

402+-- >>> :set -XTypeApplications

403+-- >>> oidOf @'PGbool

404+-- Oid 16

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

508+

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

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

511+

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

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

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

375− aliasedOid :: Word32

514+ oidOfField :: Oid

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

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

377− aliasedOid = oid @ty

516+ oidOfField = oidOf @ty

378−

517+

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

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

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

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

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

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

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

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

@@ -383,55 +524,36 @@ instance ToParam x pg => ToNullityParam x ('NotNull pg) where

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

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

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

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

385

526

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

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

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

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

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

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

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

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

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

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

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

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

390

535

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

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

538+-- You should not define instances for

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

391−class ToArray (x :: Type) (array :: NullityType) where

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

392− toArray :: x -> K Encoding.Array array

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

393− baseOid :: Word32

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

394− default baseOid :: HasOid (PGTypeOf array) => Word32

395− baseOid = oid @(PGTypeOf array)

396−instance {-# OVERLAPPABLE #-} (HasOid pg, ToParam x pg)

397− => ToArray x ('NotNull pg) where

398− toArray = K . Encoding.encodingArray . unK . toParam @x @pg

399−instance {-# OVERLAPPABLE #-} (HasOid pg, ToParam x pg)

400− => ToArray (Maybe x) ('Null pg) where

401− toArray = K . maybe Encoding.nullArray

402− (Encoding.encodingArray . unK . toParam @x @pg)

403−instance {-# OVERLAPPING #-} ToArray x array

404− => ToArray (Vector x) ('NotNull ('PGvararray array)) where

405− toArray = K . Encoding.dimensionArray Vector.foldl'

406− (unK . toArray @x @array)

407− baseOid = baseOid @x @array

408−instance {-# OVERLAPPING #-} ToArray x array

409− => ToArray (Maybe (Vector x)) ('Null ('PGvararray array)) where

410− toArray = K . maybe Encoding.nullArray

543+ toFixArray = K . K . maybe Encoding.nullArray Encoding.encodingArray . unK

411− (Encoding.dimensionArray Vector.foldl' (unK . toArray @x @array))

544+ . toNullityParam @x @ty

412− baseOid = baseOid @x @array

413−instance {-# OVERLAPPING #-}

414− ( IsProductType product xs

415− , Length xs ~ n

416− , All ((~) x) xs

417− , ToArray x array )

418− => ToArray product ('NotNull ('PGfixarray n array)) where

419− toArray = K . Encoding.dimensionArray foldlN

420− (unK . toArray @x @array) . unZ . unSOP . from

421− baseOid = baseOid @x @array

422−instance {-# OVERLAPPING #-}

545+instance

423 ( IsProductType product xs

546 ( IsProductType product xs

424− , Length xs ~ n

547+ , Length xs ~ dim

425 , All ((~) x) xs

548 , All ((~) x) xs

426− , ToArray x array )

549+ , ToFixArray x dims ty )

427− => ToArray (Maybe product) ('Null ('PGfixarray n array)) where

550+ => ToFixArray product (dim ': dims) ty where

428− toArray = K . maybe Encoding.nullArray

429− (Encoding.dimensionArray foldlN (unK . toArray @x @array) . unZ . unSOP . from)

551+ toFixArray = K . K . Encoding.dimensionArray foldlN

430− baseOid = baseOid @x @array

552+ (unK . unK . toFixArray @x @dims @ty) . unZ . unSOP . from

431

553

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

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

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

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

434−-- not define instances of `ToParams`. Instead define `Generic` instances

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -492,12 +616,41 @@ instance Aeson.FromJSON x => FromValue 'PGjson (Json x) where

492instance Aeson.FromJSON x => FromValue 'PGjsonb (Jsonb x) where

616instance Aeson.FromJSON x => FromValue 'PGjsonb (Jsonb x) where

493 fromValue = Jsonb <$>

617 fromValue = Jsonb <$>

494 Decoding.jsonb_bytes (left Strict.Text.pack . Aeson.eitherDecodeStrict)

618 Decoding.jsonb_bytes (left Strict.Text.pack . Aeson.eitherDecodeStrict)

495−instance FromArray ('NotNull ('PGvararray ty)) y

619+instance FromValue pg y

620+ => FromValue ('PGvararray ('NotNull pg)) (VarArray (Vector y)) where

621+ fromValue =

622+ let

623+ rep n x = VarArray <$> Vector.replicateM n x

624+ in

625+ Decoding.array $ Decoding.dimensionArray rep

626+ (fromFixArray @'[] @('NotNull pg))

627+instance FromValue pg y

496− => FromValue ('PGvararray ty) y where

628+ => FromValue ('PGvararray ('Null pg)) (VarArray (Vector (Maybe y))) where

497− fromValue = Decoding.array (fromArray @('NotNull ('PGvararray ty)) @y)

629+ fromValue =

498−instance FromArray ('NotNull ('PGfixarray n ty)) y

630+ let

631+ rep n x = VarArray <$> Vector.replicateM n x

632+ in

633+ Decoding.array $ Decoding.dimensionArray rep

634+ (fromFixArray @'[] @('Null pg))

635+instance FromValue pg y

636+ => FromValue ('PGvararray ('NotNull pg)) (VarArray [y]) where

637+ fromValue =

638+ let

639+ rep n x = VarArray <$> replicateM n x

640+ in

641+ Decoding.array $ Decoding.dimensionArray rep

642+ (fromFixArray @'[] @('NotNull pg))

643+instance FromValue pg y

499− => FromValue ('PGfixarray n ty) y where

644+ => FromValue ('PGvararray ('Null pg)) (VarArray [Maybe y]) where

500− fromValue = Decoding.array (fromArray @('NotNull ('PGfixarray n ty)) @y)

645+ fromValue =

646+ let

647+ rep n x = VarArray <$> replicateM n x

648+ in

649+ Decoding.array $ Decoding.dimensionArray rep

650+ (fromFixArray @'[] @('Null pg))

651+instance FromFixArray dims ty y

652+ => FromValue ('PGfixarray dims ty) (FixArray y) where

653+ fromValue = FixArray <$> Decoding.array (fromFixArray @dims @ty @y)

501instance

654instance

502 ( IsEnumType y

655 ( IsEnumType y

503 , HasDatatypeInfo y

656 , HasDatatypeInfo y

@@ -568,49 +721,32 @@ instance FromValue pg y

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

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

569 Decoding.valueParser (fromValue @pg) bytestring

722 Decoding.valueParser (fromValue @pg) bytestring

570

723

724+-- | A `FromFixArray` constraint gives a decoding to a Haskell `Type`

725+-- from the binary format of a PostgreSQL fixed-length array.

726+-- You should not define instances for

727+-- `FromFixArray`, just use the provided instances.

571−class FromArray (ty :: NullityType) (y :: Type) where

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

572− fromArray :: Decoding.Array y

729+ fromFixArray :: Decoding.Array y

573−instance {-# OVERLAPPABLE #-} FromValue pg y

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

574− => FromArray ('NotNull pg) y where

575− fromArray = Decoding.valueArray (fromValue @pg @y)

731+ fromFixArray = Decoding.valueArray (fromValue @pg @y)

576−instance {-# OVERLAPPABLE #-} FromValue pg y

732+instance FromValue pg y => FromFixArray '[] ('Null pg) (Maybe y) where

577− => FromArray ('Null pg) (Maybe y) where

578− fromArray = Decoding.nullableValueArray (fromValue @pg @y)

733+ fromFixArray = Decoding.nullableValueArray (fromValue @pg @y)

579−instance {-# OVERLAPPING #-} FromArray array y

734+instance

580− => FromArray ('NotNull ('PGvararray array)) (Vector y) where

581− fromArray =

582− Decoding.dimensionArray Vector.replicateM (fromArray @array @y)

583−instance {-# OVERLAPPING #-} FromArray array y

584− => FromArray ('Null ('PGvararray array)) (Maybe (Vector y)) where

585− fromArray = Just <$>

586− Decoding.dimensionArray Vector.replicateM (fromArray @array @y)

587−instance {-# OVERLAPPING #-}

588− ( FromArray array y

589− , All ((~) y) ys

590− , SListI ys

591− , IsProductType product ys )

735+ ( IsProductType product ys

592− => FromArray ('NotNull ('PGfixarray n array)) product where

736+ , Length ys ~ dim

593− fromArray =

594− let

595− rep _ = fmap (to . SOP . Z) . replicateMN

596− in

597− Decoding.dimensionArray rep (fromArray @array @y)

598−instance {-# OVERLAPPING #-}

599− ( FromArray array y

600 , All ((~) y) ys

737 , All ((~) y) ys

601− , SListI ys

738+ , FromFixArray dims ty y )

602− , IsProductType product ys )

739+ => FromFixArray (dim ': dims) ty product where

603− => FromArray ('Null ('PGfixarray n array)) (Maybe product) where

740+ fromFixArray =

604− fromArray =

605 let

741 let

606 rep _ = fmap (to . SOP . Z) . replicateMN

742 rep _ = fmap (to . SOP . Z) . replicateMN

607 in

743 in

608− Just <$> Decoding.dimensionArray rep (fromArray @array @y)

744+ Decoding.dimensionArray rep (fromFixArray @dims @ty @y)

609

745

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

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

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

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

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

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

613−-- Instead define `Generic` and `HasDatatypeInfo` instances which in turn

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

614-- provide `FromRow` instances.

750-- provide `FromRow` instances.

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

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

616 -- | >>> :set -XOverloadedStrings

752 -- | >>> :set -XOverloadedStrings

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

633 = fmap fromRecord

769 = fmap fromRecord

634 . hsequence'

770 . hsequence'

635 . htrans (Proxy @FromField) fromField

771 . htrans (Proxy @FromField) fromField

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

773+-- P records

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

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

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

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

778+-- instance

779+-- ( row ~ Join row1 row2

780+-- , FromRow row1 hask1

781+-- , FromRow row2 hask2

782+-- , SListI row

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

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

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

786+-- instance

787+-- ( row ~ Join row1 row23

788+-- , FromRow row1 hask1

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

790+-- , SListI row

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

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

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

794+-- hask1 <- fromRow row1

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

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

797+-- instance

798+-- ( row ~ Join row1 row234

799+-- , FromRow row1 hask1

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

801+-- , SListI row

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

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

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

805+-- hask1 <- fromRow row1

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

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

808+-- instance

809+-- ( row ~ Join row1 row2345

810+-- , FromRow row1 hask1

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

812+-- , SListI row

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

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

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

816+-- hask1 <- fromRow row1

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

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

636

819

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

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

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

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

@@ -659,4 +842,7 @@ replicateMN

659 :: forall x xs m. (All ((~) x) xs, Monad m, SListI xs)

842 :: forall x xs m. (All ((~) x) xs, Monad m, SListI xs)

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

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

661replicateMN mx = hsequence' $

844replicateMN mx = hsequence' $

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

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

846+

847+getOid :: LibPQ.Oid -> Word32

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

squeal-postgresql/src/Squeal/PostgreSQL/Definition.hs+17−968

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

11{-# LANGUAGE

12 AllowAmbiguousTypes

13 , ConstraintKinds

14+ , DeriveAnyClass

14 , DeriveGeneric

15 , DeriveGeneric

16+ , DerivingStrategies

15 , FlexibleContexts

17 , FlexibleContexts

16 , FlexibleInstances

18 , FlexibleInstances

17 , GADTs

19 , GADTs

18− , GeneralizedNewtypeDeriving

19 , LambdaCase

20 , LambdaCase

20 , MultiParamTypeClasses

21 , MultiParamTypeClasses

22+ , OverloadedLabels

21 , OverloadedStrings

23 , OverloadedStrings

22 , RankNTypes

24 , RankNTypes

23 , ScopedTypeVariables

25 , ScopedTypeVariables

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

25 , TypeInType

27 , TypeInType

26 , TypeOperators

28 , TypeOperators

27 , UndecidableSuperClasses

29 , UndecidableSuperClasses

30+ , UndecidableInstances

28#-}

31#-}

30module Squeal.PostgreSQL.Definition

33module Squeal.PostgreSQL.Definition

31 ( -- * Definition

34 ( -- * Definition

32− Definition (UnsafeDefinition, renderDefinition)

35+ Definition (..)

33 , (>>>)

36 , (>>>)

34− -- * Tables

37+ , manipDefinition

35− -- ** Create

36− , createSchema

37− , createSchemaIfNotExists

38− , createTable

39− , createTableIfNotExists

40− , TableConstraintExpression (..)

41− , check

42− , unique

43− , primaryKey

44− , foreignKey

45− , ForeignKeyed

46− , OnDeleteClause (OnDeleteNoAction, OnDeleteRestrict, OnDeleteCascade)

47− , renderOnDeleteClause

48− , OnUpdateClause (OnUpdateNoAction, OnUpdateRestrict, OnUpdateCascade)

49− , renderOnUpdateClause

50− -- ** Drop

51− , dropTable

52− -- ** Alter

53− , alterTable

54− , alterTableRename

55− , AlterTable (UnsafeAlterTable, renderAlterTable)

56− , addConstraint

57− , dropConstraint

58− , AddColumn (addColumn)

59− , dropColumn

60− , renameColumn

61− , alterColumn

62− , AlterColumn (UnsafeAlterColumn, renderAlterColumn)

63− , setDefault

64− , dropDefault

65− , setNotNull

66− , dropNotNull

67− , alterType

68− -- * Views

69− , createView

70− , dropView

71− -- * Types

72− , createTypeEnum

73− , createTypeEnumFrom

74− , createTypeComposite

75− , createTypeCompositeFrom

76− , dropType

77− -- * Columns

78− , ColumnTypeExpression (..)

79− , nullable

80− , notNullable

81− , default_

82− , serial2

83− , smallserial

84− , serial4

85− , serial

86− , serial8

87− , bigserial

88 ) where

38 ) where

90import Control.Category

40import Control.Category

91import Control.DeepSeq

41import Control.DeepSeq

92import Data.ByteString

42import Data.ByteString

93import Data.Monoid

43import Data.Monoid

94−import GHC.TypeLits

95import Prelude hiding ((.), id)

44import Prelude hiding ((.), id)

97−import qualified Generics.SOP as SOP

98import qualified GHC.Generics as GHC

46import qualified GHC.Generics as GHC

100−import Squeal.PostgreSQL.Expression

48+import Squeal.PostgreSQL.Manipulation

101−import Squeal.PostgreSQL.Query

102import Squeal.PostgreSQL.Render

49import Squeal.PostgreSQL.Render

103import Squeal.PostgreSQL.Schema

50import Squeal.PostgreSQL.Schema

104

52+-- $setup

53+-- >>> import Squeal.PostgreSQL

54+

105{-----------------------------------------

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

106statements

56statements

107-----------------------------------------}

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

@@ -121,913 +71,12 @@ instance RenderSQL (Definition schemas0 schemas1) where

121instance Category Definition where

71instance Category Definition where

122 id = UnsafeDefinition ";"

72 id = UnsafeDefinition ";"

123 ddl1 . ddl0 = UnsafeDefinition $

73 ddl1 . ddl0 = UnsafeDefinition $

124− renderDefinition ddl0 <> "\n" <> renderDefinition ddl1

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

125−

126−{-----------------------------------------

127−CREATE statements

128−-----------------------------------------}

129−

130−createSchema

131− :: KnownSymbol sch

132− => Alias sch

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

134−createSchema sch = UnsafeDefinition $

135− "CREATE" <+> "SCHEMA" <+> renderAlias sch <> ";"

136−

137−createSchemaIfNotExists

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

139− => Alias sch

140− -> Definition schemas schemas

141−createSchemaIfNotExists sch = UnsafeDefinition $

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

143− <+> renderAlias sch <> ";"

144−

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

146−

147−>>> :set -XOverloadedLabels

148−>>> :{

149−type Table = '[] :=>

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

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

152−:}

153−

154−>>> :{

155−let

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

157− setup = createTable #tab

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

159−in printSQL setup

160−:}

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

162−-}

163−createTable

164− :: ( KnownSymbol sch

165− , KnownSymbol tab

166− , columns ~ (col ': cols)

167− , SOP.SListI columns

168− , SOP.SListI constraints

169− , Has sch schemas0 schema0

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

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

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

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

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

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

176− -> Definition schemas0 schemas1

177−createTable tab columns constraints = UnsafeDefinition $

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

179

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

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

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

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

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

78+manipDefinition

183−the `Category` of `Definition`s.

79+ :: Manipulation '[] schemas '[] '[]

184−

80+ -- ^ no input or output

185−>>> :set -XOverloadedLabels -XTypeApplications

186−>>> :{

187−type Table = '[] :=>

188− '[ "a" ::: 'NoDef :=> 'Null 'PGint4

189− , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]

190−:}

191−

192−>>> type Schemas = Public '["tab" ::: 'Table Table]

193−

194−>>> :{

195−let

196− setup :: Definition Schemas Schemas

197− setup = createTableIfNotExists #tab

198− (nullable int `as` #a :* nullable real `as` #b) Nil

199−in printSQL setup

200−:}

201−CREATE TABLE IF NOT EXISTS "tab" ("a" int NULL, "b" real NULL);

202−-}

203−createTableIfNotExists

204− :: ( Has sch schemas schema

205− , Has tab schema ('Table (constraints :=> columns))

206− , SOP.SListI columns

207− , SOP.SListI constraints )

208− => QualifiedAlias sch tab -- ^ the name of the table to add

209− -> NP (Aliased (ColumnTypeExpression schemas)) columns

210− -- ^ the names and datatype of each column

211− -> NP (Aliased (TableConstraintExpression sch tab schemas)) constraints

212− -- ^ constraints that must hold for the table

213 -> Definition schemas schemas

81 -> Definition schemas schemas

214−createTableIfNotExists tab columns constraints = UnsafeDefinition $

82+manipDefinition = UnsafeDefinition . (<> ";") . renderSQL

215− "CREATE TABLE IF NOT EXISTS"

216− <+> renderCreation tab columns constraints

217−

218−-- helper function for `createTable` and `createTableIfNotExists`

219−renderCreation

220− :: ( KnownSymbol sch

221− , KnownSymbol tab

222− , SOP.SListI columns

223− , SOP.SListI constraints )

224− => QualifiedAlias sch tab -- ^ the name of the table to add

225− -> NP (Aliased (ColumnTypeExpression schemas0)) columns

226− -- ^ the names and datatype of each column

227− -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints

228− -- ^ constraints that must hold for the table

229− -> ByteString

230−renderCreation tab columns constraints = renderQualifiedAlias tab

231− <+> parenthesized

232− ( renderCommaSeparated renderColumnDef columns

233− <> ( case constraints of

234− Nil -> ""

235− _ -> ", " <>

236− renderCommaSeparated renderConstraint constraints ) )

237− <> ";"

238− where

239− renderColumnDef :: Aliased (ColumnTypeExpression schemas) x -> ByteString

240− renderColumnDef (ty `As` column) =

241− renderAlias column <+> renderColumnTypeExpression ty

242− renderConstraint

243− :: Aliased (TableConstraintExpression sch tab schemas) constraint

244− -> ByteString

245− renderConstraint (constraint `As` alias) =

246− "CONSTRAINT" <+> renderAlias alias <+> renderTableConstraintExpression constraint

247−

248−-- | Data types are a way to limit the kind of data that can be stored in a

249−-- table. For many applications, however, the constraint they provide is

250−-- too coarse. For example, a column containing a product price should

251−-- probably only accept positive values. But there is no standard data type

252−-- that accepts only positive numbers. Another issue is that you might want

253−-- to constrain column data with respect to other columns or rows.

254−-- For example, in a table containing product information,

255−-- there should be only one row for each product number.

256−-- `TableConstraint`s give you as much control over the data in your tables

257−-- as you wish. If a user attempts to store data in a column that would

258−-- violate a constraint, an error is raised. This applies

259−-- even if the value came from the default value definition.

260−newtype TableConstraintExpression

261− (sch :: Symbol)

262− (tab :: Symbol)

263− (schemas :: SchemasType)

264− (constraint :: TableConstraint)

265− = UnsafeTableConstraintExpression

266− { renderTableConstraintExpression :: ByteString }

267− deriving (GHC.Generic,Show,Eq,Ord,NFData)

268−

269−{-| A `check` constraint is the most generic `TableConstraint` type.

270−It allows you to specify that the value in a certain column must satisfy

271−a Boolean (truth-value) expression.

272−

273−>>> :{

274−type Schema = '[

275− "tab" ::: 'Table ('[ "inequality" ::: 'Check '["a","b"]] :=> '[

276− "a" ::: 'NoDef :=> 'NotNull 'PGint4,

277− "b" ::: 'NoDef :=> 'NotNull 'PGint4

278− ])]

279−:}

280−

281−>>> :{

282−let

283− definition :: Definition (Public '[]) (Public Schema)

284− definition = createTable #tab

285− ( (int & notNullable) `as` #a :*

286− (int & notNullable) `as` #b )

287− ( check (#a :* #b) (#a .> #b) `as` #inequality )

288−:}

289−

290−>>> printSQL definition

291−CREATE TABLE "tab" ("a" int NOT NULL, "b" int NOT NULL, CONSTRAINT "inequality" CHECK (("a" > "b")));

292−-}

293−check

294− :: ( Has sch schemas schema

295− , Has tab schema ('Table table)

296− , HasAll aliases (TableToRow table) subcolumns )

297− => NP Alias aliases

298− -- ^ specify the subcolumns which are getting checked

299− -> (forall t. Condition ('[] :=> schemas) '[] 'Ungrouped '[t ::: subcolumns])

300− -- ^ a closed `Condition` on those subcolumns

301− -> TableConstraintExpression sch tab schemas ('Check aliases)

302−check _cols condition = UnsafeTableConstraintExpression $

303− "CHECK" <+> parenthesized (renderExpression condition)

304−

305−{-| A `unique` constraint ensure that the data contained in a column,

306−or a group of columns, is unique among all the rows in the table.

307−

308−>>> :{

309−type Schema = '[

310− "tab" ::: 'Table( '[ "uq_a_b" ::: 'Unique '["a","b"]] :=> '[

311− "a" ::: 'NoDef :=> 'Null 'PGint4,

312− "b" ::: 'NoDef :=> 'Null 'PGint4

313− ])]

314−:}

315−

316−>>> :{

317−let

318− definition :: Definition (Public '[]) (Public Schema)

319− definition = createTable #tab

320− ( (int & nullable) `as` #a :*

321− (int & nullable) `as` #b )

322− ( unique (#a :* #b) `as` #uq_a_b )

323−:}

324−

325−>>> printSQL definition

326−CREATE TABLE "tab" ("a" int NULL, "b" int NULL, CONSTRAINT "uq_a_b" UNIQUE ("a", "b"));

327−-}

328−unique

329− :: ( Has sch schemas schema

330− , Has tab schema('Table table)

331− , HasAll aliases (TableToRow table) subcolumns )

332− => NP Alias aliases

333− -- ^ specify subcolumns which together are unique for each row

334− -> TableConstraintExpression sch tab schemas ('Unique aliases)

335−unique columns = UnsafeTableConstraintExpression $

336− "UNIQUE" <+> parenthesized (commaSeparated (renderAliases columns))

337−

338−{-| A `primaryKey` constraint indicates that a column, or group of columns,

339−can be used as a unique identifier for rows in the table.

340−This requires that the values be both unique and not null.

341−

342−>>> :{

343−type Schema = '[

344− "tab" ::: 'Table ('[ "pk_id" ::: 'PrimaryKey '["id"]] :=> '[

345− "id" ::: 'Def :=> 'NotNull 'PGint4,

346− "name" ::: 'NoDef :=> 'NotNull 'PGtext

347− ])]

348−:}

349−

350−>>> :{

351−let

352− definition :: Definition (Public '[]) (Public Schema)

353− definition = createTable #tab

354− ( serial `as` #id :*

355− (text & notNullable) `as` #name )

356− ( primaryKey #id `as` #pk_id )

357−:}

358−

359−>>> printSQL definition

360−CREATE TABLE "tab" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_id" PRIMARY KEY ("id"));

361−-}

362−primaryKey

363− :: ( Has sch schemas schema

364− , Has tab schema ('Table table)

365− , HasAll aliases (TableToColumns table) subcolumns

366− , AllNotNull subcolumns )

367− => NP Alias aliases

368− -- ^ specify the subcolumns which together form a primary key.

369− -> TableConstraintExpression sch tab schemas ('PrimaryKey aliases)

370−primaryKey columns = UnsafeTableConstraintExpression $

371− "PRIMARY KEY" <+> parenthesized (commaSeparated (renderAliases columns))

372−

373−{-| A `foreignKey` specifies that the values in a column

374−(or a group of columns) must match the values appearing in some row of

375−another table. We say this maintains the referential integrity

376−between two related tables.

377−

378−>>> :{

379−type Schema =

380− '[ "users" ::: 'Table (

381− '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>

382− '[ "id" ::: 'Def :=> 'NotNull 'PGint4

383− , "name" ::: 'NoDef :=> 'NotNull 'PGtext

384− ])

385− , "emails" ::: 'Table (

386− '[ "pk_emails" ::: 'PrimaryKey '["id"]

387− , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]

388− ] :=>

389− '[ "id" ::: 'Def :=> 'NotNull 'PGint4

390− , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4

391− , "email" ::: 'NoDef :=> 'Null 'PGtext

392− ])

393− ]

394−:}

395−

396−>>> :{

397−let

398− setup :: Definition (Public '[]) (Public Schema)

399− setup =

400− createTable #users

401− ( serial `as` #id :*

402− (text & notNullable) `as` #name )

403− ( primaryKey #id `as` #pk_users ) >>>

404− createTable #emails

405− ( serial `as` #id :*

406− (int & notNullable) `as` #user_id :*

407− (text & nullable) `as` #email )

408− ( primaryKey #id `as` #pk_emails :*

409− foreignKey #user_id #users #id

410− OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

411−in printSQL setup

412−:}

413−CREATE TABLE "users" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_users" PRIMARY KEY ("id"));

414−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);

415−

416−A `foreignKey` can even be a table self-reference.

417−

418−>>> :{

419−type Schema =

420− '[ "employees" ::: 'Table (

421− '[ "employees_pk" ::: 'PrimaryKey '["id"]

422− , "employees_employer_fk" ::: 'ForeignKey '["employer_id"] "employees" '["id"]

423− ] :=>

424− '[ "id" ::: 'Def :=> 'NotNull 'PGint4

425− , "name" ::: 'NoDef :=> 'NotNull 'PGtext

426− , "employer_id" ::: 'NoDef :=> 'Null 'PGint4

427− ])

428− ]

429−:}

430−

431−>>> :{

432−let

433− setup :: Definition (Public '[]) (Public Schema)

434− setup =

435− createTable #employees

436− ( serial `as` #id :*

437− (text & notNullable) `as` #name :*

438− (integer & nullable) `as` #employer_id )

439− ( primaryKey #id `as` #employees_pk :*

440− foreignKey #employer_id #employees #id

441− OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )

442−in printSQL setup

443−:}

444−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);

445−-}

446−foreignKey

447− :: (ForeignKeyed schemas sch schema child parent

448− table reftable

449− columns refcolumns

450− constraints cols

451− reftys tys )

452− => NP Alias columns

453− -- ^ column or columns in the table

454− -> Alias parent

455− -- ^ reference table

456− -> NP Alias refcolumns

457− -- ^ reference column or columns in the reference table

458− -> OnDeleteClause

459− -- ^ what to do when reference is deleted

460− -> OnUpdateClause

461− -- ^ what to do when reference is updated

462− -> TableConstraintExpression sch child schemas

463− ('ForeignKey columns parent refcolumns)

464−foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $

465− "FOREIGN KEY" <+> parenthesized (commaSeparated (renderAliases keys))

466− <+> "REFERENCES" <+> renderAlias parent

467− <+> parenthesized (commaSeparated (renderAliases refs))

468− <+> renderOnDeleteClause ondel

469− <+> renderOnUpdateClause onupd

470−

471−-- | A constraint synonym between types involved in a foreign key constraint.

472−type ForeignKeyed schemas

473− sch

474− schema

475− child parent

476− table reftable

477− columns refcolumns

478− constraints cols

479− reftys tys =

480− ( Has sch schemas schema

481− , Has child schema ('Table table)

482− , Has parent schema ('Table reftable)

483− , HasAll columns (TableToColumns table) tys

484− , reftable ~ (constraints :=> cols)

485− , HasAll refcolumns cols reftys

486− , SOP.AllZip SamePGType tys reftys

487− , Uniquely refcolumns constraints )

488−

489−-- | `OnDeleteClause` indicates what to do with rows that reference a deleted row.

490−data OnDeleteClause

491− = OnDeleteNoAction

492− -- ^ if any referencing rows still exist when the constraint is checked,

493− -- an error is raised

494− | OnDeleteRestrict -- ^ prevents deletion of a referenced row

495− | OnDeleteCascade

496− -- ^ specifies that when a referenced row is deleted,

497− -- row(s) referencing it should be automatically deleted as well

498− deriving (GHC.Generic,Show,Eq,Ord)

499−instance NFData OnDeleteClause

500−

501−-- | Render `OnDeleteClause`.

502−renderOnDeleteClause :: OnDeleteClause -> ByteString

503−renderOnDeleteClause = \case

504− OnDeleteNoAction -> "ON DELETE NO ACTION"

505− OnDeleteRestrict -> "ON DELETE RESTRICT"

506− OnDeleteCascade -> "ON DELETE CASCADE"

507−

508−-- | Analagous to `OnDeleteClause` there is also `OnUpdateClause` which is invoked

509−-- when a referenced column is changed (updated).

510−data OnUpdateClause

511− = OnUpdateNoAction

512− -- ^ if any referencing rows has not changed when the constraint is checked,

513− -- an error is raised

514− | OnUpdateRestrict -- ^ prevents update of a referenced row

515− | OnUpdateCascade

516− -- ^ the updated values of the referenced column(s) should be copied

517− -- into the referencing row(s)

518− deriving (GHC.Generic,Show,Eq,Ord)

519−instance NFData OnUpdateClause

520−

521−-- | Render `OnUpdateClause`.

522−renderOnUpdateClause :: OnUpdateClause -> ByteString

523−renderOnUpdateClause = \case

524− OnUpdateNoAction -> "ON UPDATE NO ACTION"

525− OnUpdateRestrict -> "ON UPDATE RESTRICT"

526− OnUpdateCascade -> "ON UPDATE CASCADE"

527−

528−{-----------------------------------------

529−DROP statements

530−-----------------------------------------}

531−

532−-- | `dropTable` removes a table from the schema.

533−--

534−-- >>> :{

535−-- let

536−-- definition :: Definition '["public" ::: '["muh_table" ::: 'Table t]] (Public '[])

537−-- definition = dropTable #muh_table

538−-- :}

539−--

540−-- >>> printSQL definition

541−-- DROP TABLE "muh_table";

542−dropTable

543− :: ( Has sch schemas schema

544− , Has tab schema ('Table table))

545− => QualifiedAlias sch tab -- ^ table to remove

546− -> Definition schemas (Alter sch (Drop tab schema) schemas)

547−dropTable tab = UnsafeDefinition $ "DROP TABLE" <+> renderQualifiedAlias tab <> ";"

548−

549−{-----------------------------------------

550−ALTER statements

551−-----------------------------------------}

552−

553−-- | `alterTable` changes the definition of a table from the schema.

554−alterTable

555− :: (Has sch schemas schema, Has tab schema ('Table table0))

556− => QualifiedAlias sch tab -- ^ table to alter

557− -> AlterTable sch tab schemas table1 -- ^ alteration to perform

558− -> Definition schemas (Alter sch (Alter tab ('Table table1) schema) schemas)

559−alterTable tab alteration = UnsafeDefinition $

560− "ALTER TABLE"

561− <+> renderQualifiedAlias tab

562− <+> renderAlterTable alteration

563− <> ";"

564−

565−-- | `alterTableRename` changes the name of a table from the schema.

566−--

567−-- >>> printSQL $ alterTableRename #foo #bar

568−-- ALTER TABLE "foo" RENAME TO "bar";

569−alterTableRename

570− :: (KnownSymbol table0, KnownSymbol table1)

571− => Alias table0 -- ^ table to rename

572− -> Alias table1 -- ^ what to rename it

573− -> Definition schema (Rename table0 table1 schema)

574−alterTableRename table0 table1 = UnsafeDefinition $

575− "ALTER TABLE" <+> renderAlias table0

576− <+> "RENAME TO" <+> renderAlias table1 <> ";"

577−

578−-- | An `AlterTable` describes the alteration to perform on the columns

579−-- of a table.

580−newtype AlterTable

581− (sch :: Symbol)

582− (tab :: Symbol)

583− (schemas :: SchemasType)

584− (table :: TableType) =

585− UnsafeAlterTable {renderAlterTable :: ByteString}

586− deriving (GHC.Generic,Show,Eq,Ord,NFData)

587−

588−-- | An `addConstraint` adds a table constraint.

589−--

590−-- >>> :{

591−-- let

592−-- definition :: Definition

593−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

594−-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: 'Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

595−-- definition = alterTable #tab (addConstraint #positive (check #col (#col .> 0)))

596−-- in printSQL definition

597−-- :}

598−-- ALTER TABLE "tab" ADD CONSTRAINT "positive" CHECK (("col" > 0));

599−addConstraint

600− :: ( KnownSymbol alias

601− , Has sch schemas schema

602− , Has tab schema ('Table table0)

603− , table0 ~ (constraints :=> columns)

604− , table1 ~ (Create alias constraint constraints :=> columns) )

605− => Alias alias

606− -> TableConstraintExpression sch tab schemas constraint

607− -- ^ constraint to add

608− -> AlterTable sch tab schemas table1

609−addConstraint alias constraint = UnsafeAlterTable $

610− "ADD" <+> "CONSTRAINT" <+> renderAlias alias

611− <+> renderTableConstraintExpression constraint

612−

613−-- | A `dropConstraint` drops a table constraint.

614−--

615−-- >>> :{

616−-- let

617−-- definition :: Definition

618−-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

619−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

620−-- definition = alterTable #tab (dropConstraint #positive)

621−-- in printSQL definition

622−-- :}

623−-- ALTER TABLE "tab" DROP CONSTRAINT "positive";

624−dropConstraint

625− :: ( KnownSymbol constraint

626− , Has sch schemas schema

627− , Has tab schema ('Table table0)

628− , table0 ~ (constraints :=> columns)

629− , table1 ~ (Drop constraint constraints :=> columns) )

630− => Alias constraint

631− -- ^ constraint to drop

632− -> AlterTable sch tab schemas table1

633−dropConstraint constraint = UnsafeAlterTable $

634− "DROP" <+> "CONSTRAINT" <+> renderAlias constraint

635−

636−-- | An `AddColumn` is either @NULL@ or has @DEFAULT@.

637−class AddColumn ty where

638− -- | `addColumn` adds a new column, initially filled with whatever

639− -- default value is given or with @NULL@.

640− --

641− -- >>> :{

642− -- let

643− -- definition :: Definition

644− -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

645− -- '["public" ::: '["tab" ::: 'Table ('[] :=>

646− -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

647− -- , "col2" ::: 'Def :=> 'Null 'PGtext ])]]

648− -- definition = alterTable #tab (addColumn #col2 (text & nullable & default_ "foo"))

649− -- in printSQL definition

650− -- :}

651− -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL DEFAULT E'foo';

652− --

653− -- >>> :{

654− -- let

655− -- definition :: Definition

656− -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

657− -- '["public" ::: '["tab" ::: 'Table ('[] :=>

658− -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

659− -- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

660− -- definition = alterTable #tab (addColumn #col2 (text & nullable))

661− -- in printSQL definition

662− -- :}

663− -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL;

664− addColumn

665− :: ( KnownSymbol column

666− , Has sch schemas schema

667− , Has tab schema ('Table table0)

668− , table0 ~ (constraints :=> columns) )

669− => Alias column -- ^ column to add

670− -> ColumnTypeExpression schemas ty -- ^ type of the new column

671− -> AlterTable sch tab schemas (constraints :=> Create column ty columns)

672− addColumn column ty = UnsafeAlterTable $

673− "ADD COLUMN" <+> renderAlias column <+> renderColumnTypeExpression ty

674−instance {-# OVERLAPPING #-} AddColumn ('Def :=> ty)

675−instance {-# OVERLAPPABLE #-} AddColumn ('NoDef :=> 'Null ty)

676−

677−-- | A `dropColumn` removes a column. Whatever data was in the column

678−-- disappears. Table constraints involving the column are dropped, too.

679−-- However, if the column is referenced by a foreign key constraint of

680−-- another table, PostgreSQL will not silently drop that constraint.

681−--

682−-- >>> :{

683−-- let

684−-- definition :: Definition

685−-- '["public" ::: '["tab" ::: 'Table ('[] :=>

686−-- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

687−-- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

688−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

689−-- definition = alterTable #tab (dropColumn #col2)

690−-- in printSQL definition

691−-- :}

692−-- ALTER TABLE "tab" DROP COLUMN "col2";

693−dropColumn

694− :: ( KnownSymbol column

695− , Has sch schemas schema

696− , Has tab schema ('Table table0)

697− , table0 ~ (constraints :=> columns)

698− , table1 ~ (constraints :=> Drop column columns) )

699− => Alias column -- ^ column to remove

700− -> AlterTable sch tab schemas table1

701−dropColumn column = UnsafeAlterTable $

702− "DROP COLUMN" <+> renderAlias column

703−

704−-- | A `renameColumn` renames a column.

705−--

706−-- >>> :{

707−-- let

708−-- definition :: Definition

709−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["foo" ::: 'NoDef :=> 'Null 'PGint4])]]

710−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["bar" ::: 'NoDef :=> 'Null 'PGint4])]]

711−-- definition = alterTable #tab (renameColumn #foo #bar)

712−-- in printSQL definition

713−-- :}

714−-- ALTER TABLE "tab" RENAME COLUMN "foo" TO "bar";

715−renameColumn

716− :: ( KnownSymbol column0

717− , KnownSymbol column1

718− , Has sch schemas schema

719− , Has tab schema ('Table table0)

720− , table0 ~ (constraints :=> columns)

721− , table1 ~ (constraints :=> Rename column0 column1 columns) )

722− => Alias column0 -- ^ column to rename

723− -> Alias column1 -- ^ what to rename the column

724− -> AlterTable sch tab schemas table1

725−renameColumn column0 column1 = UnsafeAlterTable $

726− "RENAME COLUMN" <+> renderAlias column0 <+> "TO" <+> renderAlias column1

727−

728−-- | An `alterColumn` alters a single column.

729−alterColumn

730− :: ( KnownSymbol column

731− , Has sch schemas schema

732− , Has tab schema ('Table table0)

733− , table0 ~ (constraints :=> columns)

734− , Has column columns ty0

735− , table1 ~ (constraints :=> Alter column ty1 columns))

736− => Alias column -- ^ column to alter

737− -> AlterColumn schemas ty0 ty1 -- ^ alteration to perform

738− -> AlterTable sch tab schemas table1

739−alterColumn column alteration = UnsafeAlterTable $

740− "ALTER COLUMN" <+> renderAlias column <+> renderAlterColumn alteration

741−

742−-- | An `AlterColumn` describes the alteration to perform on a single column.

743−newtype AlterColumn (schemas :: SchemasType) (ty0 :: ColumnType) (ty1 :: ColumnType) =

744− UnsafeAlterColumn {renderAlterColumn :: ByteString}

745− deriving (GHC.Generic,Show,Eq,Ord,NFData)

746−

747−-- | A `setDefault` sets a new default for a column. Note that this doesn't

748−-- affect any existing rows in the table, it just changes the default for

749−-- future insert and update commands.

750−--

751−-- >>> :{

752−-- let

753−-- definition :: Definition

754−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

755−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]

756−-- definition = alterTable #tab (alterColumn #col (setDefault 5))

757−-- in printSQL definition

758−-- :}

759−-- ALTER TABLE "tab" ALTER COLUMN "col" SET DEFAULT 5;

760−setDefault

761− :: Expression ('[] :=> schemas) '[] 'Ungrouped '[] ty -- ^ default value to set

762− -> AlterColumn schemas (constraint :=> ty) ('Def :=> ty)

763−setDefault expression = UnsafeAlterColumn $

764− "SET DEFAULT" <+> renderExpression expression

765−

766−-- | A `dropDefault` removes any default value for a column.

767−--

768−-- >>> :{

769−-- let

770−-- definition :: Definition

771−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]

772−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

773−-- definition = alterTable #tab (alterColumn #col dropDefault)

774−-- in printSQL definition

775−-- :}

776−-- ALTER TABLE "tab" ALTER COLUMN "col" DROP DEFAULT;

777−dropDefault :: AlterColumn schemas ('Def :=> ty) ('NoDef :=> ty)

778−dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"

779−

780−-- | A `setNotNull` adds a @NOT NULL@ constraint to a column.

781−-- The constraint will be checked immediately, so the table data must satisfy

782−-- the constraint before it can be added.

783−--

784−-- >>> :{

785−-- let

786−-- definition :: Definition

787−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

788−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

789−-- definition = alterTable #tab (alterColumn #col setNotNull)

790−-- in printSQL definition

791−-- :}

792−-- ALTER TABLE "tab" ALTER COLUMN "col" SET NOT NULL;

793−setNotNull

794− :: AlterColumn schemas (constraint :=> 'Null ty) (constraint :=> 'NotNull ty)

795−setNotNull = UnsafeAlterColumn $ "SET NOT NULL"

796−

797−-- | A `dropNotNull` drops a @NOT NULL@ constraint from a column.

798−--

799−-- >>> :{

800−-- let

801−-- definition :: Definition

802−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

803−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

804−-- definition = alterTable #tab (alterColumn #col dropNotNull)

805−-- in printSQL definition

806−-- :}

807−-- ALTER TABLE "tab" ALTER COLUMN "col" DROP NOT NULL;

808−dropNotNull

809− :: AlterColumn schemas (constraint :=> 'NotNull ty) (constraint :=> 'Null ty)

810−dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"

811−

812−-- | An `alterType` converts a column to a different data type.

813−-- This will succeed only if each existing entry in the column can be

814−-- converted to the new type by an implicit cast.

815−--

816−-- >>> :{

817−-- let

818−-- definition :: Definition

819−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

820−-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGnumeric])]]

821−-- definition =

822−-- alterTable #tab (alterColumn #col (alterType (numeric & notNullable)))

823−-- in printSQL definition

824−-- :}

825−-- ALTER TABLE "tab" ALTER COLUMN "col" TYPE numeric NOT NULL;

826−alterType :: ColumnTypeExpression schemas ty -> AlterColumn schemas ty0 ty

827−alterType ty = UnsafeAlterColumn $ "TYPE" <+> renderColumnTypeExpression ty

828−

829−{- | Create a view.

830−>>> type ABC = '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4]

831−>>> type BC = '["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4]

832−>>> :{

833−let

834− definition :: Definition

835− '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC)]]

836− '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC), "bc" ::: 'View BC]]

837− definition =

838− createView #bc (select (#b :* #c) (from (table #abc)))

839−in printSQL definition

840−:}

841−CREATE VIEW "bc" AS SELECT "b" AS "b", "c" AS "c" FROM "abc" AS "abc";

842−-}

843−createView

844− :: (KnownSymbol sch, KnownSymbol vw, Has sch schemas schema)

845− => QualifiedAlias sch vw -- ^ the name of the view to add

846− -> Query ('[] :=> schemas) '[] view -- ^ query

847− -> Definition schemas (Alter sch (Create vw ('View view) schema) schemas)

848−createView alias query = UnsafeDefinition $

849− "CREATE" <+> "VIEW" <+> renderQualifiedAlias alias <+> "AS"

850− <+> renderQuery query <> ";"

851−

852−-- | Drop a view.

853−--

854−-- >>> :{

855−-- let

856−-- definition :: Definition

857−-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])

858−-- , "bc" ::: 'View ('["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4])]]

859−-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])]]

860−-- definition = dropView #bc

861−-- in printSQL definition

862−-- :}

863−-- DROP VIEW "bc";

864−dropView

865− :: (Has sch schemas schema, Has vw schema ('View view))

866− => QualifiedAlias sch vw -- ^ view to remove

867− -> Definition schemas (Alter sch (Drop vw schema) schemas)

868−dropView vw = UnsafeDefinition $ "DROP VIEW" <+> renderQualifiedAlias vw <> ";"

869−

870−-- | Enumerated types are created using the `createTypeEnum` command, for example

871−--

872−-- >>> printSQL $ (createTypeEnum #mood (label @"sad" :* label @"ok" :* label @"happy") :: Definition (Public '[]) '["public" ::: '["mood" ::: 'Typedef ('PGenum '["sad","ok","happy"])]])

873−-- CREATE TYPE "mood" AS ENUM ('sad', 'ok', 'happy');

874−createTypeEnum

875− :: (KnownSymbol enum, Has sch schemas schema, SOP.All KnownSymbol labels)

876− => QualifiedAlias sch enum

877− -- ^ name of the user defined enumerated type

878− -> NP PGlabel labels

879− -- ^ labels of the enumerated type

880− -> Definition schemas (Alter sch (Create enum ('Typedef ('PGenum labels)) schema) schemas)

881−createTypeEnum enum labels = UnsafeDefinition $

882− "CREATE" <+> "TYPE" <+> renderQualifiedAlias enum <+> "AS" <+> "ENUM" <+>

883− parenthesized (commaSeparated (renderLabels labels)) <> ";"

884−

885−-- | Enumerated types can also be generated from a Haskell type, for example

886−--

887−-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

888−-- >>> instance SOP.Generic Schwarma

889−-- >>> instance SOP.HasDatatypeInfo Schwarma

890−-- >>> :{

891−-- let

892−-- createSchwarma :: Definition (Public '[]) '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]]

893−-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma

894−-- in

895−-- printSQL createSchwarma

896−-- :}

897−-- CREATE TYPE "schwarma" AS ENUM ('Beef', 'Lamb', 'Chicken');

898−createTypeEnumFrom

899− :: forall hask sch enum schemas schema.

900− ( SOP.Generic hask

901− , SOP.All KnownSymbol (LabelsPG hask)

902− , KnownSymbol enum

903− , Has sch schemas schema )

904− => QualifiedAlias sch enum

905− -- ^ name of the user defined enumerated type

906− -> Definition schemas (Alter sch (Create enum ('Typedef (PG (Enumerated hask))) schema) schemas)

907−createTypeEnumFrom enum = createTypeEnum enum

908− (SOP.hpure label :: NP PGlabel (LabelsPG hask))

909−

910−{- | `createTypeComposite` creates a composite type. The composite type is

911−specified by a list of attribute names and data types.

912−

913−>>> :{

914−type PGcomplex = 'PGcomposite

915− '[ "real" ::: 'NotNull 'PGfloat8

916− , "imaginary" ::: 'NotNull 'PGfloat8 ]

917−:}

918−

919−>>> :{

920−let

921− setup :: Definition (Public '[]) '["public" ::: '["complex" ::: 'Typedef PGcomplex]]

922− setup = createTypeComposite #complex

923− (float8 `as` #real :* float8 `as` #imaginary)

924−in printSQL setup

925−:}

926−CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

927−-}

928−createTypeComposite

929− :: (KnownSymbol ty, Has sch schemas schema, SOP.SListI fields)

930− => QualifiedAlias sch ty

931− -- ^ name of the user defined composite type

932− -> NP (Aliased (TypeExpression schemas)) fields

933− -- ^ list of attribute names and data types

934− -> Definition schemas (Alter sch (Create ty ('Typedef ('PGcomposite fields)) schema) schemas)

935−createTypeComposite ty fields = UnsafeDefinition $

936− "CREATE" <+> "TYPE" <+> renderQualifiedAlias ty <+> "AS" <+> parenthesized

937− (renderCommaSeparated renderField fields) <> ";"

938− where

939− renderField :: Aliased (TypeExpression schemas) x -> ByteString

940− renderField (typ `As` alias) =

941− renderAlias alias <+> renderTypeExpression typ

942−

943−-- | Composite types can also be generated from a Haskell type, for example

944−--

945−-- >>> data Complex = Complex {real :: Double, imaginary :: Double} deriving GHC.Generic

946−-- >>> instance SOP.Generic Complex

947−-- >>> instance SOP.HasDatatypeInfo Complex

948−-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]

949−-- >>> :{

950−-- let

951−-- createComplex :: Definition (Public '[]) (Public Schema)

952−-- createComplex = createTypeCompositeFrom @Complex #complex

953−-- in

954−-- printSQL createComplex

955−-- :}

956−-- CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

957−createTypeCompositeFrom

958− :: forall hask sch ty schemas schema.

959− ( SOP.All (FieldTyped schemas) (RowPG hask)

960− , KnownSymbol ty

961− , Has sch schemas schema )

962− => QualifiedAlias sch ty

963− -- ^ name of the user defined composite type

964− -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)

965−createTypeCompositeFrom ty = createTypeComposite ty

966− (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype

967− :: NP (Aliased (TypeExpression schemas)) (RowPG hask))

968−

969−class FieldTyped schemas ty where

970− fieldtype :: Aliased (TypeExpression schemas) ty

971−instance (KnownSymbol alias, PGTyped schemas ty)

972− => FieldTyped schemas (alias ::: ty) where

973− fieldtype = pgtype `As` Alias

974−

975−-- | Drop a type.

976−--

977−-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

978−-- >>> instance SOP.Generic Schwarma

979−-- >>> instance SOP.HasDatatypeInfo Schwarma

980−-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))

981−-- DROP TYPE "schwarma";

982−dropType

983− :: (Has sch schemas schema, Has td schema ('Typedef ty))

984− => QualifiedAlias sch td

985− -- ^ name of the user defined type

986− -> Definition schemas (Alter sch (Drop td schema) schemas)

987−dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderQualifiedAlias tydef <> ";"

988−

989−-- | `ColumnTypeExpression`s are used in `createTable` commands.

990−newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)

991− = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }

992− deriving (GHC.Generic,Show,Eq,Ord,NFData)

993−

994−-- | used in `createTable` commands as a column constraint to note that

995−-- @NULL@ may be present in a column

996−nullable

997− :: TypeExpression schemas (nullity ty)

998− -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)

999−nullable ty = UnsafeColumnTypeExpression $ renderTypeExpression ty <+> "NULL"

1000−

1001−-- | used in `createTable` commands as a column constraint to ensure

1002−-- @NULL@ is not present in a column

1003−notNullable

1004− :: TypeExpression schemas (nullity ty)

1005− -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)

1006−notNullable ty = UnsafeColumnTypeExpression $ renderTypeExpression ty <+> "NOT NULL"

1007−

1008−-- | used in `createTable` commands as a column constraint to give a default

1009−default_

1010− :: Expression ('[] :=> schemas) '[] 'Ungrouped '[] ty

1011− -> ColumnTypeExpression schemas ('NoDef :=> ty)

1012− -> ColumnTypeExpression schemas ('Def :=> ty)

1013−default_ x ty = UnsafeColumnTypeExpression $

1014− renderColumnTypeExpression ty <+> "DEFAULT" <+> renderExpression x

1015−

1016−-- | not a true type, but merely a notational convenience for creating

1017−-- unique identifier columns with type `PGint2`

1018−serial2, smallserial

1019− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)

1020−serial2 = UnsafeColumnTypeExpression "serial2"

1021−smallserial = UnsafeColumnTypeExpression "smallserial"

1022−-- | not a true type, but merely a notational convenience for creating

1023−-- unique identifier columns with type `PGint4`

1024−serial4, serial

1025− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)

1026−serial4 = UnsafeColumnTypeExpression "serial4"

1027−serial = UnsafeColumnTypeExpression "serial"

1028−-- | not a true type, but merely a notational convenience for creating

1029−-- unique identifier columns with type `PGint8`

1030−serial8, bigserial

1031− :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)

1032−serial8 = UnsafeColumnTypeExpression "serial8"

1033−bigserial = UnsafeColumnTypeExpression "bigserial"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Function.hsnew file+238

@@ -0,0 +1,238 @@

1+{-|

2+Module: Squeal.PostgreSQL.Definition.Function

3+Description: Create and drop function and operator definitions

4+Copyright: (c) Eitan Chatav, 2017

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Create and drop function and operator definitions.

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , ConstraintKinds

14+ , DeriveAnyClass

15+ , DeriveGeneric

16+ , DerivingStrategies

17+ , FlexibleContexts

18+ , FlexibleInstances

19+ , GADTs

20+ , LambdaCase

21+ , MultiParamTypeClasses

22+ , OverloadedLabels

23+ , OverloadedStrings

24+ , RankNTypes

25+ , ScopedTypeVariables

26+ , TypeApplications

27+ , TypeInType

28+ , TypeOperators

29+ , UndecidableSuperClasses

30+#-}

31+

32+module Squeal.PostgreSQL.Definition.Function

33+ ( createFunction

34+ , createOrReplaceFunction

35+ , createSetFunction

36+ , createOrReplaceSetFunction

37+ , createBinaryOp

38+ , createLeftOp

39+ , createRightOp

40+ , dropFunction

41+ , dropFunctionIfExists

42+ , dropOperator

43+ , dropOperatorIfExists

44+ , FunctionDefinition(..)

45+ , languageSqlExpr

46+ , languageSqlQuery

47+ ) where

48+

49+import Control.DeepSeq

50+import Data.ByteString

51+import GHC.TypeLits

52+

53+import qualified Generics.SOP as SOP

54+import qualified GHC.Generics as GHC

55+

56+import Squeal.PostgreSQL.Alias

57+import Squeal.PostgreSQL.Definition

58+import Squeal.PostgreSQL.Expression

59+import Squeal.PostgreSQL.Expression.Type

60+import Squeal.PostgreSQL.List

61+import Squeal.PostgreSQL.Query

62+import Squeal.PostgreSQL.Render

63+import Squeal.PostgreSQL.Schema

64+

65+-- $setup

66+-- >>> import Squeal.PostgreSQL

67+

68+createFunction

69+ :: ( Has sch schemas schema

70+ , KnownSymbol fun

71+ , SOP.SListI args )

72+ => QualifiedAlias sch fun

73+ -> NP (TypeExpression schemas) args

74+ -> TypeExpression schemas ret

75+ -> FunctionDefinition schemas args ('Returns ret)

76+ -> Definition schemas (Alter sch (Create fun ('Function (args :=> 'Returns ret)) schema) schemas)

77+createFunction fun args ret fundef = UnsafeDefinition $

78+ "CREATE" <+> "FUNCTION" <+> renderSQL fun

79+ <+> parenthesized (renderCommaSeparated renderSQL args)

80+ <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"

81+

82+createOrReplaceFunction

83+ :: ( Has sch schemas schema

84+ , KnownSymbol fun

85+ , SOP.SListI args )

86+ => QualifiedAlias sch fun

87+ -> NP (TypeExpression schemas) args

88+ -> TypeExpression schemas ret

89+ -> FunctionDefinition schemas args ('Returns ret)

90+ -> Definition schemas (Alter sch (CreateOrReplace fun ('Function (args :=> 'Returns ret)) schema) schemas)

91+createOrReplaceFunction fun args ret fundef = UnsafeDefinition $

92+ "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun

93+ <+> parenthesized (renderCommaSeparated renderSQL args)

94+ <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"

95+

96+languageSqlExpr

97+ :: Expression '[] '[] 'Ungrouped schemas args '[] ret

98+ -> FunctionDefinition schemas args ('Returns ret)

99+languageSqlExpr expr = UnsafeFunctionDefinition $

100+ "language sql as"

101+ <+> "$$" <+> renderSQL (values_ (expr `as` #ret)) <+> "$$"

102+

103+languageSqlQuery

104+ :: Query '[] '[] schemas args rets

105+ -> FunctionDefinition schemas args ('ReturnsTable rets)

106+languageSqlQuery qry = UnsafeFunctionDefinition $

107+ "language sql as" <+> "$$" <+> renderSQL qry <+> "$$"

108+

109+createSetFunction

110+ :: ( Has sch schemas schema

111+ , KnownSymbol fun

112+ , SOP.SListI args

113+ , SOP.SListI rets )

114+ => QualifiedAlias sch fun

115+ -> NP (TypeExpression schemas) args

116+ -> NP (Aliased (TypeExpression schemas)) rets

117+ -> FunctionDefinition schemas args ('ReturnsTable rets)

118+ -> Definition schemas (Alter sch (Create fun ('Function (args :=> 'ReturnsTable rets)) schema) schemas)

119+createSetFunction fun args rets fundef = UnsafeDefinition $

120+ "CREATE" <+> "FUNCTION" <+> renderSQL fun

121+ <+> parenthesized (renderCommaSeparated renderSQL args)

122+ <+> "RETURNS" <+> "TABLE"

123+ <+> parenthesized (renderCommaSeparated renderRet rets)

124+ <+> renderSQL fundef <> ";"

125+ where

126+ renderRet :: Aliased (TypeExpression s) r -> ByteString

127+ renderRet (ty `As` col) = renderSQL col <+> renderSQL ty

128+

129+createOrReplaceSetFunction

130+ :: ( Has sch schemas schema

131+ , KnownSymbol fun

132+ , SOP.SListI args

133+ , SOP.SListI rets )

134+ => QualifiedAlias sch fun

135+ -> NP (TypeExpression schemas) args

136+ -> NP (Aliased (TypeExpression schemas)) rets

137+ -> FunctionDefinition schemas args ('ReturnsTable rets)

138+ -> Definition schemas (Alter sch (CreateOrReplace fun ('Function (args :=> 'ReturnsTable rets)) schema) schemas)

139+createOrReplaceSetFunction fun args rets fundef = UnsafeDefinition $

140+ "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun

141+ <+> parenthesized (renderCommaSeparated renderSQL args)

142+ <+> "RETURNS" <+> "TABLE"

143+ <+> parenthesized (renderCommaSeparated renderRet rets)

144+ <+> renderSQL fundef <> ";"

145+ where

146+ renderRet :: Aliased (TypeExpression s) r -> ByteString

147+ renderRet (ty `As` col) = renderSQL col <+> renderSQL ty

148+

149+createBinaryOp

150+ :: forall op fun sch schemas schema x y z.

151+ ( Has sch schemas schema

152+ , Has fun schema ('Function ('[x,y] :=> 'Returns z))

153+ , KnownSymbol op )

154+ => QualifiedAlias sch fun

155+ -> TypeExpression schemas x

156+ -> TypeExpression schemas y

157+ -> Definition schemas

158+ (Alter sch (Create op ('Operator ('BinaryOp x y z)) schema) schemas)

159+createBinaryOp fun x y = UnsafeDefinition $

160+ "CREATE" <+> "OPERATOR" <+> renderSymbol @op

161+ <+> parenthesized (commaSeparated opdef)

162+ where

163+ opdef =

164+ [ "FUNCTION" <+> "=" <+> renderSQL fun

165+ , "LEFTARG" <+> "=" <+> renderSQL x

166+ , "RIGHTARG" <+> "=" <+> renderSQL y ]

167+

168+createLeftOp

169+ :: forall op fun sch schemas schema x y.

170+ ( Has sch schemas schema

171+ , Has fun schema ('Function ('[x] :=> 'Returns y))

172+ , KnownSymbol op )

173+ => QualifiedAlias sch fun

174+ -> TypeExpression schemas x

175+ -> Definition schemas

176+ (Alter sch (Create op ('Operator ('LeftOp x y)) schema) schemas)

177+createLeftOp fun x = UnsafeDefinition $

178+ "CREATE" <+> "OPERATOR" <+> renderSymbol @op

179+ <+> parenthesized (commaSeparated opdef)

180+ where

181+ opdef =

182+ [ "FUNCTION" <+> "=" <+> renderSQL fun

183+ , "RIGHTARG" <+> "=" <+> renderSQL x ]

184+

185+createRightOp

186+ :: forall op fun sch schemas schema x y.

187+ ( Has sch schemas schema

188+ , Has fun schema ('Function ('[x] :=> 'Returns y))

189+ , KnownSymbol op )

190+ => QualifiedAlias sch fun

191+ -> TypeExpression schemas x

192+ -> Definition schemas

193+ (Alter sch (Create op ('Operator ('RightOp x y)) schema) schemas)

194+createRightOp fun x = UnsafeDefinition $

195+ "CREATE" <+> "OPERATOR" <+> renderSymbol @op

196+ <+> parenthesized (commaSeparated opdef)

197+ where

198+ opdef =

199+ [ "FUNCTION" <+> "=" <+> renderSQL fun

200+ , "LEFTARG" <+> "=" <+> renderSQL x ]

201+

202+dropFunction

203+ :: (Has sch schemas schema, KnownSymbol fun)

204+ => QualifiedAlias sch fun

205+ -- ^ name of the user defined function

206+ -> Definition schemas (Alter sch (DropSchemum fun 'Function schema) schemas)

207+dropFunction fun = UnsafeDefinition $

208+ "DROP" <+> "FUNCTION" <+> renderSQL fun <> ";"

209+

210+dropFunctionIfExists

211+ :: (Has sch schemas schema, KnownSymbol fun)

212+ => QualifiedAlias sch fun

213+ -- ^ name of the user defined function

214+ -> Definition schemas (Alter sch (DropSchemumIfExists fun 'Function schema) schemas)

215+dropFunctionIfExists fun = UnsafeDefinition $

216+ "DROP FUNCTION IF EXISTS" <+> renderSQL fun <> ";"

217+

218+dropOperator

219+ :: (Has sch schemas schema, KnownSymbol op)

220+ => QualifiedAlias sch op

221+ -- ^ name of the user defined operator

222+ -> Definition schemas (Alter sch (DropSchemum op 'Operator schema) schemas)

223+dropOperator op = UnsafeDefinition $

224+ "DROP" <+> "OPERATOR" <+> renderSQL op <> ";"

225+

226+dropOperatorIfExists

227+ :: (Has sch schemas schema, KnownSymbol op)

228+ => QualifiedAlias sch op

229+ -- ^ name of the user defined operator

230+ -> Definition schemas (Alter sch (DropSchemumIfExists op 'Operator schema) schemas)

231+dropOperatorIfExists op = UnsafeDefinition $

232+ "DROP OPERATOR IF EXISTS" <+> renderSQL op <> ";"

233+

234+newtype FunctionDefinition schemas args ret = UnsafeFunctionDefinition

235+ { renderFunctionDefinition :: ByteString }

236+ deriving (Eq,Show,GHC.Generic,NFData)

237+instance RenderSQL (FunctionDefinition schemas args ret) where

238+ renderSQL = renderFunctionDefinition

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Index.hsnew file+159

@@ -0,0 +1,159 @@

1+{-|

2+Module: Squeal.PostgreSQL.Definition.Index

3+Description: Create and drop index definitions

4+Copyright: (c) Eitan Chatav, 2017

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Create and drop index definitions.

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , ConstraintKinds

14+ , DeriveAnyClass

15+ , DeriveGeneric

16+ , DerivingStrategies

17+ , FlexibleContexts

18+ , FlexibleInstances

19+ , GADTs

20+ , LambdaCase

21+ , MultiParamTypeClasses

22+ , OverloadedLabels

23+ , OverloadedStrings

24+ , RankNTypes

25+ , ScopedTypeVariables

26+ , TypeApplications

27+ , TypeInType

28+ , TypeOperators

29+ , UndecidableSuperClasses

30+#-}

31+

32+module Squeal.PostgreSQL.Definition.Index

33+ ( createIndex

34+ , createIndexIfNotExists

35+ , dropIndex

36+ , dropIndexIfExists

37+ , IndexMethod (..)

38+ , btree

39+ , hash

40+ , gist

41+ , spgist

42+ , gin

43+ , brin

44+ ) where

45+

46+import Data.ByteString

47+import GHC.TypeLits

48+

49+import qualified GHC.Generics as GHC

50+

51+import Squeal.PostgreSQL.Alias

52+import Squeal.PostgreSQL.Definition

53+import Squeal.PostgreSQL.Expression.Sort

54+import Squeal.PostgreSQL.Render

55+import Squeal.PostgreSQL.Schema

56+

57+-- $setup

58+-- >>> import Squeal.PostgreSQL

59+

60+{- |

61+>>> :{

62+type Table = '[] :=>

63+ '[ "a" ::: 'NoDef :=> 'Null 'PGint4

64+ , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]

65+:}

66+

67+>>> :{

68+let

69+ setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table, "ix" ::: 'Index 'Btree])

70+ setup =

71+ createTable #tab (nullable int `as` #a :* nullable real `as` #b) Nil >>>

72+ createIndex #ix #tab btree [#a & AscNullsFirst, #b & AscNullsLast]

73+in printSQL setup

74+:}

75+CREATE TABLE "tab" ("a" int NULL, "b" real NULL);

76+CREATE INDEX "ix" ON "tab" USING btree (("a") ASC NULLS FIRST, ("b") ASC NULLS LAST);

77+-}

78+createIndex

79+ :: (Has sch schemas schema, Has tab schema ('Table table), KnownSymbol ix)

80+ => Alias ix

81+ -> QualifiedAlias sch tab

82+ -> IndexMethod method

83+ -> [SortExpression '[] '[] 'Ungrouped schemas '[] '[tab ::: TableToRow table]]

84+ -> Definition schemas (Alter sch (Create ix ('Index method) schema) schemas)

85+createIndex ix tab method cols = UnsafeDefinition $

86+ "CREATE" <+> "INDEX" <+> renderSQL ix <+> "ON" <+> renderSQL tab

87+ <+> "USING" <+> renderSQL method

88+ <+> parenthesized (commaSeparated (renderIndex <$> cols))

89+ <> ";"

90+ where

91+ renderIndex = \case

92+ Asc expression -> parenthesized (renderSQL expression) <+> "ASC"

93+ Desc expression -> parenthesized (renderSQL expression) <+> "DESC"

94+ AscNullsFirst expression -> parenthesized (renderSQL expression)

95+ <+> "ASC NULLS FIRST"

96+ DescNullsFirst expression -> parenthesized (renderSQL expression)

97+ <+> "DESC NULLS FIRST"

98+ AscNullsLast expression -> parenthesized (renderSQL expression)

99+ <+> "ASC NULLS LAST"

100+ DescNullsLast expression -> parenthesized (renderSQL expression)

101+ <+> "DESC NULLS LAST"

102+

103+createIndexIfNotExists

104+ :: (Has sch schemas schema, Has tab schema ('Table table), KnownSymbol ix)

105+ => Alias ix

106+ -> QualifiedAlias sch tab

107+ -> IndexMethod method

108+ -> [SortExpression '[] '[] 'Ungrouped schemas '[] '[tab ::: TableToRow table]]

109+ -> Definition schemas (Alter sch (CreateIfNotExists ix ('Index method) schema) schemas)

110+createIndexIfNotExists ix tab method cols = UnsafeDefinition $

111+ "CREATE INDEX IF NOT EXISTS" <+> renderSQL ix <+> "ON" <+> renderSQL tab

112+ <+> "USING" <+> renderSQL method

113+ <+> parenthesized (commaSeparated (renderIndex <$> cols))

114+ <> ";"

115+ where

116+ renderIndex = \case

117+ Asc expression -> parenthesized (renderSQL expression) <+> "ASC"

118+ Desc expression -> parenthesized (renderSQL expression) <+> "DESC"

119+ AscNullsFirst expression -> parenthesized (renderSQL expression)

120+ <+> "ASC NULLS FIRST"

121+ DescNullsFirst expression -> parenthesized (renderSQL expression)

122+ <+> "DESC NULLS FIRST"

123+ AscNullsLast expression -> parenthesized (renderSQL expression)

124+ <+> "ASC NULLS LAST"

125+ DescNullsLast expression -> parenthesized (renderSQL expression)

126+ <+> "DESC NULLS LAST"

127+

128+newtype IndexMethod ty = UnsafeIndexMethod {renderIndexMethod :: ByteString}

129+ deriving stock (Eq, Ord, Show, GHC.Generic)

130+instance RenderSQL (IndexMethod ty) where renderSQL = renderIndexMethod

131+btree :: IndexMethod 'Btree

132+btree = UnsafeIndexMethod "btree"

133+hash :: IndexMethod 'Hash

134+hash = UnsafeIndexMethod "hash"

135+gist :: IndexMethod 'Gist

136+gist = UnsafeIndexMethod "gist"

137+spgist :: IndexMethod 'Spgist

138+spgist = UnsafeIndexMethod "spgist"

139+gin :: IndexMethod 'Gin

140+gin = UnsafeIndexMethod "gin"

141+brin :: IndexMethod 'Brin

142+brin = UnsafeIndexMethod "brin"

143+

144+-- |

145+-- >>> printSQL (dropIndex #ix :: Definition (Public '["ix" ::: 'Index 'Btree]) (Public '[]))

146+-- DROP INDEX "ix";

147+dropIndex

148+ :: (Has sch schemas schema, KnownSymbol ix)

149+ => QualifiedAlias sch ix

150+ -- ^ name of the user defined index

151+ -> Definition schemas (Alter sch (DropSchemum ix 'Index schema) schemas)

152+dropIndex ix = UnsafeDefinition $ "DROP" <+> "INDEX" <+> renderSQL ix <> ";"

153+

154+dropIndexIfExists

155+ :: (Has sch schemas schema, KnownSymbol ix)

156+ => QualifiedAlias sch ix

157+ -- ^ name of the user defined index

158+ -> Definition schemas (Alter sch (DropSchemumIfExists ix 'Index schema) schemas)

159+dropIndexIfExists ix = UnsafeDefinition $ "DROP INDEX IF EXISTS" <+> renderSQL ix <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Schema.hsnew file+96

@@ -0,0 +1,96 @@

1+{-|

2+Module: Squeal.PostgreSQL.Definition.Schema

3+Description: Create and drop schema definitions

4+Copyright: (c) Eitan Chatav, 2017

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Create and drop schema definitions.

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , ConstraintKinds

14+ , DeriveAnyClass

15+ , DeriveGeneric

16+ , DerivingStrategies

17+ , FlexibleContexts

18+ , FlexibleInstances

19+ , GADTs

20+ , LambdaCase

21+ , MultiParamTypeClasses

22+ , OverloadedLabels

23+ , OverloadedStrings

24+ , RankNTypes

25+ , ScopedTypeVariables

26+ , TypeApplications

27+ , TypeInType

28+ , TypeOperators

29+ , UndecidableSuperClasses

30+#-}

31+

32+module Squeal.PostgreSQL.Definition.Schema

33+ ( createSchema

34+ , createSchemaIfNotExists

35+ , dropSchema

36+ , dropSchemaIfExists

37+ ) where

38+

39+import GHC.TypeLits

40+

41+import Squeal.PostgreSQL.Alias

42+import Squeal.PostgreSQL.Definition

43+import Squeal.PostgreSQL.Render

44+import Squeal.PostgreSQL.Schema

45+

46+-- $setup

47+-- >>> import Squeal.PostgreSQL

48+

49+{- |

50+`createSchema` enters a new schema into the current database.

51+The schema name must be distinct from the name of any existing schema

52+in the current database.

53+

54+A schema is essentially a namespace: it contains named objects

55+(tables, data types, functions, and operators) whose names

56+can duplicate those of other objects existing in other schemas.

57+Named objects are accessed by `QualifiedAlias`es with the schema

58+name as a prefix.

59+-}

60+createSchema

61+ :: KnownSymbol sch

62+ => Alias sch

63+ -> Definition schemas (Create sch '[] schemas)

64+createSchema sch = UnsafeDefinition $

65+ "CREATE" <+> "SCHEMA" <+> renderSQL sch <> ";"

66+

67+{- | Idempotent version of `createSchema`. -}

68+createSchemaIfNotExists

69+ :: (KnownSymbol sch, Has sch schemas schema)

70+ => Alias sch

71+ -> Definition schemas (CreateIfNotExists sch '[] schemas)

72+createSchemaIfNotExists sch = UnsafeDefinition $

73+ "CREATE" <+> "SCHEMA" <+> "IF" <+> "NOT" <+> "EXISTS"

74+ <+> renderSQL sch <> ";"

75+

76+-- | >>> :{

77+-- let

78+-- definition :: Definition '["muh_schema" ::: schema, "public" ::: public] '["public" ::: public]

79+-- definition = dropSchema #muh_schema

80+-- :}

81+--

82+-- >>> printSQL definition

83+-- DROP SCHEMA "muh_schema";

84+dropSchema

85+ :: KnownSymbol sch

86+ => Alias sch

87+ -- ^ user defined schema

88+ -> Definition schemas (Drop sch schemas)

89+dropSchema sch = UnsafeDefinition $ "DROP SCHEMA" <+> renderSQL sch <> ";"

90+

91+dropSchemaIfExists

92+ :: KnownSymbol sch

93+ => Alias sch

94+ -- ^ user defined schema

95+ -> Definition schemas (DropIfExists sch schemas)

96+dropSchemaIfExists sch = UnsafeDefinition $ "DROP SCHEMA" <+> renderSQL sch <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table.hsnew file+500

@@ -0,0 +1,500 @@

1+{-|

2+Module: Squeal.PostgreSQL.Definition.Table

3+Description: Create, drop and alter table definitions

4+Copyright: (c) Eitan Chatav, 2017

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Create, drop and alter table definitions.

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , ConstraintKinds

14+ , DeriveAnyClass

15+ , DeriveGeneric

16+ , DerivingStrategies

17+ , FlexibleContexts

18+ , FlexibleInstances

19+ , GADTs

20+ , LambdaCase

21+ , MultiParamTypeClasses

22+ , OverloadedLabels

23+ , OverloadedStrings

24+ , RankNTypes

25+ , ScopedTypeVariables

26+ , TypeApplications

27+ , TypeInType

28+ , TypeOperators

29+ , UndecidableSuperClasses

30+#-}

31+

32+module Squeal.PostgreSQL.Definition.Table

33+ ( createTable

34+ , createTableIfNotExists

35+ , dropTable

36+ , dropTableIfExists

37+ , alterTable

38+ , alterTableIfExists

39+ , alterTableRename

40+ , alterTableIfExistsRename

41+ , AlterTable (..)

42+ , addConstraint

43+ , dropConstraint

44+ , AddColumn (..)

45+ , dropColumn

46+ , renameColumn

47+ , alterColumn

48+ , AlterColumn (..)

49+ , setDefault

50+ , dropDefault

51+ , setNotNull

52+ , dropNotNull

53+ , alterType

54+ ) where

55+

56+import Control.DeepSeq

57+import Data.ByteString

58+import GHC.TypeLits

59+

60+import qualified Generics.SOP as SOP

61+import qualified GHC.Generics as GHC

62+

63+import Squeal.PostgreSQL.Alias

64+import Squeal.PostgreSQL.Definition

65+import Squeal.PostgreSQL.Definition.Table.Constraint

66+import Squeal.PostgreSQL.Expression

67+import Squeal.PostgreSQL.Expression.Type

68+import Squeal.PostgreSQL.List

69+import Squeal.PostgreSQL.Render

70+import Squeal.PostgreSQL.Schema

71+

72+-- $setup

73+-- >>> import Squeal.PostgreSQL

74+

75+{- | `createTable` adds a table to the schema.

76+

77+>>> :set -XOverloadedLabels

78+>>> :{

79+type Table = '[] :=>

80+ '[ "a" ::: 'NoDef :=> 'Null 'PGint4

81+ , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]

82+:}

83+

84+>>> :{

85+let

86+ setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table])

87+ setup = createTable #tab

88+ (nullable int `as` #a :* nullable real `as` #b) Nil

89+in printSQL setup

90+:}

91+CREATE TABLE "tab" ("a" int NULL, "b" real NULL);

92+-}

93+createTable

94+ :: ( KnownSymbol sch

95+ , KnownSymbol tab

96+ , columns ~ (col ': cols)

97+ , SOP.SListI columns

98+ , SOP.SListI constraints

99+ , Has sch schemas0 schema0

100+ , schemas1 ~ Alter sch (Create tab ('Table (constraints :=> columns)) schema0) schemas0 )

101+ => QualifiedAlias sch tab -- ^ the name of the table to add

102+ -> NP (Aliased (ColumnTypeExpression schemas0)) columns

103+ -- ^ the names and datatype of each column

104+ -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints

105+ -- ^ constraints that must hold for the table

106+ -> Definition schemas0 schemas1

107+createTable tab columns constraints = UnsafeDefinition $

108+ "CREATE TABLE" <+> renderCreation tab columns constraints

109+

110+{-| `createTableIfNotExists` creates a table if it doesn't exist, but does not add it to the schema.

111+Instead, the schema already has the table so if the table did not yet exist, the schema was wrong.

112+`createTableIfNotExists` fixes this. Interestingly, this property makes it an idempotent in

113+the `Category` of `Definition`s.

114+

115+>>> :set -XOverloadedLabels -XTypeApplications

116+>>> :{

117+type Table = '[] :=>

118+ '[ "a" ::: 'NoDef :=> 'Null 'PGint4

119+ , "b" ::: 'NoDef :=> 'Null 'PGfloat4 ]

120+:}

121+

122+>>> type Schemas = Public '["tab" ::: 'Table Table]

123+

124+>>> :{

125+let

126+ setup :: Definition Schemas Schemas

127+ setup = createTableIfNotExists #tab

128+ (nullable int `as` #a :* nullable real `as` #b) Nil

129+in printSQL setup

130+:}

131+CREATE TABLE IF NOT EXISTS "tab" ("a" int NULL, "b" real NULL);

132+-}

133+createTableIfNotExists

134+ :: ( KnownSymbol sch

135+ , KnownSymbol tab

136+ , columns ~ (col ': cols)

137+ , SOP.SListI columns

138+ , SOP.SListI constraints

139+ , Has sch schemas0 schema0

140+ , schemas1 ~ Alter sch (CreateIfNotExists tab ('Table (constraints :=> columns)) schema0) schemas0 )

141+ => QualifiedAlias sch tab -- ^ the name of the table to add

142+ -> NP (Aliased (ColumnTypeExpression schemas0)) columns

143+ -- ^ the names and datatype of each column

144+ -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints

145+ -- ^ constraints that must hold for the table

146+ -> Definition schemas0 schemas1

147+createTableIfNotExists tab columns constraints = UnsafeDefinition $

148+ "CREATE TABLE IF NOT EXISTS"

149+ <+> renderCreation tab columns constraints

150+

151+-- helper function for `createTable` and `createTableIfNotExists`

152+renderCreation

153+ :: ( KnownSymbol sch

154+ , KnownSymbol tab

155+ , SOP.SListI columns

156+ , SOP.SListI constraints )

157+ => QualifiedAlias sch tab -- ^ the name of the table to add

158+ -> NP (Aliased (ColumnTypeExpression schemas0)) columns

159+ -- ^ the names and datatype of each column

160+ -> NP (Aliased (TableConstraintExpression sch tab schemas1)) constraints

161+ -- ^ constraints that must hold for the table

162+ -> ByteString

163+renderCreation tab columns constraints = renderSQL tab

164+ <+> parenthesized

165+ ( renderCommaSeparated renderColumnDef columns

166+ <> ( case constraints of

167+ Nil -> ""

168+ _ -> ", " <>

169+ renderCommaSeparated renderConstraint constraints ) )

170+ <> ";"

171+ where

172+ renderColumnDef :: Aliased (ColumnTypeExpression schemas) x -> ByteString

173+ renderColumnDef (ty `As` column) =

174+ renderSQL column <+> renderColumnTypeExpression ty

175+ renderConstraint

176+ :: Aliased (TableConstraintExpression sch tab schemas) constraint

177+ -> ByteString

178+ renderConstraint (constraint `As` alias) =

179+ "CONSTRAINT" <+> renderSQL alias <+> renderSQL constraint

180+

181+-- | `dropTable` removes a table from the schema.

182+--

183+-- >>> :{

184+-- let

185+-- definition :: Definition '["public" ::: '["muh_table" ::: 'Table t]] (Public '[])

186+-- definition = dropTable #muh_table

187+-- :}

188+--

189+-- >>> printSQL definition

190+-- DROP TABLE "muh_table";

191+dropTable

192+ :: ( Has sch schemas schema

193+ , KnownSymbol tab )

194+ => QualifiedAlias sch tab -- ^ table to remove

195+ -> Definition schemas (Alter sch (DropSchemum tab 'Table schema) schemas)

196+dropTable tab = UnsafeDefinition $ "DROP TABLE" <+> renderSQL tab <> ";"

197+

198+dropTableIfExists

199+ :: ( Has sch schemas schema

200+ , KnownSymbol tab)

201+ => QualifiedAlias sch tab -- ^ table to remove

202+ -> Definition schemas (Alter sch (DropSchemumIfExists tab 'Table schema) schemas)

203+dropTableIfExists tab = UnsafeDefinition $ "DROP TABLE IF EXISTS" <+> renderSQL tab <> ";"

204+

205+-- | `alterTable` changes the definition of a table from the schema.

206+alterTable

207+ :: (Has sch schemas schema, KnownSymbol tab)

208+ => QualifiedAlias sch tab -- ^ table to alter

209+ -> AlterTable sch tab schemas table -- ^ alteration to perform

210+ -> Definition schemas (Alter sch (Alter tab ('Table table) schema) schemas)

211+alterTable tab alteration = UnsafeDefinition $

212+ "ALTER TABLE"

213+ <+> renderSQL tab

214+ <+> renderAlterTable alteration

215+ <> ";"

216+

217+-- | `alterTable` changes the definition of a table from the schema.

218+alterTableIfExists

219+ :: (Has sch schemas schema, KnownSymbol tab)

220+ => QualifiedAlias sch tab -- ^ table to alter

221+ -> AlterTable sch tab schemas table -- ^ alteration to perform

222+ -> Definition schemas (Alter sch (AlterIfExists tab ('Table table) schema) schemas)

223+alterTableIfExists tab alteration = UnsafeDefinition $

224+ "ALTER TABLE IF EXISTS"

225+ <+> renderSQL tab

226+ <+> renderAlterTable alteration

227+ <> ";"

228+

229+-- | `alterTableRename` changes the name of a table from the schema.

230+--

231+-- >>> printSQL $ alterTableRename #foo #bar

232+-- ALTER TABLE "foo" RENAME TO "bar";

233+alterTableRename

234+ :: (KnownSymbol tab0, KnownSymbol tab1)

235+ => Alias tab0 -- ^ table to rename

236+ -> Alias tab1 -- ^ what to rename it

237+ -> Definition schema (Rename tab0 tab1 schema)

238+alterTableRename tab0 tab1 = UnsafeDefinition $

239+ "ALTER TABLE" <+> renderSQL tab0

240+ <+> "RENAME TO" <+> renderSQL tab1 <> ";"

241+

242+alterTableIfExistsRename

243+ :: (KnownSymbol tab0, KnownSymbol tab1)

244+ => Alias tab0 -- ^ table to rename

245+ -> Alias tab1 -- ^ what to rename it

246+ -> Definition schema (RenameIfExists tab0 tab1 schema)

247+alterTableIfExistsRename tab0 tab1 = UnsafeDefinition $

248+ "ALTER TABLE IF EXISTS" <+> renderSQL tab0

249+ <+> "RENAME TO" <+> renderSQL tab1 <> ";"

250+

251+-- | An `AlterTable` describes the alteration to perform on the columns

252+-- of a table.

253+newtype AlterTable

254+ (sch :: Symbol)

255+ (tab :: Symbol)

256+ (schemas :: SchemasType)

257+ (table :: TableType) =

258+ UnsafeAlterTable {renderAlterTable :: ByteString}

259+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

260+

261+-- | An `addConstraint` adds a table constraint.

262+--

263+-- >>> :{

264+-- let

265+-- definition :: Definition

266+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

267+-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: 'Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

268+-- definition = alterTable #tab (addConstraint #positive (check #col (#col .> 0)))

269+-- in printSQL definition

270+-- :}

271+-- ALTER TABLE "tab" ADD CONSTRAINT "positive" CHECK (("col" > 0));

272+addConstraint

273+ :: ( KnownSymbol alias

274+ , Has sch schemas schema

275+ , Has tab schema ('Table table0)

276+ , table0 ~ (constraints :=> columns)

277+ , table1 ~ (Create alias constraint constraints :=> columns) )

278+ => Alias alias

279+ -> TableConstraintExpression sch tab schemas constraint

280+ -- ^ constraint to add

281+ -> AlterTable sch tab schemas table1

282+addConstraint alias constraint = UnsafeAlterTable $

283+ "ADD" <+> "CONSTRAINT" <+> renderSQL alias

284+ <+> renderSQL constraint

285+

286+-- | A `dropConstraint` drops a table constraint.

287+--

288+-- >>> :{

289+-- let

290+-- definition :: Definition

291+-- '["public" ::: '["tab" ::: 'Table ('["positive" ::: Check '["col"]] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

292+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

293+-- definition = alterTable #tab (dropConstraint #positive)

294+-- in printSQL definition

295+-- :}

296+-- ALTER TABLE "tab" DROP CONSTRAINT "positive";

297+dropConstraint

298+ :: ( KnownSymbol constraint

299+ , Has sch schemas schema

300+ , Has tab schema ('Table table0)

301+ , table0 ~ (constraints :=> columns)

302+ , table1 ~ (Drop constraint constraints :=> columns) )

303+ => Alias constraint

304+ -- ^ constraint to drop

305+ -> AlterTable sch tab schemas table1

306+dropConstraint constraint = UnsafeAlterTable $

307+ "DROP" <+> "CONSTRAINT" <+> renderSQL constraint

308+

309+-- | An `AddColumn` is either @NULL@ or has @DEFAULT@.

310+class AddColumn ty where

311+ -- | `addColumn` adds a new column, initially filled with whatever

312+ -- default value is given or with @NULL@.

313+ --

314+ -- >>> :{

315+ -- let

316+ -- definition :: Definition

317+ -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

318+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>

319+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

320+ -- , "col2" ::: 'Def :=> 'Null 'PGtext ])]]

321+ -- definition = alterTable #tab (addColumn #col2 (text & nullable & default_ "foo"))

322+ -- in printSQL definition

323+ -- :}

324+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL DEFAULT E'foo';

325+ --

326+ -- >>> :{

327+ -- let

328+ -- definition :: Definition

329+ -- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

330+ -- '["public" ::: '["tab" ::: 'Table ('[] :=>

331+ -- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

332+ -- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

333+ -- definition = alterTable #tab (addColumn #col2 (text & nullable))

334+ -- in printSQL definition

335+ -- :}

336+ -- ALTER TABLE "tab" ADD COLUMN "col2" text NULL;

337+ addColumn

338+ :: ( KnownSymbol column

339+ , Has sch schemas schema

340+ , Has tab schema ('Table table0)

341+ , table0 ~ (constraints :=> columns) )

342+ => Alias column -- ^ column to add

343+ -> ColumnTypeExpression schemas ty -- ^ type of the new column

344+ -> AlterTable sch tab schemas (constraints :=> Create column ty columns)

345+ addColumn column ty = UnsafeAlterTable $

346+ "ADD COLUMN" <+> renderSQL column <+> renderColumnTypeExpression ty

347+instance {-# OVERLAPPING #-} AddColumn ('Def :=> ty)

348+instance {-# OVERLAPPABLE #-} AddColumn ('NoDef :=> 'Null ty)

349+

350+-- | A `dropColumn` removes a column. Whatever data was in the column

351+-- disappears. Table constraints involving the column are dropped, too.

352+-- However, if the column is referenced by a foreign key constraint of

353+-- another table, PostgreSQL will not silently drop that constraint.

354+--

355+-- >>> :{

356+-- let

357+-- definition :: Definition

358+-- '["public" ::: '["tab" ::: 'Table ('[] :=>

359+-- '[ "col1" ::: 'NoDef :=> 'Null 'PGint4

360+-- , "col2" ::: 'NoDef :=> 'Null 'PGtext ])]]

361+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col1" ::: 'NoDef :=> 'Null 'PGint4])]]

362+-- definition = alterTable #tab (dropColumn #col2)

363+-- in printSQL definition

364+-- :}

365+-- ALTER TABLE "tab" DROP COLUMN "col2";

366+dropColumn

367+ :: ( KnownSymbol column

368+ , Has sch schemas schema

369+ , Has tab schema ('Table table0)

370+ , table0 ~ (constraints :=> columns)

371+ , table1 ~ (constraints :=> Drop column columns) )

372+ => Alias column -- ^ column to remove

373+ -> AlterTable sch tab schemas table1

374+dropColumn column = UnsafeAlterTable $

375+ "DROP COLUMN" <+> renderSQL column

376+

377+-- | A `renameColumn` renames a column.

378+--

379+-- >>> :{

380+-- let

381+-- definition :: Definition

382+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["foo" ::: 'NoDef :=> 'Null 'PGint4])]]

383+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["bar" ::: 'NoDef :=> 'Null 'PGint4])]]

384+-- definition = alterTable #tab (renameColumn #foo #bar)

385+-- in printSQL definition

386+-- :}

387+-- ALTER TABLE "tab" RENAME COLUMN "foo" TO "bar";

388+renameColumn

389+ :: ( KnownSymbol column0

390+ , KnownSymbol column1

391+ , Has sch schemas schema

392+ , Has tab schema ('Table table0)

393+ , table0 ~ (constraints :=> columns)

394+ , table1 ~ (constraints :=> Rename column0 column1 columns) )

395+ => Alias column0 -- ^ column to rename

396+ -> Alias column1 -- ^ what to rename the column

397+ -> AlterTable sch tab schemas table1

398+renameColumn column0 column1 = UnsafeAlterTable $

399+ "RENAME COLUMN" <+> renderSQL column0 <+> "TO" <+> renderSQL column1

400+

401+-- | An `alterColumn` alters a single column.

402+alterColumn

403+ :: ( KnownSymbol column

404+ , Has sch schemas schema

405+ , Has tab schema ('Table table0)

406+ , table0 ~ (constraints :=> columns)

407+ , Has column columns ty0

408+ , table1 ~ (constraints :=> Alter column ty1 columns))

409+ => Alias column -- ^ column to alter

410+ -> AlterColumn schemas ty0 ty1 -- ^ alteration to perform

411+ -> AlterTable sch tab schemas table1

412+alterColumn column alteration = UnsafeAlterTable $

413+ "ALTER COLUMN" <+> renderSQL column <+> renderAlterColumn alteration

414+

415+-- | An `AlterColumn` describes the alteration to perform on a single column.

416+newtype AlterColumn (schemas :: SchemasType) (ty0 :: ColumnType) (ty1 :: ColumnType) =

417+ UnsafeAlterColumn {renderAlterColumn :: ByteString}

418+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

419+

420+-- | A `setDefault` sets a new default for a column. Note that this doesn't

421+-- affect any existing rows in the table, it just changes the default for

422+-- future insert and update commands.

423+--

424+-- >>> :{

425+-- let

426+-- definition :: Definition

427+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

428+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]

429+-- definition = alterTable #tab (alterColumn #col (setDefault 5))

430+-- in printSQL definition

431+-- :}

432+-- ALTER TABLE "tab" ALTER COLUMN "col" SET DEFAULT 5;

433+setDefault

434+ :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty -- ^ default value to set

435+ -> AlterColumn schemas (constraint :=> ty) ('Def :=> ty)

436+setDefault expression = UnsafeAlterColumn $

437+ "SET DEFAULT" <+> renderExpression expression

438+

439+-- | A `dropDefault` removes any default value for a column.

440+--

441+-- >>> :{

442+-- let

443+-- definition :: Definition

444+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'Def :=> 'Null 'PGint4])]]

445+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

446+-- definition = alterTable #tab (alterColumn #col dropDefault)

447+-- in printSQL definition

448+-- :}

449+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP DEFAULT;

450+dropDefault :: AlterColumn schemas ('Def :=> ty) ('NoDef :=> ty)

451+dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"

452+

453+-- | A `setNotNull` adds a @NOT NULL@ constraint to a column.

454+-- The constraint will be checked immediately, so the table data must satisfy

455+-- the constraint before it can be added.

456+--

457+-- >>> :{

458+-- let

459+-- definition :: Definition

460+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

461+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

462+-- definition = alterTable #tab (alterColumn #col setNotNull)

463+-- in printSQL definition

464+-- :}

465+-- ALTER TABLE "tab" ALTER COLUMN "col" SET NOT NULL;

466+setNotNull

467+ :: AlterColumn schemas (constraint :=> 'Null ty) (constraint :=> 'NotNull ty)

468+setNotNull = UnsafeAlterColumn $ "SET NOT NULL"

469+

470+-- | A `dropNotNull` drops a @NOT NULL@ constraint from a column.

471+--

472+-- >>> :{

473+-- let

474+-- definition :: Definition

475+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

476+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'Null 'PGint4])]]

477+-- definition = alterTable #tab (alterColumn #col dropNotNull)

478+-- in printSQL definition

479+-- :}

480+-- ALTER TABLE "tab" ALTER COLUMN "col" DROP NOT NULL;

481+dropNotNull

482+ :: AlterColumn schemas (constraint :=> 'NotNull ty) (constraint :=> 'Null ty)

483+dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"

484+

485+-- | An `alterType` converts a column to a different data type.

486+-- This will succeed only if each existing entry in the column can be

487+-- converted to the new type by an implicit cast.

488+--

489+-- >>> :{

490+-- let

491+-- definition :: Definition

492+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGint4])]]

493+-- '["public" ::: '["tab" ::: 'Table ('[] :=> '["col" ::: 'NoDef :=> 'NotNull 'PGnumeric])]]

494+-- definition =

495+-- alterTable #tab (alterColumn #col (alterType (numeric & notNullable)))

496+-- in printSQL definition

497+-- :}

498+-- ALTER TABLE "tab" ALTER COLUMN "col" TYPE numeric NOT NULL;

499+alterType :: ColumnTypeExpression schemas ty -> AlterColumn schemas ty0 ty

500+alterType ty = UnsafeAlterColumn $ "TYPE" <+> renderColumnTypeExpression ty

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table/Constraint.hsnew file+339

@@ -0,0 +1,339 @@

1+{-|

2+Module: Squeal.PostgreSQL.Definition.Table.Constraint

3+Description: Table constraint expressions

4+Copyright: (c) Eitan Chatav, 2017

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Table constraint expressions.

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , ConstraintKinds

14+ , DeriveAnyClass

15+ , DeriveGeneric

16+ , DerivingStrategies

17+ , FlexibleContexts

18+ , FlexibleInstances

19+ , GADTs

20+ , LambdaCase

21+ , MultiParamTypeClasses

22+ , OverloadedLabels

23+ , OverloadedStrings

24+ , RankNTypes

25+ , ScopedTypeVariables

26+ , TypeApplications

27+ , TypeInType

28+ , TypeOperators

29+ , UndecidableSuperClasses

30+#-}

31+

32+module Squeal.PostgreSQL.Definition.Table.Constraint

33+ ( TableConstraintExpression (..)

34+ , check

35+ , unique

36+ , primaryKey

37+ , foreignKey

38+ , ForeignKeyed

39+ , OnDeleteClause (..)

40+ , OnUpdateClause (..)

41+ ) where

42+

43+import Control.DeepSeq

44+import Data.ByteString

45+import GHC.TypeLits

46+

47+import qualified Generics.SOP as SOP

48+import qualified GHC.Generics as GHC

49+

50+import Squeal.PostgreSQL.Alias

51+import Squeal.PostgreSQL.Expression.Logic

52+import Squeal.PostgreSQL.List

53+import Squeal.PostgreSQL.Render

54+import Squeal.PostgreSQL.Schema

55+

56+-- $setup

57+-- >>> import Squeal.PostgreSQL

58+

59+-- | Data types are a way to limit the kind of data that can be stored in a

60+-- table. For many applications, however, the constraint they provide is

61+-- too coarse. For example, a column containing a product price should

62+-- probably only accept positive values. But there is no standard data type

63+-- that accepts only positive numbers. Another issue is that you might want

64+-- to constrain column data with respect to other columns or rows.

65+-- For example, in a table containing product information,

66+-- there should be only one row for each product number.

67+-- `TableConstraint`s give you as much control over the data in your tables

68+-- as you wish. If a user attempts to store data in a column that would

69+-- violate a constraint, an error is raised. This applies

70+-- even if the value came from the default value definition.

71+newtype TableConstraintExpression

72+ (sch :: Symbol)

73+ (tab :: Symbol)

74+ (schemas :: SchemasType)

75+ (constraint :: TableConstraint)

76+ = UnsafeTableConstraintExpression

77+ { renderTableConstraintExpression :: ByteString }

78+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

79+instance RenderSQL

80+ (TableConstraintExpression sch tab schemas constraint) where

81+ renderSQL = renderTableConstraintExpression

82+

83+{-| A `check` constraint is the most generic `TableConstraint` type.

84+It allows you to specify that the value in a certain column must satisfy

85+a Boolean (truth-value) expression.

86+

87+>>> :{

88+type Schema = '[

89+ "tab" ::: 'Table ('[ "inequality" ::: 'Check '["a","b"]] :=> '[

90+ "a" ::: 'NoDef :=> 'NotNull 'PGint4,

91+ "b" ::: 'NoDef :=> 'NotNull 'PGint4

92+ ])]

93+:}

94+

95+>>> :{

96+let

97+ definition :: Definition (Public '[]) (Public Schema)

98+ definition = createTable #tab

99+ ( (int & notNullable) `as` #a :*

100+ (int & notNullable) `as` #b )

101+ ( check (#a :* #b) (#a .> #b) `as` #inequality )

102+:}

103+

104+>>> printSQL definition

105+CREATE TABLE "tab" ("a" int NOT NULL, "b" int NOT NULL, CONSTRAINT "inequality" CHECK (("a" > "b")));

106+-}

107+check

108+ :: ( Has sch schemas schema

109+ , Has tab schema ('Table table)

110+ , HasAll aliases (TableToRow table) subcolumns )

111+ => NP Alias aliases

112+ -- ^ specify the subcolumns which are getting checked

113+ -> (forall t. Condition '[] '[] 'Ungrouped schemas '[] '[t ::: subcolumns])

114+ -- ^ a closed `Condition` on those subcolumns

115+ -> TableConstraintExpression sch tab schemas ('Check aliases)

116+check _cols condition = UnsafeTableConstraintExpression $

117+ "CHECK" <+> parenthesized (renderSQL condition)

118+

119+{-| A `unique` constraint ensure that the data contained in a column,

120+or a group of columns, is unique among all the rows in the table.

121+

122+>>> :{

123+type Schema = '[

124+ "tab" ::: 'Table( '[ "uq_a_b" ::: 'Unique '["a","b"]] :=> '[

125+ "a" ::: 'NoDef :=> 'Null 'PGint4,

126+ "b" ::: 'NoDef :=> 'Null 'PGint4

127+ ])]

128+:}

129+

130+>>> :{

131+let

132+ definition :: Definition (Public '[]) (Public Schema)

133+ definition = createTable #tab

134+ ( (int & nullable) `as` #a :*

135+ (int & nullable) `as` #b )

136+ ( unique (#a :* #b) `as` #uq_a_b )

137+:}

138+

139+>>> printSQL definition

140+CREATE TABLE "tab" ("a" int NULL, "b" int NULL, CONSTRAINT "uq_a_b" UNIQUE ("a", "b"));

141+-}

142+unique

143+ :: ( Has sch schemas schema

144+ , Has tab schema('Table table)

145+ , HasAll aliases (TableToRow table) subcolumns )

146+ => NP Alias aliases

147+ -- ^ specify subcolumns which together are unique for each row

148+ -> TableConstraintExpression sch tab schemas ('Unique aliases)

149+unique columns = UnsafeTableConstraintExpression $

150+ "UNIQUE" <+> parenthesized (renderSQL columns)

151+

152+{-| A `primaryKey` constraint indicates that a column, or group of columns,

153+can be used as a unique identifier for rows in the table.

154+This requires that the values be both unique and not null.

155+

156+>>> :{

157+type Schema = '[

158+ "tab" ::: 'Table ('[ "pk_id" ::: 'PrimaryKey '["id"]] :=> '[

159+ "id" ::: 'Def :=> 'NotNull 'PGint4,

160+ "name" ::: 'NoDef :=> 'NotNull 'PGtext

161+ ])]

162+:}

163+

164+>>> :{

165+let

166+ definition :: Definition (Public '[]) (Public Schema)

167+ definition = createTable #tab

168+ ( serial `as` #id :*

169+ (text & notNullable) `as` #name )

170+ ( primaryKey #id `as` #pk_id )

171+:}

172+

173+>>> printSQL definition

174+CREATE TABLE "tab" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_id" PRIMARY KEY ("id"));

175+-}

176+primaryKey

177+ :: ( Has sch schemas schema

178+ , Has tab schema ('Table table)

179+ , HasAll aliases (TableToColumns table) subcolumns

180+ , AllNotNull subcolumns )

181+ => NP Alias aliases

182+ -- ^ specify the subcolumns which together form a primary key.

183+ -> TableConstraintExpression sch tab schemas ('PrimaryKey aliases)

184+primaryKey columns = UnsafeTableConstraintExpression $

185+ "PRIMARY KEY" <+> parenthesized (renderSQL columns)

186+

187+{-| A `foreignKey` specifies that the values in a column

188+(or a group of columns) must match the values appearing in some row of

189+another table. We say this maintains the referential integrity

190+between two related tables.

191+

192+>>> :{

193+type Schema =

194+ '[ "users" ::: 'Table (

195+ '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>

196+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4

197+ , "name" ::: 'NoDef :=> 'NotNull 'PGtext

198+ ])

199+ , "emails" ::: 'Table (

200+ '[ "pk_emails" ::: 'PrimaryKey '["id"]

201+ , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]

202+ ] :=>

203+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4

204+ , "user_id" ::: 'NoDef :=> 'NotNull 'PGint4

205+ , "email" ::: 'NoDef :=> 'Null 'PGtext

206+ ])

207+ ]

208+:}

209+

210+>>> :{

211+let

212+ setup :: Definition (Public '[]) (Public Schema)

213+ setup =

214+ createTable #users

215+ ( serial `as` #id :*

216+ (text & notNullable) `as` #name )

217+ ( primaryKey #id `as` #pk_users ) >>>

218+ createTable #emails

219+ ( serial `as` #id :*

220+ (int & notNullable) `as` #user_id :*

221+ (text & nullable) `as` #email )

222+ ( primaryKey #id `as` #pk_emails :*

223+ foreignKey #user_id #users #id

224+ OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

225+in printSQL setup

226+:}

227+CREATE TABLE "users" ("id" serial, "name" text NOT NULL, CONSTRAINT "pk_users" PRIMARY KEY ("id"));

228+CREATE TABLE "emails" ("id" serial, "user_id" int NOT NULL, "email" text NULL, CONSTRAINT "pk_emails" PRIMARY KEY ("id"), CONSTRAINT "fk_user_id" FOREIGN KEY ("user_id") REFERENCES "users" ("id") ON DELETE CASCADE ON UPDATE CASCADE);

229+

230+A `foreignKey` can even be a table self-reference.

231+

232+>>> :{

233+type Schema =

234+ '[ "employees" ::: 'Table (

235+ '[ "employees_pk" ::: 'PrimaryKey '["id"]

236+ , "employees_employer_fk" ::: 'ForeignKey '["employer_id"] "employees" '["id"]

237+ ] :=>

238+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4

239+ , "name" ::: 'NoDef :=> 'NotNull 'PGtext

240+ , "employer_id" ::: 'NoDef :=> 'Null 'PGint4

241+ ])

242+ ]

243+:}

244+

245+>>> :{

246+let

247+ setup :: Definition (Public '[]) (Public Schema)

248+ setup =

249+ createTable #employees

250+ ( serial `as` #id :*

251+ (text & notNullable) `as` #name :*

252+ (integer & nullable) `as` #employer_id )

253+ ( primaryKey #id `as` #employees_pk :*

254+ foreignKey #employer_id #employees #id

255+ OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )

256+in printSQL setup

257+:}

258+CREATE TABLE "employees" ("id" serial, "name" text NOT NULL, "employer_id" integer NULL, CONSTRAINT "employees_pk" PRIMARY KEY ("id"), CONSTRAINT "employees_employer_fk" FOREIGN KEY ("employer_id") REFERENCES "employees" ("id") ON DELETE CASCADE ON UPDATE CASCADE);

259+-}

260+foreignKey

261+ :: (ForeignKeyed schemas sch schema child parent

262+ table reftable

263+ columns refcolumns

264+ constraints cols

265+ reftys tys )

266+ => NP Alias columns

267+ -- ^ column or columns in the table

268+ -> Alias parent

269+ -- ^ reference table

270+ -> NP Alias refcolumns

271+ -- ^ reference column or columns in the reference table

272+ -> OnDeleteClause

273+ -- ^ what to do when reference is deleted

274+ -> OnUpdateClause

275+ -- ^ what to do when reference is updated

276+ -> TableConstraintExpression sch child schemas

277+ ('ForeignKey columns parent refcolumns)

278+foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $

279+ "FOREIGN KEY" <+> parenthesized (renderSQL keys)

280+ <+> "REFERENCES" <+> renderSQL parent

281+ <+> parenthesized (renderSQL refs)

282+ <+> renderSQL ondel

283+ <+> renderSQL onupd

284+

285+-- | A constraint synonym between types involved in a foreign key constraint.

286+type ForeignKeyed schemas

287+ sch

288+ schema

289+ child parent

290+ table reftable

291+ columns refcolumns

292+ constraints cols

293+ reftys tys =

294+ ( Has sch schemas schema

295+ , Has child schema ('Table table)

296+ , Has parent schema ('Table reftable)

297+ , HasAll columns (TableToColumns table) tys

298+ , reftable ~ (constraints :=> cols)

299+ , HasAll refcolumns cols reftys

300+ , SOP.AllZip SamePGType tys reftys

301+ , Uniquely refcolumns constraints )

302+

303+-- | `OnDeleteClause` indicates what to do with rows that reference a deleted row.

304+data OnDeleteClause

305+ = OnDeleteNoAction

306+ -- ^ if any referencing rows still exist when the constraint is checked,

307+ -- an error is raised

308+ | OnDeleteRestrict -- ^ prevents deletion of a referenced row

309+ | OnDeleteCascade

310+ -- ^ specifies that when a referenced row is deleted,

311+ -- row(s) referencing it should be automatically deleted as well

312+ deriving (GHC.Generic,Show,Eq,Ord)

313+instance NFData OnDeleteClause

314+-- | Render `OnDeleteClause`.

315+instance RenderSQL OnDeleteClause where

316+ renderSQL = \case

317+ OnDeleteNoAction -> "ON DELETE NO ACTION"

318+ OnDeleteRestrict -> "ON DELETE RESTRICT"

319+ OnDeleteCascade -> "ON DELETE CASCADE"

320+

321+-- | Analagous to `OnDeleteClause` there is also `OnUpdateClause` which is invoked

322+-- when a referenced column is changed (updated).

323+data OnUpdateClause

324+ = OnUpdateNoAction

325+ -- ^ if any referencing rows has not changed when the constraint is checked,

326+ -- an error is raised

327+ | OnUpdateRestrict -- ^ prevents update of a referenced row

328+ | OnUpdateCascade

329+ -- ^ the updated values of the referenced column(s) should be copied

330+ -- into the referencing row(s)

331+ deriving (GHC.Generic,Show,Eq,Ord)

332+instance NFData OnUpdateClause

333+

334+-- | Render `OnUpdateClause`.

335+instance RenderSQL OnUpdateClause where

336+ renderSQL = \case

337+ OnUpdateNoAction -> "ON UPDATE NO ACTION"

338+ OnUpdateRestrict -> "ON UPDATE RESTRICT"

339+ OnUpdateCascade -> "ON UPDATE CASCADE"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Type.hsnew file+229

@@ -0,0 +1,229 @@

1+{-|

2+Module: Squeal.PostgreSQL.Definition.Type

3+Description: Create and drop type definitions

4+Copyright: (c) Eitan Chatav, 2017

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Create and drop type definitions.

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , ConstraintKinds

14+ , DeriveAnyClass

15+ , DeriveGeneric

16+ , DerivingStrategies

17+ , FlexibleContexts

18+ , FlexibleInstances

19+ , GADTs

20+ , LambdaCase

21+ , MultiParamTypeClasses

22+ , OverloadedLabels

23+ , OverloadedStrings

24+ , RankNTypes

25+ , ScopedTypeVariables

26+ , TypeApplications

27+ , TypeInType

28+ , TypeOperators

29+ , UndecidableSuperClasses

30+#-}

31+

32+module Squeal.PostgreSQL.Definition.Type

33+ ( createTypeEnum

34+ , createTypeEnumFrom

35+ , createTypeComposite

36+ , createTypeCompositeFrom

37+ , createTypeRange

38+ , createDomain

39+ , dropType

40+ , dropTypeIfExists

41+ ) where

42+

43+import Data.ByteString

44+import Data.Monoid

45+import GHC.TypeLits

46+import Prelude hiding ((.), id)

47+

48+import qualified Generics.SOP as SOP

49+

50+import Squeal.PostgreSQL.Alias

51+import Squeal.PostgreSQL.Expression.Logic

52+import Squeal.PostgreSQL.Expression.Type

53+import Squeal.PostgreSQL.Definition

54+import Squeal.PostgreSQL.List

55+import Squeal.PostgreSQL.PG

56+import Squeal.PostgreSQL.Render

57+import Squeal.PostgreSQL.Schema

58+

59+-- $setup

60+-- >>> import Squeal.PostgreSQL

61+-- >>> import qualified GHC.Generics as GHC

62+-- >>> import qualified Generics.SOP as SOP

63+

64+-- | Enumerated types are created using the `createTypeEnum` command, for example

65+--

66+-- >>> printSQL $ (createTypeEnum #mood (label @"sad" :* label @"ok" :* label @"happy") :: Definition (Public '[]) '["public" ::: '["mood" ::: 'Typedef ('PGenum '["sad","ok","happy"])]])

67+-- CREATE TYPE "mood" AS ENUM ('sad', 'ok', 'happy');

68+createTypeEnum

69+ :: (KnownSymbol enum, Has sch schemas schema, SOP.All KnownSymbol labels)

70+ => QualifiedAlias sch enum

71+ -- ^ name of the user defined enumerated type

72+ -> NP PGlabel labels

73+ -- ^ labels of the enumerated type

74+ -> Definition schemas (Alter sch (Create enum ('Typedef ('PGenum labels)) schema) schemas)

75+createTypeEnum enum labels = UnsafeDefinition $

76+ "CREATE" <+> "TYPE" <+> renderSQL enum <+> "AS" <+> "ENUM" <+>

77+ parenthesized (renderSQL labels) <> ";"

78+

79+-- | Enumerated types can also be generated from a Haskell type, for example

80+--

81+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

82+-- >>> instance SOP.Generic Schwarma

83+-- >>> instance SOP.HasDatatypeInfo Schwarma

84+-- >>> :{

85+-- let

86+-- createSchwarma :: Definition (Public '[]) '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]]

87+-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma

88+-- in

89+-- printSQL createSchwarma

90+-- :}

91+-- CREATE TYPE "schwarma" AS ENUM ('Beef', 'Lamb', 'Chicken');

92+createTypeEnumFrom

93+ :: forall hask sch enum schemas schema.

94+ ( SOP.Generic hask

95+ , SOP.All KnownSymbol (LabelsPG hask)

96+ , KnownSymbol enum

97+ , Has sch schemas schema )

98+ => QualifiedAlias sch enum

99+ -- ^ name of the user defined enumerated type

100+ -> Definition schemas (Alter sch (Create enum ('Typedef (PG (Enumerated hask))) schema) schemas)

101+createTypeEnumFrom enum = createTypeEnum enum

102+ (SOP.hpure label :: NP PGlabel (LabelsPG hask))

103+

104+{- | `createTypeComposite` creates a composite type. The composite type is

105+specified by a list of attribute names and data types.

106+

107+>>> :{

108+type PGcomplex = 'PGcomposite

109+ '[ "real" ::: 'NotNull 'PGfloat8

110+ , "imaginary" ::: 'NotNull 'PGfloat8 ]

111+:}

112+

113+>>> :{

114+let

115+ setup :: Definition (Public '[]) '["public" ::: '["complex" ::: 'Typedef PGcomplex]]

116+ setup = createTypeComposite #complex

117+ (float8 `as` #real :* float8 `as` #imaginary)

118+in printSQL setup

119+:}

120+CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

121+-}

122+createTypeComposite

123+ :: (KnownSymbol ty, Has sch schemas schema, SOP.SListI fields)

124+ => QualifiedAlias sch ty

125+ -- ^ name of the user defined composite type

126+ -> NP (Aliased (TypeExpression schemas)) fields

127+ -- ^ list of attribute names and data types

128+ -> Definition schemas (Alter sch (Create ty ('Typedef ('PGcomposite fields)) schema) schemas)

129+createTypeComposite ty fields = UnsafeDefinition $

130+ "CREATE" <+> "TYPE" <+> renderSQL ty <+> "AS" <+> parenthesized

131+ (renderCommaSeparated renderField fields) <> ";"

132+ where

133+ renderField :: Aliased (TypeExpression schemas) x -> ByteString

134+ renderField (typ `As` alias) =

135+ renderSQL alias <+> renderSQL typ

136+

137+-- | Composite types can also be generated from a Haskell type, for example

138+--

139+-- >>> data Complex = Complex {real :: Double, imaginary :: Double} deriving GHC.Generic

140+-- >>> instance SOP.Generic Complex

141+-- >>> instance SOP.HasDatatypeInfo Complex

142+-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]

143+-- >>> :{

144+-- let

145+-- createComplex :: Definition (Public '[]) (Public Schema)

146+-- createComplex = createTypeCompositeFrom @Complex #complex

147+-- in

148+-- printSQL createComplex

149+-- :}

150+-- CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

151+createTypeCompositeFrom

152+ :: forall hask sch ty schemas schema.

153+ ( SOP.All (FieldTyped schemas) (RowPG hask)

154+ , KnownSymbol ty

155+ , Has sch schemas schema )

156+ => QualifiedAlias sch ty

157+ -- ^ name of the user defined composite type

158+ -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)

159+createTypeCompositeFrom ty = createTypeComposite ty

160+ (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype

161+ :: NP (Aliased (TypeExpression schemas)) (RowPG hask))

162+

163+{-|

164+`createDomain` creates a new domain. A domain is essentially a data type

165+with constraints (restrictions on the allowed set of values).

166+

167+Domains are useful for abstracting common constraints on fields

168+into a single location for maintenance. For example, several tables might

169+contain email address columns, all requiring the same `check` constraint

170+to verify the address syntax. Define a domain rather than setting up

171+each table's constraint individually.

172+

173+>>> :{

174+let

175+ createPositive :: Definition (Public '[]) (Public '["positive" ::: 'Typedef 'PGfloat4])

176+ createPositive = createDomain #positive real (#value .> 0 .&& (#value & isNotNull))

177+in printSQL createPositive

178+:}

179+CREATE DOMAIN "positive" AS real CHECK ((("value" > 0) AND "value" IS NOT NULL));

180+-}

181+createDomain

182+ :: (Has sch schemas schema, KnownSymbol dom)

183+ => QualifiedAlias sch dom

184+ -> (forall null. TypeExpression schemas (null ty))

185+ -> (forall tab. Condition '[] '[] 'Ungrouped schemas '[] '[tab ::: '["value" ::: 'Null ty]])

186+ -> Definition schemas (Alter sch (Create dom ('Typedef ty) schema) schemas)

187+createDomain dom ty condition =

188+ UnsafeDefinition $ "CREATE DOMAIN" <+> renderSQL dom

189+ <+> "AS" <+> renderTypeExpression ty

190+ <+> "CHECK" <+> parenthesized (renderSQL condition) <> ";"

191+

192+{- |

193+>>> :{

194+let

195+ createSmallIntRange :: Definition (Public '[]) (Public '["int2range" ::: 'Typedef ('PGrange 'PGint2)])

196+ createSmallIntRange = createTypeRange #int2range int2

197+in printSQL createSmallIntRange

198+:}

199+CREATE TYPE "int2range" AS RANGE (subtype = int2);

200+-}

201+createTypeRange

202+ :: (Has sch schemas schema, KnownSymbol range)

203+ => QualifiedAlias sch range

204+ -> (forall null. TypeExpression schemas (null ty))

205+ -> Definition schemas (Alter sch (Create range ('Typedef ('PGrange ty)) schema) schemas)

206+createTypeRange range ty = UnsafeDefinition $

207+ "CREATE" <+> "TYPE" <+> renderSQL range <+> "AS" <+> "RANGE" <+>

208+ parenthesized ("subtype" <+> "=" <+> renderTypeExpression ty) <> ";"

209+

210+-- | Drop a type.

211+--

212+-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

213+-- >>> instance SOP.Generic Schwarma

214+-- >>> instance SOP.HasDatatypeInfo Schwarma

215+-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))

216+-- DROP TYPE "schwarma";

217+dropType

218+ :: (Has sch schemas schema, KnownSymbol td)

219+ => QualifiedAlias sch td

220+ -- ^ name of the user defined type

221+ -> Definition schemas (Alter sch (DropSchemum td 'Typedef schema) schemas)

222+dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

223+

224+dropTypeIfExists

225+ :: (Has sch schemas schema, KnownSymbol td)

226+ => QualifiedAlias sch td

227+ -- ^ name of the user defined type

228+ -> Definition schemas (Alter sch (DropSchemumIfExists td 'Typedef schema) schemas)

229+dropTypeIfExists tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/View.hsnew file+104

@@ -0,0 +1,104 @@

1+{-|

2+Module: Squeal.PostgreSQL.Definition.View

3+Description: Create and drop view definitions

4+Copyright: (c) Eitan Chatav, 2017

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Create and drop view definitions.

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , ConstraintKinds

14+ , DeriveAnyClass

15+ , DeriveGeneric

16+ , DerivingStrategies

17+ , FlexibleContexts

18+ , FlexibleInstances

19+ , GADTs

20+ , LambdaCase

21+ , MultiParamTypeClasses

22+ , OverloadedLabels

23+ , OverloadedStrings

24+ , RankNTypes

25+ , ScopedTypeVariables

26+ , TypeApplications

27+ , TypeInType

28+ , TypeOperators

29+ , UndecidableSuperClasses

30+#-}

31+

32+module Squeal.PostgreSQL.Definition.View

33+ ( createView

34+ , createOrReplaceView

35+ , dropView

36+ , dropViewIfExists

37+ ) where

38+

39+import GHC.TypeLits

40+

41+import Squeal.PostgreSQL.Alias

42+import Squeal.PostgreSQL.Definition

43+import Squeal.PostgreSQL.Query

44+import Squeal.PostgreSQL.Render

45+import Squeal.PostgreSQL.Schema

46+

47+-- $setup

48+-- >>> import Squeal.PostgreSQL

49+

50+{- | Create a view.

51+>>> type ABC = '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4]

52+>>> type BC = '["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4]

53+>>> :{

54+let

55+ definition :: Definition

56+ '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC)]]

57+ '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC), "bc" ::: 'View BC]]

58+ definition =

59+ createView #bc (select_ (#b :* #c) (from (table #abc)))

60+in printSQL definition

61+:}

62+CREATE VIEW "bc" AS SELECT "b" AS "b", "c" AS "c" FROM "abc" AS "abc";

63+-}

64+createView

65+ :: (Has sch schemas schema, KnownSymbol vw)

66+ => QualifiedAlias sch vw -- ^ the name of the view to add

67+ -> Query '[] '[] schemas '[] view -- ^ query

68+ -> Definition schemas (Alter sch (Create vw ('View view) schema) schemas)

69+createView alias query = UnsafeDefinition $

70+ "CREATE" <+> "VIEW" <+> renderSQL alias <+> "AS"

71+ <+> renderQuery query <> ";"

72+

73+createOrReplaceView

74+ :: (Has sch schemas schema, KnownSymbol vw)

75+ => QualifiedAlias sch vw -- ^ the name of the view to add

76+ -> Query '[] '[] schemas '[] view -- ^ query

77+ -> Definition schemas (Alter sch (CreateOrReplace vw ('View view) schema) schemas)

78+createOrReplaceView alias query = UnsafeDefinition $

79+ "CREATE OR REPLACE VIEW" <+> renderSQL alias <+> "AS"

80+ <+> renderQuery query <> ";"

81+

82+-- | Drop a view.

83+--

84+-- >>> :{

85+-- let

86+-- definition :: Definition

87+-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])

88+-- , "bc" ::: 'View ('["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4])]]

89+-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])]]

90+-- definition = dropView #bc

91+-- in printSQL definition

92+-- :}

93+-- DROP VIEW "bc";

94+dropView

95+ :: (Has sch schemas schema, KnownSymbol vw)

96+ => QualifiedAlias sch vw -- ^ view to remove

97+ -> Definition schemas (Alter sch (DropSchemum vw 'View schema) schemas)

98+dropView vw = UnsafeDefinition $ "DROP VIEW" <+> renderSQL vw <> ";"

99+

100+dropViewIfExists

101+ :: (Has sch schemas schema, KnownSymbol vw)

102+ => QualifiedAlias sch vw -- ^ view to remove

103+ -> Definition schemas (Alter sch (DropIfExists vw schema) schemas)

104+dropViewIfExists vw = UnsafeDefinition $ "DROP VIEW IF EXISTS" <+> renderSQL vw <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Expression.hs+297−1600

@@ -1,14 +1,13 @@

1{-|

2−Module: Squeal.PostgreSQL.Query

2+Module: Squeal.PostgreSQL.Expression

3Description: Squeal expressions

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

8Squeal expressions are the atoms used to build statements.

9-}

11−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}

12{-# LANGUAGE

11{-# LANGUAGE

13 AllowAmbiguousTypes

12 AllowAmbiguousTypes

14 , ConstraintKinds

13 , ConstraintKinds

@@ -16,11 +15,13 @@ Squeal expressions are the atoms used to build statements.

16 , FlexibleContexts

15 , FlexibleContexts

17 , FlexibleInstances

16 , FlexibleInstances

18 , FunctionalDependencies

17 , FunctionalDependencies

18+ , GADTs

19 , GeneralizedNewtypeDeriving

20 , LambdaCase

21 , MagicHash

22 , OverloadedStrings

23 , ScopedTypeVariables

24+ , StandaloneDeriving

24 , TypeApplications

25 , TypeApplications

25 , TypeFamilies

26 , TypeFamilies

26 , TypeInType

27 , TypeInType

@@ -31,547 +32,351 @@ Squeal expressions are the atoms used to build statements.

32module Squeal.PostgreSQL.Expression

33module Squeal.PostgreSQL.Expression

33 ( -- * Expression

34 ( -- * Expression

34− Expression (UnsafeExpression, renderExpression)

35+ Expression (..)

35− , HasParameter (parameter)

36+ , Expr

36− , param

37+ , type (-->)

37− -- ** Null

38+ , FunctionDB

38− , null_

39− , notNull

40− , coalesce

41− , fromNull

42− , isNull

43− , isNotNull

44− , matchNull

45− , nullIf

46− -- ** Collections

47− , array

48− , index

49− , row

50− , field

51− -- ** Functions

52− , unsafeBinaryOp

53− , unsafeUnaryOp

54 , unsafeFunction

39 , unsafeFunction

55− , unsafeVariadicFunction

40+ , function

56− , atan2_

41+ , unsafeLeftOp

57− , cast

42+ , leftOp

58− , quot_

43+ , unsafeRightOp

59− , rem_

44+ , rightOp

60− , trunc

45+ , Operator

61− , round_

46+ , OperatorDB

62− , ceiling_

47+ , unsafeBinaryOp

63− , greatest

48+ , binaryOp

64− , least

49+ , FunctionVar

65− -- ** Conditions

50+ , unsafeFunctionVar

66− , true

51+ , type (--->)

67− , false

52+ , FunctionNDB

68− , not_

53+ , unsafeFunctionN

69− , (.&&)

54+ , functionN

70− , (.||)

55+ , PGSubset (..)

71− , Condition

56+ , PGIntersect (..)

72− , caseWhenThenElse

73− , ifThenElse

74− , (.==)

75− , (./=)

76− , (.>=)

77− , (.<)

78− , (.<=)

79− , (.>)

80− -- ** Time

81− , currentDate

82− , currentTime

83− , currentTimestamp

84− , localTime

85− , localTimestamp

86− -- ** Text

87− , lower

88− , upper

89− , charLength

90− , like

91− , ilike

92− -- ** Json

93− -- *** Json and Jsonb operators

94− , (.->)

95− , (.->>)

96− , (.#>)

97− , (.#>>)

98− -- *** Jsonb operators

99− , (.@>)

100− , (.<@)

101− , (.?)

102− , (.?|)

103− , (.?&)

104− , (.-.)

105− , (#-.)

106− -- *** Functions

107− , jsonLit

108− , jsonbLit

109− , toJson

110− , toJsonb

111− , arrayToJson

112− , rowToJson

113− , jsonBuildArray

114− , jsonbBuildArray

115− , jsonBuildObject

116− , jsonbBuildObject

117− , jsonObject

118− , jsonbObject

119− , jsonZipObject

120− , jsonbZipObject

121− , jsonArrayLength

122− , jsonbArrayLength

123− , jsonExtractPath

124− , jsonbExtractPath

125− , jsonExtractPathAsText

126− , jsonbExtractPathAsText

127− , jsonTypeof

128− , jsonbTypeof

129− , jsonStripNulls

130− , jsonbStripNulls

131− , jsonbSet

132− , jsonbInsert

133− , jsonbPretty

134− -- ** Aggregation

135− , unsafeAggregate, unsafeAggregateDistinct

136− , sum_, sumDistinct

137− , PGAvg (avg, avgDistinct)

138− , bitAnd, bitOr, boolAnd, boolOr

139− , bitAndDistinct, bitOrDistinct, boolAndDistinct, boolOrDistinct

140− , countStar

141− , count, countDistinct

142− , every, everyDistinct

143− , max_, maxDistinct, min_, minDistinct

144− -- * Types

145− , TypeExpression (UnsafeTypeExpression, renderTypeExpression)

146− , PGTyped (pgtype)

147− , typedef

148− , typetable

149− , typeview

150− , bool

151− , int2

152− , smallint

153− , int4

154− , int

155− , integer

156− , int8

157− , bigint

158− , numeric

159− , float4

160− , real

161− , float8

162− , doublePrecision

163− , text

164− , char

165− , character

166− , varchar

167− , characterVarying

168− , bytea

169− , timestamp

170− , timestampWithTimeZone

171− , date

172− , time

173− , timeWithTimeZone

174− , interval

175− , uuid

176− , inet

177− , json

178− , jsonb

179− , vararray

180− , fixarray

181 -- * Re-export

57 -- * Re-export

182 , (&)

58 , (&)

183− , NP ((:*), Nil)

59+ , K (..)

60+ , unK

184 ) where

61 ) where

185

186import Control.Category

63import Control.Category

187import Control.DeepSeq

64import Control.DeepSeq

188import Data.ByteString (ByteString)

65import Data.ByteString (ByteString)

189−import Data.ByteString.Lazy (toStrict)

190import Data.Function ((&))

66import Data.Function ((&))

191import Data.Semigroup hiding (All)

67import Data.Semigroup hiding (All)

192−import qualified Data.Aeson as JSON

193−import Data.Ratio

194import Data.String

68import Data.String

195−import Data.Word

196−import Generics.SOP hiding (from)

69+import Generics.SOP hiding (All, from)

197import GHC.OverloadedLabels

70import GHC.OverloadedLabels

198import GHC.TypeLits

71import GHC.TypeLits

72+import Numeric

199import Prelude hiding (id, (.))

73import Prelude hiding (id, (.))

200

201import qualified GHC.Generics as GHC

75import qualified GHC.Generics as GHC

202

77+import Squeal.PostgreSQL.Alias

78+import Squeal.PostgreSQL.List

203import Squeal.PostgreSQL.Render

79import Squeal.PostgreSQL.Render

204import Squeal.PostgreSQL.Schema

80import Squeal.PostgreSQL.Schema

205

82+-- $setup

83+-- >>> import Squeal.PostgreSQL

84+

206{-----------------------------------------

85{-----------------------------------------

207column expressions

86column expressions

208-----------------------------------------}

87-----------------------------------------}

209

210{- | `Expression`s are used in a variety of contexts,

89{- | `Expression`s are used in a variety of contexts,

90+such as in the target `Squeal.PostgreSQL.Query.List` of the

211−such as in the target list of the `Squeal.PostgreSQL.Query.select` command,

91+`Squeal.PostgreSQL.Query.select` command,

212as new column values in `Squeal.PostgreSQL.Manipulation.insertRow` or

92as new column values in `Squeal.PostgreSQL.Manipulation.insertRow` or

213`Squeal.PostgreSQL.Manipulation.update`,

93`Squeal.PostgreSQL.Manipulation.update`,

214−or in search `Condition`s in a number of commands.

94+or in search `Squeal.PostgreSQL.Logic.Condition`s in a number of commands.

215

216The expression syntax allows the calculation of

96The expression syntax allows the calculation of

217values from primitive expression using arithmetic, logical,

97values from primitive expression using arithmetic, logical,

218and other operations.

98and 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`.

219-}

113-}

220newtype Expression

114newtype Expression

221− (db :: DBType)

115+ (outer :: FromType)

222− (params :: [NullityType])

116+ (commons :: FromType)

223 (grp :: Grouping)

117 (grp :: Grouping)

118+ (schemas :: SchemasType)

119+ (params :: [NullityType])

224 (from :: FromType)

120 (from :: FromType)

225 (ty :: NullityType)

121 (ty :: NullityType)

226 = UnsafeExpression { renderExpression :: ByteString }

122 = UnsafeExpression { renderExpression :: ByteString }

227 deriving (GHC.Generic,Show,Eq,Ord,NFData)

123 deriving (GHC.Generic,Show,Eq,Ord,NFData)

228−

229−instance RenderSQL (Expression db params grp from ty) where

124+instance RenderSQL (Expression outer commons grp schemas params from ty) where

230 renderSQL = renderExpression

125 renderSQL = renderExpression

231

126

232−{- | A `HasParameter` constraint is used to indicate a value that is

127+-- | An `Expr` is a closed `Expression`.

233−supplied externally to a SQL statement.

128+-- It is a F@RankNType@ but don't be scared.

234−`Squeal.PostgreSQL.PQ.manipulateParams`,

129+-- Think of it as an expression which sees no

235−`Squeal.PostgreSQL.PQ.queryParams` and

130+-- namespaces, so you can't use parameters

236−`Squeal.PostgreSQL.PQ.traversePrepared` support specifying data values

131+-- or alias references. It can be used as

237−separately from the SQL command string, in which case `param`s are used to

132+-- a simple piece of more complex `Expression`s.

238−refer to the out-of-line data values.

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)

239-}

181-}

240−class KnownNat n => HasParameter

182+type (--->) xs y

241− (n :: Nat)

183+ = forall outer commons grp schemas params from

242− (params :: [NullityType])

184+ . NP (Expression outer commons grp schemas params from) xs

243− (ty :: NullityType)

185+ -- ^ inputs

244− | n params -> ty where

245− -- | `parameter` takes a `Nat` using type application and a `TypeExpression`.

246− --

247− -- >>> let expr = parameter @1 int4 :: Expression (DBof schemas) from grp '[ 'Null 'PGint4] ('Null 'PGint4)

248− -- >>> printSQL expr

249− -- ($1 :: int4)

250− parameter

251− :: TypeExpression schemas ty

252− -> Expression (commons :=> schemas) params grp from ty

186+ -> Expression outer commons grp schemas params from y

253− parameter ty = UnsafeExpression $ parenthesized $

187+ -- ^ output

254− "$" <> renderNat @n <+> "::"

188+

255− <+> renderTypeExpression ty

189+type FunctionNDB schemas xs y

256−instance {-# OVERLAPPING #-} HasParameter 1 (ty1:tys) ty1

190+ = forall outer commons grp params from

257−instance {-# OVERLAPPABLE #-} (KnownNat n, HasParameter (n-1) params ty)

191+ . NP (Expression outer commons grp schemas params from) xs

258− => HasParameter n (ty' : params) ty

192+ -- ^ inputs

259−

193+ -> Expression outer commons grp schemas params from y

260−-- | `param` takes a `Nat` using type application and for basic types,

194+ -- ^ output

261−-- infers a `TypeExpression`.

195+

262−--

196+{- | A @RankNType@ for functions with a variable-length list of

197+homogeneous arguments and at least 1 more argument.

198+-}

199+type FunctionVar x0 x1 y

200+ = forall outer commons grp schemas params from

263−-- >>> let expr = param @1 :: Expression (commons :=> schemas) from grp '[ 'Null 'PGint4] ('Null 'PGint4)

201+ . [Expression outer commons grp schemas params from x0]

264−-- >>> printSQL expr

202+ -- ^ inputs

265−-- ($1 :: int4)

203+ -> Expression outer commons grp schemas params from x1

266−param

204+ -- ^ must have at least 1 input

267− :: forall n db commons schemas params from grp ty

205+ -> Expression outer commons grp schemas params from y

268− . (db ~ (commons :=> schemas), PGTyped schemas ty, HasParameter n params ty)

206+ -- ^ output

269− => Expression db params grp from ty -- ^ param

207+

270−param = parameter @n (pgtype @schemas)

208+{- | >>> printSQL (unsafeFunctionVar "greatest" [true, null_] false)

271−

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)

214+

272−instance (HasUnique tab from row, Has col row ty)

215+instance (HasUnique tab (Join outer from) row, Has col row ty)

273− => IsLabel col (Expression db params 'Ungrouped from ty) where

216+ => IsLabel col (Expression outer commons 'Ungrouped schemas params from ty) where

274− fromLabel = UnsafeExpression $ renderAlias (Alias @col)

217+ fromLabel = UnsafeExpression $ renderSQL (Alias @col)

275−instance (HasUnique tab from row, Has col row ty, column ~ (col ::: ty))

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))

276 => IsLabel col

222 => IsLabel col

277− (Aliased (Expression db params 'Ungrouped from) column) where

223+ (Aliased (Expression outer commons 'Ungrouped schemas params from) column) where

278 fromLabel = fromLabel @col `As` Alias

224 fromLabel = fromLabel @col `As` Alias

279−instance (HasUnique tab from row, Has col row ty, columns ~ '[col ::: ty])

225+instance (HasUnique tab (Join outer from) row, Has col row ty, columns ~ '[col ::: ty])

280 => IsLabel col

226 => IsLabel col

281− (NP (Aliased (Expression db params 'Ungrouped from)) columns) where

227+ (NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns) where

282 fromLabel = fromLabel @col :* Nil

228 fromLabel = fromLabel @col :* Nil

283

229

284−instance (Has tab from row, Has col row ty)

230+instance (Has tab (Join outer from) row, Has col row ty)

285− => IsQualified tab col (Expression db params 'Ungrouped from ty) where

231+ => IsQualified tab col (Expression outer commons 'Ungrouped schemas params from ty) where

286 tab ! col = UnsafeExpression $

232 tab ! col = UnsafeExpression $

287− renderAlias tab <> "." <> renderAlias col

233+ 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

288−instance (Has tab from row, Has col row ty, column ~ (col ::: ty))

237+instance (Has tab (Join outer from) row, Has col row ty, column ~ (col ::: ty))

289 => IsQualified tab col

238 => IsQualified tab col

290− (Aliased (Expression db params 'Ungrouped from) column) where

239+ (Aliased (Expression outer commons 'Ungrouped schemas params from) column) where

291 tab ! col = tab ! col `As` col

240 tab ! col = tab ! col `As` col

292−instance (Has tab from row, Has col row ty, columns ~ '[col ::: ty])

241+instance (Has tab (Join outer from) row, Has col row ty, columns ~ '[col ::: ty])

293 => IsQualified tab col

242 => IsQualified tab col

294− (NP (Aliased (Expression db params 'Ungrouped from)) columns) where

243+ (NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns) where

295 tab ! col = tab ! col :* Nil

244 tab ! col = tab ! col :* Nil

296

245

297instance

246instance

298− ( HasUnique tab from row

247+ ( HasUnique tab (Join outer from) row

248+ , Has col row ty

249+ , GroupedBy tab col bys

250+ ) => IsLabel col

251+ (Expression outer commons ('Grouped bys) schemas params from ty) where

252+ fromLabel = UnsafeExpression $ renderSQL (Alias @col)

253+instance

254+ ( HasUnique tab (Join outer from) row

299 , Has col row ty

255 , Has col row ty

300 , GroupedBy tab col bys

256 , GroupedBy tab col bys

257+ , tys ~ '[ty]

301 ) => IsLabel col

258 ) => IsLabel col

302− (Expression db params ('Grouped bys) from ty) where

259+ (NP (Expression outer commons ('Grouped bys) schemas params from) tys) where

303− fromLabel = UnsafeExpression $ renderAlias (Alias @col)

260+ fromLabel = fromLabel @col :* Nil

304instance

261instance

305− ( HasUnique tab from row

262+ ( HasUnique tab (Join outer from) row

306 , Has col row ty

263 , Has col row ty

307 , GroupedBy tab col bys

264 , GroupedBy tab col bys

308 , column ~ (col ::: ty)

265 , column ~ (col ::: ty)

309 ) => IsLabel col

266 ) => IsLabel col

310− (Aliased (Expression db params ('Grouped bys) from) column) where

267+ (Aliased (Expression outer commons ('Grouped bys) schemas params from) column) where

311 fromLabel = fromLabel @col `As` Alias

268 fromLabel = fromLabel @col `As` Alias

312instance

269instance

313− ( HasUnique tab from row

270+ ( HasUnique tab (Join outer from) row

314 , Has col row ty

271 , Has col row ty

315 , GroupedBy tab col bys

272 , GroupedBy tab col bys

316 , columns ~ '[col ::: ty]

273 , columns ~ '[col ::: ty]

317 ) => IsLabel col

274 ) => IsLabel col

318− (NP (Aliased (Expression db params ('Grouped bys) from)) columns) where

275+ (NP (Aliased (Expression outer commons ('Grouped bys) schemas params from)) columns) where

319 fromLabel = fromLabel @col :* Nil

276 fromLabel = fromLabel @col :* Nil

320

277

321instance

278instance

322− ( Has tab from row

279+ ( Has tab (Join outer from) row

323 , Has col row ty

280 , Has col row ty

324 , GroupedBy tab col bys

281 , GroupedBy tab col bys

325 ) => IsQualified tab col

282 ) => IsQualified tab col

326− (Expression db params ('Grouped bys) from ty) where

283+ (Expression outer commons ('Grouped bys) schemas params from ty) where

327 tab ! col = UnsafeExpression $

284 tab ! col = UnsafeExpression $

328− renderAlias tab <> "." <> renderAlias col

285+ renderSQL tab <> "." <> renderSQL col

329instance

286instance

330− ( Has tab from row

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

331 , Has col row ty

296 , Has col row ty

332 , GroupedBy tab col bys

297 , GroupedBy tab col bys

333 , column ~ (col ::: ty)

298 , column ~ (col ::: ty)

334 ) => IsQualified tab col

299 ) => IsQualified tab col

335− (Aliased (Expression db params ('Grouped bys) from) column) where

300+ (Aliased (Expression outer commons ('Grouped bys) schemas params from) column) where

336 tab ! col = tab ! col `As` col

301 tab ! col = tab ! col `As` col

337instance

302instance

338− ( Has tab from row

303+ ( Has tab (Join outer from) row

339 , Has col row ty

304 , Has col row ty

340 , GroupedBy tab col bys

305 , GroupedBy tab col bys

341 , columns ~ '[col ::: ty]

306 , columns ~ '[col ::: ty]

342 ) => IsQualified tab col

307 ) => IsQualified tab col

343− (NP (Aliased (Expression db params ('Grouped bys) from)) columns) where

308+ (NP (Aliased (Expression outer commons ('Grouped bys) schemas params from)) columns) where

344 tab ! col = tab ! col :* Nil

309 tab ! col = tab ! col :* Nil

345

310

346−-- | analagous to `Nothing`

347−--

348−-- >>> printSQL null_

349−-- NULL

350−null_ :: Expression db rels grouping params ('Null ty)

351−null_ = UnsafeExpression "NULL"

352−

353−-- | analagous to `Just`

354−--

355−-- >>> printSQL $ notNull true

356−-- TRUE

357−notNull

358− :: Expression db rels grouping params ('NotNull ty)

359− -> Expression db rels grouping params ('Null ty)

360−notNull = UnsafeExpression . renderExpression

361−

362−-- | return the leftmost value which is not NULL

363−--

364−-- >>> printSQL $ coalesce [null_, true] false

365−-- COALESCE(NULL, TRUE, FALSE)

366−coalesce

367− :: [Expression db params grp from ('Null ty)]

368− -- ^ @NULL@s may be present

369− -> Expression db params grp from ('NotNull ty)

370− -- ^ @NULL@ is absent

371− -> Expression db params grp from ('NotNull ty)

372−coalesce nullxs notNullx = UnsafeExpression $

373− "COALESCE" <> parenthesized (commaSeparated

374− ((renderExpression <$> nullxs) <> [renderExpression notNullx]))

375−

376−-- | analagous to `Data.Maybe.fromMaybe` using @COALESCE@

377−--

378−-- >>> printSQL $ fromNull true null_

379−-- COALESCE(NULL, TRUE)

380−fromNull

381− :: Expression db params grp from ('NotNull ty)

382− -- ^ what to convert @NULL@ to

383− -> Expression db params grp from ('Null ty)

384− -> Expression db params grp from ('NotNull ty)

385−fromNull notNullx nullx = coalesce [nullx] notNullx

386−

387−-- | >>> printSQL $ null_ & isNull

388−-- NULL IS NULL

389−isNull

390− :: Expression db params grp from ('Null ty)

391− -- ^ possibly @NULL@

392− -> Condition db params grp from

393−isNull x = UnsafeExpression $ renderExpression x <+> "IS NULL"

394−

395−-- | >>> printSQL $ null_ & isNotNull

396−-- NULL IS NOT NULL

397−isNotNull

398− :: Expression db params grp from ('Null ty)

399− -- ^ possibly @NULL@

400− -> Condition db params grp from

401−isNotNull x = UnsafeExpression $ renderExpression x <+> "IS NOT NULL"

402−

403−-- | analagous to `maybe` using @IS NULL@

404−--

405−-- >>> printSQL $ matchNull true not_ null_

406−-- CASE WHEN NULL IS NULL THEN TRUE ELSE (NOT NULL) END

407−matchNull

408− :: Expression db params grp from (nullty)

409− -- ^ what to convert @NULL@ to

410− -> ( Expression db params grp from ('NotNull ty)

411− -> Expression db params grp from (nullty) )

412− -- ^ function to perform when @NULL@ is absent

413− -> Expression db params grp from ('Null ty)

414− -> Expression db params grp from (nullty)

415−matchNull y f x = ifThenElse (isNull x) y

416− (f (UnsafeExpression (renderExpression x)))

417−

418−{-| right inverse to `fromNull`, if its arguments are equal then

419−`nullIf` gives @NULL@.

420−

421−>>> :set -XTypeApplications -XDataKinds

422−>>> let expr = nullIf false (param @1) :: Expression (commons :=> schema) from grp '[ 'NotNull 'PGbool] ('Null 'PGbool)

423−>>> printSQL expr

424−NULL IF (FALSE, ($1 :: bool))

425−-}

426−nullIf

427− :: Expression db params grp from ('NotNull ty)

428− -- ^ @NULL@ is absent

429− -> Expression db params grp from ('NotNull ty)

430− -- ^ @NULL@ is absent

431− -> Expression db params grp from ('Null ty)

432−nullIf x y = UnsafeExpression $ "NULL IF" <+> parenthesized

433− (renderExpression x <> ", " <> renderExpression y)

434−

435−-- | >>> printSQL $ array [null_, false, true]

436−-- ARRAY[NULL, FALSE, TRUE]

437−array

438− :: [Expression db params grp from ty]

439− -- ^ array elements

440− -> Expression db params grp from (nullity ('PGvararray ty))

441−array xs = UnsafeExpression $

442− "ARRAY[" <> commaSeparated (renderExpression <$> xs) <> "]"

443−

444−-- | >>> printSQL $ array [null_, false, true] & index 2

445−-- (ARRAY[NULL, FALSE, TRUE])[2]

446−index

447− :: Word64 -- ^ index

448− -> Expression db params grp from (nullity ('PGvararray ty)) -- ^ array

449− -> Expression db params grp from (NullifyType ty)

450−index n expr = UnsafeExpression $

451− parenthesized (renderExpression expr) <> "[" <> fromString (show n) <> "]"

452−

453instance (KnownSymbol label, label `In` labels) => IsPGlabel label

311instance (KnownSymbol label, label `In` labels) => IsPGlabel label

454− (Expression db params grp from (nullity ('PGenum labels))) where

312+ (Expression outer commons grp schemas params from (null ('PGenum labels))) where

455− label = UnsafeExpression $ renderLabel (PGlabel @label)

313+ label = UnsafeExpression $ renderSQL (PGlabel @label)

456−

457−-- | A row constructor is an expression that builds a row value

458−-- (also called a composite value) using values for its member fields.

459−--

460−-- >>> :{

461−-- type Complex = 'PGcomposite

462−-- '[ "real" ::: 'NotNull 'PGfloat8

463−-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

464−-- :}

465−--

466−-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression db from grp params ('NotNull Complex)

467−-- >>> printSQL i

468−-- ROW(0, 1)

469−row

470− :: SListI row

471− => NP (Aliased (Expression db params grp from)) row

472− -- ^ zero or more expressions for the row field values

473− -> Expression db params grp from (nullity ('PGcomposite row))

474−row exprs = UnsafeExpression $ "ROW" <> parenthesized

475− (renderCommaSeparated (\ (expr `As` _) -> renderExpression expr) exprs)

476−

477−-- | >>> :{

478−-- type Complex = 'PGcomposite

479−-- '[ "real" ::: 'NotNull 'PGfloat8

480−-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

481−-- type Schema = '["complex" ::: 'Typedef Complex]

482−-- type DB = DBof (Public Schema)

483−-- :}

484−--

485−-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression DB from grp params ('NotNull Complex)

486−-- >>> printSQL $ i & field #complex #imaginary

487−-- (ROW(0, 1)::"complex")."imaginary"

488−field

489− :: ( Has sch schemas schema

490− , Has tydef schema ('Typedef ('PGcomposite row))

491− , Has field row ty)

492− => QualifiedAlias sch tydef -- ^ row type

493− -> Alias field -- ^ field name

494− -> Expression (commons :=> schemas) params grp from ('NotNull ('PGcomposite row))

495− -> Expression (commons :=> schemas) params grp from ty

496−field td fld expr = UnsafeExpression $

497− parenthesized (renderExpression expr <> "::" <> renderQualifiedAlias td)

498− <> "." <> renderAlias fld

499−

500−instance Semigroup

501− (Expression db params grp from (nullity ('PGvararray ty))) where

502− (<>) = unsafeBinaryOp "||"

503−

504−instance Monoid

505− (Expression db params grp from (nullity ('PGvararray ty))) where

506− mempty = array []

507− mappend = (<>)

508−

509−-- | >>> let expr = greatest currentTimestamp [param @1] :: Expression (commons :=> schemas) rels grp '[ 'NotNull 'PGtimestamptz] ('NotNull 'PGtimestamptz)

510−-- >>> printSQL expr

511−-- GREATEST(CURRENT_TIMESTAMP, ($1 :: timestamp with time zone))

512−greatest

513− :: Expression db params grp from (nullty)

514− -- ^ needs at least 1 argument

515− -> [Expression db params grp from (nullty)]

516− -- ^ or more

517− -> Expression db params grp from (nullty)

518−greatest x xs = UnsafeExpression $ "GREATEST("

519− <> commaSeparated (renderExpression <$> (x:xs)) <> ")"

520−

521−-- | >>> printSQL $ least currentTimestamp [null_]

522−-- LEAST(CURRENT_TIMESTAMP, NULL)

523−least

524− :: Expression db params grp from (nullty)

525− -- ^ needs at least 1 argument

526− -> [Expression db params grp from (nullty)]

527− -- ^ or more

528− -> Expression db params grp from (nullty)

529−least x xs = UnsafeExpression $ "LEAST("

530− <> commaSeparated (renderExpression <$> (x:xs)) <> ")"

531

314

532-- | >>> printSQL $ unsafeBinaryOp "OR" true false

315-- | >>> printSQL $ unsafeBinaryOp "OR" true false

533-- (TRUE OR FALSE)

316-- (TRUE OR FALSE)

534−unsafeBinaryOp

317+unsafeBinaryOp :: ByteString -> Operator ty0 ty1 ty2

535− :: ByteString

536− -- ^ operator

537− -> Expression db params grp from (ty0)

538− -> Expression db params grp from (ty1)

539− -> Expression db params grp from (ty2)

540unsafeBinaryOp op x y = UnsafeExpression $ parenthesized $

318unsafeBinaryOp op x y = UnsafeExpression $ parenthesized $

541− renderExpression x <+> op <+> renderExpression y

319+ renderSQL x <+> op <+> renderSQL y

320+

321+binaryOp

322+ :: forall op sch schemas schema x y z.

323+ ( Has sch schemas schema

324+ , Has op schema ('Operator ('BinaryOp x y z)) )

325+ => OperatorDB schemas x y z

326+binaryOp = unsafeBinaryOp $ renderSymbol @op

542

327

543−-- | >>> printSQL $ unsafeUnaryOp "NOT" true

328+-- | >>> printSQL $ unsafeLeftOp "NOT" true

544-- (NOT TRUE)

329-- (NOT TRUE)

545−unsafeUnaryOp

546− :: ByteString

330+unsafeLeftOp :: ByteString -> x --> y

547− -- ^ operator

331+unsafeLeftOp op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x

548− -> Expression db params grp from (ty0)

332+

549− -> Expression db params grp from (ty1)

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

550−unsafeUnaryOp op x = UnsafeExpression $ parenthesized $

343+unsafeRightOp op x = UnsafeExpression $ parenthesized $ renderSQL x <+> op

551− op <+> renderExpression x

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

552

351

553-- | >>> printSQL $ unsafeFunction "f" true

352-- | >>> printSQL $ unsafeFunction "f" true

554-- f(TRUE)

353-- f(TRUE)

555−unsafeFunction

354+unsafeFunction :: ByteString -> x --> y

556− :: ByteString

557− -- ^ function

558− -> Expression db params grp from (xty)

559− -> Expression db params grp from (yty)

560unsafeFunction fun x = UnsafeExpression $

355unsafeFunction fun x = UnsafeExpression $

561− fun <> parenthesized (renderExpression x)

356+ fun <> parenthesized (renderSQL x)

357+

358+function

359+ :: (Has sch schemas schema, Has fun schema ('Function ('[x] :=> 'Returns y)))

360+ => QualifiedAlias sch fun

361+ -> FunctionDB schemas x y

362+function = unsafeFunction . renderSQL

562

363

563−-- | Helper for defining variadic functions.

364+-- | >>> printSQL $ unsafeFunctionN "f" (currentTime :* localTimestamp :* false *: literal 'a')

564−unsafeVariadicFunction

365+-- f(CURRENT_TIME, LOCALTIMESTAMP, FALSE, E'a')

565− :: SListI elems

566− => ByteString

366+unsafeFunctionN :: SListI xs => ByteString -> xs ---> y

567− -- ^ function

568− -> NP (Expression db params grp from) elems

569− -> Expression db params grp from ret

570−unsafeVariadicFunction fun x = UnsafeExpression $

367+unsafeFunctionN fun xs = UnsafeExpression $

571− fun <> parenthesized (commaSeparated (hcollapse (hmap (K . renderExpression) x)))

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

572

377

573instance ty `In` PGNum

378instance ty `In` PGNum

574− => Num (Expression db params grp from (nullity ty)) where

379+ => Num (Expression outer commons grp schemas params from (null ty)) where

575 (+) = unsafeBinaryOp "+"

380 (+) = unsafeBinaryOp "+"

576 (-) = unsafeBinaryOp "-"

381 (-) = unsafeBinaryOp "-"

577 (*) = unsafeBinaryOp "*"

382 (*) = unsafeBinaryOp "*"

@@ -583,18 +388,23 @@ instance ty `In` PGNum

583 . show

388 . show

584

389

585instance (ty `In` PGNum, ty `In` PGFloating) => Fractional

390instance (ty `In` PGNum, ty `In` PGFloating) => Fractional

586− (Expression db params grp from (nullity ty)) where

391+ (Expression outer commons grp schemas params from (null ty)) where

587 (/) = unsafeBinaryOp "/"

392 (/) = unsafeBinaryOp "/"

588− fromRational x = fromInteger (numerator x) / fromInteger (denominator x)

393+ fromRational

394+ = UnsafeExpression

395+ . fromString

396+ . ($ "")

397+ . showFFloat Nothing

398+ . fromRat @Double

589

399

590instance (ty `In` PGNum, ty `In` PGFloating) => Floating

400instance (ty `In` PGNum, ty `In` PGFloating) => Floating

591− (Expression db params grp from (nullity ty)) where

401+ (Expression outer commons grp schemas params from (null ty)) where

592 pi = UnsafeExpression "pi()"

402 pi = UnsafeExpression "pi()"

593 exp = unsafeFunction "exp"

403 exp = unsafeFunction "exp"

594 log = unsafeFunction "ln"

404 log = unsafeFunction "ln"

595 sqrt = unsafeFunction "sqrt"

405 sqrt = unsafeFunction "sqrt"

596 b ** x = UnsafeExpression $

406 b ** x = UnsafeExpression $

597− "power(" <> renderExpression b <> ", " <> renderExpression x <> ")"

407+ "power(" <> renderSQL b <> ", " <> renderSQL x <> ")"

598 logBase b y = log y / log b

408 logBase b y = log y / log b

599 sin = unsafeFunction "sin"

409 sin = unsafeFunction "sin"

600 cos = unsafeFunction "cos"

410 cos = unsafeFunction "cos"

@@ -609,1167 +419,54 @@ instance (ty `In` PGNum, ty `In` PGFloating) => Floating

609 acosh x = log (x + sqrt (x*x - 1))

419 acosh x = log (x + sqrt (x*x - 1))

610 atanh x = log ((1 + x) / (1 - x)) / 2

420 atanh x = log ((1 + x) / (1 - x)) / 2

611

421

612−-- | >>> :{

422+-- | Contained by operators

613−-- let

423+class PGSubset ty where

614−-- expression :: Expression db params grp from (nullity 'PGfloat4)

424+ (@>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

615−-- expression = atan2_ pi 2

425+ (@>) = unsafeBinaryOp "@>"

616−-- in printSQL expression

426+ (<@) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

617−-- :}

427+ (<@) = unsafeBinaryOp "<@"

618−-- atan2(pi(), 2)

428+instance PGSubset 'PGjsonb

619−atan2_

429+instance PGSubset 'PGtsquery

620− :: float `In` PGFloating

430+instance PGSubset ('PGvararray ty)

621− => Expression db params grp from (nullity float)

431+instance PGSubset ('PGrange ty)

622− -- ^ numerator

432+

623− -> Expression db params grp from (nullity float)

433+class PGIntersect ty where

624− -- ^ denominator

434+ (@&&) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

625− -> Expression db params grp from (nullity float)

435+ (@&&) = unsafeBinaryOp "&&"

626−atan2_ y x = UnsafeExpression $

436+instance PGIntersect ('PGvararray ty)

627− "atan2(" <> renderExpression y <> ", " <> renderExpression x <> ")"

437+instance PGIntersect ('PGrange ty)

628−

629−-- When a `cast` is applied to an `Expression` of a known type, it

630−-- represents a run-time type conversion. The cast will succeed only if a

631−-- suitable type conversion operation has been defined.

632−--

633−-- | >>> printSQL $ true & cast int4

634−-- (TRUE :: int4)

635−cast

636− :: TypeExpression schemas ty1

637− -- ^ type to cast as

638− -> Expression (commons :=> schemas) params grp from ty0

639− -- ^ value to convert

640− -> Expression (commons :=> schemas) params grp from ty1

641−cast ty x = UnsafeExpression $ parenthesized $

642− renderExpression x <+> "::" <+> renderTypeExpression ty

643−

644−-- | integer division, truncates the result

645−--

646−-- >>> :{

647−-- let

648−-- expression :: Expression db params grp from (nullity 'PGint2)

649−-- expression = 5 `quot_` 2

650−-- in printSQL expression

651−-- :}

652−-- (5 / 2)

653−quot_

654− :: int `In` PGIntegral

655− => Expression db params grp from (nullity int)

656− -- ^ numerator

657− -> Expression db params grp from (nullity int)

658− -- ^ denominator

659− -> Expression db params grp from (nullity int)

660−quot_ = unsafeBinaryOp "/"

661−

662−-- | remainder upon integer division

663−--

664−-- >>> :{

665−-- let

666−-- expression :: Expression db params grp from (nullity 'PGint2)

667−-- expression = 5 `rem_` 2

668−-- in printSQL expression

669−-- :}

670−-- (5 % 2)

671−rem_

672− :: int `In` PGIntegral

673− => Expression db params grp from (nullity int)

674− -- ^ numerator

675− -> Expression db params grp from (nullity int)

676− -- ^ denominator

677− -> Expression db params grp from (nullity int)

678−rem_ = unsafeBinaryOp "%"

679−

680−-- | >>> :{

681−-- let

682−-- expression :: Expression db params grp from (nullity 'PGfloat4)

683−-- expression = trunc pi

684−-- in printSQL expression

685−-- :}

686−-- trunc(pi())

687−trunc

688− :: frac `In` PGFloating

689− => Expression db params grp from (nullity frac)

690− -- ^ fractional number

691− -> Expression db params grp from (nullity frac)

692−trunc = unsafeFunction "trunc"

693−

694−-- | >>> :{

695−-- let

696−-- expression :: Expression db params grp from (nullity 'PGfloat4)

697−-- expression = round_ pi

698−-- in printSQL expression

699−-- :}

700−-- round(pi())

701−round_

702− :: frac `In` PGFloating

703− => Expression db params grp from (nullity frac)

704− -- ^ fractional number

705− -> Expression db params grp from (nullity frac)

706−round_ = unsafeFunction "round"

707−

708−-- | >>> :{

709−-- let

710−-- expression :: Expression db params grp from (nullity 'PGfloat4)

711−-- expression = ceiling_ pi

712−-- in printSQL expression

713−-- :}

714−-- ceiling(pi())

715−ceiling_

716− :: frac `In` PGFloating

717− => Expression db params grp from (nullity frac)

718− -- ^ fractional number

719− -> Expression db params grp from (nullity frac)

720−ceiling_ = unsafeFunction "ceiling"

721−

722−-- | A `Condition` is an `Expression`, which can evaluate

723−-- to `true`, `false` or `null_`. This is because SQL uses

724−-- a three valued logic.

725−type Condition db params grp from =

726− Expression db params grp from ('Null 'PGbool)

727−

728−-- | >>> printSQL true

729−-- TRUE

730−true :: Expression db params grp from (nullity 'PGbool)

731−true = UnsafeExpression "TRUE"

732−

733−-- | >>> printSQL false

734−-- FALSE

735−false :: Expression db params grp from (nullity 'PGbool)

736−false = UnsafeExpression "FALSE"

737−

738−-- | >>> printSQL $ not_ true

739−-- (NOT TRUE)

740−not_

741− :: Expression db params grp from (nullity 'PGbool)

742− -> Expression db params grp from (nullity 'PGbool)

743−not_ = unsafeUnaryOp "NOT"

744−

745−-- | >>> printSQL $ true .&& false

746−-- (TRUE AND FALSE)

747−(.&&)

748− :: Expression db params grp from (nullity 'PGbool)

749− -> Expression db params grp from (nullity 'PGbool)

750− -> Expression db params grp from (nullity 'PGbool)

751−infixr 3 .&&

752−(.&&) = unsafeBinaryOp "AND"

753−

754−-- | >>> printSQL $ true .|| false

755−-- (TRUE OR FALSE)

756−(.||)

757− :: Expression db params grp from (nullity 'PGbool)

758− -> Expression db params grp from (nullity 'PGbool)

759− -> Expression db params grp from (nullity 'PGbool)

760−infixr 2 .||

761−(.||) = unsafeBinaryOp "OR"

762−

763−-- | >>> :{

764−-- let

765−-- expression :: Expression db params grp from (nullity 'PGint2)

766−-- expression = caseWhenThenElse [(true, 1), (false, 2)] 3

767−-- in printSQL expression

768−-- :}

769−-- CASE WHEN TRUE THEN 1 WHEN FALSE THEN 2 ELSE 3 END

770−caseWhenThenElse

771− :: [ ( Condition db params grp from

772− , Expression db params grp from ty

773− ) ]

774− -- ^ whens and thens

775− -> Expression db params grp from ty

776− -- ^ else

777− -> Expression db params grp from ty

778−caseWhenThenElse whenThens else_ = UnsafeExpression $ mconcat

779− [ "CASE"

780− , mconcat

781− [ mconcat

782− [ " WHEN ", renderExpression when_

783− , " THEN ", renderExpression then_

784− ]

785− | (when_,then_) <- whenThens

786− ]

787− , " ELSE ", renderExpression else_

788− , " END"

789− ]

790−

791−-- | >>> :{

792−-- let

793−-- expression :: Expression db params grp from (nullity 'PGint2)

794−-- expression = ifThenElse true 1 0

795−-- in printSQL expression

796−-- :}

797−-- CASE WHEN TRUE THEN 1 ELSE 0 END

798−ifThenElse

799− :: Condition db params grp from

800− -> Expression db params grp from ty -- ^ then

801− -> Expression db params grp from ty -- ^ else

802− -> Expression db params grp from ty

803−ifThenElse if_ then_ else_ = caseWhenThenElse [(if_,then_)] else_

804−

805−-- | Comparison operations like `.==`, `./=`, `.>`, `.>=`, `.<` and `.<=`

806−-- will produce @NULL@s if one of their arguments is @NULL@.

807−--

808−-- >>> printSQL $ true .== null_

809−-- (TRUE = NULL)

810−(.==)

811− :: Expression db params grp from (nullity0 ty) -- ^ lhs

812− -> Expression db params grp from (nullity1 ty) -- ^ rhs

813− -> Condition db params grp from

814−(.==) = unsafeBinaryOp "="

815−infix 4 .==

816−

817−-- | >>> printSQL $ true ./= null_

818−-- (TRUE <> NULL)

819−(./=)

820− :: Expression db params grp from (nullity0 ty) -- ^ lhs

821− -> Expression db params grp from (nullity1 ty) -- ^ rhs

822− -> Condition db params grp from

823−(./=) = unsafeBinaryOp "<>"

824−infix 4 ./=

825−

826−-- | >>> printSQL $ true .>= null_

827−-- (TRUE >= NULL)

828−(.>=)

829− :: Expression db params grp from (nullity0 ty) -- ^ lhs

830− -> Expression db params grp from (nullity1 ty) -- ^ rhs

831− -> Condition db params grp from

832−(.>=) = unsafeBinaryOp ">="

833−infix 4 .>=

834−

835−-- | >>> printSQL $ true .< null_

836−-- (TRUE < NULL)

837−(.<)

838− :: Expression db params grp from (nullity0 ty) -- ^ lhs

839− -> Expression db params grp from (nullity1 ty) -- ^ rhs

840− -> Condition db params grp from

841−(.<) = unsafeBinaryOp "<"

842−infix 4 .<

843−

844−-- | >>> printSQL $ true .<= null_

845−-- (TRUE <= NULL)

846−(.<=)

847− :: Expression db params grp from (nullity0 ty) -- ^ lhs

848− -> Expression db params grp from (nullity1 ty) -- ^ rhs

849− -> Condition db params grp from

850−(.<=) = unsafeBinaryOp "<="

851−infix 4 .<=

852−

853−-- | >>> printSQL $ true .> null_

854−-- (TRUE > NULL)

855−(.>)

856− :: Expression db params grp from (nullity0 ty) -- ^ lhs

857− -> Expression db params grp from (nullity1 ty) -- ^ rhs

858− -> Condition db params grp from

859−(.>) = unsafeBinaryOp ">"

860−infix 4 .>

861−

862−-- | >>> printSQL currentDate

863−-- CURRENT_DATE

864−currentDate

865− :: Expression db params grp from (nullity 'PGdate)

866−currentDate = UnsafeExpression "CURRENT_DATE"

867−

868−-- | >>> printSQL currentTime

869−-- CURRENT_TIME

870−currentTime

871− :: Expression db params grp from (nullity 'PGtimetz)

872−currentTime = UnsafeExpression "CURRENT_TIME"

873−

874−-- | >>> printSQL currentTimestamp

875−-- CURRENT_TIMESTAMP

876−currentTimestamp

877− :: Expression db params grp from (nullity 'PGtimestamptz)

878−currentTimestamp = UnsafeExpression "CURRENT_TIMESTAMP"

879−

880−-- | >>> printSQL localTime

881−-- LOCALTIME

882−localTime

883− :: Expression db params grp from (nullity 'PGtime)

884−localTime = UnsafeExpression "LOCALTIME"

885−

886−-- | >>> printSQL localTimestamp

887−-- LOCALTIMESTAMP

888−localTimestamp

889− :: Expression db params grp from (nullity 'PGtimestamp)

890−localTimestamp = UnsafeExpression "LOCALTIMESTAMP"

891−

892−{-----------------------------------------

893−text

894−-----------------------------------------}

895

438

896instance IsString

439instance IsString

897− (Expression db params grp from (nullity 'PGtext)) where

440+ (Expression outer commons grp schemas params from (null 'PGtext)) where

898 fromString str = UnsafeExpression $

441 fromString str = UnsafeExpression $

899 "E\'" <> fromString (escape =<< str) <> "\'"

442 "E\'" <> fromString (escape =<< str) <> "\'"

900− where

443+instance IsString

901− escape = \case

444+ (Expression outer commons grp schemas params from (null 'PGtsvector)) where

902− '\NUL' -> "\\0"

445+ fromString str = UnsafeExpression . parenthesized . (<> " :: tsvector") $

903− '\'' -> "''"

446+ "E\'" <> fromString (escape =<< str) <> "\'"

904− '"' -> "\\\""

447+instance IsString

905− '\b' -> "\\b"

448+ (Expression outer commons grp schemas params from (null 'PGtsquery)) where

906− '\n' -> "\\n"

449+ fromString str = UnsafeExpression . parenthesized . (<> " :: tsquery") $

907− '\r' -> "\\r"

450+ "E\'" <> fromString (escape =<< str) <> "\'"

908− '\t' -> "\\t"

909− '\\' -> "\\\\"

910− c -> [c]

911

451

912instance Semigroup

452instance Semigroup

913− (Expression db params grp from (nullity 'PGtext)) where

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

914 (<>) = unsafeBinaryOp "||"

463 (<>) = unsafeBinaryOp "||"

915

464

916instance Monoid

465instance Monoid

917− (Expression db params grp from (nullity 'PGtext)) where

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

918 mempty = fromString ""

471 mempty = fromString ""

919 mappend = (<>)

472 mappend = (<>)

920−

921−-- | >>> printSQL $ lower "ARRRGGG"

922−-- lower(E'ARRRGGG')

923−lower

924− :: Expression db params grp from (nullity 'PGtext)

925− -- ^ string to lower case

926− -> Expression db params grp from (nullity 'PGtext)

927−lower = unsafeFunction "lower"

928−

929−-- | >>> printSQL $ upper "eeee"

930−-- upper(E'eeee')

931−upper

932− :: Expression db params grp from (nullity 'PGtext)

933− -- ^ string to upper case

934− -> Expression db params grp from (nullity 'PGtext)

935−upper = unsafeFunction "upper"

936−

937−-- | >>> printSQL $ charLength "four"

938−-- char_length(E'four')

939−charLength

940− :: Expression db params grp from (nullity 'PGtext)

941− -- ^ string to measure

942− -> Expression db params grp from (nullity 'PGint4)

943−charLength = unsafeFunction "char_length"

944−

945−-- | The `like` expression returns true if the @string@ matches

946−-- the supplied @pattern@. If @pattern@ does not contain percent signs

947−-- or underscores, then the pattern only represents the string itself;

948−-- in that case `like` acts like the equals operator. An underscore (_)

949−-- in pattern stands for (matches) any single character; a percent sign (%)

950−-- matches any sequence of zero or more characters.

951−--

952−-- >>> printSQL $ "abc" `like` "a%"

953−-- (E'abc' LIKE E'a%')

954−like

955− :: Expression db params grp from (nullity 'PGtext)

956− -- ^ string

957− -> Expression db params grp from (nullity 'PGtext)

958− -- ^ pattern

959− -> Expression db params grp from (nullity 'PGbool)

960−like = unsafeBinaryOp "LIKE"

961−

962−-- | The key word ILIKE can be used instead of LIKE to make the

963−-- match case-insensitive according to the active locale.

964−--

965−-- >>> printSQL $ "abc" `ilike` "a%"

966−-- (E'abc' ILIKE E'a%')

967−ilike

968− :: Expression db params grp from (nullity 'PGtext)

969− -- ^ string

970− -> Expression db params grp from (nullity 'PGtext)

971− -- ^ pattern

972− -> Expression db params grp from (nullity 'PGbool)

973−ilike = unsafeBinaryOp "ILIKE"

974−

975−{-----------------------------------------

976− -- json and jsonb support

977−

978−See https://www.postgresql.org/docs/10/static/functions-json.html -- most

979−comments lifted directly from this page.

980−

981−Table 9.44: json and jsonb operators

982−-----------------------------------------}

983−

984−-- | Get JSON value (object field or array element) at a key.

985−(.->)

986− :: (json `In` PGJsonType, key `In` PGJsonKey)

987− => Expression db params grp from (nullity json)

988− -> Expression db params grp from (nullity key)

989− -> Expression db params grp from ('Null json)

990−infixl 8 .->

991−(.->) = unsafeBinaryOp "->"

992−

993−-- | Get JSON value (object field or array element) at a key, as text.

994−(.->>)

995− :: (json `In` PGJsonType, key `In` PGJsonKey)

996− => Expression db params grp from (nullity json)

997− -> Expression db params grp from (nullity key)

998− -> Expression db params grp from ('Null 'PGtext)

999−infixl 8 .->>

1000−(.->>) = unsafeBinaryOp "->>"

1001−

1002−-- | Get JSON value at a specified path.

1003−(.#>)

1004− :: (json `In` PGJsonType, PGTextArray "(.#>)" path)

1005− => Expression db params grp from (nullity json)

1006− -> Expression db params grp from (nullity path)

1007− -> Expression db params grp from ('Null json)

1008−infixl 8 .#>

1009−(.#>) = unsafeBinaryOp "#>"

1010−

1011−-- | Get JSON value at a specified path as text.

1012−(.#>>)

1013− :: (json `In` PGJsonType, PGTextArray "(.#>>)" path)

1014− => Expression db params grp from (nullity json)

1015− -> Expression db params grp from (nullity path)

1016− -> Expression db params grp from ('Null 'PGtext)

1017−infixl 8 .#>>

1018−(.#>>) = unsafeBinaryOp "#>>"

1019−

1020−-- Additional jsonb operators

1021−

1022−-- | Does the left JSON value contain the right JSON path/value entries at the

1023−-- top level?

1024−(.@>)

1025− :: Expression db params grp from (nullity 'PGjsonb)

1026− -> Expression db params grp from (nullity 'PGjsonb)

1027− -> Condition db params grp from

1028−infixl 9 .@>

1029−(.@>) = unsafeBinaryOp "@>"

1030−

1031−-- | Are the left JSON path/value entries contained at the top level within the

1032−-- right JSON value?

1033−(.<@)

1034− :: Expression db params grp from (nullity 'PGjsonb)

1035− -> Expression db params grp from (nullity 'PGjsonb)

1036− -> Condition db params grp from

1037−infixl 9 .<@

1038−(.<@) = unsafeBinaryOp "<@"

1039−

1040−-- | Does the string exist as a top-level key within the JSON value?

1041−(.?)

1042− :: Expression db params grp from (nullity 'PGjsonb)

1043− -> Expression db params grp from (nullity 'PGtext)

1044− -> Condition db params grp from

1045−infixl 9 .?

1046−(.?) = unsafeBinaryOp "?"

1047−

1048−-- | Do any of these array strings exist as top-level keys?

1049−(.?|)

1050− :: Expression db params grp from (nullity 'PGjsonb)

1051− -> Expression db params grp from (nullity ('PGvararray ('NotNull 'PGtext)))

1052− -> Condition db params grp from

1053−infixl 9 .?|

1054−(.?|) = unsafeBinaryOp "?|"

1055−

1056−-- | Do all of these array strings exist as top-level keys?

1057−(.?&)

1058− :: Expression db params grp from (nullity 'PGjsonb)

1059− -> Expression db params grp from (nullity ('PGvararray ('NotNull 'PGtext)))

1060− -> Condition db params grp from

1061−infixl 9 .?&

1062−(.?&) = unsafeBinaryOp "?&"

1063−

1064−-- | Concatenate two jsonb values into a new jsonb value.

1065−instance

1066− Semigroup (Expression db from grouping param (nullity 'PGjsonb)) where

1067− (<>) = unsafeBinaryOp "||"

1068−

1069−-- | Delete a key or keys from a JSON object, or remove an array element.

1070−--

1071−-- If the right operand is..

1072−--

1073−-- @ text @: Delete key/value pair or string element from left operand. Key/value pairs

1074−-- are matched based on their key value.

1075−--

1076−-- @ text[] @: Delete multiple key/value pairs or string elements

1077−-- from left operand. Key/value pairs are matched based on their key value.

1078−--

1079−-- @ integer @: Delete the array element with specified index (Negative integers

1080−-- count from the end). Throws an error if top level container is not an array.

1081−(.-.)

1082− :: (key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]) -- hlint error without parens here

1083− => Expression db params grp from (nullity 'PGjsonb)

1084− -> Expression db params grp from (nullity key)

1085− -> Expression db params grp from (nullity 'PGjsonb)

1086−infixl 6 .-.

1087−(.-.) = unsafeBinaryOp "-"

1088−

1089−-- | Delete the field or element with specified path (for JSON arrays, negative

1090−-- integers count from the end)

1091−(#-.)

1092− :: PGTextArray "(#-.)" arrayty

1093− => Expression db params grp from (nullity 'PGjsonb)

1094− -> Expression db params grp from (nullity arrayty)

1095− -> Expression db params grp from (nullity 'PGjsonb)

1096−infixl 6 #-.

1097−(#-.) = unsafeBinaryOp "#-"

1098−

1099−{-----------------------------------------

1100−Table 9.45: JSON creation functions

1101−-----------------------------------------}

1102−

1103−-- | Literal binary JSON

1104−jsonbLit

1105− :: JSON.ToJSON x

1106− => x -> Expression (commons :=> schemas) params grp from (nullity 'PGjsonb)

1107−jsonbLit = cast jsonb . UnsafeExpression

1108− . singleQuotedUtf8 . toStrict . JSON.encode

1109−

1110−-- | Literal JSON

1111−jsonLit

1112− :: JSON.ToJSON x

1113− => x -> Expression (commons :=> schemas) params grp from (nullity 'PGjson)

1114−jsonLit = cast json . UnsafeExpression

1115− . singleQuotedUtf8 . toStrict . JSON.encode

1116−

1117−-- | Returns the value as json. Arrays and composites are converted

1118−-- (recursively) to arrays and objects; otherwise, if there is a cast from the

1119−-- type to json, the cast function will be used to perform the conversion;

1120−-- otherwise, a scalar value is produced. For any scalar type other than a

1121−-- number, a Boolean, or a null value, the text representation will be used, in

1122−-- such a fashion that it is a valid json value.

1123−toJson

1124− :: Expression db params grp from (nullity ty)

1125− -> Expression db params grp from (nullity 'PGjson)

1126−toJson = unsafeFunction "to_json"

1127−

1128−-- | Returns the value as jsonb. Arrays and composites are converted

1129−-- (recursively) to arrays and objects; otherwise, if there is a cast from the

1130−-- type to json, the cast function will be used to perform the conversion;

1131−-- otherwise, a scalar value is produced. For any scalar type other than a

1132−-- number, a Boolean, or a null value, the text representation will be used, in

1133−-- such a fashion that it is a valid jsonb value.

1134−toJsonb

1135− :: Expression db params grp from (nullity ty)

1136− -> Expression db params grp from (nullity 'PGjsonb)

1137−toJsonb = unsafeFunction "to_jsonb"

1138−

1139−-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

1140−-- becomes a JSON array of arrays.

1141−arrayToJson

1142− :: PGArray "arrayToJson" arr

1143− => Expression db params grp from (nullity arr)

1144− -> Expression db params grp from (nullity 'PGjson)

1145−arrayToJson = unsafeFunction "array_to_json"

1146−

1147−-- | Returns the row as a JSON object.

1148−rowToJson

1149− :: Expression db params grp from (nullity ('PGcomposite ty))

1150− -> Expression db params grp from (nullity 'PGjson)

1151−rowToJson = unsafeFunction "row_to_json"

1152−

1153−-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

1154−-- argument list.

1155−jsonBuildArray

1156− :: SListI elems

1157− => NP (Expression db params grp from) elems

1158− -> Expression db params grp from (nullity 'PGjson)

1159−jsonBuildArray = unsafeVariadicFunction "json_build_array"

1160−

1161−-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

1162−-- variadic argument list.

1163−jsonbBuildArray

1164− :: SListI elems

1165− => NP (Expression db params grp from) elems

1166− -> Expression db params grp from (nullity 'PGjsonb)

1167−jsonbBuildArray = unsafeVariadicFunction "jsonb_build_array"

1168−

1169−unsafeRowFunction

1170− :: All Top elems

1171− => NP (Aliased (Expression db params grp from)) elems

1172− -> [ByteString]

1173−unsafeRowFunction =

1174− (`appEndo` []) . hcfoldMap (Proxy :: Proxy Top)

1175− (\(col `As` name) -> Endo $ \xs ->

1176− renderAliasString name : renderExpression col : xs)

1177−

1178−-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

1179−-- argument list. The elements of the argument list must alternate between text

1180−-- and values.

1181−jsonBuildObject

1182− :: All Top elems

1183− => NP (Aliased (Expression db params grp from)) elems

1184− -> Expression db params grp from (nullity 'PGjson)

1185−jsonBuildObject

1186− = unsafeFunction "json_build_object"

1187− . UnsafeExpression

1188− . commaSeparated

1189− . unsafeRowFunction

1190−

1191−-- | Builds a possibly-heterogeneously-typed (binary) JSON object out of a

1192−-- variadic argument list. The elements of the argument list must alternate

1193−-- between text and values.

1194−jsonbBuildObject

1195− :: All Top elems

1196− => NP (Aliased (Expression db params grp from)) elems

1197− -> Expression db params grp from (nullity 'PGjsonb)

1198−jsonbBuildObject

1199− = unsafeFunction "jsonb_build_object"

1200− . UnsafeExpression

1201− . commaSeparated

1202− . unsafeRowFunction

1203−

1204−-- | Builds a JSON object out of a text array. The array must have either

1205−-- exactly one dimension with an even number of members, in which case they are

1206−-- taken as alternating key/value pairs, or two dimensions such that each inner

1207−-- array has exactly two elements, which are taken as a key/value pair.

1208−jsonObject

1209− :: PGArrayOf "jsonObject" arr ('NotNull 'PGtext)

1210− => Expression db params grp from (nullity arr)

1211− -> Expression db params grp from (nullity 'PGjson)

1212−jsonObject = unsafeFunction "json_object"

1213−

1214−-- | Builds a binary JSON object out of a text array. The array must have either

1215−-- exactly one dimension with an even number of members, in which case they are

1216−-- taken as alternating key/value pairs, or two dimensions such that each inner

1217−-- array has exactly two elements, which are taken as a key/value pair.

1218−jsonbObject

1219− :: PGArrayOf "jsonbObject" arr ('NotNull 'PGtext)

1220− => Expression db params grp from (nullity arr)

1221− -> Expression db params grp from (nullity 'PGjsonb)

1222−jsonbObject = unsafeFunction "jsonb_object"

1223−

1224−-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

1225−-- keys and one for values, that are zipped pairwise to create a JSON object.

1226−jsonZipObject

1227− :: ( PGArrayOf "jsonZipObject" keysArray ('NotNull 'PGtext)

1228− , PGArrayOf "jsonZipObject" valuesArray ('NotNull 'PGtext))

1229− => Expression db params grp from (nullity keysArray)

1230− -> Expression db params grp from (nullity valuesArray)

1231− -> Expression db params grp from (nullity 'PGjson)

1232−jsonZipObject ks vs =

1233− unsafeVariadicFunction "json_object" (ks :* vs :* Nil)

1234−

1235−-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

1236−-- keys and one for values, that are zipped pairwise to create a binary JSON

1237−-- object.

1238−jsonbZipObject

1239− :: ( PGArrayOf "jsonbZipObject" keysArray ('NotNull 'PGtext)

1240− , PGArrayOf "jsonbZipObject" valuesArray ('NotNull 'PGtext))

1241− => Expression db params grp from (nullity keysArray)

1242− -> Expression db params grp from (nullity valuesArray)

1243− -> Expression db params grp from (nullity 'PGjsonb)

1244−jsonbZipObject ks vs =

1245− unsafeVariadicFunction "jsonb_object" (ks :* vs :* Nil)

1246−

1247−{-----------------------------------------

1248−Table 9.46: JSON processing functions

1249−-----------------------------------------}

1250−

1251−-- | Returns the number of elements in the outermost JSON array.

1252−jsonArrayLength

1253− :: Expression db params grp from (nullity 'PGjson)

1254− -> Expression db params grp from (nullity 'PGint4)

1255−jsonArrayLength = unsafeFunction "json_array_length"

1256−

1257−-- | Returns the number of elements in the outermost binary JSON array.

1258−jsonbArrayLength

1259− :: Expression db params grp from (nullity 'PGjsonb)

1260− -> Expression db params grp from (nullity 'PGint4)

1261−jsonbArrayLength = unsafeFunction "jsonb_array_length"

1262−

1263−-- | Returns JSON value pointed to by the given path (equivalent to #>

1264−-- operator).

1265−jsonExtractPath

1266− :: SListI elems

1267− => Expression db params grp from (nullity 'PGjson)

1268− -> NP (Expression db params grp from) elems

1269− -> Expression db params grp from (nullity 'PGjsonb)

1270−jsonExtractPath x xs =

1271− unsafeVariadicFunction "json_extract_path" (x :* xs)

1272−

1273−-- | Returns JSON value pointed to by the given path (equivalent to #>

1274−-- operator).

1275−jsonbExtractPath

1276− :: SListI elems

1277− => Expression db params grp from (nullity 'PGjsonb)

1278− -> NP (Expression db params grp from) elems

1279− -> Expression db params grp from (nullity 'PGjsonb)

1280−jsonbExtractPath x xs =

1281− unsafeVariadicFunction "jsonb_extract_path" (x :* xs)

1282−

1283−-- | Returns JSON value pointed to by the given path (equivalent to #>

1284−-- operator), as text.

1285−jsonExtractPathAsText

1286− :: SListI elems

1287− => Expression db params grp from (nullity 'PGjson)

1288− -> NP (Expression db params grp from) elems

1289− -> Expression db params grp from (nullity 'PGjson)

1290−jsonExtractPathAsText x xs =

1291− unsafeVariadicFunction "json_extract_path_text" (x :* xs)

1292−

1293−-- | Returns JSON value pointed to by the given path (equivalent to #>

1294−-- operator), as text.

1295−jsonbExtractPathAsText

1296− :: SListI elems

1297− => Expression db params grp from (nullity 'PGjsonb)

1298− -> NP (Expression db params grp from) elems

1299− -> Expression db params grp from (nullity 'PGjsonb)

1300−jsonbExtractPathAsText x xs =

1301− unsafeVariadicFunction "jsonb_extract_path_text" (x :* xs)

1302−

1303−-- | Returns the type of the outermost JSON value as a text string. Possible

1304−-- types are object, array, string, number, boolean, and null.

1305−jsonTypeof

1306− :: Expression db params grp from (nullity 'PGjson)

1307− -> Expression db params grp from (nullity 'PGtext)

1308−jsonTypeof = unsafeFunction "json_typeof"

1309−

1310−-- | Returns the type of the outermost binary JSON value as a text string.

1311−-- Possible types are object, array, string, number, boolean, and null.

1312−jsonbTypeof

1313− :: Expression db params grp from (nullity 'PGjsonb)

1314− -> Expression db params grp from (nullity 'PGtext)

1315−jsonbTypeof = unsafeFunction "jsonb_typeof"

1316−

1317−-- | Returns its argument with all object fields that have null values omitted.

1318−-- Other null values are untouched.

1319−jsonStripNulls

1320− :: Expression db params grp from (nullity 'PGjson)

1321− -> Expression db params grp from (nullity 'PGjson)

1322−jsonStripNulls = unsafeFunction "json_strip_nulls"

1323−

1324−-- | Returns its argument with all object fields that have null values omitted.

1325−-- Other null values are untouched.

1326−jsonbStripNulls

1327− :: Expression db params grp from (nullity 'PGjsonb)

1328− -> Expression db params grp from (nullity 'PGjsonb)

1329−jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

1330−

1331−-- | @ jsonbSet target path new_value create_missing @

1332−--

1333−-- Returns target with the section designated by path replaced by new_value,

1334−-- or with new_value added if create_missing is true ( default is true) and the

1335−-- item designated by path does not exist. As with the path orientated

1336−-- operators, negative integers that appear in path count from the end of JSON

1337−-- arrays.

1338−jsonbSet

1339− :: PGTextArray "jsonbSet" arr

1340− => Expression db params grp from (nullity 'PGjsonb)

1341− -> Expression db params grp from (nullity arr)

1342− -> Expression db params grp from (nullity 'PGjsonb)

1343− -> Maybe (Expression db params grp from (nullity 'PGbool))

1344− -> Expression db params grp from (nullity 'PGjsonb)

1345−jsonbSet tgt path val createMissing = case createMissing of

1346− Just m -> unsafeVariadicFunction "jsonb_set" (tgt :* path :* val :* m :* Nil)

1347− Nothing -> unsafeVariadicFunction "jsonb_set" (tgt :* path :* val :* Nil)

1348−

1349−-- | @ jsonbInsert target path new_value insert_after @

1350−--

1351−-- Returns target with new_value inserted. If target section designated by

1352−-- path is in a JSONB array, new_value will be inserted before target or after

1353−-- if insert_after is true (default is false). If target section designated by

1354−-- path is in JSONB object, new_value will be inserted only if target does not

1355−-- exist. As with the path orientated operators, negative integers that appear

1356−-- in path count from the end of JSON arrays.

1357−jsonbInsert

1358− :: PGTextArray "jsonbInsert" arr

1359− => Expression db params grp from (nullity 'PGjsonb)

1360− -> Expression db params grp from (nullity arr)

1361− -> Expression db params grp from (nullity 'PGjsonb)

1362− -> Maybe (Expression db params grp from (nullity 'PGbool))

1363− -> Expression db params grp from (nullity 'PGjsonb)

1364−jsonbInsert tgt path val insertAfter = case insertAfter of

1365− Just i -> unsafeVariadicFunction "jsonb_insert" (tgt :* path :* val :* i :* Nil)

1366− Nothing -> unsafeVariadicFunction "jsonb_insert" (tgt :* path :* val :* Nil)

1367−

1368−-- | Returns its argument as indented JSON text.

1369−jsonbPretty

1370− :: Expression db params grp from (nullity 'PGjsonb)

1371− -> Expression db params grp from (nullity 'PGtext)

1372−jsonbPretty = unsafeFunction "jsonb_pretty"

1373−

1374−{-----------------------------------------

1375−aggregation

1376−-----------------------------------------}

1377−

1378−-- | escape hatch to define aggregate functions

1379−unsafeAggregate

1380− :: ByteString -- ^ aggregate function

1381− -> Expression db from 'Ungrouped params (xty)

1382− -> Expression db from ('Grouped bys) params (yty)

1383−unsafeAggregate fun x = UnsafeExpression $ mconcat

1384− [fun, "(", renderExpression x, ")"]

1385−

1386−-- | escape hatch to define aggregate functions over distinct values

1387−unsafeAggregateDistinct

1388− :: ByteString -- ^ aggregate function

1389− -> Expression db from 'Ungrouped params (xty)

1390− -> Expression db from ('Grouped bys) params (yty)

1391−unsafeAggregateDistinct fun x = UnsafeExpression $ mconcat

1392− [fun, "(DISTINCT ", renderExpression x, ")"]

1393−

1394−-- | >>> :{

1395−-- let

1396−-- expression :: Expression db '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('Grouped bys) params ('Null 'PGnumeric)

1397−-- expression = sum_ #col

1398−-- in printSQL expression

1399−-- :}

1400−-- sum("col")

1401−sum_

1402− :: ty `In` PGNum

1403− => Expression db from 'Ungrouped params (nullity ty)

1404− -- ^ what to sum

1405− -> Expression db from ('Grouped bys) params (nullity ty)

1406−sum_ = unsafeAggregate "sum"

1407−

1408−-- | >>> :{

1409−-- let

1410−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGnumeric]] ('Grouped bys) params (nullity 'PGnumeric)

1411−-- expression = sumDistinct #col

1412−-- in printSQL expression

1413−-- :}

1414−-- sum(DISTINCT "col")

1415−sumDistinct

1416− :: ty `In` PGNum

1417− => Expression db from 'Ungrouped params (nullity ty)

1418− -- ^ what to sum

1419− -> Expression db from ('Grouped bys) params (nullity ty)

1420−sumDistinct = unsafeAggregateDistinct "sum"

1421−

1422−-- | A constraint for `PGType`s that you can take averages of and the resulting

1423−-- `PGType`.

1424−class PGAvg ty avg | ty -> avg where

1425− avg, avgDistinct

1426− :: Expression db from 'Ungrouped params (nullity ty)

1427− -- ^ what to average

1428− -> Expression db from ('Grouped bys) params (nullity avg)

1429− avg = unsafeAggregate "avg"

1430− avgDistinct = unsafeAggregateDistinct "avg"

1431−instance PGAvg 'PGint2 'PGnumeric

1432−instance PGAvg 'PGint4 'PGnumeric

1433−instance PGAvg 'PGint8 'PGnumeric

1434−instance PGAvg 'PGnumeric 'PGnumeric

1435−instance PGAvg 'PGfloat4 'PGfloat8

1436−instance PGAvg 'PGfloat8 'PGfloat8

1437−instance PGAvg 'PGinterval 'PGinterval

1438−

1439−-- | >>> :{

1440−-- let

1441−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGint4]] (Grouped bys) params (nullity 'PGint4)

1442−-- expression = bitAnd #col

1443−-- in printSQL expression

1444−-- :}

1445−-- bit_and("col")

1446−bitAnd

1447− :: int `In` PGIntegral

1448− => Expression db from 'Ungrouped params (nullity int)

1449− -- ^ what to aggregate

1450− -> Expression db from ('Grouped bys) params (nullity int)

1451−bitAnd = unsafeAggregate "bit_and"

1452−

1453−-- | >>> :{

1454−-- let

1455−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGint4]] (Grouped bys) params (nullity 'PGint4)

1456−-- expression = bitOr #col

1457−-- in printSQL expression

1458−-- :}

1459−-- bit_or("col")

1460−bitOr

1461− :: int `In` PGIntegral

1462− => Expression db from 'Ungrouped params (nullity int)

1463− -- ^ what to aggregate

1464− -> Expression db from ('Grouped bys) params (nullity int)

1465−bitOr = unsafeAggregate "bit_or"

1466−

1467−-- | >>> :{

1468−-- let

1469−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGint4]] (Grouped bys) params (nullity 'PGint4)

1470−-- expression = bitAndDistinct #col

1471−-- in printSQL expression

1472−-- :}

1473−-- bit_and(DISTINCT "col")

1474−bitAndDistinct

1475− :: int `In` PGIntegral

1476− => Expression db from 'Ungrouped params (nullity int)

1477− -- ^ what to aggregate

1478− -> Expression db from ('Grouped bys) params (nullity int)

1479−bitAndDistinct = unsafeAggregateDistinct "bit_and"

1480−

1481−-- | >>> :{

1482−-- let

1483−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGint4]] (Grouped bys) params (nullity 'PGint4)

1484−-- expression = bitOrDistinct #col

1485−-- in printSQL expression

1486−-- :}

1487−-- bit_or(DISTINCT "col")

1488−bitOrDistinct

1489− :: int `In` PGIntegral

1490− => Expression db from 'Ungrouped params (nullity int)

1491− -- ^ what to aggregate

1492− -> Expression db from ('Grouped bys) params (nullity int)

1493−bitOrDistinct = unsafeAggregateDistinct "bit_or"

1494−

1495−-- | >>> :{

1496−-- let

1497−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGbool]] (Grouped bys) params (nullity 'PGbool)

1498−-- expression = boolAnd #col

1499−-- in printSQL expression

1500−-- :}

1501−-- bool_and("col")

1502−boolAnd

1503− :: Expression db from 'Ungrouped params (nullity 'PGbool)

1504− -- ^ what to aggregate

1505− -> Expression db from ('Grouped bys) params (nullity 'PGbool)

1506−boolAnd = unsafeAggregate "bool_and"

1507−

1508−-- | >>> :{

1509−-- let

1510−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGbool]] (Grouped bys) params (nullity 'PGbool)

1511−-- expression = boolOr #col

1512−-- in printSQL expression

1513−-- :}

1514−-- bool_or("col")

1515−boolOr

1516− :: Expression db from 'Ungrouped params (nullity 'PGbool)

1517− -- ^ what to aggregate

1518− -> Expression db from ('Grouped bys) params (nullity 'PGbool)

1519−boolOr = unsafeAggregate "bool_or"

1520−

1521−-- | >>> :{

1522−-- let

1523−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGbool]] (Grouped bys) params (nullity 'PGbool)

1524−-- expression = boolAndDistinct #col

1525−-- in printSQL expression

1526−-- :}

1527−-- bool_and(DISTINCT "col")

1528−boolAndDistinct

1529− :: Expression db from 'Ungrouped params (nullity 'PGbool)

1530− -- ^ what to aggregate

1531− -> Expression db from ('Grouped bys) params (nullity 'PGbool)

1532−boolAndDistinct = unsafeAggregateDistinct "bool_and"

1533−

1534−-- | >>> :{

1535−-- let

1536−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGbool]] (Grouped bys) params (nullity 'PGbool)

1537−-- expression = boolOrDistinct #col

1538−-- in printSQL expression

1539−-- :}

1540−-- bool_or(DISTINCT "col")

1541−boolOrDistinct

1542− :: Expression db from 'Ungrouped params (nullity 'PGbool)

1543− -- ^ what to aggregate

1544− -> Expression db from ('Grouped bys) params (nullity 'PGbool)

1545−boolOrDistinct = unsafeAggregateDistinct "bool_or"

1546−

1547−-- | A special aggregation that does not require an input

1548−--

1549−-- >>> printSQL countStar

1550−-- count(*)

1551−countStar

1552− :: Expression db from ('Grouped bys) params ('NotNull 'PGint8)

1553−countStar = UnsafeExpression $ "count(*)"

1554−

1555−-- | >>> :{

1556−-- let

1557−-- expression :: Expression db '[tab ::: '["col" ::: nullity ty]] (Grouped bys) params ('NotNull 'PGint8)

1558−-- expression = count #col

1559−-- in printSQL expression

1560−-- :}

1561−-- count("col")

1562−count

1563− :: Expression db from 'Ungrouped params ty

1564− -- ^ what to count

1565− -> Expression db from ('Grouped bys) params ('NotNull 'PGint8)

1566−count = unsafeAggregate "count"

1567−

1568−-- | >>> :{

1569−-- let

1570−-- expression :: Expression db '[tab ::: '["col" ::: nullity ty]] (Grouped bys) params ('NotNull 'PGint8)

1571−-- expression = countDistinct #col

1572−-- in printSQL expression

1573−-- :}

1574−-- count(DISTINCT "col")

1575−countDistinct

1576− :: Expression db from 'Ungrouped params ty

1577− -- ^ what to count

1578− -> Expression db from ('Grouped bys) params ('NotNull 'PGint8)

1579−countDistinct = unsafeAggregateDistinct "count"

1580−

1581−-- | synonym for `boolAnd`

1582−--

1583−-- >>> :{

1584−-- let

1585−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGbool]] (Grouped bys) params (nullity 'PGbool)

1586−-- expression = every #col

1587−-- in printSQL expression

1588−-- :}

1589−-- every("col")

1590−every

1591− :: Expression db from 'Ungrouped params (nullity 'PGbool)

1592− -- ^ what to aggregate

1593− -> Expression db from ('Grouped bys) params (nullity 'PGbool)

1594−every = unsafeAggregate "every"

1595−

1596−-- | synonym for `boolAndDistinct`

1597−--

1598−-- >>> :{

1599−-- let

1600−-- expression :: Expression db '[tab ::: '["col" ::: nullity 'PGbool]] (Grouped bys) params (nullity 'PGbool)

1601−-- expression = everyDistinct #col

1602−-- in printSQL expression

1603−-- :}

1604−-- every(DISTINCT "col")

1605−everyDistinct

1606− :: Expression db from 'Ungrouped params (nullity 'PGbool)

1607− -- ^ what to aggregate

1608− -> Expression db from ('Grouped bys) params (nullity 'PGbool)

1609−everyDistinct = unsafeAggregateDistinct "every"

1610−

1611−-- | minimum and maximum aggregation

1612−max_, min_, maxDistinct, minDistinct

1613− :: Expression db from 'Ungrouped params (nullity ty)

1614− -- ^ what to aggregate

1615− -> Expression db from ('Grouped bys) params (nullity ty)

1616−max_ = unsafeAggregate "max"

1617−min_ = unsafeAggregate "min"

1618−maxDistinct = unsafeAggregateDistinct "max"

1619−minDistinct = unsafeAggregateDistinct "min"

1620−

1621−{-----------------------------------------

1622−type expressions

1623−-----------------------------------------}

1624−

1625−-- | `TypeExpression`s are used in `cast`s and `createTable` commands.

1626−newtype TypeExpression (schemas :: SchemasType) (ty :: NullityType)

1627− = UnsafeTypeExpression { renderTypeExpression :: ByteString }

1628− deriving (GHC.Generic,Show,Eq,Ord,NFData)

1629−

1630−-- | The enum or composite type in a `Typedef` can be expressed by its alias.

1631−typedef

1632− :: (Has sch schemas schema, Has td schema ('Typedef ty))

1633− => QualifiedAlias sch td

1634− -> TypeExpression schemas (nullity ty)

1635−typedef = UnsafeTypeExpression . renderQualifiedAlias

1636−

1637−-- | The composite type corresponding to a `Table` definition can be expressed

1638−-- by its alias.

1639−typetable

1640− :: (Has sch schemas schema, Has tab schema ('Table table))

1641− => QualifiedAlias sch tab

1642− -> TypeExpression schemas (nullity ('PGcomposite (TableToRow table)))

1643−typetable = UnsafeTypeExpression . renderQualifiedAlias

1644−

1645−-- | The composite type corresponding to a `View` definition can be expressed

1646−-- by its alias.

1647−typeview

1648− :: (Has sch schemas schema, Has vw schema ('View view))

1649− => QualifiedAlias sch vw

1650− -> TypeExpression schemas (nullity ('PGcomposite view))

1651−typeview = UnsafeTypeExpression . renderQualifiedAlias

1652−

1653−-- | logical Boolean (true/false)

1654−bool :: TypeExpression schemas (nullity 'PGbool)

1655−bool = UnsafeTypeExpression "bool"

1656−-- | signed two-byte integer

1657−int2, smallint :: TypeExpression schemas (nullity 'PGint2)

1658−int2 = UnsafeTypeExpression "int2"

1659−smallint = UnsafeTypeExpression "smallint"

1660−-- | signed four-byte integer

1661−int4, int, integer :: TypeExpression schemas (nullity 'PGint4)

1662−int4 = UnsafeTypeExpression "int4"

1663−int = UnsafeTypeExpression "int"

1664−integer = UnsafeTypeExpression "integer"

1665−-- | signed eight-byte integer

1666−int8, bigint :: TypeExpression schemas (nullity 'PGint8)

1667−int8 = UnsafeTypeExpression "int8"

1668−bigint = UnsafeTypeExpression "bigint"

1669−-- | arbitrary precision numeric type

1670−numeric :: TypeExpression schemas (nullity 'PGnumeric)

1671−numeric = UnsafeTypeExpression "numeric"

1672−-- | single precision floating-point number (4 bytes)

1673−float4, real :: TypeExpression schemas (nullity 'PGfloat4)

1674−float4 = UnsafeTypeExpression "float4"

1675−real = UnsafeTypeExpression "real"

1676−-- | double precision floating-point number (8 bytes)

1677−float8, doublePrecision :: TypeExpression schemas (nullity 'PGfloat8)

1678−float8 = UnsafeTypeExpression "float8"

1679−doublePrecision = UnsafeTypeExpression "double precision"

1680−-- | variable-length character string

1681−text :: TypeExpression schemas (nullity 'PGtext)

1682−text = UnsafeTypeExpression "text"

1683−-- | fixed-length character string

1684−char, character

1685− :: forall n schemas nullity. (KnownNat n, 1 <= n)

1686− => TypeExpression schemas (nullity ('PGchar n))

1687−char = UnsafeTypeExpression $ "char(" <> renderNat @n <> ")"

1688−character = UnsafeTypeExpression $ "character(" <> renderNat @n <> ")"

1689−-- | variable-length character string

1690−varchar, characterVarying

1691− :: forall n schemas nullity. (KnownNat n, 1 <= n)

1692− => TypeExpression schemas (nullity ('PGvarchar n))

1693−varchar = UnsafeTypeExpression $ "varchar(" <> renderNat @n <> ")"

1694−characterVarying = UnsafeTypeExpression $

1695− "character varying(" <> renderNat @n <> ")"

1696−-- | binary data ("byte array")

1697−bytea :: TypeExpression schemas (nullity 'PGbytea)

1698−bytea = UnsafeTypeExpression "bytea"

1699−-- | date and time (no time zone)

1700−timestamp :: TypeExpression schemas (nullity 'PGtimestamp)

1701−timestamp = UnsafeTypeExpression "timestamp"

1702−-- | date and time, including time zone

1703−timestampWithTimeZone :: TypeExpression schemas (nullity 'PGtimestamptz)

1704−timestampWithTimeZone = UnsafeTypeExpression "timestamp with time zone"

1705−-- | calendar date (year, month, day)

1706−date :: TypeExpression schemas (nullity 'PGdate)

1707−date = UnsafeTypeExpression "date"

1708−-- | time of day (no time zone)

1709−time :: TypeExpression schemas (nullity 'PGtime)

1710−time = UnsafeTypeExpression "time"

1711−-- | time of day, including time zone

1712−timeWithTimeZone :: TypeExpression schemas (nullity 'PGtimetz)

1713−timeWithTimeZone = UnsafeTypeExpression "time with time zone"

1714−-- | time span

1715−interval :: TypeExpression schemas (nullity 'PGinterval)

1716−interval = UnsafeTypeExpression "interval"

1717−-- | universally unique identifier

1718−uuid :: TypeExpression schemas (nullity 'PGuuid)

1719−uuid = UnsafeTypeExpression "uuid"

1720−-- | IPv4 or IPv6 host address

1721−inet :: TypeExpression schemas (nullity 'PGinet)

1722−inet = UnsafeTypeExpression "inet"

1723−-- | textual JSON data

1724−json :: TypeExpression schemas (nullity 'PGjson)

1725−json = UnsafeTypeExpression "json"

1726−-- | binary JSON data, decomposed

1727−jsonb :: TypeExpression schemas (nullity 'PGjsonb)

1728−jsonb = UnsafeTypeExpression "jsonb"

1729−-- | variable length array

1730−vararray

1731− :: TypeExpression schemas pg

1732− -> TypeExpression schemas (nullity ('PGvararray pg))

1733−vararray ty = UnsafeTypeExpression $ renderTypeExpression ty <> "[]"

1734−-- | fixed length array

1735−--

1736−-- >>> renderTypeExpression (fixarray @2 json)

1737−-- "json[2]"

1738−fixarray

1739− :: forall n schemas nullity pg. KnownNat n

1740− => TypeExpression schemas pg

1741− -> TypeExpression schemas (nullity ('PGfixarray n pg))

1742−fixarray ty = UnsafeTypeExpression $

1743− renderTypeExpression ty <> "[" <> renderNat @n <> "]"

1744−

1745−-- | `pgtype` is a demoted version of a `PGType`

1746−class PGTyped schemas (ty :: NullityType) where

1747− pgtype :: TypeExpression schemas ty

1748−instance PGTyped schemas (nullity 'PGbool) where pgtype = bool

1749−instance PGTyped schemas (nullity 'PGint2) where pgtype = int2

1750−instance PGTyped schemas (nullity 'PGint4) where pgtype = int4

1751−instance PGTyped schemas (nullity 'PGint8) where pgtype = int8

1752−instance PGTyped schemas (nullity 'PGnumeric) where pgtype = numeric

1753−instance PGTyped schemas (nullity 'PGfloat4) where pgtype = float4

1754−instance PGTyped schemas (nullity 'PGfloat8) where pgtype = float8

1755−instance PGTyped schemas (nullity 'PGtext) where pgtype = text

1756−instance (KnownNat n, 1 <= n)

1757− => PGTyped schemas (nullity ('PGchar n)) where pgtype = char @n

1758−instance (KnownNat n, 1 <= n)

1759− => PGTyped schemas (nullity ('PGvarchar n)) where pgtype = varchar @n

1760−instance PGTyped schemas (nullity 'PGbytea) where pgtype = bytea

1761−instance PGTyped schemas (nullity 'PGtimestamp) where pgtype = timestamp

1762−instance PGTyped schemas (nullity 'PGtimestamptz) where pgtype = timestampWithTimeZone

1763−instance PGTyped schemas (nullity 'PGdate) where pgtype = date

1764−instance PGTyped schemas (nullity 'PGtime) where pgtype = time

1765−instance PGTyped schemas (nullity 'PGtimetz) where pgtype = timeWithTimeZone

1766−instance PGTyped schemas (nullity 'PGinterval) where pgtype = interval

1767−instance PGTyped schemas (nullity 'PGuuid) where pgtype = uuid

1768−instance PGTyped schemas (nullity 'PGjson) where pgtype = json

1769−instance PGTyped schemas (nullity 'PGjsonb) where pgtype = jsonb

1770−instance PGTyped schemas ty

1771− => PGTyped schemas (nullity ('PGvararray ty)) where

1772− pgtype = vararray (pgtype @schemas @ty)

1773−instance (KnownNat n, PGTyped schemas ty)

1774− => PGTyped schemas (nullity ('PGfixarray n ty)) where

1775− pgtype = fixarray @n (pgtype @schemas @ty)

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Aggregate.hsnew file+462

@@ -0,0 +1,462 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Aggregate

3+Description: Aggregate functions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Aggregate functions

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , DeriveGeneric

14+ , FlexibleContexts

15+ , FlexibleInstances

16+ , FunctionalDependencies

17+ , LambdaCase

18+ , MultiParamTypeClasses

19+ , OverloadedStrings

20+ , PolyKinds

21+ , TypeFamilies

22+ , TypeOperators

23+ , UndecidableInstances

24+#-}

25+

26+module Squeal.PostgreSQL.Expression.Aggregate

27+ ( Aggregate (..)

28+ , Distinction (..)

29+ , PGSum

30+ , PGAvg

31+ ) where

32+

33+import Control.DeepSeq

34+import Data.ByteString (ByteString)

35+import Data.Kind

36+import GHC.TypeLits

37+

38+import qualified GHC.Generics as GHC

39+import qualified Generics.SOP as SOP

40+

41+import Squeal.PostgreSQL.Alias

42+import Squeal.PostgreSQL.Expression

43+import Squeal.PostgreSQL.List

44+import Squeal.PostgreSQL.Render

45+import Squeal.PostgreSQL.Schema

46+

47+-- $setup

48+-- >>> import Squeal.PostgreSQL

49+

50+{- |

51+`Aggregate` functions compute a single result from a set of input values.

52+`Aggregate` functions can be used as `GroupedBy` `Expression`s as well

53+as `Squeal.PostgreSQL.Expression.Window.WindowFunction`s.

54+-}

55+class Aggregate expr1 exprN aggr

56+ | aggr -> expr1, aggr -> exprN where

57+

58+ -- | A special aggregation that does not require an input

59+ --

60+ -- >>> :{

61+ -- let

62+ -- expression :: Expression '[] commons ('Grouped bys) schemas params from ('NotNull 'PGint8)

63+ -- expression = countStar

64+ -- in printSQL expression

65+ -- :}

66+ -- count(*)

67+ countStar :: aggr ('NotNull 'PGint8)

68+

69+ -- | >>> :{

70+ -- let

71+ -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null ty]] ('NotNull 'PGint8)

72+ -- expression = count (All #col)

73+ -- in printSQL expression

74+ -- :}

75+ -- count(ALL "col")

76+ count

77+ :: expr1 ty

78+ -- ^ what to count

79+ -> aggr ('NotNull 'PGint8)

80+

81+ -- | >>> :{

82+ -- let

83+ -- expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: 'Null 'PGnumeric]] ('Null 'PGnumeric)

84+ -- expression = sum_ (Distinct #col)

85+ -- in printSQL expression

86+ -- :}

87+ -- sum(DISTINCT "col")

88+ sum_

89+ :: expr1 (null ty)

90+ -> aggr ('Null (PGSum ty))

91+

92+ -- | input values, including nulls, concatenated into an array

93+ arrayAgg

94+ :: expr1 ty

95+ -> aggr ('Null ('PGvararray ty))

96+

97+ -- | aggregates values as a JSON array

98+ jsonAgg

99+ :: expr1 ty

100+ -> aggr ('Null 'PGjson)

101+

102+ -- | aggregates values as a JSON array

103+ jsonbAgg

104+ :: expr1 ty

105+ -> aggr ('Null 'PGjsonb)

106+

107+ {- |

108+ the bitwise AND of all non-null input values, or null if none

109+

110+ >>> :{

111+ let

112+ expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

113+ expression = bitAnd (Distinct #col)

114+ in printSQL expression

115+ :}

116+ bit_and(DISTINCT "col")

117+ -}

118+ bitAnd

119+ :: int `In` PGIntegral

120+ => expr1 (null int)

121+ -- ^ what to aggregate

122+ -> aggr ('Null int)

123+

124+ {- |

125+ the bitwise OR of all non-null input values, or null if none

126+

127+ >>> :{

128+ let

129+ expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGint4]] ('Null 'PGint4)

130+ expression = bitOr (All #col)

131+ in printSQL expression

132+ :}

133+ bit_or(ALL "col")

134+ -}

135+ bitOr

136+ :: int `In` PGIntegral

137+ => expr1 (null int)

138+ -- ^ what to aggregate

139+ -> aggr ('Null int)

140+

141+ {- |

142+ true if all input values are true, otherwise false

143+

144+ >>> :{

145+ let

146+ winFun :: WindowFunction '[] commons 'Ungrouped schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

147+ winFun = boolAnd #col

148+ in printSQL winFun

149+ :}

150+ bool_and("col")

151+ -}

152+ boolAnd

153+ :: expr1 (null 'PGbool)

154+ -- ^ what to aggregate

155+ -> aggr ('Null 'PGbool)

156+

157+ {- |

158+ true if at least one input value is true, otherwise false

159+

160+ >>> :{

161+ let

162+ expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

163+ expression = boolOr (All #col)

164+ in printSQL expression

165+ :}

166+ bool_or(ALL "col")

167+ -}

168+ boolOr

169+ :: expr1 (null 'PGbool)

170+ -- ^ what to aggregate

171+ -> aggr ('Null 'PGbool)

172+

173+ {- |

174+ equivalent to `boolAnd`

175+

176+ >>> :{

177+ let

178+ expression :: Expression '[] commons ('Grouped bys) schemas params '[tab ::: '["col" ::: null 'PGbool]] ('Null 'PGbool)

179+ expression = every (Distinct #col)

180+ in printSQL expression

181+ :}

182+ every(DISTINCT "col")

183+ -}

184+ every

185+ :: expr1 (null 'PGbool)

186+ -- ^ what to aggregate

187+ -> aggr ('Null 'PGbool)

188+

189+ {- |maximum value of expression across all input values-}

190+ max_

191+ :: expr1 (null ty)

192+ -- ^ what to maximize

193+ -> aggr ('Null ty)

194+

195+ -- | minimum value of expression across all input values

196+ min_

197+ :: expr1 (null ty)

198+ -- ^ what to minimize

199+ -> aggr ('Null ty)

200+

201+ -- | the average (arithmetic mean) of all input values

202+ avg

203+ :: expr1 (null ty)

204+ -- ^ what to average

205+ -> aggr ('Null (PGAvg ty))

206+

207+ {- | correlation coefficient

208+

209+ >>> :{

210+ let

211+ expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

212+ expression = corr (All (#y *: #x))

213+ in printSQL expression

214+ :}

215+ corr(ALL "y", "x")

216+ -}

217+ corr

218+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

219+ -> aggr ('Null 'PGfloat8)

220+

221+ {- | population covariance

222+

223+ >>> :{

224+ let

225+ expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

226+ expression = covarPop (All (#y *: #x))

227+ in printSQL expression

228+ :}

229+ covar_pop(ALL "y", "x")

230+ -}

231+ covarPop

232+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

233+ -> aggr ('Null 'PGfloat8)

234+

235+ {- | sample covariance

236+

237+ >>> :{

238+ let

239+ winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

240+ winFun = covarSamp (#y *: #x)

241+ in printSQL winFun

242+ :}

243+ covar_samp("y", "x")

244+ -}

245+ covarSamp

246+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

247+ -> aggr ('Null 'PGfloat8)

248+

249+ {- | average of the independent variable (sum(X)/N)

250+

251+ >>> :{

252+ let

253+ expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

254+ expression = regrAvgX (All (#y *: #x))

255+ in printSQL expression

256+ :}

257+ regr_avgx(ALL "y", "x")

258+ -}

259+ regrAvgX

260+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

261+ -> aggr ('Null 'PGfloat8)

262+

263+ {- | average of the dependent variable (sum(Y)/N)

264+

265+ >>> :{

266+ let

267+ winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

268+ winFun = regrAvgY (#y *: #x)

269+ in printSQL winFun

270+ :}

271+ regr_avgy("y", "x")

272+ -}

273+ regrAvgY

274+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

275+ -> aggr ('Null 'PGfloat8)

276+

277+ {- | number of input rows in which both expressions are nonnull

278+

279+ >>> :{

280+ let

281+ winFun :: WindowFunction '[] c 'Ungrouped s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGint8)

282+ winFun = regrCount (#y *: #x)

283+ in printSQL winFun

284+ :}

285+ regr_count("y", "x")

286+ -}

287+ regrCount

288+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

289+ -> aggr ('Null 'PGint8)

290+

291+ {- | y-intercept of the least-squares-fit linear equation determined by the (X, Y) pairs

292+ >>> :{

293+ let

294+ expression :: Expression '[] c ('Grouped g) s p '[t ::: '["x" ::: 'NotNull 'PGfloat8, "y" ::: 'NotNull 'PGfloat8]] ('Null 'PGfloat8)

295+ expression = regrIntercept (All (#y *: #x))

296+ in printSQL expression

297+ :}

298+ regr_intercept(ALL "y", "x")

299+ -}

300+ regrIntercept

301+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

302+ -> aggr ('Null 'PGfloat8)

303+

304+ -- | @regr_r2(Y, X)@, square of the correlation coefficient

305+ regrR2

306+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

307+ -> aggr ('Null 'PGfloat8)

308+

309+ -- | @regr_slope(Y, X)@, slope of the least-squares-fit linear equation

310+ -- determined by the (X, Y) pairs

311+ regrSlope

312+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

313+ -> aggr ('Null 'PGfloat8)

314+

315+ -- | @regr_sxx(Y, X)@, sum(X^2) - sum(X)^2/N

316+ -- (“sum of squares” of the independent variable)

317+ regrSxx

318+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

319+ -> aggr ('Null 'PGfloat8)

320+

321+ -- | @regr_sxy(Y, X)@, sum(X*Y) - sum(X) * sum(Y)/N

322+ -- (“sum of products” of independent times dependent variable)

323+ regrSxy

324+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

325+ -> aggr ('Null 'PGfloat8)

326+

327+ -- | @regr_syy(Y, X)@, sum(Y^2) - sum(Y)^2/N

328+ -- (“sum of squares” of the dependent variable)

329+ regrSyy

330+ :: exprN '[null 'PGfloat8, null 'PGfloat8]

331+ -> aggr ('Null 'PGfloat8)

332+

333+ -- | historical alias for `stddevSamp`

334+ stddev

335+ :: expr1 (null ty)

336+ -> aggr ('Null (PGAvg ty))

337+

338+ -- | population standard deviation of the input values

339+ stddevPop

340+ :: expr1 (null ty)

341+ -> aggr ('Null (PGAvg ty))

342+

343+ -- | sample standard deviation of the input values

344+ stddevSamp

345+ :: expr1 (null ty)

346+ -> aggr ('Null (PGAvg ty))

347+

348+ -- | historical alias for `varSamp`

349+ variance

350+ :: expr1 (null ty)

351+ -> aggr ('Null (PGAvg ty))

352+

353+ -- | population variance of the input values

354+ -- (square of the population standard deviation)

355+ varPop

356+ :: expr1 (null ty)

357+ -> aggr ('Null (PGAvg ty))

358+

359+ -- | sample variance of the input values

360+ -- (square of the sample standard deviation)

361+ varSamp

362+ :: expr1 (null ty)

363+ -> aggr ('Null (PGAvg ty))

364+

365+{- |

366+`Distinction`s are used for the input of `Aggregate` `Expression`s.

367+`All` invokes the aggregate once for each input row.

368+`Distinct` invokes the aggregate once for each distinct value of the expression

369+(or distinct set of values, for multiple expressions) found in the input

370+-}

371+data Distinction (expr :: kind -> Type) (ty :: kind)

372+ = All (expr ty)

373+ | Distinct (expr ty)

374+ deriving (GHC.Generic,Show,Eq,Ord)

375+instance NFData (Distinction (Expression outer commons grp schemas params from) ty)

376+instance RenderSQL (Distinction (Expression outer commons grp schemas params from) ty) where

377+ renderSQL = \case

378+ All x -> "ALL" <+> renderSQL x

379+ Distinct x -> "DISTINCT" <+> renderSQL x

380+instance SOP.SListI tys => RenderSQL

381+ (Distinction (NP (Expression outer commons grp schemas params from)) tys) where

382+ renderSQL = \case

383+ All xs -> "ALL" <+> renderCommaSeparated renderSQL xs

384+ Distinct xs -> "DISTINCT" <+> renderCommaSeparated renderSQL xs

385+

386+instance Aggregate

387+ (Distinction (Expression outer commons 'Ungrouped schemas params from))

388+ (Distinction (NP (Expression outer commons 'Ungrouped schemas params from)))

389+ (Expression outer commons ('Grouped bys) schemas params from) where

390+ countStar = UnsafeExpression "count(*)"

391+ count = unsafeAggregate1 "count"

392+ sum_ = unsafeAggregate1 "sum"

393+ arrayAgg = unsafeAggregate1 "array_agg"

394+ jsonAgg = unsafeAggregate1 "json_agg"

395+ jsonbAgg = unsafeAggregate1 "jsonb_agg"

396+ bitAnd = unsafeAggregate1 "bit_and"

397+ bitOr = unsafeAggregate1 "bit_or"

398+ boolAnd = unsafeAggregate1 "bool_and"

399+ boolOr = unsafeAggregate1 "bool_or"

400+ every = unsafeAggregate1 "every"

401+ max_ = unsafeAggregate1 "max"

402+ min_ = unsafeAggregate1 "min"

403+ avg = unsafeAggregate1 "avg"

404+ corr = unsafeAggregateN "corr"

405+ covarPop = unsafeAggregateN "covar_pop"

406+ covarSamp = unsafeAggregateN "covar_samp"

407+ regrAvgX = unsafeAggregateN "regr_avgx"

408+ regrAvgY = unsafeAggregateN "regr_avgy"

409+ regrCount = unsafeAggregateN "regr_count"

410+ regrIntercept = unsafeAggregateN "regr_intercept"

411+ regrR2 = unsafeAggregateN "regr_r2"

412+ regrSlope = unsafeAggregateN "regr_slope"

413+ regrSxx = unsafeAggregateN "regr_sxx"

414+ regrSxy = unsafeAggregateN "regr_sxy"

415+ regrSyy = unsafeAggregateN "regr_syy"

416+ stddev = unsafeAggregate1 "stddev"

417+ stddevPop = unsafeAggregate1 "stddev_pop"

418+ stddevSamp = unsafeAggregate1 "stddev_samp"

419+ variance = unsafeAggregate1 "variance"

420+ varPop = unsafeAggregate1 "var_pop"

421+ varSamp = unsafeAggregate1 "var_samp"

422+

423+-- | escape hatch to define aggregate functions

424+unsafeAggregate1

425+ :: ByteString -- ^ aggregate function

426+ -> Distinction (Expression outer commons 'Ungrouped schemas params from) x

427+ -> Expression outer commons ('Grouped bys) schemas params from y

428+unsafeAggregate1 fun x = UnsafeExpression $ fun <> parenthesized (renderSQL x)

429+

430+unsafeAggregateN

431+ :: SOP.SListI xs

432+ => ByteString -- ^ function

433+ -> Distinction (NP (Expression outer commons 'Ungrouped schemas params from)) xs

434+ -> Expression outer commons ('Grouped bys) schemas params from y

435+unsafeAggregateN fun xs = UnsafeExpression $ fun <> parenthesized (renderSQL xs)

436+

437+-- | A type family that calculates `PGSum``PGType` of

438+-- a given argument `PGType`.

439+type family PGSum ty where

440+ PGSum 'PGint2 = 'PGint8

441+ PGSum 'PGint4 = 'PGint8

442+ PGSum 'PGint8 = 'PGnumeric

443+ PGSum 'PGfloat4 = 'PGfloat4

444+ PGSum 'PGfloat8 = 'PGfloat8

445+ PGSum 'PGnumeric = 'PGnumeric

446+ PGSum 'PGinterval = 'PGinterval

447+ PGSum 'PGmoney = 'PGmoney

448+ PGSum pg = TypeError

449+ ( 'Text "Squeal type error: Cannot sum with argument type "

450+ ':<>: 'ShowType pg )

451+

452+-- | A type family that calculates `PGAvg` type of a `PGType`.

453+type family PGAvg ty where

454+ PGAvg 'PGint2 = 'PGnumeric

455+ PGAvg 'PGint4 = 'PGnumeric

456+ PGAvg 'PGint8 = 'PGnumeric

457+ PGAvg 'PGnumeric = 'PGnumeric

458+ PGAvg 'PGfloat4 = 'PGfloat8

459+ PGAvg 'PGfloat8 = 'PGfloat8

460+ PGAvg 'PGinterval = 'PGinterval

461+ PGAvg pg = TypeError

462+ ('Text "Squeal type error: No average for " ':<>: 'ShowType pg)

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Collection.hsnew file+169

@@ -0,0 +1,169 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Collection

3+Description: Array and composite functions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Array and composite functions

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , DataKinds

14+ , FlexibleContexts

15+ , FlexibleInstances

16+ , MultiParamTypeClasses

17+ , OverloadedLabels

18+ , OverloadedStrings

19+ , RankNTypes

20+ , ScopedTypeVariables

21+ , TypeApplications

22+ , TypeFamilies

23+ , TypeOperators

24+ , UndecidableInstances

25+#-}

26+

27+module Squeal.PostgreSQL.Expression.Collection

28+ ( array

29+ , array1

30+ , array2

31+ , cardinality

32+ , index

33+ , unnest

34+ , row

35+ , field

36+ ) where

37+

38+import Data.String

39+import Data.Word (Word64)

40+

41+import qualified Generics.SOP as SOP

42+

43+import Squeal.PostgreSQL.Alias

44+import Squeal.PostgreSQL.Expression

45+import Squeal.PostgreSQL.Expression.Set

46+import Squeal.PostgreSQL.List

47+import Squeal.PostgreSQL.Render

48+import Squeal.PostgreSQL.Schema

49+

50+-- $setup

51+-- >>> import Squeal.PostgreSQL

52+

53+-- | >>> printSQL $ array [null_, false, true]

54+-- ARRAY[NULL, FALSE, TRUE]

55+array

56+ :: [Expression outer commons grp schemas params from ty]

57+ -- ^ array elements

58+ -> Expression outer commons grp schemas params from (null ('PGvararray ty))

59+array xs = UnsafeExpression $ "ARRAY" <>

60+ bracketed (commaSeparated (renderSQL <$> xs))

61+

62+{- | construct a 1-dimensional fixed length array

63+

64+>>> printSQL $ array1 (null_ :* false *: true)

65+ARRAY[NULL, FALSE, TRUE]

66+

67+>>> :type array1 (null_ :* false *: true)

68+array1 (null_ :* false *: true)

69+ :: Expression

70+ outer

71+ commons

72+ grp

73+ schemas

74+ params

75+ from

76+ (null ('PGfixarray '[3] ('Null 'PGbool)))

77+-}

78+array1

79+ :: (n ~ Length tys, SOP.All ((~) ty) tys)

80+ => NP (Expression outer commons grp schemas params from) tys

81+ -> Expression outer commons grp schemas params from (null ('PGfixarray '[n] ty))

82+array1 xs = UnsafeExpression $ "ARRAY" <>

83+ bracketed (renderCommaSeparated renderSQL xs)

84+

85+{- | construct a 2-dimensional fixed length array

86+

87+>>> printSQL $ array2 ((null_ :* false *: true) *: (false :* null_ *: true))

88+ARRAY[[NULL, FALSE, TRUE], [FALSE, NULL, TRUE]]

89+

90+>>> :type array2 ((null_ :* false *: true) *: (false :* null_ *: true))

91+array2 ((null_ :* false *: true) *: (false :* null_ *: true))

92+ :: Expression

93+ outer

94+ commons

95+ grp

96+ schemas

97+ params

98+ from

99+ (null ('PGfixarray '[2, 3] ('Null 'PGbool)))

100+-}

101+array2

102+ :: ( SOP.All ((~) tys) tyss

103+ , SOP.All SOP.SListI tyss

104+ , Length tyss ~ n1

105+ , SOP.All ((~) ty) tys

106+ , Length tys ~ n2 )

107+ => NP (NP (Expression outer commons grp schemas params from)) tyss

108+ -> Expression outer commons grp schemas params from (null ('PGfixarray '[n1,n2] ty))

109+array2 xss = UnsafeExpression $ "ARRAY" <>

110+ bracketed (renderCommaSeparatedConstraint @SOP.SListI (bracketed . renderCommaSeparated renderSQL) xss)

111+

112+-- | >>> printSQL $ cardinality (array [null_, false, true])

113+-- cardinality(ARRAY[NULL, FALSE, TRUE])

114+cardinality :: null ('PGvararray ty) --> null 'PGint8

115+cardinality = unsafeFunction "cardinality"

116+

117+-- | >>> printSQL $ array [null_, false, true] & index 2

118+-- (ARRAY[NULL, FALSE, TRUE])[2]

119+index

120+ :: Word64 -- ^ index

121+ -> null ('PGvararray ty) --> NullifyType ty

122+index n expr = UnsafeExpression $

123+ parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"

124+

125+-- | Expand an array to a set of rows

126+unnest :: SetFunction "unnest" (null ('PGvararray ty)) '["unnest" ::: ty]

127+unnest = unsafeSetFunction

128+

129+-- | A row constructor is an expression that builds a row value

130+-- (also called a composite value) using values for its member fields.

131+--

132+-- >>> :{

133+-- type Complex = 'PGcomposite

134+-- '[ "real" ::: 'NotNull 'PGfloat8

135+-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

136+-- :}

137+--

138+-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression outer commons grp schemas params from ('NotNull Complex)

139+-- >>> printSQL i

140+-- ROW(0, 1)

141+row

142+ :: SOP.SListI row

143+ => NP (Aliased (Expression outer commons grp schemas params from)) row

144+ -- ^ zero or more expressions for the row field values

145+ -> Expression outer commons grp schemas params from (null ('PGcomposite row))

146+row exprs = UnsafeExpression $ "ROW" <> parenthesized

147+ (renderCommaSeparated (\ (expr `As` _) -> renderSQL expr) exprs)

148+

149+-- | >>> :{

150+-- type Complex = 'PGcomposite

151+-- '[ "real" ::: 'NotNull 'PGfloat8

152+-- , "imaginary" ::: 'NotNull 'PGfloat8 ]

153+-- type Schema = '["complex" ::: 'Typedef Complex]

154+-- :}

155+--

156+-- >>> let i = row (0 `as` #real :* 1 `as` #imaginary) :: Expression outer '[] grp (Public Schema) from params ('NotNull Complex)

157+-- >>> printSQL $ i & field #complex #imaginary

158+-- (ROW(0, 1)::"complex")."imaginary"

159+field

160+ :: ( Has sch schemas schema

161+ , Has tydef schema ('Typedef ('PGcomposite row))

162+ , Has field row ty)

163+ => QualifiedAlias sch tydef -- ^ row type

164+ -> Alias field -- ^ field name

165+ -> Expression outer commons grp schemas params from ('NotNull ('PGcomposite row))

166+ -> Expression outer commons grp schemas params from ty

167+field td fld expr = UnsafeExpression $

168+ parenthesized (renderSQL expr <> "::" <> renderSQL td)

169+ <> "." <> renderSQL fld

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Comparison.hsnew file+206

@@ -0,0 +1,206 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Comparison

3+Description: Comparison expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Comparison functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ OverloadedStrings

13+ , RankNTypes

14+ , TypeInType

15+ , TypeOperators

16+#-}

17+

18+module Squeal.PostgreSQL.Expression.Comparison

19+ ( (.==)

20+ , (./=)

21+ , (.>=)

22+ , (.<)

23+ , (.<=)

24+ , (.>)

25+ , greatest

26+ , least

27+ , BetweenExpr

28+ , between

29+ , notBetween

30+ , betweenSymmetric

31+ , notBetweenSymmetric

32+ , isDistinctFrom

33+ , isNotDistinctFrom

34+ , isTrue

35+ , isNotTrue

36+ , isFalse

37+ , isNotFalse

38+ , isUnknown

39+ , isNotUnknown

40+ ) where

41+

42+import Data.ByteString

43+

44+import Squeal.PostgreSQL.Expression

45+import Squeal.PostgreSQL.Expression.Logic

46+import Squeal.PostgreSQL.Render

47+import Squeal.PostgreSQL.Schema

48+

49+-- $setup

50+-- >>> import Squeal.PostgreSQL

51+

52+-- | Comparison operations like `.==`, `./=`, `.>`, `.>=`, `.<` and `.<=`

53+-- will produce @NULL@s if one of their arguments is @NULL@.

54+--

55+-- >>> printSQL $ true .== null_

56+-- (TRUE = NULL)

57+(.==) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

58+(.==) = unsafeBinaryOp "="

59+infix 4 .==

60+

61+-- | >>> printSQL $ true ./= null_

62+-- (TRUE <> NULL)

63+(./=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

64+(./=) = unsafeBinaryOp "<>"

65+infix 4 ./=

66+

67+-- | >>> printSQL $ true .>= null_

68+-- (TRUE >= NULL)

69+(.>=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

70+(.>=) = unsafeBinaryOp ">="

71+infix 4 .>=

72+

73+-- | >>> printSQL $ true .< null_

74+-- (TRUE < NULL)

75+(.<) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

76+(.<) = unsafeBinaryOp "<"

77+infix 4 .<

78+

79+-- | >>> printSQL $ true .<= null_

80+-- (TRUE <= NULL)

81+(.<=) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

82+(.<=) = unsafeBinaryOp "<="

83+infix 4 .<=

84+

85+-- | >>> printSQL $ true .> null_

86+-- (TRUE > NULL)

87+(.>) :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

88+(.>) = unsafeBinaryOp ">"

89+infix 4 .>

90+

91+-- | >>> let expr = greatest [param @1] currentTimestamp :: Expression outer commons grp schemas '[ 'NotNull 'PGtimestamptz] from ('NotNull 'PGtimestamptz)

92+-- >>> printSQL expr

93+-- GREATEST(($1 :: timestamp with time zone), CURRENT_TIMESTAMP)

94+greatest :: FunctionVar ty ty ty

95+greatest = unsafeFunctionVar "GREATEST"

96+

97+-- | >>> printSQL $ least [null_] currentTimestamp

98+-- LEAST(NULL, CURRENT_TIMESTAMP)

99+least :: FunctionVar ty ty ty

100+least = unsafeFunctionVar "LEAST"

101+

102+{- |

103+A @RankNType@ for comparison expressions like `between`.

104+-}

105+type BetweenExpr

106+ = forall outer commons grp schemas params from ty

107+ . Expression outer commons grp schemas params from ty

108+ -> ( Expression outer commons grp schemas params from ty

109+ , Expression outer commons grp schemas params from ty ) -- ^ bounds

110+ -> Condition outer commons grp schemas params from

111+

112+unsafeBetweenExpr :: ByteString -> BetweenExpr

113+unsafeBetweenExpr fun a (x,y) = UnsafeExpression $

114+ renderSQL a <+> fun <+> renderSQL x <+> "AND" <+> renderSQL y

115+

116+{- | >>> printSQL $ true `between` (null_, false)

117+TRUE BETWEEN NULL AND FALSE

118+-}

119+between :: BetweenExpr

120+between = unsafeBetweenExpr "BETWEEN"

121+

122+{- | >>> printSQL $ true `notBetween` (null_, false)

123+TRUE NOT BETWEEN NULL AND FALSE

124+-}

125+notBetween :: BetweenExpr

126+notBetween = unsafeBetweenExpr "NOT BETWEEN"

127+

128+{- | between, after sorting the comparison values

129+

130+>>> printSQL $ true `betweenSymmetric` (null_, false)

131+TRUE BETWEEN SYMMETRIC NULL AND FALSE

132+-}

133+betweenSymmetric :: BetweenExpr

134+betweenSymmetric = unsafeBetweenExpr "BETWEEN SYMMETRIC"

135+

136+{- | not between, after sorting the comparison values

137+

138+>>> printSQL $ true `notBetweenSymmetric` (null_, false)

139+TRUE NOT BETWEEN SYMMETRIC NULL AND FALSE

140+-}

141+notBetweenSymmetric :: BetweenExpr

142+notBetweenSymmetric = unsafeBetweenExpr "NOT BETWEEN SYMMETRIC"

143+

144+{- | not equal, treating null like an ordinary value

145+

146+>>> printSQL $ true `isDistinctFrom` null_

147+(TRUE IS DISTINCT FROM NULL)

148+-}

149+isDistinctFrom :: Operator (null0 ty) (null1 ty) ('Null 'PGbool)

150+isDistinctFrom = unsafeBinaryOp "IS DISTINCT FROM"

151+

152+{- | equal, treating null like an ordinary value

153+

154+>>> printSQL $ true `isNotDistinctFrom` null_

155+(TRUE IS NOT DISTINCT FROM NULL)

156+-}

157+isNotDistinctFrom :: Operator (null0 ty) (null1 ty) ('NotNull 'PGbool)

158+isNotDistinctFrom = unsafeBinaryOp "IS NOT DISTINCT FROM"

159+

160+{- | is true

161+

162+>>> printSQL $ true & isTrue

163+(TRUE IS TRUE)

164+-}

165+isTrue :: null0 'PGbool --> null1 'PGbool

166+isTrue = unsafeRightOp "IS TRUE"

167+

168+{- | is false or unknown

169+

170+>>> printSQL $ true & isNotTrue

171+(TRUE IS NOT TRUE)

172+-}

173+isNotTrue :: null0 'PGbool --> null1 'PGbool

174+isNotTrue = unsafeRightOp "IS NOT TRUE"

175+

176+{- | is false

177+

178+>>> printSQL $ true & isFalse

179+(TRUE IS FALSE)

180+-}

181+isFalse :: null0 'PGbool --> null1 'PGbool

182+isFalse = unsafeRightOp "IS FALSE"

183+

184+{- | is true or unknown

185+

186+>>> printSQL $ true & isNotFalse

187+(TRUE IS NOT FALSE)

188+-}

189+isNotFalse :: null0 'PGbool --> null1 'PGbool

190+isNotFalse = unsafeRightOp "IS NOT FALSE"

191+

192+{- | is unknown

193+

194+>>> printSQL $ true & isUnknown

195+(TRUE IS UNKNOWN)

196+-}

197+isUnknown :: null0 'PGbool --> null1 'PGbool

198+isUnknown = unsafeRightOp "IS UNKNOWN"

199+

200+{- | is true or false

201+

202+>>> printSQL $ true & isNotUnknown

203+(TRUE IS NOT UNKNOWN)

204+-}

205+isNotUnknown :: null0 'PGbool --> null1 'PGbool

206+isNotUnknown = unsafeRightOp "IS NOT UNKNOWN"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Json.hsnew file+462

@@ -0,0 +1,462 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Json

3+Description: Json and Jsonb functions and operators

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Json and Jsonb functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , FlexibleContexts

14+ , FlexibleInstances

15+ , GADTs

16+ , OverloadedLabels

17+ , OverloadedStrings

18+ , PolyKinds

19+ , RankNTypes

20+ , ScopedTypeVariables

21+ , TypeApplications

22+ , TypeOperators

23+ , UndecidableInstances

24+ , UndecidableSuperClasses

25+#-}

26+

27+module Squeal.PostgreSQL.Expression.Json

28+ ( -- * Json and Jsonb operators

29+ (.->)

30+ , (.->>)

31+ , (.#>)

32+ , (.#>>)

33+ -- * Jsonb operators

34+ , (.?)

35+ , (.?|)

36+ , (.?&)

37+ , (.-.)

38+ , (#-.)

39+ -- * Json and Jsonb functions

40+ , toJson

41+ , toJsonb

42+ , arrayToJson

43+ , rowToJson

44+ , jsonBuildArray

45+ , jsonbBuildArray

46+ , JsonBuildObject (..)

47+ , jsonObject

48+ , jsonbObject

49+ , jsonZipObject

50+ , jsonbZipObject

51+ , jsonArrayLength

52+ , jsonbArrayLength

53+ , jsonTypeof

54+ , jsonbTypeof

55+ , jsonStripNulls

56+ , jsonbStripNulls

57+ , jsonbSet

58+ , jsonbInsert

59+ , jsonbPretty

60+ -- * Json and Jsonb set returning functions

61+ , jsonEach

62+ , jsonbEach

63+ , jsonEachText

64+ , jsonbEachText

65+ , jsonObjectKeys

66+ , jsonbObjectKeys

67+ , JsonPopulateFunction

68+ , jsonPopulateRecord

69+ , jsonbPopulateRecord

70+ , jsonPopulateRecordSet

71+ , jsonbPopulateRecordSet

72+ , JsonToRecordFunction

73+ , jsonToRecord

74+ , jsonbToRecord

75+ , jsonToRecordSet

76+ , jsonbToRecordSet

77+ ) where

78+

79+import Data.ByteString (ByteString)

80+import GHC.TypeLits

81+

82+import Squeal.PostgreSQL.Alias

83+import Squeal.PostgreSQL.Expression

84+import Squeal.PostgreSQL.Expression.Set

85+import Squeal.PostgreSQL.Expression.Type

86+import Squeal.PostgreSQL.List

87+import Squeal.PostgreSQL.Query

88+import Squeal.PostgreSQL.Render

89+import Squeal.PostgreSQL.Schema

90+

91+import qualified Generics.SOP as SOP

92+

93+-- $setup

94+-- >>> import Squeal.PostgreSQL

95+-- >>> import Data.Aeson

96+

97+{-----------------------------------------

98+ -- json and jsonb support

99+

100+See https://www.postgresql.org/docs/10/static/functions-json.html -- most

101+comments lifted directly from this page.

102+

103+Table 9.44: json and jsonb operators

104+-----------------------------------------}

105+

106+-- | Get JSON value (object field or array element) at a key.

107+(.->)

108+ :: (json `In` PGJsonType, key `In` PGJsonKey)

109+ => Operator (null json) (null key) ('Null json)

110+infixl 8 .->

111+(.->) = unsafeBinaryOp "->"

112+

113+-- | Get JSON value (object field or array element) at a key, as text.

114+(.->>)

115+ :: (json `In` PGJsonType, key `In` PGJsonKey)

116+ => Operator (null json) (null key) ('Null 'PGtext)

117+infixl 8 .->>

118+(.->>) = unsafeBinaryOp "->>"

119+

120+-- | Get JSON value at a specified path.

121+(.#>)

122+ :: json `In` PGJsonType

123+ => Operator (null json) (null ('PGvararray ('NotNull 'PGtext))) ('Null json)

124+infixl 8 .#>

125+(.#>) = unsafeBinaryOp "#>"

126+

127+-- | Get JSON value at a specified path as text.

128+(.#>>)

129+ :: json `In` PGJsonType

130+ => Operator (null json) (null ('PGvararray ('NotNull 'PGtext))) ('Null 'PGtext)

131+infixl 8 .#>>

132+(.#>>) = unsafeBinaryOp "#>>"

133+

134+-- Additional jsonb operators

135+

136+-- | Does the string exist as a top-level key within the JSON value?

137+(.?) :: Operator (null 'PGjsonb) (null 'PGtext) ('Null 'PGbool)

138+infixl 9 .?

139+(.?) = unsafeBinaryOp "?"

140+

141+-- | Do any of these array strings exist as top-level keys?

142+(.?|) :: Operator

143+ (null 'PGjsonb)

144+ (null ('PGvararray ('NotNull 'PGtext)))

145+ ('Null 'PGbool)

146+infixl 9 .?|

147+(.?|) = unsafeBinaryOp "?|"

148+

149+-- | Do all of these array strings exist as top-level keys?

150+(.?&) :: Operator

151+ (null 'PGjsonb)

152+ (null ('PGvararray ('NotNull 'PGtext)))

153+ ('Null 'PGbool)

154+infixl 9 .?&

155+(.?&) = unsafeBinaryOp "?&"

156+

157+-- | Delete a key or keys from a JSON object, or remove an array element.

158+--

159+-- If the right operand is

160+--

161+-- @ text @: Delete key / value pair or string element from left operand.

162+-- Key / value pairs are matched based on their key value,

163+--

164+-- @ text[] @: Delete multiple key / value pairs or string elements

165+-- from left operand. Key / value pairs are matched based on their key value,

166+--

167+-- @ integer @: Delete the array element with specified index (Negative integers

168+-- count from the end). Throws an error if top level container is not an array.

169+(.-.)

170+ :: key `In` '[ 'PGtext, 'PGvararray ('NotNull 'PGtext), 'PGint4, 'PGint2 ]

171+ => Operator (null 'PGjsonb) (null key) (null 'PGjsonb)

172+infixl 6 .-.

173+(.-.) = unsafeBinaryOp "-"

174+

175+-- | Delete the field or element with specified path (for JSON arrays, negative

176+-- integers count from the end)

177+(#-.) :: Operator (null 'PGjsonb) (null ('PGvararray ('NotNull 'PGtext))) (null 'PGjsonb)

178+infixl 6 #-.

179+(#-.) = unsafeBinaryOp "#-"

180+

181+{-----------------------------------------

182+Table 9.45: JSON creation functions

183+-----------------------------------------}

184+

185+-- | Returns the value as json. Arrays and composites are converted

186+-- (recursively) to arrays and objects; otherwise, if there is a cast from the

187+-- type to json, the cast function will be used to perform the conversion;

188+-- otherwise, a scalar value is produced. For any scalar type other than a

189+-- number, a Boolean, or a null value, the text representation will be used, in

190+-- such a fashion that it is a valid json value.

191+toJson :: null ty --> null 'PGjson

192+toJson = unsafeFunction "to_json"

193+

194+-- | Returns the value as jsonb. Arrays and composites are converted

195+-- (recursively) to arrays and objects; otherwise, if there is a cast from the

196+-- type to json, the cast function will be used to perform the conversion;

197+-- otherwise, a scalar value is produced. For any scalar type other than a

198+-- number, a Boolean, or a null value, the text representation will be used, in

199+-- such a fashion that it is a valid jsonb value.

200+toJsonb :: null ty --> null 'PGjsonb

201+toJsonb = unsafeFunction "to_jsonb"

202+

203+-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

204+-- becomes a JSON array of arrays.

205+arrayToJson :: null ('PGvararray ty) --> null 'PGjson

206+arrayToJson = unsafeFunction "array_to_json"

207+

208+-- | Returns the row as a JSON object.

209+rowToJson :: null ('PGcomposite ty) --> null 'PGjson

210+rowToJson = unsafeFunction "row_to_json"

211+

212+-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

213+-- argument list.

214+jsonBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjson

215+jsonBuildArray = unsafeFunctionN "json_build_array"

216+

217+-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

218+-- variadic argument list.

219+jsonbBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjsonb

220+jsonbBuildArray = unsafeFunctionN "jsonb_build_array"

221+

222+-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

223+-- argument list. The elements of the argument list must alternate between text

224+-- and values.

225+class SOP.SListI tys => JsonBuildObject tys where

226+

227+ jsonBuildObject :: tys ---> null 'PGjson

228+ jsonBuildObject = unsafeFunctionN "json_build_object"

229+

230+ jsonbBuildObject :: tys ---> null 'PGjsonb

231+ jsonbBuildObject = unsafeFunctionN "jsonb_build_object"

232+

233+instance JsonBuildObject '[]

234+instance (JsonBuildObject tys, key `In` PGJsonKey)

235+ => JsonBuildObject ('NotNull key ': value ': tys)

236+

237+-- | Builds a JSON object out of a text array.

238+-- The array must have two dimensions

239+-- such that each inner array has exactly two elements,

240+-- which are taken as a key/value pair.

241+jsonObject

242+ :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

243+ --> null 'PGjson

244+jsonObject = unsafeFunction "json_object"

245+

246+-- | Builds a binary JSON object out of a text array.

247+-- The array must have two dimensions

248+-- such that each inner array has exactly two elements,

249+-- which are taken as a key/value pair.

250+jsonbObject

251+ :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

252+ --> null 'PGjsonb

253+jsonbObject = unsafeFunction "jsonb_object"

254+

255+-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

256+-- keys and one for values, that are zipped pairwise to create a JSON object.

257+jsonZipObject ::

258+ '[ null ('PGvararray ('NotNull 'PGtext))

259+ , null ('PGvararray ('NotNull 'PGtext)) ]

260+ ---> null 'PGjson

261+jsonZipObject = unsafeFunctionN "json_object"

262+

263+-- | This is an alternate form of 'jsonbObject' that takes two arrays; one for

264+-- keys and one for values, that are zipped pairwise to create a binary JSON

265+-- object.

266+jsonbZipObject ::

267+ '[ null ('PGvararray ('NotNull 'PGtext))

268+ , null ('PGvararray ('NotNull 'PGtext)) ]

269+ ---> null 'PGjsonb

270+jsonbZipObject = unsafeFunctionN "jsonb_object"

271+

272+{-----------------------------------------

273+Table 9.46: JSON processing functions

274+-----------------------------------------}

275+

276+-- | Returns the number of elements in the outermost JSON array.

277+jsonArrayLength :: null 'PGjson --> null 'PGint4

278+jsonArrayLength = unsafeFunction "json_array_length"

279+

280+-- | Returns the number of elements in the outermost binary JSON array.

281+jsonbArrayLength :: null 'PGjsonb --> null 'PGint4

282+jsonbArrayLength = unsafeFunction "jsonb_array_length"

283+

284+-- | Returns the type of the outermost JSON value as a text string. Possible

285+-- types are object, array, string, number, boolean, and null.

286+jsonTypeof :: null 'PGjson --> null 'PGtext

287+jsonTypeof = unsafeFunction "json_typeof"

288+

289+-- | Returns the type of the outermost binary JSON value as a text string.

290+-- Possible types are object, array, string, number, boolean, and null.

291+jsonbTypeof :: null 'PGjsonb --> null 'PGtext

292+jsonbTypeof = unsafeFunction "jsonb_typeof"

293+

294+-- | Returns its argument with all object fields that have null values omitted.

295+-- Other null values are untouched.

296+jsonStripNulls :: null 'PGjson --> null 'PGjson

297+jsonStripNulls = unsafeFunction "json_strip_nulls"

298+

299+-- | Returns its argument with all object fields that have null values omitted.

300+-- Other null values are untouched.

301+jsonbStripNulls :: null 'PGjsonb --> null 'PGjsonb

302+jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

303+

304+-- | @ jsonbSet target path new_value create_missing @

305+--

306+-- Returns target with the section designated by path replaced by @new_value@,

307+-- or with @new_value@ added if create_missing is

308+-- `Squeal.PostgreSQL.Expression.Logic.true` and the

309+-- item designated by path does not exist. As with the path orientated

310+-- operators, negative integers that appear in path count from the end of JSON

311+-- arrays.

312+jsonbSet ::

313+ '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

314+ , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

315+jsonbSet = unsafeFunctionN "jsonbSet"

316+

317+-- | @ jsonbInsert target path new_value insert_after @

318+--

319+-- Returns target with @new_value@ inserted. If target section designated by

320+-- path is in a JSONB array, @new_value@ will be inserted before target or after

321+-- if @insert_after@ is `Squeal.PostgreSQL.Expression.Logic.true`.

322+-- If target section designated by

323+-- path is in JSONB object, @new_value@ will be inserted only if target does not

324+-- exist. As with the path orientated operators, negative integers that appear

325+-- in path count from the end of JSON arrays.

326+jsonbInsert ::

327+ '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

328+ , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

329+jsonbInsert = unsafeFunctionN "jsonb_insert"

330+

331+-- | Returns its argument as indented JSON text.

332+jsonbPretty :: null 'PGjsonb --> null 'PGtext

333+jsonbPretty = unsafeFunction "jsonb_pretty"

334+

335+{- | Expands the outermost JSON object into a set of key/value pairs.

336+

337+>>> printSQL (select Star (from (jsonEach (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))

338+SELECT * FROM json_each(('{"a":"foo","b":"bar"}' :: json))

339+-}

340+jsonEach :: SetFunction "json_each" (null 'PGjson)

341+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]

342+jsonEach = unsafeSetFunction

343+

344+{- | Expands the outermost binary JSON object into a set of key/value pairs.

345+

346+>>> printSQL (select Star (from (jsonbEach (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))

347+SELECT * FROM jsonb_each(('{"a":"foo","b":"bar"}' :: jsonb))

348+-}

349+jsonbEach

350+ :: SetFunction "jsonb_each" (nullity 'PGjsonb)

351+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]

352+jsonbEach = unsafeSetFunction

353+

354+{- | Expands the outermost JSON object into a set of key/value pairs.

355+

356+>>> printSQL (select Star (from (jsonEachText (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))

357+SELECT * FROM json_each_text(('{"a":"foo","b":"bar"}' :: json))

358+-}

359+jsonEachText

360+ :: SetFunction "json_each_text" (null 'PGjson)

361+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

362+jsonEachText = unsafeSetFunction

363+

364+{- | Expands the outermost binary JSON object into a set of key/value pairs.

365+

366+>>> printSQL (select Star (from (jsonbEachText (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))))

367+SELECT * FROM jsonb_each_text(('{"a":"foo","b":"bar"}' :: jsonb))

368+-}

369+jsonbEachText

370+ :: SetFunction "jsonb_each_text" (null 'PGjsonb)

371+ '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

372+jsonbEachText = unsafeSetFunction

373+

374+{- | Returns set of keys in the outermost JSON object.

375+

376+>>> printSQL (jsonObjectKeys (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))

377+json_object_keys(('{"a":"foo","b":"bar"}' :: json))

378+-}

379+jsonObjectKeys

380+ :: SetFunction "json_object_keys" (nullity 'PGjson)

381+ '["json_object_keys" ::: 'NotNull 'PGtext]

382+jsonObjectKeys = unsafeSetFunction

383+

384+{- | Returns set of keys in the outermost JSON object.

385+

386+>>> printSQL (jsonbObjectKeys (literal (Jsonb (object ["a" .= "foo", "b" .= "bar"]))))

387+jsonb_object_keys(('{"a":"foo","b":"bar"}' :: jsonb))

388+-}

389+jsonbObjectKeys

390+ :: SetFunction "jsonb_object_keys" (null 'PGjsonb)

391+ '["jsonb_object_keys" ::: 'NotNull 'PGtext]

392+jsonbObjectKeys = unsafeSetFunction

393+

394+-- | Build rows from Json types.

395+type JsonPopulateFunction fun json

396+ = forall schemas row outer commons params

397+ . json `In` PGJsonType

398+ => TypeExpression schemas ('NotNull ('PGcomposite row)) -- ^ row type

399+ -> Expression outer commons 'Ungrouped schemas params '[] ('NotNull json)

400+ -- ^ json type

401+ -> FromClause outer commons schemas params '[fun ::: row]

402+

403+unsafePopulateFunction

404+ :: forall fun ty

405+ . KnownSymbol fun => Alias fun -> JsonPopulateFunction fun ty

406+unsafePopulateFunction _fun ty expr = UnsafeFromClause $ renderSymbol @fun

407+ <> parenthesized ("null::" <> renderSQL ty <> ", " <> renderSQL expr)

408+

409+-- | Expands the JSON expression to a row whose columns match the record

410+-- type defined by the given table.

411+jsonPopulateRecord :: JsonPopulateFunction "json_populate_record" 'PGjson

412+jsonPopulateRecord = unsafePopulateFunction #json_populate_record

413+

414+-- | Expands the binary JSON expression to a row whose columns match the record

415+-- type defined by the given table.

416+jsonbPopulateRecord :: JsonPopulateFunction "jsonb_populate_record" 'PGjsonb

417+jsonbPopulateRecord = unsafePopulateFunction #jsonb_populate_record

418+

419+-- | Expands the outermost array of objects in the given JSON expression to a

420+-- set of rows whose columns match the record type defined by the given table.

421+jsonPopulateRecordSet :: JsonPopulateFunction "json_populate_record_set" 'PGjson

422+jsonPopulateRecordSet = unsafePopulateFunction #json_populate_record_set

423+

424+-- | Expands the outermost array of objects in the given binary JSON expression

425+-- to a set of rows whose columns match the record type defined by the given

426+-- table.

427+jsonbPopulateRecordSet :: JsonPopulateFunction "jsonb_populate_record_set" 'PGjsonb

428+jsonbPopulateRecordSet = unsafePopulateFunction #jsonb_populate_record_set

429+

430+-- | Build rows from Json types.

431+type JsonToRecordFunction json

432+ = forall outer commons schemas params tab row

433+ . (SOP.SListI row, json `In` PGJsonType)

434+ => Expression outer commons 'Ungrouped schemas params '[] ('NotNull json)

435+ -- ^ json type

436+ -> Aliased (NP (Aliased (TypeExpression schemas))) (tab ::: row)

437+ -- ^ row type

438+ -> FromClause outer commons schemas params '[tab ::: row]

439+

440+unsafeRecordFunction :: ByteString -> JsonToRecordFunction json

441+unsafeRecordFunction fun expr (types `As` tab) = UnsafeFromClause $

442+ fun <> parenthesized (renderSQL expr) <+> "AS" <+> renderSQL tab

443+ <> parenthesized (renderCommaSeparated renderTy types)

444+ where

445+ renderTy :: Aliased (TypeExpression schemas) ty -> ByteString

446+ renderTy (ty `As` alias) = renderSQL alias <+> renderSQL ty

447+

448+-- | Builds an arbitrary record from a JSON object.

449+jsonToRecord :: JsonToRecordFunction 'PGjson

450+jsonToRecord = unsafeRecordFunction "json_to_record"

451+

452+-- | Builds an arbitrary record from a binary JSON object.

453+jsonbToRecord :: JsonToRecordFunction 'PGjsonb

454+jsonbToRecord = unsafeRecordFunction "jsonb_to_record"

455+

456+-- | Builds an arbitrary set of records from a JSON array of objects.

457+jsonToRecordSet :: JsonToRecordFunction 'PGjson

458+jsonToRecordSet = unsafeRecordFunction "json_to_record_set"

459+

460+-- | Builds an arbitrary set of records from a binary JSON array of objects.

461+jsonbToRecordSet :: JsonToRecordFunction 'PGjsonb

462+jsonbToRecordSet = unsafeRecordFunction "jsonb_to_record_set"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Literal.hsnew file+87

@@ -0,0 +1,87 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Literal

3+Description: Literal expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Literal expressions

9+-}

10+

11+{-# LANGUAGE

12+ FlexibleContexts

13+ , FlexibleInstances

14+ , LambdaCase

15+ , OverloadedStrings

16+ , RankNTypes

17+ , ScopedTypeVariables

18+ , TypeApplications

19+ , TypeSynonymInstances

20+ , UndecidableInstances

21+#-}

22+

23+module Squeal.PostgreSQL.Expression.Literal (Literal (..)) where

24+

25+import ByteString.StrictBuilder (builderBytes)

26+import Data.ByteString.Lazy (toStrict)

27+import Data.Int

28+import Data.String

29+import Data.Text (Text)

30+

31+import qualified Data.Aeson as JSON

32+import qualified Data.Text as Text

33+import qualified Data.Text.Lazy as Lazy (Text)

34+import qualified Data.Text.Lazy as Lazy.Text

35+

36+import Squeal.PostgreSQL.Binary

37+import Squeal.PostgreSQL.Expression

38+import Squeal.PostgreSQL.Expression.Logic

39+import Squeal.PostgreSQL.PG

40+import Squeal.PostgreSQL.Render

41+

42+{- |

43+The `Literal` class allows embedding a Haskell value directly

44+as an `Expression` using `literal`.

45+

46+>>> printSQL (literal 'a')

47+E'a'

48+

49+>>> printSQL (literal (1 :: Double))

50+1.0

51+

52+>>> printSQL (literal (Json [1 :: Double, 2]))

53+('[1.0,2.0]' :: json)

54+

55+>>> printSQL (literal (Enumerated GT))

56+'GT'

57+-}

58+class Literal hask where literal :: hask -> Expr (null (PG hask))

59+instance Literal Bool where

60+ literal = \case

61+ True -> true

62+ False -> false

63+instance JSON.ToJSON hask => Literal (Json hask) where

64+ literal = UnsafeExpression . parenthesized . (<> " :: json")

65+ . singleQuotedUtf8 . toStrict . JSON.encode . getJson

66+instance JSON.ToJSON hask => Literal (Jsonb hask) where

67+ literal = UnsafeExpression . parenthesized . (<> " :: jsonb")

68+ . singleQuotedUtf8 . toStrict . JSON.encode . getJsonb

69+instance Literal Char where

70+ literal chr = UnsafeExpression $

71+ "E\'" <> fromString (escape chr) <> "\'"

72+instance Literal String where literal = fromString

73+instance Literal Int16 where literal = fromIntegral

74+instance Literal Int32 where literal = fromIntegral

75+instance Literal Int64 where literal = fromIntegral

76+instance Literal Float where literal = fromRational . toRational

77+instance Literal Double where literal = fromRational . toRational

78+instance Literal Text where literal = fromString . Text.unpack

79+instance Literal Lazy.Text where literal = fromString . Lazy.Text.unpack

80+instance ToParam (Enumerated enum) (PG (Enumerated enum))

81+ => Literal (Enumerated enum) where

82+ literal

83+ = UnsafeExpression

84+ . singleQuotedUtf8

85+ . builderBytes

86+ . unK

87+ . toParam @(Enumerated enum) @(PG (Enumerated enum))

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Logic.hsnew file+105

@@ -0,0 +1,105 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Logic

3+Description: Logical expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Logical expressions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.Logic

18+ ( Condition

19+ , true

20+ , false

21+ , not_

22+ , (.&&)

23+ , (.||)

24+ , caseWhenThenElse

25+ , ifThenElse

26+ ) where

27+

28+import Squeal.PostgreSQL.Expression

29+import Squeal.PostgreSQL.Render

30+import Squeal.PostgreSQL.Schema

31+

32+-- | A `Condition` is an `Expression`, which can evaluate

33+-- to `true`, `false` or `Squeal.PostgreSQL.Null.null_`. This is because SQL uses

34+-- a three valued logic.

35+type Condition outer commons grp schemas params from =

36+ Expression outer commons grp schemas params from ('Null 'PGbool)

37+

38+-- | >>> printSQL true

39+-- TRUE

40+true :: Expr (null 'PGbool)

41+true = UnsafeExpression "TRUE"

42+

43+-- | >>> printSQL false

44+-- FALSE

45+false :: Expr (null 'PGbool)

46+false = UnsafeExpression "FALSE"

47+

48+-- | >>> printSQL $ not_ true

49+-- (NOT TRUE)

50+not_ :: null 'PGbool --> null 'PGbool

51+not_ = unsafeLeftOp "NOT"

52+

53+-- | >>> printSQL $ true .&& false

54+-- (TRUE AND FALSE)

55+(.&&) :: Operator (null 'PGbool) (null 'PGbool) (null 'PGbool)

56+infixr 3 .&&

57+(.&&) = unsafeBinaryOp "AND"

58+

59+-- | >>> printSQL $ true .|| false

60+-- (TRUE OR FALSE)

61+(.||) :: Operator (null 'PGbool) (null 'PGbool) (null 'PGbool)

62+infixr 2 .||

63+(.||) = unsafeBinaryOp "OR"

64+

65+-- | >>> :{

66+-- let

67+-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

68+-- expression = caseWhenThenElse [(true, 1), (false, 2)] 3

69+-- in printSQL expression

70+-- :}

71+-- CASE WHEN TRUE THEN 1 WHEN FALSE THEN 2 ELSE 3 END

72+caseWhenThenElse

73+ :: [ ( Condition outer commons grp schemas params from

74+ , Expression outer commons grp schemas params from ty

75+ ) ]

76+ -- ^ whens and thens

77+ -> Expression outer commons grp schemas params from ty

78+ -- ^ else

79+ -> Expression outer commons grp schemas params from ty

80+caseWhenThenElse whenThens else_ = UnsafeExpression $ mconcat

81+ [ "CASE"

82+ , mconcat

83+ [ mconcat

84+ [ " WHEN ", renderSQL when_

85+ , " THEN ", renderSQL then_

86+ ]

87+ | (when_,then_) <- whenThens

88+ ]

89+ , " ELSE ", renderSQL else_

90+ , " END"

91+ ]

92+

93+-- | >>> :{

94+-- let

95+-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

96+-- expression = ifThenElse true 1 0

97+-- in printSQL expression

98+-- :}

99+-- CASE WHEN TRUE THEN 1 ELSE 0 END

100+ifThenElse

101+ :: Condition outer commons grp schemas params from

102+ -> Expression outer commons grp schemas params from ty -- ^ then

103+ -> Expression outer commons grp schemas params from ty -- ^ else

104+ -> Expression outer commons grp schemas params from ty

105+ifThenElse if_ then_ else_ = caseWhenThenElse [(if_,then_)] else_

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Math.hsnew file+100

@@ -0,0 +1,100 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Math

3+Description: Math expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Mathematical functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.Math

18+ ( atan2_

19+ , quot_

20+ , rem_

21+ , trunc

22+ , round_

23+ , ceiling_

24+ ) where

25+

26+import Squeal.PostgreSQL.Expression

27+import Squeal.PostgreSQL.List

28+import Squeal.PostgreSQL.Schema

29+

30+-- $setup

31+-- >>> import Squeal.PostgreSQL

32+

33+-- | >>> :{

34+-- let

35+-- expression :: Expr (null 'PGfloat4)

36+-- expression = atan2_ (pi *: 2)

37+-- in printSQL expression

38+-- :}

39+-- atan2(pi(), 2)

40+atan2_ :: float `In` PGFloating => '[ null float, null float] ---> null float

41+atan2_ = unsafeFunctionN "atan2"

42+

43+

44+-- | integer division, truncates the result

45+--

46+-- >>> :{

47+-- let

48+-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

49+-- expression = 5 `quot_` 2

50+-- in printSQL expression

51+-- :}

52+-- (5 / 2)

53+quot_

54+ :: int `In` PGIntegral

55+ => Operator (null int) (null int) (null int)

56+quot_ = unsafeBinaryOp "/"

57+

58+-- | remainder upon integer division

59+--

60+-- >>> :{

61+-- let

62+-- expression :: Expression outer commons grp schemas params from (null 'PGint2)

63+-- expression = 5 `rem_` 2

64+-- in printSQL expression

65+-- :}

66+-- (5 % 2)

67+rem_

68+ :: int `In` PGIntegral

69+ => Operator (null int) (null int) (null int)

70+rem_ = unsafeBinaryOp "%"

71+

72+-- | >>> :{

73+-- let

74+-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

75+-- expression = trunc pi

76+-- in printSQL expression

77+-- :}

78+-- trunc(pi())

79+trunc :: frac `In` PGFloating => null frac --> null frac

80+trunc = unsafeFunction "trunc"

81+

82+-- | >>> :{

83+-- let

84+-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

85+-- expression = round_ pi

86+-- in printSQL expression

87+-- :}

88+-- round(pi())

89+round_ :: frac `In` PGFloating => null frac --> null frac

90+round_ = unsafeFunction "round"

91+

92+-- | >>> :{

93+-- let

94+-- expression :: Expression outer commons grp schemas params from (null 'PGfloat4)

95+-- expression = ceiling_ pi

96+-- in printSQL expression

97+-- :}

98+-- ceiling(pi())

99+ceiling_ :: frac `In` PGFloating => null frac --> null frac

100+ceiling_ = unsafeFunction "ceiling"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Null.hsnew file+104

@@ -0,0 +1,104 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Null

3+Description: Null

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Null values and null handling functions

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.Null

18+ ( null_

19+ , notNull

20+ , coalesce

21+ , fromNull

22+ , isNull

23+ , isNotNull

24+ , matchNull

25+ , nullIf

26+ ) where

27+

28+import Squeal.PostgreSQL.Expression

29+import Squeal.PostgreSQL.Expression.Logic

30+import Squeal.PostgreSQL.Render

31+import Squeal.PostgreSQL.Schema

32+

33+-- $setup

34+-- >>> import Squeal.PostgreSQL

35+

36+-- | analagous to `Nothing`

37+--

38+-- >>> printSQL null_

39+-- NULL

40+null_ :: Expr ('Null ty)

41+null_ = UnsafeExpression "NULL"

42+

43+-- | analagous to `Just`

44+--

45+-- >>> printSQL $ notNull true

46+-- TRUE

47+notNull :: 'NotNull ty --> 'Null ty

48+notNull = UnsafeExpression . renderSQL

49+

50+-- | return the leftmost value which is not NULL

51+--

52+-- >>> printSQL $ coalesce [null_, true] false

53+-- COALESCE(NULL, TRUE, FALSE)

54+coalesce :: FunctionVar ('Null ty) ('NotNull ty) ('NotNull ty)

55+coalesce nullxs notNullx = UnsafeExpression $

56+ "COALESCE" <> parenthesized (commaSeparated

57+ ((renderSQL <$> nullxs) <> [renderSQL notNullx]))

58+

59+-- | analagous to `Data.Maybe.fromMaybe` using @COALESCE@

60+--

61+-- >>> printSQL $ fromNull true null_

62+-- COALESCE(NULL, TRUE)

63+fromNull

64+ :: Expression outer commons grp schemas params from ('NotNull ty)

65+ -- ^ what to convert @NULL@ to

66+ -> Expression outer commons grp schemas params from ('Null ty)

67+ -> Expression outer commons grp schemas params from ('NotNull ty)

68+fromNull notNullx nullx = coalesce [nullx] notNullx

69+

70+-- | >>> printSQL $ null_ & isNull

71+-- NULL IS NULL

72+isNull :: 'Null ty --> null 'PGbool

73+isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"

74+

75+-- | >>> printSQL $ null_ & isNotNull

76+-- NULL IS NOT NULL

77+isNotNull :: 'Null ty --> null 'PGbool

78+isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"

79+

80+-- | analagous to `maybe` using @IS NULL@

81+--

82+-- >>> printSQL $ matchNull true not_ null_

83+-- CASE WHEN NULL IS NULL THEN TRUE ELSE (NOT NULL) END

84+matchNull

85+ :: Expression outer commons grp schemas params from (nullty)

86+ -- ^ what to convert @NULL@ to

87+ -> ( Expression outer commons grp schemas params from ('NotNull ty)

88+ -> Expression outer commons grp schemas params from (nullty) )

89+ -- ^ function to perform when @NULL@ is absent

90+ -> Expression outer commons grp schemas params from ('Null ty)

91+ -> Expression outer commons grp schemas params from (nullty)

92+matchNull y f x = ifThenElse (isNull x) y

93+ (f (UnsafeExpression (renderSQL x)))

94+

95+{-| right inverse to `fromNull`, if its arguments are equal then

96+`nullIf` gives @NULL@.

97+

98+>>> :set -XTypeApplications -XDataKinds

99+>>> let expr = nullIf (false *: param @1) :: Expression outer commons grp schemas '[ 'NotNull 'PGbool] from ('Null 'PGbool)

100+>>> printSQL expr

101+NULLIF(FALSE, ($1 :: bool))

102+-}

103+nullIf :: '[ 'NotNull ty, 'NotNull ty] ---> 'Null ty

104+nullIf = unsafeFunctionN "NULLIF"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Parameter.hsnew file+80

@@ -0,0 +1,80 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Parameter

3+Description: Parameters

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Parameters, out-of-line data values

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , DataKinds

14+ , FlexibleContexts

15+ , FlexibleInstances

16+ , FunctionalDependencies

17+ , KindSignatures

18+ , MultiParamTypeClasses

19+ , OverloadedStrings

20+ , RankNTypes

21+ , ScopedTypeVariables

22+ , TypeApplications

23+ , TypeOperators

24+ , UndecidableInstances

25+#-}

26+

27+module Squeal.PostgreSQL.Expression.Parameter

28+ ( HasParameter (parameter)

29+ , param

30+ ) where

31+

32+import GHC.TypeLits

33+

34+import Squeal.PostgreSQL.Expression

35+import Squeal.PostgreSQL.Expression.Type

36+import Squeal.PostgreSQL.Render

37+import Squeal.PostgreSQL.Schema

38+

39+-- $setup

40+-- >>> import Squeal.PostgreSQL

41+

42+{- | A `HasParameter` constraint is used to indicate a value that is

43+supplied externally to a SQL statement.

44+`Squeal.PostgreSQL.PQ.manipulateParams`,

45+`Squeal.PostgreSQL.PQ.queryParams` and

46+`Squeal.PostgreSQL.PQ.traversePrepared` support specifying data values

47+separately from the SQL command string, in which case `param`s are used to

48+refer to the out-of-line data values.

49+-}

50+class KnownNat n => HasParameter

51+ (n :: Nat)

52+ (params :: [NullityType])

53+ (ty :: NullityType)

54+ | n params -> ty where

55+ -- | `parameter` takes a `Nat` using type application and a `TypeExpression`.

56+ --

57+ -- >>> let expr = parameter @1 int4 :: Expression outer '[] grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)

58+ -- >>> printSQL expr

59+ -- ($1 :: int4)

60+ parameter

61+ :: TypeExpression schemas ty

62+ -> Expression outer commons grp schemas params from ty

63+ parameter ty = UnsafeExpression $ parenthesized $

64+ "$" <> renderNat @n <+> "::"

65+ <+> renderSQL ty

66+instance {-# OVERLAPPING #-} HasParameter 1 (ty1:tys) ty1

67+instance {-# OVERLAPPABLE #-} (KnownNat n, HasParameter (n-1) params ty)

68+ => HasParameter n (ty' : params) ty

69+

70+-- | `param` takes a `Nat` using type application and for basic types,

71+-- infers a `TypeExpression`.

72+--

73+-- >>> let expr = param @1 :: Expression outer commons grp schemas '[ 'Null 'PGint4] from ('Null 'PGint4)

74+-- >>> printSQL expr

75+-- ($1 :: int4)

76+param

77+ :: forall n outer commons schemas params from grp ty

78+ . (PGTyped schemas ty, HasParameter n params ty)

79+ => Expression outer commons grp schemas params from ty -- ^ param

80+param = parameter @n (pgtype @schemas)

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Range.hsnew file+230

@@ -0,0 +1,230 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Range

3+Description: range types and functions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Range types and functions

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , DataKinds

14+ , DeriveAnyClass

15+ , DeriveGeneric

16+ , DeriveFoldable

17+ , DerivingStrategies

18+ , DeriveTraversable

19+ , FlexibleContexts

20+ , FlexibleInstances

21+ , LambdaCase

22+ , MultiParamTypeClasses

23+ , OverloadedLabels

24+ , OverloadedStrings

25+ , PatternSynonyms

26+ , RankNTypes

27+ , ScopedTypeVariables

28+ , TypeApplications

29+ , TypeFamilies

30+ , TypeOperators

31+ , UndecidableInstances

32+#-}

33+

34+module Squeal.PostgreSQL.Expression.Range

35+ ( range

36+ , Range (..)

37+ , (<=..<=), (<..<), (<=..<), (<..<=)

38+ , moreThan, atLeast, lessThan, atMost

39+ , singleton, whole

40+ , Bound (..)

41+ , (.<@)

42+ , (@>.)

43+ , (<<@)

44+ , (@>>)

45+ , (&<)

46+ , (&>)

47+ , (-|-)

48+ , (@+)

49+ , (@*)

50+ , (@-)

51+ , lowerBound

52+ , upperBound

53+ , isEmpty

54+ , lowerInc

55+ , lowerInf

56+ , upperInc

57+ , upperInf

58+ , rangeMerge

59+ ) where

60+

61+import BinaryParser

62+import ByteString.StrictBuilder

63+import Data.Bits

64+import qualified GHC.Generics as GHC

65+import qualified Generics.SOP as SOP

66+import qualified PostgreSQL.Binary.Decoding as Decoding

67+

68+import Squeal.PostgreSQL.Binary

69+import Squeal.PostgreSQL.Expression

70+import Squeal.PostgreSQL.Expression.Type hiding (bool)

71+import Squeal.PostgreSQL.PG

72+import Squeal.PostgreSQL.Render

73+import Squeal.PostgreSQL.Schema

74+

75+-- $setup

76+-- >>> import Squeal.PostgreSQL

77+

78+-- | Construct a `range`

79+--

80+-- >>> printSQL $ range tstzrange (atLeast now)

81+-- tstzrange(now(), NULL, '[)')

82+-- >>> printSQL $ range numrange (0 <=..< 2*pi)

83+-- numrange(0, (2 * pi()), '[)')

84+-- >>> printSQL $ range int4range Empty

85+-- ('empty' :: int4range)

86+range

87+ :: TypeExpression schemas (null ('PGrange ty))

88+ -> Range (Expression outer commons grp schemas params from ('NotNull ty))

89+ -> Expression outer commons grp schemas params from (null ('PGrange ty))

90+range ty = \case

91+ Empty -> UnsafeExpression $ parenthesized

92+ (emp <+> "::" <+> renderSQL ty)

93+ NonEmpty l u -> UnsafeExpression $ renderSQL ty <> parenthesized

94+ (commaSeparated (args l u))

95+ where

96+ emp = singleQuote <> "empty" <> singleQuote

97+ args l u = [arg l, arg u, singleQuote <> bra l <> ket u <> singleQuote]

98+ singleQuote = "\'"

99+ arg = \case

100+ Infinite -> "NULL"; Closed x -> renderSQL x; Open x -> renderSQL x

101+ bra = \case Infinite -> "("; Closed _ -> "["; Open _ -> "("

102+ ket = \case Infinite -> ")"; Closed _ -> "]"; Open _ -> ")"

103+

104+data Bound x = Infinite | Closed x | Open x

105+ deriving

106+ ( Eq, Ord, Show, Read, GHC.Generic

107+ , Functor, Foldable, Traversable )

108+

109+data Range x = Empty | NonEmpty (Bound x) (Bound x)

110+ deriving

111+ ( Eq, Ord, Show, Read, GHC.Generic

112+ , Functor, Foldable, Traversable )

113+ deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)

114+type instance PG (Range x) = 'PGrange (PG x)

115+instance ToParam x pg => ToParam (Range x) ('PGrange pg) where

116+ toParam rng = K $

117+ word8 (setFlags rng 0) <>

118+ case rng of

119+ Empty -> mempty

120+ NonEmpty lower upper -> putBound lower <> putBound upper

121+ where

122+ putBound = \case

123+ Infinite -> mempty

124+ Closed value -> putValue (unK (toParam @x @pg value))

125+ Open value -> putValue (unK (toParam @x @pg value))

126+ putValue value = int32BE (fromIntegral (builderLength value)) <> value

127+ setFlags = \case

128+ Empty -> (`setBit` 0)

129+ NonEmpty lower upper ->

130+ setLowerFlags lower . setUpperFlags upper

131+ setLowerFlags = \case

132+ Infinite -> (`setBit` 3)

133+ Closed _ -> (`setBit` 1)

134+ Open _ -> id

135+ setUpperFlags = \case

136+ Infinite -> (`setBit` 4)

137+ Closed _ -> (`setBit` 2)

138+ Open _ -> id

139+instance FromValue pg y => FromValue ('PGrange pg) (Range y) where

140+ fromValue = do

141+ flag <- byte

142+ if testBit flag 0 then return Empty else do

143+ lower <-

144+ if testBit flag 3

145+ then return Infinite

146+ else do

147+ len <- sized 4 Decoding.int

148+ l <- sized len (fromValue @pg)

149+ return $ if testBit flag 1 then Closed l else Open l

150+ upper <-

151+ if testBit flag 4

152+ then return Infinite

153+ else do

154+ len <- sized 4 Decoding.int

155+ l <- sized len (fromValue @pg)

156+ return $ if testBit flag 2 then Closed l else Open l

157+ return $ NonEmpty lower upper

158+

159+(<=..<=), (<..<), (<=..<), (<..<=) :: x -> x -> Range x

160+infix 4 <=..<=, <..<, <=..<, <..<=

161+x <=..<= y = NonEmpty (Closed x) (Closed y)

162+x <..< y = NonEmpty (Open x) (Open y)

163+x <=..< y = NonEmpty (Closed x) (Open y)

164+x <..<= y = NonEmpty (Open x) (Closed y)

165+

166+moreThan, atLeast, lessThan, atMost :: x -> Range x

167+moreThan x = NonEmpty (Open x) Infinite

168+atLeast x = NonEmpty (Closed x) Infinite

169+lessThan x = NonEmpty Infinite (Open x)

170+atMost x = NonEmpty Infinite (Closed x)

171+

172+singleton :: x -> Range x

173+singleton x = x <=..<= x

174+

175+whole :: Range x

176+whole = NonEmpty Infinite Infinite

177+

178+(.<@) :: Operator ('NotNull ty) (null ('PGrange ty)) ('Null 'PGbool)

179+(.<@) = unsafeBinaryOp "<@"

180+

181+(@>.) :: Operator (null ('PGrange ty)) ('NotNull ty) ('Null 'PGbool)

182+(@>.) = unsafeBinaryOp "<@"

183+

184+(<<@) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

185+(<<@) = unsafeBinaryOp "<<"

186+

187+(@>>) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

188+(@>>) = unsafeBinaryOp ">>"

189+

190+(&<) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

191+(&<) = unsafeBinaryOp "&<"

192+

193+(&>) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

194+(&>) = unsafeBinaryOp "&>"

195+

196+(-|-) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) ('Null 'PGbool)

197+(-|-) = unsafeBinaryOp "-|-"

198+

199+(@+) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))

200+(@+) = unsafeBinaryOp "+"

201+

202+(@*) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))

203+(@*) = unsafeBinaryOp "*"

204+

205+(@-) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))

206+(@-) = unsafeBinaryOp "-"

207+

208+lowerBound :: null ('PGrange ty) --> 'Null ty

209+lowerBound = unsafeFunction "lower"

210+

211+upperBound :: null ('PGrange ty) --> 'Null ty

212+upperBound = unsafeFunction "upper"

213+

214+isEmpty :: null ('PGrange ty) --> 'Null 'PGbool

215+isEmpty = unsafeFunction "isempty"

216+

217+lowerInc :: null ('PGrange ty) --> 'Null 'PGbool

218+lowerInc = unsafeFunction "lower_inc"

219+

220+lowerInf :: null ('PGrange ty) --> 'Null 'PGbool

221+lowerInf = unsafeFunction "lower_inf"

222+

223+upperInc :: null ('PGrange ty) --> 'Null 'PGbool

224+upperInc = unsafeFunction "upper_inc"

225+

226+upperInf :: null ('PGrange ty) --> 'Null 'PGbool

227+upperInf = unsafeFunction "upper_inf"

228+

229+rangeMerge :: '[null ('PGrange ty), null ('PGrange ty)] ---> null ('PGrange ty)

230+rangeMerge = unsafeFunctionN "range_merge"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Set.hsnew file+139

@@ -0,0 +1,139 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Set

3+Description: Set returning functions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Set returning functions

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , DataKinds

14+ , FlexibleContexts

15+ , OverloadedStrings

16+ , PolyKinds

17+ , RankNTypes

18+ , ScopedTypeVariables

19+ , TypeApplications

20+ , TypeOperators

21+#-}

22+

23+module Squeal.PostgreSQL.Expression.Set

24+ ( generateSeries

25+ , generateSeriesStep

26+ , generateSeriesTimestamp

27+ , SetFunction

28+ , unsafeSetFunction

29+ , SetFunctionDB

30+ , setFunction

31+ , SetFunctionN

32+ , unsafeSetFunctionN

33+ , SetFunctionNDB

34+ , setFunctionN

35+ ) where

36+

37+import GHC.TypeLits

38+

39+import qualified Generics.SOP as SOP

40+

41+import Squeal.PostgreSQL.Alias

42+import Squeal.PostgreSQL.Expression

43+import Squeal.PostgreSQL.List

44+import Squeal.PostgreSQL.Render

45+import Squeal.PostgreSQL.Query

46+import Squeal.PostgreSQL.Schema

47+

48+{- |

49+A @RankNType@ for set returning functions with 1 argument.

50+-}

51+type SetFunction fun ty row

52+ = forall outer commons schemas params

53+ . Expression outer commons 'Ungrouped schemas params '[] ty

54+ -- ^ input

55+ -> FromClause outer commons schemas params '[fun ::: row]

56+ -- ^ output

57+

58+type SetFunctionDB fun schemas ty row

59+ = forall outer commons params

60+ . Expression outer commons 'Ungrouped schemas params '[] ty

61+ -- ^ input

62+ -> FromClause outer commons schemas params '[fun ::: row]

63+ -- ^ output

64+

65+-- | Escape hatch for a set returning function with 1 argument.

66+unsafeSetFunction

67+ :: forall fun ty row. KnownSymbol fun

68+ => SetFunction fun ty row -- ^ set returning function

69+unsafeSetFunction x = UnsafeFromClause $

70+ renderSymbol @fun <> parenthesized (renderSQL x)

71+

72+setFunction

73+ :: ( Has sch schemas schema

74+ , Has fun schema ('Function ('[ty] :=> 'ReturnsTable row)) )

75+ => QualifiedAlias sch fun

76+ -> SetFunctionDB fun schemas ty row

77+setFunction _ = unsafeSetFunction

78+

79+{- |

80+A @RankNType@ for set returning functions with multiple argument.

81+-}

82+type SetFunctionN fun tys row

83+ = forall outer commons schemas params

84+ . NP (Expression outer commons 'Ungrouped schemas params '[]) tys

85+ -- ^ inputs

86+ -> FromClause outer commons schemas params '[fun ::: row]

87+ -- ^ output

88+

89+-- | Escape hatch for a set returning function with multiple argument.

90+unsafeSetFunctionN

91+ :: forall fun tys row. (SOP.SListI tys, KnownSymbol fun)

92+ => SetFunctionN fun tys row -- ^ set returning function

93+unsafeSetFunctionN xs = UnsafeFromClause $

94+ renderSymbol @fun <> parenthesized (renderCommaSeparated renderSQL xs)

95+

96+type SetFunctionNDB fun schemas tys row

97+ = forall outer commons params

98+ . NP (Expression outer commons 'Ungrouped schemas params '[]) tys

99+ -- ^ inputs

100+ -> FromClause outer commons schemas params '[fun ::: row]

101+ -- ^ output

102+

103+setFunctionN

104+ :: ( Has sch schemas schema

105+ , Has fun schema ('Function (tys :=> 'ReturnsTable row))

106+ , SOP.SListI tys )

107+ => QualifiedAlias sch fun

108+ -> SetFunctionNDB fun schemas tys row

109+setFunctionN _ = unsafeSetFunctionN

110+

111+{- | @generateSeries (start *: stop)@

112+

113+Generate a series of values, from @start@ to @stop@ with a step size of one

114+-}

115+generateSeries

116+ :: ty `In` '[ 'PGint4, 'PGint8, 'PGnumeric]

117+ => SetFunctionN "generate_series" '[ null ty, null ty]

118+ '["generate_series" ::: null ty] -- ^ set returning function

119+generateSeries = unsafeSetFunctionN

120+

121+{- | @generateSeries (start :* stop *: step)@

122+

123+Generate a series of values, from @start@ to @stop@ with a step size of @step@

124+-}

125+generateSeriesStep

126+ :: ty `In` '[ 'PGint4, 'PGint8, 'PGnumeric]

127+ => SetFunctionN "generate_series" '[null ty, null ty, null ty]

128+ '["generate_series" ::: null ty] -- ^ set returning function

129+generateSeriesStep = unsafeSetFunctionN

130+

131+{- | @generateSeries (start :* stop *: step)@

132+

133+Generate a series of values, from @start@ to @stop@ with a step size of @step@

134+-}

135+generateSeriesTimestamp

136+ :: ty `In` '[ 'PGtimestamp, 'PGtimestamptz]

137+ => SetFunctionN "generate_series" '[null ty, null ty, null 'PGinterval]

138+ '["generate_series" ::: null ty] -- ^ set returning function

139+generateSeriesTimestamp = unsafeSetFunctionN

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Sort.hsnew file+85

@@ -0,0 +1,85 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Sort

3+Description: Sort expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Sort expressions

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , GADTs

14+ , LambdaCase

15+ , OverloadedStrings

16+ , StandaloneDeriving

17+#-}

18+

19+module Squeal.PostgreSQL.Expression.Sort

20+ ( SortExpression (..)

21+ , OrderBy (..)

22+ ) where

23+

24+import Squeal.PostgreSQL.Expression

25+import Squeal.PostgreSQL.Render

26+import Squeal.PostgreSQL.Schema

27+

28+-- | `SortExpression`s are used by `orderBy` to optionally sort the results

29+-- of a `Squeal.PostgreSQL.Query.Query`. `Asc` or `Desc`

30+-- set the sort direction of a `NotNull` result

31+-- column to ascending or descending. Ascending order puts smaller values

32+-- first, where "smaller" is defined in terms of the

33+-- `Squeal.PostgreSQL.Expression.Comparison..<` operator. Similarly,

34+-- descending order is determined with the

35+-- `Squeal.PostgreSQL.Expression.Comparison..>` operator. `AscNullsFirst`,

36+-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to

37+-- determine whether nulls appear before or after non-null values in the sort

38+-- ordering of a `Null` result column.

39+data SortExpression outer commons grp schemas params from where

40+ Asc

41+ :: Expression outer commons grp schemas params from ('NotNull ty)

42+ -> SortExpression outer commons grp schemas params from

43+ Desc

44+ :: Expression outer commons grp schemas params from ('NotNull ty)

45+ -> SortExpression outer commons grp schemas params from

46+ AscNullsFirst

47+ :: Expression outer commons grp schemas params from ('Null ty)

48+ -> SortExpression outer commons grp schemas params from

49+ AscNullsLast

50+ :: Expression outer commons grp schemas params from ('Null ty)

51+ -> SortExpression outer commons grp schemas params from

52+ DescNullsFirst

53+ :: Expression outer commons grp schemas params from ('Null ty)

54+ -> SortExpression outer commons grp schemas params from

55+ DescNullsLast

56+ :: Expression outer commons grp schemas params from ('Null ty)

57+ -> SortExpression outer commons grp schemas params from

58+deriving instance Show (SortExpression outer commons grp schemas params from)

59+instance RenderSQL (SortExpression outer commons grp schemas params from) where

60+ renderSQL = \case

61+ Asc expression -> renderSQL expression <+> "ASC"

62+ Desc expression -> renderSQL expression <+> "DESC"

63+ AscNullsFirst expression -> renderSQL expression

64+ <+> "ASC NULLS FIRST"

65+ DescNullsFirst expression -> renderSQL expression

66+ <+> "DESC NULLS FIRST"

67+ AscNullsLast expression -> renderSQL expression <+> "ASC NULLS LAST"

68+ DescNullsLast expression -> renderSQL expression <+> "DESC NULLS LAST"

69+

70+{- |

71+The `orderBy` clause causes the result rows of a `Squeal.PostgreSQL.Query.TableExpression`

72+to be sorted according to the specified `SortExpression`(s).

73+If two rows are equal according to the leftmost expression,

74+they are compared according to the next expression and so on.

75+If they are equal according to all specified expressions,

76+they are returned in an implementation-dependent order.

77+

78+You can also control the order in which rows are processed by window functions

79+using `orderBy` within `Squeal.PostgreSQL.Query.Over`.

80+-}

81+class OrderBy expr where

82+ orderBy

83+ :: [SortExpression outer commons grp schemas params from]

84+ -> expr outer commons grp schemas params from

85+ -> expr outer commons grp schemas params from

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Subquery.hsnew file+120

@@ -0,0 +1,120 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Subquery

3+Description: Subquery expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Subquery expressions

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , RankNTypes

15+ , TypeOperators

16+#-}

17+

18+module Squeal.PostgreSQL.Expression.Subquery

19+ ( exists

20+ , in_

21+ , notIn

22+ , subAll

23+ , subAny

24+ ) where

25+

26+import Squeal.PostgreSQL.Alias

27+import Squeal.PostgreSQL.Expression

28+import Squeal.PostgreSQL.Expression.Logic

29+import Squeal.PostgreSQL.List

30+import Squeal.PostgreSQL.Query

31+import Squeal.PostgreSQL.Render

32+import Squeal.PostgreSQL.Schema

33+

34+-- $setup

35+-- >>> import Squeal.PostgreSQL

36+

37+{- |

38+The argument of `exists` is an arbitrary subquery. The subquery is evaluated

39+to determine whether it returns any rows. If it returns at least one row,

40+the result of `exists` is `true`; if the subquery returns no rows,

41+the result of `exists` is `false`.

42+

43+The subquery can refer to variables from the surrounding query,

44+which will act as constants during any one evaluation of the subquery.

45+

46+The subquery will generally only be executed long enough to determine whether

47+at least one row is returned, not all the way to completion.

48+-}

49+exists

50+ :: Query (Join outer from) commons schemas params row

51+ -> Condition outer commons grp schemas params from

52+exists query = UnsafeExpression $ "EXISTS" <+> parenthesized (renderSQL query)

53+

54+{- |

55+The right-hand side is a parenthesized subquery, which must return

56+exactly one column. The left-hand expression is evaluated and compared to each

57+row of the subquery result using the given `Operator`,

58+which must yield a Boolean result. The result of `subAll` is `true`

59+if all rows yield true (including the case where the subquery returns no rows).

60+The result is `false` if any `false` result is found.

61+The result is `Squeal.PostgreSQL.Expression.Null.null_` if

62+ no comparison with a subquery row returns `false`,

63+and at least one comparison returns `Squeal.PostgreSQL.Expression.Null.null_`.

64+

65+>>> printSQL $ subAll true (.==) (values_ (true `as` #foo))

66+(TRUE = ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo")))

67+-}

68+subAll

69+ :: Expression outer commons grp schemas params from ty1 -- ^ expression

70+ -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator

71+ -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery

72+ -> Condition outer commons grp schemas params from

73+subAll expr (?) qry = expr ?

74+ (UnsafeExpression $ "ALL" <+> parenthesized (renderSQL qry))

75+

76+{- |

77+The right-hand side is a parenthesized subquery, which must return exactly one column.

78+The left-hand expression is evaluated and compared to each row of the subquery result

79+using the given `Operator`, which must yield a Boolean result. The result of `subAny` is `true`

80+if any `true` result is obtained. The result is `false` if no true result is found

81+(including the case where the subquery returns no rows).

82+

83+>>> printSQL $ subAny "foo" like (values_ ("foobar" `as` #foo))

84+(E'foo' LIKE ANY (SELECT * FROM (VALUES (E'foobar')) AS t ("foo")))

85+-}

86+subAny

87+ :: Expression outer commons grp schemas params from ty1 -- ^ expression

88+ -> Operator ty1 ty2 ('Null 'PGbool) -- ^ operator

89+ -> Query (Join outer from) commons schemas params '[col ::: ty2] -- ^ subquery

90+ -> Condition outer commons grp schemas params from

91+subAny expr (?) qry = expr ?

92+ (UnsafeExpression $ "ANY" <+> parenthesized (renderSQL qry))

93+

94+{- |

95+The result is `true` if the left-hand expression's result is equal

96+to any of the right-hand expressions.

97+

98+>>> printSQL $ true `in_` [true, false, null_]

99+TRUE IN (TRUE, FALSE, NULL)

100+-}

101+in_

102+ :: Expression outer commons grp schemas params from ty -- ^ expression

103+ -> [Expression outer commons grp schemas params from ty]

104+ -> Condition outer commons grp schemas params from

105+expr `in_` exprs = UnsafeExpression $ renderSQL expr <+> "IN"

106+ <+> parenthesized (commaSeparated (renderSQL <$> exprs))

107+

108+{- |

109+The result is `true` if the left-hand expression's result is not equal

110+to any of the right-hand expressions.

111+

112+>>> printSQL $ true `notIn` [false, null_]

113+TRUE NOT IN (FALSE, NULL)

114+-}

115+notIn

116+ :: Expression outer commons grp schemas params from ty -- ^ expression

117+ -> [Expression outer commons grp schemas params from ty]

118+ -> Condition outer commons grp schemas params from

119+expr `notIn` exprs = UnsafeExpression $ renderSQL expr <+> "NOT IN"

120+ <+> parenthesized (commaSeparated (renderSQL <$> exprs))

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Text.hsnew file+64

@@ -0,0 +1,64 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Text

3+Description: Text expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+String functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.Text

18+ ( lower

19+ , upper

20+ , charLength

21+ , like

22+ , ilike

23+ ) where

24+

25+import Squeal.PostgreSQL.Expression

26+import Squeal.PostgreSQL.Schema

27+

28+-- $setup

29+-- >>> import Squeal.PostgreSQL

30+

31+-- | >>> printSQL $ lower "ARRRGGG"

32+-- lower(E'ARRRGGG')

33+lower :: null 'PGtext --> null 'PGtext

34+lower = unsafeFunction "lower"

35+

36+-- | >>> printSQL $ upper "eeee"

37+-- upper(E'eeee')

38+upper :: null 'PGtext --> null 'PGtext

39+upper = unsafeFunction "upper"

40+

41+-- | >>> printSQL $ charLength "four"

42+-- char_length(E'four')

43+charLength :: null 'PGtext --> null 'PGint4

44+charLength = unsafeFunction "char_length"

45+

46+-- | The `like` expression returns true if the @string@ matches

47+-- the supplied @pattern@. If @pattern@ does not contain percent signs

48+-- or underscores, then the pattern only represents the string itself;

49+-- in that case `like` acts like the equals operator. An underscore (_)

50+-- in pattern stands for (matches) any single character; a percent sign (%)

51+-- matches any sequence of zero or more characters.

52+--

53+-- >>> printSQL $ "abc" `like` "a%"

54+-- (E'abc' LIKE E'a%')

55+like :: Operator (null 'PGtext) (null 'PGtext) ('Null 'PGbool)

56+like = unsafeBinaryOp "LIKE"

57+

58+-- | The key word ILIKE can be used instead of LIKE to make the

59+-- match case-insensitive according to the active locale.

60+--

61+-- >>> printSQL $ "abc" `ilike` "a%"

62+-- (E'abc' ILIKE E'a%')

63+ilike :: Operator (null 'PGtext) (null 'PGtext) ('Null 'PGbool)

64+ilike = unsafeBinaryOp "ILIKE"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/TextSearch.hsnew file+157

@@ -0,0 +1,157 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.TextSearch

3+Description: Text search expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Text search functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , OverloadedStrings

14+ , TypeOperators

15+#-}

16+

17+module Squeal.PostgreSQL.Expression.TextSearch

18+ ( (@@)

19+ , (.&)

20+ , (.|)

21+ , (.!)

22+ , (<->)

23+ , arrayToTSvector

24+ , tsvectorLength

25+ , numnode

26+ , plainToTSquery

27+ , phraseToTSquery

28+ , websearchToTSquery

29+ , queryTree

30+ , toTSquery

31+ , toTSvector

32+ , setWeight

33+ , strip

34+ , jsonToTSvector

35+ , jsonbToTSvector

36+ , tsDelete

37+ , tsFilter

38+ , tsHeadline

39+ ) where

40+

41+import Squeal.PostgreSQL.Expression

42+import Squeal.PostgreSQL.List

43+import Squeal.PostgreSQL.Schema

44+

45+-- | `Squeal.PostgreSQL.Expression.Type.tsvector` matches tsquery ?

46+(@@) :: Operator (null 'PGtsvector) (null 'PGtsquery) ('Null 'PGbool)

47+(@@) = unsafeBinaryOp "@@"

48+

49+-- | AND `Squeal.PostgreSQL.Expression.Type.tsquery`s together

50+(.&) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

51+(.&) = unsafeBinaryOp "&&"

52+

53+-- | OR `Squeal.PostgreSQL.Expression.Type.tsquery`s together

54+(.|) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

55+(.|) = unsafeBinaryOp "||"

56+

57+-- | negate a `Squeal.PostgreSQL.Expression.Type.tsquery`

58+(.!) :: null 'PGtsquery --> null 'PGtsquery

59+(.!) = unsafeLeftOp "!!"

60+

61+-- | `Squeal.PostgreSQL.Expression.Type.tsquery` followed by

62+-- `Squeal.PostgreSQL.Expression.Type.tsquery`

63+(<->) :: Operator (null 'PGtsquery) (null 'PGtsquery) (null 'PGtsquery)

64+(<->) = unsafeBinaryOp "<->"

65+

66+-- | convert array of lexemes to `Squeal.PostgreSQL.Expression.Type.tsvector`

67+arrayToTSvector

68+ :: null ('PGvararray ('NotNull 'PGtext))

69+ --> null 'PGtsvector

70+arrayToTSvector = unsafeFunction "array_to_tsvector"

71+

72+-- | number of lexemes in `Squeal.PostgreSQL.Expression.Type.tsvector`

73+tsvectorLength :: null 'PGtsvector --> null 'PGint4

74+tsvectorLength = unsafeFunction "length"

75+

76+-- | number of lexemes plus operators in `Squeal.PostgreSQL.Expression.Type.tsquery`

77+numnode :: null 'PGtsquery --> null 'PGint4

78+numnode = unsafeFunction "numnode"

79+

80+-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` ignoring punctuation

81+plainToTSquery :: null 'PGtext --> null 'PGtsquery

82+plainToTSquery = unsafeFunction "plainto_tsquery"

83+

84+-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` that searches for a phrase,

85+-- ignoring punctuation

86+phraseToTSquery :: null 'PGtext --> null 'PGtsquery

87+phraseToTSquery = unsafeFunction "phraseto_tsquery"

88+

89+-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` from a web search style query

90+websearchToTSquery :: null 'PGtext --> null 'PGtsquery

91+websearchToTSquery = unsafeFunction "websearch_to_tsquery"

92+

93+-- | get indexable part of a `Squeal.PostgreSQL.Expression.Type.tsquery`

94+queryTree :: null 'PGtsquery --> null 'PGtext

95+queryTree = unsafeFunction "query_tree"

96+

97+-- | normalize words and convert to `Squeal.PostgreSQL.Expression.Type.tsquery`

98+toTSquery :: null 'PGtext --> null 'PGtsquery

99+toTSquery = unsafeFunction "to_tsquery"

100+

101+-- | reduce document text to `Squeal.PostgreSQL.Expression.Type.tsvector`

102+toTSvector

103+ :: ty `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

104+ => null ty --> null 'PGtsvector

105+toTSvector = unsafeFunction "to_tsvector"

106+

107+-- | assign weight to each element of `Squeal.PostgreSQL.Expression.Type.tsvector`

108+setWeight :: '[null 'PGtsvector, null ('PGchar 1)] ---> null 'PGtsvector

109+setWeight = unsafeFunctionN "set_weight"

110+

111+-- | remove positions and weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

112+strip :: null 'PGtsvector --> null 'PGtsvector

113+strip = unsafeFunction "strip"

114+

115+-- | @jsonToTSvector (document *: filter)@

116+-- reduce each value in the document, specified by filter to a `Squeal.PostgreSQL.Expression.Type.tsvector`,

117+-- and then concatenate those in document order to produce a single `Squeal.PostgreSQL.Expression.Type.tsvector`.

118+-- filter is a `Squeal.PostgreSQL.Expression.Type.json` array, that enumerates what kind of elements

119+-- need to be included into the resulting `Squeal.PostgreSQL.Expression.Type.tsvector`.

120+-- Possible values for filter are "string" (to include all string values),

121+-- "numeric" (to include all numeric values in the string format),

122+-- "boolean" (to include all Boolean values in the string format "true"/"false"),

123+-- "key" (to include all keys) or "all" (to include all above).

124+-- These values can be combined together to include, e.g. all string and numeric values.

125+jsonToTSvector :: '[null 'PGjson, null 'PGjson] ---> null 'PGtsvector

126+jsonToTSvector = unsafeFunctionN "json_to_tsvector"

127+

128+-- | @jsonbToTSvector (document *: filter)@

129+-- reduce each value in the document, specified by filter to a `Squeal.PostgreSQL.Expression.Type.tsvector`,

130+-- and then concatenate those in document order to produce a single `Squeal.PostgreSQL.Expression.Type.tsvector`.

131+-- filter is a `Squeal.PostgreSQL.Expression.Type.jsonb` array, that enumerates what kind of elements

132+-- need to be included into the resulting `Squeal.PostgreSQL.Expression.Type.tsvector`.

133+-- Possible values for filter are "string" (to include all string values),

134+-- "numeric" (to include all numeric values in the string format),

135+-- "boolean" (to include all Boolean values in the string format "true"/"false"),

136+-- "key" (to include all keys) or "all" (to include all above).

137+-- These values can be combined together to include, e.g. all string and numeric values.

138+jsonbToTSvector :: '[null 'PGjsonb, null 'PGjsonb] ---> null 'PGtsvector

139+jsonbToTSvector = unsafeFunctionN "jsonb_to_tsvector"

140+

141+-- | remove given lexeme from `Squeal.PostgreSQL.Expression.Type.tsvector`

142+tsDelete ::

143+ '[null 'PGtsvector, null ('PGvararray ('NotNull 'PGtext))]

144+ ---> null 'PGtsvector

145+tsDelete = unsafeFunctionN "ts_delete"

146+

147+-- | select only elements with given weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

148+tsFilter ::

149+ '[null 'PGtsvector, null ('PGvararray ('NotNull ('PGchar 1)))]

150+ ---> null 'PGtsvector

151+tsFilter = unsafeFunctionN "ts_filter"

152+

153+-- | display a `Squeal.PostgreSQL.Expression.Type.tsquery` match

154+tsHeadline

155+ :: document `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

156+ => '[null document, null 'PGtsquery] ---> null 'PGtext

157+tsHeadline = unsafeFunctionN "ts_headline"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Time.hsnew file+192

@@ -0,0 +1,192 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Time

3+Description: Date/Time expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Date/Time functions and operators

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , DeriveGeneric

14+ , FunctionalDependencies

15+ , LambdaCase

16+ , MultiParamTypeClasses

17+ , OverloadedStrings

18+ , PolyKinds

19+ , RankNTypes

20+ , TypeOperators

21+#-}

22+

23+module Squeal.PostgreSQL.Expression.Time

24+ ( TimeOp (..)

25+ , currentDate

26+ , currentTime

27+ , currentTimestamp

28+ , localTime

29+ , localTimestamp

30+ , now

31+ , makeDate

32+ , makeTime

33+ , makeTimestamp

34+ , makeTimestamptz

35+ , interval_

36+ , TimeUnit (..)

37+ ) where

38+

39+import Data.String

40+

41+import qualified GHC.Generics as GHC

42+import qualified Generics.SOP as SOP

43+

44+import Squeal.PostgreSQL.Expression

45+import Squeal.PostgreSQL.Render

46+import Squeal.PostgreSQL.Schema

47+

48+-- $setup

49+-- >>> import Squeal.PostgreSQL

50+

51+-- | >>> printSQL currentDate

52+-- CURRENT_DATE

53+currentDate :: Expr (null 'PGdate)

54+currentDate = UnsafeExpression "CURRENT_DATE"

55+

56+-- | >>> printSQL currentTime

57+-- CURRENT_TIME

58+currentTime :: Expr (null 'PGtimetz)

59+currentTime = UnsafeExpression "CURRENT_TIME"

60+

61+-- | >>> printSQL currentTimestamp

62+-- CURRENT_TIMESTAMP

63+currentTimestamp :: Expr (null 'PGtimestamptz)

64+currentTimestamp = UnsafeExpression "CURRENT_TIMESTAMP"

65+

66+-- | >>> printSQL localTime

67+-- LOCALTIME

68+localTime :: Expr (null 'PGtime)

69+localTime = UnsafeExpression "LOCALTIME"

70+

71+-- | >>> printSQL localTimestamp

72+-- LOCALTIMESTAMP

73+localTimestamp :: Expr (null 'PGtimestamp)

74+localTimestamp = UnsafeExpression "LOCALTIMESTAMP"

75+

76+-- | Current date and time (equivalent to `currentTimestamp`)

77+--

78+-- >>> printSQL now

79+-- now()

80+now :: Expr (null 'PGtimestamptz)

81+now = UnsafeExpression "now()"

82+

83+{-|

84+Create date from year, month and day fields

85+

86+>>> printSQL (makeDate (1984 :* 7 *: 3))

87+make_date(1984, 7, 3)

88+-}

89+makeDate :: '[ null 'PGint4, null 'PGint4, null 'PGint4 ] ---> null 'PGdate

90+makeDate = unsafeFunctionN "make_date"

91+

92+{-|

93+Create time from hour, minute and seconds fields

94+

95+>>> printSQL (makeTime (8 :* 15 *: 23.5))

96+make_time(8, 15, 23.5)

97+-}

98+makeTime :: '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtime

99+makeTime = unsafeFunctionN "make_time"

100+

101+{-|

102+Create timestamp from year, month, day, hour, minute and seconds fields

103+

104+>>> printSQL (makeTimestamp (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

105+make_timestamp(2013, 7, 15, 8, 15, 23.5)

106+-}

107+makeTimestamp ::

108+ '[ null 'PGint4, null 'PGint4, null 'PGint4

109+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamp

110+makeTimestamp = unsafeFunctionN "make_timestamp"

111+

112+{-|

113+Create timestamp with time zone from

114+year, month, day, hour, minute and seconds fields;

115+the current time zone is used

116+

117+>>> printSQL (makeTimestamptz (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

118+make_timestamptz(2013, 7, 15, 8, 15, 23.5)

119+-}

120+makeTimestamptz ::

121+ '[ null 'PGint4, null 'PGint4, null 'PGint4

122+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamptz

123+makeTimestamptz = unsafeFunctionN "make_timestamptz"

124+

125+{-|

126+Affine space operations on time types.

127+-}

128+class TimeOp time diff | time -> diff where

129+ {-|

130+ >>> printSQL (makeDate (1984 :* 7 *: 3) !+ 365)

131+ (make_date(1984, 7, 3) + 365)

132+ -}

133+ (!+) :: Operator (null time) (null diff) (null time)

134+ (!+) = unsafeBinaryOp "+"

135+ {-|

136+ >>> printSQL (365 +! makeDate (1984 :* 7 *: 3))

137+ (365 + make_date(1984, 7, 3))

138+ -}

139+ (+!) :: Operator (null diff) (null time) (null time)

140+ (+!) = unsafeBinaryOp "+"

141+ {-|

142+ >>> printSQL (makeDate (1984 :* 7 *: 3) !- 365)

143+ (make_date(1984, 7, 3) - 365)

144+ -}

145+ (!-) :: Operator (null time) (null diff) (null time)

146+ (!-) = unsafeBinaryOp "-"

147+ {-|

148+ >>> printSQL (makeDate (1984 :* 7 *: 3) !-! currentDate)

149+ (make_date(1984, 7, 3) - CURRENT_DATE)

150+ -}

151+ (!-!) :: Operator (null time) (null time) (null diff)

152+ (!-!) = unsafeBinaryOp "-"

153+instance TimeOp 'PGtimestamp 'PGinterval

154+instance TimeOp 'PGtimestamptz 'PGinterval

155+instance TimeOp 'PGtime 'PGinterval

156+instance TimeOp 'PGtimetz 'PGinterval

157+instance TimeOp 'PGinterval 'PGinterval

158+instance TimeOp 'PGdate 'PGint4

159+infixl 6 !+

160+infixl 6 +!

161+infixl 6 !-

162+infixl 6 !-!

163+

164+-- | A `TimeUnit` to use in `interval_` construction.

165+data TimeUnit

166+ = Years | Months | Weeks | Days

167+ | Hours | Minutes | Seconds

168+ | Microseconds | Milliseconds

169+ | Decades | Centuries | Millennia

170+ deriving (Eq, Ord, Show, Read, Enum, GHC.Generic)

171+instance SOP.Generic TimeUnit

172+instance SOP.HasDatatypeInfo TimeUnit

173+instance RenderSQL TimeUnit where

174+ renderSQL = \case

175+ Years -> "years"

176+ Months -> "months"

177+ Weeks -> "weeks"

178+ Days -> "days"

179+ Hours -> "hours"

180+ Minutes -> "minutes"

181+ Seconds -> "seconds"

182+ Microseconds -> "microseconds"

183+ Milliseconds -> "milliseconds"

184+ Decades -> "decades"

185+ Centuries -> "centuries"

186+ Millennia -> "millennia"

187+

188+-- | >>> printSQL $ interval_ 7 Days

189+-- (INTERVAL '7.0 days')

190+interval_ :: Double -> TimeUnit -> Expr (null 'PGinterval)

191+interval_ num unit = UnsafeExpression . parenthesized $ "INTERVAL" <+>

192+ "'" <> fromString (show num) <+> renderSQL unit <> "'"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Type.hsnew file+446

@@ -0,0 +1,446 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression

3+Description: Type expressions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Type expressions.

9+-}

10+

11+{-# LANGUAGE

12+ AllowAmbiguousTypes

13+ , DataKinds

14+ , DeriveGeneric

15+ , FlexibleContexts

16+ , FlexibleInstances

17+ , GADTs

18+ , GeneralizedNewtypeDeriving

19+ , KindSignatures

20+ , MultiParamTypeClasses

21+ , OverloadedStrings

22+ , RankNTypes

23+ , ScopedTypeVariables

24+ , TypeApplications

25+ , TypeOperators

26+ , UndecidableInstances

27+#-}

28+

29+module Squeal.PostgreSQL.Expression.Type

30+ ( -- * type casting

31+ cast

32+ , astype

33+ , inferredtype

34+ -- * type expressions

35+ , TypeExpression (..)

36+ , typedef

37+ , typetable

38+ , typeview

39+ , bool

40+ , int2

41+ , smallint

42+ , int4

43+ , int

44+ , integer

45+ , int8

46+ , bigint

47+ , numeric

48+ , float4

49+ , real

50+ , float8

51+ , doublePrecision

52+ , money

53+ , text

54+ , char

55+ , character

56+ , varchar

57+ , characterVarying

58+ , bytea

59+ , timestamp

60+ , timestampWithTimeZone

61+ , timestamptz

62+ , date

63+ , time

64+ , timeWithTimeZone

65+ , timetz

66+ , interval

67+ , uuid

68+ , inet

69+ , json

70+ , jsonb

71+ , vararray

72+ , fixarray

73+ , tsvector

74+ , tsquery

75+ , oid

76+ , int4range

77+ , int8range

78+ , numrange

79+ , tsrange

80+ , tstzrange

81+ , daterange

82+ -- * column type definitions

83+ , ColumnTypeExpression (..)

84+ , nullable

85+ , notNullable

86+ , default_

87+ , serial2

88+ , smallserial

89+ , serial4

90+ , serial

91+ , serial8

92+ , bigserial

93+ , hask

94+ -- * type inference

95+ , PGTyped (..)

96+ , PGNullityTyped (..)

97+ , FieldTyped (..)

98+ ) where

99+

100+import Control.DeepSeq

101+import Data.ByteString

102+import Data.String

103+import GHC.TypeLits

104+

105+import qualified Data.ByteString as ByteString

106+import qualified GHC.Generics as GHC

107+import qualified Generics.SOP as SOP

108+

109+import Squeal.PostgreSQL.Alias

110+import Squeal.PostgreSQL.Expression

111+import Squeal.PostgreSQL.PG

112+import Squeal.PostgreSQL.Render

113+import Squeal.PostgreSQL.Schema

114+

115+-- $setup

116+-- >>> import Squeal.PostgreSQL

117+

118+-- When a `cast` is applied to an `Expression` of a known type, it

119+-- represents a run-time type conversion. The cast will succeed only if a

120+-- suitable type conversion operation has been defined.

121+--

122+-- | >>> printSQL $ true & cast int4

123+-- (TRUE :: int4)

124+cast

125+ :: TypeExpression schemas ty1

126+ -- ^ type to cast as

127+ -> Expression outer commons grp schemas params from ty0

128+ -- ^ value to convert

129+ -> Expression outer commons grp schemas params from ty1

130+cast ty x = UnsafeExpression $ parenthesized $

131+ renderSQL x <+> "::" <+> renderSQL ty

132+

133+-- | A safe version of `cast` which just matches a value with its type.

134+--

135+-- >>> printSQL (1 & astype int)

136+-- (1 :: int)

137+astype

138+ :: TypeExpression schemas ty

139+ -- ^ type to specify as

140+ -> Expression outer commons grp schemas params from ty

141+ -- ^ value

142+ -> Expression outer commons grp schemas params from ty

143+astype = cast

144+

145+-- | `inferredtype` will add a type annotation to an `Expression`

146+-- which can be useful for fixing the storage type of a value.

147+--

148+-- >>> printSQL (inferredtype true)

149+-- (TRUE :: bool)

150+inferredtype

151+ :: PGTyped schemas ty

152+ => Expression outer common grp schemas params from ty

153+ -- ^ value

154+ -> Expression outer common grp schemas params from ty

155+inferredtype = astype pgtype

156+

157+{-----------------------------------------

158+type expressions

159+-----------------------------------------}

160+

161+-- | `TypeExpression`s are used in `cast`s and

162+-- `Squeal.PostgreSQL.Definition.createTable` commands.

163+newtype TypeExpression (schemas :: SchemasType) (ty :: NullityType)

164+ = UnsafeTypeExpression { renderTypeExpression :: ByteString }

165+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

166+instance RenderSQL (TypeExpression schemas ty) where

167+ renderSQL = renderTypeExpression

168+

169+-- | The enum or composite type in a `Typedef` can be expressed by its alias.

170+typedef

171+ :: (Has sch schemas schema, Has td schema ('Typedef ty))

172+ => QualifiedAlias sch td

173+ -- ^ type alias

174+ -> TypeExpression schemas (null ty)

175+typedef = UnsafeTypeExpression . renderSQL

176+

177+-- | The composite type corresponding to a `Table` definition can be expressed

178+-- by its alias.

179+typetable

180+ :: (Has sch schemas schema, Has tab schema ('Table table))

181+ => QualifiedAlias sch tab

182+ -- ^ table alias

183+ -> TypeExpression schemas (null ('PGcomposite (TableToRow table)))

184+typetable = UnsafeTypeExpression . renderSQL

185+

186+-- | The composite type corresponding to a `View` definition can be expressed

187+-- by its alias.

188+typeview

189+ :: (Has sch schemas schema, Has vw schema ('View view))

190+ => QualifiedAlias sch vw

191+ -- ^ view alias

192+ -> TypeExpression schemas (null ('PGcomposite view))

193+typeview = UnsafeTypeExpression . renderSQL

194+

195+-- | logical Boolean (true/false)

196+bool :: TypeExpression schemas (null 'PGbool)

197+bool = UnsafeTypeExpression "bool"

198+-- | signed two-byte integer

199+int2, smallint :: TypeExpression schemas (null 'PGint2)

200+int2 = UnsafeTypeExpression "int2"

201+smallint = UnsafeTypeExpression "smallint"

202+-- | signed four-byte integer

203+int4, int, integer :: TypeExpression schemas (null 'PGint4)

204+int4 = UnsafeTypeExpression "int4"

205+int = UnsafeTypeExpression "int"

206+integer = UnsafeTypeExpression "integer"

207+-- | signed eight-byte integer

208+int8, bigint :: TypeExpression schemas (null 'PGint8)

209+int8 = UnsafeTypeExpression "int8"

210+bigint = UnsafeTypeExpression "bigint"

211+-- | arbitrary precision numeric type

212+numeric :: TypeExpression schemas (null 'PGnumeric)

213+numeric = UnsafeTypeExpression "numeric"

214+-- | single precision floating-point number (4 bytes)

215+float4, real :: TypeExpression schemas (null 'PGfloat4)

216+float4 = UnsafeTypeExpression "float4"

217+real = UnsafeTypeExpression "real"

218+-- | double precision floating-point number (8 bytes)

219+float8, doublePrecision :: TypeExpression schemas (null 'PGfloat8)

220+float8 = UnsafeTypeExpression "float8"

221+doublePrecision = UnsafeTypeExpression "double precision"

222+-- | currency amount

223+money :: TypeExpression schema (null 'PGmoney)

224+money = UnsafeTypeExpression "money"

225+-- | variable-length character string

226+text :: TypeExpression schemas (null 'PGtext)

227+text = UnsafeTypeExpression "text"

228+-- | fixed-length character string

229+char, character

230+ :: forall n schemas null. (KnownNat n, 1 <= n)

231+ => TypeExpression schemas (null ('PGchar n))

232+char = UnsafeTypeExpression $ "char(" <> renderNat @n <> ")"

233+character = UnsafeTypeExpression $ "character(" <> renderNat @n <> ")"

234+-- | variable-length character string

235+varchar, characterVarying

236+ :: forall n schemas null. (KnownNat n, 1 <= n)

237+ => TypeExpression schemas (null ('PGvarchar n))

238+varchar = UnsafeTypeExpression $ "varchar(" <> renderNat @n <> ")"

239+characterVarying = UnsafeTypeExpression $

240+ "character varying(" <> renderNat @n <> ")"

241+-- | binary data ("byte array")

242+bytea :: TypeExpression schemas (null 'PGbytea)

243+bytea = UnsafeTypeExpression "bytea"

244+-- | date and time (no time zone)

245+timestamp :: TypeExpression schemas (null 'PGtimestamp)

246+timestamp = UnsafeTypeExpression "timestamp"

247+-- | date and time, including time zone

248+timestampWithTimeZone, timestamptz :: TypeExpression schemas (null 'PGtimestamptz)

249+timestampWithTimeZone = UnsafeTypeExpression "timestamp with time zone"

250+timestamptz = UnsafeTypeExpression "timestamptz"

251+-- | calendar date (year, month, day)

252+date :: TypeExpression schemas (null 'PGdate)

253+date = UnsafeTypeExpression "date"

254+-- | time of day (no time zone)

255+time :: TypeExpression schemas (null 'PGtime)

256+time = UnsafeTypeExpression "time"

257+-- | time of day, including time zone

258+timeWithTimeZone, timetz :: TypeExpression schemas (null 'PGtimetz)

259+timeWithTimeZone = UnsafeTypeExpression "time with time zone"

260+timetz = UnsafeTypeExpression "timetz"

261+-- | time span

262+interval :: TypeExpression schemas (null 'PGinterval)

263+interval = UnsafeTypeExpression "interval"

264+-- | universally unique identifier

265+uuid :: TypeExpression schemas (null 'PGuuid)

266+uuid = UnsafeTypeExpression "uuid"

267+-- | IPv4 or IPv6 host address

268+inet :: TypeExpression schemas (null 'PGinet)

269+inet = UnsafeTypeExpression "inet"

270+-- | textual JSON data

271+json :: TypeExpression schemas (null 'PGjson)

272+json = UnsafeTypeExpression "json"

273+-- | binary JSON data, decomposed

274+jsonb :: TypeExpression schemas (null 'PGjsonb)

275+jsonb = UnsafeTypeExpression "jsonb"

276+-- | variable length array

277+vararray

278+ :: TypeExpression schemas pg

279+ -> TypeExpression schemas (null ('PGvararray pg))

280+vararray ty = UnsafeTypeExpression $ renderSQL ty <> "[]"

281+-- | fixed length array

282+--

283+-- >>> renderSQL (fixarray @'[2] json)

284+-- "json[2]"

285+fixarray

286+ :: forall dims schemas null pg. SOP.All KnownNat dims

287+ => TypeExpression schemas pg

288+ -> TypeExpression schemas (null ('PGfixarray dims pg))

289+fixarray ty = UnsafeTypeExpression $

290+ renderSQL ty <> renderDims @dims

291+ where

292+ renderDims :: forall ns. SOP.All KnownNat ns => ByteString

293+ renderDims =

294+ ("[" <>)

295+ . (<> "]")

296+ . ByteString.intercalate "]["

297+ . SOP.hcollapse

298+ $ SOP.hcmap (SOP.Proxy @KnownNat)

299+ (K . fromString . show . natVal)

300+ (SOP.hpure SOP.Proxy :: SOP.NP SOP.Proxy ns)

301+-- | text search query

302+tsvector :: TypeExpression schemas (null 'PGtsvector)

303+tsvector = UnsafeTypeExpression "tsvector"

304+-- | text search document

305+tsquery :: TypeExpression schemas (null 'PGtsquery)

306+tsquery = UnsafeTypeExpression "tsquery"

307+-- | Object identifiers (OIDs) are used internally by PostgreSQL

308+-- as primary keys for various system tables.

309+oid :: TypeExpression schemas (null 'PGoid)

310+oid = UnsafeTypeExpression "oid"

311+-- | Range of integer

312+int4range :: TypeExpression schemas (null ('PGrange 'PGint4))

313+int4range = UnsafeTypeExpression "int4range"

314+-- | Range of bigint

315+int8range :: TypeExpression schemas (null ('PGrange 'PGint8))

316+int8range = UnsafeTypeExpression "int8range"

317+-- | Range of numeric

318+numrange :: TypeExpression schemas (null ('PGrange 'PGnumeric))

319+numrange = UnsafeTypeExpression "numrange"

320+-- | Range of timestamp without time zone

321+tsrange :: TypeExpression schemas (null ('PGrange 'PGtimestamp))

322+tsrange = UnsafeTypeExpression "tsrange"

323+-- | Range of timestamp with time zone

324+tstzrange :: TypeExpression schemas (null ('PGrange 'PGtimestamptz))

325+tstzrange = UnsafeTypeExpression "tstzrange"

326+-- | Range of date

327+daterange :: TypeExpression schemas (null ('PGrange 'PGdate))

328+daterange = UnsafeTypeExpression "daterange"

329+

330+-- | `pgtype` is a demoted version of a `PGType`

331+class PGTyped schemas (ty :: NullityType) where

332+ pgtype :: TypeExpression schemas ty

333+instance PGTyped schemas (null 'PGbool) where pgtype = bool

334+instance PGTyped schemas (null 'PGint2) where pgtype = int2

335+instance PGTyped schemas (null 'PGint4) where pgtype = int4

336+instance PGTyped schemas (null 'PGint8) where pgtype = int8

337+instance PGTyped schemas (null 'PGnumeric) where pgtype = numeric

338+instance PGTyped schemas (null 'PGfloat4) where pgtype = float4

339+instance PGTyped schemas (null 'PGfloat8) where pgtype = float8

340+instance PGTyped schemas (null 'PGmoney) where pgtype = money

341+instance PGTyped schemas (null 'PGtext) where pgtype = text

342+instance (KnownNat n, 1 <= n)

343+ => PGTyped schemas (null ('PGchar n)) where pgtype = char @n

344+instance (KnownNat n, 1 <= n)

345+ => PGTyped schemas (null ('PGvarchar n)) where pgtype = varchar @n

346+instance PGTyped schemas (null 'PGbytea) where pgtype = bytea

347+instance PGTyped schemas (null 'PGtimestamp) where pgtype = timestamp

348+instance PGTyped schemas (null 'PGtimestamptz) where pgtype = timestampWithTimeZone

349+instance PGTyped schemas (null 'PGdate) where pgtype = date

350+instance PGTyped schemas (null 'PGtime) where pgtype = time

351+instance PGTyped schemas (null 'PGtimetz) where pgtype = timeWithTimeZone

352+instance PGTyped schemas (null 'PGinterval) where pgtype = interval

353+instance PGTyped schemas (null 'PGuuid) where pgtype = uuid

354+instance PGTyped schemas (null 'PGjson) where pgtype = json

355+instance PGTyped schemas (null 'PGjsonb) where pgtype = jsonb

356+instance PGTyped schemas ty

357+ => PGTyped schemas (null ('PGvararray ty)) where

358+ pgtype = vararray (pgtype @schemas @ty)

359+instance (SOP.All KnownNat dims, PGTyped schemas ty)

360+ => PGTyped schemas (null ('PGfixarray dims ty)) where

361+ pgtype = fixarray @dims (pgtype @schemas @ty)

362+instance PGTyped schemas (null 'PGtsvector) where pgtype = tsvector

363+instance PGTyped schemas (null 'PGtsquery) where pgtype = tsquery

364+instance PGTyped schemas (null 'PGoid) where pgtype = oid

365+instance PGTyped schemas (null ('PGrange 'PGint4)) where pgtype = int4range

366+instance PGTyped schemas (null ('PGrange 'PGint8)) where pgtype = int8range

367+instance PGTyped schemas (null ('PGrange 'PGnumeric)) where pgtype = numrange

368+instance PGTyped schemas (null ('PGrange 'PGtimestamp)) where pgtype = tsrange

369+instance PGTyped schemas (null ('PGrange 'PGtimestamptz)) where pgtype = tstzrange

370+instance PGTyped schemas (null ('PGrange 'PGdate)) where pgtype = daterange

371+

372+-- | Lift `PGTyped` to a field

373+class FieldTyped schemas ty where

374+ fieldtype :: Aliased (TypeExpression schemas) ty

375+instance (KnownSymbol alias, PGTyped schemas ty)

376+ => FieldTyped schemas (alias ::: ty) where

377+ fieldtype = pgtype `As` Alias

378+

379+-- | `ColumnTypeExpression`s are used in `createTable` commands.

380+newtype ColumnTypeExpression (schemas :: SchemasType) (ty :: ColumnType)

381+ = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }

382+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

383+instance RenderSQL (ColumnTypeExpression schemas ty) where

384+ renderSQL = renderColumnTypeExpression

385+

386+-- | used in `createTable` commands as a column constraint to note that

387+-- @NULL@ may be present in a column

388+nullable

389+ :: TypeExpression schemas (nullity ty)

390+ -> ColumnTypeExpression schemas ('NoDef :=> 'Null ty)

391+nullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NULL"

392+

393+-- | used in `createTable` commands as a column constraint to ensure

394+-- @NULL@ is not present in a column

395+notNullable

396+ :: TypeExpression schemas (nullity ty)

397+ -> ColumnTypeExpression schemas ('NoDef :=> 'NotNull ty)

398+notNullable ty = UnsafeColumnTypeExpression $ renderSQL ty <+> "NOT NULL"

399+

400+-- | used in `createTable` commands as a column constraint to give a default

401+default_

402+ :: Expression '[] '[] 'Ungrouped schemas '[] '[] ty

403+ -> ColumnTypeExpression schemas ('NoDef :=> ty)

404+ -> ColumnTypeExpression schemas ('Def :=> ty)

405+default_ x ty = UnsafeColumnTypeExpression $

406+ renderSQL ty <+> "DEFAULT" <+> renderExpression x

407+

408+-- | not a true type, but merely a notational convenience for creating

409+-- unique identifier columns with type `PGint2`

410+serial2, smallserial

411+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)

412+serial2 = UnsafeColumnTypeExpression "serial2"

413+smallserial = UnsafeColumnTypeExpression "smallserial"

414+-- | not a true type, but merely a notational convenience for creating

415+-- unique identifier columns with type `PGint4`

416+serial4, serial

417+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)

418+serial4 = UnsafeColumnTypeExpression "serial4"

419+serial = UnsafeColumnTypeExpression "serial"

420+-- | not a true type, but merely a notational convenience for creating

421+-- unique identifier columns with type `PGint8`

422+serial8, bigserial

423+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)

424+serial8 = UnsafeColumnTypeExpression "serial8"

425+bigserial = UnsafeColumnTypeExpression "bigserial"

426+

427+-- | Like @PGTyped@ but also accounts for nullity.

428+class PGNullityTyped schemas (nullty :: NullityType) where

429+ pgNullityType :: ColumnTypeExpression schemas ('NoDef :=> nullty)

430+

431+instance PGTyped schemas ('Null ty) => PGNullityTyped schemas ('Null ty) where

432+ pgNullityType = nullable (pgtype @_ @('Null ty))

433+

434+instance PGTyped schemas ('NotNull ty) => PGNullityTyped schemas ('NotNull ty) where

435+ pgNullityType = notNullable (pgtype @_ @('NotNull ty))

436+

437+-- | Allow you to specify pg column types in relation to haskell types.

438+-- >>> printSQL $ hask @(Maybe String)

439+-- text NULL

440+--

441+-- >>> printSQL $ hask @Double

442+-- float8 NOT NULL

443+hask

444+ :: forall hask schemas. PGNullityTyped schemas (NullPG hask)

445+ => ColumnTypeExpression schemas ('NoDef :=> NullPG hask)

446+hask = pgNullityType

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Window.hsnew file+284

@@ -0,0 +1,284 @@

1+{-|

2+Module: Squeal.PostgreSQL.Expression.Window

3+Description: Window functions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Window functions and definitions

9+-}

10+

11+{-# LANGUAGE

12+ DataKinds

13+ , DeriveGeneric

14+ , FlexibleContexts

15+ , FlexibleInstances

16+ , GADTs

17+ , GeneralizedNewtypeDeriving

18+ , LambdaCase

19+ , MultiParamTypeClasses

20+ , OverloadedStrings

21+ , RankNTypes

22+ , KindSignatures

23+#-}

24+

25+module Squeal.PostgreSQL.Expression.Window

26+ ( -- * functions

27+ partitionBy

28+ , rank

29+ , rowNumber

30+ , denseRank

31+ , percentRank

32+ , cumeDist

33+ , ntile

34+ , lag

35+ , lead

36+ , firstValue

37+ , lastValue

38+ , nthValue

39+ , unsafeWindowFunction1

40+ , unsafeWindowFunctionN

41+ -- * types

42+ , WindowFunction (..)

43+ , WindowDefinition (..)

44+ , WinFun0

45+ , WinFun1

46+ , WinFunN

47+ ) where

48+

49+import Control.DeepSeq

50+import Data.ByteString

51+

52+import qualified GHC.Generics as GHC

53+import qualified Generics.SOP as SOP

54+

55+import Squeal.PostgreSQL.Alias

56+import Squeal.PostgreSQL.Expression

57+import Squeal.PostgreSQL.Expression.Aggregate

58+import Squeal.PostgreSQL.Expression.Sort

59+import Squeal.PostgreSQL.List

60+import Squeal.PostgreSQL.Render

61+import Squeal.PostgreSQL.Schema

62+

63+instance Aggregate

64+ (Expression outer commons grp schemas params from)

65+ (NP (Expression outer commons grp schemas params from))

66+ (WindowFunction outer commons grp schemas params from) where

67+ countStar = UnsafeWindowFunction "count(*)"

68+ count = unsafeWindowFunction1 "count"

69+ sum_ = unsafeWindowFunction1 "sum"

70+ arrayAgg = unsafeWindowFunction1 "array_agg"

71+ jsonAgg = unsafeWindowFunction1 "json_agg"

72+ jsonbAgg = unsafeWindowFunction1 "jsonb_agg"

73+ bitAnd = unsafeWindowFunction1 "bit_and"

74+ bitOr = unsafeWindowFunction1 "bit_or"

75+ boolAnd = unsafeWindowFunction1 "bool_and"

76+ boolOr = unsafeWindowFunction1 "bool_or"

77+ every = unsafeWindowFunction1 "every"

78+ max_ = unsafeWindowFunction1 "max"

79+ min_ = unsafeWindowFunction1 "min"

80+ avg = unsafeWindowFunction1 "avg"

81+ corr = unsafeWindowFunctionN "corr"

82+ covarPop = unsafeWindowFunctionN "covar_pop"

83+ covarSamp = unsafeWindowFunctionN "covar_samp"

84+ regrAvgX = unsafeWindowFunctionN "regr_avgx"

85+ regrAvgY = unsafeWindowFunctionN "regr_avgy"

86+ regrCount = unsafeWindowFunctionN "regr_count"

87+ regrIntercept = unsafeWindowFunctionN "regr_intercept"

88+ regrR2 = unsafeWindowFunctionN "regr_r2"

89+ regrSlope = unsafeWindowFunctionN "regr_slope"

90+ regrSxx = unsafeWindowFunctionN "regr_sxx"

91+ regrSxy = unsafeWindowFunctionN "regr_sxy"

92+ regrSyy = unsafeWindowFunctionN "regr_syy"

93+ stddev = unsafeWindowFunction1 "stddev"

94+ stddevPop = unsafeWindowFunction1 "stddev_pop"

95+ stddevSamp = unsafeWindowFunction1 "stddev_samp"

96+ variance = unsafeWindowFunction1 "variance"

97+ varPop = unsafeWindowFunction1 "var_pop"

98+ varSamp = unsafeWindowFunction1 "var_samp"

99+

100+-- | A `WindowDefinition` is a set of table rows that are somehow related

101+-- to the current row

102+data WindowDefinition outer commons grp schemas params from where

103+ WindowDefinition

104+ :: SOP.SListI bys

105+ => NP (Expression outer commons grp schemas params from) bys

106+ -- ^ `partitionBy` clause

107+ -> [SortExpression outer commons grp schemas params from]

108+ -- ^ `Squeal.PostgreSQL.Expression.Sort.orderBy` clause

109+ -> WindowDefinition outer commons grp schemas params from

110+

111+instance OrderBy WindowDefinition where

112+ orderBy sortsR (WindowDefinition parts sortsL)

113+ = WindowDefinition parts (sortsL ++ sortsR)

114+

115+instance RenderSQL (WindowDefinition outer commons schemas from grp params) where

116+ renderSQL (WindowDefinition part ord) =

117+ renderPartitionByClause part <> renderOrderByClause ord

118+ where

119+ renderPartitionByClause = \case

120+ Nil -> ""

121+ parts -> "PARTITION" <+> "BY" <+> renderCommaSeparated renderExpression parts

122+ renderOrderByClause = \case

123+ [] -> ""

124+ srts -> " ORDER" <+> "BY"

125+ <+> commaSeparated (renderSQL <$> srts)

126+

127+{- |

128+The `partitionBy` clause within `Squeal.PostgreSQL.Query.Over` divides the rows into groups,

129+or partitions, that share the same values of the `partitionBy` `Expression`(s).

130+For each row, the window function is computed across the rows that fall into

131+the same partition as the current row.

132+-}

133+partitionBy

134+ :: SOP.SListI bys

135+ => NP (Expression outer commons grp schemas params from) bys -- ^ partitions

136+ -> WindowDefinition outer commons grp schemas params from

137+partitionBy bys = WindowDefinition bys []

138+

139+{- |

140+A window function performs a calculation across a set of table rows

141+that are somehow related to the current row. This is comparable to the type

142+of calculation that can be done with an aggregate function.

143+However, window functions do not cause rows to become grouped into a single

144+output row like non-window aggregate calls would.

145+Instead, the rows retain their separate identities.

146+Behind the scenes, the window function is able to access more than

147+just the current row of the query result.

148+-}

149+newtype WindowFunction

150+ (outer :: FromType)

151+ (commons :: FromType)

152+ (grp :: Grouping)

153+ (schemas :: SchemasType)

154+ (params :: [NullityType])

155+ (from :: FromType)

156+ (ty :: NullityType)

157+ = UnsafeWindowFunction { renderWindowFunction :: ByteString }

158+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

159+

160+instance RenderSQL (WindowFunction outer commons grp schemas params from ty) where

161+ renderSQL = renderWindowFunction

162+

163+{- |

164+A @RankNType@ for window functions with no arguments.

165+-}

166+type WinFun0 x

167+ = forall outer commons grp schemas params from

168+ . WindowFunction outer commons grp schemas params from x

169+ -- ^ cannot reference aliases

170+

171+{- |

172+A @RankNType@ for window functions with 1 argument.

173+-}

174+type WinFun1 x y

175+ = forall outer commons grp schemas params from

176+ . Expression outer commons grp schemas params from x

177+ -- ^ input

178+ -> WindowFunction outer commons grp schemas params from y

179+ -- ^ output

180+

181+{- | A @RankNType@ for window functions with a fixed-length

182+list of heterogeneous arguments.

183+Use the `*:` operator to end your argument lists.

184+-}

185+type WinFunN xs y

186+ = forall outer commons grp schemas params from

187+ . NP (Expression outer commons grp schemas params from) xs

188+ -- ^ inputs

189+ -> WindowFunction outer commons grp schemas params from y

190+ -- ^ output

191+

192+-- | escape hatch for defining window functions

193+unsafeWindowFunction1 :: ByteString -> WinFun1 x y

194+unsafeWindowFunction1 fun x

195+ = UnsafeWindowFunction $ fun <> parenthesized (renderSQL x)

196+

197+-- | escape hatch for defining multi-argument window functions

198+unsafeWindowFunctionN :: SOP.SListI xs => ByteString -> WinFunN xs y

199+unsafeWindowFunctionN fun xs = UnsafeWindowFunction $ fun <>

200+ parenthesized (renderCommaSeparated renderSQL xs)

201+

202+{- | rank of the current row with gaps; same as `rowNumber` of its first peer

203+

204+>>> printSQL rank

205+rank()

206+-}

207+rank :: WinFun0 ('NotNull 'PGint8)

208+rank = UnsafeWindowFunction "rank()"

209+

210+{- | number of the current row within its partition, counting from 1

211+

212+>>> printSQL rowNumber

213+row_number()

214+-}

215+rowNumber :: WinFun0 ('NotNull 'PGint8)

216+rowNumber = UnsafeWindowFunction "row_number()"

217+

218+{- | rank of the current row without gaps; this function counts peer groups

219+

220+>>> printSQL denseRank

221+dense_rank()

222+-}

223+denseRank :: WinFun0 ('NotNull 'PGint8)

224+denseRank = UnsafeWindowFunction "dense_rank()"

225+

226+{- | relative rank of the current row: (rank - 1) / (total partition rows - 1)

227+

228+>>> printSQL percentRank

229+percent_rank()

230+-}

231+percentRank :: WinFun0 ('NotNull 'PGfloat8)

232+percentRank = UnsafeWindowFunction "percent_rank()"

233+

234+{- | cumulative distribution: (number of partition rows

235+preceding or peer with current row) / total partition rows

236+

237+>>> printSQL cumeDist

238+cume_dist()

239+-}

240+cumeDist :: WinFun0 ('NotNull 'PGfloat8)

241+cumeDist = UnsafeWindowFunction "cume_dist()"

242+

243+{- | integer ranging from 1 to the argument value,

244+dividing the partition as equally as possible

245+

246+>>> printSQL $ ntile 5

247+ntile(5)

248+-}

249+ntile :: WinFun1 ('NotNull 'PGint4) ('NotNull 'PGint4)

250+ntile = unsafeWindowFunction1 "ntile"

251+

252+{- | returns value evaluated at the row that is offset rows before the current

253+row within the partition; if there is no such row, instead return default

254+(which must be of the same type as value). Both offset and default are

255+evaluated with respect to the current row.

256+-}

257+lag :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

258+lag = unsafeWindowFunctionN "lag"

259+

260+{- | returns value evaluated at the row that is offset rows after the current

261+row within the partition; if there is no such row, instead return default

262+(which must be of the same type as value). Both offset and default are

263+evaluated with respect to the current row.

264+-}

265+lead :: WinFunN '[ty, 'NotNull 'PGint4, ty] ty

266+lead = unsafeWindowFunctionN "lead"

267+

268+{- | returns value evaluated at the row that is the

269+first row of the window frame

270+-}

271+firstValue :: WinFun1 ty ty

272+firstValue = unsafeWindowFunction1 "first_value"

273+

274+{- | returns value evaluated at the row that is the

275+last row of the window frame

276+-}

277+lastValue :: WinFun1 ty ty

278+lastValue = unsafeWindowFunction1 "last_value"

279+

280+{- | returns value evaluated at the row that is the nth

281+row of the window frame (counting from 1); null if no such row

282+-}

283+nthValue :: WinFunN '[null ty, 'NotNull 'PGint4] ('Null ty)

284+nthValue = unsafeWindowFunctionN "nth_value"

squeal-postgresql/src/Squeal/PostgreSQL/List.hsnew file+112

@@ -0,0 +1,112 @@

1+{-|

2+Module: Squeal.PostgreSQL.List

3+Description: List related types and functions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Haskell singly-linked lists are very powerful. This module

9+provides functionality for type-level lists, heterogeneous

10+lists and type aligned lists.

11+-}

12+

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+290−315

@@ -18,9 +18,11 @@ Squeal data manipulation language.

18 , MultiParamTypeClasses

19 , OverloadedStrings

20 , PatternSynonyms

21+ , QuantifiedConstraints

21 , RankNTypes

22 , RankNTypes

22 , ScopedTypeVariables

23 , ScopedTypeVariables

23 , TypeApplications

24 , TypeApplications

25+ , TypeFamilies

24 , TypeInType

26 , TypeInType

25 , TypeOperators

27 , TypeOperators

26 , UndecidableInstances

28 , UndecidableInstances

@@ -28,59 +30,107 @@ Squeal data manipulation language.

29module Squeal.PostgreSQL.Manipulation

31module Squeal.PostgreSQL.Manipulation

30 ( -- * Manipulation

32 ( -- * Manipulation

33+ Manipulation_

31− Manipulation (..)

34+ , Manipulation (..)

32 , queryStatement

35 , queryStatement

33− , QueryClause (..)

34− , pattern Values_

35− , DefaultAliasable (..)

36− , ColumnExpression (..)

37− , ReturningClause (..)

38− , ConflictClause (..)

39− , ConflictTarget (..)

40− , ConflictAction (..)

41− , UsingClause (..)

42 -- * Insert

36 -- * Insert

43 , insertInto

37 , insertInto

44 , insertInto_

38 , insertInto_

45− , renderReturningClause

46− , renderConflictClause

47− , renderConflictTarget

48− , renderConflictAction

49 -- * Update

39 -- * Update

50 , update

40 , update

51 , update_

41 , update_

52 -- * Delete

42 -- * Delete

53 , deleteFrom

43 , deleteFrom

54 , deleteFrom_

44 , deleteFrom_

55− , also

45+ -- * Clauses

46+ , Optional (..)

47+ , QueryClause (..)

48+ , pattern Values_

49+ , ReturningClause (..)

50+ , pattern Returning_

51+ , ConflictClause (..)

52+ , ConflictTarget (..)

53+ , ConflictAction (..)

54+ , UsingClause (..)

56 ) where

55 ) where

58import Control.DeepSeq

57import Control.DeepSeq

59import Data.ByteString hiding (foldr)

58import Data.ByteString hiding (foldr)

60−import GHC.TypeLits (KnownSymbol)

59+import Data.Kind (Type)

62import qualified Generics.SOP as SOP

61import qualified Generics.SOP as SOP

63import qualified GHC.Generics as GHC

62import qualified GHC.Generics as GHC

64+import Squeal.PostgreSQL.Alias

65import Squeal.PostgreSQL.Expression

66+import Squeal.PostgreSQL.Expression.Logic

67+import Squeal.PostgreSQL.List

68+import Squeal.PostgreSQL.PG

66import Squeal.PostgreSQL.Render

69import Squeal.PostgreSQL.Render

67import Squeal.PostgreSQL.Query

70import Squeal.PostgreSQL.Query

68import Squeal.PostgreSQL.Schema

71import Squeal.PostgreSQL.Schema

73+-- $setup

74+-- >>> import Squeal.PostgreSQL

75+-- >>> import Data.Int

76+-- >>> import Data.Time

77+

70{- |

78{- |

71A `Manipulation` is a statement which may modify data in the database,

79A `Manipulation` is a statement which may modify data in the database,

72but does not alter its schemas. Examples are inserts, updates and deletes.

80but does not alter its schemas. Examples are inserts, updates and deletes.

73A `Query` is also considered a `Manipulation` even though it does not modify data.

81A `Query` is also considered a `Manipulation` even though it does not modify data.

83+The general `Manipulation` type is parameterized by

84+

85+* @commons :: FromType@ - scope for all `common` table expressions,

86+* @schemas :: SchemasType@ - scope for all `table`s and `view`s,

87+* @params :: [NullityType]@ - scope for all `Squeal.Expression.Parameter.parameter`s,

88+* @row :: RowType@ - return type of the `Query`.

89+-}

90+newtype Manipulation

91+ (commons :: FromType)

92+ (schemas :: SchemasType)

93+ (params :: [NullityType])

94+ (columns :: RowType)

95+ = UnsafeManipulation { renderManipulation :: ByteString }

96+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

97+instance RenderSQL (Manipulation commons schemas params columns) where

98+ renderSQL = renderManipulation

99+instance With Manipulation where

100+ with Done manip = manip

101+ with ctes manip = UnsafeManipulation $

102+ "WITH" <+> commaSeparated (ctoList renderSQL ctes) <+> renderSQL manip

103+

104+{- |

105+The top level `Manipulation_` type is parameterized by a @schemas@ `SchemasType`,

106+against which the query is type-checked, an input @parameters@ Haskell `Type`,

107+and an ouput row Haskell `Type`.

108+

109+A top-level `Manipulation_` can be run

110+using `Squeal.PostgreSQL.PQ.manipulateParams`, or if @parameters = ()@

111+using `Squeal.PostgreSQL.PQ.manipulate`.

112+

113+Generally, @parameters@ will be a Haskell tuple or record whose entries

114+may be referenced using positional

115+`Squeal.PostgreSQL.Expression.Parameter.parameter`s and @row@ will be a

116+Haskell record, whose entries will be targeted using overloaded labels.

117+

118+>>> :set -XDeriveAnyClass -XDerivingStrategies

119+>>> :{

120+data Row a b = Row { col1 :: a, col2 :: b }

121+ deriving stock (GHC.Generic)

122+ deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)

123+:}

124+

75simple insert:

125simple insert:

126

77>>> type Columns = '["col1" ::: 'NoDef :=> 'Null 'PGint4, "col2" ::: 'Def :=> 'NotNull 'PGint4]

127>>> type Columns = '["col1" ::: 'NoDef :=> 'Null 'PGint4, "col2" ::: 'Def :=> 'NotNull 'PGint4]

78>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

128>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

79>>> :{

129>>> :{

80let

130let

81− manipulation :: Manipulation (DBof (Public Schema)) '[] '[]

131+ manipulation :: Manipulation_ (Public Schema) () ()

82 manipulation =

132 manipulation =

83− insertInto_ #tab (Values_ (2 `as` #col1 :* defaultAs #col2))

133+ insertInto_ #tab (Values_ (Set 2 `as` #col1 :* Default `as` #col2))

84in printSQL manipulation

134in printSQL manipulation

85:}

135:}

86INSERT INTO "tab" ("col1", "col2") VALUES (2, DEFAULT)

136INSERT INTO "tab" ("col1", "col2") VALUES (2, DEFAULT)

@@ -91,9 +141,9 @@ parameterized insert:

91>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

141>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

92>>> :{

142>>> :{

93let

143let

94− manipulation :: Manipulation (DBof (Public Schema)) '[ 'NotNull 'PGint4, 'NotNull 'PGint4 ] '[]

144+ manipulation :: Manipulation_ (Public Schema) (Int32, Int32) ()

95 manipulation =

145 manipulation =

96− insertInto_ #tab (Values_ (param @1 `as` #col1 :* param @2 `as` #col2))

146+ insertInto_ #tab (Values_ (Set (param @1) `as` #col1 :* Set (param @2) `as` #col2))

97in printSQL manipulation

147in printSQL manipulation

98:}

148:}

99INSERT INTO "tab" ("col1", "col2") VALUES (($1 :: int4), ($2 :: int4))

149INSERT INTO "tab" ("col1", "col2") VALUES (($1 :: int4), ($2 :: int4))

@@ -102,9 +152,9 @@ returning insert:

102

152

103>>> :{

153>>> :{

104let

154let

105− manipulation :: Manipulation (DBof (Public Schema)) '[] '["fromOnly" ::: 'NotNull 'PGint4]

155+ manipulation :: Manipulation_ (Public Schema) () (Only Int32)

106 manipulation =

156 manipulation =

107− insertInto #tab (Values_ (2 `as` #col1 :* 3 `as` #col2))

157+ insertInto #tab (Values_ (Set 2 `as` #col1 :* Set 3 `as` #col2))

108 OnConflictDoRaise (Returning (#col1 `as` #fromOnly))

158 OnConflictDoRaise (Returning (#col1 `as` #fromOnly))

109in printSQL manipulation

159in printSQL manipulation

110:}

160:}

@@ -117,13 +167,13 @@ upsert:

117>>> type CustomersSchema = '["customers" ::: 'Table (CustomersConstraints :=> CustomersColumns)]

167>>> type CustomersSchema = '["customers" ::: 'Table (CustomersConstraints :=> CustomersColumns)]

118>>> :{

168>>> :{

119let

169let

120− manipulation :: Manipulation (DBof (Public CustomersSchema)) '[] '[]

170+ manipulation :: Manipulation_ (Public CustomersSchema) () ()

121 manipulation =

171 manipulation =

122 insertInto #customers

172 insertInto #customers

123− (Values_ ("John Smith" `as` #name :* "john@smith.com" `as` #email))

173+ (Values_ (Set "John Smith" `as` #name :* Set "john@smith.com" `as` #email))

124 (OnConflict (OnConstraint #uq)

174 (OnConflict (OnConstraint #uq)

125− (DoUpdate (((#excluded ! #email) <> "; " <> (#customers ! #email)) `as` #email) []))

175+ (DoUpdate (Set (#excluded ! #email <> "; " <> #customers ! #email) `as` #email) []))

126− (Returning Nil)

176+ (Returning_ Nil)

127in printSQL manipulation

177in printSQL manipulation

128:}

178:}

129INSERT INTO "customers" ("name", "email") VALUES (E'John Smith', E'john@smith.com') ON CONFLICT ON CONSTRAINT "uq" DO UPDATE SET "email" = ("excluded"."email" || (E'; ' || "customers"."email"))

179INSERT INTO "customers" ("name", "email") VALUES (E'John Smith', E'john@smith.com') ON CONFLICT ON CONSTRAINT "uq" DO UPDATE SET "email" = ("excluded"."email" || (E'; ' || "customers"."email"))

@@ -132,8 +182,8 @@ query insert:

132

182

133>>> :{

183>>> :{

134let

184let

135− manipulation :: Manipulation (DBof (Public Schema)) '[] '[]

185+ manipulation :: Manipulation_ (Public Schema) () ()

136− manipulation = insertInto_ #tab (Subquery (selectStar (from (table #tab))))

186+ manipulation = insertInto_ #tab (Subquery (select Star (from (table #tab))))

137in printSQL manipulation

187in printSQL manipulation

138:}

188:}

139INSERT INTO "tab" SELECT * FROM "tab" AS "tab"

189INSERT INTO "tab" SELECT * FROM "tab" AS "tab"

@@ -142,8 +192,8 @@ update:

142

192

143>>> :{

193>>> :{

144let

194let

145− manipulation :: Manipulation (DBof (Public Schema)) '[] '[]

195+ manipulation :: Manipulation_ (Public Schema) () ()

146− manipulation = update_ #tab (2 `as` #col1) (#col1 ./= #col2)

196+ manipulation = update_ #tab (Set 2 `as` #col1) (#col1 ./= #col2)

147in printSQL manipulation

197in printSQL manipulation

148:}

198:}

149UPDATE "tab" SET "col1" = 2 WHERE ("col1" <> "col2")

199UPDATE "tab" SET "col1" = 2 WHERE ("col1" <> "col2")

@@ -152,10 +202,8 @@ delete:

152

202

153>>> :{

203>>> :{

154let

204let

155− manipulation :: Manipulation (DBof (Public Schema)) '[]

205+ manipulation :: Manipulation_ (Public Schema) () (Row Int32 Int32)

156− '[ "col1" ::: 'NotNull 'PGint4

157− , "col2" ::: 'NotNull 'PGint4 ]

158− manipulation = deleteFrom #tab NoUsing (#col1 .== #col2) ReturningStar

206+ manipulation = deleteFrom #tab NoUsing (#col1 .== #col2) (Returning Star)

159in printSQL manipulation

207in printSQL manipulation

160:}

208:}

161DELETE FROM "tab" WHERE ("col1" = "col2") RETURNING *

209DELETE FROM "tab" WHERE ("col1" = "col2") RETURNING *

@@ -165,17 +213,18 @@ delete and using clause:

165>>> :{

213>>> :{

166type Schema3 =

214type Schema3 =

167 '[ "tab" ::: 'Table ('[] :=> Columns)

215 '[ "tab" ::: 'Table ('[] :=> Columns)

168− , "other_tab" ::: 'Table ('[] :=> Columns)

216+ , "other_tab" ::: 'Table ('[] :=> Columns)

169− , "third_tab" ::: 'Table ('[] :=> Columns) ]

217+ , "third_tab" ::: 'Table ('[] :=> Columns) ]

170:}

218:}

171

219

172>>> :{

220>>> :{

173let

221let

174− manipulation :: Manipulation (DBof (Public Schema3)) '[] '[]

222+ manipulation :: Manipulation_ (Public Schema3) () ()

175 manipulation =

223 manipulation =

176− deleteFrom_ #tab (Using (table #other_tab & also (table #third_tab)))

224+ deleteFrom #tab (Using (table #other_tab & also (table #third_tab)))

177 ( (#tab ! #col2 .== #other_tab ! #col2)

225 ( (#tab ! #col2 .== #other_tab ! #col2)

178 .&& (#tab ! #col2 .== #third_tab ! #col2) )

226 .&& (#tab ! #col2 .== #third_tab ! #col2) )

227+ (Returning_ Nil)

179in printSQL manipulation

228in printSQL manipulation

180:}

229:}

181DELETE 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"))

230DELETE 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"))

@@ -186,34 +235,23 @@ with manipulation:

186>>> type ProductsSchema = '["products" ::: 'Table ('[] :=> ProductsColumns), "products_deleted" ::: 'Table ('[] :=> ProductsColumns)]

235>>> type ProductsSchema = '["products" ::: 'Table ('[] :=> ProductsColumns), "products_deleted" ::: 'Table ('[] :=> ProductsColumns)]

187>>> :{

236>>> :{

188let

237let

189− manipulation :: Manipulation (DBof (Public ProductsSchema)) '[ 'NotNull 'PGdate] '[]

238+ manipulation :: Manipulation_ (Public ProductsSchema) (Only Day) ()

190 manipulation = with

239 manipulation = with

191− (deleteFrom #products NoUsing (#date .< param @1) ReturningStar `as` #del)

240+ (deleteFrom #products NoUsing (#date .< param @1) (Returning Star) `as` #del)

192− (insertInto_ #products_deleted (Subquery (selectStar (from (common #del)))))

241+ (insertInto_ #products_deleted (Subquery (select Star (from (common #del)))))

193in printSQL manipulation

242in printSQL manipulation

194:}

243:}

195WITH "del" AS (DELETE FROM "products" WHERE ("date" < ($1 :: date)) RETURNING *) INSERT INTO "products_deleted" SELECT * FROM "del" AS "del"

244WITH "del" AS (DELETE FROM "products" WHERE ("date" < ($1 :: date)) RETURNING *) INSERT INTO "products_deleted" SELECT * FROM "del" AS "del"

196-}

245-}

197−

246+type family Manipulation_ (schemas :: SchemasType) (params :: Type) (row :: Type) where

198−newtype Manipulation

247+ Manipulation_ schemas params row = Manipulation '[] schemas (TuplePG params) (RowPG row)

199− (db :: DBType)

200− (params :: [NullityType])

201− (columns :: RowType)

202− = UnsafeManipulation { renderManipulation :: ByteString }

203− deriving (GHC.Generic,Show,Eq,Ord,NFData)

204−instance RenderSQL (Manipulation db params columns) where

205− renderSQL = renderManipulation

206−instance With Manipulation where

207− with Done manip = manip

208− with (cte :>> ctes) manip = UnsafeManipulation $

209− "WITH" <+> renderCommonTableExpressions renderManipulation cte ctes

210− <+> renderManipulation manip

211

248

212-- | Convert a `Query` into a `Manipulation`.

249-- | Convert a `Query` into a `Manipulation`.

213queryStatement

250queryStatement

214− :: Query db params columns

251+ :: Query '[] commons schemas params columns

252+ -- ^ `Query` to embed as a `Manipulation`

215− -> Manipulation db params columns

253+ -> Manipulation commons schemas params columns

216−queryStatement q = UnsafeManipulation $ renderQuery q

254+queryStatement q = UnsafeManipulation $ renderSQL q

217

255

218{-----------------------------------------

256{-----------------------------------------

219INSERT statements

257INSERT statements

@@ -227,176 +265,115 @@ more than one row, but there is no way to insert less than one row.

227Even if you know only some column values, a complete row must be created.

265Even if you know only some column values, a complete row must be created.

228-}

266-}

229insertInto

267insertInto

230− :: ( db ~ (commons :=> schemas)

231− , Has sch schemas schema

268+ :: ( Has sch schemas schema

232 , Has tab schema ('Table table)

269 , Has tab schema ('Table table)

233 , columns ~ TableToColumns table

270 , columns ~ TableToColumns table

234− , row ~ TableToRow table

271+ , row0 ~ TableToRow table

235 , SOP.SListI columns

272 , SOP.SListI columns

236− , SOP.SListI result )

273+ , SOP.SListI row1 )

237 => QualifiedAlias sch tab

274 => QualifiedAlias sch tab

275+ -- ^ table

238− -> QueryClause db params columns

276+ -> QueryClause commons schemas params columns

277+ -- ^ what to insert

239− -> ConflictClause tab db params table

278+ -> ConflictClause tab commons schemas params table

279+ -- ^ what to do in case of conflict

240− -> ReturningClause db params row result

280+ -> ReturningClause commons schemas params '[tab ::: row0] row1

281+ -- ^ what to return

241− -> Manipulation db params result

282+ -> Manipulation commons schemas params row1

242insertInto tab qry conflict ret = UnsafeManipulation $

283insertInto tab qry conflict ret = UnsafeManipulation $

243− "INSERT" <+> "INTO" <+> renderQualifiedAlias tab

284+ "INSERT" <+> "INTO" <+> renderSQL tab

244− <+> renderQueryClause qry

285+ <+> renderSQL qry

245− <> renderConflictClause conflict

286+ <> renderSQL conflict

246− <> renderReturningClause ret

287+ <> renderSQL ret

247

288

289+-- | Like `insertInto` but with `OnConflictDoRaise` and `no` `ReturningClause`.

248insertInto_

290insertInto_

249− :: ( db ~ (commons :=> schemas)

250− , Has sch schemas schema

291+ :: ( Has sch schemas schema

251 , Has tab schema ('Table table)

292 , Has tab schema ('Table table)

252 , columns ~ TableToColumns table

293 , columns ~ TableToColumns table

253 , row ~ TableToRow table

294 , row ~ TableToRow table

254 , SOP.SListI columns )

295 , SOP.SListI columns )

255 => QualifiedAlias sch tab

296 => QualifiedAlias sch tab

297+ -- ^ table

256− -> QueryClause db params columns

298+ -> QueryClause commons schemas params columns

299+ -- ^ what to insert

257− -> Manipulation db params '[]

300+ -> Manipulation commons schemas params '[]

258insertInto_ tab qry =

301insertInto_ tab qry =

259− insertInto tab qry OnConflictDoRaise (Returning Nil)

302+ insertInto tab qry OnConflictDoRaise (Returning_ Nil)

260

303

304+-- | A `QueryClause` describes what to `insertInto` a table.

261−data QueryClause db params columns where

305+data QueryClause commons schemas params columns where

262 Values

306 Values

263 :: SOP.SListI columns

307 :: SOP.SListI columns

264− => NP (ColumnExpression db params 'Ungrouped '[]) columns

308+ => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

265− -> [NP (ColumnExpression db params 'Ungrouped '[]) columns]

309+ -- ^ row of values

310+ -> [NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns]

311+ -- ^ additional rows of values

266− -> QueryClause db params columns

312+ -> QueryClause commons schemas params columns

267 Select

313 Select

268 :: SOP.SListI columns

314 :: SOP.SListI columns

269− => NP (ColumnExpression db params grp from) columns

315+ => NP (Aliased (Optional (Expression '[] commons grp schemas params from))) columns

316+ -- ^ row of values

270− -> TableExpression db params grp from

317+ -> TableExpression '[] commons grp schemas params from

318+ -- ^ from a table expression

271− -> QueryClause db params columns

319+ -> QueryClause commons schemas params columns

272 Subquery

320 Subquery

273 :: ColumnsToRow columns ~ row

321 :: ColumnsToRow columns ~ row

274− => Query db params row

322+ => Query '[] commons schemas params row

323+ -- ^ subquery to insert

275− -> QueryClause db params columns

324+ -> QueryClause commons schemas params columns

276−

325+

277−renderQueryClause

278− :: QueryClause db params columns

326+instance RenderSQL (QueryClause commons schemas params columns) where

279− -> ByteString

327+ renderSQL = \case

280−renderQueryClause = \case

281− Values row0 rows ->

328+ Values row0 rows ->

282− parenthesized (renderCommaSeparated renderAliasPart row0)

329+ parenthesized (renderCommaSeparated renderSQLPart row0)

283− <+> "VALUES"

330+ <+> "VALUES"

284− <+> commaSeparated

331+ <+> commaSeparated

285− ( parenthesized

332+ ( parenthesized

286− . renderCommaSeparated renderValuePart <$> row0 : rows )

333+ . renderCommaSeparated renderValuePart <$> row0 : rows )

287− Select row0 tab ->

334+ Select row0 tab ->

288− parenthesized (renderCommaSeparatedMaybe renderAliasPartMaybe row0)

335+ parenthesized (renderCommaSeparatedMaybe renderSQLPartMaybe row0)

289− <+> "SELECT"

336+ <+> "SELECT"

290− <+> renderCommaSeparatedMaybe renderValuePartMaybe row0

337+ <+> renderCommaSeparatedMaybe renderValuePartMaybe row0

291− <+> renderTableExpression tab

338+ <+> renderSQL tab

292− Subquery qry -> renderQuery qry

339+ Subquery qry -> renderQuery qry

293− where

340+ where

294− renderAliasPartMaybe, renderValuePartMaybe

341+ renderSQLPartMaybe, renderValuePartMaybe

342+ :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

295− :: ColumnExpression db params grp from column -> Maybe ByteString

343+ -> Maybe ByteString

296− renderAliasPartMaybe = \case

344+ renderSQLPartMaybe = \case

297− DefaultAs _ -> Nothing

345+ Default `As` _ -> Nothing

298− Specific (_ `As` name) -> Just $ renderAlias name

346+ Set _ `As` name -> Just $ renderSQL name

299− renderValuePartMaybe = \case

347+ renderValuePartMaybe = \case

300− DefaultAs _ -> Nothing

348+ Default `As` _ -> Nothing

301− Specific (value `As` _) -> Just $ renderExpression value

349+ Set value `As` _ -> Just $ renderExpression value

302− renderAliasPart, renderValuePart

350+ renderSQLPart, renderValuePart

303− :: ColumnExpression db params grp from column -> ByteString

351+ :: Aliased (Optional (Expression '[] commons grp schemas params from)) column

304− renderAliasPart = \case

352+ -> ByteString

305− DefaultAs name -> renderAlias name

353+ renderSQLPart (_ `As` name) = renderSQL name

306− Specific (_ `As` name) -> renderAlias name

354+ renderValuePart (value `As` _) = renderSQL value

307− renderValuePart = \case

355+

308− DefaultAs _ -> "DEFAULT"

356+-- | `Values_` describes a single `NP` list of `Aliased` `Optional` `Expression`s

309− Specific (value `As` _) -> renderExpression value

357+-- whose `ColumnsType` must match the tables'.

310−

311pattern Values_

358pattern Values_

312 :: SOP.SListI columns

359 :: SOP.SListI columns

313− => NP (ColumnExpression db params 'Ungrouped '[]) columns

360+ => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[]))) columns

361+ -- ^ row of values

314− -> QueryClause db params columns

362+ -> QueryClause commons schemas params columns

315pattern Values_ vals = Values vals []

363pattern Values_ vals = Values vals []

316

364

317−data ColumnExpression db params grp from column where

365+-- | `Optional` is either `Default` or a value, parameterized by an appropriate

318− DefaultAs

366+-- `ColumnConstraint`.

319− :: KnownSymbol col

367+data Optional expr ty where

320− => Alias col

368+ -- | Use the `Default` value for a column.

321− -> ColumnExpression db params grp from (col ::: 'Def :=> ty)

369+ Default :: Optional expr ('Def :=> ty)

322− Specific

370+ -- | `Set` a value for a column.

323− :: Aliased (Expression db params grp from) (col ::: ty)

371+ Set :: expr ty -> Optional expr (def :=> ty)

324− -> ColumnExpression db params grp from (col ::: defness :=> ty)

372+

325−

373+instance (forall x. RenderSQL (expr x)) => RenderSQL (Optional expr ty) where

326−instance (KnownSymbol col, column ~ (col ::: defness :=> ty))

374+ renderSQL = \case

327− => Aliasable col

328− (Expression db params grp from ty)

329− (ColumnExpression db params grp from column) where

330− expression `as` col = Specific (expression `As` col)

331−instance (KnownSymbol col, columns ~ '[col ::: defness :=> ty])

332− => Aliasable col

333− (Expression db params grp from ty)

334− (NP (ColumnExpression db params grp from) columns) where

335− expression `as` col = expression `as` col :* Nil

336−instance (KnownSymbol col, column ~ (col ::: 'Def :=> ty))

337− => DefaultAliasable col (ColumnExpression db params grp from column) where

338− defaultAs = DefaultAs

339−instance (KnownSymbol col, columns ~ '[col ::: 'Def :=> ty])

340− => DefaultAliasable col (NP (ColumnExpression db params grp 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 db params 'Ungrouped 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 db params 'Ungrouped 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 db params 'Ungrouped 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 db params 'Ungrouped 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 db params ('Grouped bys) 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 db params ('Grouped bys) 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 db params ('Grouped bys) 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 db params ('Grouped bys) from) columns) where

390− tab ! col = tab ! col :* Nil

391−

392−renderColumnExpression

393− :: ColumnExpression db params grp from column

394− -> ByteString

395−renderColumnExpression = \case

396− DefaultAs col ->

397− renderAlias col <+> "=" <+> "DEFAULT"

375+ Default -> "DEFAULT"

398− Specific (expression `As` col) ->

376+ Set expr -> renderSQL expr

399− renderAlias col <+> "=" <+> renderExpression expression

400

377

401-- | A `ReturningClause` computes and return value(s) based

378-- | A `ReturningClause` computes and return value(s) based

402-- on each row actually inserted, updated or deleted. This is primarily

379-- on each row actually inserted, updated or deleted. This is primarily

@@ -404,78 +381,87 @@ renderColumnExpression = \case

404-- serial sequence number. However, any expression using the table's columns

381-- serial sequence number. However, any expression using the table's columns

405-- is allowed. Only rows that were successfully inserted or updated or

382-- is allowed. Only rows that were successfully inserted or updated or

406-- deleted will be returned. For example, if a row was locked

383-- deleted will be returned. For example, if a row was locked

407−-- but not updated because an `OnConflictDoUpdate` condition was not satisfied,

384+-- but not updated because an `OnConflict` `DoUpdate` condition was not satisfied,

408−-- the row will not be returned. `ReturningStar` will return all columns

385+-- the row will not be returned. `Returning` `Star` will return all columns

409−-- in the row. Use @Returning Nil@ in the common case where no return

386+-- in the row. Use `Returning` `Nil` in the common case where no return

410-- values are desired.

387-- values are desired.

411−data ReturningClause

388+newtype ReturningClause commons schemas params from row =

412− (db :: DBType)

389+ Returning (Selection '[] commons 'Ungrouped schemas params from row)

413− (params :: [NullityType])

390+

414− (row0 :: RowType)

391+instance RenderSQL (ReturningClause commons schemas params from row) where

415− (row1 :: RowType)

392+ renderSQL = \case

416− where

417− ReturningStar

418− :: ReturningClause db params row row

419− Returning

393+ Returning (List Nil) -> ""

420− :: NP (Aliased (Expression db params 'Ungrouped '[tab ::: row0])) row1

394+ Returning selection -> " RETURNING" <+> renderSQL selection

421− -> ReturningClause db params row0 row1

395+

422−

396+-- | `Returning` a `List`

423−-- | Render a `ReturningClause`.

397+pattern Returning_

424−renderReturningClause

425− :: SOP.SListI results

398+ :: SOP.SListI row

426− => ReturningClause db params columns results

399+ => NP (Aliased (Expression '[] commons 'Ungrouped schemas params from)) row

427− -> ByteString

400+ -- ^ row of values

428−renderReturningClause = \case

401+ -> ReturningClause commons schemas params from row

429− ReturningStar -> " RETURNING *"

402+pattern Returning_ list = Returning (List list)

430− Returning Nil -> ""

431− Returning results -> " RETURNING"

432− <+> renderCommaSeparated (renderAliasedAs renderExpression) results

433

403

434-- | A `ConflictClause` specifies an action to perform upon a constraint

404-- | A `ConflictClause` specifies an action to perform upon a constraint

435-- violation. `OnConflictDoRaise` will raise an error.

405-- violation. `OnConflictDoRaise` will raise an error.

436−-- `OnConflictDoNothing` simply avoids inserting a row.

406+-- `OnConflict` `DoNothing` simply avoids inserting a row.

437−-- `OnConflictDoUpdate` updates the existing row that conflicts with the row

407+-- `OnConflict` `DoUpdate` updates the existing row that conflicts with the row

438-- proposed for insertion.

408-- proposed for insertion.

439−data ConflictClause tab db params table where

409+data ConflictClause tab commons schemas params table where

440− OnConflictDoRaise :: ConflictClause tab db params table

410+ OnConflictDoRaise :: ConflictClause tab commons schemas params table

441 OnConflict

411 OnConflict

442 :: ConflictTarget constraints

412 :: ConflictTarget constraints

413+ -- ^ conflict target

443− -> ConflictAction tab db params columns

414+ -> ConflictAction tab commons schemas params columns

415+ -- ^ conflict action

444− -> ConflictClause tab db params (constraints :=> columns)

416+ -> ConflictClause tab commons schemas params (constraints :=> columns)

445

417

446-- | Render a `ConflictClause`.

418-- | Render a `ConflictClause`.

447−renderConflictClause

448− :: SOP.SListI (TableToColumns table)

419+instance SOP.SListI (TableToColumns table)

449− => ConflictClause tab db params table

420+ => RenderSQL (ConflictClause tab commons schemas params table) where

450− -> ByteString

421+ renderSQL = \case

451−renderConflictClause = \case

452− OnConflictDoRaise -> ""

422+ OnConflictDoRaise -> ""

453− OnConflict target action -> " ON CONFLICT"

423+ OnConflict target action -> " ON CONFLICT"

454− <+> renderConflictTarget target <+> renderConflictAction action

424+ <+> renderSQL target <+> renderSQL action

455

425

426+{- |

427+`ConflictAction` specifies an alternative `OnConflict` action.

428+It can be either `DoNothing`, or a `DoUpdate` clause specifying

429+the exact details of the `update` action to be performed in case of a conflict.

430+The `Set` and WHERE `Condition`s in `OnConflict` `DoUpdate` have access to the

431+existing row using the table's name (or an alias), and to rows proposed

432+for insertion using the special @#excluded@ table.

433+`OnConflict` `DoNothing` simply avoids inserting a row as its alternative action.

434+`OnConflict` `DoUpdate` updates the existing row that conflicts

435+with the row proposed for insertion as its alternative action.

436+-}

456−data ConflictAction tab db params columns where

437+data ConflictAction tab commons schemas params columns where

457− DoNothing :: ConflictAction tab db params columns

438+ DoNothing :: ConflictAction tab commons schemas params columns

458 DoUpdate

439 DoUpdate

459 :: ( row ~ ColumnsToRow columns

440 :: ( row ~ ColumnsToRow columns

460 , SOP.SListI columns

441 , SOP.SListI columns

461 , columns ~ (col0 ': cols)

442 , columns ~ (col0 ': cols)

462 , SOP.All (HasIn columns) subcolumns

443 , SOP.All (HasIn columns) subcolumns

463 , AllUnique subcolumns )

444 , AllUnique subcolumns )

464− => NP (ColumnExpression db params 'Ungrouped '[tab ::: row, "excluded" ::: row]) subcolumns

445+ => NP (Aliased (Optional (Expression '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]))) subcolumns

465− -> [Condition db params 'Ungrouped '[tab ::: row, "excluded" ::: row]]

446+ -> [Condition '[] commons 'Ungrouped schemas params '[tab ::: row, "excluded" ::: row]]

447+ -- ^ WHERE `Condition`s

466− -> ConflictAction tab db params columns

448+ -> ConflictAction tab commons schemas params columns

467−

449+

468−renderConflictAction

450+instance RenderSQL (ConflictAction tab commons schemas params columns) where

469− :: ConflictAction tab db params columns

451+ renderSQL = \case

452+ DoNothing -> "DO NOTHING"

453+ DoUpdate updates whs'

454+ -> "DO UPDATE SET"

455+ <+> renderCommaSeparated renderUpdate updates

456+ <> case whs' of

457+ [] -> ""

458+ wh:whs -> " WHERE" <+> renderSQL (foldr (.&&) wh whs)

459+

460+renderUpdate

461+ :: (forall x. RenderSQL (expr x))

462+ => Aliased (Optional expr) ty

470 -> ByteString

463 -> ByteString

471−renderConflictAction = \case

464+renderUpdate (expr `As` col) = renderSQL col <+> "=" <+> renderSQL expr

472− DoNothing -> "DO NOTHING"

473− DoUpdate updates whs'

474− -> "DO UPDATE SET"

475− <+> renderCommaSeparated renderColumnExpression updates

476− <> case whs' of

477− [] -> ""

478− wh:whs -> " WHERE" <+> renderExpression (foldr (.&&) wh whs)

479

465

480-- | A `ConflictTarget` specifies the constraint violation that triggers a

466-- | A `ConflictTarget` specifies the constraint violation that triggers a

481-- `ConflictAction`.

467-- `ConflictAction`.

@@ -486,11 +472,9 @@ data ConflictTarget constraints where

486 -> ConflictTarget constraints

472 -> ConflictTarget constraints

487

473

488-- | Render a `ConflictTarget`

474-- | Render a `ConflictTarget`

489−renderConflictTarget

490− :: ConflictTarget constraints

475+instance RenderSQL (ConflictTarget constraints) where

491− -> ByteString

492−renderConflictTarget (OnConstraint con) =

476+ renderSQL (OnConstraint con) =

493− "ON" <+> "CONSTRAINT" <+> renderAlias con

477+ "ON" <+> "CONSTRAINT" <+> renderSQL con

494

478

495{-----------------------------------------

479{-----------------------------------------

496UPDATE statements

480UPDATE statements

@@ -500,33 +484,31 @@ UPDATE statements

500-- in all rows that satisfy the condition.

484-- in all rows that satisfy the condition.

501update

485update

502 :: ( SOP.SListI columns

486 :: ( SOP.SListI columns

503− , SOP.SListI results

487+ , SOP.SListI row1

504− , db ~ (commons :=> schemas)

505 , Has sch schemas schema

488 , Has sch schemas schema

506 , Has tab schema ('Table table)

489 , Has tab schema ('Table table)

507− , row ~ TableToRow table

490+ , row0 ~ TableToRow table

508 , columns ~ TableToColumns table

491 , columns ~ TableToColumns table

509 , SOP.All (HasIn columns) subcolumns

492 , SOP.All (HasIn columns) subcolumns

510 , AllUnique subcolumns )

493 , AllUnique subcolumns )

511 => QualifiedAlias sch tab -- ^ table to update

494 => QualifiedAlias sch tab -- ^ table to update

512− -> NP (ColumnExpression db params 'Ungrouped '[tab ::: row]) subcolumns

495+ -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row0]))) subcolumns

513 -- ^ modified values to replace old values

496 -- ^ modified values to replace old values

514− -> Condition db params 'Ungrouped '[tab ::: row]

497+ -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row0]

515 -- ^ condition under which to perform update on a row

498 -- ^ condition under which to perform update on a row

516− -> ReturningClause db params row results -- ^ results to return

499+ -> ReturningClause commons schemas params '[tab ::: row0] row1 -- ^ results to return

517− -> Manipulation db params results

500+ -> Manipulation commons schemas params row1

518update tab columns wh returning = UnsafeManipulation $

501update tab columns wh returning = UnsafeManipulation $

519 "UPDATE"

502 "UPDATE"

520− <+> renderQualifiedAlias tab

503+ <+> renderSQL tab

521 <+> "SET"

504 <+> "SET"

522− <+> renderCommaSeparated renderColumnExpression columns

505+ <+> renderCommaSeparated renderUpdate columns

523− <+> "WHERE" <+> renderExpression wh

506+ <+> "WHERE" <+> renderSQL wh

524− <> renderReturningClause returning

507+ <> renderSQL returning

525

508

526-- | Update a row returning `Nil`.

509-- | Update a row returning `Nil`.

527update_

510update_

528 :: ( SOP.SListI columns

511 :: ( SOP.SListI columns

529− , db ~ (commons :=> schemas)

530 , Has sch schemas schema

512 , Has sch schemas schema

531 , Has tab schema ('Table table)

513 , Has tab schema ('Table table)

532 , row ~ TableToRow table

514 , row ~ TableToRow table

@@ -534,70 +516,63 @@ update_

534 , SOP.All (HasIn columns) subcolumns

516 , SOP.All (HasIn columns) subcolumns

535 , AllUnique subcolumns )

517 , AllUnique subcolumns )

536 => QualifiedAlias sch tab -- ^ table to update

518 => QualifiedAlias sch tab -- ^ table to update

537− -> NP (ColumnExpression db params 'Ungrouped '[tab ::: row]) subcolumns

519+ -> NP (Aliased (Optional (Expression '[] '[] 'Ungrouped schemas params '[tab ::: row]))) subcolumns

538 -- ^ modified values to replace old values

520 -- ^ modified values to replace old values

539− -> Condition db params 'Ungrouped '[tab ::: row]

521+ -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]

540 -- ^ condition under which to perform update on a row

522 -- ^ condition under which to perform update on a row

541− -> Manipulation db params '[]

523+ -> Manipulation commons schemas params '[]

542−update_ tab columns wh = update tab columns wh (Returning Nil)

524+update_ tab columns wh = update tab columns wh (Returning_ Nil)

543

525

544{-----------------------------------------

526{-----------------------------------------

545DELETE statements

527DELETE statements

546-----------------------------------------}

528-----------------------------------------}

547

529

530+-- | Specify additional tables with `Using`

531+-- an `also` list of table expressions, allowing columns

532+-- from other tables to appear in the WHERE condition.

533+-- This is similar to the list of tables that can be specified

534+-- in the FROM Clause of a SELECT statement;

535+-- for example, an alias for the table name can be specified.

536+-- Do not repeat the target table in the `Using` list,

537+-- unless you wish to set up a self-join.

538+-- `NoUsing` if no additional tables are to be used.

548−data UsingClause db params from where

539+data UsingClause commons schemas params from where

549− NoUsing :: UsingClause db params '[]

540+ NoUsing :: UsingClause commons schemas params '[]

550 Using

541 Using

551− :: FromClause db params from

542+ :: FromClause '[] commons schemas params from

543+ -- ^ what to use

552− -> UsingClause db params from

544+ -> UsingClause commons schemas params from

553

545

554-- | Delete rows from a table.

546-- | Delete rows from a table.

555deleteFrom

547deleteFrom

556− :: ( SOP.SListI results

548+ :: ( SOP.SListI row1

557− , db ~ (commons :=> schemas)

558 , Has sch schemas schema

549 , Has sch schemas schema

559 , Has tab schema ('Table table)

550 , Has tab schema ('Table table)

560− , row ~ TableToRow table

551+ , row0 ~ TableToRow table

561 , columns ~ TableToColumns table )

552 , columns ~ TableToColumns table )

562 => QualifiedAlias sch tab -- ^ table to delete from

553 => QualifiedAlias sch tab -- ^ table to delete from

563− -> UsingClause db params from

554+ -> UsingClause commons schemas params from

564− -> Condition db params 'Ungrouped (tab ::: row ': from)

555+ -> Condition '[] commons 'Ungrouped schemas params (tab ::: row0 ': from)

565 -- ^ condition under which to delete a row

556 -- ^ condition under which to delete a row

566− -> ReturningClause db params row results -- ^ results to return

557+ -> ReturningClause commons schemas params '[tab ::: row0] row1 -- ^ results to return

567− -> Manipulation db params results

558+ -> Manipulation commons schemas params row1

568deleteFrom tab using wh returning = UnsafeManipulation $

559deleteFrom tab using wh returning = UnsafeManipulation $

569 "DELETE FROM"

560 "DELETE FROM"

570− <+> renderQualifiedAlias tab

561+ <+> renderSQL tab

571 <> case using of

562 <> case using of

572 NoUsing -> ""

563 NoUsing -> ""

573− Using tables -> " USING" <+> renderFromClause tables

564+ Using tables -> " USING" <+> renderSQL tables

574− <+> "WHERE" <+> renderExpression wh

565+ <+> "WHERE" <+> renderSQL wh

575− <> renderReturningClause returning

566+ <> renderSQL returning

576

567

577-- | Delete rows returning `Nil`.

568-- | Delete rows returning `Nil`.

578deleteFrom_

569deleteFrom_

579− :: ( db ~ (commons :=> schemas)

580− , Has sch schemas schema

570+ :: ( Has sch schemas schema

581 , Has tab schema ('Table table)

571 , Has tab schema ('Table table)

582 , row ~ TableToRow table

572 , row ~ TableToRow table

583 , columns ~ TableToColumns table )

573 , columns ~ TableToColumns table )

584 => QualifiedAlias sch tab -- ^ table to delete from

574 => QualifiedAlias sch tab -- ^ table to delete from

585− -> UsingClause db params from

586− -> Condition db params 'Ungrouped (tab ::: row ': from)

575+ -> Condition '[] commons 'Ungrouped schemas params '[tab ::: row]

587 -- ^ condition under which to delete a row

576 -- ^ condition under which to delete a row

588− -> Manipulation db params '[]

577+ -> Manipulation commons schemas params '[]

589−deleteFrom_ tab uses wh = deleteFrom tab uses wh (Returning Nil)

578+deleteFrom_ tab wh = deleteFrom tab NoUsing wh (Returning_ Nil)

590−

591−-- | This has the behaviour of a cartesian product, taking all

592−-- possible combinations between @left@ and @right@ - exactly like a

593−-- CROSS JOIN. Used when no "CROSS JOIN" syntax is required but simply

594−-- a comma separated list of tables. Typical case is the `USING` clause

595−-- of a DELETE query.

596−also

597− :: FromClause schema params right

598− -- ^ right

599− -> FromClause schema params left

600− -- ^ left

601− -> FromClause schema params (Join left right)

602−also right left = UnsafeFromClause $

603− renderFromClause left <> "," <+> renderFromClause right

squeal-postgresql/src/Squeal/PostgreSQL/Migration.hs+337−186

@@ -8,8 +8,13 @@ Stability: experimental

8This module defines a `Migration` type to safely

9change the schema of your database over time. Let's see an example!

11+First turn on some extensions.

12+

11>>> :set -XDataKinds -XOverloadedLabels

13>>> :set -XDataKinds -XOverloadedLabels

12>>> :set -XOverloadedStrings -XFlexibleContexts -XTypeOperators

14>>> :set -XOverloadedStrings -XFlexibleContexts -XTypeOperators

15+

16+Next, let's define our `TableType`s.

17+

13>>> :{

18>>> :{

14type UsersTable =

19type UsersTable =

15 '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>

20 '[ "pk_users" ::: 'PrimaryKey '["id"] ] :=>

@@ -20,7 +25,7 @@ type UsersTable =

21>>> :{

26>>> :{

22type EmailsTable =

27type EmailsTable =

23− '[ "pk_emails" ::: 'PrimaryKey '["id"]

28+ '[ "pk_emails" ::: 'PrimaryKey '["id"]

24 , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]

29 , "fk_user_id" ::: 'ForeignKey '["user_id"] "users" '["id"]

25 ] :=>

30 ] :=>

26 '[ "id" ::: 'Def :=> 'NotNull 'PGint4

31 '[ "id" ::: 'Def :=> 'NotNull 'PGint4

@@ -29,227 +34,293 @@ type EmailsTable =

29 ]

34 ]

30:}

35:}

37+Now we can define some `Migration`s to make our tables.

38+

32>>> :{

39>>> :{

33let

40let

34− makeUsers :: Migration IO (Public '[]) '["public" ::: '["users" ::: 'Table UsersTable]]

41+ makeUsers :: Migration Definition (Public '[]) '["public" ::: '["users" ::: 'Table UsersTable]]

35 makeUsers = Migration

42 makeUsers = Migration

36 { name = "make users table"

43 { name = "make users table"

37− , up = void . define $

38− createTable #users

44+ , up = createTable #users

39 ( serial `as` #id :*

45 ( serial `as` #id :*

40− (text & notNullable) `as` #name )

46+ notNullable text `as` #name )

41 ( primaryKey #id `as` #pk_users )

47 ( primaryKey #id `as` #pk_users )

42− , down = void . define $ dropTable #users

48+ , down = dropTable #users

43 }

49 }

44:}

50:}

46>>> :{

52>>> :{

47let

53let

48− makeEmails :: Migration IO '["public" ::: '["users" ::: 'Table UsersTable]]

54+ makeEmails :: Migration Definition '["public" ::: '["users" ::: 'Table UsersTable]]

49 '["public" ::: '["users" ::: 'Table UsersTable, "emails" ::: 'Table EmailsTable]]

55 '["public" ::: '["users" ::: 'Table UsersTable, "emails" ::: 'Table EmailsTable]]

50 makeEmails = Migration

56 makeEmails = Migration

51 { name = "make emails table"

57 { name = "make emails table"

52− , up = void . define $

53− createTable #emails

58+ , up = createTable #emails

54 ( serial `as` #id :*

59 ( serial `as` #id :*

55− (int & notNullable) `as` #user_id :*

60+ notNullable int `as` #user_id :*

56− (text & nullable) `as` #email )

61+ nullable text `as` #email )

57 ( primaryKey #id `as` #pk_emails :*

62 ( primaryKey #id `as` #pk_emails :*

58 foreignKey #user_id #users #id

63 foreignKey #user_id #users #id

59 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

64 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

60− , down = void . define $ dropTable #emails

65+ , down = dropTable #emails

61 }

66 }

62:}

67:}

64−Now that we have a couple migrations we can chain them together.

69+Now that we have a couple migrations we can chain them together into a `Path`.

66>>> let migrations = makeUsers :>> makeEmails :>> Done

71>>> let migrations = makeUsers :>> makeEmails :>> Done

68−>>> :{

73+Now run the migrations.

69−let

70− numMigrations

71− :: Has "migrations" schemas MigrationsSchema

72− => PQ schemas schemas IO ()

73− numMigrations = do

74− result <- runQuery (selectStar (from (table (#migrations ! #schema_migrations `as` #m))))

75− num <- ntuples result

76− liftBase $ print num

77−:}

75+>>> import Control.Monad.IO.Class

79>>> :{

76>>> :{

80withConnection "host=localhost port=5432 dbname=exampledb" $

77withConnection "host=localhost port=5432 dbname=exampledb" $

81 manipulate (UnsafeManipulation "SET client_min_messages TO WARNING;")

78 manipulate (UnsafeManipulation "SET client_min_messages TO WARNING;")

82 -- suppress notices

79 -- suppress notices

80+ & pqThen (liftIO (putStrLn "Migrate"))

83 & pqThen (migrateUp migrations)

81 & pqThen (migrateUp migrations)

84− & pqThen numMigrations

82+ & pqThen (liftIO (putStrLn "Rollback"))

85 & pqThen (migrateDown migrations)

83 & pqThen (migrateDown migrations)

86− & pqThen numMigrations

87:}

84:}

88−Row 2

85+Migrate

89−Row 0

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.

90-}

122-}

123

92{-# LANGUAGE

124{-# LANGUAGE

93 DataKinds

125 DataKinds

126+ , DeriveGeneric

127+ , FlexibleContexts

128+ , FlexibleInstances

94 , GADTs

129 , GADTs

95 , LambdaCase

130 , LambdaCase

96− , PolyKinds

97 , OverloadedLabels

131 , OverloadedLabels

132+ , OverloadedStrings

133+ , PolyKinds

134+ , QuantifiedConstraints

135+ , RankNTypes

98 , TypeApplications

136 , TypeApplications

99− , FlexibleContexts

100 , TypeOperators

137 , TypeOperators

101#-}

138#-}

102

139

103module Squeal.PostgreSQL.Migration

140module Squeal.PostgreSQL.Migration

104 ( -- * Migration

141 ( -- * Migration

105 Migration (..)

142 Migration (..)

106− , migrateUp

143+ , Migratory (..)

107− , migrateDown

144+ , Terminally (..)

108− -- * Migration table

145+ , terminally

146+ , pureMigration

109 , MigrationsTable

147 , MigrationsTable

110− , createMigrations

148+ , defaultMain

111− , insertMigration

112− , deleteMigration

113− , selectMigration

114 ) where

149 ) where

115

150

151+import Control.Category

116import Control.Monad

152import Control.Monad

117−import Control.Monad.Base

153+import Data.ByteString (ByteString)

118−import Control.Monad.Trans.Control

154+import Data.Foldable (traverse_)

119−import Generics.SOP (K(..))

120import Data.Function ((&))

155import Data.Function ((&))

156+import Data.List ((\\))

121import Data.Text (Text)

157import Data.Text (Text)

158+import Data.Time (UTCTime)

159+import Prelude hiding ((.), id)

160+import System.Environment

161+import UnliftIO (MonadIO (..))

122

162

123−import Squeal.PostgreSQL

163+import qualified Data.Text.IO as Text (putStrLn)

164+import qualified Generics.SOP as SOP

165+import qualified GHC.Generics as GHC

124

166

167+import Squeal.PostgreSQL.Alias

168+import Squeal.PostgreSQL.Binary

169+import Squeal.PostgreSQL.Definition

170+import Squeal.PostgreSQL.Definition.Table

171+import Squeal.PostgreSQL.Definition.Table.Constraint

172+import Squeal.PostgreSQL.Expression.Comparison

173+import Squeal.PostgreSQL.Expression.Parameter

174+import Squeal.PostgreSQL.Expression.Time

175+import Squeal.PostgreSQL.Expression.Type

176+import Squeal.PostgreSQL.List

177+import Squeal.PostgreSQL.Manipulation

178+import Squeal.PostgreSQL.PQ

179+import Squeal.PostgreSQL.Query

180+import Squeal.PostgreSQL.Schema

181+import Squeal.PostgreSQL.Transaction

182+

183+-- | A `Migration` is a named "isomorphism" over a given category.

125−-- | A `Migration` should contain an inverse pair of

184+-- It should contain an inverse pair of `up` and `down`

126−-- `up` and `down` instructions and a unique `name`.

185+-- instructions and a unique `name`.

127−data Migration io schemas0 schemas1 = Migration

186+data Migration p schemas0 schemas1 = Migration

128 { name :: Text -- ^ The `name` of a `Migration`.

187 { name :: Text -- ^ The `name` of a `Migration`.

129 -- Each `name` in a `Migration` should be unique.

188 -- Each `name` in a `Migration` should be unique.

130− , up :: PQ schemas0 schemas1 io () -- ^ The `up` instruction of a `Migration`.

189+ , up :: p schemas0 schemas1 -- ^ The `up` instruction of a `Migration`.

131− , down :: PQ schemas1 schemas0 io () -- ^ The `down` 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

132 }

260 }

133

261

134−-- | Run `Migration`s by creating the `MigrationsTable`

262+instance Migratory (Terminally PQ IO) where

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

150

263

151− upMigrations

264+ migrateUp migration = unsafePQ . transactionally_ $ do

152− :: MonadBaseControl IO io

265+ define createMigrations

153− => AlignedList (Migration io) schemas0 schemas1

266+ upMigrations migration

154− -> PQ

267+

155− ("migrations" ::: MigrationsSchema ': schemas0)

268+ where

156− ("migrations" ::: MigrationsSchema ': schemas1)

269+

157− io ()

270+ upMigrations

271+ :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

272+ -> PQ MigrationsSchemas MigrationsSchemas IO ()

158− upMigrations = \case

273+ upMigrations = \case

159− Done -> return ()

274+ Done -> return ()

160− step :>> steps -> upMigration step & pqThen (upMigrations steps)

275+ step :>> steps -> upMigration step >> upMigrations steps

161−

276+

162− upMigration

277+ upMigration

163− :: MonadBase IO io

164− => Migration io schemas0 schemas1 -> PQ

278+ :: Migration (Terminally PQ IO) schemas0 schemas1

165− ("migrations" ::: MigrationsSchema ': schemas0)

279+ -> PQ MigrationsSchemas MigrationsSchemas IO ()

166− ("migrations" ::: MigrationsSchema ': schemas1)

167− io ()

168− upMigration step =

280+ upMigration step = do

169− queryExecuted step

281+ executed <- queryExecuted step

170− & pqBind (\ executed ->

282+ unless (executed == 1) $ do

171− if executed == 1 -- up step has already been executed

283+ unsafePQ . runTerminally $ up step

172− then PQ (\ _ -> return (K ())) -- unsafely switch schemas

173− else

174− pqEmbed (up step) -- safely switch schemas

175− & pqThen (manipulateParams insertMigration (Only (name step)))

284+ manipulateParams_ insertMigration (Only (name step))

176− -- insert execution record

285+

177− & pqBind okResult)

178−

179− queryExecuted

286+ queryExecuted

180− :: MonadBase IO io

287+ :: Migration (Terminally PQ IO) schemas0 schemas1

181− => Migration io schemas0 schemas1 -> PQ

288+ -> PQ MigrationsSchemas MigrationsSchemas IO Row

182− ("migrations" ::: MigrationsSchema ': schemas0)

183− ("migrations" ::: MigrationsSchema ': schemas0)

184− io Row

185− queryExecuted step = do

289+ queryExecuted step = do

186− result <- runQueryParams selectMigration (Only (name step))

290+ result <- runQueryParams selectMigration (Only (name step))

187− okResult result

188− ntuples result

291+ 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

206

292

207− downMigrations

293+ migrateDown migrations = unsafePQ . transactionally_ $ do

208− :: MonadBaseControl IO io

294+ define createMigrations

209− => AlignedList (Migration io) schemas0 schemas1 -> PQ

295+ downMigrations migrations

210− ("migrations" ::: MigrationsSchema ': schemas1)

296+

211− ("migrations" ::: MigrationsSchema ': schemas0)

297+ where

212− io ()

298+

299+ downMigrations

300+ :: Path (Migration (Terminally PQ IO)) schemas0 schemas1

301+ -> PQ MigrationsSchemas MigrationsSchemas IO ()

213− downMigrations = \case

302+ downMigrations = \case

214− Done -> return ()

303+ Done -> return ()

215− step :>> steps -> downMigrations steps & pqThen (downMigration step)

304+ step :>> steps -> downMigrations steps >> downMigration step

216−

305+

217− downMigration

306+ downMigration

218− :: MonadBase IO io

307+ :: Migration (Terminally PQ IO) schemas0 schemas1

219− => Migration io schemas0 schemas1 -> PQ

308+ -> PQ MigrationsSchemas MigrationsSchemas IO ()

220− ("migrations" ::: MigrationsSchema ': schemas1)

221− ("migrations" ::: MigrationsSchema ': schemas0)

222− io ()

223− downMigration step =

309+ downMigration step = do

224− queryExecuted step

310+ executed <- queryExecuted step

225− & pqBind (\ executed ->

311+ unless (executed == 0) $ do

226− if executed == 0 -- up step has not been executed

312+ unsafePQ . runTerminally $ down step

227− then PQ (\ _ -> return (K ())) -- unsafely switch schemas

228− else

229− pqEmbed (down step) -- safely switch schemas

230− & pqThen (manipulateParams deleteMigration (Only (name step)))

313+ manipulateParams_ deleteMigration (Only (name step))

231− -- delete execution record

314+

232− & pqBind okResult)

233−

234− queryExecuted

315+ queryExecuted

235− :: MonadBase IO io

316+ :: Migration (Terminally PQ IO) schemas0 schemas1

236− => Migration io schemas0 schemas1 -> PQ

317+ -> PQ MigrationsSchemas MigrationsSchemas IO Row

237− ("migrations" ::: MigrationsSchema ': schemas1)

238− ("migrations" ::: MigrationsSchema ': schemas1)

239− io Row

240− queryExecuted step = do

318+ queryExecuted step = do

241− result <- runQueryParams selectMigration (Only (name step))

319+ result <- runQueryParams selectMigration (Only (name step))

242− okResult result

243− ntuples result

320+ ntuples result

244−

321+

245−okResult :: MonadBase IO io => K Result results -> PQ schema schema io ()

322+unsafePQ :: (Functor m) => PQ db0 db1 m x -> PQ db0' db1' m x

246−okResult result = do

323+unsafePQ (PQ pq) = PQ $ fmap (SOP.K . SOP.unK) . pq . SOP.K . SOP.unK

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)

253

324

254-- | The `TableType` for a Squeal migration.

325-- | The `TableType` for a Squeal migration.

255type MigrationsTable =

326type MigrationsTable =

@@ -258,40 +329,120 @@ type MigrationsTable =

258 , "executed_at" ::: 'Def :=> 'NotNull 'PGtimestamptz

329 , "executed_at" ::: 'Def :=> 'NotNull 'PGtimestamptz

259 ]

330 ]

260

331

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+

261type MigrationsSchema = '["schema_migrations" ::: 'Table MigrationsTable]

340type MigrationsSchema = '["schema_migrations" ::: 'Table MigrationsTable]

341+type MigrationsSchemas = Public MigrationsSchema

262

342

263-- | Creates a `MigrationsTable` if it does not already exist.

343-- | Creates a `MigrationsTable` if it does not already exist.

264−createMigrations

344+createMigrations :: Definition MigrationsSchemas MigrationsSchemas

265− :: Has "migrations" schemas MigrationsSchema

266− => Definition schemas schemas

267createMigrations =

345createMigrations =

268− createSchemaIfNotExists #migrations >>>

269− createTableIfNotExists (#migrations ! #schema_migrations)

346+ createTableIfNotExists #schema_migrations

270 ( (text & notNullable) `as` #name :*

347 ( (text & notNullable) `as` #name :*

271 (timestampWithTimeZone & notNullable & default_ currentTimestamp)

348 (timestampWithTimeZone & notNullable & default_ currentTimestamp)

272 `as` #executed_at )

349 `as` #executed_at )

273 ( unique #name `as` #migrations_unique_name )

350 ( unique #name `as` #migrations_unique_name )

274

351

275−-- | Inserts a `Migration` into the `MigrationsTable`

352+-- | Inserts a `Migration` into the `MigrationsTable`, returning

276−insertMigration

353+-- the time at which it was inserted.

277− :: Has "migrations" schemas MigrationsSchema

354+insertMigration :: Manipulation_ MigrationsSchemas (Only Text) ()

278− => Manipulation ('[] :=> schemas) '[ 'NotNull 'PGtext] '[]

279−insertMigration = insertInto_ (#migrations ! #schema_migrations) . Values_ $

355+insertMigration = insertInto_ #schema_migrations

280− (param @1) `as` #name :* defaultAs #executed_at

356+ (Values_ (Set (param @1) `as` #name :* Default `as` #executed_at))

281

357

282−-- | Deletes a `Migration` from the `MigrationsTable`

358+-- | Deletes a `Migration` from the `MigrationsTable`, returning

283−deleteMigration

359+-- the time at which it was inserted.

284− :: Has "migrations" schemas MigrationsSchema

360+deleteMigration :: Manipulation_ MigrationsSchemas (Only Text) ()

285− => Manipulation ('[] :=> schemas) '[ 'NotNull 'PGtext ] '[]

286−deleteMigration = deleteFrom_ (#migrations ! #schema_migrations) NoUsing (#name .== param @1)

361+deleteMigration = deleteFrom_ #schema_migrations (#name .== param @1)

287

362

288-- | Selects a `Migration` from the `MigrationsTable`, returning

363-- | Selects a `Migration` from the `MigrationsTable`, returning

289−-- the time at which it was executed.

364+-- the time at which it was inserted.

290selectMigration

365selectMigration

291− :: Has "migrations" schemas MigrationsSchema

366+ :: Query_ MigrationsSchemas (Only Text) (Only UTCTime)

292− => Query ('[] :=> schemas) '[ 'NotNull 'PGtext ]

293− '[ "executed_at" ::: 'NotNull 'PGtimestamptz ]

294−selectMigration = select_

367+selectMigration = select_ (#executed_at `as` #fromOnly)

295− (#executed_at `as` #executed_at)

296− ( from (table ((#migrations ! #schema_migrations) `as` #m))

368+ $ from (table (#schema_migrations))

297− & where_ (#name .== param @1))

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

squeal-postgresql/src/Squeal/PostgreSQL/PG.hsnew file+388

@@ -0,0 +1,388 @@

1+{-|

2+Module: Squeal.PostgreSQL.PG

3+Description: Embedding of Haskell types into Postgres's type system

4+Copyright: (c) Eitan Chatav, 2010

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+`Squeal.PostgreSQL.PG` provides type families for turning Haskell

9+`Type`s into corresponding Postgres types.

10+-}

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+171−131

@@ -6,7 +6,7 @@ Maintainer: eitan@morphism.tech

6Stability: experimental

8This module is where Squeal commands actually get executed by

9−`LibPQ`. It containts two typeclasses, `IndexedMonadTransPQ` for executing

9+`Database.PostgreSQL.LibPQ`. It containts two typeclasses, `IndexedMonadTransPQ` for executing

10a `Definition` and `MonadPQ` for executing a `Manipulation` or `Query`,

11and a `PQ` type with instances for them.

@@ -24,6 +24,7 @@ of executing Squeal commands.

24 , FunctionalDependencies

25 , FlexibleContexts

26 , FlexibleInstances

27+ , InstanceSigs

27 , OverloadedStrings

28 , OverloadedStrings

28 , RankNTypes

29 , RankNTypes

29 , ScopedTypeVariables

30 , ScopedTypeVariables

@@ -48,8 +49,6 @@ module Squeal.PostgreSQL.PQ

48 , evalPQ

49 , evalPQ

49 , IndexedMonadTransPQ (..)

50 , IndexedMonadTransPQ (..)

50 , MonadPQ (..)

51 , MonadPQ (..)

51− , PQRun

52− , pqliftWith

53 -- * Results

52 -- * Results

54 , LibPQ.Result

53 , LibPQ.Result

55 , LibPQ.Row

54 , LibPQ.Row

@@ -65,25 +64,30 @@ module Squeal.PostgreSQL.PQ

65 , resultErrorCode

64 , resultErrorCode

66 -- * Exceptions

65 -- * Exceptions

67 , SquealException (..)

66 , SquealException (..)

67+ , PQState (..)

68+ , okResult

68 , catchSqueal

69 , catchSqueal

69 , handleSqueal

70 , handleSqueal

71+ , trySqueal

70 ) where

72 ) where

72−import Control.Exception.Lifted

74+import Control.Exception (Exception, throw)

73−import Control.Monad.Base

74import Control.Monad.Except

75import Control.Monad.Except

75import Control.Monad.Morph

76import Control.Monad.Morph

76−import Control.Monad.Trans.Control

77+import UnliftIO (MonadUnliftIO (..), bracket, catch, handle, try)

77import Data.ByteString (ByteString)

78import Data.ByteString (ByteString)

78import Data.Foldable

79import Data.Foldable

79import Data.Function ((&))

80import Data.Function ((&))

81+import Data.Functor ((<&>))

80import Data.Kind

82import Data.Kind

81import Data.Text (pack, Text)

83import Data.Text (pack, Text)

82import Data.Traversable

84import Data.Traversable

83import Generics.SOP

85import Generics.SOP

84import PostgreSQL.Binary.Encoding (encodingBytes)

86import PostgreSQL.Binary.Encoding (encodingBytes)

88+import qualified Control.Monad.Fail as Fail

86import qualified Database.PostgreSQL.LibPQ as LibPQ

89import qualified Database.PostgreSQL.LibPQ as LibPQ

90+import qualified PostgreSQL.Binary.Encoding as Encoding

88import Squeal.PostgreSQL.Binary

92import Squeal.PostgreSQL.Binary

89import Squeal.PostgreSQL.Definition

93import Squeal.PostgreSQL.Definition

@@ -104,6 +108,9 @@ import qualified Control.Monad.Trans.Writer.Strict as Strict

104import qualified Control.Monad.Trans.RWS.Lazy as Lazy

108import qualified Control.Monad.Trans.RWS.Lazy as Lazy

105import qualified Control.Monad.Trans.RWS.Strict as Strict

109import qualified Control.Monad.Trans.RWS.Strict as Strict

106

110

111+-- $setup

112+-- >>> import Squeal.PostgreSQL

113+

107{- | Makes a new connection to the database server.

114{- | Makes a new connection to the database server.

108

115

109This function opens a new database connection using the parameters taken

116This function opens a new database connection using the parameters taken

@@ -131,19 +138,19 @@ with the wrong schema!

131-}

138-}

132connectdb

139connectdb

133 :: forall schemas io

140 :: forall schemas io

134− . MonadBase IO io

141+ . MonadIO io

135 => ByteString -- ^ conninfo

142 => ByteString -- ^ conninfo

136 -> io (K LibPQ.Connection schemas)

143 -> io (K LibPQ.Connection schemas)

137−connectdb = fmap K . liftBase . LibPQ.connectdb

144+connectdb = fmap K . liftIO . LibPQ.connectdb

138

145

139-- | Closes the connection to the server.

146-- | Closes the connection to the server.

140−finish :: MonadBase IO io => K LibPQ.Connection schemas -> io ()

147+finish :: MonadIO io => K LibPQ.Connection schemas -> io ()

141−finish = liftBase . LibPQ.finish . unK

148+finish = liftIO . LibPQ.finish . unK

142

149

143-- | Do `connectdb` and `finish` before and after a computation.

150-- | Do `connectdb` and `finish` before and after a computation.

144withConnection

151withConnection

145 :: forall schemas0 schemas1 io x

152 :: forall schemas0 schemas1 io x

146− . MonadBaseControl IO io

153+ . MonadUnliftIO io

147 => ByteString

154 => ByteString

148 -> PQ schemas0 schemas1 io x

155 -> PQ schemas0 schemas1 io x

149 -> io x

156 -> io x

@@ -171,7 +178,7 @@ instance Monad m => Functor (PQ schemas0 schemas1 m) where

171 K x <- pq conn

178 K x <- pq conn

172 return $ K (f x)

179 return $ K (f x)

173

180

174−-- | Run a `PQ` and keep the result and the `Connection`.

181+-- | Run a `PQ` and keep the result and the `LibPQ.Connection`.

175runPQ

182runPQ

176 :: Functor m

183 :: Functor m

177 => PQ schemas0 schemas1 m x

184 => PQ schemas0 schemas1 m x

@@ -181,7 +188,7 @@ runPQ (PQ pq) conn = (\ x -> (unK x, K (unK conn))) <$> pq conn

181 -- K x <- pq conn

188 -- K x <- pq conn

182 -- return (x, K (unK conn))

189 -- return (x, K (unK conn))

183

190

184−-- | Execute a `PQ` and discard the result but keep the `Connection`.

191+-- | Execute a `PQ` and discard the result but keep the `LibPQ.Connection`.

185execPQ

192execPQ

186 :: Functor m

193 :: Functor m

187 => PQ schemas0 schemas1 m x

194 => PQ schemas0 schemas1 m x

@@ -189,7 +196,7 @@ execPQ

189 -> m (K LibPQ.Connection schemas1)

196 -> m (K LibPQ.Connection schemas1)

190execPQ (PQ pq) conn = mapKK (\ _ -> unK conn) <$> pq conn

197execPQ (PQ pq) conn = mapKK (\ _ -> unK conn) <$> pq conn

191

198

192−-- | Evaluate a `PQ` and discard the `Connection` but keep the result.

199+-- | Evaluate a `PQ` and discard the `LibPQ.Connection` but keep the result.

193evalPQ

200evalPQ

194 :: Functor m

201 :: Functor m

195 => PQ schemas0 schemas1 m x

202 => PQ schemas0 schemas1 m x

@@ -201,8 +208,7 @@ evalPQ (PQ pq) conn = unK <$> pq conn

201-- [enriched category](https://ncatlab.org/nlab/show/enriched+category).

208-- [enriched category](https://ncatlab.org/nlab/show/enriched+category).

202-- An indexed monad transformer transforms a `Monad` into an indexed monad.

209-- An indexed monad transformer transforms a `Monad` into an indexed monad.

203-- And, `IndexedMonadTransPQ` is a class for indexed monad transformers that

210-- And, `IndexedMonadTransPQ` is a class for indexed monad transformers that

204−-- support running `Definition`s using `define` and embedding a computation

211+-- support running `Definition`s using `define`.

205−-- in a larger schema using `pqEmbed`.

206class IndexedMonadTransPQ pq where

212class IndexedMonadTransPQ pq where

207

213

208 -- | indexed analog of `<*>`

214 -- | indexed analog of `<*>`

@@ -242,19 +248,16 @@ class IndexedMonadTransPQ pq where

242 -> x -> pq schemas0 schemas2 m z

248 -> x -> pq schemas0 schemas2 m z

243 pqAndThen g f x = pqBind g (f x)

249 pqAndThen g f x = pqBind g (f x)

244

250

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

251+ -- | Run a `Definition` with `LibPQ.exec`.

252+ --

253+ -- It should be functorial in effect.

252 --

254 --

255+ -- @define id = return ()@

253− -- @define statement1 & pqThen (define statement2) = define (statement1 >>> statement2)@

256+ -- @define (statement1 >>> statement2) = define statement1 & pqThen (define statement2)@

254 define

257 define

255− :: MonadBase IO io

258+ :: MonadIO io

256 => Definition schemas0 schemas1

259 => Definition schemas0 schemas1

257− -> pq schemas0 schemas1 io (K LibPQ.Result '[])

260+ -> pq schemas0 schemas1 io ()

258

261

259instance IndexedMonadTransPQ PQ where

262instance IndexedMonadTransPQ PQ where

260

263

@@ -267,26 +270,26 @@ instance IndexedMonadTransPQ PQ where

267 K x' <- x conn

270 K x' <- x conn

268 unPQ (f x') (K (unK conn))

271 unPQ (f x') (K (unK conn))

269

272

270− pqEmbed (PQ pq) = PQ $ \ (K conn) -> do

271− K x <- pq (K conn)

272− return $ K x

273−

274 define (UnsafeDefinition q) = PQ $ \ (K conn) -> do

273 define (UnsafeDefinition q) = PQ $ \ (K conn) -> do

275− resultMaybe <- liftBase $ LibPQ.exec conn q

274+ resultMaybe <- liftIO $ LibPQ.exec conn q

276 case resultMaybe of

275 case resultMaybe of

277 Nothing -> throw $ ResultException

276 Nothing -> throw $ ResultException

278 "define: LibPQ.exec returned no results"

277 "define: LibPQ.exec returned no results"

279− Just result -> return $ K (K result)

278+ Just result -> K <$> okResult_ result

280

279

281−{- | `MonadPQ` is an `mtl` style constraint, similar to

280+{- | `MonadPQ` is an @mtl@ style constraint, similar to

282−`Control.Monad.State.Class.MonadState`, for using `LibPQ` to

281+`Control.Monad.State.Class.MonadState`, for using `Database.PostgreSQL.LibPQ` to

283

282

284* `manipulateParams` runs a `Manipulation` with params from a type

283* `manipulateParams` runs a `Manipulation` with params from a type

285 with a `ToParams` constraint. It calls `LibPQ.execParams` and

284 with a `ToParams` constraint. It calls `LibPQ.execParams` and

286 doesn't afraid of anything.

285 doesn't afraid of anything.

287

286

287+* `manipulateParams_` is like `manipulateParams` for a returning-free statement.

288+

288* `manipulate` is like `manipulateParams` for a parameter-free statement.

289* `manipulate` is like `manipulateParams` for a parameter-free statement.

289

290

291+* `manipulate_` is like `manipulate` for a returning-free statement.

292+

290* `runQueryParams` is like `manipulateParams` for query statements.

293* `runQueryParams` is like `manipulateParams` for query statements.

291

294

292* `runQuery` is like `runQueryParams` for a parameter-free statement.

295* `runQuery` is like `runQueryParams` for a parameter-free statement.

@@ -300,11 +303,11 @@ instance IndexedMonadTransPQ PQ where

300* `forPrepared` is a flipped `traversePrepared`

303* `forPrepared` is a flipped `traversePrepared`

301

304

302* `traversePrepared_` is like `traversePrepared` but works on `Foldable`

305* `traversePrepared_` is like `traversePrepared` but works on `Foldable`

303− containers and returns unit.

306+ containers for a returning-free statement.

304

307

305* `forPrepared_` is a flipped `traversePrepared_`.

308* `forPrepared_` is a flipped `traversePrepared_`.

306

309

307−* `liftPQ` lets you lift actions from `LibPQ` that require a connection

310+* `liftPQ` lets you lift actions from `Database.PostgreSQL.LibPQ` that require a connection

308 into your monad.

311 into your monad.

309

312

310To define an instance, you can minimally define only `manipulateParams`,

313To define an instance, you can minimally define only `manipulateParams`,

@@ -314,74 +317,84 @@ a default instance.

314-}

317-}

315class Monad pq => MonadPQ schemas pq | pq -> schemas where

318class Monad pq => MonadPQ schemas pq | pq -> schemas where

316 manipulateParams

319 manipulateParams

317− :: ToParams x params

320+ :: (ToParams x params, All OidOfParam params)

318− => Manipulation ('[] :=> schemas) params ys

321+ => Manipulation '[] schemas params ys

319− -- ^ `insertRows`, `update` or `deleteFrom`

322+ -- ^ `insertInto`, `update` or `deleteFrom`

320 -> x -> pq (K LibPQ.Result ys)

323 -> x -> pq (K LibPQ.Result ys)

321 default manipulateParams

324 default manipulateParams

322 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

325 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

323− => ToParams x params

326+ => (ToParams x params, All OidOfParam params)

324− => Manipulation ('[] :=> schemas) params ys

327+ => Manipulation '[] schemas params ys

325− -- ^ `insertRows`, `update` or `deleteFrom`

328+ -- ^ `insertInto`, `update` or `deleteFrom`

326 -> x -> pq (K LibPQ.Result ys)

329 -> x -> pq (K LibPQ.Result ys)

327 manipulateParams manipulation params = lift $

330 manipulateParams manipulation params = lift $

328 manipulateParams manipulation params

331 manipulateParams manipulation params

329

332

333+ manipulateParams_

334+ :: (ToParams x params, All OidOfParam params)

335+ => Manipulation '[] schemas params '[]

336+ -- ^ `insertInto`, `update` or `deleteFrom`

337+ -> x -> pq ()

338+ manipulateParams_ q x = void $ manipulateParams q x

339+

330− manipulate :: Manipulation ('[] :=> schemas) '[] ys -> pq (K LibPQ.Result ys)

340+ manipulate :: Manipulation '[] schemas '[] ys -> pq (K LibPQ.Result ys)

331 manipulate statement = manipulateParams statement ()

341 manipulate statement = manipulateParams statement ()

332

342

343+ manipulate_ :: Manipulation '[] schemas '[] '[] -> pq ()

344+ manipulate_ = void . manipulate

345+

333 runQueryParams

346 runQueryParams

334− :: ToParams x params

347+ :: (ToParams x params, All OidOfParam params)

335− => Query ('[] :=> schemas) params ys

348+ => Query '[] '[] schemas params ys

336 -- ^ `select` and friends

349 -- ^ `select` and friends

337 -> x -> pq (K LibPQ.Result ys)

350 -> x -> pq (K LibPQ.Result ys)

338 runQueryParams = manipulateParams . queryStatement

351 runQueryParams = manipulateParams . queryStatement

339

352

340 runQuery

353 runQuery

341− :: Query ('[] :=> schemas) '[] ys

354+ :: Query '[] '[] schemas '[] ys

342 -- ^ `select` and friends

355 -- ^ `select` and friends

343 -> pq (K LibPQ.Result ys)

356 -> pq (K LibPQ.Result ys)

344 runQuery q = runQueryParams q ()

357 runQuery q = runQueryParams q ()

345

358

346 traversePrepared

359 traversePrepared

347− :: (ToParams x params, Traversable list)

360+ :: (ToParams x params, Traversable list, All OidOfParam params)

348− => Manipulation ('[] :=> schemas) params ys

361+ => Manipulation '[] schemas params ys

349− -- ^ `insertRows`, `update`, or `deleteFrom`, and friends

362+ -- ^ `insertInto`, `update`, or `deleteFrom`, and friends

350 -> list x -> pq (list (K LibPQ.Result ys))

363 -> list x -> pq (list (K LibPQ.Result ys))

351 default traversePrepared

364 default traversePrepared

352 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

365 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

353− => (ToParams x params, Traversable list)

366+ => (ToParams x params, Traversable list, All OidOfParam params)

354− => Manipulation ('[] :=> schemas) params ys -> list x -> pq (list (K LibPQ.Result ys))

367+ => Manipulation '[] schemas params ys -> list x -> pq (list (K LibPQ.Result ys))

355 traversePrepared manipulation params = lift $

368 traversePrepared manipulation params = lift $

356 traversePrepared manipulation params

369 traversePrepared manipulation params

357

370

358 forPrepared

371 forPrepared

359− :: (ToParams x params, Traversable list)

372+ :: (ToParams x params, Traversable list, All OidOfParam params)

360 => list x

373 => list x

361− -> Manipulation ('[] :=> schemas) params ys

374+ -> Manipulation '[] schemas params ys

362− -- ^ `insertRows`, `update` or `deleteFrom`

375+ -- ^ `insertInto`, `update` or `deleteFrom`

363 -> pq (list (K LibPQ.Result ys))

376 -> pq (list (K LibPQ.Result ys))

364 forPrepared = flip traversePrepared

377 forPrepared = flip traversePrepared

365

378

366 traversePrepared_

379 traversePrepared_

367− :: (ToParams x params, Foldable list)

380+ :: (ToParams x params, Foldable list, All OidOfParam params)

368− => Manipulation ('[] :=> schemas) params '[]

381+ => Manipulation '[] schemas params '[]

369− -- ^ `insertRows`, `update` or `deleteFrom`

382+ -- ^ `insertInto`, `update` or `deleteFrom`

370 -> list x -> pq ()

383 -> list x -> pq ()

371 default traversePrepared_

384 default traversePrepared_

372 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

385 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

373− => (ToParams x params, Foldable list)

386+ => (ToParams x params, Foldable list, All OidOfParam params)

374− => Manipulation ('[] :=> schemas) params '[]

387+ => Manipulation '[] schemas params '[]

375− -- ^ `insertRows`, `update` or `deleteFrom`

388+ -- ^ `insertInto`, `update` or `deleteFrom`

376 -> list x -> pq ()

389 -> list x -> pq ()

377 traversePrepared_ manipulation params = lift $

390 traversePrepared_ manipulation params = lift $

378 traversePrepared_ manipulation params

391 traversePrepared_ manipulation params

379

392

380 forPrepared_

393 forPrepared_

381− :: (ToParams x params, Foldable list)

394+ :: (ToParams x params, Foldable list, All OidOfParam params)

382 => list x

395 => list x

383− -> Manipulation ('[] :=> schemas) params '[]

396+ -> Manipulation '[] schemas params '[]

384− -- ^ `insertRows`, `update` or `deleteFrom`

397+ -- ^ `insertInto`, `update` or `deleteFrom`

385 -> pq ()

398 -> pq ()

386 forPrepared_ = flip traversePrepared_

399 forPrepared_ = flip traversePrepared_

387

400

@@ -391,61 +404,83 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

391 => (LibPQ.Connection -> IO a) -> pq a

404 => (LibPQ.Connection -> IO a) -> pq a

392 liftPQ = lift . liftPQ

405 liftPQ = lift . liftPQ

393

406

394−instance (MonadBase IO io, schemas0 ~ schemas, schemas1 ~ schemas)

407+instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

395 => MonadPQ schemas (PQ schemas0 schemas1 io) where

408 => MonadPQ schemas (PQ schemas0 schemas1 io) where

396

409

397 manipulateParams

410 manipulateParams

398− (UnsafeManipulation q :: Manipulation ('[] :=> schemas) ps ys) (params :: x) =

411+ (UnsafeManipulation q :: Manipulation '[] schemas ps ys) (params :: x) =

399 PQ $ \ (K conn) -> do

412 PQ $ \ (K conn) -> do

400 let

413 let

401− toParam' encoding =

414+ paramSet

415+ :: forall param. OidOfParam param

416+ => K (Maybe Encoding.Encoding) param

417+ -> K (Maybe (LibPQ.Oid, ByteString, LibPQ.Format)) param

418+ paramSet (K maybeEncoding) = K $

419+ maybeEncoding <&> \encoding ->

402− (LibPQ.invalidOid, encodingBytes encoding, LibPQ.Binary)

420+ (oidOfParam @param, encodingBytes encoding, LibPQ.Binary)

421+ params'

422+ = hcollapse

423+ . hcmap (Proxy @OidOfParam) paramSet

403− params' = fmap (fmap toParam') (hcollapse (toParams @x @ps params))

424+ $ toParams @x @ps params

404 q' = q <> ";"

425 q' = q <> ";"

405− resultMaybe <- liftBase $ LibPQ.execParams conn q' params' LibPQ.Binary

426+ resultMaybe <- liftIO $ LibPQ.execParams conn q' params' LibPQ.Binary

406 case resultMaybe of

427 case resultMaybe of

407 Nothing -> throw $ ResultException

428 Nothing -> throw $ ResultException

408 "manipulateParams: LibPQ.execParams returned no results"

429 "manipulateParams: LibPQ.execParams returned no results"

409 Just result -> do

430 Just result -> do

410− tryResult result

431+ okResult_ result

411 return $ K (K result)

432 return $ K (K result)

412

433

413 traversePrepared

434 traversePrepared

414− (UnsafeManipulation q :: Manipulation ('[] :=> schemas) xs ys) (list :: list x) =

435+ (UnsafeManipulation q :: Manipulation '[] schemas xs ys) (list :: list x) =

415− PQ $ \ (K conn) -> liftBase $ do

436+ PQ $ \ (K conn) -> liftIO $ do

437+ let

416− let temp = "temporary_statement"

438+ temp = "temporary_statement"

439+ paramOid :: forall p. OidOfParam p => K LibPQ.Oid p

440+ paramOid = K (oidOfParam @p)

441+ paramOids :: NP (K LibPQ.Oid) xs

442+ paramOids = hcpure (Proxy @OidOfParam) paramOid

443+ paramOids' :: [LibPQ.Oid]

444+ paramOids' = hcollapse paramOids

417− prepResultMaybe <- LibPQ.prepare conn temp q Nothing

445+ prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

418 case prepResultMaybe of

446 case prepResultMaybe of

419 Nothing -> throw $ ResultException

447 Nothing -> throw $ ResultException

420 "traversePrepared: LibPQ.prepare returned no results"

448 "traversePrepared: LibPQ.prepare returned no results"

421− Just prepResult -> tryResult prepResult

449+ Just prepResult -> okResult_ prepResult

422 results <- for list $ \ params -> do

450 results <- for list $ \ params -> do

423 let

451 let

424− toParam' encoding = (encodingBytes encoding,LibPQ.Binary)

452+ toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

425 params' = fmap (fmap toParam') (hcollapse (toParams @x @xs params))

453 params' = fmap (fmap toParam') (hcollapse (toParams @x @xs params))

426 resultMaybe <- LibPQ.execPrepared conn temp params' LibPQ.Binary

454 resultMaybe <- LibPQ.execPrepared conn temp params' LibPQ.Binary

427 case resultMaybe of

455 case resultMaybe of

428 Nothing -> throw $ ResultException

456 Nothing -> throw $ ResultException

429 "traversePrepared: LibPQ.execParams returned no results"

457 "traversePrepared: LibPQ.execParams returned no results"

430 Just result -> do

458 Just result -> do

431− tryResult result

459+ okResult_ result

432 return $ K result

460 return $ K result

433 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

461 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

434 case deallocResultMaybe of

462 case deallocResultMaybe of

435 Nothing -> throw $ ResultException

463 Nothing -> throw $ ResultException

436 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

464 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

437− Just deallocResult -> tryResult deallocResult

465+ Just deallocResult -> okResult_ deallocResult

438 return (K results)

466 return (K results)

439

467

440 traversePrepared_

468 traversePrepared_

441− (UnsafeManipulation q :: Manipulation ('[] :=> schemas) xs '[]) (list :: list x) =

469+ (UnsafeManipulation q :: Manipulation '[] schemas xs '[]) (list :: list x) =

442− PQ $ \ (K conn) -> liftBase $ do

470+ PQ $ \ (K conn) -> liftIO $ do

471+ let

443− let temp = "temporary_statement"

472+ temp = "temporary_statement"

473+ paramOid :: forall p. OidOfParam p => K LibPQ.Oid p

474+ paramOid = K (oidOfParam @p)

475+ paramOids :: NP (K LibPQ.Oid) xs

476+ paramOids = hcpure (Proxy @OidOfParam) paramOid

477+ paramOids' :: [LibPQ.Oid]

478+ paramOids' = hcollapse paramOids

444− prepResultMaybe <- LibPQ.prepare conn temp q Nothing

479+ prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

445 case prepResultMaybe of

480 case prepResultMaybe of

446 Nothing -> throw $ ResultException

481 Nothing -> throw $ ResultException

447 "traversePrepared_: LibPQ.prepare returned no results"

482 "traversePrepared_: LibPQ.prepare returned no results"

448− Just prepResult -> tryResult prepResult

483+ Just prepResult -> okResult_ prepResult

449 for_ list $ \ params -> do

484 for_ list $ \ params -> do

450 let

485 let

451 toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

486 toParam' encoding = (encodingBytes encoding, LibPQ.Binary)

@@ -454,16 +489,16 @@ instance (MonadBase IO io, schemas0 ~ schemas, schemas1 ~ schemas)

454 case resultMaybe of

489 case resultMaybe of

455 Nothing -> throw $ ResultException

490 Nothing -> throw $ ResultException

456 "traversePrepared_: LibPQ.execParams returned no results"

491 "traversePrepared_: LibPQ.execParams returned no results"

457− Just result -> tryResult result

492+ Just result -> okResult_ result

458 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

493 deallocResultMaybe <- LibPQ.exec conn ("DEALLOCATE " <> temp <> ";")

459 case deallocResultMaybe of

494 case deallocResultMaybe of

460 Nothing -> throw $ ResultException

495 Nothing -> throw $ ResultException

461 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

496 "traversePrepared: LibPQ.exec DEALLOCATE returned no results"

462− Just deallocResult -> tryResult deallocResult

497+ Just deallocResult -> okResult_ deallocResult

463 return (K ())

498 return (K ())

464

499

465 liftPQ pq = PQ $ \ (K conn) -> do

500 liftPQ pq = PQ $ \ (K conn) -> do

466− y <- liftBase $ pq conn

501+ y <- liftIO $ pq conn

467 return (K y)

502 return (K y)

468

503

469instance MonadPQ schemas m => MonadPQ schemas (IdentityT m)

504instance MonadPQ schemas m => MonadPQ schemas (IdentityT m)

@@ -488,6 +523,10 @@ instance (Monad m, schemas0 ~ schemas1)

488 return = pure

523 return = pure

489 (>>=) = flip pqBind

524 (>>=) = flip pqBind

490

525

526+instance (Monad m, schemas0 ~ schemas1)

527+ => Fail.MonadFail (PQ schemas0 schemas1 m) where

528+ fail = Fail.fail

529+

491instance schemas0 ~ schemas1 => MFunctor (PQ schemas0 schemas1) where

530instance schemas0 ~ schemas1 => MFunctor (PQ schemas0 schemas1) where

492 hoist f (PQ pq) = PQ (f . pq)

531 hoist f (PQ pq) = PQ (f . pq)

493

532

@@ -500,40 +539,29 @@ instance schemas0 ~ schemas1 => MMonad (PQ schemas0 schemas1) where

500 embed f (PQ pq) = PQ $ \ conn -> do

539 embed f (PQ pq) = PQ $ \ conn -> do

501 evalPQ (f (pq conn)) conn

540 evalPQ (f (pq conn)) conn

502

541

503−instance (MonadBase b m, schemas0 ~ schemas1)

504− => MonadBase b (PQ schemas0 schemas1 m) where

505− liftBase = lift . liftBase

506−

507instance (MonadIO m, schema0 ~ schema1)

542instance (MonadIO m, schema0 ~ schema1)

508 => MonadIO (PQ schema0 schema1 m) where

543 => MonadIO (PQ schema0 schema1 m) where

509 liftIO = lift . liftIO

544 liftIO = lift . liftIO

510

545

511−-- | A snapshot of the state of a `PQ` computation.

546+instance (MonadUnliftIO m, schemas0 ~ schemas1)

512−type PQRun schemas =

547+ => MonadUnliftIO (PQ schemas0 schemas1 m) where

513− forall m x. Monad m => PQ schemas schemas m x -> m (K x schemas)

548+ withRunInIO

514−

549+ :: ((forall a . PQ schemas0 schema1 m a -> IO a) -> IO b)

515−-- | Helper function in defining `MonadBaseControl` instance for `PQ`.

550+ -> PQ schemas0 schema1 m b

516−pqliftWith :: Functor m => (PQRun schemas -> m a) -> PQ schemas schemas m a

551+ withRunInIO inner = PQ $ \conn ->

517−pqliftWith f = PQ $ \ conn ->

552+ withRunInIO $ \(run :: (forall x . m x -> IO x)) ->

518− fmap K (f $ \ pq -> unPQ pq conn)

553+ K <$> inner (\pq -> run $ unK <$> 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

526

554

527-- | Get a row corresponding to a given row number from a `LibPQ.Result`,

555-- | Get a row corresponding to a given row number from a `LibPQ.Result`,

528-- throwing an exception if the row number is out of bounds.

556-- throwing an exception if the row number is out of bounds.

529getRow

557getRow

530− :: (FromRow columns y, MonadBase IO io)

558+ :: (FromRow columns y, MonadIO io)

531 => LibPQ.Row

559 => LibPQ.Row

532 -- ^ row number

560 -- ^ row number

533 -> K LibPQ.Result columns

561 -> K LibPQ.Result columns

534 -- ^ result

562 -- ^ result

535 -> io y

563 -> io y

536−getRow r (K result :: K LibPQ.Result columns) = liftBase $ do

564+getRow r (K result :: K LibPQ.Result columns) = liftIO $ do

537 numRows <- LibPQ.ntuples result

565 numRows <- LibPQ.ntuples result

538 when (numRows < r) $ throw $ ResultException $

566 when (numRows < r) $ throw $ ResultException $

539 "getRow: expected at least " <> pack (show r) <> "rows but only saw "

567 "getRow: expected at least " <> pack (show r) <> "rows but only saw "

@@ -551,13 +579,13 @@ getRow r (K result :: K LibPQ.Result columns) = liftBase $ do

551-- and a `LibPQ.Result` and given a row number if it's too large returns `Nothing`,

579-- and a `LibPQ.Result` and given a row number if it's too large returns `Nothing`,

552-- otherwise returning the row along with the next row number.

580-- otherwise returning the row along with the next row number.

553nextRow

581nextRow

554− :: (FromRow columns y, MonadBase IO io)

582+ :: (FromRow columns y, MonadIO io)

555 => LibPQ.Row -- ^ total number of rows

583 => LibPQ.Row -- ^ total number of rows

556 -> K LibPQ.Result columns -- ^ result

584 -> K LibPQ.Result columns -- ^ result

557 -> LibPQ.Row -- ^ row number

585 -> LibPQ.Row -- ^ row number

558 -> io (Maybe (LibPQ.Row,y))

586 -> io (Maybe (LibPQ.Row,y))

559nextRow total (K result :: K LibPQ.Result columns) r

587nextRow total (K result :: K LibPQ.Result columns) r

560− = liftBase $ if r >= total then return Nothing else do

588+ = liftIO $ if r >= total then return Nothing else do

561 let len = fromIntegral (lengthSList (Proxy @columns))

589 let len = fromIntegral (lengthSList (Proxy @columns))

562 row' <- traverse (LibPQ.getvalue result r) [0 .. len - 1]

590 row' <- traverse (LibPQ.getvalue result r) [0 .. len - 1]

563 case fromList row' of

591 case fromList row' of

@@ -568,10 +596,10 @@ nextRow total (K result :: K LibPQ.Result columns) r

568

596

569-- | Get all rows from a `LibPQ.Result`.

597-- | Get all rows from a `LibPQ.Result`.

570getRows

598getRows

571− :: (FromRow columns y, MonadBase IO io)

599+ :: (FromRow columns y, MonadIO io)

572 => K LibPQ.Result columns -- ^ result

600 => K LibPQ.Result columns -- ^ result

573 -> io [y]

601 -> io [y]

574−getRows (K result :: K LibPQ.Result columns) = liftBase $ do

602+getRows (K result :: K LibPQ.Result columns) = liftIO $ do

575 let len = fromIntegral (lengthSList (Proxy @columns))

603 let len = fromIntegral (lengthSList (Proxy @columns))

576 numRows <- LibPQ.ntuples result

604 numRows <- LibPQ.ntuples result

577 for [0 .. numRows - 1] $ \ r -> do

605 for [0 .. numRows - 1] $ \ r -> do

@@ -584,10 +612,10 @@ getRows (K result :: K LibPQ.Result columns) = liftBase $ do

584

612

585-- | Get the first row if possible from a `LibPQ.Result`.

613-- | Get the first row if possible from a `LibPQ.Result`.

586firstRow

614firstRow

587− :: (FromRow columns y, MonadBase IO io)

615+ :: (FromRow columns y, MonadIO io)

588 => K LibPQ.Result columns -- ^ result

616 => K LibPQ.Result columns -- ^ result

589 -> io (Maybe y)

617 -> io (Maybe y)

590−firstRow (K result :: K LibPQ.Result columns) = liftBase $ do

618+firstRow (K result :: K LibPQ.Result columns) = liftIO $ do

591 numRows <- LibPQ.ntuples result

619 numRows <- LibPQ.ntuples result

592 if numRows <= 0 then return Nothing else do

620 if numRows <= 0 then return Nothing else do

593 let len = fromIntegral (lengthSList (Proxy @columns))

621 let len = fromIntegral (lengthSList (Proxy @columns))

@@ -600,23 +628,23 @@ firstRow (K result :: K LibPQ.Result columns) = liftBase $ do

600

628

601-- | Lifts actions on results from @LibPQ@.

629-- | Lifts actions on results from @LibPQ@.

602liftResult

630liftResult

603− :: MonadBase IO io

631+ :: MonadIO io

604 => (LibPQ.Result -> IO x)

632 => (LibPQ.Result -> IO x)

605 -> K LibPQ.Result results -> io x

633 -> K LibPQ.Result results -> io x

606−liftResult f (K result) = liftBase $ f result

634+liftResult f (K result) = liftIO $ f result

607

635

608-- | Returns the number of rows (tuples) in the query result.

636-- | Returns the number of rows (tuples) in the query result.

609−ntuples :: MonadBase IO io => K LibPQ.Result columns -> io LibPQ.Row

637+ntuples :: MonadIO io => K LibPQ.Result columns -> io LibPQ.Row

610ntuples = liftResult LibPQ.ntuples

638ntuples = liftResult LibPQ.ntuples

611

639

612-- | Returns the result status of the command.

640-- | Returns the result status of the command.

613−resultStatus :: MonadBase IO io => K LibPQ.Result results -> io LibPQ.ExecStatus

641+resultStatus :: MonadIO io => K LibPQ.Result results -> io LibPQ.ExecStatus

614resultStatus = liftResult LibPQ.resultStatus

642resultStatus = liftResult LibPQ.resultStatus

615

643

616-- | Returns the error message most recently generated by an operation

644-- | Returns the error message most recently generated by an operation

617-- on the connection.

645-- on the connection.

618resultErrorMessage

646resultErrorMessage

619− :: MonadBase IO io => K LibPQ.Result results -> io (Maybe ByteString)

647+ :: MonadIO io => K LibPQ.Result results -> io (Maybe ByteString)

620resultErrorMessage = liftResult LibPQ.resultErrorMessage

648resultErrorMessage = liftResult LibPQ.resultErrorMessage

621

649

622-- | Returns the error code most recently generated by an operation

650-- | Returns the error code most recently generated by an operation

@@ -624,29 +652,29 @@ resultErrorMessage = liftResult LibPQ.resultErrorMessage

624--

652--

625-- https://www.postgresql.org/docs/current/static/errcodes-appendix.html

653-- https://www.postgresql.org/docs/current/static/errcodes-appendix.html

626resultErrorCode

654resultErrorCode

627− :: MonadBase IO io

655+ :: MonadIO io

628 => K LibPQ.Result results

656 => K LibPQ.Result results

629 -> io (Maybe ByteString)

657 -> io (Maybe ByteString)

630resultErrorCode = liftResult (flip LibPQ.resultErrorField LibPQ.DiagSqlstate)

658resultErrorCode = liftResult (flip LibPQ.resultErrorField LibPQ.DiagSqlstate)

631

659

632−-- | `Exception`s that can be thrown by Squeal.

660+-- | the state of LibPQ

633−data SquealException

661+data PQState = PQState

634− = PQException

635 { sqlExecStatus :: LibPQ.ExecStatus

662 { sqlExecStatus :: LibPQ.ExecStatus

636 , sqlStateCode :: Maybe ByteString

663 , sqlStateCode :: Maybe ByteString

637 -- ^ https://www.postgresql.org/docs/current/static/errcodes-appendix.html

664 -- ^ https://www.postgresql.org/docs/current/static/errcodes-appendix.html

638 , sqlErrorMessage :: Maybe ByteString

665 , sqlErrorMessage :: Maybe ByteString

639− }

666+ } deriving (Eq, Show)

667+

668+-- | `Exception`s that can be thrown by Squeal.

669+data SquealException

670+ = PQException PQState

640 | ResultException Text

671 | ResultException Text

641 | ParseException Text

672 | ParseException Text

642 deriving (Eq, Show)

673 deriving (Eq, Show)

643instance Exception SquealException

674instance Exception SquealException

644

675

645−tryResult

676+okResult_ :: MonadIO io => LibPQ.Result -> io ()

646− :: MonadBase IO io

677+okResult_ result = liftIO $ do

647− => LibPQ.Result

648− -> io ()

649−tryResult result = liftBase $ do

650 status <- LibPQ.resultStatus result

678 status <- LibPQ.resultStatus result

651 case status of

679 case status of

652 LibPQ.CommandOk -> return ()

680 LibPQ.CommandOk -> return ()

@@ -654,11 +682,16 @@ tryResult result = liftBase $ do

654 _ -> do

682 _ -> do

655 stateCode <- LibPQ.resultErrorField result LibPQ.DiagSqlstate

683 stateCode <- LibPQ.resultErrorField result LibPQ.DiagSqlstate

656 msg <- LibPQ.resultErrorMessage result

684 msg <- LibPQ.resultErrorMessage result

657− throw $ PQException status stateCode msg

685+ throw . PQException $ PQState status stateCode msg

686+

687+-- | Check if a `LibPQ.Result`'s status is either `LibPQ.CommandOk`

688+-- or `LibPQ.TuplesOk` otherwise `throw` a `PQException`.

689+okResult :: MonadIO io => K LibPQ.Result row -> io ()

690+okResult = okResult_ . unK

658

691

659-- | Catch `SquealException`s.

692-- | Catch `SquealException`s.

660catchSqueal

693catchSqueal

661− :: MonadBaseControl IO io

694+ :: MonadUnliftIO io

662 => io a

695 => io a

663 -> (SquealException -> io a) -- ^ handler

696 -> (SquealException -> io a) -- ^ handler

664 -> io a

697 -> io a

@@ -666,7 +699,14 @@ catchSqueal = catch

666

699

667-- | Handle `SquealException`s.

700-- | Handle `SquealException`s.

668handleSqueal

701handleSqueal

669− :: MonadBaseControl IO io

702+ :: MonadUnliftIO io

670 => (SquealException -> io a) -- ^ handler

703 => (SquealException -> io a) -- ^ handler

671 -> io a -> io a

704 -> io a -> io a

672handleSqueal = handle

705handleSqueal = handle

706+

707+-- | `Either` return a `SquealException` or a result.

708+trySqueal

709+ :: MonadUnliftIO io

710+ => io a

711+ -> io (Either SquealException a)

712+trySqueal = try

squeal-postgresql/src/Squeal/PostgreSQL/Pool.hs+72−103

@@ -1,17 +1,40 @@

1{-|

2−Module: Squeal.PostgreSQL.Definition

2+Module: Squeal.PostgreSQL.Pool

3−Description: Pooled connections

3+Description: Connection pools

4Copyright: (c) Eitan Chatav, 2017

5Maintainer: eitan@morphism.tech

6Stability: experimental

8−A `MonadPQ` for pooled connections.

8+Connection pools.

10+Typical use case would be to create your pool using `createConnectionPool`

11+and run anything that requires the pool connection with `usingConnectionPool`.

12+

13+Here's a simplified example:

14+

15+>>> import Squeal.PostgreSQL

16+

17+>>> :{

18+do

19+ let

20+ query :: Query_ (Public '[]) () (Only Char)

21+ query = values_ (literal 'a' `as` #fromOnly)

22+ pool <- createConnectionPool "host=localhost port=5432 dbname=exampledb" 1 0.5 10

23+ chr <- usingConnectionPool pool $ do

24+ result <- runQuery query

25+ Just (Only a) <- firstRow result

26+ return a

27+ destroyConnectionPool pool

28+ putChar chr

29+:}

30+a

9-}

31-}

11{-# LANGUAGE

33{-# LANGUAGE

12 DeriveFunctor

34 DeriveFunctor

13 , FlexibleContexts

35 , FlexibleContexts

14 , FlexibleInstances

36 , FlexibleInstances

37+ , InstanceSigs

15 , MultiParamTypeClasses

38 , MultiParamTypeClasses

16 , RankNTypes

39 , RankNTypes

17 , ScopedTypeVariables

40 , ScopedTypeVariables

@@ -22,55 +45,24 @@ A `MonadPQ` for pooled connections.

23module Squeal.PostgreSQL.Pool

46module Squeal.PostgreSQL.Pool

24 ( -- * Pools

47 ( -- * Pools

25− PoolPQ (..)

48+ Pool

26 , createConnectionPool

49 , createConnectionPool

27− , Pool

50+ , usingConnectionPool

28− , destroyAllResources

51+ , destroyConnectionPool

29− , PoolPQRun

30− , poolpqliftWith

31 ) where

52 ) where

33−import Control.Monad.Base

34−import Control.Monad.Trans

35−import Control.Monad.Trans.Control

36import Data.ByteString

54import Data.ByteString

37−import Data.Pool

38import Data.Time

55import Data.Time

39−import Generics.SOP (K(..))

56+import Generics.SOP (K(..), unK)

57+import UnliftIO (MonadUnliftIO (..))

58+import UnliftIO.Pool (Pool, createPool, destroyAllResources, withResource)

41import Squeal.PostgreSQL.PQ

60import Squeal.PostgreSQL.PQ

42−import Squeal.PostgreSQL.Schema

43−

44−{- | `PoolPQ` @schemas@ should be a drop-in replacement for `PQ` @schemas schemas@.

45−

46−Typical use case would be to create your pool using `createConnectionPool` and run anything that requires the pool connection with it.

47−

48−Here's a simplified example:

49−

50−> 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

70-- | Create a striped pool of connections.

62-- | Create a striped pool of connections.

71-- Although the garbage collector will destroy all idle connections when the pool is garbage collected it's recommended to manually `destroyAllResources` when you're done with the pool so that the connections are freed up as soon as possible.

63-- Although the garbage collector will destroy all idle connections when the pool is garbage collected it's recommended to manually `destroyAllResources` when you're done with the pool so that the connections are freed up as soon as possible.

72createConnectionPool

64createConnectionPool

73− :: MonadBase IO io

65+ :: MonadUnliftIO io

74 => ByteString

66 => ByteString

75 -- ^ The passed string can be empty to use all default parameters, or it can

67 -- ^ The passed string can be empty to use all default parameters, or it can

76 -- contain one or more parameter settings separated by whitespace.

68 -- contain one or more parameter settings separated by whitespace.

@@ -87,67 +79,44 @@ createConnectionPool

87 -- ^ Maximum number of connections to keep open per stripe. The smallest acceptable value is 1.

79 -- ^ Maximum number of connections to keep open per stripe. The smallest acceptable value is 1.

88 -- Requests for connections will block if this limit is reached on a single stripe, even if other stripes have idle connections available.

80 -- Requests for connections will block if this limit is reached on a single stripe, even if other stripes have idle connections available.

89 -> io (Pool (K Connection schemas))

81 -> io (Pool (K Connection schemas))

90−createConnectionPool conninfo stripes idle maxResrc = liftBase $

82+createConnectionPool conninfo stripes idle maxResrc =

91 createPool (connectdb conninfo) finish stripes idle maxResrc

83 createPool (connectdb conninfo) finish stripes idle maxResrc

93−-- | `Applicative` instance for `PoolPQ`.

85+{-|

94−instance Monad m => Applicative (PoolPQ schemas m) where

86+Temporarily take a connection from a `Pool`, perform an action with it,

95− pure x = PoolPQ $ \ _ -> pure x

87+and return it to the pool afterwards.

96− PoolPQ f <*> PoolPQ x = PoolPQ $ \ pool -> do

88+

97− f' <- f pool

89+If the pool has an idle connection available, it is used immediately.

98− x' <- x pool

90+Otherwise, if the maximum number of connections has not yet been reached,

99− return $ f' x'

91+a new connection is created and used.

100−

92+If the maximum number of connections has been reached, this function blocks

101−-- | `Monad` instance for `PoolPQ`.

93+until a connection becomes available.

102−instance Monad m => Monad (PoolPQ schemas m) where

94+-}

103− return = pure

95+usingConnectionPool

104− PoolPQ x >>= f = PoolPQ $ \ pool -> do

96+ :: MonadUnliftIO io

105− x' <- x pool

97+ => Pool (K Connection schemas) -- ^ pool

106− runPoolPQ (f x') pool

98+ -> PQ schemas schemas io x -- ^ session

107−

99+ -> io x

108−-- | `MonadTrans` instance for `PoolPQ`.

100+usingConnectionPool pool (PQ session) = unK <$> withResource pool session

109−instance MonadTrans (PoolPQ schemas) where

101+

110− lift m = PoolPQ $ \ _pool -> m

102+{- |

111−

103+Destroy all connections in all stripes in the pool.

112−-- | `MonadBase` instance for `PoolPQ`.

104+Note that this will ignore any exceptions in the destroy function.

113−instance MonadBase b m => MonadBase b (PoolPQ schemas m) where

105+

114− liftBase = lift . liftBase

106+This function is useful when you detect that all connections

115−

107+in the pool are broken. For example after a database has been

116−-- | `MonadPQ` instance for `PoolPQ`.

108+restarted all connections opened before the restart will be broken.

117−instance MonadBaseControl IO io => MonadPQ schemas (PoolPQ schemas io) where

109+In that case it's better to close those connections so that

118− manipulateParams manipulation params = PoolPQ $ \ pool -> do

110+`usingConnectionPool` won't take a broken connection from the pool

119− withResource pool $ \ conn -> do

111+but will open a new connection instead.

120− (K result :: K (K Result ys) schemas) <- flip unPQ conn $

112+

121− manipulateParams manipulation params

113+Another use-case for this function is that when you know you are done

122− return result

114+with the pool you can destroy all idle connections immediately

123− traversePrepared manipulation params = PoolPQ $ \ pool ->

115+instead of waiting on the garbage collector to destroy them,

124− withResource pool $ \ conn -> do

116+thus freeing up those connections sooner.

125− (K result :: K (list (K Result ys)) schemas) <- flip unPQ conn $

117+-}

126− traversePrepared manipulation params

118+destroyConnectionPool

127− return result

119+ :: MonadUnliftIO io

128− traversePrepared_ manipulation params = PoolPQ $ \ pool -> do

120+ => Pool (K Connection schemas) -- ^ pool

129− withResource pool $ \ conn -> do

121+ -> io ()

130− (_ :: K () schemas) <- flip unPQ conn $

122+destroyConnectionPool = destroyAllResources

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+532−817

@@ -1,7 +1,7 @@

1{-|

2Module: Squeal.PostgreSQL.Query

3Description: Squeal queries

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

@@ -17,8 +17,12 @@ Squeal queries.

17 , GeneralizedNewtypeDeriving

18 , LambdaCase

19 , MultiParamTypeClasses

20+ , OverloadedLabels

20 , OverloadedStrings

21 , OverloadedStrings

22+ , QuantifiedConstraints

23+ , ScopedTypeVariables

21 , StandaloneDeriving

24 , StandaloneDeriving

25+ , TypeApplications

22 , TypeFamilies

26 , TypeFamilies

23 , TypeInType

27 , TypeInType

24 , TypeOperators

28 , TypeOperators

@@ -28,12 +32,16 @@ Squeal queries.

29module Squeal.PostgreSQL.Query

33module Squeal.PostgreSQL.Query

30 ( -- * Queries

34 ( -- * Queries

31− Query (UnsafeQuery, renderQuery)

35+ Query_

36+ , Query (..)

32 -- ** Select

37 -- ** Select

33 , select

38 , select

34 , select_

39 , select_

35 , selectDistinct

40 , selectDistinct

36 , selectDistinct_

41 , selectDistinct_

42+ , selectDistinctOn

43+ , selectDistinctOn_

44+ , Selection (..)

37 -- ** Values

45 -- ** Values

38 , values

46 , values

39 , values_

47 , values_

@@ -45,33 +53,15 @@ module Squeal.PostgreSQL.Query

45 , except

53 , except

46 , exceptAll

54 , exceptAll

47 -- ** With

55 -- ** With

48− , With (with)

56+ , With (..)

49 , CommonTableExpression (..)

57 , CommonTableExpression (..)

50− , renderCommonTableExpression

58+ , withRecursive

51− , renderCommonTableExpressions

52− -- ** Json

53− , jsonEach

54− , jsonbEach

55− , jsonEachAsText

56− , jsonbEachAsText

57− , jsonObjectKeys

58− , jsonbObjectKeys

59− , jsonPopulateRecord

60− , jsonbPopulateRecord

61− , jsonPopulateRecordSet

62− , jsonbPopulateRecordSet

63− , jsonToRecord

64− , jsonbToRecord

65− , jsonToRecordSet

66− , jsonbToRecordSet

67 -- * Table Expressions

59 -- * Table Expressions

68 , TableExpression (..)

60 , TableExpression (..)

69− , renderTableExpression

70 , from

61 , from

71 , where_

62 , where_

72 , groupBy

63 , groupBy

73 , having

64 , having

74− , orderBy

75 , limit

65 , limit

76 , offset

66 , offset

77 -- * From Clauses

67 -- * From Clauses

@@ -86,46 +76,14 @@ module Squeal.PostgreSQL.Query

86 , rightOuterJoin

76 , rightOuterJoin

87 , fullOuterJoin

77 , fullOuterJoin

88 -- * Grouping

78 -- * Grouping

89− , By (By1, By2)

79+ , By (..)

90− , renderBy

80+ , GroupByClause (..)

91− , GroupByClause (NoGroups, Group)

81+ , HavingClause (..)

92− , renderGroupByClause

93− , HavingClause (NoHaving, Having)

94− , renderHavingClause

95− -- * Sorting

96− , SortExpression (..)

97− , renderSortExpression

98− -- * Subquery Expressions

99− , in_

100− , rowIn

101− , eqAll

102− , rowEqAll

103− , eqAny

104− , rowEqAny

105− , neqAll

106− , rowNeqAll

107− , neqAny

108− , rowNeqAny

109− , allLt

110− , rowLtAll

111− , ltAny

112− , rowLtAny

113− , lteAll

114− , rowLteAll

115− , lteAny

116− , rowLteAny

117− , gtAll

118− , rowGtAll

119− , gtAny

120− , rowGtAny

121− , gteAll

122− , rowGteAll

123− , gteAny

124− , rowGteAny

125 ) where

82 ) where

126

127import Control.DeepSeq

84import Control.DeepSeq

128import Data.ByteString (ByteString)

85import Data.ByteString (ByteString)

86+import Data.Kind (Type)

129import Data.String

87import Data.String

130import Data.Word

88import Data.Word

131import Generics.SOP hiding (from)

89import Generics.SOP hiding (from)

@@ -133,13 +91,67 @@ import GHC.TypeLits

133

134import qualified GHC.Generics as GHC

92import qualified GHC.Generics as GHC

135

94+import Squeal.PostgreSQL.Alias

136import Squeal.PostgreSQL.Expression

95import Squeal.PostgreSQL.Expression

96+import Squeal.PostgreSQL.Expression.Logic

97+import Squeal.PostgreSQL.Expression.Sort

98+import Squeal.PostgreSQL.Expression.Window

99+import Squeal.PostgreSQL.List

100+import Squeal.PostgreSQL.PG

137import Squeal.PostgreSQL.Render

101import Squeal.PostgreSQL.Render

138import Squeal.PostgreSQL.Schema

102import Squeal.PostgreSQL.Schema

139

103

104+-- $setup

105+-- >>> import Squeal.PostgreSQL

106+-- >>> import Data.Int (Int32, Int64)

107+-- >>> import Data.Monoid (Sum (..))

108+-- >>> import Data.Text (Text)

109+-- >>> import qualified Generics.SOP as SOP

110+

111+{- |

112+The process of retrieving or the command to retrieve data from

113+a database is called a `Query`.

114+

115+The general `Query` type is parameterized by

116+

117+* @outer :: FromType@ - outer scope for a correlated subquery,

118+* @commons :: FromType@ - scope for all `common` table expressions,

119+* @schemas :: SchemasType@ - scope for all `table`s and `view`s,

120+* @params :: [NullityType]@ - scope for all `Squeal.Expression.Parameter.parameter`s,

121+* @row :: RowType@ - return type of the `Query`.

122+-}

123+newtype Query

124+ (outer :: FromType)

125+ (commons :: FromType)

126+ (schemas :: SchemasType)

127+ (params :: [NullityType])

128+ (row :: RowType)

129+ = UnsafeQuery { renderQuery :: ByteString }

130+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

131+instance RenderSQL (Query outer commons schemas params row) where renderSQL = renderQuery

132+

140{- |

133{- |

141−The process of retrieving or the command to retrieve data from a database

134+The top level `Query_` type is parameterized by a @schemas@ `SchemasType`,

142−is called a `Query`. Let's see some examples of queries.

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+:}

143

155

144simple query:

156simple query:

145

157

@@ -147,8 +159,8 @@ simple query:

147>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

159>>> type Schema = '["tab" ::: 'Table ('[] :=> Columns)]

148>>> :{

160>>> :{

149let

161let

150− query :: Query (DBof (Public Schema)) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

162+ query :: Query_ (Public Schema) () (Row Int32 Int32)

151− query = selectStar (from (table #tab))

163+ query = select Star (from (table #tab))

152in printSQL query

164in printSQL query

153:}

165:}

154SELECT * FROM "tab" AS "tab"

166SELECT * FROM "tab" AS "tab"

@@ -157,22 +169,22 @@ restricted query:

157

169

158>>> :{

170>>> :{

159let

171let

160− query :: Query (DBof (Public Schema)) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4]

172+ query :: Query_ (Public Schema) () (Row Int32 Int32)

161 query =

173 query =

162− select ((#col1 + #col2) `as` #sum :* #col1)

174+ select_ ((#col1 + #col2) `as` #col1 :* #col1 `as` #col2)

163 ( from (table #tab)

175 ( from (table #tab)

164 & where_ (#col1 .> #col2)

176 & where_ (#col1 .> #col2)

165 & where_ (#col2 .> 0) )

177 & where_ (#col2 .> 0) )

166in printSQL query

178in printSQL query

167:}

179:}

168−SELECT ("col1" + "col2") AS "sum", "col1" AS "col1" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))

180+SELECT ("col1" + "col2") AS "col1", "col1" AS "col2" FROM "tab" AS "tab" WHERE (("col1" > "col2") AND ("col2" > 0))

169

181

170subquery:

182subquery:

171

183

172>>> :{

184>>> :{

173let

185let

174− query :: Query (DBof (Public Schema)) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

186+ query :: Query_ (Public Schema) () (Row Int32 Int32)

175− query = selectStar (from (subquery (selectStar (from (table #tab)) `as` #sub)))

187+ query = select Star (from (subquery (select Star (from (table #tab)) `as` #sub)))

176in printSQL query

188in printSQL query

177:}

189:}

178SELECT * FROM (SELECT * FROM "tab" AS "tab") AS "sub"

190SELECT * FROM (SELECT * FROM "tab" AS "tab") AS "sub"

@@ -181,8 +193,8 @@ limits and offsets:

181

193

182>>> :{

194>>> :{

183let

195let

184− query :: Query (DBof (Public Schema)) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

196+ query :: Query_ (Public Schema) () (Row Int32 Int32)

185− query = selectStar (from (table #tab) & limit 100 & offset 2 & limit 50 & offset 2)

197+ query = select Star (from (table #tab) & limit 100 & offset 2 & limit 50 & offset 2)

186in printSQL query

198in printSQL query

187:}

199:}

188SELECT * FROM "tab" AS "tab" LIMIT 50 OFFSET 4

200SELECT * FROM "tab" AS "tab" LIMIT 50 OFFSET 4

@@ -191,8 +203,8 @@ parameterized query:

191

203

192>>> :{

204>>> :{

193let

205let

194− query :: Query (DBof (Public Schema)) '[ 'NotNull 'PGint4] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

206+ query :: Query_ (Public Schema) (Only Int32) (Row Int32 Int32)

195− query = selectStar (from (table #tab) & where_ (#col1 .> param @1))

207+ query = select Star (from (table #tab) & where_ (#col1 .> param @1))

196in printSQL query

208in printSQL query

197:}

209:}

198SELECT * FROM "tab" AS "tab" WHERE ("col1" > ($1 :: int4))

210SELECT * FROM "tab" AS "tab" WHERE ("col1" > ($1 :: int4))

@@ -201,36 +213,34 @@ aggregation query:

201

213

202>>> :{

214>>> :{

203let

215let

204− query :: Query (DBof (Public Schema)) '[] '["sum" ::: 'NotNull 'PGint4, "col1" ::: 'NotNull 'PGint4 ]

216+ query :: Query_ (Public Schema) () (Row Int64 Int32)

205 query =

217 query =

206− select (sum_ #col2 `as` #sum :* #col1)

218+ select_ ((fromNull 0 (sum_ (All #col2))) `as` #col1 :* #col1 `as` #col2)

207 ( from (table (#tab `as` #table1))

219 ( from (table (#tab `as` #table1))

208 & groupBy #col1

220 & groupBy #col1

209− & having (#col1 + sum_ #col2 .> 1) )

221+ & having (sum_ (Distinct #col2) .> 1) )

210in printSQL query

222in printSQL query

211:}

223:}

212−SELECT sum("col2") AS "sum", "col1" AS "col1" FROM "tab" AS "table1" GROUP BY "col1" HAVING (("col1" + sum("col2")) > 1)

224+SELECT COALESCE(sum(ALL "col2"), 0) AS "col1", "col1" AS "col2" FROM "tab" AS "table1" GROUP BY "col1" HAVING (sum(DISTINCT "col2") > 1)

213

225

214sorted query:

226sorted query:

215

227

216>>> :{

228>>> :{

217let

229let

218− query :: Query (DBof (Public Schema)) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

230+ query :: Query_ (Public Schema) () (Row Int32 Int32)

219− query = selectStar (from (table #tab) & orderBy [#col1 & Asc])

231+ query = select Star (from (table #tab) & orderBy [#col1 & Asc])

220in printSQL query

232in printSQL query

221:}

233:}

222SELECT * FROM "tab" AS "tab" ORDER BY "col1" ASC

234SELECT * FROM "tab" AS "tab" ORDER BY "col1" ASC

223

235

224joins:

236joins:

225

237

226−>>> :set -XFlexibleContexts

227>>> :{

238>>> :{

228type OrdersColumns =

239type OrdersColumns =

229 '[ "id" ::: 'NoDef :=> 'NotNull 'PGint4

240 '[ "id" ::: 'NoDef :=> 'NotNull 'PGint4

230− , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

241+ , "price" ::: 'NoDef :=> 'NotNull 'PGfloat4

231− , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

242+ , "customer_id" ::: 'NoDef :=> 'NotNull 'PGint4

232− , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4

243+ , "shipper_id" ::: 'NoDef :=> 'NotNull 'PGint4 ]

233− ]

234:}

244:}

235

245

236>>> :{

246>>> :{

@@ -246,22 +256,27 @@ type OrdersConstraints =

246>>> :{

256>>> :{

247type OrdersSchema =

257type OrdersSchema =

248 '[ "orders" ::: 'Table (OrdersConstraints :=> OrdersColumns)

258 '[ "orders" ::: 'Table (OrdersConstraints :=> OrdersColumns)

249− , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

259+ , "customers" ::: 'Table (CustomersConstraints :=> NamesColumns)

250− , "shippers" ::: 'Table (ShippersConstraints :=> NamesColumns) ]

260+ , "shippers" ::: 'Table (ShippersConstraints :=> NamesColumns) ]

261+:}

262+

263+>>> :{

264+data Order = Order

265+ { price :: Float

266+ , customerName :: Text

267+ , shipperName :: Text

268+ } deriving GHC.Generic

269+instance SOP.Generic Order

270+instance SOP.HasDatatypeInfo Order

251:}

271:}

252

272

253>>> :{

273>>> :{

254let

274let

255− query :: Query (DBof (Public OrdersSchema))

275+ query :: Query_ (Public OrdersSchema) () Order

256− '[]

276+ query = select_

257− '[ "order_price" ::: 'NotNull 'PGfloat4

277+ ( #o ! #price `as` #price :*

258− , "customer_name" ::: 'NotNull 'PGtext

278+ #c ! #name `as` #customerName :*

259− , "shipper_name" ::: 'NotNull 'PGtext

279+ #s ! #name `as` #shipperName )

260− ]

261− query = select

262− ( #o ! #price `as` #order_price :*

263− #c ! #name `as` #customer_name :*

264− #s ! #name `as` #shipper_name )

265 ( from (table (#orders `as` #o)

280 ( from (table (#orders `as` #o)

266 & innerJoin (table (#customers `as` #c))

281 & innerJoin (table (#customers `as` #c))

267 (#o ! #customer_id .== #c ! #id)

282 (#o ! #customer_id .== #c ! #id)

@@ -269,14 +284,16 @@ let

269 (#o ! #shipper_id .== #s ! #id)) )

284 (#o ! #shipper_id .== #s ! #id)) )

270in printSQL query

285in printSQL query

271:}

286:}

272−SELECT "o"."price" AS "order_price", "c"."name" AS "customer_name", "s"."name" AS "shipper_name" FROM "orders" AS "o" INNER JOIN "customers" AS "c" ON ("o"."customer_id" = "c"."id") INNER JOIN "shippers" AS "s" ON ("o"."shipper_id" = "s"."id")

287+SELECT "o"."price" AS "price", "c"."name" AS "customerName", "s"."name" AS "shipperName" FROM "orders" AS "o" INNER JOIN "customers" AS "c" ON ("o"."customer_id" = "c"."id") INNER JOIN "shippers" AS "s" ON ("o"."shipper_id" = "s"."id")

273

288

274self-join:

289self-join:

275

290

276>>> :{

291>>> :{

277let

292let

278− query :: Query (DBof (Public Schema)) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

293+ query :: Query_ (Public Schema) () (Row Int32 Int32)

279− query = selectDotStar #t1 (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

294+ query = select

295+ (#t1 & DotStar)

296+ (from (table (#tab `as` #t1) & crossJoin (table (#tab `as` #t2))))

280in printSQL query

297in printSQL query

281:}

298:}

282SELECT "t1".* FROM "tab" AS "t1" CROSS JOIN "tab" AS "t2"

299SELECT "t1".* FROM "tab" AS "t1" CROSS JOIN "tab" AS "t2"

@@ -285,18 +302,20 @@ value queries:

285

302

286>>> :{

303>>> :{

287let

304let

288− query :: Query db '[] '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

305+ query :: Query_ schemas () (Row String Bool)

289− query = values (1 `as` #foo :* true `as` #bar) [2 `as` #foo :* false `as` #bar]

306+ query = values

307+ ("true" `as` #col1 :* true `as` #col2)

308+ ["false" `as` #col1 :* false `as` #col2]

290in printSQL query

309in printSQL query

291:}

310:}

292−SELECT * FROM (VALUES (1, TRUE), (2, FALSE)) AS t ("foo", "bar")

311+SELECT * FROM (VALUES (E'true', TRUE), (E'false', FALSE)) AS t ("col1", "col2")

293

312

294set operations:

313set operations:

295

314

296>>> :{

315>>> :{

297let

316let

298− query :: Query (DBof (Public Schema)) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

317+ query :: Query_ (Public Schema) () (Row Int32 Int32)

299− query = selectStar (from (table #tab)) `unionAll` selectStar (from (table #tab))

318+ query = select Star (from (table #tab)) `unionAll` select Star (from (table #tab))

300in printSQL query

319in printSQL query

301:}

320:}

302(SELECT * FROM "tab" AS "tab") UNION ALL (SELECT * FROM "tab" AS "tab")

321(SELECT * FROM "tab" AS "tab") UNION ALL (SELECT * FROM "tab" AS "tab")

@@ -305,163 +324,305 @@ with queries:

305

324

306>>> :{

325>>> :{

307let

326let

308− query :: Query (DBof (Public Schema)) '[] '["col1" ::: 'NotNull 'PGint4, "col2" ::: 'NotNull 'PGint4]

327+ query :: Query_ (Public Schema) () (Row Int32 Int32)

309 query = with (

328 query = with (

310− selectStar (from (table #tab)) `as` #cte1 :>>

329+ select Star (from (table #tab)) `as` #cte1 :>>

311− selectStar (from (common #cte1)) `as` #cte2

330+ select Star (from (common #cte1)) `as` #cte2

312− ) (selectStar (from (common #cte2)))

331+ ) (select Star (from (common #cte2)))

313in printSQL query

332in printSQL query

314:}

333:}

315WITH "cte1" AS (SELECT * FROM "tab" AS "tab"), "cte2" AS (SELECT * FROM "cte1" AS "cte1") SELECT * FROM "cte2" AS "cte2"

334WITH "cte1" AS (SELECT * FROM "tab" AS "tab"), "cte2" AS (SELECT * FROM "cte1" AS "cte1") SELECT * FROM "cte2" AS "cte2"

335+

336+window function queries

337+

338+>>> :{

339+let

340+ query :: Query_ (Public Schema) () (Row Int32 Int64)

341+ query = select

342+ (#col1 & Also (rank `as` #col2 `Over` (partitionBy #col1 & orderBy [#col2 & Asc])))

343+ (from (table #tab))

344+in printSQL query

345+:}

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+

316-}

362-}

317−newtype Query

363+type family Query_

318− (db :: DBType)

364+ (schemas :: SchemasType)

319− (params :: [NullityType])

365+ (parameters :: Type)

320− (columns :: RowType)

366+ (row :: Type) where

321− = UnsafeQuery { renderQuery :: ByteString }

367+ Query_ schemas params row =

322− deriving (GHC.Generic,Show,Eq,Ord,NFData)

368+ Query '[] '[] schemas (TuplePG params) (RowPG row)

323−instance RenderSQL (Query db params columns) where renderSQL = renderQuery

324

369

325-- | The results of two queries can be combined using the set operation

370-- | The results of two queries can be combined using the set operation

326-- `union`. Duplicate rows are eliminated.

371-- `union`. Duplicate rows are eliminated.

327union

372union

328− :: Query db params columns

373+ :: Query outer commons schemas params columns

329− -> Query db params columns

374+ -> Query outer commons schemas params columns

330− -> Query db params columns

375+ -> Query outer commons schemas params columns

331q1 `union` q2 = UnsafeQuery $

376q1 `union` q2 = UnsafeQuery $

332− parenthesized (renderQuery q1)

377+ parenthesized (renderSQL q1)

333 <+> "UNION"

378 <+> "UNION"

334− <+> parenthesized (renderQuery q2)

379+ <+> parenthesized (renderSQL q2)

335

380

336-- | The results of two queries can be combined using the set operation

381-- | The results of two queries can be combined using the set operation

337-- `unionAll`, the disjoint union. Duplicate rows are retained.

382-- `unionAll`, the disjoint union. Duplicate rows are retained.

338unionAll

383unionAll

339− :: Query db params columns

384+ :: Query outer commons schemas params columns

340− -> Query db params columns

385+ -> Query outer commons schemas params columns

341− -> Query db params columns

386+ -> Query outer commons schemas params columns

342q1 `unionAll` q2 = UnsafeQuery $

387q1 `unionAll` q2 = UnsafeQuery $

343− parenthesized (renderQuery q1)

388+ parenthesized (renderSQL q1)

344 <+> "UNION" <+> "ALL"

389 <+> "UNION" <+> "ALL"

345− <+> parenthesized (renderQuery q2)

390+ <+> parenthesized (renderSQL q2)

346

391

347-- | The results of two queries can be combined using the set operation

392-- | The results of two queries can be combined using the set operation

348-- `intersect`, the intersection. Duplicate rows are eliminated.

393-- `intersect`, the intersection. Duplicate rows are eliminated.

349intersect

394intersect

350− :: Query db params columns

395+ :: Query outer commons schemas params columns

351− -> Query db params columns

396+ -> Query outer commons schemas params columns

352− -> Query db params columns

397+ -> Query outer commons schemas params columns

353q1 `intersect` q2 = UnsafeQuery $

398q1 `intersect` q2 = UnsafeQuery $

354− parenthesized (renderQuery q1)

399+ parenthesized (renderSQL q1)

355 <+> "INTERSECT"

400 <+> "INTERSECT"

356− <+> parenthesized (renderQuery q2)

401+ <+> parenthesized (renderSQL q2)

357

402

358-- | The results of two queries can be combined using the set operation

403-- | The results of two queries can be combined using the set operation

359-- `intersectAll`, the intersection. Duplicate rows are retained.

404-- `intersectAll`, the intersection. Duplicate rows are retained.

360intersectAll

405intersectAll

361− :: Query db params columns

406+ :: Query outer commons schemas params columns

362− -> Query db params columns

407+ -> Query outer commons schemas params columns

363− -> Query db params columns

408+ -> Query outer commons schemas params columns

364q1 `intersectAll` q2 = UnsafeQuery $

409q1 `intersectAll` q2 = UnsafeQuery $

365− parenthesized (renderQuery q1)

410+ parenthesized (renderSQL q1)

366 <+> "INTERSECT" <+> "ALL"

411 <+> "INTERSECT" <+> "ALL"

367− <+> parenthesized (renderQuery q2)

412+ <+> parenthesized (renderSQL q2)

368

413

369-- | The results of two queries can be combined using the set operation

414-- | The results of two queries can be combined using the set operation

370-- `except`, the set difference. Duplicate rows are eliminated.

415-- `except`, the set difference. Duplicate rows are eliminated.

371except

416except

372− :: Query db params columns

417+ :: Query outer commons schemas params columns

373− -> Query db params columns

418+ -> Query outer commons schemas params columns

374− -> Query db params columns

419+ -> Query outer commons schemas params columns

375q1 `except` q2 = UnsafeQuery $

420q1 `except` q2 = UnsafeQuery $

376− parenthesized (renderQuery q1)

421+ parenthesized (renderSQL q1)

377 <+> "EXCEPT"

422 <+> "EXCEPT"

378− <+> parenthesized (renderQuery q2)

423+ <+> parenthesized (renderSQL q2)

379

424

380-- | The results of two queries can be combined using the set operation

425-- | The results of two queries can be combined using the set operation

381-- `exceptAll`, the set difference. Duplicate rows are retained.

426-- `exceptAll`, the set difference. Duplicate rows are retained.

382exceptAll

427exceptAll

383− :: Query db params columns

428+ :: Query outer commons schemas params columns

384− -> Query db params columns

429+ -> Query outer commons schemas params columns

385− -> Query db params columns

430+ -> Query outer commons schemas params columns

386q1 `exceptAll` q2 = UnsafeQuery $

431q1 `exceptAll` q2 = UnsafeQuery $

387− parenthesized (renderQuery q1)

432+ parenthesized (renderSQL q1)

388 <+> "EXCEPT" <+> "ALL"

433 <+> "EXCEPT" <+> "ALL"

389− <+> parenthesized (renderQuery q2)

434+ <+> parenthesized (renderSQL q2)

390

435

391{-----------------------------------------

436{-----------------------------------------

392SELECT queries

437SELECT queries

393-----------------------------------------}

438-----------------------------------------}

394

439

395−data Selection db params grp from row where

440+{- | The simplest kinds of `Selection` are `Star` and `DotStar` which

396− List

441+emits all columns that a `TableExpression` produces. A select `List`

397− :: SListI row

442+is a list of `Expression`s. A `Selection` could be a list of

398− => NP (Aliased (Expression db params grp from)) row

443+`WindowFunction`s `Over` `WindowDefinition`. `Additional` `Selection`s can

399− -> Selection db params grp from row

444+be selected with `Also`.

445+-}

446+data Selection outer commons grp schemas params from row where

400 Star

447 Star

401 :: HasUnique tab from row

448 :: HasUnique tab from row

402− => Selection db params 'Ungrouped from row

449+ => Selection outer commons 'Ungrouped schemas params from row

450+ -- ^ `HasUnique` table in the `FromClause`

403 DotStar

451 DotStar

404 :: Has tab from row

452 :: Has tab from row

405 => Alias tab

453 => Alias tab

406− -> Selection db params 'Ungrouped from row

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

461+ Over

462+ :: 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

407 Also

467 Also

408− :: Selection db params grp from right

468+ :: Selection outer commons grp schemas params from right

409− -> Selection db params grp from left

469+ -- ^ `Additional` `Selection`

410− -> Selection db params grp from (Join left right)

470+ -> Selection outer commons grp schemas params from left

411−

471+ -> Selection outer commons grp schemas params from (Join left right)

412−instance RenderSQL (Selection db params grp from row) where

472+instance Additional (Selection outer commons grp schemas params from) where

473+ also = Also

474+instance (KnownSymbol col, row ~ '[col ::: ty])

475+ => Aliasable col

476+ (Expression outer commons grp schemas params from ty)

477+ (Selection outer commons grp schemas params from row) where

478+ 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

483+instance

484+ ( Has tab (Join outer from) row0

485+ , Has col row0 ty

486+ , row1 ~ '[col ::: ty]

487+ , 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

495+instance

496+ ( HasUnique tab (Join outer from) row0

497+ , Has col row0 ty

498+ , row1 ~ '[col ::: ty]

499+ , GroupedBy tab col bys )

500+ => IsLabel col

501+ (Selection outer commons ('Grouped bys) schemas params from row1) where

502+ fromLabel = fromLabel @col `as` Alias

503+

504+instance RenderSQL (Selection outer commons grp schemas params from row) where

413 renderSQL = \case

505 renderSQL = \case

414− List list -> renderCommaSeparated (renderAliasedAs renderExpression) list

506+ List list -> renderCommaSeparated (renderAliased renderSQL) list

415 Star -> "*"

507 Star -> "*"

416− DotStar tab -> renderAlias tab <> ".*"

508+ DotStar tab -> renderSQL tab <> ".*"

417 Also right left -> renderSQL left <> ", " <> renderSQL right

509 Also right left -> renderSQL left <> ", " <> renderSQL right

510+ Over winFns winDef ->

511+ let

512+ renderOver

513+ :: Aliased (WindowFunction outer commons grp schemas params from) field

514+ -> ByteString

515+ renderOver (winFn `As` col) = renderSQL winFn

516+ <+> "OVER" <+> parenthesized (renderSQL winDef)

517+ <+> "AS" <+> renderSQL col

518+ in

519+ renderCommaSeparated renderOver winFns

520+

521+instance IsString

522+ (Selection outer commons grp schemas params from '["fromOnly" ::: 'NotNull 'PGtext]) where

523+ fromString str = fromString str `as` Alias

418

524

419-- | the `TableExpression` in the `select` command constructs an intermediate

525-- | the `TableExpression` in the `select` command constructs an intermediate

420-- virtual table by possibly combining tables, views, eliminating rows,

526-- virtual table by possibly combining tables, views, eliminating rows,

421-- grouping, etc. This table is finally passed on to processing by

527-- grouping, etc. This table is finally passed on to processing by

422−-- the select list. The select list determines which columns of

528+-- the select list. The `Selection` determines which columns of

423-- the intermediate table are actually output.

529-- the intermediate table are actually output.

424select

530select

425 :: (SListI row, row ~ (x ': xs))

531 :: (SListI row, row ~ (x ': xs))

426− => Selection db params grp from row

532+ => Selection outer commons grp schemas params from row

427− -- ^ select list

533+ -- ^ selection

428− -> TableExpression db params grp from

534+ -> TableExpression outer commons grp schemas params from

429 -- ^ intermediate virtual table

535 -- ^ intermediate virtual table

430− -> Query db params row

536+ -> Query outer commons schemas params row

431select selection tabexpr = UnsafeQuery $

537select selection tabexpr = UnsafeQuery $

432 "SELECT"

538 "SELECT"

433 <+> renderSQL selection

539 <+> renderSQL selection

434− <+> renderTableExpression tabexpr

540+ <+> renderSQL tabexpr

435

541

542+-- | Like `select` but takes an `NP` list of `Expression`s instead

543+-- of a general `Selection`.

436select_

544select_

437 :: (SListI row, row ~ (x ': xs))

545 :: (SListI row, row ~ (x ': xs))

438− => NP (Aliased (Expression db params grp from)) row

546+ => NP (Aliased (Expression outer commons grp schemas params from)) row

439− -> TableExpression db params grp from

547+ -- ^ select list

440− -> Query db params row

548+ -> TableExpression outer commons grp schemas params from

441−select_ list = select (List list)

549+ -- ^ intermediate virtual table

550+ -> Query outer commons schemas params row

551+select_ = select . List

442

552

443-- | After the select list has been processed, the result table can

553-- | After the select list has been processed, the result table can

444-- be subject to the elimination of duplicate rows using `selectDistinct`.

554-- be subject to the elimination of duplicate rows using `selectDistinct`.

445selectDistinct

555selectDistinct

446 :: (SListI columns, columns ~ (col ': cols))

556 :: (SListI columns, columns ~ (col ': cols))

447− => Selection db params 'Ungrouped from columns

557+ => Selection outer commons grp schemas params from columns

448− -- ^ select list

558+ -- ^ selection

449− -> TableExpression db params 'Ungrouped from

559+ -> TableExpression outer commons grp schemas params from

450 -- ^ intermediate virtual table

560 -- ^ intermediate virtual table

451− -> Query db params columns

561+ -> Query outer commons schemas params columns

452selectDistinct selection tabexpr = UnsafeQuery $

562selectDistinct selection tabexpr = UnsafeQuery $

453 "SELECT DISTINCT"

563 "SELECT DISTINCT"

454 <+> renderSQL selection

564 <+> renderSQL selection

455− <+> renderTableExpression tabexpr

565+ <+> renderSQL tabexpr

456

566

567+-- | Like `selectDistinct` but takes an `NP` list of `Expression`s instead

568+-- of a general `Selection`.

457selectDistinct_

569selectDistinct_

458 :: (SListI columns, columns ~ (col ': cols))

570 :: (SListI columns, columns ~ (col ': cols))

459− => NP (Aliased (Expression db params 'Ungrouped from)) columns

571+ => NP (Aliased (Expression outer commons grp schemas params from)) columns

460 -- ^ select list

572 -- ^ select list

461− -> TableExpression db params 'Ungrouped from

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

462 -- ^ intermediate virtual table

598 -- ^ intermediate virtual table

463− -> Query db params columns

599+ -> Query outer commons schemas params columns

464−selectDistinct_ list = select (List list)

600+selectDistinctOn distincts selection tab = UnsafeQuery $

601+ "SELECT DISTINCT ON"

602+ <+> parenthesized (commaSeparated (renderDistinctOn <$> distincts))

603+ <+> renderSQL selection

604+ <+> renderSQL (tab {orderByClause = distincts <> orderByClause tab})

605+ where

606+ renderDistinctOn = \case

607+ Asc expression -> renderSQL expression

608+ Desc expression -> renderSQL expression

609+ AscNullsFirst expression -> renderSQL expression

610+ DescNullsFirst expression -> renderSQL expression

611+ AscNullsLast expression -> renderSQL expression

612+ DescNullsLast expression -> renderSQL expression

613+

614+-- | Like `selectDistinctOn` but takes an `NP` list of `Expression`s instead

615+-- of a general `Selection`.

616+selectDistinctOn_

617+ :: (SListI columns, columns ~ (col ': cols))

618+ => [SortExpression outer commons grp schemas params from]

619+ -- ^ distinct on and return the first row in ordering

620+ -> NP (Aliased (Expression outer commons grp schemas params from)) columns

621+ -- ^ selection

622+ -> TableExpression outer commons grp schemas params from

623+ -- ^ intermediate virtual table

624+ -> Query outer commons schemas params columns

625+selectDistinctOn_ distincts = selectDistinctOn distincts . List

465

626

466-- | `values` computes a row value or set of row values

627-- | `values` computes a row value or set of row values

467-- specified by value expressions. It is most commonly used

628-- specified by value expressions. It is most commonly used

@@ -469,16 +630,16 @@ selectDistinct_ list = select (List list)

469-- but it can be used on its own.

630-- but it can be used on its own.

470--

631--

471-- >>> type Row = '["a" ::: 'NotNull 'PGint4, "b" ::: 'NotNull 'PGtext]

632-- >>> type Row = '["a" ::: 'NotNull 'PGint4, "b" ::: 'NotNull 'PGtext]

472−-- >>> let query = values (1 `as` #a :* "one" `as` #b) [] :: Query db '[] Row

633+-- >>> let query = values (1 `as` #a :* "one" `as` #b) [] :: Query outer commons schemas '[] Row

473-- >>> printSQL query

634-- >>> printSQL query

474-- SELECT * FROM (VALUES (1, E'one')) AS t ("a", "b")

635-- SELECT * FROM (VALUES (1, E'one')) AS t ("a", "b")

475values

636values

476 :: SListI cols

637 :: SListI cols

477− => NP (Aliased (Expression db params 'Ungrouped '[] )) cols

638+ => NP (Aliased (Expression outer commons 'Ungrouped schemas params '[] )) cols

478− -> [NP (Aliased (Expression db params 'Ungrouped '[] )) cols]

639+ -> [NP (Aliased (Expression outer commons 'Ungrouped schemas params '[] )) cols]

479 -- ^ When more than one row is specified, all the rows must

640 -- ^ When more than one row is specified, all the rows must

480 -- must have the same number of elements

641 -- must have the same number of elements

481− -> Query db params cols

642+ -> Query outer commons schemas params cols

482values rw rws = UnsafeQuery $ "SELECT * FROM"

643values rw rws = UnsafeQuery $ "SELECT * FROM"

483 <+> parenthesized (

644 <+> parenthesized (

484 "VALUES"

645 "VALUES"

@@ -489,17 +650,17 @@ values rw rws = UnsafeQuery $ "SELECT * FROM"

489 <+> parenthesized (renderCommaSeparated renderAliasPart rw)

650 <+> parenthesized (renderCommaSeparated renderAliasPart rw)

490 where

651 where

491 renderAliasPart, renderValuePart

652 renderAliasPart, renderValuePart

492− :: Aliased (Expression db params 'Ungrouped '[] ) ty -> ByteString

653+ :: Aliased (Expression outer commons 'Ungrouped schemas params '[] ) ty -> ByteString

493− renderAliasPart (_ `As` name) = renderAlias name

654+ renderAliasPart (_ `As` name) = renderSQL name

494− renderValuePart (value `As` _) = renderExpression value

655+ renderValuePart (value `As` _) = renderSQL value

495

656

496-- | `values_` computes a row value or set of row values

657-- | `values_` computes a row value or set of row values

497-- specified by value expressions.

658-- specified by value expressions.

498values_

659values_

499 :: SListI cols

660 :: SListI cols

500− => NP (Aliased (Expression db params 'Ungrouped '[] )) cols

661+ => NP (Aliased (Expression outer commons 'Ungrouped schemas params '[] )) cols

501 -- ^ one row of values

662 -- ^ one row of values

502− -> Query db params cols

663+ -> Query outer commons schemas params cols

503values_ rw = values rw []

664values_ rw = values rw []

504

665

505{-----------------------------------------

666{-----------------------------------------

@@ -513,15 +674,17 @@ Table Expressions

513-- to a table on disk, a so-called base table, but more complex expressions

674-- to a table on disk, a so-called base table, but more complex expressions

514-- can be used to modify or combine base tables in various ways.

675-- can be used to modify or combine base tables in various ways.

515data TableExpression

676data TableExpression

516− (db :: DBType)

677+ (outer :: FromType)

517− (params :: [NullityType])

678+ (commons :: FromType)

518 (grp :: Grouping)

679 (grp :: Grouping)

680+ (schemas :: SchemasType)

681+ (params :: [NullityType])

519 (from :: FromType)

682 (from :: FromType)

520 = TableExpression

683 = TableExpression

521− { fromClause :: FromClause db params from

684+ { fromClause :: FromClause outer commons schemas params from

522 -- ^ A table reference that can be a table name, or a derived table such

685 -- ^ A table reference that can be a table name, or a derived table such

523 -- as a subquery, a @JOIN@ construct, or complex combinations of these.

686 -- as a subquery, a @JOIN@ construct, or complex combinations of these.

524− , whereClause :: [Condition db params 'Ungrouped from]

687+ , whereClause :: [Condition outer commons 'Ungrouped schemas params from]

525 -- ^ optional search coditions, combined with `.&&`. After the processing

688 -- ^ optional search coditions, combined with `.&&`. After the processing

526 -- of the `fromClause` is done, each row of the derived virtual table

689 -- of the `fromClause` is done, each row of the derived virtual table

527 -- is checked against the search condition. If the result of the

690 -- is checked against the search condition. If the result of the

@@ -537,13 +700,13 @@ data TableExpression

537 -- set of rows having common values into one group row that represents all

700 -- set of rows having common values into one group row that represents all

538 -- rows in the group. This is done to eliminate redundancy in the output

701 -- rows in the group. This is done to eliminate redundancy in the output

539 -- and/or compute aggregates that apply to these groups.

702 -- and/or compute aggregates that apply to these groups.

540− , havingClause :: HavingClause db params grp from

703+ , havingClause :: HavingClause outer commons grp schemas params from

541 -- ^ If a table has been grouped using `groupBy`, but only certain groups

704 -- ^ If a table has been grouped using `groupBy`, but only certain groups

542 -- are of interest, the `havingClause` can be used, much like a

705 -- are of interest, the `havingClause` can be used, much like a

543 -- `whereClause`, to eliminate groups from the result. Expressions in the

706 -- `whereClause`, to eliminate groups from the result. Expressions in the

544 -- `havingClause` can refer both to grouped expressions and to ungrouped

707 -- `havingClause` can refer both to grouped expressions and to ungrouped

545 -- expressions (which necessarily involve an aggregate function).

708 -- expressions (which necessarily involve an aggregate function).

546− , orderByClause :: [SortExpression db params grp from]

709+ , orderByClause :: [SortExpression outer commons grp schemas params from]

547 -- ^ The `orderByClause` is for optional sorting. When more than one

710 -- ^ The `orderByClause` is for optional sorting. When more than one

548 -- `SortExpression` is specified, the later (right) values are used to sort

711 -- `SortExpression` is specified, the later (right) values are used to sort

549 -- rows that are equal according to the earlier (left) values.

712 -- rows that are equal according to the earlier (left) values.

@@ -553,72 +716,69 @@ data TableExpression

553 -- will be returned (but possibly fewer, if the query itself yields

716 -- will be returned (but possibly fewer, if the query itself yields

554 -- fewer rows).

717 -- fewer rows).

555 , offsetClause :: [Word64]

718 , offsetClause :: [Word64]

556− -- ^ The `offsetClause` is combined with `+` to give an offset count

719+ -- ^ The `offsetClause` is combined with `Prelude.+` to give an offset count

557 -- if nonempty. The offset count says to skip that many rows before

720 -- if nonempty. The offset count says to skip that many rows before

558 -- beginning to return rows. The rows are skipped before the limit count

721 -- beginning to return rows. The rows are skipped before the limit count

559 -- is applied.

722 -- is applied.

560− }

723+ } deriving (GHC.Generic)

561

724

562-- | Render a `TableExpression`

725-- | Render a `TableExpression`

563−renderTableExpression

726+instance RenderSQL (TableExpression outer commons grp schemas params from) where

564− :: TableExpression db params grp from

727+ renderSQL

565− -> ByteString

728+ (TableExpression frm' whs' grps' hvs' srts' lims' offs') = mconcat

566−renderTableExpression

729+ [ "FROM ", renderSQL frm'

567− (TableExpression frm' whs' grps' hvs' srts' lims' offs') = mconcat

730+ , renderWheres whs'

568− [ "FROM ", renderFromClause frm'

731+ , renderSQL grps'

569− , renderWheres whs'

732+ , renderSQL hvs'

570− , renderGroupByClause grps'

733+ , renderOrderByClause srts'

571− , renderHavingClause hvs'

734+ , renderLimits lims'

572− , renderOrderByClause srts'

735+ , renderOffsets offs' ]

573− , renderLimits lims'

736+ where

574− , renderOffsets offs'

737+ renderWheres = \case

575− ]

738+ [] -> ""

576− where

739+ wh:[] -> " WHERE" <+> renderSQL wh

577− renderWheres = \case

740+ wh:whs -> " WHERE" <+> renderSQL (foldr (.&&) wh whs)

578− [] -> ""

741+ renderOrderByClause = \case

579− wh:[] -> " WHERE" <+> renderExpression wh

742+ [] -> ""

580− wh:whs -> " WHERE" <+> renderExpression (foldr (.&&) wh whs)

743+ srts -> " ORDER BY"

581− renderOrderByClause = \case

744+ <+> commaSeparated (renderSQL <$> srts)

582− [] -> ""

745+ renderLimits = \case

583− srts -> " ORDER BY"

746+ [] -> ""

584− <+> commaSeparated (renderSortExpression <$> srts)

747+ lims -> " LIMIT" <+> fromString (show (minimum lims))

585− renderLimits = \case

748+ renderOffsets = \case

586− [] -> ""

749+ [] -> ""

587− lims -> " LIMIT" <+> fromString (show (minimum lims))

750+ offs -> " OFFSET" <+> fromString (show (sum offs))

588− renderOffsets = \case

589− [] -> ""

590− offs -> " OFFSET" <+> fromString (show (sum offs))

591

751

592-- | A `from` generates a `TableExpression` from a table reference that can be

752-- | A `from` generates a `TableExpression` from a table reference that can be

593-- a table name, or a derived table such as a subquery, a JOIN construct,

753-- a table name, or a derived table such as a subquery, a JOIN construct,

594-- or complex combinations of these. A `from` may be transformed by `where_`,

754-- or complex combinations of these. A `from` may be transformed by `where_`,

595−-- `group`, `having`, `orderBy`, `limit` and `offset`, using the `&` operator

755+-- `groupBy`, `having`, `orderBy`, `limit` and `offset`, using the `&` operator

596-- to match the left-to-right sequencing of their placement in SQL.

756-- to match the left-to-right sequencing of their placement in SQL.

597from

757from

598− :: FromClause db params from -- ^ table reference

758+ :: FromClause outer commons schemas params from -- ^ table reference

599− -> TableExpression db params 'Ungrouped from

759+ -> TableExpression outer commons 'Ungrouped schemas params from

600−from rels = TableExpression rels [] NoGroups NoHaving [] [] []

760+from tab = TableExpression tab [] noGroups NoHaving [] [] []

601

761

602-- | A `where_` is an endomorphism of `TableExpression`s which adds a

762-- | A `where_` is an endomorphism of `TableExpression`s which adds a

603-- search condition to the `whereClause`.

763-- search condition to the `whereClause`.

604where_

764where_

605− :: Condition db params 'Ungrouped from -- ^ filtering condition

765+ :: Condition outer commons 'Ungrouped schemas params from -- ^ filtering condition

606− -> TableExpression db params grp from

766+ -> TableExpression outer commons grp schemas params from

607− -> TableExpression db params grp from

767+ -> TableExpression outer commons grp schemas params from

608where_ wh rels = rels {whereClause = wh : whereClause rels}

768where_ wh rels = rels {whereClause = wh : whereClause rels}

609

769

610-- | A `groupBy` is a transformation of `TableExpression`s which switches

770-- | A `groupBy` is a transformation of `TableExpression`s which switches

611−-- its `Grouping` from `Ungrouped` to `Grouped`. Use @group Nil@ to perform

771+-- its `Grouping` from `Ungrouped` to `Grouped`. Use @groupBy Nil@ to perform

612-- a "grand total" aggregation query.

772-- a "grand total" aggregation query.

613groupBy

773groupBy

614 :: SListI bys

774 :: SListI bys

615 => NP (By from) bys -- ^ grouped columns

775 => NP (By from) bys -- ^ grouped columns

616− -> TableExpression db params 'Ungrouped from

776+ -> TableExpression outer commons 'Ungrouped schemas params from

617− -> TableExpression db params ('Grouped bys) from

777+ -> TableExpression outer commons ('Grouped bys) schemas params from

618groupBy bys rels = TableExpression

778groupBy bys rels = TableExpression

619 { fromClause = fromClause rels

779 { fromClause = fromClause rels

620 , whereClause = whereClause rels

780 , whereClause = whereClause rels

621− , groupByClause = Group bys

781+ , groupByClause = group bys

622 , havingClause = Having []

782 , havingClause = Having []

623 , orderByClause = []

783 , orderByClause = []

624 , limitClause = limitClause rels

784 , limitClause = limitClause rels

@@ -628,177 +788,31 @@ groupBy bys rels = TableExpression

628-- | A `having` is an endomorphism of `TableExpression`s which adds a

788-- | A `having` is an endomorphism of `TableExpression`s which adds a

629-- search condition to the `havingClause`.

789-- search condition to the `havingClause`.

630having

790having

631− :: Condition db params ('Grouped bys) from -- ^ having condition

791+ :: Condition outer commons ('Grouped bys) schemas params from -- ^ having condition

632− -> TableExpression db params ('Grouped bys) from

792+ -> TableExpression outer commons ('Grouped bys) schemas params from

633− -> TableExpression db params ('Grouped bys) from

793+ -> TableExpression outer commons ('Grouped bys) schemas params from

634having hv rels = rels

794having hv rels = rels

635 { havingClause = case havingClause rels of Having hvs -> Having (hv:hvs) }

795 { havingClause = case havingClause rels of Having hvs -> Having (hv:hvs) }

636

796

637−-- | An `orderBy` is an endomorphism of `TableExpression`s which appends an

797+instance OrderBy TableExpression where

638−-- ordering to the right of the `orderByClause`.

798+ orderBy srts rels = rels {orderByClause = orderByClause rels ++ srts}

639−orderBy

640− :: [SortExpression db params grp from] -- ^ sort expressions

641− -> TableExpression db params grp from

642− -> TableExpression db params grp from

643−orderBy srts rels = rels {orderByClause = orderByClause rels ++ srts}

644

799

645-- | A `limit` is an endomorphism of `TableExpression`s which adds to the

800-- | A `limit` is an endomorphism of `TableExpression`s which adds to the

646-- `limitClause`.

801-- `limitClause`.

647limit

802limit

648 :: Word64 -- ^ limit parameter

803 :: Word64 -- ^ limit parameter

649− -> TableExpression db params grp from

804+ -> TableExpression outer commons grp schemas params from

650− -> TableExpression db params grp from

805+ -> TableExpression outer commons grp schemas params from

651limit lim rels = rels {limitClause = lim : limitClause rels}

806limit lim rels = rels {limitClause = lim : limitClause rels}

652

807

653-- | An `offset` is an endomorphism of `TableExpression`s which adds to the

808-- | An `offset` is an endomorphism of `TableExpression`s which adds to the

654-- `offsetClause`.

809-- `offsetClause`.

655offset

810offset

656 :: Word64 -- ^ offset parameter

811 :: Word64 -- ^ offset parameter

657− -> TableExpression db params grp from

812+ -> TableExpression outer commons grp schemas params from

658− -> TableExpression db params grp from

813+ -> TableExpression outer commons grp schemas params from

659offset off rels = rels {offsetClause = off : offsetClause rels}

814offset off rels = rels {offsetClause = off : offsetClause rels}

660

815

661−{-----------------------------------------

662−JSON stuff

663−-----------------------------------------}

664−

665−unsafeSetOfFunction

666− :: ByteString

667− -> Expression db params 'Ungrouped '[] ty

668− -> Query db params row

669−unsafeSetOfFunction fun expr = UnsafeQuery $

670− "SELECT * FROM " <> fun <> "(" <> renderExpression expr <> ")"

671−

672−-- | Expands the outermost JSON object into a set of key/value pairs.

673−jsonEach

674− :: Expression db params 'Ungrouped '[] (nullity 'PGjson) -- ^ json object

675− -> Query db params

676− '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]

677−jsonEach = unsafeSetOfFunction "json_each"

678−

679−-- | Expands the outermost binary JSON object into a set of key/value pairs.

680−jsonbEach

681− :: Expression db params 'Ungrouped '[] (nullity 'PGjsonb) -- ^ jsonb object

682− -> Query db params

683− '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjsonb]

684−jsonbEach = unsafeSetOfFunction "jsonb_each"

685−

686−-- | Expands the outermost JSON object into a set of key/value pairs.

687−jsonEachAsText

688− :: Expression db params 'Ungrouped '[] (nullity 'PGjson) -- ^ json object

689− -> Query db params

690− '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

691−jsonEachAsText = unsafeSetOfFunction "json_each_text"

692−

693−-- | Expands the outermost binary JSON object into a set of key/value pairs.

694−jsonbEachAsText

695− :: Expression db params 'Ungrouped '[] (nullity 'PGjsonb) -- ^ jsonb object

696− -> Query db params

697− '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

698−jsonbEachAsText = unsafeSetOfFunction "jsonb_each_text"

699−

700−-- | Returns set of keys in the outermost JSON object.

701−jsonObjectKeys

702− :: Expression db params 'Ungrouped '[] (nullity 'PGjson) -- ^ json object

703− -> Query db params '["json_object_keys" ::: 'NotNull 'PGtext]

704−jsonObjectKeys = unsafeSetOfFunction "json_object_keys"

705−

706−-- | Returns set of keys in the outermost JSON object.

707−jsonbObjectKeys

708− :: Expression db params 'Ungrouped '[] (nullity 'PGjsonb) -- ^ jsonb object

709− -> Query db params '["jsonb_object_keys" ::: 'NotNull 'PGtext]

710−jsonbObjectKeys = unsafeSetOfFunction "jsonb_object_keys"

711−

712−unsafePopulateFunction

713− :: ByteString

714− -> TypeExpression schemas (nullity ('PGcomposite row))

715− -> Expression (commons :=> schemas) params 'Ungrouped '[] ty

716− -> Query (commons :=> schemas) params row

717−unsafePopulateFunction fun ty expr = UnsafeQuery $

718− "SELECT * FROM " <> fun <> "("

719− <> "null::" <> renderTypeExpression ty <> ", "

720− <> renderExpression expr <> ")"

721−

722−-- | Expands the JSON expression to a row whose columns match the record

723−-- type defined by the given table.

724−jsonPopulateRecord

725− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

726− -> Expression (commons :=> schemas) params 'Ungrouped '[] (nullity 'PGjson) -- ^ json object

727− -> Query (commons :=> schemas) params row

728−jsonPopulateRecord = unsafePopulateFunction "json_populate_record"

729−

730−-- | Expands the binary JSON expression to a row whose columns match the record

731−-- type defined by the given table.

732−jsonbPopulateRecord

733− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

734− -> Expression (commons :=> schemas) params 'Ungrouped '[] (nullity 'PGjsonb) -- ^ jsonb object

735− -> Query (commons :=> schemas) params row

736−jsonbPopulateRecord = unsafePopulateFunction "jsonb_populate_record"

737−

738−-- | Expands the outermost array of objects in the given JSON expression to a

739−-- set of rows whose columns match the record type defined by the given table.

740−jsonPopulateRecordSet

741− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

742− -> Expression (commons :=> schemas) params 'Ungrouped '[] (nullity 'PGjson) -- ^ json array

743− -> Query (commons :=> schemas) params row

744−jsonPopulateRecordSet = unsafePopulateFunction "json_populate_record_set"

745−

746−-- | Expands the outermost array of objects in the given binary JSON expression

747−-- to a set of rows whose columns match the record type defined by the given

748−-- table.

749−jsonbPopulateRecordSet

750− :: TypeExpression schemas (nullity ('PGcomposite row)) -- ^ row type

751− -> Expression (commons :=> schemas) params 'Ungrouped '[] (nullity 'PGjsonb) -- ^ jsonb array

752− -> Query (commons :=> schemas) params row

753−jsonbPopulateRecordSet = unsafePopulateFunction "jsonb_populate_record_set"

754−

755−unsafeRecordFunction

756− :: (SListI record, json `In` PGJsonType)

757− => ByteString

758− -> Expression (commons :=> schemas) params 'Ungrouped '[] (nullity json)

759− -> NP (Aliased (TypeExpression schemas)) record

760− -> Query (commons :=> schemas) params record

761−unsafeRecordFunction fun expr types = UnsafeQuery $

762− "SELECT * FROM " <> fun <> "("

763− <> renderExpression expr <> ")"

764− <+> "AS" <+> "x" <> parenthesized (renderCommaSeparated renderTy types)

765− where

766− renderTy :: Aliased (TypeExpression db) ty -> ByteString

767− renderTy (ty `As` alias) =

768− renderAlias alias <+> renderTypeExpression ty

769−

770−-- | Builds an arbitrary record from a JSON object.

771−jsonToRecord

772− :: SListI record

773− => Expression (commons :=> schemas) params 'Ungrouped '[] (nullity 'PGjson) -- ^ json object

774− -> NP (Aliased (TypeExpression schemas)) record -- ^ record types

775− -> Query (commons :=> schemas) params record

776−jsonToRecord = unsafeRecordFunction "json_to_record"

777−

778−-- | Builds an arbitrary record from a binary JSON object.

779−jsonbToRecord

780− :: SListI record

781− => Expression (commons :=> schemas) params 'Ungrouped '[] (nullity 'PGjsonb) -- ^ jsonb object

782− -> NP (Aliased (TypeExpression schemas)) record -- ^ record types

783− -> Query (commons :=> schemas) params record

784−jsonbToRecord = unsafeRecordFunction "jsonb_to_record"

785−

786−-- | Builds an arbitrary set of records from a JSON array of objects.

787−jsonToRecordSet

788− :: SListI record

789− => Expression (commons :=> schemas) params 'Ungrouped '[] (nullity 'PGjson) -- ^ json array

790− -> NP (Aliased (TypeExpression schemas)) record -- ^ record types

791− -> Query (commons :=> schemas) params record

792−jsonToRecordSet = unsafeRecordFunction "json_to_record_set"

793−

794−-- | Builds an arbitrary set of records from a binary JSON array of objects.

795−jsonbToRecordSet

796− :: SListI record

797− => Expression (commons :=> schemas) params 'Ungrouped '[] (nullity 'PGjsonb) -- ^ jsonb array

798− -> NP (Aliased (TypeExpression schemas)) record -- ^ record types

799− -> Query (commons :=> schemas) params record

800−jsonbToRecordSet = unsafeRecordFunction "jsonb_to_record_set"

801−

802{-----------------------------------------

816{-----------------------------------------

803FROM clauses

817FROM clauses

804-----------------------------------------}

818-----------------------------------------}

@@ -807,68 +821,76 @@ FROM clauses

807A `FromClause` can be a table name, or a derived table such

821A `FromClause` can be a table name, or a derived table such

808as a subquery, a @JOIN@ construct, or complex combinations of these.

822as a subquery, a @JOIN@ construct, or complex combinations of these.

809-}

823-}

810−newtype FromClause db params from

824+newtype FromClause outer commons schemas params from

811 = UnsafeFromClause { renderFromClause :: ByteString }

825 = UnsafeFromClause { renderFromClause :: ByteString }

812 deriving (GHC.Generic,Show,Eq,Ord,NFData)

826 deriving (GHC.Generic,Show,Eq,Ord,NFData)

827+instance RenderSQL (FromClause outer commons schemas params from) where

828+ renderSQL = renderFromClause

813

829

814-- | A real `table` is a table from the database.

830-- | A real `table` is a table from the database.

815table

831table

816 :: (Has sch schemas schema, Has tab schema ('Table table))

832 :: (Has sch schemas schema, Has tab schema ('Table table))

817 => Aliased (QualifiedAlias sch) (alias ::: tab)

833 => Aliased (QualifiedAlias sch) (alias ::: tab)

818− -> FromClause (commons :=> schemas) params '[alias ::: TableToRow table]

834+ -> FromClause outer commons schemas params '[alias ::: TableToRow table]

819table (tab `As` alias) = UnsafeFromClause $

835table (tab `As` alias) = UnsafeFromClause $

820− renderQualifiedAlias tab <+> "AS" <+> renderAlias alias

836+ renderSQL tab <+> "AS" <+> renderSQL alias

821

837

822-- | `subquery` derives a table from a `Query`.

838-- | `subquery` derives a table from a `Query`.

823subquery

839subquery

824− :: Aliased (Query db params) query

840+ :: Aliased (Query outer commons schemas params) query

825− -> FromClause db params '[query]

841+ -> FromClause outer commons schemas params '[query]

826−subquery = UnsafeFromClause . renderAliasedAs (parenthesized . renderQuery)

842+subquery = UnsafeFromClause . renderAliased (parenthesized . renderSQL)

827

843

828-- | `view` derives a table from a `View`.

844-- | `view` derives a table from a `View`.

829view

845view

830 :: (Has sch schemas schema, Has vw schema ('View view))

846 :: (Has sch schemas schema, Has vw schema ('View view))

831 => Aliased (QualifiedAlias sch) (alias ::: vw)

847 => Aliased (QualifiedAlias sch) (alias ::: vw)

832− -> FromClause (commons :=> schemas) params '[alias ::: view]

848+ -> FromClause outer commons schemas params '[alias ::: view]

833view (vw `As` alias) = UnsafeFromClause $

849view (vw `As` alias) = UnsafeFromClause $

834− renderQualifiedAlias vw <+> "AS" <+> renderAlias alias

850+ renderSQL vw <+> "AS" <+> renderSQL alias

835

851

852+-- | `common` derives a table from a common table expression.

836common

853common

837 :: Has cte commons common

854 :: Has cte commons common

838 => Aliased Alias (alias ::: cte)

855 => Aliased Alias (alias ::: cte)

839− -> FromClause (commons :=> schemas) params '[alias ::: common]

856+ -> FromClause outer commons schemas params '[alias ::: common]

840common (cte `As` alias) = UnsafeFromClause $

857common (cte `As` alias) = UnsafeFromClause $

841− renderAlias cte <+> "AS" <+> renderAlias alias

858+ renderSQL cte <+> "AS" <+> renderSQL alias

842

859

843−{- | @left & crossJoin right@. For every possible combination of rows from

860+instance Additional (FromClause outer commons schemas params) where

844− @left@ and @right@ (i.e., a Cartesian product), the joined table will contain

861+ also right left = UnsafeFromClause $

845− a row consisting of all columns in @left@ followed by all columns in @right@.

862+ renderSQL left <> ", " <> renderSQL right

846− If the tables have @n@ and @m@ rows respectively, the joined table will

863+

847− have @n * m@ rows.

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.

848-}

870-}

849crossJoin

871crossJoin

850− :: FromClause db params right

872+ :: FromClause outer commons schemas params right

851 -- ^ right

873 -- ^ right

852− -> FromClause db params left

874+ -> FromClause outer commons schemas params left

853 -- ^ left

875 -- ^ left

854− -> FromClause db params (Join left right)

876+ -> FromClause outer commons schemas params (Join left right)

855crossJoin right left = UnsafeFromClause $

877crossJoin right left = UnsafeFromClause $

856− renderFromClause left <+> "CROSS JOIN" <+> renderFromClause right

878+ renderSQL left <+> "CROSS JOIN" <+> renderSQL right

857

879

858{- | @left & innerJoin right on@. The joined table is filtered by

880{- | @left & innerJoin right on@. The joined table is filtered by

859the @on@ condition.

881the @on@ condition.

860-}

882-}

861innerJoin

883innerJoin

862− :: FromClause db params right

884+ :: FromClause outer commons schemas params right

863 -- ^ right

885 -- ^ right

864− -> Condition db params 'Ungrouped (Join left right)

886+ -> Condition outer commons 'Ungrouped schemas params (Join left right)

865 -- ^ @on@ condition

887 -- ^ @on@ condition

866− -> FromClause db params left

888+ -> FromClause outer commons schemas params left

867 -- ^ left

889 -- ^ left

868− -> FromClause db params (Join left right)

890+ -> FromClause outer commons schemas params (Join left right)

869innerJoin right on left = UnsafeFromClause $

891innerJoin right on left = UnsafeFromClause $

870− renderFromClause left <+> "INNER JOIN" <+> renderFromClause right

892+ renderSQL left <+> "INNER JOIN" <+> renderSQL right

871− <+> "ON" <+> renderExpression on

893+ <+> "ON" <+> renderSQL on

872

894

873{- | @left & leftOuterJoin right on@. First, an inner join is performed.

895{- | @left & leftOuterJoin right on@. First, an inner join is performed.

874 Then, for each row in @left@ that does not satisfy the @on@ condition with

896 Then, for each row in @left@ that does not satisfy the @on@ condition with

@@ -876,16 +898,16 @@ innerJoin right on left = UnsafeFromClause $

876 Thus, the joined table always has at least one row for each row in @left@.

898 Thus, the joined table always has at least one row for each row in @left@.

877-}

899-}

878leftOuterJoin

900leftOuterJoin

879− :: FromClause db params right

901+ :: FromClause outer commons schemas params right

880 -- ^ right

902 -- ^ right

881− -> Condition db params 'Ungrouped (Join left right)

903+ -> Condition outer commons 'Ungrouped schemas params (Join left right)

882 -- ^ @on@ condition

904 -- ^ @on@ condition

883− -> FromClause db params left

905+ -> FromClause outer commons schemas params left

884 -- ^ left

906 -- ^ left

885− -> FromClause db params (Join left (NullifyFrom right))

907+ -> FromClause outer commons schemas params (Join left (NullifyFrom right))

886leftOuterJoin right on left = UnsafeFromClause $

908leftOuterJoin right on left = UnsafeFromClause $

887− renderFromClause left <+> "LEFT OUTER JOIN" <+> renderFromClause right

909+ renderSQL left <+> "LEFT OUTER JOIN" <+> renderSQL right

888− <+> "ON" <+> renderExpression on

910+ <+> "ON" <+> renderSQL on

889

911

890{- | @left & rightOuterJoin right on@. First, an inner join is performed.

912{- | @left & rightOuterJoin right on@. First, an inner join is performed.

891 Then, for each row in @right@ that does not satisfy the @on@ condition with

913 Then, for each row in @right@ that does not satisfy the @on@ condition with

@@ -894,16 +916,16 @@ leftOuterJoin right on left = UnsafeFromClause $

894 have a row for each row in @right@.

916 have a row for each row in @right@.

895-}

917-}

896rightOuterJoin

918rightOuterJoin

897− :: FromClause db params right

919+ :: FromClause outer commons schemas params right

898 -- ^ right

920 -- ^ right

899− -> Condition db params 'Ungrouped (Join left right)

921+ -> Condition outer commons 'Ungrouped schemas params (Join left right)

900 -- ^ @on@ condition

922 -- ^ @on@ condition

901− -> FromClause db params left

923+ -> FromClause outer commons schemas params left

902 -- ^ left

924 -- ^ left

903− -> FromClause db params (Join (NullifyFrom left) right)

925+ -> FromClause outer commons schemas params (Join (NullifyFrom left) right)

904rightOuterJoin right on left = UnsafeFromClause $

926rightOuterJoin right on left = UnsafeFromClause $

905− renderFromClause left <+> "RIGHT OUTER JOIN" <+> renderFromClause right

927+ renderSQL left <+> "RIGHT OUTER JOIN" <+> renderSQL right

906− <+> "ON" <+> renderExpression on

928+ <+> "ON" <+> renderSQL on

907

929

908{- | @left & fullOuterJoin right on@. First, an inner join is performed.

930{- | @left & fullOuterJoin right on@. First, an inner join is performed.

909 Then, for each row in @left@ that does not satisfy the @on@ condition with

931 Then, for each row in @left@ that does not satisfy the @on@ condition with

@@ -913,23 +935,23 @@ rightOuterJoin right on left = UnsafeFromClause $

913 is added.

935 is added.

914-}

936-}

915fullOuterJoin

937fullOuterJoin

916− :: FromClause db params right

938+ :: FromClause outer commons schemas params right

917 -- ^ right

939 -- ^ right

918− -> Condition db params 'Ungrouped (Join left right)

940+ -> Condition outer commons 'Ungrouped schemas params (Join left right)

919 -- ^ @on@ condition

941 -- ^ @on@ condition

920− -> FromClause db params left

942+ -> FromClause outer commons schemas params left

921 -- ^ left

943 -- ^ left

922− -> FromClause db params

944+ -> FromClause outer commons schemas params

923 (Join (NullifyFrom left) (NullifyFrom right))

945 (Join (NullifyFrom left) (NullifyFrom right))

924fullOuterJoin right on left = UnsafeFromClause $

946fullOuterJoin right on left = UnsafeFromClause $

925− renderFromClause left <+> "FULL OUTER JOIN" <+> renderFromClause right

947+ renderSQL left <+> "FULL OUTER JOIN" <+> renderSQL right

926− <+> "ON" <+> renderExpression on

948+ <+> "ON" <+> renderSQL on

927

949

928{-----------------------------------------

950{-----------------------------------------

929Grouping

951Grouping

930-----------------------------------------}

952-----------------------------------------}

931

953

932−-- | `By`s are used in `group` to reference a list of columns which are then

954+-- | `By`s are used in `groupBy` to reference a list of columns which are then

933-- used to group together those rows in a table that have the same values

955-- used to group together those rows in a table that have the same values

934-- in all the columns listed. @By \#col@ will reference an unambiguous

956-- in all the columns listed. @By \#col@ will reference an unambiguous

935-- column @col@; otherwise @By2 (\#tab \! \#col)@ will reference a table

957-- column @col@; otherwise @By2 (\#tab \! \#col)@ will reference a table

@@ -949,6 +971,10 @@ data By

949deriving instance Show (By from by)

971deriving instance Show (By from by)

950deriving instance Eq (By from by)

972deriving instance Eq (By from by)

951deriving instance Ord (By from by)

973deriving instance Ord (By from by)

974+instance RenderSQL (By from by) where

975+ renderSQL = \case

976+ By1 column -> renderSQL column

977+ By2 rel column -> renderSQL rel <> "." <> renderSQL column

952

978

953instance (HasUnique rel rels cols, Has col cols ty, by ~ '(rel, col))

979instance (HasUnique rel rels cols, Has col cols ty, by ~ '(rel, col))

954 => IsLabel col (By rels by) where fromLabel = By1 fromLabel

980 => IsLabel col (By rels by) where fromLabel = By1 fromLabel

@@ -960,424 +986,113 @@ instance (Has rel rels cols, Has col cols ty, bys ~ '[ '(rel, col)])

960 => IsQualified rel col (NP (By rels) bys) where

986 => IsQualified rel col (NP (By rels) bys) where

961 rel ! col = By2 rel col :* Nil

987 rel ! col = By2 rel col :* Nil

962

988

963−-- | Renders a `By`.

964−renderBy :: By from by -> ByteString

965−renderBy = \case

966− By1 column -> renderAlias column

967− By2 rel column -> renderAlias rel <> "." <> renderAlias column

968−

969-- | A `GroupByClause` indicates the `Grouping` of a `TableExpression`.

989-- | A `GroupByClause` indicates the `Grouping` of a `TableExpression`.

970-- A `NoGroups` indicates `Ungrouped` while a `Group` indicates `Grouped`.

990-- A `NoGroups` indicates `Ungrouped` while a `Group` indicates `Grouped`.

971-- @NoGroups@ is distinguised from @Group Nil@ since no aggregation can be

991-- @NoGroups@ is distinguised from @Group Nil@ since no aggregation can be

972-- done on @NoGroups@ while all output `Expression`s must be aggregated

992-- done on @NoGroups@ while all output `Expression`s must be aggregated

973-- in @Group Nil@. In general, all output `Expression`s in the

993-- in @Group Nil@. In general, all output `Expression`s in the

974-- complement of @bys@ must be aggregated in @Group bys@.

994-- complement of @bys@ must be aggregated in @Group bys@.

975−data GroupByClause grp from where

995+newtype GroupByClause grp from = UnsafeGroupByClause

976− NoGroups :: GroupByClause 'Ungrouped from

996+ { renderGroupByClause :: ByteString }

977− Group

997+ deriving (GHC.Generic,Show,Eq,Ord,NFData)

978− :: SListI bys

998+instance RenderSQL (GroupByClause grp from) where

979− => NP (By from) bys

999+ renderSQL = renderGroupByClause

980− -> GroupByClause ('Grouped bys) from

1000+noGroups :: GroupByClause 'Ungrouped from

981−

1001+noGroups = UnsafeGroupByClause ""

982−-- | Renders a `GroupByClause`.

1002+group

983−renderGroupByClause :: GroupByClause grp from -> ByteString

1003+ :: SListI bys

984−renderGroupByClause = \case

1004+ => NP (By from) bys

985− NoGroups -> ""

1005+ -> GroupByClause ('Grouped bys) from

986− Group Nil -> ""

1006+group bys = UnsafeGroupByClause $ case bys of

987− Group bys -> " GROUP BY" <+> renderCommaSeparated renderBy bys

1007+ Nil -> ""

1008+ bys' -> " GROUP BY" <+> renderCommaSeparated renderSQL bys'

988

1009

989-- | A `HavingClause` is used to eliminate groups that are not of interest.

1010-- | A `HavingClause` is used to eliminate groups that are not of interest.

990-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`

1011-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`

991-- `TableExpression` must use `Having` whose conditions are combined with

1012-- `TableExpression` must use `Having` whose conditions are combined with

992-- `.&&`.

1013-- `.&&`.

993−data HavingClause db params grp from where

1014+data HavingClause outer commons grp schemas params from where

994− NoHaving :: HavingClause db params 'Ungrouped from

1015+ NoHaving :: HavingClause outer commons 'Ungrouped schemas params from

995 Having

1016 Having

996− :: [Condition db params ('Grouped bys) from]

1017+ :: [Condition outer commons ('Grouped bys) schemas params from]

997− -> HavingClause db params ('Grouped bys) from

1018+ -> HavingClause outer commons ('Grouped bys) schemas params from

998−deriving instance Show (HavingClause db params grp from)

1019+deriving instance Show (HavingClause outer commons grp schemas params from)

999−deriving instance Eq (HavingClause db params grp from)

1020+deriving instance Eq (HavingClause outer commons grp schemas params from)

1000−deriving instance Ord (HavingClause db params grp from)

1021+deriving instance Ord (HavingClause outer commons grp schemas params from)

1001

1022

1002-- | Render a `HavingClause`.

1023-- | Render a `HavingClause`.

1003−renderHavingClause :: HavingClause db params grp from -> ByteString

1024+instance RenderSQL (HavingClause outer commons grp schemas params from) where

1004−renderHavingClause = \case

1025+ renderSQL = \case

1005− NoHaving -> ""

1026+ NoHaving -> ""

1006− Having [] -> ""

1027+ Having [] -> ""

1007− Having conditions ->

1028+ Having conditions ->

1008− " HAVING" <+> commaSeparated (renderExpression <$> conditions)

1029+ " HAVING" <+> commaSeparated (renderSQL <$> conditions)

1009−

1010−{-----------------------------------------

1011−Sorting

1012−-----------------------------------------}

1013−

1014−-- | `SortExpression`s are used by `sortBy` to optionally sort the results

1015−-- of a `Query`. `Asc` or `Desc` set the sort direction of a `NotNull` result

1016−-- column to ascending or descending. Ascending order puts smaller values

1017−-- first, where "smaller" is defined in terms of the `.<` operator. Similarly,

1018−-- descending order is determined with the `.>` operator. `AscNullsFirst`,

1019−-- `AscNullsLast`, `DescNullsFirst` and `DescNullsLast` options are used to

1020−-- determine whether nulls appear before or after non-null values in the sort

1021−-- ordering of a `Null` result column.

1022−data SortExpression db params grp from where

1023− Asc

1024− :: Expression db params grp from ('NotNull ty)

1025− -> SortExpression db params grp from

1026− Desc

1027− :: Expression db params grp from ('NotNull ty)

1028− -> SortExpression db params grp from

1029− AscNullsFirst

1030− :: Expression db params grp from ('Null ty)

1031− -> SortExpression db params grp from

1032− AscNullsLast

1033− :: Expression db params grp from ('Null ty)

1034− -> SortExpression db params grp from

1035− DescNullsFirst

1036− :: Expression db params grp from ('Null ty)

1037− -> SortExpression db params grp from

1038− DescNullsLast

1039− :: Expression db params grp from ('Null ty)

1040− -> SortExpression db params grp from

1041−deriving instance Show (SortExpression db params grp from)

1042−

1043−-- | Render a `SortExpression`.

1044−renderSortExpression :: SortExpression db params grp from -> ByteString

1045−renderSortExpression = \case

1046− Asc expression -> renderExpression expression <+> "ASC"

1047− Desc expression -> renderExpression expression <+> "DESC"

1048− AscNullsFirst expression -> renderExpression expression

1049− <+> "ASC NULLS FIRST"

1050− DescNullsFirst expression -> renderExpression expression

1051− <+> "DESC NULLS FIRST"

1052− AscNullsLast expression -> renderExpression expression <+> "ASC NULLS LAST"

1053− DescNullsLast expression -> renderExpression expression <+> "DESC NULLS LAST"

1054−

1055−unsafeSubqueryExpression

1056− :: ByteString

1057− -> Expression db params grp from ty

1058− -> Query db params '[alias ::: ty]

1059− -> Expression db params grp from (nullity 'PGbool)

1060−unsafeSubqueryExpression op x q = UnsafeExpression $

1061− renderExpression x <+> op <+> parenthesized (renderQuery q)

1062−

1063−unsafeRowSubqueryExpression

1064− :: SListI row

1065− => ByteString

1066− -> NP (Aliased (Expression db params grp from)) row

1067− -> Query db params row

1068− -> Expression db params grp from (nullity 'PGbool)

1069−unsafeRowSubqueryExpression op xs q = UnsafeExpression $

1070− renderExpression (row xs) <+> op <+> parenthesized (renderQuery q)

1071−

1072−-- | The right-hand side is a sub`Query`, which must return exactly one column.

1073−-- The left-hand expression is evaluated and compared to each row of the

1074−-- sub`Query` result. The result of `in_` is `true` if any equal subquery row is found.

1075−-- The result is `false` if no equal row is found

1076−-- (including the case where the subquery returns no rows).

1077−--

1078−-- >>> printSQL $ true `in_` values_ (true `as` #foo)

1079−-- TRUE IN (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1080−in_

1081− :: Expression db params grp from ty -- ^ expression

1082− -> Query db params '[alias ::: ty] -- ^ subquery

1083− -> Expression db params grp from (nullity 'PGbool)

1084−in_ = unsafeSubqueryExpression "IN"

1085−

1086−{- | The left-hand side of this form of `rowIn` is a row constructor.

1087−The right-hand side is a sub`Query`,

1088−which must return exactly as many columns as

1089−there are expressions in the left-hand row.

1090−The left-hand expressions are evaluated and compared row-wise to each row

1091−of the subquery result. The result of `rowIn`

1092−is `true` if any equal subquery row is found.

1093−The result is `false` if no equal row is found

1094−(including the case where the subquery returns no rows).

1095−

1096−>>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1097−>>> printSQL $ myRow `rowIn` values_ myRow

1098−ROW(1, FALSE) IN (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1099−-}

1100−rowIn

1101− :: SListI row

1102− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1103− -> Query db params row -- ^ subquery

1104− -> Expression db params grp from (nullity 'PGbool)

1105−rowIn = unsafeRowSubqueryExpression "IN"

1106−

1107−-- | >>> printSQL $ true `eqAll` values_ (true `as` #foo)

1108−-- TRUE = ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1109−eqAll

1110− :: Expression db params grp from ty -- ^ expression

1111− -> Query db params '[alias ::: ty] -- ^ subquery

1112− -> Expression db params grp from (nullity 'PGbool)

1113−eqAll = unsafeSubqueryExpression "= ALL"

1114−

1115−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1116−-- >>> printSQL $ myRow `rowEqAll` values_ myRow

1117−-- ROW(1, FALSE) = ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1118−rowEqAll

1119− :: SListI row

1120− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1121− -> Query db params row -- ^ subquery

1122− -> Expression db params grp from (nullity 'PGbool)

1123−rowEqAll = unsafeRowSubqueryExpression "= ALL"

1124−

1125−-- | >>> printSQL $ true `eqAny` values_ (true `as` #foo)

1126−-- TRUE = ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1127−eqAny

1128− :: Expression db params grp from ty -- ^ expression

1129− -> Query db params '[alias ::: ty] -- ^ subquery

1130− -> Expression db params grp from (nullity 'PGbool)

1131−eqAny = unsafeSubqueryExpression "= ANY"

1132−

1133−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1134−-- >>> printSQL $ myRow `rowEqAny` values_ myRow

1135−-- ROW(1, FALSE) = ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1136−rowEqAny

1137− :: SListI row

1138− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1139− -> Query db params row -- ^ subquery

1140− -> Expression db params grp from (nullity 'PGbool)

1141−rowEqAny = unsafeRowSubqueryExpression "= ANY"

1142−

1143−-- | >>> printSQL $ true `neqAll` values_ (true `as` #foo)

1144−-- TRUE <> ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1145−neqAll

1146− :: Expression db params grp from ty -- ^ expression

1147− -> Query db params '[alias ::: ty] -- ^ subquery

1148− -> Expression db params grp from (nullity 'PGbool)

1149−neqAll = unsafeSubqueryExpression "<> ALL"

1150−

1151−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1152−-- >>> printSQL $ myRow `rowNeqAll` values_ myRow

1153−-- ROW(1, FALSE) <> ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1154−rowNeqAll

1155− :: SListI row

1156− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1157− -> Query db params row -- ^ subquery

1158− -> Expression db params grp from (nullity 'PGbool)

1159−rowNeqAll = unsafeRowSubqueryExpression "<> ALL"

1160−

1161−-- | >>> printSQL $ true `neqAny` values_ (true `as` #foo)

1162−-- TRUE <> ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1163−neqAny

1164− :: Expression db params grp from ty -- ^ expression

1165− -> Query db params '[alias ::: ty] -- ^ subquery

1166− -> Expression db params grp from (nullity 'PGbool)

1167−neqAny = unsafeSubqueryExpression "<> ANY"

1168−

1169−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1170−-- >>> printSQL $ myRow `rowNeqAny` values_ myRow

1171−-- ROW(1, FALSE) <> ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1172−rowNeqAny

1173− :: SListI row

1174− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1175− -> Query db params row -- ^ subquery

1176− -> Expression db params grp from (nullity 'PGbool)

1177−rowNeqAny = unsafeRowSubqueryExpression "<> ANY"

1178−

1179−-- | >>> printSQL $ true `allLt` values_ (true `as` #foo)

1180−-- TRUE ALL < (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1181−allLt

1182− :: Expression db params grp from ty -- ^ expression

1183− -> Query db params '[alias ::: ty] -- ^ subquery

1184− -> Expression db params grp from (nullity 'PGbool)

1185−allLt = unsafeSubqueryExpression "ALL <"

1186−

1187−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1188−-- >>> printSQL $ myRow `rowLtAll` values_ myRow

1189−-- ROW(1, FALSE) ALL < (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1190−rowLtAll

1191− :: SListI row

1192− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1193− -> Query db params row -- ^ subquery

1194− -> Expression db params grp from (nullity 'PGbool)

1195−rowLtAll = unsafeRowSubqueryExpression "ALL <"

1196−

1197−-- | >>> printSQL $ true `ltAny` values_ (true `as` #foo)

1198−-- TRUE ANY < (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1199−ltAny

1200− :: Expression db params grp from ty -- ^ expression

1201− -> Query db params '[alias ::: ty] -- ^ subquery

1202− -> Expression db params grp from (nullity 'PGbool)

1203−ltAny = unsafeSubqueryExpression "ANY <"

1204−

1205−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1206−-- >>> printSQL $ myRow `rowLtAll` values_ myRow

1207−-- ROW(1, FALSE) ALL < (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1208−rowLtAny

1209− :: SListI row

1210− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1211− -> Query db params row -- ^ subquery

1212− -> Expression db params grp from (nullity 'PGbool)

1213−rowLtAny = unsafeRowSubqueryExpression "ANY <"

1214−

1215−-- | >>> printSQL $ true `lteAll` values_ (true `as` #foo)

1216−-- TRUE <= ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1217−lteAll

1218− :: Expression db params grp from ty -- ^ expression

1219− -> Query db params '[alias ::: ty] -- ^ subquery

1220− -> Expression db params grp from (nullity 'PGbool)

1221−lteAll = unsafeSubqueryExpression "<= ALL"

1222−

1223−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1224−-- >>> printSQL $ myRow `rowLteAll` values_ myRow

1225−-- ROW(1, FALSE) <= ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1226−rowLteAll

1227− :: SListI row

1228− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1229− -> Query db params row -- ^ subquery

1230− -> Expression db params grp from (nullity 'PGbool)

1231−rowLteAll = unsafeRowSubqueryExpression "<= ALL"

1232−

1233−-- | >>> printSQL $ true `lteAny` values_ (true `as` #foo)

1234−-- TRUE <= ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1235−lteAny

1236− :: Expression db params grp from ty -- ^ expression

1237− -> Query db params '[alias ::: ty] -- ^ subquery

1238− -> Expression db params grp from (nullity 'PGbool)

1239−lteAny = unsafeSubqueryExpression "<= ANY"

1240−

1241−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1242−-- >>> printSQL $ myRow `rowLteAny` values_ myRow

1243−-- ROW(1, FALSE) <= ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1244−rowLteAny

1245− :: SListI row

1246− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1247− -> Query db params row -- ^ subquery

1248− -> Expression db params grp from (nullity 'PGbool)

1249−rowLteAny = unsafeRowSubqueryExpression "<= ANY"

1250−

1251−-- | >>> printSQL $ true `gtAll` values_ (true `as` #foo)

1252−-- TRUE > ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1253−gtAll

1254− :: Expression db params grp from ty -- ^ expression

1255− -> Query db params '[alias ::: ty] -- ^ subquery

1256− -> Expression db params grp from (nullity 'PGbool)

1257−gtAll = unsafeSubqueryExpression "> ALL"

1258−

1259−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1260−-- >>> printSQL $ myRow `rowGtAll` values_ myRow

1261−-- ROW(1, FALSE) > ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1262−rowGtAll

1263− :: SListI row

1264− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1265− -> Query db params row -- ^ subquery

1266− -> Expression db params grp from (nullity 'PGbool)

1267−rowGtAll = unsafeRowSubqueryExpression "> ALL"

1268−

1269−-- | >>> printSQL $ true `gtAny` values_ (true `as` #foo)

1270−-- TRUE > ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1271−gtAny

1272− :: Expression db params grp from ty -- ^ expression

1273− -> Query db params '[alias ::: ty] -- ^ subquery

1274− -> Expression db params grp from (nullity 'PGbool)

1275−gtAny = unsafeSubqueryExpression "> ANY"

1276−

1277−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1278−-- >>> printSQL $ myRow `rowGtAny` values_ myRow

1279−-- ROW(1, FALSE) > ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1280−rowGtAny

1281− :: SListI row

1282− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1283− -> Query db params row -- ^ subquery

1284− -> Expression db params grp from (nullity 'PGbool)

1285−rowGtAny = unsafeRowSubqueryExpression "> ANY"

1286−

1287−-- | >>> printSQL $ true `gteAll` values_ (true `as` #foo)

1288−-- TRUE >= ALL (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1289−gteAll

1290− :: Expression db params grp from ty -- ^ expression

1291− -> Query db params '[alias ::: ty] -- ^ subquery

1292− -> Expression db params grp from (nullity 'PGbool)

1293−gteAll = unsafeSubqueryExpression ">= ALL"

1294−

1295−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1296−-- >>> printSQL $ myRow `rowGteAll` values_ myRow

1297−-- ROW(1, FALSE) >= ALL (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1298−rowGteAll

1299− :: SListI row

1300− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1301− -> Query db params row -- ^ subquery

1302− -> Expression db params grp from (nullity 'PGbool)

1303−rowGteAll = unsafeRowSubqueryExpression ">= ALL"

1304−

1305−-- | >>> printSQL $ true `gteAny` values_ (true `as` #foo)

1306−-- TRUE >= ANY (SELECT * FROM (VALUES (TRUE)) AS t ("foo"))

1307−gteAny

1308− :: Expression db params grp from ty -- ^ expression

1309− -> Query db params '[alias ::: ty] -- ^ subquery

1310− -> Expression db params grp from (nullity 'PGbool)

1311−gteAny = unsafeSubqueryExpression ">= ANY"

1312−

1313−-- | >>> let myRow = 1 `as` #foo :* false `as` #bar :: NP (Aliased (Expression db params grp from)) '["foo" ::: 'NotNull 'PGint2, "bar" ::: 'NotNull 'PGbool]

1314−-- >>> printSQL $ myRow `rowGteAny` values_ myRow

1315−-- ROW(1, FALSE) >= ANY (SELECT * FROM (VALUES (1, FALSE)) AS t ("foo", "bar"))

1316−rowGteAny

1317− :: SListI row

1318− => NP (Aliased (Expression db params grp from)) row -- ^ row constructor

1319− -> Query db params row -- ^ subquery

1320− -> Expression db params grp from (nullity 'PGbool)

1321−rowGteAny = unsafeRowSubqueryExpression ">= ANY"

1322

1030

1323-- | A `CommonTableExpression` is an auxiliary statement in a `with` clause.

1031-- | A `CommonTableExpression` is an auxiliary statement in a `with` clause.

1324data CommonTableExpression statement

1032data CommonTableExpression statement

1033+ (schemas :: SchemasType)

1325 (params :: [NullityType])

1034 (params :: [NullityType])

1326− (db0 :: DBType)

1035+ (commons0 :: FromType)

1327− (db1 :: DBType) where

1036+ (commons1 :: FromType) where

1328 CommonTableExpression

1037 CommonTableExpression

1329− :: Aliased (statement (commons :=> schemas) params) (cte ::: common)

1038+ :: Aliased (statement commons schemas params) (cte ::: common)

1330− -> CommonTableExpression statement params

1039+ -> CommonTableExpression statement schemas params commons (cte ::: common ': commons)

1331− (commons :=> schemas) ((cte ::: common ': commons) :=> schemas)

1332instance

1040instance

1333 ( KnownSymbol cte

1041 ( KnownSymbol cte

1334− , db0 ~ (commons :=> schemas)

1042+ , commons1 ~ (cte ::: common ': commons)

1335− , db1 ~ ((cte ::: common ': commons) :=> schemas)

1336 ) => Aliasable cte

1043 ) => Aliasable cte

1337− (statement db0 params common)

1044+ (statement commons schemas params common)

1338− (CommonTableExpression statement params db0 db1) where

1045+ (CommonTableExpression statement schemas params commons commons1) where

1339 statement `as` cte = CommonTableExpression (statement `as` cte)

1046 statement `as` cte = CommonTableExpression (statement `as` cte)

1340instance

1047instance

1341 ( KnownSymbol cte

1048 ( KnownSymbol cte

1342− , db0 ~ (commons :=> schemas)

1049+ , commons1 ~ (cte ::: common ': commons)

1343− , db1 ~ ((cte ::: common ': commons) :=> schemas)

1344 ) => Aliasable cte

1050 ) => Aliasable cte

1345− (statement db0 params common)

1051+ (statement commons schemas params common)

1346− (AlignedList (CommonTableExpression statement params) db0 db1) where

1052+ (Path (CommonTableExpression statement schemas params) commons commons1) where

1347− statement `as` cte = single (statement `as` cte)

1053+ statement `as` cte = csingleton (statement `as` cte)

1348−

1054+

1349−-- | render a `CommonTableExpression`.

1055+instance (forall c s p r. RenderSQL (statement c s p r)) => RenderSQL

1350−renderCommonTableExpression

1056+ (CommonTableExpression statement schemas params commons0 commons1) where

1351− :: (forall db ps row. statement db ps row -> ByteString) -- ^ render statement

1057+ renderSQL (CommonTableExpression (statement `As` cte)) =

1352− -> CommonTableExpression statement params db0 db1 -> ByteString

1058+ renderSQL cte <+> "AS" <+> parenthesized (renderSQL statement)

1353−renderCommonTableExpression renderStatement

1354− (CommonTableExpression (statement `As` alias)) =

1355− renderAlias alias <+> "AS" <+> parenthesized (renderStatement statement)

1356−

1357−-- | render a non-empty `AlignedList` of `CommonTableExpression`s.

1358−renderCommonTableExpressions

1359− :: (forall db ps row. statement db ps row -> ByteString) -- ^ render statement

1360− -> CommonTableExpression statement params db0 db1

1361− -> AlignedList (CommonTableExpression statement params) db1 db2

1362− -> ByteString

1363−renderCommonTableExpressions renderStatement cte ctes =

1364− renderCommonTableExpression renderStatement cte <> case ctes of

1365− Done -> ""

1366− cte' :>> ctes' -> "," <+>

1367− renderCommonTableExpressions renderStatement cte' ctes'

1368

1059

1369-- | `with` provides a way to write auxiliary statements for use in a larger query.

1060-- | `with` provides a way to write auxiliary statements for use in a larger query.

1370-- These statements, referred to as `CommonTableExpression`s, can be thought of as

1061-- These statements, referred to as `CommonTableExpression`s, can be thought of as

1371-- defining temporary tables that exist just for one query.

1062-- defining temporary tables that exist just for one query.

1372class With statement where

1063class With statement where

1373 with

1064 with

1374− :: AlignedList (CommonTableExpression statement params) db0 db1

1065+ :: Path (CommonTableExpression statement schemas params) commons0 commons1

1375 -- ^ common table expressions

1066 -- ^ common table expressions

1376− -> statement db1 params row

1067+ -> statement commons1 schemas params row

1377 -- ^ larger query

1068 -- ^ larger query

1378− -> statement db0 params row

1069+ -> statement commons0 schemas params row

1379−instance With Query where

1070+instance With (Query outer) where

1380 with Done query = query

1071 with Done query = query

1381− with (cte :>> ctes) query = UnsafeQuery $

1072+ with ctes query = UnsafeQuery $

1382− "WITH" <+> renderCommonTableExpressions renderQuery cte ctes

1073+ "WITH" <+> commaSeparated (ctoList renderSQL ctes) <+> renderSQL query

1383− <+> renderQuery query

1074+

1075+{- |

1076+>>> import Data.Monoid (Sum (..))

1077+>>> import Data.Int (Int64)

1078+>>> :{

1079+ let

1080+ query :: Query_ schema () (Sum Int64)

1081+ query = withRecursive

1082+ ( values_ ((1 & astype int) `as` #n)

1083+ `unionAll`

1084+ select_ ((#n + 1) `as` #n)

1085+ (from (common #t) & where_ (#n .< 100)) `as` #t )

1086+ ( select_ (fromNull 0 (sum_ (All #n)) `as` #getSum) (from (common #t) & groupBy Nil))

1087+ in printSQL query

1088+:}

1089+WITH RECURSIVE "t" AS ((SELECT * FROM (VALUES ((1 :: int))) AS t ("n")) UNION ALL (SELECT ("n" + 1) AS "n" FROM "t" AS "t" WHERE ("n" < 100))) SELECT COALESCE(sum(ALL "n"), 0) AS "getSum" FROM "t" AS "t"

1090+-}

1091+withRecursive

1092+ :: Aliased (Query outer (recursive ': commons) schemas params) recursive

1093+ -> Query outer (recursive ': commons) schemas params row

1094+ -> Query outer commons schemas params row

1095+withRecursive (recursive `As` cte) query = UnsafeQuery $

1096+ "WITH RECURSIVE" <+> renderSQL cte

1097+ <+> "AS" <+> parenthesized (renderSQL recursive)

1098+ <+> renderSQL query

squeal-postgresql/src/Squeal/PostgreSQL/Render.hs+47−13

@@ -10,40 +10,47 @@ Rendering helper functions.

11{-# LANGUAGE

12 AllowAmbiguousTypes

13+ , ConstraintKinds

13 , FlexibleContexts

14 , FlexibleContexts

15+ , LambdaCase

14 , MagicHash

16 , MagicHash

15 , OverloadedStrings

17 , OverloadedStrings

16 , PolyKinds

18 , PolyKinds

17 , RankNTypes

19 , RankNTypes

18 , ScopedTypeVariables

20 , ScopedTypeVariables

21+ , TypeApplications

19#-}

22#-}

21module Squeal.PostgreSQL.Render

24module Squeal.PostgreSQL.Render

22 ( -- * Render

25 ( -- * Render

23− parenthesized

26+ RenderSQL (..)

27+ , printSQL

28+ , escape

29+ , parenthesized

30+ , bracketed

24 , (<+>)

31 , (<+>)

25 , commaSeparated

32 , commaSeparated

26 , doubleQuoted

33 , doubleQuoted

27 , singleQuotedText

34 , singleQuotedText

28 , singleQuotedUtf8

35 , singleQuotedUtf8

29 , renderCommaSeparated

36 , renderCommaSeparated

37+ , renderCommaSeparatedConstraint

30 , renderCommaSeparatedMaybe

38 , renderCommaSeparatedMaybe

31 , renderNat

39 , renderNat

32 , renderSymbol

40 , renderSymbol

33− , RenderSQL (..)

34− , printSQL

35 ) where

41 ) where

37−import Control.Monad.Base

43+import Control.Monad.IO.Class (MonadIO (..))

38import Data.ByteString (ByteString)

44import Data.ByteString (ByteString)

39import Data.Maybe (catMaybes)

45import Data.Maybe (catMaybes)

40import Data.Monoid ((<>))

46import Data.Monoid ((<>))

41import Data.Text (Text)

47import Data.Text (Text)

42import Generics.SOP

48import Generics.SOP

43import GHC.Exts

49import GHC.Exts

44−import GHC.TypeLits

50+import GHC.TypeLits hiding (Text)

45−import qualified Data.Text as T

51+

46−import qualified Data.Text.Encoding as T

52+import qualified Data.Text as Text

53+import qualified Data.Text.Encoding as Text

47import qualified Data.ByteString as ByteString

54import qualified Data.ByteString as ByteString

48import qualified Data.ByteString.Char8 as Char8

55import qualified Data.ByteString.Char8 as Char8

@@ -51,6 +58,10 @@ import qualified Data.ByteString.Char8 as Char8

51parenthesized :: ByteString -> ByteString

58parenthesized :: ByteString -> ByteString

52parenthesized str = "(" <> str <> ")"

59parenthesized str = "(" <> str <> ")"

61+-- | Square bracket a `ByteString`

62+bracketed :: ByteString -> ByteString

63+bracketed str = "[" <> str <> "]"

64+

54-- | Concatenate two `ByteString`s with a space between.

65-- | Concatenate two `ByteString`s with a space between.

55(<+>) :: ByteString -> ByteString -> ByteString

66(<+>) :: ByteString -> ByteString -> ByteString

56infixr 7 <+>

67infixr 7 <+>

@@ -66,11 +77,12 @@ doubleQuoted str = "\"" <> str <> "\""

67-- | Add single quotes around a `Text` and escape single quotes within it.

78-- | Add single quotes around a `Text` and escape single quotes within it.

68singleQuotedText :: Text -> ByteString

79singleQuotedText :: Text -> ByteString

69−singleQuotedText str = "'" <> T.encodeUtf8 (T.replace "'" "''" str) <> "'"

80+singleQuotedText str =

81+ "'" <> Text.encodeUtf8 (Text.replace "'" "''" str) <> "'"

71-- | Add single quotes around a `ByteString` and escape single quotes within it.

83-- | Add single quotes around a `ByteString` and escape single quotes within it.

72singleQuotedUtf8 :: ByteString -> ByteString

84singleQuotedUtf8 :: ByteString -> ByteString

73−singleQuotedUtf8 = singleQuotedText . T.decodeUtf8

85+singleQuotedUtf8 = singleQuotedText . Text.decodeUtf8

75-- | Comma separate the renderings of a heterogeneous list.

87-- | Comma separate the renderings of a heterogeneous list.

76renderCommaSeparated

88renderCommaSeparated

@@ -82,6 +94,16 @@ renderCommaSeparated render

82 . hcollapse

94 . hcollapse

83 . hmap (K . render)

95 . hmap (K . render)

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+

85-- | Comma separate the `Maybe` renderings of a heterogeneous list, dropping

107-- | Comma separate the `Maybe` renderings of a heterogeneous list, dropping

86-- `Nothing`s.

108-- `Nothing`s.

87renderCommaSeparatedMaybe

109renderCommaSeparatedMaybe

@@ -103,9 +125,21 @@ renderSymbol :: forall s. KnownSymbol s => ByteString

103renderSymbol = fromString (symbolVal' (proxy# :: Proxy# s))

125renderSymbol = fromString (symbolVal' (proxy# :: Proxy# s))

104

126

105-- | A class for rendering SQL

127-- | A class for rendering SQL

106−class RenderSQL sql where

128+class RenderSQL sql where renderSQL :: sql -> ByteString

107− renderSQL :: sql -> ByteString

108

129

109-- | Print SQL.

130-- | Print SQL.

110−printSQL :: (RenderSQL sql, MonadBase IO io) => sql -> io ()

131+printSQL :: (RenderSQL sql, MonadIO io) => sql -> io ()

111−printSQL = liftBase . Char8.putStrLn . renderSQL

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]

squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+215−561

@@ -1,16 +1,15 @@

1{-|

2Module: Squeal.PostgreSQL.Schema

3Description: Embedding of PostgreSQL type and alias system

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

8−This module provides a type-level DSL for kinds of Postgres types,

8+`Squeal.PostgreSQL.Schema` provides a type-level DSL for kinds of Postgres types,

9tables, schema, constraints, aliases, enumerated labels, and groupings.

10It also defines useful type families to operate on these. Finally,

11it defines an embedding of Haskell types into Postgres types.

12-}

13−{-# OPTIONS_GHC -fno-warn-unticked-promoted-constructors #-}

14{-# LANGUAGE

13{-# LANGUAGE

15 AllowAmbiguousTypes

14 AllowAmbiguousTypes

16 , ConstraintKinds

15 , ConstraintKinds

@@ -22,6 +21,7 @@ it defines an embedding of Haskell types into Postgres types.

22 , GADTs

21 , GADTs

23 , LambdaCase

22 , LambdaCase

24 , OverloadedStrings

23 , OverloadedStrings

24+ , QuantifiedConstraints

25 , RankNTypes

26 , ScopedTypeVariables

27 , StandaloneDeriving

@@ -39,83 +39,48 @@ module Squeal.PostgreSQL.Schema

39 , NullityType (..)

40 , RowType

41 , FromType

42− -- * Haskell to Postgres Types

43− , PG

44− , NullPG

45− , TuplePG

46− , RowPG

47− , Json (..)

48− , Jsonb (..)

49− , Composite (..)

50− , Enumerated (..)

51 -- * Schema Types

42 -- * Schema Types

52 , ColumnType

43 , ColumnType

53 , ColumnsType

44 , ColumnsType

54 , TableType

45 , TableType

55 , SchemumType (..)

46 , SchemumType (..)

47+ , IndexType (..)

48+ , FunctionType

49+ , OperatorType (..)

50+ , ReturnsType (..)

56 , SchemaType

51 , SchemaType

57 , SchemasType

52 , SchemasType

58 , Public

53 , Public

59− , DBType

60− , DBof

61 -- * Constraints

54 -- * Constraints

62 , (:=>)

55 , (:=>)

63 , ColumnConstraint (..)

56 , ColumnConstraint (..)

64 , TableConstraint (..)

57 , TableConstraint (..)

65 , TableConstraints

58 , TableConstraints

66 , Uniquely

59 , Uniquely

67− -- * Aliases

68− , (:::)

69− , Alias (..)

70− , IsLabel (..)

71− , renderAlias

72− , renderAliasString

73− , renderAliases

74− , Aliased (As)

75− , Aliasable (as)

76− , renderAliasedAs

77− , Has

78− , HasUnique

79− , HasAll

80− , QualifiedAlias (..)

81− , IsQualified (..)

82− , HasIn

83− , IsNotElem

84− , AllUnique

85− , DefaultAliasable (..)

86− , renderQualifiedAlias

87 -- * Enumerated Labels

60 -- * Enumerated Labels

88 , IsPGlabel (..)

61 , IsPGlabel (..)

89 , PGlabel (..)

62 , PGlabel (..)

90− , renderLabel

91− , renderLabels

92− , LabelsPG

93− -- * Grouping

94− , Grouping (..)

95− , GroupedBy

96− -- * Aligned lists

97− , AlignedList (..)

98− , single

99 -- * Data Definitions

63 -- * Data Definitions

100 , Create

64 , Create

65+ , CreateIfNotExists

66+ , CreateOrReplace

101 , Drop

67 , Drop

68+ , DropSchemum

69+ , DropIfExists

70+ , DropSchemumIfExists

102 , Alter

71 , Alter

72+ , AlterIfExists

103 , Rename

73 , Rename

74+ , RenameIfExists

75+ , ConstraintInvolves

104 , DropIfConstraintsInvolve

76 , DropIfConstraintsInvolve

105− -- * Lists

77+ , IsNotElem

106− , Join

78+ , AllUnique

107− , Elem

108− , In

109− , Length

110 -- * Type Classifications

79 -- * Type Classifications

111− , HasOid (..)

112 , PGNum

80 , PGNum

113 , PGIntegral

81 , PGIntegral

114 , PGFloating

82 , PGFloating

115 , PGTypeOf

83 , PGTypeOf

116− , PGArrayOf

117− , PGArray

118− , PGTextArray

119 , PGJsonType

84 , PGJsonType

120 , PGJsonKey

85 , PGJsonKey

121 , SamePGType

86 , SamePGType

@@ -132,37 +97,22 @@ module Squeal.PostgreSQL.Schema

132 ) where

97 ) where

133

134import Control.Category

99import Control.Category

135−import Control.DeepSeq

136−import Data.Aeson (Value)

137−import Data.ByteString (ByteString)

138−import Data.Int (Int16, Int32, Int64)

139import Data.Kind

100import Data.Kind

140import Data.Monoid hiding (All)

101import Data.Monoid hiding (All)

141−import Data.Scientific (Scientific)

142−import Data.String

143−import Data.Text (Text)

144−import Data.Time

145−import Data.Word (Word16, Word32, Word64)

146import Data.Type.Bool

102import Data.Type.Bool

147−import Data.UUID.Types (UUID)

148−import Data.Vector (Vector)

149import Generics.SOP

103import Generics.SOP

150−import Generics.SOP.Record

151−import GHC.OverloadedLabels

152import GHC.TypeLits

104import GHC.TypeLits

153−import Network.IP.Addr

154import Prelude hiding (id, (.))

105import Prelude hiding (id, (.))

155

106

156−import qualified Data.ByteString.Lazy as Lazy

107+import Squeal.PostgreSQL.Alias

157−import qualified Data.Text.Lazy as Lazy

108+import Squeal.PostgreSQL.List

158−import qualified GHC.Generics as GHC

159−import qualified Generics.SOP.Type.Metadata as Type

160−

161import Squeal.PostgreSQL.Render

109import Squeal.PostgreSQL.Render

162

110

111+-- $setup

112+-- >>> import Squeal.PostgreSQL

113+

163-- | `PGType` is the promoted datakind of PostgreSQL types.

114-- | `PGType` is the promoted datakind of PostgreSQL types.

164--

115--

165−-- >>> import Squeal.PostgreSQL.Schema

166-- >>> :kind 'PGbool

116-- >>> :kind 'PGbool

167-- 'PGbool :: PGType

117-- 'PGbool :: PGType

168data PGType

118data PGType

@@ -173,6 +123,7 @@ data PGType

173 | PGnumeric -- ^ arbitrary precision numeric type

123 | PGnumeric -- ^ arbitrary precision numeric type

174 | PGfloat4 -- ^ single precision floating-point number (4 bytes)

124 | PGfloat4 -- ^ single precision floating-point number (4 bytes)

175 | PGfloat8 -- ^ double precision floating-point number (8 bytes)

125 | PGfloat8 -- ^ double precision floating-point number (8 bytes)

126+ | PGmoney -- ^ currency amount

176 | PGchar Nat -- ^ fixed-length character string

127 | PGchar Nat -- ^ fixed-length character string

177 | PGvarchar Nat -- ^ variable-length character string

128 | PGvarchar Nat -- ^ variable-length character string

178 | PGtext -- ^ variable-length character string

129 | PGtext -- ^ variable-length character string

@@ -188,39 +139,15 @@ data PGType

188 | PGjson -- ^ textual JSON data

139 | PGjson -- ^ textual JSON data

189 | PGjsonb -- ^ binary JSON data, decomposed

140 | PGjsonb -- ^ binary JSON data, decomposed

190 | PGvararray NullityType -- ^ variable length array

141 | PGvararray NullityType -- ^ variable length array

191− | PGfixarray Nat NullityType -- ^ fixed length array

142+ | PGfixarray [Nat] NullityType -- ^ fixed length array

192 | PGenum [Symbol] -- ^ enumerated (enum) types are data types that comprise a static, ordered set of values.

143 | PGenum [Symbol] -- ^ enumerated (enum) types are data types that comprise a static, ordered set of values.

193 | PGcomposite RowType -- ^ a composite type represents the structure of a row or record; it is essentially just a list of field names and their data types.

144 | PGcomposite RowType -- ^ a composite type represents the structure of a row or record; it is essentially just a list of field names and their data types.

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).

194 | UnsafePGType Symbol -- ^ an escape hatch for unsupported PostgreSQL types

149 | UnsafePGType Symbol -- ^ an escape hatch for unsupported PostgreSQL types

195

150

196−-- | The object identifier of a `PGType`.

197−--

198−-- >>> :set -XTypeApplications

199−-- >>> oid @'PGbool

200−-- 16

201−class HasOid (ty :: PGType) where oid :: Word32

202−instance HasOid 'PGbool where oid = 16

203−instance HasOid 'PGint2 where oid = 21

204−instance HasOid 'PGint4 where oid = 23

205−instance HasOid 'PGint8 where oid = 20

206−instance HasOid 'PGnumeric where oid = 1700

207−instance HasOid 'PGfloat4 where oid = 700

208−instance HasOid 'PGfloat8 where oid = 701

209−instance HasOid ('PGchar n) where oid = 18

210−instance HasOid ('PGvarchar n) where oid = 1043

211−instance HasOid 'PGtext where oid = 25

212−instance HasOid 'PGbytea where oid = 17

213−instance HasOid 'PGtimestamp where oid = 1114

214−instance HasOid 'PGtimestamptz where oid = 1184

215−instance HasOid 'PGdate where oid = 1082

216−instance HasOid 'PGtime where oid = 1083

217−instance HasOid 'PGtimetz where oid = 1266

218−instance HasOid 'PGinterval where oid = 1186

219−instance HasOid 'PGuuid where oid = 2950

220−instance HasOid 'PGinet where oid = 869

221−instance HasOid 'PGjson where oid = 114

222−instance HasOid 'PGjsonb where oid = 3802

223−

224-- | `NullityType` encodes the potential presence or definite absence of a

151-- | `NullityType` encodes the potential presence or definite absence of a

225-- @NULL@ allowing operations which are sensitive to such to be well typed.

152-- @NULL@ allowing operations which are sensitive to such to be well typed.

226--

153--

@@ -239,11 +166,6 @@ data NullityType

239type (:=>) constraint ty = '(constraint,ty)

166type (:=>) constraint ty = '(constraint,ty)

240infixr 7 :=>

167infixr 7 :=>

241

168

242−-- | The alias operator `:::` is like a promoted version of `As`,

243−-- a type level pair between an alias and some type.

244−type (:::) (alias :: Symbol) ty = '(alias,ty)

245−infixr 6 :::

246−

247-- | `ColumnConstraint` encodes the availability of @DEFAULT@ for inserts and updates.

169-- | `ColumnConstraint` encodes the availability of @DEFAULT@ for inserts and updates.

248-- A column can be assigned a default value.

170-- A column can be assigned a default value.

249-- A data `Squeal.PostgreSQL.Manipulations.Manipulation` command can also

171-- A data `Squeal.PostgreSQL.Manipulations.Manipulation` command can also

@@ -285,7 +207,13 @@ data TableConstraint

285 | PrimaryKey [Symbol]

207 | PrimaryKey [Symbol]

286 | ForeignKey [Symbol] Symbol [Symbol]

208 | ForeignKey [Symbol] Symbol [Symbol]

287

209

288−-- | A `TableConstraints` is a row of `TableConstraint`s.

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+-}

289type TableConstraints = [(Symbol,TableConstraint)]

217type TableConstraints = [(Symbol,TableConstraint)]

290

218

291-- | A `ForeignKey` must reference columns that either are

219-- | A `ForeignKey` must reference columns that either are

@@ -311,7 +239,7 @@ type family Uniquely

311type TableType = (TableConstraints,ColumnsType)

239type TableType = (TableConstraints,ColumnsType)

312

240

313{- | A `RowType` is a row of `NullityType`. They correspond to Haskell

241{- | A `RowType` is a row of `NullityType`. They correspond to Haskell

314−record types by means of `RowPG` and are used in many places.

242+record types by means of `Squeal.PostgreSQL.Binary.RowPG` and are used in many places.

315

243

316>>> :{

244>>> :{

317type family PersonRow :: RowType where

245type family PersonRow :: RowType where

@@ -332,9 +260,19 @@ type FromType = [(Symbol,RowType)]

332

260

333-- | `ColumnsToRow` removes column constraints.

261-- | `ColumnsToRow` removes column constraints.

334type family ColumnsToRow (columns :: ColumnsType) :: RowType where

262type family ColumnsToRow (columns :: ColumnsType) :: RowType where

335− ColumnsToRow '[] = '[]

263+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': column4 ::: _ :=> ty4 ': column5 ::: _ :=> ty5 ': columns) =

336− ColumnsToRow (column ::: constraint :=> ty ': columns) =

264+ column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': column5 ::: ty5 ': ColumnsToRow columns

265+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': column4 ::: _ :=> ty4 ': columns) =

266+ column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': ColumnsToRow columns

267+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': columns) =

268+ column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': ColumnsToRow columns

269+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': columns) =

270+ column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': ColumnsToRow columns

271+ ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': columns) =

272+ column ::: ty ': column1 ::: ty1 ': ColumnsToRow columns

273+ ColumnsToRow (column ::: _ :=> ty ': columns) =

337 column ::: ty ': ColumnsToRow columns

274 column ::: ty ': ColumnsToRow columns

275+ ColumnsToRow '[] = '[]

338

276

339-- | `TableToColumns` removes table constraints.

277-- | `TableToColumns` removes table constraints.

340type family TableToColumns (table :: TableType) :: ColumnsType where

278type family TableToColumns (table :: TableType) :: ColumnsType where

@@ -344,195 +282,6 @@ type family TableToColumns (table :: TableType) :: ColumnsType where

344type family TableToRow (table :: TableType) :: RowType where

282type family TableToRow (table :: TableType) :: RowType where

345 TableToRow tab = ColumnsToRow (TableToColumns tab)

283 TableToRow tab = ColumnsToRow (TableToColumns tab)

346

284

347−-- | `Grouping` is an auxiliary namespace, created by

348−-- @GROUP BY@ clauses (`Squeal.PostgreSQL.Query.group`), and used

349−-- for typesafe aggregation

350−data Grouping

351− = Ungrouped -- ^ no aggregation permitted

352− | Grouped [(Symbol,Symbol)] -- ^ aggregation required for any column which is not grouped

353−

354−{- | A `GroupedBy` constraint indicates that a table qualified column is

355−a member of the auxiliary namespace created by @GROUP BY@ clauses and thus,

356−may be called in an output `Squeal.PostgreSQL.Expression.Expression` without aggregating.

357−-}

358−class (KnownSymbol table, KnownSymbol column)

359− => GroupedBy table column bys where

360−instance {-# OVERLAPPING #-} (KnownSymbol table, KnownSymbol column)

361− => GroupedBy table column ('(table,column) ': bys)

362−instance {-# OVERLAPPABLE #-}

363− ( KnownSymbol table

364− , KnownSymbol column

365− , GroupedBy table column bys

366− ) => GroupedBy table column (tabcol ': bys)

367−

368−-- | `Alias`es are proxies for a type level string or `Symbol`

369−-- and have an `IsLabel` instance so that with @-XOverloadedLabels@

370−--

371−-- >>> :set -XOverloadedLabels

372−-- >>> #foobar :: Alias "foobar"

373−-- Alias

374−data Alias (alias :: Symbol) = Alias

375− deriving (Eq,GHC.Generic,Ord,Show,NFData)

376−instance alias1 ~ alias2 => IsLabel alias1 (Alias alias2) where

377− fromLabel = Alias

378−instance aliases ~ '[alias] => IsLabel alias (NP Alias aliases) where

379− fromLabel = fromLabel :* Nil

380−instance KnownSymbol alias => RenderSQL (Alias alias) where renderSQL = renderAlias

381−

382−-- | >>> renderAlias #jimbob

383−-- "\"jimbob\""

384−renderAlias :: KnownSymbol alias => Alias alias -> ByteString

385−renderAlias = doubleQuoted . fromString . symbolVal

386−

387−-- | >>> renderAliasString #ohmahgerd

388−-- "'ohmahgerd'"

389−renderAliasString :: KnownSymbol alias => Alias alias -> ByteString

390−renderAliasString = singleQuotedText . fromString . symbolVal

391−

392−-- | >>> import Generics.SOP (NP(..))

393−-- >>> renderAliases (#jimbob :* #kandi)

394−-- ["\"jimbob\"","\"kandi\""]

395−renderAliases

396− :: All KnownSymbol aliases => NP Alias aliases -> [ByteString]

397−renderAliases = hcollapse

398− . hcmap (Proxy @KnownSymbol) (K . renderAlias)

399−

400−-- | The `As` operator is used to name an expression. `As` is like a demoted

401−-- version of `:::`.

402−--

403−-- >>> Just "hello" `As` #hi :: Aliased Maybe ("hi" ::: String)

404−-- As (Just "hello") Alias

405−data Aliased expression aliased where

406− As

407− :: KnownSymbol alias

408− => expression ty

409− -> Alias alias

410− -> Aliased expression (alias ::: ty)

411−deriving instance Show (expression ty)

412− => Show (Aliased expression (alias ::: ty))

413−deriving instance Eq (expression ty)

414− => Eq (Aliased expression (alias ::: ty))

415−deriving instance Ord (expression ty)

416− => Ord (Aliased expression (alias ::: ty))

417−instance (alias0 ~ alias1, alias0 ~ alias2, KnownSymbol alias2)

418− => IsLabel alias0 (Aliased Alias (alias1 ::: alias2)) where

419− fromLabel = fromLabel @alias2 `As` fromLabel @alias1

420−

421−-- | The `Aliasable` class provides a way to scrap your `Nil`s

422−-- in an `NP` list of `Aliased` expressions.

423−class KnownSymbol alias => Aliasable alias expression aliased

424− | aliased -> expression

425− , aliased -> alias

426− where as :: expression -> Alias alias -> aliased

427−instance (KnownSymbol alias, aliased ~ (alias ::: ty)) => Aliasable alias

428− (expression ty)

429− (Aliased expression aliased)

430− where

431− as = As

432−instance (KnownSymbol alias, tys ~ '[alias ::: ty]) => Aliasable alias

433− (expression ty)

434− (NP (Aliased expression) tys)

435− where

436− expression `as` alias = expression `As` alias :* Nil

437−

438−-- | >>> let renderMaybe = fromString . maybe "Nothing" (const "Just")

439−-- >>> renderAliasedAs renderMaybe (Just (3::Int) `As` #an_int)

440−-- "Just AS \"an_int\""

441−renderAliasedAs

442− :: (forall ty. expression ty -> ByteString)

443− -> Aliased expression aliased

444− -> ByteString

445−renderAliasedAs render (expression `As` alias) =

446− render expression <> " AS " <> renderAlias alias

447−

448−-- | @HasUnique alias fields field@ is a constraint that proves that

449−-- @fields@ is a singleton of @alias ::: field@.

450−type HasUnique alias fields field = fields ~ '[alias ::: field]

451−

452−-- | @Has alias fields field@ is a constraint that proves that

453−-- @fields@ has a field of @alias ::: field@, inferring @field@

454−-- from @alias@ and @fields@.

455−class KnownSymbol alias =>

456− Has (alias :: Symbol) (fields :: [(Symbol,kind)]) (field :: kind)

457− | alias fields -> field where

458−instance {-# OVERLAPPING #-} KnownSymbol alias

459− => Has alias (alias ::: field ': fields) field

460−instance {-# OVERLAPPABLE #-} (KnownSymbol alias, Has alias fields field)

461− => Has alias (field' ': fields) field

462−

463−class HasIn fields (x :: (Symbol, a)) where

464−instance (Has alias fields field) => HasIn fields '(alias, field) where

465−

466−-- | Utility class for `AllUnique` to provide nicer error messages.

467−class IsNotElem x isElem where

468−instance IsNotElem x 'False where

469−instance (TypeError ( 'Text "Cannot assign to "

470− ':<>: 'ShowType alias

471− ':<>: 'Text " more than once"))

472− => IsNotElem '(alias, a) 'True where

473− -- | No elem of @xs@ appears more than once, in the context of assignment.

474−class AllUnique (xs :: [(Symbol, a)]) where

475−instance AllUnique '[] where

476−instance (IsNotElem x (Elem x xs), AllUnique xs) => AllUnique (x ': xs) where

477−

478−class KnownSymbol alias

479− => DefaultAliasable alias aliased | aliased -> alias where

480− defaultAs :: Alias alias -> aliased

481−

482−-- | `HasAll` extends `Has` to take lists of @aliases@ and @fields@ and infer

483−-- a list of @subfields@.

484−class

485− ( All KnownSymbol aliases

486− ) => HasAll

487− (aliases :: [Symbol])

488− (fields :: [(Symbol,kind)])

489− (subfields :: [(Symbol,kind)])

490− | aliases fields -> subfields where

491−instance {-# OVERLAPPING #-} HasAll '[] fields '[]

492−instance {-# OVERLAPPABLE #-}

493− (Has alias fields field, HasAll aliases fields subfields)

494− => HasAll (alias ': aliases) fields (alias ::: field ': subfields)

495−

496−-- | Analagous to `IsLabel`, the constraint

497−-- `IsQualified` defines `!` for a column alias qualified

498−-- by a table alias.

499−class IsQualified table column expression where

500− (!) :: Alias table -> Alias column -> expression

501− infixl 9 !

502−instance IsQualified table column (Alias table, Alias column) where (!) = (,)

503−

504−data QualifiedAlias (qualifier :: Symbol) (alias :: Symbol) = QualifiedAlias

505− deriving (Eq,GHC.Generic,Ord,Show,NFData)

506−instance (q ~ q', a ~ a') => IsQualified q a (QualifiedAlias q' a') where

507− _!_ = QualifiedAlias

508−instance (q' ~ "public", a ~ a') => IsLabel a (QualifiedAlias q' a') where

509− fromLabel = QualifiedAlias

510−instance (q0 ~ q1, a0 ~ a1, a1 ~ a2, KnownSymbol a2) =>

511− IsQualified q0 a0 (Aliased (QualifiedAlias q1) (a1 ::: a2)) where

512− _!_ = QualifiedAlias `As` Alias

513−instance (q ~ "public", a0 ~ a1, a1 ~ a2, KnownSymbol a2) =>

514− IsLabel a0 (Aliased (QualifiedAlias q) (a1 ::: a2)) where

515− fromLabel = QualifiedAlias `As` Alias

516−

517−renderQualifiedAlias

518− :: forall q a. (KnownSymbol q, KnownSymbol a)

519− => QualifiedAlias q a -> ByteString

520−renderQualifiedAlias _ =

521− let

522− qualifier = renderAlias (Alias @q)

523− alias = renderAlias (Alias @a)

524− in

525− if qualifier == "\"public\"" then alias else qualifier <> "." <> alias

526−

527−-- | @Elem@ is a promoted `Data.List.elem`.

528−type family Elem x xs where

529− Elem x '[] = 'False

530− Elem x (x ': xs) = 'True

531− Elem x (_ ': xs) = Elem x xs

532−

533−-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.

534−type family In x xs :: Constraint where In x xs = Elem x xs ~ 'True

535−

536-- | Numeric Postgres types.

285-- | Numeric Postgres types.

537type PGNum =

286type PGNum =

538 '[ 'PGint2, 'PGint4, 'PGint8, 'PGnumeric, 'PGfloat4, 'PGfloat8]

287 '[ 'PGint2, 'PGint4, 'PGint8, 'PGnumeric, 'PGfloat4, 'PGfloat8]

@@ -543,37 +292,6 @@ type PGFloating = '[ 'PGfloat4, 'PGfloat8, 'PGnumeric]

543-- | Integral Postgres types.

292-- | Integral Postgres types.

544type PGIntegral = '[ 'PGint2, 'PGint4, 'PGint8]

293type PGIntegral = '[ 'PGint2, 'PGint4, 'PGint8]

545

294

546−-- | Error message helper for displaying unavailable\/unknown\/placeholder type

547−-- variables whose kind is known.

548−type Placeholder k = 'Text "(_::" :<>: 'ShowType k :<>: 'Text ")"

549−

550−type ErrArrayOf arr ty = arr :<>: 'Text " " :<>: ty

551−type ErrPGfixarrayOf t = ErrArrayOf ('ShowType 'PGfixarray :<>: 'Text " " :<>: Placeholder Nat) t

552−type ErrPGvararrayOf t = ErrArrayOf ('ShowType 'PGvararray) t

553−

554−-- | Ensure a type is a valid array type.

555−type family PGArray name arr :: Constraint where

556− PGArray name ('PGvararray x) = ()

557− PGArray name ('PGfixarray n x) = ()

558− PGArray name val = TypeError

559− ('Text name :<>: 'Text ": Unsatisfied PGArray constraint. Expected either: "

560− :$$: 'Text " • " :<>: ErrPGvararrayOf (Placeholder PGType)

561− :$$: 'Text " • " :<>: ErrPGfixarrayOf (Placeholder PGType)

562− :$$: 'Text "But got: " :<>: 'ShowType val)

563−

564−-- | Ensure a type is a valid array type with a specific element type.

565−type family PGArrayOf name arr ty :: Constraint where

566− PGArrayOf name ('PGvararray x) ty = x ~ ty

567− PGArrayOf name ('PGfixarray n x) ty = x ~ ty

568− PGArrayOf name val ty = TypeError

569− ( 'Text name :<>: 'Text "Unsatisfied PGArrayOf constraint. Expected either: "

570− :$$: 'Text " • " :<>: ErrPGvararrayOf ( 'ShowType ty )

571− :$$: 'Text " • " :<>: ErrPGfixarrayOf ( 'ShowType ty )

572− :$$: 'Text "But got: " :<>: 'ShowType val)

573−

574−-- | Ensure a type is a valid array type whose elements are text.

575−type PGTextArray name arr = PGArrayOf name arr ('NotNull 'PGtext)

576−

577-- | `PGTypeOf` forgets about @NULL@ and any column constraints.

295-- | `PGTypeOf` forgets about @NULL@ and any column constraints.

578type family PGTypeOf (ty :: NullityType) :: PGType where

296type family PGTypeOf (ty :: NullityType) :: PGType where

579 PGTypeOf (nullity pg) = pg

297 PGTypeOf (nullity pg) = pg

@@ -587,14 +305,24 @@ instance ty0 ~ ty1 => SamePGType

587

305

588-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.

306-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.

589type family AllNotNull (columns :: ColumnsType) :: Constraint where

307type family AllNotNull (columns :: ColumnsType) :: Constraint where

308+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns

309+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns

310+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns

311+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns

312+ AllNotNull (_ ::: _ :=> 'NotNull _ ': _ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns

313+ AllNotNull (_ ::: _ :=> 'NotNull _ ': columns) = AllNotNull columns

590 AllNotNull '[] = ()

314 AllNotNull '[] = ()

591− AllNotNull (column ::: def :=> 'NotNull ty ': columns) = AllNotNull columns

592

315

593-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some

316-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some

594-- @NOT NULL@.

317-- @NOT NULL@.

595type family NotAllNull (columns :: ColumnsType) :: Constraint where

318type family NotAllNull (columns :: ColumnsType) :: Constraint where

596− NotAllNull (column ::: def :=> 'NotNull ty ': columns) = ()

319+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

597− NotAllNull (column ::: def :=> 'Null ty ': columns) = NotAllNull columns

320+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

321+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

322+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

323+ NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

324+ NotAllNull (_ ::: _ :=> 'NotNull _ ': _) = ()

325+ NotAllNull (_ ::: _ :=> 'Null _ ': columns) = NotAllNull columns

598

326

599-- | `NullifyType` is an idempotent that nullifies a `NullityType`.

327-- | `NullifyType` is an idempotent that nullifies a `NullityType`.

600type family NullifyType (ty :: NullityType) :: NullityType where

328type family NullifyType (ty :: NullityType) :: NullityType where

@@ -603,23 +331,37 @@ type family NullifyType (ty :: NullityType) :: NullityType where

603

331

604-- | `NullifyRow` is an idempotent that nullifies a `RowType`.

332-- | `NullifyRow` is an idempotent that nullifies a `RowType`.

605type family NullifyRow (columns :: RowType) :: RowType where

333type family NullifyRow (columns :: RowType) :: RowType where

606− NullifyRow '[] = '[]

334+ NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': column5 ::: ty5 ': columns) =

335+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': column4 ::: NullifyType ty4 ': column5 ::: NullifyType ty5 ': NullifyRow columns

336+ NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': columns) =

337+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': column4 ::: NullifyType ty4 ': NullifyRow columns

338+ NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': columns) =

339+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': NullifyRow columns

340+ NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': columns) =

341+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': NullifyRow columns

342+ NullifyRow (column ::: ty ': column1 ::: ty1 ': columns) =

343+ column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': NullifyRow columns

607 NullifyRow (column ::: ty ': columns) =

344 NullifyRow (column ::: ty ': columns) =

608 column ::: NullifyType ty ': NullifyRow columns

345 column ::: NullifyType ty ': NullifyRow columns

346+ NullifyRow '[] = '[]

609

347

610-- | `NullifyFrom` is an idempotent that nullifies a `FromType`

348-- | `NullifyFrom` is an idempotent that nullifies a `FromType`

611-- used to nullify the left or right hand side of an outer join

349-- used to nullify the left or right hand side of an outer join

612-- in a `Squeal.PostgreSQL.Query.FromClause`.

350-- in a `Squeal.PostgreSQL.Query.FromClause`.

613type family NullifyFrom (tables :: FromType) :: FromType where

351type family NullifyFrom (tables :: FromType) :: FromType where

614− NullifyFrom '[] = '[]

352+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': table4 ::: columns4 ': table5 ::: columns5 ': tables) =

353+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': table4 ::: NullifyRow columns5 ': table5 ::: NullifyRow columns4 ': NullifyFrom tables

354+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': table4 ::: columns4 ': tables) =

355+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': table4 ::: NullifyRow columns4 ': NullifyFrom tables

356+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': tables) =

357+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': NullifyFrom tables

358+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': tables) =

359+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': NullifyFrom tables

360+ NullifyFrom (table ::: columns ': table1 ::: columns1 ': tables) =

361+ table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': NullifyFrom tables

615 NullifyFrom (table ::: columns ': tables) =

362 NullifyFrom (table ::: columns ': tables) =

616 table ::: NullifyRow columns ': NullifyFrom tables

363 table ::: NullifyRow columns ': NullifyFrom tables

617−

364+ NullifyFrom '[] = '[]

618−-- | `Join` is simply promoted `++` and is used in @JOIN@s in

619−-- `Squeal.PostgreSQL.Query.FromClause`s.

620−type family Join xs ys where

621− Join '[] ys = ys

622− Join (x ': xs) ys = x ': Join xs ys

623

365

624-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in

366-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in

625-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@

367-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@

@@ -629,30 +371,101 @@ type family Create alias x xs where

629 Create alias x (alias ::: y ': xs) = TypeError

371 Create alias x (alias ::: y ': xs) = TypeError

630 ('Text "Create: alias "

372 ('Text "Create: alias "

631 ':<>: 'ShowType alias

373 ':<>: 'ShowType alias

632− ':<>: 'Text "already in use")

374+ ':<>: 'Text "already exists")

633 Create alias y (x ': xs) = x ': Create alias y xs

375 Create alias y (x ': xs) = x ': Create alias y xs

634

376

377+type family CreateIfNotExists alias x xs where

378+ CreateIfNotExists alias x '[] = '[alias ::: x]

379+ CreateIfNotExists alias x (alias ::: y ': xs) = alias ::: y ': xs

380+ CreateIfNotExists alias y (x ': xs) = x ': CreateIfNotExists alias y xs

381+

382+type family CreateOrReplace alias x xs where

383+ CreateOrReplace alias x '[] = '[alias ::: x]

384+ CreateOrReplace alias x (alias ::: x ': xs) = alias ::: x ': xs

385+ CreateOrReplace alias x (alias ::: y ': xs) = TypeError

386+ ('Text "CreateOrReplace: expected type "

387+ ':<>: 'ShowType x

388+ ':<>: 'Text " but alias "

389+ ':<>: 'ShowType alias

390+ ':<>: 'Text " has type "

391+ ':<>: 'ShowType y)

392+ CreateOrReplace alias y (x ': xs) = x ': CreateOrReplace alias y xs

393+

635-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@

394-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@

636-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements

395-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements

637-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.

396-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.

638type family Drop alias xs where

397type family Drop alias xs where

639− Drop alias ((alias ::: x) ': xs) = xs

398+ Drop alias '[] = TypeError

399+ ('Text "Drop: alias "

400+ ':<>: 'ShowType alias

401+ ':<>: 'Text " does not exist" )

402+ Drop alias (alias ::: x ': xs) = xs

640 Drop alias (x ': xs) = x ': Drop alias xs

403 Drop alias (x ': xs) = x ': Drop alias xs

641

404

405+type family DropSchemum alias sch xs where

406+ DropSchemum alias sch '[] = TypeError

407+ ('Text "DropSchemum: alias "

408+ ':<>: 'ShowType alias

409+ ':<>: 'Text " does not exist" )

410+ DropSchemum alias sch (alias ::: sch x ': xs) = xs

411+ DropSchemum alias sch0 (alias ::: sch1 x ': xs) = TypeError

412+ ('Text "DropSchemum: expected schemum "

413+ ':<>: 'ShowType sch0

414+ ':<>: 'Text " but alias "

415+ ':<>: 'ShowType alias

416+ ':<>: 'Text " has schemum "

417+ ':<>: 'ShowType sch1)

418+ DropSchemum alias sch (x ': xs) = x ': DropSchemum alias sch xs

419+

420+type family DropIfExists alias xs where

421+ DropIfExists alias '[] = '[]

422+ DropIfExists alias (alias ::: x ': xs) = xs

423+ DropIfExists alias (x ': xs) = x ': DropIfExists alias xs

424+

425+type family DropSchemumIfExists alias sch xs where

426+ DropSchemumIfExists alias sch '[] = '[]

427+ DropSchemumIfExists alias sch (alias ::: sch x ': xs) = xs

428+ DropSchemumIfExists alias sch0 (alias ::: sch1 x ': xs) = TypeError

429+ ('Text "DropSchemumIfExists: expected schemum "

430+ ':<>: 'ShowType sch1

431+ ':<>: 'Text " but alias "

432+ ':<>: 'ShowType alias

433+ ':<>: 'Text " has schemum "

434+ ':<>: 'ShowType sch0)

435+ DropSchemumIfExists alias sch (x ': xs) = x ': DropSchemumIfExists alias sch xs

436+

642-- | @Alter alias x xs@ replaces the type associated with an @alias@ in @xs@

437-- | @Alter alias x xs@ replaces the type associated with an @alias@ in @xs@

643−-- with the type `x` and is used in `Squeal.PostgreSQL.Definition.alterTable`

438+-- with the type @x@ and is used in `Squeal.PostgreSQL.Definition.alterTable`

644-- and `Squeal.PostgreSQL.Definition.alterColumn`.

439-- and `Squeal.PostgreSQL.Definition.alterColumn`.

645type family Alter alias x xs where

440type family Alter alias x xs where

441+ Alter alias x '[] = TypeError

442+ ('Text "Alter: alias "

443+ ':<>: 'ShowType alias

444+ ':<>: 'Text " does not exist" )

646 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

445 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

647 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

446 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

648

447

448+type family AlterIfExists alias x xs where

449+ AlterIfExists alias x '[] = '[]

450+ AlterIfExists alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

451+ AlterIfExists alias x1 (x0 ': xs) = x0 ': AlterIfExists alias x1 xs

452+

649-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@

453-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@

650-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and

454-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and

651-- `Squeal.PostgreSQL.Definition.renameColumn`.

455-- `Squeal.PostgreSQL.Definition.renameColumn`.

652type family Rename alias0 alias1 xs where

456type family Rename alias0 alias1 xs where

457+ Rename alias0 alias1 '[] = TypeError

458+ ('Text "Rename: alias "

459+ ':<>: 'ShowType alias0

460+ ':<>: 'Text " does not exist" )

653 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

461 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

654 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

462 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

655

463

464+type family RenameIfExists alias0 alias1 xs where

465+ RenameIfExists alias x '[] = '[]

466+ RenameIfExists alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

467+ RenameIfExists alias0 alias1 (x ': xs) = x ': RenameIfExists alias0 alias1 xs

468+

656-- | Check if a `TableConstraint` involves a column

469-- | Check if a `TableConstraint` involves a column

657type family ConstraintInvolves column constraint where

470type family ConstraintInvolves column constraint where

658 ConstraintInvolves column ('Check columns) = column `Elem` columns

471 ConstraintInvolves column ('Check columns) = column `Elem` columns

@@ -669,22 +482,35 @@ type family DropIfConstraintsInvolve column constraints where

669 (DropIfConstraintsInvolve column constraints)

482 (DropIfConstraintsInvolve column constraints)

670 (alias ::: constraint ': DropIfConstraintsInvolve column constraints)

483 (alias ::: constraint ': DropIfConstraintsInvolve column constraints)

671

484

672−{- | Calculate the `Length` of a type level list

673−

674−>>> :kind! Length '[Char,String,Bool,Double]

675−Length '[Char,String,Bool,Double] :: Nat

676−= 4

677−-}

678−type family Length (xs :: [k]) :: Nat where

679− Length (x : xs) = 1 + Length xs

680− Length '[] = 0

681−

682-- | A `SchemumType` is a user-defined type, either a `Table`,

485-- | A `SchemumType` is a user-defined type, either a `Table`,

683-- `View` or `Typedef`.

486-- `View` or `Typedef`.

684data SchemumType

487data SchemumType

685 = Table TableType

488 = Table TableType

686 | View RowType

489 | View RowType

687 | Typedef PGType

490 | Typedef PGType

491+ | Index IndexType

492+ | Function FunctionType

493+ | Operator OperatorType

494+ | UnsafeSchemum Symbol

495+

496+type FunctionType = ([NullityType], ReturnsType)

497+

498+data IndexType

499+ = Btree

500+ | Hash

501+ | Gist

502+ | Spgist

503+ | Gin

504+ | Brin

505+

506+data ReturnsType

507+ = Returns NullityType

508+ | ReturnsTable RowType

509+

510+data OperatorType

511+ = BinaryOp NullityType NullityType NullityType

512+ | LeftOp NullityType NullityType

513+ | RightOp NullityType NullityType

688

514

689{- | The schema of a database consists of a list of aliased,

515{- | The schema of a database consists of a list of aliased,

690user-defined `SchemumType`s.

516user-defined `SchemumType`s.

@@ -710,15 +536,27 @@ type family Schema :: SchemaType where

710-}

536-}

711type SchemaType = [(Symbol,SchemumType)]

537type SchemaType = [(Symbol,SchemumType)]

712

538

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+-}

713type SchemasType = [(Symbol,SchemaType)]

554type SchemasType = [(Symbol,SchemaType)]

714

555

556+-- | A type family to use for a single schema database.

715type family Public (schema :: SchemaType) :: SchemasType

557type family Public (schema :: SchemaType) :: SchemasType

716 where Public schema = '["public" ::: schema]

558 where Public schema = '["public" ::: schema]

717

559

718−type DBType = (FromType,SchemasType)

719−

720−type family DBof :: SchemasType -> DBType where DBof = '(,) '[]

721−

722-- | `IsPGlabel` looks very much like the `IsLabel` class. Whereas

560-- | `IsPGlabel` looks very much like the `IsLabel` class. Whereas

723-- the overloaded label, `fromLabel` is used for column references,

561-- the overloaded label, `fromLabel` is used for column references,

724-- `label`s are used for enum terms. A `label` is called with

562-- `label`s are used for enum terms. A `label` is called with

@@ -730,195 +568,13 @@ instance labels ~ '[label]

730 => IsPGlabel label (NP PGlabel labels) where label = PGlabel :* Nil

568 => IsPGlabel label (NP PGlabel labels) where label = PGlabel :* Nil

731-- | A `PGlabel` unit type with an `IsPGlabel` instance

569-- | A `PGlabel` unit type with an `IsPGlabel` instance

732data PGlabel (label :: Symbol) = PGlabel

570data PGlabel (label :: Symbol) = PGlabel

733−-- | Renders a label

571+instance KnownSymbol label => RenderSQL (PGlabel label) where

734−renderLabel :: KnownSymbol label => proxy label -> ByteString

572+ renderSQL _ = "\'" <> renderSymbol @label <> "\'"

735−renderLabel (_ :: proxy label) =

573+instance All KnownSymbol labels => RenderSQL (NP PGlabel labels) where

736− "\'" <> renderSymbol @label <> "\'"

574+ renderSQL

737−-- | Renders a list of labels

575+ = commaSeparated

738−renderLabels

576+ . hcollapse

739− :: All KnownSymbol labels => NP PGlabel labels -> [ByteString]

577+ . hcmap (Proxy @KnownSymbol) (K . renderSQL)

740−renderLabels = hcollapse

741− . hcmap (Proxy @KnownSymbol) (K . renderLabel)

742−

743−{- | The `PG` type family embeds a subset of Haskell types

744−as Postgres types. As an open type family, `PG` is extensible.

745−

746−>>> :kind! PG LocalTime

747−PG LocalTime :: PGType

748−= 'PGtimestamp

749−

750−>>> newtype MyDouble = My Double

751−>>> type instance PG MyDouble = 'PGfloat8

752−-}

753−type family PG (hask :: Type) :: PGType

754−type instance PG Bool = 'PGbool

755−type instance PG Int16 = 'PGint2

756−type instance PG Int32 = 'PGint4

757−type instance PG Int64 = 'PGint8

758−type instance PG Word16 = 'PGint2

759−type instance PG Word32 = 'PGint4

760−type instance PG Word64 = 'PGint8

761−type instance PG Scientific = 'PGnumeric

762−type instance PG Float = 'PGfloat4

763−type instance PG Double = 'PGfloat8

764−type instance PG Char = 'PGchar 1

765−type instance PG Text = 'PGtext

766−type instance PG Lazy.Text = 'PGtext

767−type instance PG String = 'PGtext

768−type instance PG ByteString = 'PGbytea

769−type instance PG Lazy.ByteString = 'PGbytea

770−type instance PG LocalTime = 'PGtimestamp

771−type instance PG UTCTime = 'PGtimestamptz

772−type instance PG Day = 'PGdate

773−type instance PG TimeOfDay = 'PGtime

774−type instance PG (TimeOfDay, TimeZone) = 'PGtimetz

775−type instance PG DiffTime = 'PGinterval

776−type instance PG UUID = 'PGuuid

777−type instance PG (NetAddr IP) = 'PGinet

778−type instance PG Value = 'PGjson

779−type instance PG (Json hask) = 'PGjson

780−type instance PG (Jsonb hask) = 'PGjsonb

781−type instance PG (Vector hask) = 'PGvararray (NullPG hask)

782−type instance PG (hask, hask) = 'PGfixarray 2 (NullPG hask)

783−type instance PG (hask, hask, hask) = 'PGfixarray 3 (NullPG hask)

784−type instance PG (hask, hask, hask, hask) = 'PGfixarray 4 (NullPG hask)

785−type instance PG (hask, hask, hask, hask, hask) = 'PGfixarray 5 (NullPG hask)

786−type instance PG (hask, hask, hask, hask, hask, hask)

787− = 'PGfixarray 6 (NullPG hask)

788−type instance PG (hask, hask, hask, hask, hask, hask, hask)

789− = 'PGfixarray 7 (NullPG hask)

790−type instance PG (hask, hask, hask, hask, hask, hask, hask, hask)

791− = 'PGfixarray 8 (NullPG hask)

792−type instance PG (hask, hask, hask, hask, hask, hask, hask, hask, hask)

793− = 'PGfixarray 9 (NullPG hask)

794−type instance PG (hask, hask, hask, hask, hask, hask, hask, hask, hask, hask)

795− = 'PGfixarray 10 (NullPG hask)

796−type instance PG (Composite hask) = 'PGcomposite (RowPG hask)

797−type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)

798−

799−{- | The `Json` newtype is an indication that the Haskell

800−type it's applied to should be stored as `PGjson`.

801−-}

802−newtype Json hask = Json {getJson :: hask}

803− deriving (Eq, Ord, Show, Read, GHC.Generic)

804−

805−{- | The `Jsonb` newtype is an indication that the Haskell

806−type it's applied to should be stored as `PGjsonb`.

807−-}

808−newtype Jsonb hask = Jsonb {getJsonb :: hask}

809− deriving (Eq, Ord, Show, Read, GHC.Generic)

810−

811−{- | The `Composite` newtype is an indication that the Haskell

812−type it's applied to should be stored as a `PGcomposite`.

813−-}

814−newtype Composite record = Composite {getComposite :: record}

815− deriving (Eq, Ord, Show, Read, GHC.Generic)

816−

817−{- | The `Enumerated` newtype is an indication that the Haskell

818−type it's applied to should be stored as `PGenum`.

819−-}

820−newtype Enumerated enum = Enumerated {getEnumerated :: enum}

821− deriving (Eq, Ord, Show, Read, GHC.Generic)

822−

823−{-| The `LabelsPG` type family calculates the constructors of a

824−Haskell enum type.

825−

826−>>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

827−>>> instance Generic Schwarma

828−>>> instance HasDatatypeInfo Schwarma

829−>>> :kind! LabelsPG Schwarma

830−LabelsPG Schwarma :: [Type.ConstructorName]

831−= '["Beef", "Lamb", "Chicken"]

832−-}

833−type family LabelsPG (hask :: Type) :: [Type.ConstructorName] where

834− LabelsPG hask =

835− ConstructorNamesOf (ConstructorsOf (DatatypeInfoOf hask))

836−

837−{- | `RowPG` turns a Haskell record type into a `RowType`.

838−

839−>>> data Person = Person { name :: Text, age :: Int32 } deriving GHC.Generic

840−>>> instance Generic Person

841−>>> instance HasDatatypeInfo Person

842−>>> :kind! RowPG Person

843−RowPG Person :: [(Symbol, NullityType)]

844−= '["name" ::: 'NotNull 'PGtext, "age" ::: 'NotNull 'PGint4]

845−-}

846−type family RowPG (hask :: Type) :: RowType where

847− RowPG hask = RowOf (RecordCodeOf hask)

848−

849−type family RowOf (fields :: [(Symbol, Type)]) :: RowType where

850− RowOf '[] = '[]

851− RowOf (field ': fields) = FieldPG field ': RowOf fields

852−

853−type family FieldPG (field :: (Symbol, Type)) :: (Symbol, NullityType) where

854− FieldPG (field ::: hask) = field ::: NullPG hask

855−

856−{- | `NullPG` turns a Haskell type into a `NullityType`.

857−

858−>>> :kind! NullPG Double

859−NullPG Double :: NullityType

860−= 'NotNull 'PGfloat8

861−>>> :kind! NullPG (Maybe Double)

862−NullPG (Maybe Double) :: NullityType

863−= 'Null 'PGfloat8

864−-}

865−type family NullPG (hask :: Type) :: NullityType where

866− NullPG (Maybe hask) = 'Null (PG hask)

867− NullPG hask = 'NotNull (PG hask)

868−

869−{- | `TuplePG` turns a Haskell tuple type (including record types) into

870−the corresponding list of `NullityType`s.

871−

872−>>> :kind! TuplePG (Double, Maybe Char)

873−TuplePG (Double, Maybe Char) :: [NullityType]

874−= '['NotNull 'PGfloat8, 'Null ('PGchar 1)]

875−-}

876−type family TuplePG (hask :: Type) :: [NullityType] where

877− TuplePG hask = TupleOf (TupleCodeOf hask (Code hask))

878−

879−type family TupleOf (tuple :: [Type]) :: [NullityType] where

880− TupleOf '[] = '[]

881− TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple

882−

883−type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where

884− TupleCodeOf hask '[tuple] = tuple

885− TupleCodeOf hask '[] =

886− TypeError

887− ( 'Text "The type `" :<>: 'ShowType hask :<>: 'Text "' is not a tuple type."

888− :$$: 'Text "It is a void type with no constructors."

889− )

890− TupleCodeOf hask (_ ': _ ': _) =

891− TypeError

892− ( 'Text "The type `" :<>: 'ShowType hask :<>: 'Text "' is not a tuple type."

893− :$$: 'Text "It is a sum type with more than one constructor."

894− )

895−

896−-- | Calculates constructors of a datatype.

897−type family ConstructorsOf (datatype :: Type.DatatypeInfo)

898− :: [Type.ConstructorInfo] where

899− ConstructorsOf ('Type.ADT _module _datatype constructors) =

900− constructors

901− ConstructorsOf ('Type.Newtype _module _datatype constructor) =

902− '[constructor]

903−

904−-- | Calculates the name of a nullary constructor, otherwise

905−-- generates a type error.

906−type family ConstructorNameOf (constructors :: Type.ConstructorInfo)

907− :: Type.ConstructorName where

908− ConstructorNameOf ('Type.Constructor name) = name

909− ConstructorNameOf ('Type.Infix name _assoc _fix) = TypeError

910− ('Text "ConstructorNameOf error: non-nullary constructor "

911− ':<>: 'Text name)

912− ConstructorNameOf ('Type.Record name _fields) = TypeError

913− ('Text "ConstructorNameOf error: non-nullary constructor "

914− ':<>: 'Text name)

915−

916−-- | Calculate the names of nullary constructors.

917−type family ConstructorNamesOf (constructors :: [Type.ConstructorInfo])

918− :: [Type.ConstructorName] where

919− ConstructorNamesOf '[] = '[]

920− ConstructorNamesOf (constructor ': constructors) =

921− ConstructorNameOf constructor ': ConstructorNamesOf constructors

922

578

923-- | Is a type a valid JSON key?

579-- | Is a type a valid JSON key?

924type PGJsonKey = '[ 'PGint2, 'PGint4, 'PGtext ]

580type PGJsonKey = '[ 'PGint2, 'PGint4, 'PGtext ]

@@ -926,17 +582,15 @@ type PGJsonKey = '[ 'PGint2, 'PGint4, 'PGtext ]

926-- | Is a type a valid JSON type?

582-- | Is a type a valid JSON type?

927type PGJsonType = '[ 'PGjson, 'PGjsonb ]

583type PGJsonType = '[ 'PGjson, 'PGjsonb ]

928

584

929−-- | An `AlignedList` is a type-aligned list or free category.

585+-- | Utility class for `AllUnique` to provide nicer error messages.

930−data AlignedList p x0 x1 where

586+class IsNotElem x isElem where

931− Done :: AlignedList p x x

587+instance IsNotElem x 'False where

932− (:>>) :: p x0 x1 -> AlignedList p x1 x2 -> AlignedList p x0 x2

588+instance (TypeError ( 'Text "Cannot assign to "

933−infixr 7 :>>

589+ ':<>: 'ShowType alias

934−instance Category (AlignedList p) where

590+ ':<>: 'Text " more than once"))

935− id = Done

591+ => IsNotElem '(alias, a) 'True where

936− (.) list = \case

592+

937− Done -> list

593+-- | No elem of @xs@ appears more than once, in the context of assignment.

938− step :>> steps -> step :>> (steps >>> list)

594+class AllUnique (xs :: [(Symbol, a)]) where

939−

595+instance AllUnique '[] where

940−-- | A `single` step.

596+instance (IsNotElem x (Elem x xs), AllUnique xs) => AllUnique (x ': xs) where

941−single :: p x0 x1 -> AlignedList p x0 x1

942−single step = step :>> Done

squeal-postgresql/src/Squeal/PostgreSQL/Transaction.hs+98−72

@@ -1,7 +1,7 @@

1{-|

2Module: Squeal.PostgreSQL.Transaction

3Description: Squeal transaction control language

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

5Maintainer: eitan@morphism.tech

6Stability: experimental

@@ -20,88 +20,114 @@ module Squeal.PostgreSQL.Transaction

20 ( -- * Transaction

21 transactionally

22 , transactionally_

23+ , transactionallyRetry

24+ , ephemerally

25+ , ephemerally_

23 , begin

26 , begin

24 , commit

27 , commit

25 , rollback

28 , rollback

26− , transactionallySchema

27− , transactionallySchema_

28 -- * Transaction Mode

29 -- * Transaction Mode

29 , TransactionMode (..)

30 , TransactionMode (..)

30 , defaultMode

31 , defaultMode

31 , longRunningMode

32 , longRunningMode

32 , IsolationLevel (..)

33 , IsolationLevel (..)

33− , renderIsolationLevel

34 , AccessMode (..)

35− , renderAccessMode

36 , DeferrableMode (..)

35 , DeferrableMode (..)

37− , renderDeferrableMode

38 ) where

36 ) where

40−import Control.Exception.Lifted

38+import UnliftIO

41−import Control.Monad.Base

42−import Control.Monad.Trans.Control

43−import Data.ByteString

44−import Generics.SOP

45−

46−import qualified Database.PostgreSQL.LibPQ as LibPQ

48import Squeal.PostgreSQL.Manipulation

40import Squeal.PostgreSQL.Manipulation

49import Squeal.PostgreSQL.Render

41import Squeal.PostgreSQL.Render

50import Squeal.PostgreSQL.PQ

42import Squeal.PostgreSQL.PQ

51−import Squeal.PostgreSQL.Schema

53−-- | Run a schema invariant computation `transactionally`.

44+{- | Run a computation `transactionally`;

45+first `begin`,

46+then run the computation,

47+`onException` `rollback` and rethrow the exception,

48+otherwise `commit` and `return` the result.

49+-}

54transactionally

50transactionally

55− :: (MonadBaseControl IO tx, MonadPQ schemas tx)

51+ :: (MonadUnliftIO tx, MonadPQ schemas tx)

56 => TransactionMode

52 => TransactionMode

57 -> tx x -- ^ run inside a transaction

53 -> tx x -- ^ run inside a transaction

58 -> tx x

54 -> tx x

59transactionally mode tx = mask $ \restore -> do

55transactionally mode tx = mask $ \restore -> do

60− _ <- begin mode

56+ manipulate_ $ begin mode

61− result <- restore tx `onException` rollback

57+ result <- restore tx `onException` (manipulate_ rollback)

62− _ <- commit

58+ manipulate_ commit

63 return result

59 return result

65−-- | Run a schema invariant computation `transactionally_` in `defaultMode`.

61+-- | Run a computation `transactionally_`, in `defaultMode`.

66transactionally_

62transactionally_

67− :: (MonadBaseControl IO tx, MonadPQ schemas tx)

63+ :: (MonadUnliftIO tx, MonadPQ schemas tx)

68 => tx x -- ^ run inside a transaction

64 => tx x -- ^ run inside a transaction

69 -> tx x

65 -> tx x

70transactionally_ = transactionally defaultMode

66transactionally_ = transactionally defaultMode

72−-- | @BEGIN@ a transaction.

68+{- |

73−begin :: MonadPQ schemas tx => TransactionMode -> tx (K Result ('[] :: RowType))

69+`transactionallyRetry` a computation;

74−begin mode = manipulate . UnsafeManipulation $

70+

75− "BEGIN" <+> renderTransactionMode mode <> ";"

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

77−-- | @COMMIT@ a schema invariant transaction.

113+{- | Run a computation `ephemerally` in `defaultMode`. -}

78−commit :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

114+ephemerally_

79−commit = manipulate $ UnsafeManipulation "COMMIT;"

115+ :: (MonadUnliftIO tx, MonadPQ schemas tx)

116+ => tx x -- ^ run inside an ephemeral transaction

117+ -> tx x

118+ephemerally_ = ephemerally defaultMode

119+

120+-- | @BEGIN@ a transaction.

121+begin :: TransactionMode -> Manipulation_ schemas () ()

122+begin mode = UnsafeManipulation $ "BEGIN" <+> renderSQL mode

123

81−-- | @ROLLBACK@ a schema invariant transaction.

124+-- | @COMMIT@ a transaction.

82−rollback :: MonadPQ schemas tx => tx (K Result ('[] :: RowType))

125+commit :: Manipulation_ schemas () ()

83−rollback = manipulate $ UnsafeManipulation "ROLLBACK;"

126+commit = UnsafeManipulation "COMMIT"

127

85−-- | Run a schema changing computation `transactionallySchema`.

128+-- | @ROLLBACK@ a transaction.

86−transactionallySchema

129+rollback :: Manipulation_ schemas () ()

87− :: MonadBaseControl IO io

130+rollback = UnsafeManipulation "ROLLBACK"

88− => TransactionMode

89− -> PQ schemas0 schemas1 io x

90− -> PQ schemas0 schemas1 io x

91−transactionallySchema mode u = PQ $ \ conn -> mask $ \ restore -> do

92− _ <- liftBase . LibPQ.exec (unK conn) $

93− "BEGIN" <+> renderTransactionMode mode <> ";"

94− x <- restore (unPQ u conn)

95− `onException` (liftBase (LibPQ.exec (unK conn) "ROLLBACK"))

96− _ <- liftBase $ LibPQ.exec (unK conn) "COMMIT"

97− return x

98−

99−-- | Run a schema changing computation `transactionallySchema_` in `DefaultMode`.

100−transactionallySchema_

101− :: MonadBaseControl IO io

102− => PQ schemas0 schemas1 io x

103− -> PQ schemas0 schemas1 io x

104−transactionallySchema_ = transactionallySchema defaultMode

105

131

106-- | The available transaction characteristics are the transaction `IsolationLevel`,

132-- | The available transaction characteristics are the transaction `IsolationLevel`,

107-- the transaction `AccessMode` (`ReadWrite` or `ReadOnly`), and the `DeferrableMode`.

133-- the transaction `AccessMode` (`ReadWrite` or `ReadOnly`), and the `DeferrableMode`.

@@ -114,7 +140,7 @@ data TransactionMode = TransactionMode

114-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

140-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

115-- `ReadWrite` `AccessMode` and `NotDeferrable` `DeferrableMode`.

141-- `ReadWrite` `AccessMode` and `NotDeferrable` `DeferrableMode`.

116defaultMode :: TransactionMode

142defaultMode :: TransactionMode

117−defaultMode = TransactionMode Serializable ReadWrite NotDeferrable

143+defaultMode = TransactionMode ReadCommitted ReadWrite NotDeferrable

118

144

119-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

145-- | `TransactionMode` with a `Serializable` `IsolationLevel`,

120-- `ReadOnly` `AccessMode` and `Deferrable` `DeferrableMode`.

146-- `ReadOnly` `AccessMode` and `Deferrable` `DeferrableMode`.

@@ -123,12 +149,12 @@ longRunningMode :: TransactionMode

123longRunningMode = TransactionMode Serializable ReadOnly Deferrable

149longRunningMode = TransactionMode Serializable ReadOnly Deferrable

124

150

125-- | Render a `TransactionMode`.

151-- | Render a `TransactionMode`.

126−renderTransactionMode :: TransactionMode -> ByteString

152+instance RenderSQL TransactionMode where

127−renderTransactionMode mode =

153+ renderSQL mode =

128− "ISOLATION LEVEL"

154+ "ISOLATION LEVEL"

129− <+> renderIsolationLevel (isolationLevel mode)

155+ <+> renderSQL (isolationLevel mode)

130− <+> renderAccessMode (accessMode mode)

156+ <+> renderSQL (accessMode mode)

131− <+> renderDeferrableMode (deferrableMode mode)

157+ <+> renderSQL (deferrableMode mode)

132

158

133-- | The SQL standard defines four levels of transaction isolation.

159-- | The SQL standard defines four levels of transaction isolation.

134-- The most strict is `Serializable`, which is defined by the standard in a paragraph

160-- The most strict is `Serializable`, which is defined by the standard in a paragraph

@@ -179,12 +205,12 @@ data IsolationLevel

179 deriving (Show, Eq)

205 deriving (Show, Eq)

180

206

181-- | Render an `IsolationLevel`.

207-- | Render an `IsolationLevel`.

182−renderIsolationLevel :: IsolationLevel -> ByteString

208+instance RenderSQL IsolationLevel where

183−renderIsolationLevel = \case

209+ renderSQL = \case

184− Serializable -> "SERIALIZABLE"

210+ Serializable -> "SERIALIZABLE"

185− ReadCommitted -> "READ COMMITTED"

211+ ReadCommitted -> "READ COMMITTED"

186− ReadUncommitted -> "READ UNCOMMITTED"

212+ ReadUncommitted -> "READ UNCOMMITTED"

187− RepeatableRead -> "REPEATABLE READ"

213+ RepeatableRead -> "REPEATABLE READ"

188

214

189-- | The transaction access mode determines whether the transaction is `ReadWrite` or `ReadOnly`.

215-- | The transaction access mode determines whether the transaction is `ReadWrite` or `ReadOnly`.

190-- `ReadWrite` is the default. When a transaction is `ReadOnly`,

216-- `ReadWrite` is the default. When a transaction is `ReadOnly`,

@@ -201,10 +227,10 @@ data AccessMode

201 deriving (Show, Eq)

227 deriving (Show, Eq)

202

228

203-- | Render an `AccessMode`.

229-- | Render an `AccessMode`.

204−renderAccessMode :: AccessMode -> ByteString

230+instance RenderSQL AccessMode where

205−renderAccessMode = \case

231+ renderSQL = \case

206− ReadWrite -> "READ WRITE"

232+ ReadWrite -> "READ WRITE"

207− ReadOnly -> "READ ONLY"

233+ ReadOnly -> "READ ONLY"

208

234

209-- | The `Deferrable` transaction property has no effect

235-- | The `Deferrable` transaction property has no effect

210-- unless the transaction is also `Serializable` and `ReadOnly`.

236-- unless the transaction is also `Serializable` and `ReadOnly`.

@@ -220,7 +246,7 @@ data DeferrableMode

220 deriving (Show, Eq)

246 deriving (Show, Eq)

221

247

222-- | Render a `DeferrableMode`.

248-- | Render a `DeferrableMode`.

223−renderDeferrableMode :: DeferrableMode -> ByteString

249+instance RenderSQL DeferrableMode where

224−renderDeferrableMode = \case

250+ renderSQL = \case

225− Deferrable -> "DEFERRABLE"

251+ Deferrable -> "DEFERRABLE"

226− NotDeferrable -> "NOT DEFERRABLE"

252+ NotDeferrable -> "NOT DEFERRABLE"

squeal-postgresql/test/Doc.hsnew file+6

@@ -0,0 +1,6 @@

1+module Main (main) where

3+import Test.DocTest

5+main :: IO ()

6+main = doctest [ "-isrc", "src" ]

squeal-postgresql/test/DocTest.hsdeleted−18

@@ -1,18 +0,0 @@

1−module Main (main) where

2−

3−import Test.DocTest

4−

5−main :: IO ()

6−main = doctest

7− [ "-isrc"

8− , "src/Squeal/PostgreSQL.hs"

9− , "src/Squeal/PostgreSQL/Binary.hs"

10− , "src/Squeal/PostgreSQL/Definition.hs"

11− , "src/Squeal/PostgreSQL/Manipulation.hs"

12− , "src/Squeal/PostgreSQL/Query.hs"

13− , "src/Squeal/PostgreSQL/Expression.hs"

14− , "src/Squeal/PostgreSQL/PQ.hs"

15− , "src/Squeal/PostgreSQL/Migration.hs"

16− , "src/Squeal/PostgreSQL/Transaction.hs"

17− , "src/Squeal/PostgreSQL/Pool.hs"

18− ]

squeal-postgresql/test/Property.hsnew file+166

@@ -0,0 +1,166 @@

1+{-# LANGUAGE

2+ DataKinds

3+ , GADTs

4+ , LambdaCase

5+ , OverloadedLabels

6+ , OverloadedStrings

7+ , TypeApplications

8+ , TypeOperators

9+#-}

10+

11+module Main (main) where

12+

13+import Control.Monad.Trans

14+import Data.ByteString (ByteString)

15+import Data.ByteString.Char8 (unpack)

16+import Data.Scientific (fromFloatDigits)

17+import Data.Fixed (Fixed(MkFixed), Micro, Pico)

18+import Data.String (IsString(fromString))

19+import Data.Time

20+import Squeal.PostgreSQL hiding (check, defaultMain, Group)

21+import Hedgehog hiding (Range)

22+import qualified Hedgehog.Gen as Gen

23+import qualified Hedgehog.Main as Main

24+import qualified Hedgehog.Range as Range

25+

26+main :: IO ()

27+main = Main.defaultMain [checkSequential roundtrips]

28+

29+roundtrips :: Group

30+roundtrips = Group "roundtrips"

31+ [ roundtrip int2 genInt16

32+ , roundtrip int4 genInt32

33+ , roundtrip int8 genInt64

34+ , roundtrip bool Gen.bool

35+ , roundtrip numeric genScientific

36+ , roundtrip float4 genFloat

37+ , roundtrip float8 genDouble

38+ , roundtripOn normalizeTimeOfDay time genTimeOfDay

39+ -- , roundtrip timetz genTimeWithZone normalizeTimeWithZone

40+ , roundtripOn normalizeLocalTime timestamp genLocalTime

41+ , roundtrip timestamptz genUTCTime

42+ , roundtrip date genDay

43+ , roundtrip interval genDiffTime

44+ , roundtripOn normalizeIntRange int4range (genRange genInt32)

45+ , roundtripOn normalizeIntRange int8range (genRange genInt64)

46+ , roundtrip numrange (genRange genScientific)

47+ , roundtripOn (fmap normalizeLocalTime) tsrange (genRange genLocalTime)

48+ , roundtrip tstzrange (genRange genUTCTime)

49+ , roundtripOn normalizeIntRange daterange (genRange genDay)

50+ ]

51+ where

52+ genInt16 = Gen.int16 Range.exponentialBounded

53+ genInt32 = Gen.int32 Range.exponentialBounded

54+ genInt64 = Gen.int64 Range.exponentialBounded

55+ genScientific = fromFloatDigits <$> genFloat

56+ genPosFloat = Gen.float

57+ (Range.exponentialFloatFrom 1 minPosFloat maxPosFloat)

58+ genFloat = Gen.prune $ Gen.choice

59+ [ genPosFloat

60+ , negate <$> genPosFloat

61+ , Gen.element [0,1/0] ]

62+ genPosDouble = Gen.double

63+ (Range.exponentialFloatFrom 1 minPosFloat maxPosFloat)

64+ genDouble = Gen.prune $ Gen.choice

65+ [ genPosDouble

66+ , negate <$> genPosDouble

67+ , Gen.element [0,1/0] ]

68+ genRange gen = do

69+ lb <- gen

70+ ub <- Gen.filter (lb <) gen

71+ Gen.element

72+ [ Empty, singleton lb, whole

73+ , lb <=..<= ub , lb <=..< ub, lb <..<= ub, lb <..< ub

74+ , atLeast lb, moreThan lb, atMost ub, lessThan ub ]

75+ genDay = do

76+ y <- toInteger <$> Gen.int (Range.constant 2000 2019)

77+ m <- Gen.int (Range.constant 1 12)

78+ d <- Gen.int (Range.constant 1 28)

79+ return $ fromGregorian y m d

80+ genDiffTime = secondsToDiffTime . toInteger <$>

81+ Gen.int (Range.constant 0 86401)

82+ genUTCTime = UTCTime <$> genDay <*> genDiffTime

83+ genTimeOfDay = do

84+ h <- Gen.int (Range.constant 0 23)

85+ m <- Gen.int (Range.constant 0 59)

86+ s <- MkFixed . toInteger <$> Gen.int (Range.constant 0 59)

87+ return $ TimeOfDay h m s

88+ genLocalTime = LocalTime <$> genDay <*> genTimeOfDay

89+ -- genTimeZone = Gen.element $ map (read @TimeZone)

90+ -- [ "UTC", "UT", "GMT", "EST", "EDT", "CST"

91+ -- , "CDT", "MST", "MDT", "PST", "PDT" ]

92+ -- genTimeWithZone = (,) <$> genTimeOfDay <*> genTimeZone

93+

94+roundtrip

95+ :: (OidOf ty, ToParam x ty, FromValue ty x, Show x, Eq x)

96+ => TypeExpression schemas ('NotNull ty)

97+ -> Gen x

98+ -> (PropertyName, Property)

99+roundtrip = roundtripOn id

100+

101+roundtripOn

102+ :: (OidOf ty, ToParam x ty, FromValue ty x, Show x, Eq x)

103+ => (x -> x)

104+ -> TypeExpression schemas ('NotNull ty)

105+ -> Gen x

106+ -> (PropertyName, Property)

107+roundtripOn norm ty gen = propertyWithName $ do

108+ x <- forAll gen

109+ Just (Only y) <- lift . withConnection connectionString $

110+ firstRow =<< runQueryParams

111+ (values_ (parameter @1 ty `as` #fromOnly)) (Only x)

112+ norm x === y

113+ where

114+ propertyWithName prop =

115+ (fromString (unpack (renderSQL ty)), property prop)

116+

117+maxPosFloat :: RealFloat a => a

118+maxPosFloat = x

119+ where

120+ n = floatDigits x

121+ b = floatRadix x

122+ (_, u) = floatRange x

123+ x = encodeFloat (b^n - 1) (u - n)

124+

125+minPosFloat :: RealFloat a => a

126+minPosFloat = x

127+ where

128+ n = floatDigits x

129+ b = floatRadix x

130+ (l, _) = floatRange x

131+ x = encodeFloat (b^n - 1) (l - n - 1)

132+

133+connectionString :: ByteString

134+connectionString = "host=localhost port=5432 dbname=exampledb"

135+

136+normalizeIntRange :: (Enum int, Ord int) => Range int -> Range int

137+normalizeIntRange = \case

138+ Empty -> Empty

139+ NonEmpty l u ->

140+ let

141+ l' = normalizeL l

142+ u' = normalizeU u

143+ in if emptyNormalized l' u' then Empty else NonEmpty l' u'

144+ where

145+ normalizeL = \case

146+ Open l -> Closed (succ l)

147+ normalized -> normalized

148+ normalizeU = \case

149+ Closed u -> Open (succ u)

150+ normalized -> normalized

151+ emptyNormalized (Closed l) (Open u) = l >= u

152+ emptyNormalized _ _ = False

153+

154+normalizeTimeOfDay :: TimeOfDay -> TimeOfDay

155+normalizeTimeOfDay (TimeOfDay h m s) = TimeOfDay h m

156+ . fromRational @Pico

157+ . toRational @Micro

158+ . fromRational @Micro

159+ . toRational @Pico

160+ $ s

161+

162+normalizeLocalTime :: LocalTime -> LocalTime

163+normalizeLocalTime (LocalTime d t) = LocalTime d (normalizeTimeOfDay t)

164+

165+-- normalizeTimeWithZone :: (TimeOfDay, TimeZone) -> (TimeOfDay, TimeZone)

166+-- normalizeTimeWithZone (t, z) = (normalizeTimeOfDay t, z)

squeal-postgresql/test/Spec.hsnew file+136

@@ -0,0 +1,136 @@

1+{-# LANGUAGE

2+ DataKinds

3+ , DeriveAnyClass

4+ , DeriveGeneric

5+ , DerivingStrategies

6+ , DuplicateRecordFields

7+ , FlexibleContexts

8+ , OverloadedLabels

9+ , OverloadedLists

10+ , OverloadedStrings

11+ , TypeApplications

12+ , TypeFamilies

13+ , TypeInType

14+ , TypeOperators

15+#-}

16+

17+module Main (main) where

18+

19+import Control.Concurrent.Async (replicateConcurrently)

20+import Data.ByteString (ByteString)

21+import Data.Int (Int32)

22+import Data.Text (Text)

23+import Test.Hspec

24+

25+import qualified Generics.SOP as SOP

26+import qualified GHC.Generics as GHC

27+

28+import Squeal.PostgreSQL

29+

30+main :: IO ()

31+main = hspec spec

32+

33+type Schemas = Public

34+ '[ "users" ::: 'Table (

35+ '[ "pk_users" ::: 'PrimaryKey '["id"]

36+ , "unique_names" ::: 'Unique '["name"]

37+ ] :=>

38+ '[ "id" ::: 'Def :=> 'NotNull 'PGint4

39+ , "name" ::: 'NoDef :=> 'NotNull 'PGtext ] ) ]

40+

41+data User = User

42+ { userName :: Text

43+ } deriving stock (Eq, Show, GHC.Generic)

44+ deriving anyclass (SOP.Generic, SOP.HasDatatypeInfo)

45+

46+insertUser :: Manipulation_ Schemas User ()

47+insertUser = insertInto_ #users

48+ (Values_ (Default `as` #id :* Set (param @1) `as` #name))

49+

50+setup :: Definition (Public '[]) Schemas

51+setup =

52+ createTable #users

53+ ( serial `as` #id :*

54+ notNullable text `as` #name )

55+ ( primaryKey #id `as` #pk_users :*

56+ unique #name `as` #unique_names )

57+

58+teardown :: Definition Schemas (Public '[])

59+teardown = dropTable #users

60+

61+silence :: MonadPQ schemas pq => pq ()

62+silence = manipulate_ $

63+ UnsafeManipulation "SET client_min_messages TO WARNING;"

64+

65+setupDB :: IO ()

66+setupDB = withConnection connectionString $

67+ silence & pqThen (define setup)

68+

69+dropDB :: IO ()

70+dropDB = withConnection connectionString $

71+ silence & pqThen (define teardown)

72+

73+connectionString :: ByteString

74+connectionString = "host=localhost port=5432 dbname=exampledb"

75+

76+spec :: Spec

77+spec = before_ setupDB . after_ dropDB $ do

78+

79+ describe "Exceptions" $ do

80+

81+ let

82+ testUser = User "TestUser"

83+ newUser = manipulateParams_ insertUser

84+ insertUserTwice = newUser testUser >> newUser testUser

85+ err23505 = PQException $ PQState FatalError (Just "23505")

86+ (Just "ERROR: duplicate key value violates unique constraint \"unique_names\"\nDETAIL: Key (name)=(TestUser) already exists.\n")

87+

88+ it "should be thrown for constraint violation" $

89+ withConnection connectionString insertUserTwice

90+ `shouldThrow` (== err23505)

91+

92+ it "should be rethrown for constraint violation in a transaction" $

93+ withConnection connectionString (transactionally_ insertUserTwice)

94+ `shouldThrow` (== err23505)

95+

96+ describe "Pools" $

97+

98+ it "should manage concurrent transactions" $ do

99+ pool <- createConnectionPool

100+ "host=localhost port=5432 dbname=exampledb" 1 0.5 10

101+ let

102+ query :: Query_ (Public '[]) () (Only Char)

103+ query = values_ (literal 'a' `as` #fromOnly)

104+ session = usingConnectionPool pool . transactionally_ $ do

105+ result <- runQuery query

106+ Just (Only chr) <- firstRow result

107+ return chr

108+ chrs <- replicateConcurrently 10 session

109+ chrs `shouldSatisfy` all (== 'a')

110+

111+ describe "Ranges" $

112+

113+ it "should correctly decode ranges" $ do

114+

115+ rangesOut <- withConnection connectionString $ do

116+ let

117+ query :: Query_ (Public '[]) () (Only (Range Int32))

118+ query = values

119+ ( range int4range (atLeast 3) `as` #fromOnly )

120+ [ range int4range (3 <=..< 5) `as` #fromOnly

121+ , range int4range Empty `as` #fromOnly

122+ , range int4range whole `as` #fromOnly ]

123+ getRows =<< runQuery query

124+ (fromOnly <$> rangesOut :: [Range Int32]) `shouldBe`

125+ [ atLeast 3, 3 <=..< 5, Empty, whole ]

126+

127+ describe "Parameters" $ do

128+

129+ it "should run queries that don't reference all their parameters" $ do

130+

131+ out <- withConnection connectionString $ do

132+ let

133+ query :: Query_ (Public '[]) (Char,Int32) (Only Int32)

134+ query = values_ (param @2 `as` #fromOnly)

135+ firstRow =<< runQueryParams query ('a', 3 :: Int32)

136+ (fromOnly <$> out :: Maybe Int32) `shouldBe` Just 3

squeal-postgresql/test/Specs/ExceptionHandling.hsdeleted−128

@@ -1,128 +0,0 @@

1−{-# LANGUAGE DataKinds #-}

2−{-# LANGUAGE DeriveGeneric #-}

3−{-# LANGUAGE DuplicateRecordFields #-}

4−{-# LANGUAGE FlexibleContexts #-}

5−{-# LANGUAGE OverloadedLabels #-}

6−{-# LANGUAGE OverloadedLists #-}

7−{-# LANGUAGE OverloadedStrings #-}

8−{-# LANGUAGE TypeApplications #-}

9−{-# LANGUAGE TypeFamilies #-}

10−{-# LANGUAGE TypeInType #-}

11−{-# LANGUAGE TypeOperators #-}

12−module ExceptionHandling

13− ( specs

14− , User (..)

15− )

16−where

17−

18−import Control.Monad (void)

19−import Control.Monad.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−type DB = DBof Schemas

52−

53−data User =

54− User { userName :: Text

55− , userEmail :: Maybe Text

56− , userVec :: Vector (Maybe Int16) }

57− deriving (Show, GHC.Generic)

58−instance SOP.Generic User

59−instance SOP.HasDatatypeInfo User

60−

61−insertUser :: Manipulation DB '[ 'NotNull 'PGtext, 'NotNull ('PGvararray ('Null 'PGint2))]

62− '[ "fromOnly" ::: 'NotNull 'PGint4 ]

63−insertUser = insertInto #users

64− (Values_ (defaultAs #id :* param @1 `as` #name :* param @2 `as` #vec))

65− OnConflictDoRaise (Returning (#id `as` #fromOnly))

66−

67−setup :: Definition (Public '[]) Schemas

68−setup =

69− createTable #users

70− ( serial `as` #id :*

71− (text & notNullable) `as` #name :*

72− (vararray int2 & notNullable) `as` #vec )

73− ( primaryKey #id `as` #pk_users

74− :* unique #name `as` #unique_names )

75− >>>

76− createTable #emails

77− ( serial `as` #id :*

78− (int & notNullable) `as` #user_id :*

79− (text & nullable) `as` #email )

80− ( primaryKey #id `as` #pk_emails :*

81− foreignKey #user_id #users #id

82− OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

83−

84−teardown :: Definition Schemas (Public '[])

85−teardown = dropTable #emails >>> dropTable #users

86−

87−migration :: Migration IO (Public '[]) Schemas

88−migration = Migration { name = "test"

89− , up = void $ define setup

90− , down = void $ define teardown }

91−

92−setupDB :: IO ()

93−setupDB = void . withConnection connectionString $

94− manipulate (UnsafeManipulation "SET client_min_messages TO WARNING;")

95− & pqThen (migrateUp (single migration))

96−

97−dropDB :: IO ()

98−dropDB = void . withConnection connectionString $

99− manipulate (UnsafeManipulation "SET client_min_messages TO WARNING;")

100− & pqThen (migrateDown (single migration))

101−

102−connectionString :: Char8.ByteString

103−connectionString = "host=localhost port=5432 dbname=exampledb"

104−

105−testUser :: User

106−testUser = User "TestUser" Nothing []

107−

108−newUser :: (MonadBase IO m, MonadPQ Schemas m) => User -> m ()

109−newUser u = void $ manipulateParams insertUser (userName u, userVec u)

110−

111−insertUserTwice :: (MonadBase IO m, MonadPQ Schemas m) => m ()

112−insertUserTwice = newUser testUser >> newUser testUser

113−

114−specs :: SpecWith ()

115−specs = before_ setupDB $ after_ dropDB $

116− describe "Exceptions" $ do

117−

118− let

119− dupKeyErr = PQException FatalError (Just "23505")

120− (Just "ERROR: duplicate key value violates unique constraint \"unique_names\"\nDETAIL: Key (name)=(TestUser) already exists.\n")

121−

122− it "should be thrown for unique constraint violation in a manipulation" $

123− withConnection connectionString insertUserTwice

124− `shouldThrow` (== dupKeyErr)

125−

126− it "should be rethrown for unique constraint violation in a manipulation by a transaction" $

127− withConnection connectionString (transactionally_ insertUserTwice)

128− `shouldThrow` (== dupKeyErr)

squeal-postgresql/test/Specs/Specs.hsdeleted−7

@@ -1,7 +0,0 @@

1−module Specs where

2−

3−import Test.Hspec

4−import qualified ExceptionHandling

5−

6−main :: IO ()

7−main = hspec ExceptionHandling.specs

stack.yaml+6−1

@@ -1,3 +1,8 @@

1−resolver: nightly-2018-09-03

1+resolver: nightly-2019-07-14

2packages:

3- squeal-postgresql

5+extra-deps:

6+- unliftio-pool-0.2.1.0

7+- github: morphismtech/free-categories

8+ commit: c0e555fbefb5c21619e532264c4dfeac556d0630